微信小程序加密消息解密工具类

迈不过友情╰ 2022-01-25 15:37 560阅读 0赞

## ##

### 开发者后台校验与解密开放数据 ###

微信会对这些开放数据做签名和加密处理。开发者后台拿到开放数据后可以对数据进行校验签名和解密，来保证数据不被篡改。

![signature.8a30a825.jpg][]

签名校验以及数据加解密涉及用户的会话密钥 session\_key。 开发者应该事先通过 [wx.login][] 登录流程获取会话密钥 session\_key 并保存在服务器。为了数据不被篡改，开发者不应该把 session\_key 传到小程序客户端等服务器外的环境。

数据签名校验

为了确保开放接口返回用户数据的安全性，微信会对明文数据进行签名。开发者可以根据业务需要对数据包进行签名校验，确保数据的完整性。

1.  通过调用接口（如 [wx.getUserInfo][]）获取数据时，接口会同时返回 rawData、signature，其中 signature = sha1( rawData + session\_key )
2.  开发者将 signature、rawData 发送到开发者服务器进行校验。服务器利用用户对应的 session\_key 使用相同的算法计算出签名 signature2 ，比对 signature 与 signature2 即可校验数据的完整性。

**如 wx.getUserInfo的数据校验：**

接口返回的rawData：

加密数据解密算法

接口如果涉及敏感数据（如[wx.getUserInfo][]当中的 openId 和 unionId），接口的明文内容将不包含这些敏感数据。开发者如需要获取敏感数据，需要对接口返回的**加密数据(encryptedData)** 进行对称解密。 解密算法如下：

1.  对称解密使用的算法为 AES-128-CBC，数据采用PKCS\#7填充。
2.  对称解密的目标密文为 Base64\_Decode(encryptedData)。
3.  对称解密秘钥 aeskey = Base64\_Decode(session\_key), aeskey 是16字节。
4.  对称解密算法初始向量 为Base64\_Decode(iv)，其中iv由数据接口返回。

微信官方提供了多种编程语言的示例代码。每种语言类型的接口名字均一致。调用方式可以参照示例。

另外，为了应用能校验数据的有效性，会在敏感数据加上数据水印( watermark )

**watermark参数说明：**

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>类型</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>appid</td> 
   <td>String</td> 
   <td>敏感数据归属 appId，开发者可校验此参数与自身 appId 是否一致</td> 
  </tr> 
  <tr> 
   <td>timestamp</td> 
   <td>Int</td> 
   <td>敏感数据获取的时间戳, 开发者可以用于数据时效性校验</td> 
  </tr> 
 </tbody> 
</table>

如接口 [wx.getUserInfo][] 敏感数据当中的 watermark：

{
        "openId": "OPENID",
        "nickName": "NICKNAME",
        "gender": GENDER,
        "city": "CITY",
        "province": "PROVINCE",
        "country": "COUNTRY",
        "avatarUrl": "AVATARURL",
        "unionId": "UNIONID",
        "watermark":
        {
            "appid":"APPID",
            "timestamp":TIMESTAMP
        }
    }

注：

1.  解密后得到的json数据根据需求可能会增加新的字段，旧字段不会改变和删减，开发者需要预留足够的空间

会话密钥 session\_key 有效性

开发者如果遇到因为 session\_key 不正确而校验签名失败或解密失败，请关注下面几个与 session\_key 有关的注意事项。

1.  [wx.login][] 调用时，用户的 session\_key **可能**会被更新而致使旧 session\_key 失效（刷新机制存在最短周期，如果同一个用户短时间内多次调用 [wx.login][]，并非每次调用都导致 session\_key 刷新）。开发者应该在明确需要重新登录时才调用 [wx.login][]，及时通过 [auth.code2Session][] 接口更新服务器存储的 session\_key。
2.  微信不会把 session\_key 的有效期告知开发者。我们会根据用户使用小程序的行为对 session\_key 进行续期。用户越频繁使用小程序，session\_key 有效期越长。
3.  开发者在 session\_key 失效时，可以通过重新执行登录流程获取有效的 session\_key。使用接口 [wx.checkSession][]可以校验 session\_key 是否有效，从而避免小程序反复执行登录流程。
4.  当开发者在实现自定义登录态时，可以考虑以 session\_key 有效期作为自身登录态有效期，也可以实现自定义的时效性策略。

### 首先使用code换取session\_key ###

登录凭证校验。通过 [wx.login][] 接口获得临时登录凭证 code 后传到开发者服务器调用此接口完成登录流程。

### 请求地址 ###

GET https://api.weixin.qq.com/sns/jscode2session?appid=APPID&secret=SECRET&js_code=JSCODE&grant_type=authorization_code

