前言
微信小程序API文档:https://mp.weixin.qq.com/debug/wxadoc/dev/api/api-login.html
在实际的小程序开发中,往往需要用户授权登陆并获取用户的数据,快速对接用户系统。
openId : 用户在当前小程序的唯一标识
unionId : 如果开发者拥有多个移动应用、网站应用、和公众帐号(包括小程序),可通过unionid来区分用户的唯一性,因为只要是同一个微信开放平台帐号下的移动应用、网站应用和公众帐号(包括小程序),用户的unionid是唯一的。换句话说,同一用户,对同一个微信开放平台下的不同应用,unionId是相同的。详情登录微信开放平台(open.weixin.qq.com) 。
在微信小程序开发中,unionId等敏感数据则被加密在encryptedData,于是需要以下流程来解密敏感数据,从而获取unionId等信息。
注:当 withCredentials 为 true 时,要求此前有调用过 wx.login 且登录态尚未过期,此时返回的数据会包含 encryptedData, iv 等敏感信息;当 withCredentials 为 false 时,不要求有登录态,返回的数据不包含 encryptedData, iv 等敏感信息。
流程
1、(客户端)微信小程序客户端调用 wx.login()接口获取登录凭证(code)
//1、调用微信登录接口,获取code
wx.login({
success: function (r) {
var code = r.code;//登录凭证
if (code) {
//2、调用获取用户信息接口
//...
} else {
console.log('获取用户登录态失败!' + r.errMsg)
}
},
fail: function () {
callback(false)
}
})
2、(客户端)微信小程序客户端调用 wx.getUserInfo()接口获取 用户基本信息、encryptedData(用户敏感信息加密数据) 和 iv(加密算法的初始向量 )
//1、调用微信登录接口,获取code
wx.login({
success: function (r) {
var code = r.code;//登录凭证
if (code) {
//2、调用获取用户信息接口
wx.getUserInfo({
success: function (res) {
console.log({encryptedData: res.encryptedData, iv: res.iv, code: code})
//3.解密用户信息 获取unionId
//...
},
fail: function () {
console.log('获取用户信息失败')
}
})
} else {
console.log('获取用户登录态失败!' + r.errMsg)
}
},
fail: function () {
callback(false)
}
})
3、(客户端)将前面获取到的 code 、encryptedData、iv发送到自己的服务器(开发者服务器),通过自己的服务器(开发者服务器)解密获取信息
//1、调用微信登录接口,获取code
wx.login({
success: function (r) {
var code = r.code;//登录凭证
if (code) {
//2、调用获取用户信息接口
wx.getUserInfo({
success: function (res) {
console.log({encryptedData: res.encryptedData, iv: res.iv, code: code})
//3.请求自己的服务器,解密用户信息 获取unionId等加密信息
wx.request({
url: 'https://xxxx.com/wxsp/decodeUserInfo',//自己的服务接口地址
method: 'post',
header: {
'content-type': 'application/x-www-form-urlencoded'
},
data: {encryptedData: res.encryptedData, iv: res.iv, code: code},
success: function (data) {
//4.解密成功后 获取自己服务器返回的结果
if (data.data.status == 1) {
var userInfo_ = data.data.userInfo;
console.log(userInfo_)
} else {
console.log('解密失败')
}
},
fail: function () {
console.log('系统错误')
}
})
},
fail: function () {
console.log('获取用户信息失败')
}
})
} else {
console.log('获取用户登录态失败!' + r.errMsg)
}
},
fail: function () {
console.log('登陆失败')
}
})
4、(服务端 php)自己的服务器发送code到微信服务器获取openid(用户唯一标识)和session_key(会话密钥),最后将encryptedData、iv、session_key通过AES解密获取到用户敏感数据
/**
* 解密用户敏感数据
*
* @param encryptedData 明文,加密数据
* @param iv 加密算法的初始向量
* @param code 用户允许登录后,回调内容会带上 code(有效期五分钟),开发者需要将 code 发送到开发者服务器后台,使用code 换取 session_key api,将 code 换成 openid 和 session_key
* @return
*/
include_once "wxBizDataCrypt.php";
function httpGet($url) {
$curl = curl_init();
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_TIMEOUT, 500);
curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false);
curl_setopt($curl, CURLOPT_URL, $url);
$res = curl_exec($curl);
curl_close($curl);
return $res;
}
$code = $_GET['code'];
$iv = $_GET['iv'];
$encryptedData = $_GET['encryptedData'];
$appid = '';//小程序唯一标识 (在微信小程序管理后台获取)
$appsecret = '';//小程序的 app secret (在微信小程序管理后台获取)
$grant_type = "authorization_code"; //授权(必填)
$params = "appid=".$appid."&secret=".$appsecret."&js_code=".$code."&grant_type=".$grant_type;
$url = "https://api.weixin.qq.com/sns/jscode2session?".$params;
$res = json_decode(httpGet($url),true);
//json_decode不加参数true,转成的就不是array,而是对象。 下面的的取值会报错 Fatal error: Cannot use object of type stdClass as array in
$sessionKey = $res['session_key'];//取出json里对应的值
$pc = new WXBizDataCrypt($appid, $sessionKey);
$errCode = $pc->decryptData($encryptedData, $iv, $data);
if ($errCode == 0) {
print($data . "\n");
} else {
print($errCode . "\n");
}
总结
好了,总算完成数据解密了,接下来对接新的或已有的用户系统都妥妥的。
有一点需要注意的是,要对接已有的用户系统可能需要用到unionId,如果通过以上方法获取不到unionId,那么你就要去检查一下你的微信开放平台(https://open.weixin.qq.com)是否有绑定微信小程序咯~
虽然code 有5分钟的有效期,但是只能使用一次,小编就这里翻更斗了。
注意:
看本文前,需要理解AES-128-CBC及psck#7数据填充方式
详情请查看:AES加密与Base64编码(加解密、签名系列)
正文开始
1: demo.php(AES使用代码)
<?php
//加载解密处理类
include_once "wxBizDataCrypt.php";
//1:wx后台得到
$appid = 'wx4f4bc4dec97d474b';
//2:[客户端]发送到服务器js_code(服务器用js_code换取sessionKey)
$sessionKey = 'tiihtNczf5v6AKRyjwEUhQ==';
//3:[客户端]发送到服务器(客户端getUserInfo()获取)
$encryptedData="CiyLU1Aw2KjvrjMdj8YKliAjtP4gsMZM
QmRzooG2xrDcvSnxIMXFufNstNGTyaGS
9uT5geRa0W4oTOb1WT7fJlAC+oNPdbB+
3hVbJSRgv+4lGOETKUQz6OYStslQ142d
NCuabNPGBzlooOmB231qMM85d2/fV6Ch
evvXvQP8Hkue1poOFtnEtpyxVLW1zAo6
/1Xx1COxFvrc2d7UL/lmHInNlxuacJXw
u0fjpXfz/YqYzBIBzD6WUfTIF9GRHpOn
/Hz7saL8xz+W//FRAUid1OksQaQx4CMs
8LOddcQhULW4ucetDf96JcR3g0gfRK4P
C7E/r7Z6xNrXd2UIeorGj5Ef7b1pJAYB
6Y5anaHqZ9J6nKEBvB4DnNLIVWSgARns
/8wR2SiRS7MNACwTyrGvt9ts8p12PKFd
lqYTopNHR1Vf7XjfhQlVsAJdNiKdYmYV
oKlaRv85IfVunYzO0IKXsyl7JCUjCpoG
20f0a04COwfneQAGGwd5oa+T8yO5hzuy
Db/XcxxmK01EpqOyuxINew==";
//4:[客户端]发送到服务器(客户端getUserInfo()获取)
$iv = 'r7BXXKkLb8qrSNn05n0qiA==';
//用appid、sessionKey初始化“解密处理类
$pc = new WXBizDataCrypt($appid, $sessionKey);
//执行解密,正确返回$data,错误返回$errCode
$errCode = $pc->decryptData($encryptedData, $iv, $data );
if ($errCode == 0) { //0表示正常
print($data . "
");
} else {
print($errCode . "
");
}
2:wxBizDataCrypt.php(解密处理)
-
<?php /** * 对微信小程序用户加密数据的解密示例代码. * * @copyright Copyright (c) 1998-2014 Tencent Inc. */ //pkcs#7填充方法类 include_once "pkcs7Encoder.php"; //错误代码定义 include_once "errorCode.php"; //解密处理类 class WXBizDataCrypt { private $appid; private $sessionKey; /** * 构造函数 * @param $sessionKey string 用户在小程序登录后获取的会话密钥 * @param $appid string 小程序的appid */ public function WXBizDataCrypt( $appid, $sessionKey) { $this->sessionKey = $sessionKey; $this->appid = $appid; } /** * 检验数据的真实性,并且获取解密后的明文. * @param $encryptedData string 加密的用户数据 * @param $iv string 与用户数据一同返回的初始向量 * @param $data string 解密后的原文 * * @return int 成功0,失败返回对应的错误码 */ public function decryptData( $encryptedData, $iv, &$data ) { //如果不是24位,就是非法 if (strlen($this->sessionKey) != 24) { return ErrorCode::$IllegalAesKey; } //sessionKey在传输前base64加密,所以要base64解密 $aesKey=base64_decode($this->sessionKey); //如果不是24位,就是非法 if (strlen($iv) != 24) { return ErrorCode::$IllegalIv; } //IV在传输前base64加密,所以要base64解密 $aesIV=base64_decode($iv); //encryptedData在传输前base64加密,所以要base64解密 $aesCipher=base64_decode($encryptedData); //用密钥aesKey,初始化AES类 $pc = new Prpcrypt($aesKey); //用密文、初始向量执行解密,得到原文 $result = $pc->decrypt($aesCipher,$aesIV); //如果结果不是0,表示不正常,返回错误代码 if ($result[0] != 0) { return $result[0]; } //把结果转换为数据对象 $dataObj=json_decode( $result[1] ); //如果错误结果为空,返回非法密文 if( $dataObj == NULL ) { return ErrorCode::$IllegalBuffer; } //如果数据对象的appid不对,返回非法密文 if( $dataObj->watermark->appid != $this->appid ) { return ErrorCode::$IllegalBuffer; } //指针$data获取值 $data = $result[1]; //返回正确代码 return ErrorCode::$OK; } }
3:pkcs7Encoder.php (pkcs7填充、AES解密核心代码)
-
<?php include_once "errorCode.php"; /**【填充】**(全过程没用到) * 用于AES的PKCS#7填充 * 提供基于PKCS#7算法(加解密接口) * 对称解密使用的算法为 AES-128-CBC,数据采用PKCS#7填充。 */ class PKCS7Encoder { //块大小为16个字节 public static $block_size = 16; /** * 对需要加密的明文进行填充补位 * @param $text 需要进行填充补位操作的明文 * @return 补齐明文字符串 */ function encode( $text ) { $block_size = PKCS7Encoder::$block_size; $text_length = strlen( $text ); //计算需要填充的位数 $amount_to_pad = PKCS7Encoder::$block_size - ( $text_length % PKCS7Encoder::$block_size ); if ( $amount_to_pad == 0 ) { $amount_to_pad = PKCS7Encoder::block_size; } //获得补位所用的字符 $pad_chr = chr( $amount_to_pad ); $tmp = ""; for ( $index = 0; $index < $amount_to_pad; $index++ ) { $tmp .= $pad_chr; } return $text . $tmp; } /**【去除填充】** * 对解密后的明文进行补位删除 * @param decrypted 解密后的明文 * @return 删除填充补位后的明文 */ function decode($text) { $pad = ord(substr($text, -1)); if ($pad < 1 || $pad > 32) { $pad = 0; } return substr($text, 0, (strlen($text) - $pad)); } } /** * AES的解密********************** * * 用于encryptedData * **********************************/ class Prpcrypt { public $key; //构造函数,用密钥初始化 function Prpcrypt( $k ) { $this->key = $k; } /** * 对密文进行解密 * @param string $aesCipher 需要解密的密文 * @param string $aesIV 解密的初始向量 * @return string 解密得到的明文 */ public function decrypt( $aesCipher, $aesIV ) { try { //设置为“128位、CBC模式的AES解密” $module = mcrypt_module_open(MCRYPT_RIJNDAEL_128, '', MCRYPT_MODE_CBC, ''); //用密钥key、初始化向量初始化 mcrypt_generic_init($module, $this->key, $aesIV); //**执行解密**(得到带有PKCS#7填充的半原文,所以要去除填充) $decrypted = mdecrypt_generic($module, $aesCipher); //清理工作与关闭解密 mcrypt_generic_deinit($module); mcrypt_module_close($module); } catch (Exception $e) { return array(ErrorCode::$IllegalBuffer, null); } try { //去除补位字符(对半原文去除PKCS#7填充) $pkc_encoder = new PKCS7Encoder; //最终得到结果$result $result = $pkc_encoder->decode($decrypted); } catch (Exception $e) { //print $e; return array(ErrorCode::$IllegalBuffer, null); } return array(0, $result); } } ?>
4:errorCode.php(错误代码)
<?php
/**
* error code 说明.
* <ul>
* <li>-41001: encodingAesKey 非法</li>
* <li>-41003: aes 解密失败</li>
* <li>-41004: 解密后得到的buffer非法</li>
* <li>-41005: base64加密失败</li>
* <li>-41016: base64解密失败</li>
* </ul>
*/
class ErrorCode
{
public static $OK = 0;
public static $IllegalAesKey = -41001; //非法密钥
public static $IllegalIv = -41002; //非法初始向量
public static $IllegalBuffer = -41003; //非法密文
public static $DecodeBase64Error = -41004; //解码错误
}
?>