微信加密数据解密

当调用微信小程序接口获取敏感信息时,返回的数据往往是经过加密的,开发者如需获取这些敏感数据,需要对接口返回的加密数据进行对称解密。

wx.BaaS.wxDecryptData(encryptedData, iv, type, code)

参数说明

参数 类型 必填 说明
encryptedData String Y 加密的数据,可通过 wx.getWeRunData 等微信 api 返回获取
iv String Y 加密算法的初始向量,可通过 wx.getWeRunData 等微信 api 返回获取
type String Y 数据类型,现支持 ‘we-run-data’, ‘phone-number’, ‘open-gid’
code String N 小程序基础库大于等于 v2.21.2 且 SDK 版本大于 v3.22.0 且 type 为 ‘phone-number’ 时必填。可通过 open-type 为 getPhoneNumber 的 button 回调中获取,如 e.detail.code

当前支持解密的数据包括:

  • 通过调用 wx.getWeRunData 获取到的微信用户的微信运动步数,此时设置 type = ‘we-run-data’
  • 通过设置 button 的 open-type 为 getPhoneNumber 获取到的微信用户绑定的手机号,此时设置 type = ‘phone-number’
  • 通过调用 wx.getShareInfo 获取到的转发详细信息,此时设置 type = ‘open-gid’

danger 该功能涉及到敏感数据接口使用,需前往 知晓云管理后台-小程序设置页面-SDK 功能设置 手动开启。

请求示例

对微信加密数据进行解密需要使用到本次登录的会话密钥(session_key),因此,在调用该接口前,最好先调用一下 wx.checkSession 检查一下 session_key 是否过期,如果过期的话,可以先调用 wx.BaaS.auth.logout 再调用 wx.BaaS.auth.loginWithWechat 接口进行重新登录。

  1. wx.getWeRunData({
  2. success(res) {
  3. wx.checkSession({
  4. success: function() {
  5. wx.BaaS.wxDecryptData(res.encryptedData, res.iv, 'we-run-data').then(decrytedData => {
  6. console.log('decrytedData: ', decrytedData)
  7. }, err => {
  8. // HError 对象
  9. // 失败的原因有可能是以下几种:用户未登录或 session_key 过期,微信解密插件未开启,提交的解密信息有误
  10. })
  11. },
  12. fail: function() {
  13. wx.BaaS.auth.logout();
  14. wx.BaaS.auth.loginWithWechat();
  15. }
  16. })
  17. }
  18. })

HError 对象结构请参考错误码和 HError 对象