使用 Token 鉴权

鉴权是指在用户访问你的系统前，对其进行身份校验。用户在使用声网服务，如加入音视频通话或登录信令系统时，声网使用 Token 对其鉴权。

为提供更好的鉴权体验和安全性保障，声网自 2022 年 7 月 20 日推出新版 Token：AccessToken2。如需从 AccessToken 升级至 AccessToken2，请参考 AccessToken 升级指南。

本文展示如何为 AccessToken2 在服务端部署一个 Token 生成器，以及如何搭建一个使用 Token 鉴权的客户端。

鉴权原理

下图展示了鉴权的基本流程：

1. 客户端根据需要，向 app 服务端申请 Token。
2. App 服务端生成并返回 Token。
3. 客户端以 UID、频道名以及获取到的 Token 加入频道。
4. 声网平台读取该 Token 中包含的信息，并进行校验。
5. 客户端收到加入频道成功回调，并获取用户 UID。
6. Token 最大有效期为 24 小时。当即将过期时，客户端会收到 Token 即将过期的回调。
7. 此时，如果客户端需要继续进行音视频互动，需要申请新的 Token。
8. App 服务端生成并返回 Token。
9. 客户端更新 Token。
   Token 过期时，SDK 会触发 Token 过期回调。收到该回调后，客户端需要从服务器获取新的 Token，再使用新的 Token 重新加入频道。

你需要自行实现步骤 1、2、3、7、8、9 的代码逻辑。

Token 包含以下信息：

• 你在声网控制台创建项目时生成的 App ID
• 频道名
• 用户 ID
• 用户权限，如是否能发流或收流
• Token 的过期时间

前提条件

开始前，请确保你的项目或使用的声网产品满足如下条件：

• 一个有效的声网账户。

• 已开启 App 证书的声网项目。

• Golang 1.14 或以上版本，GO111MODULE 设置为开启。

  如果你使用的是 Go 1.16 或以上版本，GO111MODULE 已默认开启。详情请参考 New module changes in Go 1.16。

• npm 以及支持的浏览器。

实现鉴权流程

本节介绍如何使用声网提供的代码生成并提供 Token，对用户及其权限进行校验。

获取 App ID 及 App 证书

本节介绍如何获取生成 Token 所需的安全信息，如你的项目的 App ID 及 App 证书。

获取 App ID

声网会给每个项目自动分配一个 App ID 作为项目唯一标识。

在声网控制台的项目管理页面，找到你的项目，点击 App ID 右侧的 图标，即可获取项目的 App ID。

获取 App 证书

参考以下步骤获取 App 证书：

1. 在声网控制台的项目管理页面，找到你的项目，点击配置。
   

2. 点击主要证书下面的复制图标，即可获取项目的 App 证书。
   

部署 Token 服务器

此示例服务器使用 BuildTokenWithUid[1/2]。

1. 创建一个 server.go 文件，然后贴入如下代码。将其中的 <Your App ID>和 <Your App Certificate> 替换为你的 App ID 和 App 证书。

package main

import (
    rtctokenbuilder "github.com/AgoraIO/Tools/DynamicKey/AgoraDynamicKey/go/src/rtctokenbuilder2"
    "fmt"
    "log"
    "net/http"
    "encoding/json"
    "errors"
    "strconv"
)

type rtc_int_token_struct struct{
    Uid_rtc_int uint32 `json:"uid"`
    Channel_name string `json:"ChannelName"`
    Role uint32 `json:"role"`
}

var rtc_token string
var int_uid uint32
var channel_name string

var role_num uint32
var role rtctokenbuilder.Role

// 使用 RtcTokenBuilder 来生成 RTC Token
func generateRtcToken(int_uid uint32, channelName string, role rtctokenbuilder.Role){

    appID := "<Your App ID>"
    appCertificate := "<Your App Certificate>"
    // AccessToken2 过期的时间，单位为秒
    // 当 AccessToken2 过期但权限未过期时，用户仍在频道里并且可以发流，不会触发 SDK 回调。
    // 但一旦用户和频道断开连接，用户将无法使用该 Token 加入同一频道。请确保 AccessToken2 的过期时间晚于权限过期时间。
    tokenExpireTimeInSeconds := uint32(40)
    // 权限过期的时间，单位为秒。
    // 权限过期30秒前会触发 token-privilege-will-expire 回调。
    // 权限过期时会触发 token-privilege-did-expire 回调。
    // 为作演示，在此将过期时间设为 40 秒。你可以看到客户端自动更新 Token 的过程
    privilegeExpireTimeInSeconds := uint32(40)

    result, err := rtctokenbuilder.BuildTokenWithUid(appID, appCertificate, channelName, int_uid, role, tokenExpireTimeInSeconds, privilegeExpireTimeInSeconds)
    if err != nil {
        fmt.Println(err)
    } else {
        fmt.Printf("Token with uid: %s\n", result)
        fmt.Printf("uid is %d\n", int_uid )
        fmt.Printf("ChannelName is %s\n", channelName)
        fmt.Printf("Role is %d\n", role)
    }
    rtc_token = result
}


