# 使用 Token 鉴权 (/zh-CN/realtime-media/rtc/build/setup-and-access/token-authentication/blueprint) > For AI agents: see the complete documentation index at [llms.txt](/llms.txt). 鉴权是指在用户访问你的系统前,对用户权限进行校验,声网用 Token 对用户鉴权。[Token](/zh-CN/introduction/glossary#token) 也称为动态密钥,是在加入频道时用于校验用户权限的一组字符串。当 App 用户使用声网服务,如加入 RTC 频道时传入 Token,声网服务端会根据 Token 中的信息校验用户的权限。 你可以根据你的使用场景,通过下列任意一种方式来设置 Token 的权限: - **统一设置权限**:统一设置加入频道并发流的权限,适用于绝大多数场景,详见[实现 Token 鉴权](#basic-token)。 - **精细控制发布不同流的权限**:开通连麦鉴权功能,分别设置在频道内发布音频流、视频流、数据流的权限,适用于对安全要求较高的场景,详见[使用连麦鉴权](#advanced)。 下图展示声网使用 Token 对用户鉴权的流程: ![token 流程](https://web-cdn.agora.io/docs-portal/img/rtc/token-authentication.svg) ## 前提条件 [#前提条件-12] 开始前,请确保你的项目满足如下条件: - 已开启 App 证书的声网项目以及项目的 App ID,可参考[开通 RTC 服务](/zh-CN/realtime-media/rtc/build/setup-and-access/enable-service)获取。 - 已在你的项目中集成实时互动 SDK 并实现基本的实时互动功能,详见[实现音视频互动](/zh-CN/realtime-media/rtc/get-started/quick-start)。 ## 实现 Token 鉴权 [#实现-token-鉴权-7] 本节以生成 RTC Token 并加入频道为例,介绍如何使用 Token 进行鉴权。为确保你的业务的安全性,声网推荐你对每一个加入频道的客户端都进行鉴权。 ### 生成 Token [#生成-token-15] 声网在 GitHub 上提供一个开源的 Token 生成器代码仓库 [AgoraDynamicKey](https://github.com/AgoraIO/Tools/tree/master/DynamicKey/AgoraDynamicKey),支持使用 C++、Java、Golang 等多种语言来在你自己的服务器上生成 Token。 以下列出的语言均基于 HMAC-SHA256 算法生成 Token。 | 语言 | 核心方法 | 示例代码 | |:------|:----------------------------------------------------------- |:----------------------------------------------------------- | | C++ | [buildTokenWithUid](https://github.com/AgoraIO/Tools/blob/master/DynamicKey/AgoraDynamicKey/cpp/src/RtcTokenBuilder2.h) | [RtcTokenBuilder2Sample.cpp](https://github.com/AgoraIO/Tools/tree/master/DynamicKey/AgoraDynamicKey/cpp/sample/RtcTokenBuilder2Sample.cpp) | | Golang |[BuildTokenWithUid](https://github.com/AgoraIO/Tools/blob/master/DynamicKey/AgoraDynamicKey/go/src/rtctokenbuilder2/rtctokenbuilder.go) | [sample.go](https://github.com/AgoraIO/Tools/tree/master/DynamicKey/AgoraDynamicKey/go/sample/rtctokenbuilder2/sample.go) | | Java |[buildTokenWithUid](https://github.com/AgoraIO/Tools/blob/master/DynamicKey/AgoraDynamicKey/java/src/main/java/io/agora/media/RtcTokenBuilder2.java) | [RtcTokenBuilder2Sample.java](https://github.com/AgoraIO/Tools/tree/master/DynamicKey/AgoraDynamicKey/java/src/main/java/io/agora/sample/RtcTokenBuilder2Sample.java) | | Node.js |[buildTokenWithUid](https://github.com/AgoraIO/Tools/blob/master/DynamicKey/AgoraDynamicKey/nodejs/src/RtcTokenBuilder2.js) | [RtcTokenBuilder2Sample.js](https://github.com/AgoraIO/Tools/tree/master/DynamicKey/AgoraDynamicKey/nodejs/sample/RtcTokenBuilder2Sample.js) | | PHP |[buildTokenWithUid](https://github.com/AgoraIO/Tools/blob/master/DynamicKey/AgoraDynamicKey/php/src/RtcTokenBuilder2.php) | [RtcTokenBuilder2Sample.php](https://github.com/AgoraIO/Tools/tree/master/DynamicKey/AgoraDynamicKey/php/sample/RtcTokenBuilder2Sample.php) | | Python |[build_token_with_uid](https://github.com/AgoraIO/Tools/blob/master/DynamicKey/AgoraDynamicKey/python/src/RtcTokenBuilder2.py) | [RtcTokenBuilder2Sample.py](https://github.com/AgoraIO/Tools/tree/master/DynamicKey/AgoraDynamicKey/python/sample/RtcTokenBuilder2Sample.py) | | Python3 |[build_token_with_uid](https://github.com/AgoraIO/Tools/blob/master/DynamicKey/AgoraDynamicKey/python3/src/RtcTokenBuilder2.py) | [RtcTokenBuilder2Sample.py](https://github.com/AgoraIO/Tools/tree/master/DynamicKey/AgoraDynamicKey/python3/sample/RtcTokenBuilder2Sample.py) | 以 C++ 为例,你可以通过 `privilege_expiration_in_seconds` 来统一设置所有权限的过期时间。 示例代码如下: C++ Golang Java Node.js PHP Python Python3 ```cpp #include #include #include "../src/RtcTokenBuilder2.h" using namespace agora::tools; int main(int argc, char const *argv[]) { (void)argc; (void)argv; // 获取环境变量 AGORA_APP_ID 的值。请确保你将该变量设为你在声网控制台获取的 App ID const char *env_app_id = getenv("AGORA_APP_ID"); std::string app_id = env_app_id ? env_app_id : ""; // 获取环境变量 AGORA_APP_CERTIFICATE 的值。请确保你将该变量设为你在声网控制台获取的 App 证书 const char *env_app_certificate = getenv("AGORA_APP_CERTIFICATE"); std::string app_certificate = env_app_certificate ? env_app_certificate : ""; // 将 channelName 替换为需要加入的频道名 std::string channel_name = "channelName"; // 填入你实际的用户 ID uint32_t uid = "uid"; // Token 的有效时间,单位秒 uint32_t token_expiration_in_seconds = 3600; // 所有的权限的有效时间,单位秒,声网建议你将该参数和 Token 的有效时间设为一致 uint32_t privilege_expiration_in_seconds = 3600; std::string result; std::cout << "App Id:" << app_id << std::endl; std::cout << "App Certificate:" << app_certificate << std::endl; if (app_id == "" || app_certificate == "") { std::cout << "Need to set environment variable AGORA_APP_ID and " "AGORA_APP_CERTIFICATE" << std::endl; return -1; } // 生成 Token result = RtcTokenBuilder2::BuildTokenWithUid( app_id, app_certificate, channel_name, uid, UserRole::kRolePublisher, token_expiration_in_seconds, privilege_expiration_in_seconds); std::cout << "Token With Int Uid:" << result << std::endl; return 0; } ``` ```go package main import ( "fmt" "os" rtctokenbuilder "github.com/AgoraIO/Tools/DynamicKey/AgoraDynamicKey/go/src/rtctokenbuilder2" ) func main() { // 获取环境变量 AGORA_APP_ID 的值。请确保你将该变量设为你在声网控制台获取的 App ID appId := os.Getenv("AGORA_APP_ID") // 获取环境变量 AGORA_APP_CERTIFICATE 的值。请确保你将该变量设为你在声网控制台获取的 App 证书 appCertificate := os.Getenv("AGORA_APP_CERTIFICATE") // 将 channelName 替换为需要加入的频道名 channelName := "channelName" // 填入你实际的用户 ID uid := uint32(uid) // Token 的有效时间,单位秒 tokenExpirationInSeconds := uint32(3600) // 所有的权限的有效时间,单位秒,声网建议你将该参数和 Token 的有效时间设为一致 privilegeExpirationInSeconds := uint32(3600) fmt.Println("App Id:", appId) fmt.Println("App Certificate:", appCertificate) if appId == "" || appCertificate == "" { fmt.Println("Need to set environment variable AGORA_APP_ID and AGORA_APP_CERTIFICATE") return } // 生成 Token result, err := rtctokenbuilder.BuildTokenWithUid(appId, appCertificate, channelName, uid, rtctokenbuilder.RolePublisher, tokenExpirationInSeconds, privilegeExpirationInSeconds) if err != nil { fmt.Println(err) } else { fmt.Printf("Token with int uid: %s\n", result) } } ``` ```java package io.agora.sample; import io.agora.media.RtcTokenBuilder2; import io.agora.media.RtcTokenBuilder2.Role; public class RtcTokenBuilder2Sample { // 获取环境变量 AGORA_APP_ID 的值。请确保你将该变量设为你在声网控制台获取的 App ID static String appId = System.getenv("AGORA_APP_ID"); // 获取环境变量 AGORA_APP_CERTIFICATE 的值。请确保你将该变量设为你在声网控制台获取的 App 证书 static String appCertificate = System.getenv("AGORA_APP_CERTIFICATE"); // 将 channelName 替换为需要加入的频道名 static String channelName = "channelName"; // 填入你实际的用户 ID static int uid = 2082341273; // Token 的有效时间,单位秒 static int tokenExpirationInSeconds = 3600; // 所有的权限的有效时间,单位秒,声网建议你将该参数和 Token 的有效时间设为一致 static int privilegeExpirationInSeconds = 3600; public static void main(String[] args) { System.out.printf("App Id: %s\n", appId); System.out.printf("App Certificate: %s\n", appCertificate); if (appId == null || appId.isEmpty() || appCertificate == null || appCertificate.isEmpty()) { System.out.printf("Need to set environment variable AGORA_APP_ID and AGORA_APP_CERTIFICATE\n"); return; } // 生成 Token RtcTokenBuilder2 token = new RtcTokenBuilder2(); String result = token.buildTokenWithUid(appId, appCertificate, channelName, uid, Role.ROLE_PUBLISHER, tokenExpirationInSeconds, privilegeExpirationInSeconds); System.out.printf("Token with uid: %s\n", result); } } ``` ```javascript const RtcTokenBuilder = require("../src/RtcTokenBuilder2").RtcTokenBuilder; const RtcRole = require("../src/RtcTokenBuilder2").Role; // 获取环境变量 AGORA_APP_ID 的值。请确保你将该变量设为你在声网控制台获取的 App ID const appId = process.env.AGORA_APP_ID; // 获取环境变量 AGORA_APP_CERTIFICATE 的值。请确保你将该变量设为你在声网控制台获取的 App 证书 const appCertificate = process.env.AGORA_APP_CERTIFICATE; // 将 channelName 替换为需要加入的频道名 const channelName = "channelName"; // 填入你实际的用户 ID const uid = "uid"; // 设为具有发流权限 const role = RtcRole.PUBLISHER; // Token 的有效时间,单位秒 const tokenExpirationInSecond = 3600; // 所有的权限的有效时间,单位秒,声网建议你将该参数和 Token 的有效时间设为一致 const privilegeExpirationInSecond = 3600; console.log("App Id:", appId); console.log("App Certificate:", appCertificate); if (appId == undefined || appId == "" || appCertificate == undefined || appCertificate == "") { console.log("Need to set environment variable AGORA_APP_ID and AGORA_APP_CERTIFICATE"); process.exit(1); } // 生成 Token const tokenWithUid = RtcTokenBuilder.buildTokenWithUid(appId, appCertificate, channelName, uid, role, tokenExpirationInSecond, privilegeExpirationInSecond); console.log("Token with int uid:", tokenWithUid); ``` ```php ```py import os import sys sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))) from src.RtcTokenBuilder2 import * def main(): # 获取环境变量 AGORA_APP_ID 的值。请确保你将该变量设为你在声网控制台获取的 App ID app_id = os.environ.get("AGORA_APP_ID") # 获取环境变量 AGORA_APP_CERTIFICATE 的值。请确保你将该变量设为你在声网控制台获取的 App 证书 app_certificate = os.environ.get("AGORA_APP_CERTIFICATE") # 将 channel_name 替换为需要加入的频道名 channel_name = "channel_name" # 填入你实际的用户 ID uid = "uid" # Token 的有效时间,单位秒 token_expiration_in_seconds = 3600 # 所有的权限的有效时间,单位秒,声网建议你将该参数和 Token 的有效时间设为一致 privilege_expiration_in_seconds = 3600 print("App Id: %s" % app_id) print("App Certificate: %s" % app_certificate) if not app_id or not app_certificate: print("Need to set environment variable AGORA_APP_ID and AGORA_APP_CERTIFICATE") return # 生成 Token token = RtcTokenBuilder.build_token_with_uid(app_id, app_certificate, channel_name, uid, Role_Publisher, token_expiration_in_seconds, privilege_expiration_in_seconds) print("Token with int uid: {}".format(token)) if __name__ == "__main__": main() ``` ```py import os import sys sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))) from src.RtcTokenBuilder2 import * def main(): # 获取环境变量 AGORA_APP_ID 的值。请确保你将该变量设为你在声网控制台获取的 App ID app_id = os.environ.get("AGORA_APP_ID") # 获取环境变量 AGORA_APP_CERTIFICATE 的值。请确保你将该变量设为你在声网控制台获取的 App 证书 app_certificate = os.environ.get("AGORA_APP_CERTIFICATE") # 将 channel_name 替换为需要加入的频道名 channel_name = "channel_name" # 填入你实际的用户 ID uid = "uid" # Token 的有效时间,单位秒 token_expiration_in_seconds = 3600 # 所有的权限的有效时间,单位秒,声网建议你将该参数和 Token 的有效时间设为一致 privilege_expiration_in_seconds = 3600 print("App Id: %s" % app_id) print("App Certificate: %s" % app_certificate) if not app_id or not app_certificate: print("Need to set environment variable AGORA_APP_ID and AGORA_APP_CERTIFICATE") return # 生成 Token token = RtcTokenBuilder.build_token_with_uid(app_id, app_certificate, channel_name, uid, Role_Publisher, token_expiration_in_seconds, privilege_expiration_in_seconds) print("Token with int uid: {}".format(token)) if __name__ == "__main__": main() ``` :::info[信息] - 以上示例代码中使用的是 `int` 型的用户 ID 来生成 Token。如果你需要使用 `string` 型的用户 ID 来生成 Token,请前往 [Token 生成器代码仓库](https://github.com/AgoraIO/Tools/tree/master/DynamicKey/AgoraDynamicKey)查看对应语言的相关方法及示例代码。 - 如果你需要生成同时具备 RTC 和 RTM 权限的 Token,请参考[如何生成具备 RTC 和 RTM 权限的 Token?](/zh-CN/reference/faq/integration/rtc_rtm_token) ::: ### 使用 Token [#使用-token-15] 本节介绍如何使用 Token 对客户端加入频道的用户进行鉴权。 使用获取到的 Token 和用户 ID、频道名等信息,通过 `joinChannel`[2/2] 方法加入频道。 :::warning[注意] 加入频道时使用的用户 ID 和频道名必须和生成 Token 时的用户 ID 和频道名一致。 ::: ```cpp // 频道名 const char* channelId; // 用户 ID int uid = 0 // 请求服务端生成 channelId 和 uid 对应的 token const char* token = getToken(); // 设置频道媒体选项 ChannelMediaOptions options; // 将用户角色设为主播 options.clientRoleType = CLIENT_ROLE_TYPE::CLIENT_ROLE_BROADCASTER; // 加入频道 m_rtcEngine->joinChannel(token, channelId, uid, options); ``` ### Token 过期处理 [#token-过期处理-8] 使用 Token 加入频道后,在 Token 过期前 30 秒,SDK 会触发 [`onTokenPrivilegeWillExpire`](/zh-CN/api-reference/rtc/unreal-blueprint/channel#callback_irtcengineeventhandler_ontokenprivilegewillexpire) 回调。 Token 过期时,SDK 会触发 [`onRequestToken`](/zh-CN/api-reference/rtc/unreal-blueprint/channel#onrequesttoken) 回调。 当收到上述回调后,你需要重新在服务端生成新的 Token,然后通过下列任意一种方式来更新 Token: **单频道场景** - (推荐)调用 [`renewToken`](/zh-CN/api-reference/rtc/unreal-blueprint/channel#api_irtcengine_renewtoken) 来传入新生成的 Token。 - 调用 [`updateChannelMediaOptions`](/zh-CN/api-reference/rtc/unreal-blueprint/channel#updatechannelmediaoptions) 更新 Token。 - 调用 [`leaveChannel`[2/2]](/zh-CN/api-reference/rtc/unreal-blueprint/channel#leaveChannel-[2/2]) 离开当前频道,然后再调用 [`joinChannel`[2/2]](/zh-CN/api-reference/rtc/unreal-blueprint/channel#api_irtcengine_joinchannel2) 并传入新的 Token 重新加入频道。 **多频道场景** 如果你调用了 [`joinChannelEx`](/zh-CN/api-reference/rtc/unreal-blueprint/channel#joinchannelex) 加入多个频道,需要调用 [`updateChannelMediaOptionsEx`](/zh-CN/api-reference/rtc/unreal-blueprint/channel#updatechannelmediaoptionsex) 方法来更新 Token。 **示例代码** 下列示例代码展示在收到 `onTokenPrivilegeWillExpire` 回调提示 Token 即将过期时,调用 `renewToken` 来更新 Token。 ```cpp class CJoinChannelVideoByTokenRtcEngineEventHandler : public IRtcEngineEventHandler { public: // Token 即将过期时回调 virtual void onTokenPrivilegeWillExpire(const char* token) { // 重新请求生成 Token const char* token = getToken(); // 更新 Token m_rtcEngine->renewToken(token); } } ``` ## 拓展功能(可选) [#拓展功能可选-6] 本节介绍 Token 相关的拓展功能,包括如何生成通配 Token、如何使用连麦鉴权来精细控制发流权限。 ### 生成通配 Token [#生成通配-token-7] 如果用户需要频繁切换频道、或同时加入多个频道,声网提供将**用户 ID** 或**频道名**设为通配符的通配 Token。用户可以复用同一 Token 加入不同频道,既可减少频繁获取 Token 所造成的耗时,从而加快切换、加入频道的速度,同时也能减小你的 Token 服务器的压力,详见[通配 Token](/zh-CN/realtime-media/rtc/build/security-and-auth/wildcard-token)。 ### 使用连麦鉴权 [#使用连麦鉴权-7] 声网支持精细控制频道内用户发布不同流的权限,可确保频道内的发流用户都经过授权,从而防止黑客利用业务漏洞或盗取 Token 进行直播间炸房等行为。 :::warning[注意] - 在设置前,请确保你已开启[连麦鉴权功能](/zh-CN/reference/faq/integration/token_cohost#3-开启连麦鉴权)。 - 如需在频道内发流,请确保在加入频道前,已调用 [`setClientRole`](/zh-CN/api-reference/rtc/unreal-blueprint/channel#setclientrole) 方法将用户角色设为主播(`BROADCASTER`),或是在调用 [`joinChannel`[2/2]](/zh-CN/api-reference/rtc/unreal-blueprint/channel#api_irtcengine_joinchannel2) 加入频道时通过 `options` 将 `clientRoleType` 设为 `CLIENT_ROLE_BROADCASTER`。 ::: 声网提供 `BuildTokenWithUidAndPrivilege` 方法来设置下列权限的过期时间: - 加入频道 - 频道内发布音频流 - 频道内发布视频流 - 频道内发布数据流 详细参数说明见 [API 参考](#api)。 #### 生成 Token [#生成-token-16] 声网在 GitHub 上提供一个开源的 Token 生成器代码仓库 [AgoraDynamicKey](https://github.com/AgoraIO/Tools/tree/master/DynamicKey/AgoraDynamicKey),支持使用 C++、Java、Golang 等多种语言来在你自己的服务器上生成 Token。在生成时,你可以通过不同参数分别设置发布不同流的权限。 以下列出的语言均基于 HMAC-SHA256 算法生成 Token。 | 语言 | 核心方法 | 示例代码 | |:------ |:---------- |:----------------------------------------------------------- | | C++ | [buildTokenWithUid](https://github.com/AgoraIO/Tools/blob/master/DynamicKey/AgoraDynamicKey/cpp/src/RtcTokenBuilder2.h) | [RtcTokenBuilder2Sample.cpp](https://github.com/AgoraIO/Tools/tree/master/DynamicKey/AgoraDynamicKey/cpp/sample/RtcTokenBuilder2Sample.cpp) | | Golang |[BuildTokenWithUidAndPrivilege](https://github.com/AgoraIO/Tools/blob/master/DynamicKey/AgoraDynamicKey/go/src/rtctokenbuilder2/rtctokenbuilder.go) | [sample.go](https://github.com/AgoraIO/Tools/tree/master/DynamicKey/AgoraDynamicKey/go/sample/rtctokenbuilder2/sample.go) | | Java |[buildTokenWithUid](https://github.com/AgoraIO/Tools/blob/master/DynamicKey/AgoraDynamicKey/java/src/main/java/io/agora/media/RtcTokenBuilder2.java) | [RtcTokenBuilder2Sample.java](https://github.com/AgoraIO/Tools/tree/master/DynamicKey/AgoraDynamicKey/java/src/main/java/io/agora/sample/RtcTokenBuilder2Sample.java) | | Node.js |[buildTokenWithUidAndPrivilege](https://github.com/AgoraIO/Tools/blob/master/DynamicKey/AgoraDynamicKey/nodejs/src/RtcTokenBuilder2.js) | [RtcTokenBuilder2Sample.js](https://github.com/AgoraIO/Tools/tree/master/DynamicKey/AgoraDynamicKey/nodejs/sample/RtcTokenBuilder2Sample.js) | | PHP |[buildTokenWithUidAndPrivilege](https://github.com/AgoraIO/Tools/blob/master/DynamicKey/AgoraDynamicKey/php/src/RtcTokenBuilder2.php) | [RtcTokenBuilder2Sample.php](https://github.com/AgoraIO/Tools/tree/master/DynamicKey/AgoraDynamicKey/php/sample/RtcTokenBuilder2Sample.php) | | Python |[build_token_with_uid_and_privilege](https://github.com/AgoraIO/Tools/blob/master/DynamicKey/AgoraDynamicKey/python/src/RtcTokenBuilder2.py) | [RtcTokenBuilder2Sample.py](https://github.com/AgoraIO/Tools/tree/master/DynamicKey/AgoraDynamicKey/python/sample/RtcTokenBuilder2Sample.py) | | Python3 |[build_token_with_uid_and_privilege](https://github.com/AgoraIO/Tools/blob/master/DynamicKey/AgoraDynamicKey/python3/src/RtcTokenBuilder2.py) | [RtcTokenBuilder2Sample.py](https://github.com/AgoraIO/Tools/tree/master/DynamicKey/AgoraDynamicKey/python3/sample/RtcTokenBuilder2Sample.py) | 以 C++ 为例,你可以通过 `join_channel_privilege_expiration_in_seconds`、`pub_audio_privilege_expiration_in_seconds`、`pub_video_privilege_expiration_in_seconds`、`pub_data_stream_privilege_expiration_in_seconds` 参数来分别设置加入频道、发布音频流、视频流、数据流的有效时间。 示例代码如下: ```cpp tab="C++" tabGroup="token-sample-code" #include #include #include "../src/RtcTokenBuilder2.h" using namespace agora::tools; int main(int argc, char const *argv[]) { (void)argc; (void)argv; // 获取环境变量 AGORA_APP_ID 的值。请确保你将该变量设为你在声网控制台获取的 App ID const char *env_app_id = getenv("AGORA_APP_ID"); std::string app_id = env_app_id ? env_app_id : ""; // 获取环境变量 AGORA_APP_CERTIFICATE 的值。请确保你将该变量设为你在声网控制台获取的 App 证书 const char *env_app_certificate = getenv("AGORA_APP_CERTIFICATE"); std::string app_certificate = env_app_certificate ? env_app_certificate : ""; // 将 channelName 替换为需要加入的频道名 std::string channel_name = "channelName"; // 填入你实际的用户 ID uint32_t uid = "uid"; // Token 的有效时长(秒) uint32_t token_expiration_in_seconds = 3600; // 加入频道权限的有效时长(秒),声网建议将其他权限的有效时间和该参数设为一致 uint32_t join_channel_privilege_expiration_in_seconds = 3600; // 频道内发布音频流权限的有效时长(秒) uint32_t pub_audio_privilege_expiration_in_seconds = 3600; // 频道内发布视频流权限的有效时长(秒) uint32_t pub_video_privilege_expiration_in_seconds = 3600; // 频道内发布数据流权限的有效时长(秒) uint32_t pub_data_stream_privilege_expiration_in_seconds = 3600; std::string result; std::cout << "App Id:" << app_id << std::endl; std::cout << "App Certificate:" << app_certificate << std::endl; if (app_id == "" || app_certificate == "") { std::cout << "Need to set environment variable AGORA_APP_ID and " "AGORA_APP_CERTIFICATE" << std::endl; return -1; } // 生成 Token result = RtcTokenBuilder2::BuildTokenWithUid( app_id, app_certificate, channel_name, uid, token_expiration_in_seconds, join_channel_privilege_expiration_in_seconds, pub_audio_privilege_expiration_in_seconds, pub_video_privilege_expiration_in_seconds, pub_data_stream_privilege_expiration_in_seconds); std::cout << "Token With Int Uid:" << result << std::endl; return 0; } ``` ```go tab="Go" tabGroup="token-sample-code" package main import ( "fmt" "os" rtctokenbuilder "github.com/AgoraIO/Tools/DynamicKey/AgoraDynamicKey/go/src/rtctokenbuilder2" ) func main() { // 获取环境变量 AGORA_APP_ID 的值。请确保你将该变量设为你在声网控制台获取的 App ID appId := os.Getenv("AGORA_APP_ID") // 获取环境变量 AGORA_APP_CERTIFICATE 的值。请确保你将该变量设为你在声网控制台获取的 App 证书 appCertificate := os.Getenv("AGORA_APP_CERTIFICATE") // 将 channelName 替换为需要加入的频道名 channelName := "channelName" // 填入你实际的用户 ID uid := uint32(uid) // Token 的有效时间(秒),声网建议将其他权限的有效时间和该参数设为一致 tokenExpirationInSeconds := uint32(3600) // 加入频道权限的有效时间(秒) joinChannelPrivilegeExpireInSeconds := uint32(3600) // 频道内发布音频流权限的有效时间(秒) pubAudioPrivilegeExpireInSeconds := uint32(3600) // 频道内发布视频流权限的有效时间(秒) pubVideoPrivilegeExpireInSeconds := uint32(3600) // 频道内发布数据流权限的有效时间(秒) pubDataStreamPrivilegeExpireInSeconds := uint32(3600) fmt.Println("App Id:", appId) fmt.Println("App Certificate:", appCertificate) if appId == "" || appCertificate == "" { fmt.Println("Need to set environment variable AGORA_APP_ID and AGORA_APP_CERTIFICATE") return } // 生成 Token result, err := rtctokenbuilder.BuildTokenWithUidAndPrivilege( appId, appCertificate, channelName, uid, tokenExpirationInSeconds, joinChannelPrivilegeExpireInSeconds, pubAudioPrivilegeExpireInSeconds, pubVideoPrivilegeExpireInSeconds, pubDataStreamPrivilegeExpireInSeconds, ) if err != nil { fmt.Println(err) } else { fmt.Printf("Token with int uid and privilege: %s\n", result) } } ``` ```java tab="Java" tabGroup="token-sample-code" package io.agora.sample; import io.agora.media.RtcTokenBuilder2; public class RtcTokenBuilder2Sample { // 获取环境变量 AGORA_APP_ID 的值。请确保你将该变量设为你在声网控制台获取的 App ID static String appId = System.getenv("AGORA_APP_ID"); // 获取环境变量 AGORA_APP_CERTIFICATE 的值。请确保你将该变量设为你在声网控制台获取的 App 证书 static String appCertificate = System.getenv("AGORA_APP_CERTIFICATE"); // 将 channelName 替换为需要加入的频道名 static String channelName = "channelName"; // 填入你实际的用户 ID static int uid = 2082341273; // Token 的有效时间(秒),声网建议将其他权限的有效时间和该参数设为一致 static int tokenExpirationInSeconds = 3600; // 加入频道权限的有效时间(秒) static int joinChannelPrivilegeExpireInSeconds = 3600; // 频道内发布音频流权限的有效时间(秒) static int pubAudioPrivilegeExpireInSeconds = 3600; // 频道内发布视频流权限的有效时间(秒) static int pubVideoPrivilegeExpireInSeconds = 3600; // 频道内发布数据流权限的有效时间(秒) static int pubDataStreamPrivilegeExpireInSeconds = 3600; public static void main(String[] args) { System.out.printf("App Id: %s\n", appId); System.out.printf("App Certificate: %s\n", appCertificate); if (appId == null || appId.isEmpty() || appCertificate == null || appCertificate.isEmpty()) { System.out.printf("Need to set environment variable AGORA_APP_ID and AGORA_APP_CERTIFICATE\n"); return; } // 生成 Token RtcTokenBuilder2 token = new RtcTokenBuilder2(); String result = token.buildTokenWithUid(appId, appCertificate, channelName, uid, tokenExpirationInSeconds, joinChannelPrivilegeExpireInSeconds, pubAudioPrivilegeExpireInSeconds, pubVideoPrivilegeExpireInSeconds, pubDataStreamPrivilegeExpireInSeconds); System.out.printf("Token with uid and privilege: %s\n", result); } } ``` ```javascript tab="Node.js" tabGroup="token-sample-code" const RtcTokenBuilder = require("../src/RtcTokenBuilder2").RtcTokenBuilder; // 获取环境变量 AGORA_APP_ID 的值。请确保你将该变量设为你在声网控制台获取的 App ID const appId = process.env.AGORA_APP_ID; // 获取环境变量 AGORA_APP_CERTIFICATE 的值。请确保你将该变量设为你在声网控制台获取的 App 证书 const appCertificate = process.env.AGORA_APP_CERTIFICATE; // 将 channelName 替换为需要加入的频道名 const channelName = "channelName"; // 填入你实际的用户 ID const uid = 2082341273; // Token 的有效时间(秒),声网建议将其他权限的有效时间和该参数设为一致 const tokenExpirationInSecond = 3600; // 加入频道权限的有效时间(秒) const joinChannelPrivilegeExpireInSeconds = 3600; // 频道内发布音频流权限的有效时间(秒) const pubAudioPrivilegeExpireInSeconds = 3600; // 频道内发布视频流权限的有效时间(秒) const pubVideoPrivilegeExpireInSeconds = 3600; // 频道内发布数据流权限的有效时间(秒) const pubDataStreamPrivilegeExpireInSeconds = 3600; console.log("App Id:", appId); console.log("App Certificate:", appCertificate); if (appId == undefined || appId == "" || appCertificate == undefined || appCertificate == "") { console.log("Need to set environment variable AGORA_APP_ID and AGORA_APP_CERTIFICATE"); process.exit(1); } // 生成 Token const tokenWithUidAndPrivilege = RtcTokenBuilder.buildTokenWithUidAndPrivilege( appId, appCertificate, channelName, uid, tokenExpirationInSecond, joinChannelPrivilegeExpireInSeconds, pubAudioPrivilegeExpireInSeconds, pubVideoPrivilegeExpireInSeconds, pubDataStreamPrivilegeExpireInSeconds ); console.log("Token with int uid and privilege:", tokenWithUidAndPrivilege); ``` ```php tab="PHP" tabGroup="token-sample-code" 1. 打开终端,运行下列命令来启动 Token 生成器。将 `[YOUR_APP_ID]` 和 `[YOUR_APP_CERTIFICATE]` 替换为你在声网控制台获取的 App ID 和 App 证书。 ```shell docker run -d -it -p 8080:8080 -e APP_ID=[YOUR_APP_ID] -e APP_CERTIFICATE=[YOUR_APP_CERTIFICATE] --name agora-token-service agoracn/token:0.1.2023053011 ``` 2. 运行下列命令来向你刚刚部署的 Token 生成器请求一个 Token: ```shell curl --location 'http://localhost:8080/token/generate' \ --header 'Content-Type: application/json' \ --data '{ "channelName": "channel_name_test", "uid": "12345678", "tokenExpireTs": 3600, "privilegeExpireTs": 3600, "serviceRtc": { "enable": true, "role": 1 } }' ``` 请求成功后,你的终端会返回生成的 Token。 ### 方式二:本地手动部署 Token 生成器 [#方式二本地手动部署-token-生成器-8] 以 Golang 语言为例,你可以参考如下步骤来在你本地搭建并运行一个 Token 生成器来生成 Token: 在开始前,请确保你的 [Golang](https://golang.org/dl/ ) 版本是 1.14 或以上版本。 :::warning[注意] 此示例仅用于演示,请勿用于生产环境中。 ::: 1. 新建一个 `token-server` 文件夹,在该文件夹下创建一个 `server.go` 文件,将生成 Token 的示例代码贴入到该文件中,将其中的 `appID` 和 `appCertificate` 替换为你的 App ID 和 App 证书。 2. 打开终端,进入到 `token-server` 文件路径下,运行如下命令行来为你的 Token 生成器创建 `go.mod` 文件,该文件定义导入路径及依赖项: ```go $ go mod init sampleServer ``` 3. 运行如下命令行安装依赖。你可以使用 Go 镜像进行加速,例如 [https://goproxy.cn](https://goproxy.cn/)。 ```go $ go get github.com/AgoraIO/Tools/DynamicKey/AgoraDynamicKey/go/src/rtctokenbuilder2 ``` 4. 运行如下命令行启动 Token 生成器: ```go $ go run server.go ``` ​ Token 生成器部署成功后,你的终端会返回根据你填入的 App ID 和 App 证书生成的 Token。 你也可以直接前往声网控制台获取临时 Token 来调试你的项目,详见[获取临时 Token](/zh-CN/realtime-media/rtc/build/setup-and-access/enable-service#获取临时-token)。 ## 参考信息 [#参考信息-7] ### 对 SDK 的兼容性要求 [#对-sdk-的兼容性要求-11] AccessToken2 支持以下版本的声网 SDK(不包括客户端旁路推流功能): - 对于 RTC 4.x SDK:Android、iOS、Windows、macOS、Electron、Unity、React Native、Unreal 平台的版本需大于等于 **v4.0.0**,HarmonyOS 平台需大于等于 **v4.4.0**,Web 平台需大于等于 **v4.8.0**,Flutter 平台需大于等于 **v6.0.0**。 :::info[信息] 使用 [AccessToken2](https://github.com/AgoraIO/Tools/tree/master/DynamicKey/AgoraDynamicKey/cpp/src/AccessToken2.h) 的 RTC SDK 可与使用 [AccessToken](https://github.com/AgoraIO/Tools/blob/master/DynamicKey/AgoraDynamicKey/cpp/src/AccessToken.h) 的 RTC SDK 互通。支持 AccessToken2 的 RTC SDK 也支持 AccessToken。 ::: ### API 参考 [#api-参考-8] 以 Golang 语言为例,本节介绍生成 Token 的核心方法。 - `BuildTokenWithUid`:生成 Token,设置 Token 和所有权限的过期时间。 - `BuildTokenWithUidAndPrivilege`:生成 Token 并可精细控制发流权限。可设置 Token 的有效期以及加入频道权限、发布音频、视频、数据流权限的过期时间。 #### BuildTokenWithUid [#buildtokenwithuid-8] 生成 Token 并设置所有的权限过期时间。 ```go func BuildTokenWithUid(appId string, appCertificate string, channelName string, uid uint32, role Role, tokenExpire uint32, privilegeExpire uint32) ``` **参数** - `appId`:你在声网控制台创建项目时生成的 App ID。 - `appCertificate`:你的项目的 App 证书。 - `channelName`:频道名,长度在 64 个字节以内。 - `uid`:待鉴权用户的用户 ID,32 位无符号整数,范围为 1 到 (2³² - 1), 并保证唯一性。 - `role`:用户权限,决定用户是否能在频道中发流。 - `kRolePublisher`(1)(默认):用户有发流权限,即用户可在频道中发流。 - `kRoleSubscriber`(2):用户有接收权限,即用户可在频道中接收,但不可发流。该参数仅在开启连麦鉴权后才生效。详情参考[开启连麦鉴权](/zh-CN/reference/faq/integration/token_cohost#3-开启连麦鉴权)。 - `tokenExpire`:Token 的有效时长(秒),最长有效期为 24 小时。 - `privilegeExpire`:所有权限的有效时长(秒)。如设为 0(默认值),表示权限永不过期。 :::warning[注意] 当 Token 过期但权限未过期时,用户仍在频道里并且可以发流,不会触发 SDK 中与 Token 相关的任何回调。但一旦和频道断开连接,用户将无法使用该 Token 加入同一频道。声网建议将 Token 的过期时间和权限过期时间设为**一致**。 ::: #### BuildTokenWithUidAndPrivilege [#buildtokenwithuidandprivilege-7] 生成 Token 并设置不同权限的过期时间。 ```go func BuildTokenWithUidAndPrivilege(appId string, appCertificate string, channelName string, uid uint32, tokenExpire uint32, joinChannelPrivilegeExpire uint32, pubAudioPrivilegeExpire uint32, pubVideoPrivilegeExpire uint32, pubDataStreamPrivilegeExpire uint32) ``` **参数** - `appId`:你在声网控制台创建项目时生成的 App ID。 - `appCertificate`:你的项目的 App 证书。 - `channelName`:频道名,长度在 64 个字节以内。 - `uid`:待鉴权用户的用户 ID,32 位无符号整数,范围为 1 到 (2³² - 1), 并保证唯一性。 - `tokenExpire`:Token 的有效时长(秒),最长有效期为 24 小时。 - `joinChannelPrivilegeExpire`:加入频道权限的有效时长(秒)。 - `pubAudioPrivilegeExpire`:在频道内发布音频流权限的有效时长(秒)。 - `pubVideoPrivilegeExpire`:在频道内发布视频流权限的有效时长(秒)。 - `pubDataStreamPrivilegeExpire`:在频道内发布数据流权限的有效时长(秒)。 :::warning[注意] - 上述不同权限的过期时间长度均从 Token 生成开始计算。 - 声网建议将 Token 的过期时间与其他权限的过期时间设为**一致**。 - 在频道中发布音视频流和数据流的权限仅在[开启连麦鉴权服务](/zh-CN/reference/faq/integration/token_cohost#3-开启连麦鉴权)后才生效。如果加入频道的权限过期时间早于发布音频流权限的过期时间,则在加入频道的权限过期后,用户会被踢出频道。 ::: ### 常见问题 [#常见问题-7] - [如何处理 Token 相关错误码?](/zh-CN/reference/faq/integration/token_related_issues) - [如何开启连麦鉴权?](/zh-CN/reference/faq/integration/token_cohost) - [如何生成具备 RTC 和 RTM 权限的 Token?](/zh-CN/reference/faq/integration/rtc_rtm_token) ### 相关文档 [#相关文档-12] - [AccessToken 升级指南](/zh-CN/realtime-media/rtc/build/setup-and-access/token-server-upgrade#升级至-accesstoken2) - [使用通配 Token](/zh-CN/realtime-media/rtc/build/security-and-auth/wildcard-token)