https://github.com/beary/wx-ding-aes
Node.js 微信开放平台、企业微信、钉钉第三方回调接口 AES 解密库
https://github.com/beary/wx-ding-aes
aes typescript wechat weixin
Last synced: about 1 year ago
JSON representation
Node.js 微信开放平台、企业微信、钉钉第三方回调接口 AES 解密库
- Host: GitHub
- URL: https://github.com/beary/wx-ding-aes
- Owner: beary
- License: mit
- Created: 2017-06-05T15:40:01.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2020-09-17T07:51:49.000Z (almost 6 years ago)
- Last Synced: 2025-06-05T08:16:29.600Z (about 1 year ago)
- Topics: aes, typescript, wechat, weixin
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/wx-ding-aes
- Size: 15.6 KB
- Stars: 48
- Watchers: 4
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# wx-ding-aes
微信开放平台、企业微信、钉钉第三方回调接口 AES 加密解密库
## Usage
```shell
npm install wx-ding-aes --save
```
```javascript
/* javascript */
const aes = require('wx-ding-aes')
/* typescript */
import * as aes from 'wx-ding-aes'
```
## API
### decode\(text, encodingAESKey\): string
> `text`: 微信/钉钉发送给回调接口的密文
>
> `encodingAESKey`: 创建套件时的 encodingAESKey
> `return`: 对于钉钉，返回值为一个 JSON 字符串，使用 `JSON.parse` 即可拿到 JSON 对象。
>
> 对于企业微信和微信开发平台，返回值为被加密的 xml 字符串，可以使用 xml 解析的库来进行处理。
```javascript
const text = 'xxx'
const encodingAESKey = 'xxx'
const res = aes.decode(text, encodingAESKey)
```
### encode\(text, encodingAESKey, key\): string
> `text`: 需要加密的内容
>
> `encodingAESKey`: 创建套件时的 encodingAESKey
>
> `key`:
> - 对于钉钉参考[官方文档](https://ding-doc.dingtalk.com/doc#/faquestions/ltr370)中的 `$key`
> - 对于企业微信参考[官方文档](https://work.weixin.qq.com/api/doc/90000/90139/90968)中的 `CorpID`
> - 对于微信开放平台参考[官方文档](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/Message_Encryption/Technical_Plan.html)中的 _消息体加密_ 中的描述则是 appid 。
> `return`: 加密后的密文
```javascript
const text = 'xxx'
const encodingAESKey = 'xxx'
const key = 'xxx'
const res = aes.encode(text, encodingAESKey, key)
```