func rtcTokenHandler(w http.ResponseWriter, r *http.Request){
    w.Header().Set("Content-Type", "application/json; charset=UTF-8")
    w.Header().Set("Access-Control-Allow-Origin", "*")
    w.Header().Set("Access-Control-Allow-Methods", "POST, OPTIONS");
    w.Header().Set("Access-Control-Allow-Headers", "*");

    if r.Method == "OPTIONS" {
        w.WriteHeader(http.StatusOK)
        return
    }

    if r.Method != "POST" && r.Method != "OPTIONS" {
        http.Error(w, "Unsupported method. Please check.", http.StatusNotFound)
        return
    }


    var t_int rtc_int_token_struct
    var unmarshalErr *json.UnmarshalTypeError
    int_decoder := json.NewDecoder(r.Body)
    int_err := int_decoder.Decode(&t_int)
    if (int_err == nil) {

                int_uid = t_int.Uid_rtc_int
                channel_name = t_int.Channel_name
                role_num = t_int.Role
                switch role_num {
                    case 1:
                        role = rtctokenbuilder.RolePublisher
                    case 2:
                        role = rtctokenbuilder.RoleSubscriber
                }
    }
    if (int_err != nil) {

        if errors.As(int_err, &unmarshalErr){
                errorResponse(w, "Bad request. Wrong type provided for field " + unmarshalErr.Value  + unmarshalErr.Field + unmarshalErr.Struct, http.StatusBadRequest)
                } else {
                errorResponse(w, "Bad request.", http.StatusBadRequest)
            }
        return
    }

    generateRtcToken(int_uid, channel_name, role)
    errorResponse(w, rtc_token, http.StatusOK)
    log.Println(w, r)
}

func errorResponse(w http.ResponseWriter, message string, httpStatusCode int){
    w.Header().Set("Content-Type", "application/json")
    w.Header().Set("Access-Control-Allow-Origin", "*")
    w.WriteHeader(httpStatusCode)
    resp := make(map[string]string)
    resp["token"] = message
    resp["code"] = strconv.Itoa(httpStatusCode)
    jsonResp, _ := json.Marshal(resp)
    w.Write(jsonResp)

}

func main(){
    // 使用 int 型 uid 生成 RTC Token
    http.HandleFunc("/fetch_rtc_token", rtcTokenHandler)
    fmt.Printf("Starting server at port 8082\n")

    if err := http.ListenAndServe(":8082", nil); err != nil {
        log.Fatal(err)
    }
}

2. go.mod 文件定义导入路径及依赖项。运行如下命令行来为你的 Token 服务器创建 go.mod 文件：

   $ go mod init sampleServer

3. 运行如下命令行安装依赖。你可以使用 Go 镜像进行加速，例如 https://goproxy.cn/ 。

   $ go get

4. 运行如下命令行启动服务器：

   $ go run server.go

使用 Token 对用户鉴权

本节以 iOS 客户端为例，展示如何使用 Token 对客户端的用户进行鉴权。

为了展示鉴权的工作流程，本节介绍如何在你的本地开发环境上使用 iOS 模拟器搭建并运行一个 iOS 客户端。

将 ViewController.swift 中的内容替换为如下代码。 将 Your App ID 替换为你的 App ID，必须与服务器中的 App ID 一致。 您还需要将 <Your Host URL and port> 替换为你刚刚部署的本地 Golang 服务器的主机 URL 和端口，例如 10.53.3.234:8082。

在如下代码示例中，你可以看到 Token 与客户端的如下代码逻辑有关：

• 调用 joinChannel 方法，使用 Token、用户 ID 和频道名加入频道。用户 ID 和频道名必须和用于生成 Token 的用户 ID 和频道名一致。

• 在 Token 过期前 30 秒，SDK 会触发 tokenPrivilegeWillExpire 回调。收到该回调后，客户端需要从服务器获取新的 Token 并调用 renewToken 将新生成的 Token 传给 SDK。

