Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/saqqdy/node-wxcrypto
微信消息加解密nodejs版本
https://github.com/saqqdy/node-wxcrypto
aes256 crypto decrypt encrypt node-crypto node-wxcrypto pkcs7 sha1 wxcrypto xml
Last synced: 3 months ago
JSON representation
微信消息加解密nodejs版本
- Host: GitHub
- URL: https://github.com/saqqdy/node-wxcrypto
- Owner: saqqdy
- License: mit
- Created: 2022-11-15T10:20:34.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-03-05T02:24:29.000Z (12 months ago)
- Last Synced: 2024-10-08T00:37:53.615Z (4 months ago)
- Topics: aes256, crypto, decrypt, encrypt, node-crypto, node-wxcrypto, pkcs7, sha1, wxcrypto, xml
- Language: TypeScript
- Homepage: https://www.saqqdy.com/node-wxcrypto
- Size: 990 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# node-wxcrypto
微信消息加解密 nodejs 版本
[![NPM version][npm-image]][npm-url]
[![Codacy Badge][codacy-image]][codacy-url]
![typescript][typescript-url]
[![npm download][download-image]][download-url]
[![License][license-image]][license-url]
### **[Documentation](https://www.saqqdy.com/node-wxcrypto)** • **[Change Log](./CHANGELOG.md)**
## 安装
```bash
# 使用pnpm
$ pnpm i node-wxcrypto
# 使用yarn
$ yarn add node-wxcrypto
```
## 使用
### 引入和使用
1. require 引入
```js
const { WxCrypto } = require('node-wxcrypto')
const wxCrypto = new WxCrypto(token, aesKey, appID, options)
const data = await wxCrypto.decrypt(encrypt, timestamp, nonce, options)
```
2. import 引入
```js
import { WxCrypto } from 'node-wxcrypto'
const wxCrypto = new WxCrypto(token, aesKey, appID, options)
const data = await wxCrypto.decrypt(encrypt, timestamp, nonce, options)
```
### 使用配置
> 在实例化和加解密方法均支持传入 options: `normalizeTags`, `buildXmlOptions`, `xmlOptions`，加解密方法里面传入的 options 优先级更高。
> `normalizeTags` 支持将 xml 属性由驼峰转下划线分隔的小写形式；`buildXmlOptions` 透传用于生成 xml 字符串的配置；`xmlOptions` 透传用于解析 xml 字符串的配置。
> 注意：`normalizeTags` 会全量覆盖 `xmlOptions` 里面的 `tagNameProcessors` 方法，如果想要自定义 `tagNameProcessors`，请不要传入 `normalizeTags`
持将 xml 属性由驼峰转下划线分隔的小写形式：`ComponentVerifyTicket => component_verify_ticket`
```js
// normalizeTags可传入布尔值或者字符串，传入字符串时使用该字符串分隔，例如：normalizeTags = "__"，得到：`ComponentVerifyTicket => component__verify__ticket`
const wxCrypto = new WxCrypto(token, aesKey, appID, {
normalizeTags: true,
buildXmlOptions: {}, // 透传用于生成 xml 字符串的配置
xmlOptions: {} // 透传用于解析 xml 字符串的配置
})
const data = await wxCrypto.decrypt(encrypt, timestamp, nonce, options)
```
## API
详见：[API说明文档](API.md)
## 类型
1. [Interface Options](https://www.saqqdy.com/node-wxcrypto/interfaces/Options.html)
2. [Interface BuildXMLOptions](https://www.saqqdy.com/node-wxcrypto/interfaces/BuildXMLOptions.html)
3. [Class WxCrypto](https://www.saqqdy.com/node-wxcrypto/classes/WxCrypto.html)
4. [Variable default](https://www.saqqdy.com/node-wxcrypto/variables/default.html)
## 问题和支持
Please open an issue [here](https://github.com/saqqdy/node-wxcrypto/issues).
## License
[MIT](LICENSE)
[npm-image]: https://img.shields.io/npm/v/node-wxcrypto.svg?style=flat-square
[npm-url]: https://npmjs.org/package/node-wxcrypto
[codacy-image]: https://app.codacy.com/project/badge/Grade/f70d4880e4ad4f40aa970eb9ee9d0696
[codacy-url]: https://www.codacy.com/gh/saqqdy/node-wxcrypto/dashboard?utm_source=github.com&utm_medium=referral&utm_content=saqqdy/node-wxcrypto&utm_campaign=Badge_Grade
[typescript-url]: https://badgen.net/badge/icon/typescript?icon=typescript&label
[codecov-image]: https://img.shields.io/codecov/c/github/saqqdy/node-wxcrypto.svg?style=flat-square
[codecov-url]: https://codecov.io/github/saqqdy/node-wxcrypto?branch=master
[download-image]: https://img.shields.io/npm/dm/node-wxcrypto.svg?style=flat-square
[download-url]: https://npmjs.org/package/node-wxcrypto
[license-image]: https://img.shields.io/badge/License-MIT-blue.svg
[license-url]: LICENSE
[sonar-image]: https://sonarcloud.io/api/project_badges/quality_gate?project=saqqdy_node-wxcrypto
[sonar-url]: https://sonarcloud.io/dashboard?id=saqqdy_node-wxcrypto