鉴权是指验证用户是否拥有访问系统的权限,来避免因权限控制缺失或操作不当引发的安全风险问题,ZEGO 通过 Token(包括基础鉴权 Token 和权限认证 Token) 对用户进行鉴权。
鉴权方式 | 描述 | 应用场景 |
---|---|---|
基础鉴权 Token | 开发者在登录房间时必须带上 Token 参数,来验证用户的合法性。 | 基础鉴权 Token 为 Token 的基本能力,用于业务的简单权限验证场景,绝大多数情况下生成该 Token 即可。 |
权限认证 Token | 为了进一步提高安全性开放了房间 ID 和推流 ID 这两个权限位,可以验证登录房间的 ID 和推流 ID。 | 房间 ID 和推流 ID 权限位的一般使用场景如下:
|
使用 Token 鉴权时,需要开发者先生成 Token,再携带 Token 登录房间。ZEGO 服务端对带着 Token 的用户进行校验。
以使用 Token 判断用户是否能登录房间为例介绍使用流程,如下图:
本节将详细介绍开发者如何生成 Token、如何使用 Token 和 Token 过期时的处理方式。
生成 Token 需要开发者项目的唯一标识 AppId 和密钥 ServerSecret,请参考 控制台 - 项目管理 中的 “项目信息”获取。
zego_server_assistant 插件中用于服务端生成 Token 的各语言参考信息如下:
开发者获得项目的 AppID 和 ServerSecret 信息后,根据实际业务需求,即可在自己的服务端生成 Token。开发者客户端向开发者服务端发送申请 Token 请求,由开发者服务端生成 Token 后返回给到对应客户端。
ZEGO 在 GitHub/Gitee 提供了一个开源的 zego_server_assistant 插件,支持使用 Go、C++、Java、Objective-C、Python、PHP、.NET、Node.js 语言,在开发者的服务端部署生成 Token。
zego_server_assistant 插件中提供了生成权限认证 Token 的示例代码,权限认证 Token 是在登录房间鉴权后,为了进一步提高安全性,开放房间 ID 和推流 ID 这两个权限位,可以验证登录房间的 ID 和推流 ID,此时 “payload” 字段需要按照规格生成。权限位校验规则如下:
zego_server_assistant 插件中用于服务端生成 Token 的各语言参考信息如下:
语言 | 支持版本 | 关键函数 | 代码库地址 | 示例代码地址 |
---|---|---|---|---|
Go |
Go 1.14.15 或以上版本 |
GenerateToken04 |
||
C++ |
C++ 11 或以上版本 |
GenerateToken04 |
||
Java |
Java 1.8 或以上版本 |
generateToken04 |
||
Python |
Python 3.6.8 或以上版本 |
generate_token04 |
||
PHP |
PHP 5.6 或以上版本 |
generateToken04 |
||
.NET |
.NET Framework 3.5 或以上版本 |
GenerateToken04 |
||
Node.js |
Node.js 8 或以上版本 |
generateToken04 |
以 Go 语言为例,开发者可参考以下步骤使用 zego_server_assistant 生成 Token:
小程序平台生成 Token 时必须传入 “RoomId”。
git clone https://github.com/zegoim/zego_server_assistant
获取依赖包。import "github.com/zegoim/zego_server_assistant/token/go/src/token04"
引入插件。生成 Token 的示例代码如下:
package main
import (
"encoding/json"
"fmt"
"github.com/zegoim/zego_server_assistant/token/go/src/token04"
)
/*
权限认证 Token 生成示例代码
*/
//token业务扩展:权限认证属性
type RtcRoomPayLoad struct {
RoomId string `json:"room_id"` //房间id(必填);用于对接口的房间 id 进行强验证
Privilege map[int]int `json:"privilege"` //权限位开关列表;用于对接口的操作权限进行强验证
StreamIdList []string `json:"stream_id_list"` //流列表;用于对接口的流id进行强验证;允许为空,如果为空,则不对流id验证
}
func main() {
var appId uint32 = 1
roomId := "demo"
userId := "demo"
serverSecret := "fa94dd0f974cf2e293728a526b028271"
var effectiveTimeInSeconds int64 = 3600
privilege := make(map[int]int)
privilege[token04.PrivilegeKeyLogin] = token04.PrivilegeEnable
privilege[token04.PrivilegeKeyPublish] = token04.PrivilegeDisable
payloadData := &RtcRoomPayLoad{
RoomId: roomId,
Privilege: privilege,
StreamIdList: nil,
}
payload, err := json.Marshal(payloadData)
if err != nil {
fmt.Println(err)
return
}
token, err := token04.GenerateToken04(appId, userId, serverSecret, effectiveTimeInSeconds, string(payload))
if err != nil {
fmt.Println(err)
return
}
fmt.Println(token)
}
临时 Token 获取方式
为方便开发者体验使用 Token 鉴权,ZEGO 控制台 提供生成临时 Token 的功能,开发者可直接获取临时 Token 来使用,详情请参考 控制台 - 开发辅助。但是在开发者自己的线上环境中,一定要通过自己的服务端生成 Token。
用户携带获取到的 Token 和 userID、roomID 信息,通过 loginRoom 接口登录对应的房间。
调用 loginRoom 接口登录房间时使用的 userID,必须和 “4.2 生成 Token” 时使用的 userID 保持一致。
let roomID = 'xxx' // 要登录的房间 ID
let token = 'xxxxxxxxxx' // 请求开发者服务端获取
let user = {userID : 'xxxx'} // 房间内用户唯一标识
let loginResult = zg.loginRoom(roomID, token, user): Promise<boolean>
如果开发者需要在登录房间后修改推流权限位,可以调用 renewToken 接口更新 Token,更新后会影响下一次登推流的权限,之前已经成功的推流不受影响。
let token = await getToken(); // 重新请求开发者服务端获取 Token;
zg.renewToken(token);
Token 过期可能导致推拉流异常等问题,请严格按照以下说明,及时处理过期 Token。
在 Token 过期前 30 秒,SDK 会通过 tokenWillExpire 回调发出通知。
收到该回调后,开发者需要从自己的服务端获取新的有效 Token,并调用 SDK 提供的 renewToken 接口更新 Token。否则:
zg.on('tokenWillExpire',(roomID: string)=>{
let token = await getToken(); // 重新请求开发者服务端获取 Token
zg.renewToken(token);
});
方法 | 描述 |
---|---|
loginRoom | 登录房间 |
renewToken | 更新 Token |
tokenWillExpire | Token 过期回调 |
联系我们
文档反馈