### 请求参数 ###

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>类型</th> 
   <th>默认值</th> 
   <th>必填</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>appid</td> 
   <td>string</td> 
   <td>&nbsp;</td> 
   <td>是</td> 
   <td>小程序 appId</td> 
  </tr> 
  <tr> 
   <td>secret</td> 
   <td>string</td> 
   <td>&nbsp;</td> 
   <td>是</td> 
   <td>小程序 appSecret</td> 
  </tr> 
  <tr> 
   <td>js_code</td> 
   <td>string</td> 
   <td>&nbsp;</td> 
   <td>是</td> 
   <td>登录时获取的 code</td> 
  </tr> 
  <tr> 
   <td>grant_type</td> 
   <td>string</td> 
   <td>&nbsp;</td> 
   <td>是</td> 
   <td>授权类型，此处只需填写 authorization_code</td> 
  </tr> 
 </tbody> 
</table>

### 返回值 ###

### Object ###

返回的 JSON 数据包

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>类型</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>openid</td> 
   <td>string</td> 
   <td>用户唯一标识</td> 
  </tr> 
  <tr> 
   <td>session_key</td> 
   <td>string</td> 
   <td>会话密钥</td> 
  </tr> 
  <tr> 
   <td>unionid</td> 
   <td>string</td> 
   <td>用户在开放平台的唯一标识符，在满足 UnionID 下发条件的情况下会返回，详见&nbsp;<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/union-id.html" rel="nofollow">UnionID 机制说明</a>。</td> 
  </tr> 
  <tr> 
   <td>errcode</td> 
   <td>number</td> 
   <td>错误码</td> 
  </tr> 
  <tr> 
   <td>errmsg</td> 
   <td>string</td> 
   <td>错误信息</td> 
  </tr> 
 </tbody> 
</table>

**errcode 的合法值**

<table> 
 <thead> 
  <tr> 
   <th>值</th> 
   <th>说明</th> 
   <th>最低版本</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>-1</td> 
   <td>系统繁忙，此时请开发者稍候再试</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>0</td> 
   <td>请求成功</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>40029</td> 
   <td>code 无效</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>45011</td> 
   <td>频率限制，每个用户每分钟100次</td> 
  </tr> 
 </tbody> 
</table>

获取sessionKey之后就可以解密了

package com.water.elephant.utils;
    
    import org.bouncycastle.jce.provider.BouncyCastleProvider;
    import org.bouncycastle.util.Arrays;
    import org.bouncycastle.util.encoders.Base64;
    
    import javax.crypto.Cipher;
    import javax.crypto.spec.IvParameterSpec;
    import javax.crypto.spec.SecretKeySpec;
    import java.security.Key;
    import java.security.Security;
    
    /**
     * 微信工具类
     */
    public class WechatUtil {
    
    
        public static String decryptData(String encryptDataB64, String sessionKeyB64, String ivB64) throws Exception {
            return new String(
                    decryptOfDiyIV(
                            Base64.decode(encryptDataB64),
                            Base64.decode(sessionKeyB64),
                            Base64.decode(ivB64)
                    )
            );
        }
    
        private static final String KEY_ALGORITHM = "AES";
        private static final String ALGORITHM_STR = "AES/CBC/PKCS7Padding";
        private static Key key;
        private static Cipher cipher;
    
        private static void init(byte[] keyBytes) {
            // 如果密钥不足16位，那么就补足.  这个if 中的内容很重要
            int base = 16;
            if (keyBytes.length % base != 0) {
                int groups = keyBytes.length / base + (keyBytes.length % base != 0 ? 1 : 0);
                byte[] temp = new byte[groups * base];
                Arrays.fill(temp, (byte) 0);
                System.arraycopy(keyBytes, 0, temp, 0, keyBytes.length);
                keyBytes = temp;
            }
            // 初始化
            Security.addProvider(new BouncyCastleProvider());
            // 转化成JAVA的密钥格式
            key = new SecretKeySpec(keyBytes, KEY_ALGORITHM);
            try {
                // 初始化cipher
                cipher = Cipher.getInstance(ALGORITHM_STR, "BC");
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    
        /**
         * 解密方法
         *
         * @param encryptedData 要解密的字符串
         * @param keyBytes      解密密钥
         * @param ivs           自定义对称解密算法初始向量 iv
         * @return 解密后的字节数组
         */
        private static byte[] decryptOfDiyIV(byte[] encryptedData, byte[] keyBytes, byte[] ivs) {
            byte[] encryptedText = null;
            init(keyBytes);
            try {
                cipher.init(Cipher.DECRYPT_MODE, key, new IvParameterSpec(ivs));
                encryptedText = cipher.doFinal(encryptedData);
            } catch (Exception e) {
                e.printStackTrace();
            }
            return encryptedText;
        }
    
    }

[signature.8a30a825.jpg]: /images/20220125/a882d68b975041158f9af4f4951d7801.png
[wx.login]: https://developers.weixin.qq.com/miniprogram/dev/api/open-api/login/wx.login.html
[wx.getUserInfo]: https://developers.weixin.qq.com/miniprogram/dev/api/open-api/user-info/wx.getUserInfo.html
[auth.code2Session]: https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/login/auth.code2Session.html
[wx.checkSession]: https://developers.weixin.qq.com/miniprogram/dev/api/open-api/login/wx.checkSession.html