基于NodeJS开发钉钉回调接口实现AES-CBC加解密

时间：2022-12-07 22:49:43

钉钉小程序后台接收钉钉开放平台的回调比较重要，比如通讯录变动的回调，审批流程的回调都是在业务上十分需要的。回调接口时打通钉钉平台和内部系统的重要渠道。

但是给回调的接口增加了一些障碍，它需要支持回调的服务器的接口支持AES-CBC加解密。不然无法成功注册或解析内容。

钉钉官方文档中给出了JAVA,PHP,C#的后台SDK和demo，但是却没有Node服务器的代码支持，这让占有率很高的node服务器非常尴尬，难道node就不能作为钉钉平台的回调服务器么

基于NodeJS开发钉钉回调接口实现AES-CBC加解密

好在钉钉已经开放了其加密算法，可以通过加密流程自己写一套JavaScript版的加解密程序，然后将node服务器注册为钉钉的回调接口。

首先，看一下钉钉回调接口的注册流程

基于NodeJS开发钉钉回调接口实现AES-CBC加解密

首先，是由开发者主动发起一个POST请求到钉钉开放平台，传过去回调的URL，然后钉钉在这个请求中返回一个ok，如下图

基于NodeJS开发钉钉回调接口实现AES-CBC加解密

在这里，我申请了通讯录加人或修改人事件的回调。

在这个接口请求完毕之后，钉钉会迅速的向你请求参数中写的url发送一个POST请求，如下

  1. {"encrypt":"ihVRgn3eZZrCYHfAW4Lbh9eoOcpy1VddxGS9IIYsteFgAxpPN9ZaKKp4EH/7ArtmVEACxmyGCdUFtGuXxfNfcbXXXXXXXXXXXXXXXXXXXkGy+Oq/hIN"}

此时，钉钉要求我们“success”加密，然后在服务器中响应。

AES是一种对称性加密，即加密者通过一个密钥进行加密，将密文发送给接收人，接收人通过相同的密钥进行解密。但是CBC这种模式下，还需要一个偏移，或者说IV向量进行加解密。所以在加解密的时候实际上需要两个参数，密钥和IV。换句话说，钉钉回调接口使用的加密方式为AES-256-CBC模式

按照文档要求，我们返回的JSON中需要包含4个字段

基于NodeJS开发钉钉回调接口实现AES-CBC加解密

其中，nonce是可以随便写的字符串，长度也没有限制，是用来增加msg_signature的变化度的。

timeStamp是10位数的时间戳，JavaScript默认时间戳是13位的，我们需要除以1000或者截取后3位。

encrypt是一段base64编码后的字符串，被编码的是“sucess”被加密后的密文

msg_signature是一段hash值，是将其余3个字符串，加上我们注册接口时设定的自定义token，4个字符串排序好，通过SHA1算法HASH后的值，用来验证完整性的。具体如下

基于NodeJS开发钉钉回调接口实现AES-CBC加解密

最难以解决的就是encrypt字段了，还好在JS界谷歌已经给我们准备好了CryptoJS库，不用几行代码就可以解决问题。

首先观察下这个encrypt字段的形成逻辑：

基于NodeJS开发钉钉回调接口实现AES-CBC加解密

需要被加密的明文由四个部分组成，分别是

16个字节的随机字符串：ASCII编码中，一个字符就占1个字节（8位），所以这里我们随便填16个字母组成的字符串就行

4个字节的msg长度：这里的长度不是文本格式的长度，而是4*8=32位二进制表示的长度，文档中没有明确指出是填msg的字节长度，还是比特位数，通过我个人验证，此处应该填msg的字节数。由于"success"由7个ASCII字符组成，所以长度为7，以4个字节的二进制表示就是

00000000 00000000 00000000 00000111

在JS中，要想把二进制数转化成字节，可以先换成十进制，然后使用String.fromCharCode(0)方法，转换为字节。所以此处要想用字符串表示，就是把0，0，0，7当作ASCII码转换为不可见字符

  1. var lengthString = String.fromCharCode(0)+String.fromCharCode(0)+String.fromCharCode(0)+String.fromCharCode(7)

明文msg：就是字符串"success"

$key：我是企业内部开发，Corpid可以在钉钉开发者后台看到

有了明文，下一步就是进行加密

首先我们知道AES-CBC算法需要一个密钥KEY和一个偏移量IV，而钉钉说IV是密钥的前16位，如下