• Token 过期时，SDK 会触发 rtcEngineRequestToken 回调。收到该回调后，客户端需要从服务器获取新的 Token 并调用 joinChannel 方法，再使用新的 Token 重新加入频道。

  //
  //  ViewController.swift
  //  RteQuickstart
  //
  //  Created by macoscatalina on 2021/8/12.
  //  Copyright © 2021 macoscatalina. All rights reserved.
  //
  
  import UIKit
  import AgoraRtcKit
  import Foundation
  
  public enum TokenError: Error{
      case noData
      case invalidData
  }
  
  class ViewController: UIViewController {
      var localView: UIView!
      var remoteView: UIView!
  
      var agoraKit: AgoraRtcEngineKit!
  
      override func viewDidLoad() {
          super.viewDidLoad()
          // 加载完视图后，可进行其他设置
          initView()
          initializeAgoraEngine()
          setClientRole()
          setupLocalVideo()
          fetchToken(channelName: "test", userId: 1234, role: 1){ result in
              switch result {
              case .success(let token):
                  print("token is: \(token)")
                  self.joinChannel(token: token)
              case .failure(let err):
                  print("Could not fetch token: \(err)")
              }
          }
      }
  
      override func viewDidLayoutSubviews(){
          super.viewDidLayoutSubviews()
          remoteView.frame = self.view.bounds
          localView.frame = CGRect(x: self.view.bounds.width - 90, y: 0, width: 90, height: 160)
      }
  
      override func viewDidDisappear(_ animated: Bool) {
          super.viewDidDisappear(true)
          leaveChannel()
          destroy()
      }
  
      func initView(){
          remoteView = UIView()
          self.view.addSubview(remoteView)
          localView = UIView()
          self.view.addSubview(localView)
      }
  
      func initializeAgoraEngine(){
          let config = AgoraRtcEngineConfig()
          config.appId = "Your App ID"
          config.channelProfile = .liveBroadcasting
          agoraKit = AgoraRtcEngineKit.sharedEngine(with: config, delegate: self)
          if agoraKit != nil{
              print("Initialization successful")
          }
          else{
              print("Initialization failed")
          }
      }
  
      func setClientRole(){
          agoraKit.setClientRole(.broadcaster)
      }
  
      func setupLocalVideo(){
          agoraKit.enableVideo()
          agoraKit.startPreview()
          let videoCanvas = AgoraRtcVideoCanvas()
          videoCanvas.uid = 0
          videoCanvas.renderMode = .hidden
          videoCanvas.view = localView
          agoraKit.setupLocalVideo(videoCanvas)
      }
  
      func joinChannel(token:String){
          let option = AgoraRtcChannelMediaOptions()
          agoraKit.joinChannel(byToken: token, channelId: "test", uid: 123456, mediaOptions: option)
      }
  
      func leaveChannel(){
          agoraKit.stopPreview()
          agoraKit.leaveChannel(nil)
      }
  
      func destroy(){
          AgoraRtcEngineKit.destroy()
      }
  
      func fetchToken(channelName: String, userId: UInt, role: UInt,
          callback: @escaping (Result<String, Error>) -> Void
      ){
          let url = URL(string: "http://<Your Host URL and port>/fetch_rtc_token")
          let parameters = ["uid":userId,"channelName": channelName, "role": role] as [String : Any]
  
          print(parameters.self)
  
          var request = URLRequest(
              url: url!,
              timeoutInterval: 10
          )
  
          request.httpMethod = "POST"
  
          do {
              request.httpBody = try JSONSerialization.data(withJSONObject: parameters, options: .prettyPrinted)
          }
          catch let error {
              print(error.localizedDescription)
          }
  
          URLSession.shared.dataTask(with: request){data, _, err in
              guard let data = data else {
                  if let err = err {
                      callback(.failure(err))
                  }
                  else {
                      callback(.failure(TokenError.noData))
                  }
              return
          }
  
          let responseJSON = try? JSONSerialization.jsonObject(with: data, options: [])
  
          if let responseDict = responseJSON as? [String: Any], let token = responseDict["token"] as? String {
              callback(.success(token))
          } else {
              callback(.failure(TokenError.invalidData))
          }
  
      }.resume()
  }
  }
  
  extension ViewController: AgoraRtcEngineDelegate{
      func rtcEngine(_ engine: AgoraRtcEngineKit, didJoinedOfUid uid: UInt, elapsed: Int){
          let videoCanvas = AgoraRtcVideoCanvas()
          videoCanvas.uid = uid
          videoCanvas.renderMode = .hidden
          videoCanvas.view = remoteView
          agoraKit.setupRemoteVideo(videoCanvas)
      }
  
      func rtcEngine(_ engine: AgoraRtcEngineKit, tokenPrivilegeWillExpire token: String) {
          self.fetchToken(channelName: "test", userId: 1234, role: 1){ result in
              switch result {
              case .success(let token):
                  print("token is: \(token)")
                  self.agoraKit.renewToken(token)
                  print("Renewed the token")
              case .failure(let err):
                  print("Could not fetch token: \(err)")
              }
          }
      }
  
      func rtcEngine(_ engine: AgoraRtcEngineKit, connectionStateChanged state: AgoraConnectionState, reason: AgoraConnectionChangedReason) {
          print("Connection state changed to")
          print(state.rawValue)
      }
  
      func rtcEngineRequestToken(_ engine: AgoraRtcEngineKit) {
          fetchToken(channelName: "test", userId: 1234, role: 1){ result in
              switch result {
                  case .success(let token):
                      print("token is: \(token)")
                      self.joinChannel(token: token)
                  case .failure(let err):
                      print("Could not fetch token: \(err)")
                  }
          }
      }
  }

