wxbizmsgcrypt+php7,GitHubfuchengjx/WXBizMsgCrypt:企业微信TS(JS)加解密库

WXBizMsgCrypt

企业微信TS(JS)加解密库

这是自己封装的一个企业微信加解密库。

WXBizMsgCrypt使用

import { WXBizMsgCrypt } from "./WXBizMsgCrypt"; // 导入封装的企业微信加解密算法

const EncodingAESKey &＃61; "XXXX填写自己的机器人的EncodingAESKey XXXX"; // EncodingAESKey 用于消息体的加密&＃xff0c;是AES密钥的Base64编码。 长度为43位的英文或数字。

const token &＃61; "chengfu"; // 可由开发者任意填写&＃xff0c;用于生成签名。长度为3~32之间的英文或数字.

const wxbizmsgcrypt &＃61; new WXBizMsgCrypt(token, EncodingAESKey);

企业微信机器人开发经验

先随便在群里新建一个机器人。配置里会得到一个webhook地址&＃xff0c;可用来推送消息&＃xff0c;直接通过post请求就可以对群里进行推送消息。

推送&＃xff0c;如果只是为了通过企业微信机器人给群内推送消息&＃xff0c;可以通过webhook。这个比较容易&＃xff0c;但是只能实现机器人对用户的消息交流。不能实现用户对机器人的通讯。如果要实现用户对机器人的通讯&＃xff0c;必须要用回调了。

这里是关于回调的开发经验

回调必须先填写URL&＃xff0c; 填写的URL需要正确响应企业微信URL的请求。填写完Token&＃xff0c;EncodingAESKey可以随机获取。

URL是群机器人接收企业微信群推送请求的访问协议和地址&＃xff0c;支持http或https协议。

Token可由开发者任意填写&＃xff0c;用于生成签名。长度为3~32之间的英文或数字.

EncodingAESKey用于消息体的加密&＃xff0c;是AES密钥的Base64编码。 长度为43位的英文或数字

点击保存&＃xff0c;企业微信服务器会发送一条加密的信息到填写的URL&＃xff0c;发送方法为GET。 你需要自己的URL服务器将这个加密信息按照特定的算法解密出来 出正确的响应才能通过URL验证。

企业微信在推送消息给企业时&＃xff0c;会对消息内容做AES加密&＃xff0c;以XML格式POST到企业应用的URL上。

企业在被动响应时&＃xff0c;也需要对数据加密&＃xff0c;以XML格式返回给企业微信。

这个加解密相当的麻烦&＃xff0c;为此企业微信官方提供了对应的加解密库&＃xff0c;但是目前已有c&＃43;&＃43;/python/php/java/c#等语言版本)&＃xff0c;所以很遗憾不支持js与ts。所以只能自己写了。我这边有写好一个ts版本的解密库&＃xff0c;可以直接调用。感谢 http://mk.oa.com/q/51573 这里提供的方法。

如果想详细了解加解密算法原理的可以参考群机器人的消息回调文档 加解密方案说明

假设接收消息地址设置为&＃xff1a;http://api.3dept.com/&＃xff0c;企业微信将向该地址发送如下验证请求&＃xff1a;

请求方式&＃xff1a;GET

请求地址&＃xff1a;http://api.3dept.com/?msg_signature&＃61;ASDFQWEXZCVAQFASDFASDFSS×tamp&＃61;13500001234&nonce&＃61;123412323&echostr&＃61;ENCRYPT_STR

以下代码采用koa框架编写。其它node框架都可以。

import { WXBizMsgCrypt } from "./WXBizMsgCrypt"; // 导入封装的企业微信加解密算法

const EncodingAESKey &＃61; "XXXX填写自己的机器人的EncodingAESKey XXXX"; // EncodingAESKey 用于消息体的加密&＃xff0c;是AES密钥的Base64编码。 长度为43位的英文或数字。

const token &＃61; "chengfu"; // 可由开发者任意填写&＃xff0c;用于生成签名。长度为3~32之间的英文或数字.

// GET /getInfo

router.get("info")

.use(async (ctx) &＃61;> {

const requestQuery &＃61; ctx.query;

const signature &＃61; requestQuery.msg_signature;

const { timestamp, nonce, echostr } &＃61; requestQuery; // 获取get请求信息

const wxbizmsgcrypt &＃61; new WXBizMsgCrypt(token, EncodingAESKey);

const getSignature &＃61; wxbizmsgcrypt.getSignature(timestamp, nonce, echostr);

if (signature &＃61;&＃61;&＃61; getSignature) {

logger.debug("signature验证成功&＃xff1a;");

// 解密

const decrypt &＃61; wxbizmsgcrypt.decrypt(echostr);

ctx.body &＃61; decrypt;

}

});