基于NodeJS开发钉钉回调接口实现AES-CBC加解密

钉钉让我们提供32字节长的密钥，换句话说就是256比特，然后把密钥Base64进行编码，通过上面的注册接口发给钉钉。

由于一个ASCII字符就是一个字节，所以我们这里生成一个32字符长度的字符串，就由密钥了，我选择的密钥是"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"，因为@字符的ASCII码值是64，容易记，同理，IV就是16个@组成的字符串。

注意32字节的长度的字符串base64编码后，长度肯定位44个字符，最后一位必然是=，去掉等号就是43个字符了

通过使用10进制的数字，转换为Byte字符串，也可以通过数组来解决，如上面这个，我就可以通过下面代码来生成密钥

  1. var key_256 = [64, 64, 64, 64, 64, 64, 64, 64,
  2. 64, 64, 64, 64, 64, 64, 64, 64,
  3. 64, 64, 64, 64, 64, 64, 64, 64,
  4. 64, 64, 64, 64, 64, 64, 64, 64];
  5. var key_text = '';
  6. for(let i=0;i<32;i++){
  7. key_text += String.fromCharCode(key_256[i]);
  8. }
  9. console.log(btoa(key_text))

通过JS的btoa()函数，可以直接把密钥变成Base64格式

同理，生成IV之后，就可以开始进行加密操作了，这里直接放出代码

CryptoJS库既可以在HTML中使用，也可以require到node中使用

在HTML中使用时，先到https://code.google.com/archive/p/crypto-js/downloads下载最新压缩包，然后解压到项目目录即可，如下

基于NodeJS开发钉钉回调接口实现AES-CBC加解密

然后再HTML中进行引用

  1. <script src = "crypto-js-4.0.0/crypto-js.js"></script>

这样我们就可以直接通过浏览器本地调试，生成我们想要的字符串，让node服务器直接原文返回就可以了

  1. <html>
  2. <head>
  3. <script src = "crypto-js-4.0.0/crypto-js.js"></script>
  4. <script>
  5.  
  6. // AES 秘钥
  7. var AesKey = "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@";
  8. console.log(btoa(AesKey))
  9.  
  10. // AES-128-CBC偏移量
  11. var CBCIV = "@@@@@@@@@@@@@@@@";
  12.  
  13. //16个字节的随机字符串
  14. var randomString = '1234567890123456';
  15. //明文msg
  16. var msg = 'success';
  17. //$key,对于企业内部开发来说，$key填写企业的Corpid。
  18. var corpid = 'ding00000035b90000000005d6980864d335'
  19.  
  20. function len_msg(msg){//该函数返回的是字符串，无文本意义
  21. result = String.fromCharCode(0)+String.fromCharCode(0)+String.fromCharCode(0)+String.fromCharCode(7);
  22. return result;
  23. }
  24. //msg_len(4B),此处为ASCII编码的二进制字符串，无文本意义
  25. var msg_len = len_msg(msg);
  26. //要加密的明文是[random(16B) + msg_len(4B) + msg + $key]
  27. var codeString = randomString + msg_len + msg + corpid;
  28.  
  29. console.log('要加密的明文字符串为：'+codeString);
  30. console.log('要加密的字符串Base64为：'+btoa(codeString));
  31.  
  32. // 加密选项
  33. var CBCOptions = {
  34. iv: CryptoJS.enc.Latin1.parse(CBCIV),
  35. mode:CryptoJS.mode.CBC,
  36. padding: CryptoJS.pad.Pkcs7
  37. }
  38.  
  39. /**
  40. * AES加密（CBC模式，需要偏移量）
  41. * @param data
  42. * @returns {*}
  43. */
  44. function encrypt(data){
  45. var key = CryptoJS.enc.Latin1.parse(AesKey);
  46. var secretData = CryptoJS.enc.Latin1.parse(data);
  47. var encrypted = CryptoJS.AES.encrypt(
  48. secretData,
  49. key,
  50. CBCOptions
  51. );
  52. return encrypted.toString();
  53. }
  54. /**
  55. * AES解密（CBC模式，需要偏移量）
  56. * @param data
  57. * @returns {*}
  58. */
  59. function decrypt(data){
  60. var key = CryptoJS.enc.Latin1.parse(AesKey);
  61. var decrypt = CryptoJS.AES.decrypt(
  62. data,
  63. key,
  64. CBCOptions
  65. );
  66. return CryptoJS.enc.Latin1.stringify(decrypt).toString();
  67. }
  68.  
  69. //encrypt = Base64_Encode(AES_Encrypt[random(16B) + msg_len(4B) + msg + $key])
  70. var encodeData=encrypt(codeString);
  71. console.log('加密后密文为：'+encodeData);
  72. console.log('10位时间戳：'+parseInt(new Date()/1000));
  73.  
  74. var timeStamp = ""+parseInt(new Date()/1000);
  75. var nonce = "aaaaaa";
  76. var encrypt = "LwJ0000000000000000000000000000000000000YYQIBxRvsQ=="
  77. var token = '@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@';
  78.  
  79. //dev_msg_signature=sha1(sort(token、timestamp、nonce、msg_encrypt))
  80. var sortList = [timeStamp,nonce,encrypt,token];
  81. sortList.sort();
  82. console.log(sortList);
  83.  
  84. var msg_signature = '';
  85. for (i in sortList){
  86. msg_signature += i;
  87. }
  88. console.log(msg_signature);
  89. console.log(CryptoJS.SHA1(msg_signature).toString())
  90.  
  91. var secretTxt = 'Fuqa0wgIvMtUgFBnyZkCb1z3tpSYJ0000000000000000000000p64KnDZkGsjP3y5AIGnryUjkMi16Lz5C/ZzkMRbaipIgz60U5gELKSblZ3MnTf1CVbPMvyjoYbyenjbKCDmQpdgdA4Ejh8Cnlil1laZ8wQSUSD0ju8a9pFIx9Rh6HwNfh0FenpnX22HpfU000007ZjNM5PeK5DeCbmCrqnrq1zwjqomeXSw8mw9g0i83DQKYMXuU3KsO000cHPLdfbWIKUyTcw=='
  92. var realMessage = decrypt(secretTxt);
  93. console.log('实际内容是'+realMessage);
  94. </script>
  95. </head>
  96. <body>
  97. </body>
  98. </html>

