如何计算 UserSig

最近更新时间:2019-08-20 15:33:21

UserSig 介绍

UserSig 是腾讯云设计的一种安全保护签名,目的是为了阻止恶意攻击者盗用您的云服务使用权。

目前,腾讯云的实时音视频(TRTC)、即时通信(IM)以及移动直播(MLVB)等服务都采用了该套安全保护机制。要使用这些服务,您都需要在相应 SDK 的初始化或登录函数中提供 SDKAppID,UserID 和 UserSig 三个关键信息。

其中 SDKAppID 用于标识您的应用,UserID 用于标识您的用户,而 UserSig 则是基于前两者计算出的安全签名,它由 HMAC SHA256 加密算法计算得出。只要攻击者不能伪造 UserSig,就无法盗用您的云服务流量。

UserSig 的计算原理如下图所示,其本质就是对 SDKAppID、UserID、ExpireTime 等关键信息进行了一次哈希加密:

//UserSig 计算公式,其中 secretkey 为计算 usersig 用的加密密钥

usersig = hmacsha256(secretkey, (userid + sdkappid + currtime + expire + 
                                 base64(userid + sdkappid + currtime + expire)))

密钥获取

访问腾讯实时音视频 控制台可以查询计算 UserSig 用的密钥,方法如下:

  1. 单击应用卡片,进入【快速上手】页面。
  2. 单击【第二步 获取签发UserSig的密钥】区域的【查看密钥】,即可获取用于计算 UserSig 的加密密钥。
  3. 单击【复制密钥】,将密钥拷贝到剪贴板中。

客户端计算

我们在 TRTC SDK 的示例代码中提供了一个叫做 GenerateTestUserSig 的开源模块,您只需要将其中的 SDKAPPID、EXPIRETIME 和 SECRETKEY 三个成员变量修改成您自己的配置,就可以调用 genTestUserSig() 函数获取计算好的 UserSig,从而快速跑通 SDK 的相关功能:

适用平台 文件源码链接 文件相对路径
iOS Github iOS/TRTCDemo/TRTC/GenerateTestUserSig.h
Mac Github Mac/TRTCDemo/TRTC/GenerateTestUserSig.h
Android Github Android/TRTCDemo/app/src/main/java/com/tencent/liteav/demo/trtc/debug/GenerateTestUserSig.java
Windows(C++) Github Windows/DuilibDemo/GenerateTestUserSig.h
Windows(C#) Github Windows/CSharpDemo/GenerateTestUserSig.cs
Web Github H5/js/debug/GenerateTestUserSig.js
微信小程序 Github WXMini/pages/webrtc-room/debug/GenerateTestUserSig.js

注意:

该方案仅适用于调试,如果产品要正式上线,不推荐采用这种方案,因为客户端代码(尤其是 Web 端)中的 SECRETKEY 很容易被反编译逆向破解。一旦您的密钥泄露,攻击者就可以盗用您的腾讯云流量。

正确的做法是将 UserSig 的计算代码放在您的业务服务器上,然后由您的 App 在需要的时候向您的服务器获取实时算出的 UserSig。

服务端计算

采用服务端计算 UserSig 的方案,可以最大限度地保障计算 UserSig 用的密钥不被泄露,因为攻破一台服务器的难度要高于逆向一款 App。具体的做法如下:

  1. 您的 App 在调用 SDK 的初始化函数之前,首先要向您的服务器请求 UserSig。
  2. 您的服务器根据 SDKAppID 和 UserID 计算 UserSig,计算源码见文档前半部分。
  3. 服务器将计算好的 UserSig 返回给您的 App。
  4. 您的 App 将获得的 UserSig 通过特定 API 传递给 SDK。
  5. SDK 将 SDKAppID + UserID + UserSig 提交给腾讯云服务器进行校验。
  6. 腾讯云校验 UserSig,确认合法性。
  7. 校验通过后,会向 TRTCSDK 提供实时音视频服务。

为了简化您的实现过程,我们提供了多个语言版本的 UserSig 计算源代码:

语言版本 签名算法 关键函数 下载链接
Java HMAC-SHA256 genSig Github
GO HMAC-SHA256 GenSig Github
PHP HMAC-SHA256 genSig Github
Nodejs HMAC-SHA256 genSig Github
Python HMAC-SHA256 gen_sig Github
C# HMAC-SHA256 GenSig Github

老版本算法

为了简化签名计算难度,方便客户更快速地使用腾讯云服务,实时音视频自2019.07.19开始启用新的签名算法,从之前的 ECDSA-SHA256 升级为 HMAC-SHA256,也就是从2019.07.19之后创建的 SDKAppID 均会采用新的 HMAC-SHA256 算法。

如果您的 SDKAppID 是 2019.07.19 之前创建的,可以继续使用老版本的签名算法,算法的源码下载链接如下:

语言版本 签名算法 下载链接
Java ECDSA-SHA256 Github
C++ ECDSA-SHA256 Github
GO ECDSA-SHA256 Github
PHP ECDSA-SHA256 Github
Nodejs ECDSA-SHA256 Github
C# ECDSA-SHA256 Github
Python ECDSA-SHA256 Github