使用 Token 鉴权

本文介绍如何在服务端为智能云会议生成一个 Token，并使用 Token 完成鉴权。

鉴权是指在用户访问你的系统前，对用户权限进行校验，声网用 Token 对用户鉴权。Token 也称为动态密钥，是在创建、启动、或管理会议房间时用于校验用户权限的字符串。当 App 用户使用声网服务，例如启动会议房间时传入 Token，声网服务端会根据 Token 中的信息验证用户的权限。

智能云会议 Token 类型Copy Anchor Link

智能云会议包含客户端 SDK 和服务端 RESTful API。根据不同的鉴权场景，智能云会议 Token 分为如下两种类型：

1. 服务端生成 TokenCopy Anchor Link

本节以 Golang 语言为例，展示如何部署 Token 生成器。

本节展示的 Token 为 BuildRoomUserToken 函数生成，你可按需替换成 BuildAppToken 函数。两者区别详见智能云会议 Token 类型。

开发环境要求Copy Anchor Link

Golang 1.14 以上版本，且确保 GO111MODULE 已开启。

部署 Token 服务器Copy Anchor Link

1. 创建一个 server.go 文件，并将本步骤的示例代码复制到该文件中。示例代码使用 BuildRoomUserToken 函数生成 Token。函数中需设置如下参数：

   参数	描述
   appID	App ID，详见获取 App ID。
   appCertificate	App 证书，详见获取 App 证书。
   roomUuid	房间 ID。和智能云会议 API 中 roomId 一致。
   userUuid	用户 ID。此处填写的值必须和启动会议时传入的 userId 一致。
   role	房间内用户角色。和智能云会议 API 中 userRole 一致。
   expire	设置 Token 的有效期，单位为秒。最长有效期为 24 小时。假设你设值为 600，Token 会在生成后 10 分钟过期。假设你设值超过 24 小时，Token 的有效期依然为 24 小时。假设你设值为 0，Token 一经生成立即过期。

   表格内容超出当前宽度，可横向滚动查看更多列。

   Copy Text

   package main
   
   import (
       apaastokenbuilder "github.com/AgoraIO/Tools/DynamicKey/AgoraDynamicKey/go/src/apaastokenbuilder"
       "fmt"
       "log"
       "net/http"
       "time"
       "encoding/json"
       "errors"
       "strconv"
   )
   type apaas_token_struct struct {
       // 房间 ID
       roomUuid string `json:"roomUuid"`
       // 用户 ID，是用户的唯一标识符
       userUuid string `json:"userUuid"`
       // 用户角色
       role int `json:"role"`
   }
   
   var apaasToken string
   
   func generateApaasToken(roomUuid string, userUuid string, role int) {
       // 获取环境变量 AGORA_APP_ID 的值
       // 请确保你将该变量设为你在控制台获取的 App ID
       appID := os.Getenv("AGORA_APP_ID")
       // 获取环境变量 AGORA_APP_CERTIFICATE 的值
       // 请确保你将该变量设为你在控制台获取的 App 证书
       appCertificate := os.Getenv("AGORA_APP_CERTIFICATE")
       // Token 的有效时间，单位为秒
       expire := uint32(3600)
   
       // 使用 BuildRoomUserToken 函数生成 Token
       result, err := apaastokenbuilder.BuildRoomUserToken(appID, appCertificate, roomUuid, userUuid, role, expire)
   
       if err != nil {
           fmt.Println(err)
       } else {
           fmt.Printf("ApaasToken: %s\n", result)
           apaasToken = result
       }
   }
   
   func apaasTokenHandler(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_apaas_str apaas_token_struct
       var unmarshalErr *json.UnmarshalTypeError
       str_decoder := json.NewDecoder(r.Body)
       apaas_err := str_decoder.Decode(&t_apaas_str)
   
       if (apaas_err != nil) {
           if errors.As(apaas_err, &unmarshalErr) {
               errorResponse(w, "Bad request. Please check your params.", http.StatusBadRequest)
           } else {
               errorResponse(w, "Bad request.", http.StatusBadRequest)
           }
           return
       }
   
       generateRtmToken(t_apaas_str.roomUuid,t_apaas_str.userUuid,t_apaas_str.role)
       errorResponse(w, apaasToken, 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() {
       // 处理路由
       http.HandleFunc("/fetch_apaas_token", apaasTokenHandler)
   
       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 文件：

   Copy Text

   $ go mod init sampleServer

3. 运行如下命令行安装依赖：

   Copy Text

   $ go get

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

   Copy Text

   $ go run server.go

2. 传入 Token 实现鉴权Copy Anchor Link

针对 Token 的类型，你可以将服务端生成的 Token 赋值给相应的参数，以实现鉴权：

• 对于 BuildRoomUserToken 函数生成的 Token，你需在使用客户端会议 SDK 启动会议时传入。详见启动智能云会议。

• 对于 BuildRoomUserToken 函数生成的 Token，你需在使用客户端会议 SDK 启动会议时传入。详见启动智能云会议。

• 对于 BuildAppToken 函数生成的 Token，你需在使用服务端 RESTful API 发起请求时传入。详见实现 HTTP Token 鉴权。

参考信息Copy Anchor Link

本节展示智能云会议使用的两种 Token 生成器函数：BuildRoomUserToken 和 BuildAppToken。两者区别详见智能云会议 Token 类型。同时，声网提供 GitHub 开源示例代码教你如何在服务端生成 Token。示例代码覆盖 Golang、Java、Node.js、PHP、Python 等语言。

BuildRoomUserTokenCopy Anchor Link

func BuildRoomUserToken(
    appId string,
    appCertificate string,
    roomUuid string,
    userUuid string,
    role int16,
    expire uint32
) (string, error)

BuildRoomUserToken 函数生成的 Token 作用域为指定房间中的指定用户，需在使用客户端会议 SDK 启动会议时传入。appId、appCertificate 等参数说明详见部署 Token 服务器。

BuildAppTokenCopy Anchor Link

func BuildAppToken(
    appId string,
    appCertificate string,
    expire uint32
) (string, error)

BuildAppToken 函数生成的 Token 作用域为全局房间的操作，如创建房间，配置房间和查询房间等，需在使用服务端 RESTful API 发起请求时传入。appId、appCertificate 等参数说明详见部署 Token 服务器。