注意，加密选项中CryptoJS.enc.Latin1.parse(AesKey);是将字符串表示的密钥通过ASCII码转换为字节，在加密时也可以使用CryptoJS.enc.Utf8,因为utf8编码再ASCII字符中编码没有区别。

但是反过来，加密中用Latin1和Utf8都没有问题，但是在解密时，钉钉那边是使用ASCII编码的，如果使用CryptoJS.enc.Utf8就会发生错误。因为钉钉返回内容应该全是普通英文字符，没有中文或其他特殊字符

对于消息体签名，我们只需使用JS的arr.sort()，把四个字段组成的数组通过首字母进行排序，然后首尾相连变为一个字符串，再使用CryptoJS.SHA1(msg_signature).toString()的SHA1算法取HASH值即可，注意这里的HASH值是HEX格式表示的（文档没有写，但是通过实验得出的），不要用Base64了，代码上等价于

  1. CryptoJS.SHA1(msg_signature).toString(CryptoJS.enc.Hex);

还有encrypted.toString()方法，默认返回的就是Base64编码格式，无需转换，这一点和上面SHA1方法的默认值不同，还有，CryptoJS.AES.decrypt（）方法，传入的待解码的密文，也可以直接把钉钉给的Base64格式密文传入的，无需提前解码Base64

注意，排序四元素之一的token，既不是AES的密钥，也不是IV，也不是钉钉平台的access_token,而是我们在前面https://oapi.dingtalk.com/call_back/register_call_back接口中上传的token字段，是个纯自定义的的字段

