# 服務(wù)端獲取開(kāi)放數(shù)據(jù)
小程序可以通過(guò)各種前端接口獲取微信提供的開(kāi)放數(shù)據(jù)??紤]到開(kāi)發(fā)者服務(wù)端也需要獲取這些開(kāi)放數(shù)據(jù),微信提供了兩種獲取方式:
- 方式一:開(kāi)發(fā)者后臺(tái)校驗(yàn)與解密開(kāi)放數(shù)據(jù)
- 方式二:云調(diào)用直接獲取開(kāi)放數(shù)據(jù)(云開(kāi)發(fā))
# 方式一:開(kāi)發(fā)者后臺(tái)校驗(yàn)與解密開(kāi)放數(shù)據(jù)
微信會(huì)對(duì)這些開(kāi)放數(shù)據(jù)做簽名和加密處理。開(kāi)發(fā)者后臺(tái)拿到開(kāi)放數(shù)據(jù)后可以對(duì)數(shù)據(jù)進(jìn)行校驗(yàn)簽名和解密,來(lái)保證數(shù)據(jù)不被篡改。

簽名校驗(yàn)以及數(shù)據(jù)加解密涉及用戶的會(huì)話密鑰 session_key。 開(kāi)發(fā)者應(yīng)該事先通過(guò) wx.login 登錄流程獲取會(huì)話密鑰 session_key 并保存在服務(wù)器。為了數(shù)據(jù)不被篡改,開(kāi)發(fā)者不應(yīng)該把 session_key 傳到小程序客戶端等服務(wù)器外的環(huán)境。
# 數(shù)據(jù)簽名校驗(yàn)
為了確保開(kāi)放接口返回用戶數(shù)據(jù)的安全性,微信會(huì)對(duì)明文數(shù)據(jù)進(jìn)行簽名。開(kāi)發(fā)者可以根據(jù)業(yè)務(wù)需要對(duì)數(shù)據(jù)包進(jìn)行簽名校驗(yàn),確保數(shù)據(jù)的完整性。
- 通過(guò)調(diào)用接口(如 wx.getUserInfo)獲取數(shù)據(jù)時(shí),接口會(huì)同時(shí)返回 rawData、signature,其中 signature = sha1( rawData + session_key )
- 開(kāi)發(fā)者將 signature、rawData 發(fā)送到開(kāi)發(fā)者服務(wù)器進(jìn)行校驗(yàn)。服務(wù)器利用用戶對(duì)應(yīng)的 session_key 使用相同的算法計(jì)算出簽名 signature2 ,比對(duì) signature 與 signature2 即可校驗(yàn)數(shù)據(jù)的完整性。
如 wx.getUserInfo的數(shù)據(jù)校驗(yàn):
接口返回的rawData:
{
"nickName": "Band",
"gender": 1,
"language": "zh_CN",
"city": "Guangzhou",
"province": "Guangdong",
"country": "CN",
"avatarUrl": "http://wx.qlogo.cn/mmopen/vi_32/1vZvI39NWFQ9XM4LtQpFrQJ1xlgZxx3w7bQxKARol6503Iuswjjn6nIGBiaycAjAtpujxyzYsrztuuICqIM5ibXQ/0"
}
用戶的 session-key:
HyVFkGl5F5OQWJZZaNzBBg==
用于簽名的字符串為:
{"nickName":"Band","gender":1,"language":"zh_CN","city":"Guangzhou","province":"Guangdong","country":"CN","avatarUrl":"http://wx.qlogo.cn/mmopen/vi_32/1vZvI39NWFQ9XM4LtQpFrQJ1xlgZxx3w7bQxKARol6503Iuswjjn6nIGBiaycAjAtpujxyzYsrztuuICqIM5ibXQ/0"}HyVFkGl5F5OQWJZZaNzBBg==
使用sha1得到的結(jié)果為
75e81ceda165f4ffa64f4068af58c64b8f54b88c
# 加密數(shù)據(jù)解密算法
接口如果涉及敏感數(shù)據(jù)(如wx.getUserInfo當(dāng)中的 openId 和 unionId),接口的明文內(nèi)容將不包含這些敏感數(shù)據(jù)。開(kāi)發(fā)者如需要獲取敏感數(shù)據(jù),需要對(duì)接口返回的加密數(shù)據(jù)(encryptedData) 進(jìn)行對(duì)稱解密。 解密算法如下:
- 對(duì)稱解密使用的算法為 AES-128-CBC,數(shù)據(jù)采用PKCS#7填充。
- 對(duì)稱解密的目標(biāo)密文為 Base64_Decode(encryptedData)。
- 對(duì)稱解密秘鑰 aeskey = Base64_Decode(session_key), aeskey 是16字節(jié)。
- 對(duì)稱解密算法初始向量 為Base64_Decode(iv),其中iv由數(shù)據(jù)接口返回。
微信官方提供了多種編程語(yǔ)言的示例代碼((點(diǎn)擊下載)。每種語(yǔ)言類型的接口名字均一致。調(diào)用方式可以參照示例。
另外,為了應(yīng)用能校驗(yàn)數(shù)據(jù)的有效性,會(huì)在敏感數(shù)據(jù)加上數(shù)據(jù)水印( watermark )
watermark參數(shù)說(shuō)明:
| 參數(shù) | 類型 | 說(shuō)明 |
|---|---|---|
| appid | String | 敏感數(shù)據(jù)歸屬 appId,開(kāi)發(fā)者可校驗(yàn)此參數(shù)與自身 appId 是否一致 |
| timestamp | Int | 敏感數(shù)據(jù)獲取的時(shí)間戳, 開(kāi)發(fā)者可以用于數(shù)據(jù)時(shí)效性校驗(yàn) |
如接口 wx.getUserInfo 敏感數(shù)據(jù)當(dāng)中的 watermark:
{
"openId": "OPENID",
"nickName": "NICKNAME",
"gender": GENDER,
"city": "CITY",
"province": "PROVINCE",
"country": "COUNTRY",
"avatarUrl": "AVATARURL",
"unionId": "UNIONID",
"watermark":
{
"appid":"APPID",
"timestamp":TIMESTAMP
}
}
注:
- 解密后得到的json數(shù)據(jù)根據(jù)需求可能會(huì)增加新的字段,舊字段不會(huì)改變和刪減,開(kāi)發(fā)者需要預(yù)留足夠的空間
# 會(huì)話密鑰 session_key 有效性
開(kāi)發(fā)者如果遇到因?yàn)?session_key 不正確而校驗(yàn)簽名失敗或解密失敗,請(qǐng)關(guān)注下面幾個(gè)與 session_key 有關(guān)的注意事項(xiàng)。
- wx.login 調(diào)用時(shí),用戶的 session_key 可能會(huì)被更新而致使舊 session_key 失效(刷新機(jī)制存在最短周期,如果同一個(gè)用戶短時(shí)間內(nèi)多次調(diào)用 wx.login,并非每次調(diào)用都導(dǎo)致 session_key 刷新)。開(kāi)發(fā)者應(yīng)該在明確需要重新登錄時(shí)才調(diào)用 wx.login,及時(shí)通過(guò) code2Session 接口更新服務(wù)器存儲(chǔ)的 session_key。
- 微信不會(huì)把 session_key 的有效期告知開(kāi)發(fā)者。我們會(huì)根據(jù)用戶使用小程序的行為對(duì) session_key 進(jìn)行續(xù)期。用戶越頻繁使用小程序,session_key 有效期越長(zhǎng)。
- 開(kāi)發(fā)者在 session_key 失效時(shí),可以通過(guò)重新執(zhí)行登錄流程獲取有效的 session_key。使用接口 wx.checkSession可以校驗(yàn) session_key 是否有效,從而避免小程序反復(fù)執(zhí)行登錄流程。
- 當(dāng)開(kāi)發(fā)者在實(shí)現(xiàn)自定義登錄態(tài)時(shí),可以考慮以 session_key 有效期作為自身登錄態(tài)有效期,也可以實(shí)現(xiàn)自定義的時(shí)效性策略。
# 方式二:云調(diào)用直接獲取開(kāi)放數(shù)據(jù)
接口如果涉及敏感數(shù)據(jù)(如wx.getWeRunData),接口的明文內(nèi)容將不包含這些敏感數(shù)據(jù),而是在返回的接口中包含對(duì)應(yīng)敏感數(shù)據(jù)的 cloudID 字段,數(shù)據(jù)可以通過(guò)云函數(shù)獲取。完整流程如下:
1. 獲取 cloudID
使用 2.7.0 或以上版本的基礎(chǔ)庫(kù),如果小程序已開(kāi)通云開(kāi)發(fā),在開(kāi)放數(shù)據(jù)接口的返回值中可以通過(guò) cloudID 字段獲?。ㄅc encryptedData 同級(jí)),cloudID 有效期五分鐘。
2. 調(diào)用云函數(shù)
調(diào)用云函數(shù)時(shí),對(duì)傳入的 data 參數(shù),如果有頂層字段的值為通過(guò) wx.cloud.CloudID 構(gòu)造的 CloudID,則調(diào)用云函數(shù)時(shí),這些字段的值會(huì)被替換為 cloudID 對(duì)應(yīng)的開(kāi)放數(shù)據(jù),一次調(diào)用最多可替換 5 個(gè) CloudID。
示例:
在小程序獲取到 cloudID 之后發(fā)起調(diào)用:
wx.cloud.callFunction({
name: 'myFunction',
data: {
weRunData: wx.cloud.CloudID('xxx'), // 這個(gè) CloudID 值到云函數(shù)端會(huì)被替換
obj: {
shareInfo: wx.cloud.CloudID('yyy'), // 非頂層字段的 CloudID 不會(huì)被替換,會(huì)原樣字符串展示
}
}
})
在云函數(shù)收到的 event 示例:
// event
{
// weRunData 的值已被替換為開(kāi)放數(shù)據(jù)
"weRunData": {
"cloudID": "xxx",
"data": {
"stepInfoList": [
{
"step": 5000,
"timestamp": 1554814312,
}
],
"watermark": {
"appid": "wx1111111111",
"timestamp": 1554815786
}
}
},
"obj": {
// 非頂層字段維持原樣
"shareInfo": "yyy",
}
}
如果 cloudID 非法或過(guò)期,則在 event 中獲取得到的將是一個(gè)有包含錯(cuò)誤碼、錯(cuò)誤信息和原始 cloudID 的對(duì)象。過(guò)期 cloudID 換取結(jié)果示例:
// event
{
"weRunData": {
"cloudID": "xxx",
"errCode": -601006,
"errMsg": "cloudID expired."
},
// ...
}