kepler-encryption-agreement/README.md

开普勒系列产品的加密插件

# kepler-encryption-agreement

#### 介绍
为开普勒系统提供前后台协议加密服务

#### 软件架构
软件架构说明-原始开发


#### 安装教程

1.  npm i kepler-encryption-agreement

#### 使用说明

1.  该库主要提供两个方法 getAuthToken（对x-token进行加密操作） encryption（对post请求的参数进行加密）

```
// 传入参数说明
interface OPtion {
	PUBLICKEY: string; // 公钥由后端提供
	KEY: string; // 需要的key后端提供
	CHANNEL: string; // 频道 后端定义 bp|admin|app
	RANDOM: string; // 16的随机数
	PARAMS: string; // 加密参数
	DEUBG: boolean; // 是否开启debug模式
}

// 参数 例子
const options = {
	PUBLICKEY:'afssklfjlsjlkjsakflsd',
	KEY:'123456',
	CHANNEL:'bp',
	RANDOM:'123456789123457',
	PARAMS:'{page:1,size:10}',
	DEUBG:true
}
// （生成加密后的X-Auth-Token）
new EncryptionAgr(options).getAuthToken();
// （对post参数进行加密操作）
new EncryptionAgr(options).encryption();
```


#### 参与贡献

1. 邮箱：654805028@qq.com
2. nickname: zhangyida
3. 技术博客地址：https://www.jianshu.com/u/d13b89197264
4. github: https://github.com/zhangYiDa123

#### 更新日志

1 v1.1.7 -> v1.1.8版本 1 增加debug配置 是否开启debug模式