我们通过在浏览器中执行上面的代码，就可以把注册回调需要返回的JSON值都获取到，然后我们直接在node里写死这几个值用来返回就可以了，同时，我们还需要在nodejs中引入CryptoJS，用来对钉钉发来的回调信息进行解密

  1. const express = require('express')
  2. const bodyParser = require('body-parser');
  3. const CryptoJS = require("crypto-js");
  4.  
  5. const app = express()
  6. const port = 8080
  7. const appkey = 'dingxxxx';
  8. const appsecret = 'xxxxxx';
  9. const agentId = 'xxxxxx';
  10.  
  11. var dingToken = '';
  12.  
  13. app.get('/', (req, res) => res.send('Hello World!'))
  14.  
  15. app.listen(port, function(){
  16. console.log(`Example app listening on port ${port}!`);
  17. getToken();
  18. })
  19.  
  20. app.use(bodyParser.json())
  21.  
  22. app.post('/dingCallback', function (req, res) {
  23. console.log('钉钉回调接口收到请求了：'+JSON.stringify(req.body));//获取钉钉的回调参数
  24.  
  25. var timeStamp = ""+parseInt(new Date()/1000);//动态项
  26. var nonce = "aaaaaa";//随便写
  27. var encrypt = "LwXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXxRvsQ=="
  28. var token = '666666';
  29.  
  30. //dev_msg_signature=sha1(sort(token、timestamp、nonce、msg_encrypt))
  31. var sortList = [timeStamp,nonce,encrypt,token];
  32. sortList.sort();
  33. console.log(sortList);
  34.  
  35. var msg_signature = '';
  36. for (let text of sortList){
  37. msg_signature += text;
  38. }
  39. console.log('msg_signature明文='+msg_signature)
  40. msg_signature = CryptoJS.SHA1(msg_signature).toString()
  41.  
  42. var resp = {
  43. msg_signature:msg_signature,
  44. timeStamp:timeStamp,
  45. nonce:nonce,
  46. encrypt:encrypt
  47. }
  48. console.log(''+JSON.stringify(resp))
  49.  
  50. console.log('解密内容是：'+decryptMsg(req.body.encrypt));//获取钉钉传过来的参数，并解密处json信息
  51. res.send(JSON.stringify(resp));
  52.  
  53. });
  54.  
  55. // AES 秘钥
  56. var AesKey = "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@";
  57.  
  58. // AES-128-CBC偏移量
  59. var CBCIV = "@@@@@@@@@@@@@@@@";
  60.  
  61. // 加密选项
  62. var CBCOptions = {
  63. iv: CryptoJS.enc.Latin1.parse(CBCIV),
  64. mode:CryptoJS.mode.CBC,
  65. padding: CryptoJS.pad.Pkcs7
  66. }
  67.  
  68. /**
  69. * AES解密（CBC模式，需要偏移量）
  70. * @param data Base64格式
  71. * @returns {*}
  72. */
  73. function decrypt(data){
  74. var key = CryptoJS.enc.Latin1.parse(AesKey);
  75. var decrypt = CryptoJS.AES.decrypt(
  76. data,
  77. key,
  78. CBCOptions
  79. );
  80. return CryptoJS.enc.Latin1.stringify(decrypt).toString();
  81. }
  82.  
  83. function decryptMsg(base64_crypt_msg){
  84. var realMessage = decrypt(base64_crypt_msg);
  85. var endPosition = realMessage.lastIndexOf('dingXXXXXXXX');//掐头去尾，前面掐掉20字节，后面掐掉Corpid
  86. if(!realMessage || realMessage.length < 20 || endPosition==0){
  87. console.log('解密失败')
  88. return;
  89. }
  90. var jsonData = realMessage.slice(20,endPosition);
  91. return jsonData;
  92. }

钉钉用于验证你服务器的POST请求，与给你发信息的回调参数，格式是一样的，POST收到的明文为：

{"encrypt":"ihVRgn3eZZrCYHfAW4Lbh9eoOcpy1VddxGS9IIYsteFgAxpPN9ZaKKp4EH/7ArtmV"}

解密之后，密文部分为一个JSON字符串，里面包含着我们想要的东西，如，用于验证url的参数解密后为，这个和我们设置的响应加密字符串一样，是16字节的随机字符串，4个字节的二进制长度，正文+Corpid。

AzW30dHltl1iocOd{"EventType":"check_url"}dingxxxxxxxxxxxxxxxxxxxxxxx

要判断钉钉回调我们的接口是否成功，或者说我们有没有返回正确的加密报文，只需调用钉钉的查看回调接口列表就行了，方法是使用POST请求调用https://oapi.dingtalk.com/call_back/get_call_back?access_token=，然后观察回调接口中是否包含你刚注册的url即可

基于NodeJS开发钉钉回调接口实现AES-CBC加解密

另外推荐一个网站，可以将base64后的待加密字符串，使用AES-256-CBC算法进行加解密

https://the-x.cn/cryptography/Aes.aspx

基于NodeJS开发钉钉回调接口实现AES-CBC加解密

参考：https://blog.csdn.net/myzksky/article/details/82052920

到此这篇关于基于NodeJS开发钉钉回调接口实现AES-CBC加解密的文章就介绍到这了,更多相关NodeJS AES-CBC加解密内容请搜索服务器之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持服务器之家！

原文链接：https://blog.csdn.net/lvshaorong/article/details/107712071

标签：

相关文章