运行项目

在本地设备的 iOS 模拟器中构建并运行项目，app 会执行如下操作：

1. 加入频道。
2. 每隔 10 秒更新 token。

参考

本节介绍 Token 生成器代码库、使用 Token 的版本要求等相关文档。

对 SDK 的兼容性要求

AccessToken2 支持以下版本的声网 SDK（不包括客户端旁路推流功能）:

使用 AccessToken2 的 RTC SDK 可与使用 AccessToken 的 RTC SDK 互通。支持 AccessToken2 的 RTC SDK 也支持 AccessToken。

Token 生成器代码

声网在 GitHub 上提供一个开源的 AgoraDynamicKey 仓库，，支持使用 C++、Java、Go 等语言在你自己的服务器上生成 AccessToken2。

BuildTokenWithUid API 参考

本节介绍生成 AccessToken2 的核心方法 BuildTokenWithUid。AccessToken2 生成器代码中提供两个 BuildTokenWithUid 方法：

• BuildTokenWithUid [1/2]：生成 AccessToken2，并设置 AccessToken2 和所有权限的过期时间。

• BuildTokenWithUid [2/2]：生成 AccessToken2，并设置如下过期时间：

  • AccessToken2 过期时间
  • 加入频道权限的过期时间
  • 频道内发布音频流权限的过期时间
  • 频道内发布视频流权限的过期时间
  • 频道内发布数据流权限的过期时间

BuildTokenWithUid [1/2]

该方法使用 token_expire 参数设置 AccessToken2 的过期时间，使用 privilege_expire 参数设置所有权限的过期时间。

// 以 C++ 为例
static std::string BuildTokenWithUid(const std::string& app_id,
                                       const std::string& app_certificate,
                                       const std::string& channel_name,
                                       uint32_t uid, 
                                       UserRole role,
                                       uint32_t token_expire,
                                       uint32_t privilege_expire = 0);

BuildTokenWithUid [2/2]

为支持在权限级别设置过期时间，声网还提供 BuildTokenWithUid 的同名重载方法。支持你设置 AccessToken2 的过期时间以及以下权限的过期时间：

• 加入频道
• 频道内发布音频流
• 频道内发布视频流
• 频道内发布数据流

// 以 C++ 为例
static std::string BuildTokenWithUid(
       const std::string& app_id,
       const std::string& app_certificate,
       const std::string& channel_name,
       uint32_t uid,
       uint32_t token_expire,
       uint32_t join_channel_privilege_expire = 0,
       uint32_t pub_audio_privilege_expire = 0,
       uint32_t pub_video_privilege_expire = 0,
       uint32_t pub_data_stream_privilege_expire = 0);

该方法生成 RTC AccessToken2，支持你设置 AccessToken2 的过期时间以及以下权限的过期时间：

• 加入 RTC 频道
• 在 RTC 频道中发布音频流
• 在 RTC 频道中发布视频流
• 在 RTC 频道中发布数据流

其中，在 RTC 频道中发布音频流、视频流和数据流的权限仅在开启连麦鉴权服务后才生效。

一个用户可以设置多个权限。每个权限的最大有效时间为 24 小时。权限即将过期或已经过期后，SDK 会分别触发 onTokenPriviegeWillExpire 或 onRequestToken 回调。你需要在 app 逻辑中添加如下操作：

1. 识别即将过期或已经过期的是哪类权限。
2. App 从 Token 服务器获取新的 AccessToken2。
3. SDK 调用 renewToken 以更新 AccessToken2。

开启连麦鉴权

请参考以下步骤在声网控制台开启连麦鉴权服务：

1. 登录声网控制台，在项目列表区域选择你想要开启的项目，点击配置按钮，进入编辑项目页面。
2. 在项目详情页，下滑到功能区域，点击连麦鉴权区域的启用。
3. 按照屏幕提示，了解开通该功能的主要事项，勾选后点击启用。

在控制台启用连麦鉴权后，该服务会在约 5 分钟后生效。

项目一旦开启了连麦鉴权服务，则用户在频道中发流需要同时满足两个条件：

• 在 setClientRole 中设置的 role 参数为 BROADCASTER(1)。
• 使用 Token 加入频道的用户拥有发流的权限（在 BuildTokenWithUid中设置的 role 参数为 kRolePublisher）。