URl验证成功后&＃xff0c;就可以处理回调消息了。

群机器人回调消息有文本(text)、事件(event)和附件(attachment)三种类型。文本是群成员&＃64;机器人的时候会回调&＃xff0c;事件是机器人被加入到群中或者从群里移除的时候回调 附件是用户点击markdown消息中的按钮的时候会回调。这里主要讨论文本。

假设机器人的接收消息的URL设置为http://api.3dept.com。

请求方式&＃xff1a;POST

接收数据格式 XML

ps: 因为koa本身默认是不处理xml格式的数据。所以配置了 bodyParser&＃xff0c;可以参考其它博客 koa搭配bodyParser处理xml数据。

import xml2json from "xml2json";

import xml2js from "xml2js"; // 使用 xml2js 可以方便地将XML格式字符串数据解析成Javascript中的对象数据。

// POST / 用户发送信息&＃xff0c;通过post传递到服务器。

router.post("info")

.use(async (ctx) &＃61;> {

// POST进行解密

const wxbizmsgcrypt &＃61; new WXBizMsgCrypt(token, EncodingAESKey); // 解密

const xmlDecryptString: any &＃61; ctx.request.body; // 收到的xml字符串

let Encrypt: any;

xml2js.parseString(xmlDecryptString, (err: any, result: any) &＃61;> { // 将xml字符串转换成json对象

[Encrypt] &＃61; result.xml.Encrypt; // Encrypt &＃61; result.xml.Encrypt[0]

});

// 解密

const decrypt &＃61; wxbizmsgcrypt.decrypt(Encrypt);

// xml 2 json

const decryptJson &＃61; JSON.parse(xml2json.toJson(decrypt));

const { From, WebhookUrl, MsgType, ChatId, MsgId, ChatType } &＃61; decryptJson.xml;

// ChatType 类型group, single 判断是群内聊天还是单人聊天。

const { UserId, Name, Alias } &＃61; From; // 存取用户的别名 一般是英文名

// 这里尝试用WebHook进行主动推送

const baseUrl &＃61; WebhookUrl;

// 推送代码省略

ctx.status &＃61; 200; // 必须设置返回值为200&＃xff0c;不然微信服务器会重复请求3次。

ctx.body &＃61; "";

}

ps: 当接收成功后&＃xff0c;http头部返回200表示接收ok&＃xff0c;其他错误码像302企业微信后台会一律当做失败并发起重试&＃xff0c;重复请求3次。

文本消息 协议格式如下&＃xff1a;

zhangsan

text

abcdabcdabcd

在响应本次请求的时候直接回复消息。回复的消息需要先按明文协议构造xml数据包&＃xff0c;然后对明文消息进行加密&＃xff0c;之后再回复最终的密文xml数据包。这个相当麻烦&＃xff0c;建议通过webhook地址主动发送消息到群里。

提醒机器人的开发其实很简单&＃xff0c;其实就是向这个webhook地址&＃xff0c;按文档提供的格式发送请求&＃xff0c;就可以实现消息推送了。最简单的示例&＃xff0c;可以用 Node.js 的 axios 类库&＃xff1a;

const axios &＃61; require(&＃39;axios&＃39;)

const baseUrl &＃61; WebhookUrl;

async function bookLunch() {

let result &＃61; await axios.post(baseUrl, {

msgtype: &＃39;text&＃39;,

text: {

content: &＃39;同学们好&＃xff0c;我是企业微信机器人&＃xff01;&＃39;,

mentioned_list: [&＃39;&＃64;all&＃39;] // 可以使用邮箱或者手机号码

}

})

return result.data

}

bookLunch.then((res) &＃61;> {

console.log(res)

})

以上是最简单的例子。除了普通文本内容&＃xff0c;还可以发送 markdown&＃xff0c;图文等内容&＃xff0c;可以自行去看文档。

如果只是做一种类似提醒机器人的服务&＃xff0c;比如说每早提醒大家写计划&＃xff0c;每周五傍晚提醒大家写周报&＃xff0c;怎么可以让机器人在这些时间点出现提醒大家呢&＃xff1f; 一般而言可能会写一个node服务&＃xff0c;跑在服务器上。但是这样不太经济&＃xff0c;有一种性价比更高的服务&＃xff0c;使用云函数。 无服务器云函数地址&＃xff1a; https://console.cloud.tencent.com/scf?rid&＃61;8

更多

更多详细文档可以参考