README

一个加密 SDK..

安装

$ composer require lfyw/opencrypt -vvv

用法

方案参考PHP 和 Web 端对称加密传输|JSEncrypt|CryptoJS，这是一个方便前后端简单加密解密的工具.

配置

发布配置文件

$ php artisan vendor:publish --provider="Lfyw\Opencrypt\ServiceProvider"

配置文件说明

加密状态决定是否对加密内容进行处理，建议本地开发时可以关闭以提高本地开发和测试效率。

密钥保存方式有两种，分别是文件保存方式和环境变量保存方式。顾名思义，文件保存方式会将密钥保存在文件里，密钥保存方式会将密钥写入.env文件。除此之外，其他没有什么区别。

<?php
/**
 * Filename:openssl.php
 * Author:ld
 * Date:2021/8/18
 */
return [
    /** 是否开启加解密 **/
    'opencrypt' => env('OPENCRYPT', false),
    /** 密钥保存方式 file => 文件保存模式 'env' => 环境变量保存方式 **/
    'opencrypt_type' => env('OPENCRYPT_TYPE', 'file'),

    /** 仅文件保存模式时需要设置以下配置项 **/
    /** 文件保存模式-密钥地址 **/
    'opencrypt_path' => env('OPENCRYPT_PATH', resource_path('opencrypt')),
    /** 文件保存模式-私钥文件名称 **/
    'opencrypt_private_key_filename' => env('OPENCRYPT_PRIVATE_KEY_FILENAME', 'private_key.pem'),
    /** 文件保存模式-公钥文件名称**/
    'opencrypt_public_key_filename' => env('OPENCRYPT_PUBLIC_KEY_FILENAME', 'public_key.pem'),

    /** 以下配置项仅环境变量模式时有效 **/
    /** 公钥 **/
    'opencrypt_public_key' => env('OPENCRYPT_PUBLIC_KEY'),
    /** 私钥 **/
    'opencrypt_private_key' => env('OPENCRYPT_PRIVATE_KEY'),
];

将opencrypt' => env('OPENCRYPT', false)设置为true即可使用

使用说明

生成密钥

$ php artisan opencrypt:generate

如果采用文件模式，会根据配置文件将密钥保存在对应路径；如果采用环境变量保存模式，会将变量直接写入.env文件。

容器方法使用

/** 加密 **/
app('opencrypt')->encrypt('123');//返回加密字符串
/** 解密 **/
app('opencrypt')->decrypt('123');//返回解密字符串,无法解密会返回null
/** 判断字符串加密后是否等于密文参数 **/
app('opencrypt')->equal('密文','123');//返回布尔值
/** 获取公钥 **/
app('opencrypt')->getPrivateKey();
/** 获取私钥 **/
app('opencrypt')->getPublicKey();

门面

** 加密 **/
Opencrypt::encrypt('123');//返回加密字符串
/** 解密 **/
Opencrypt::decrypt('123');//返回解密字符串,无法解密会返回null
/** 判断字符串加密后是否等于密文参数 **/
Opencrypt::equal('密文','123');//返回布尔值
/** 获取公钥 **/
Opencrypt::getPrivateKey();
/** 获取私钥 **/
Opencrypt::getPublicKey();

辅助函数

/** 加密 **/
openencrypt('123');//返回加密字符串
/** 解密 **/
opendecrypt('123');//返回解密字符串,无法解密会返回null

其他

如果需要前端配合进行一些加密操作，将公钥复制一份给前端，前端参考PHP 和 Web 端对称加密传输|JSEncrypt|CryptoJS进行编码。

参考

PHP 和 Web 端对称加密传输|JSEncrypt|CryptoJS

贡献

您可以通过以下三种方式之一进行贡献

使用问题跟踪器提交错误报告。
在问题跟踪器上回答问题或修复错误。
贡献新功能或更新wiki。

代码贡献过程并不十分正式。您只需确保遵循PSR-0、PSR-1和PSR-2编码指南。任何新的代码贡献都必须伴随相应的单元测试（如果适用）。

许可

MIT

lfyw / opencrypt

维护者

详细信息