ApsaraVideo Live:トークンベース認証の実装

サーバーサイドでのトークン生成 (推奨)

ApsaraVideo Live は、Go、Java、Python など、複数の言語に対応したトークン生成のサンプルコードを提供しています。詳細は、GitHub リポジトリをご参照ください。

クライアントサイドでのトークン生成 (開発およびテスト用)

開発およびテスト段階で、独自のサーバーサイドでのトークン生成がまだ実装されていない場合は、APIExample のサンプルコードを使用して一時的なトークンを生成できます。サンプルコードは次のとおりです。

Android： Android/ARTCExample/KeyCenter/src/main/java/com/aliyun/artc/api/keycenter/ARTCTokenHelper.java

iOS： iOS/ARTCExample/Common/ARTCTokenHelper.swift

トークンを使用したチャンネルへの参加

Android： Android/ARTCExample/QuickStart/src/main/java/com/aliyun/artc/api/quickstart/TokenGenerate/TokenGenerateActivity.java
iOS： iOS/ARTCExample/QuickStart/TokenGenerate/TokenGenerateVC.swift

手順

1. クライアントはアプリケーションサーバーにトークンをリクエストします。アプリケーションサーバーは、事前に定義されたルールに従ってトークンを生成し、クライアントに返します。

2. クライアントは、受信したトークンを appId、channelId、userId などの他の必須情報とともに使用して、指定されたチャンネルへの参加をリクエストします。

3. ARTC サーバーはトークンを検証し、検証が成功するとクライアントのチャンネルへの参加を許可します。

トークン生成方式

次の表に、トークン生成に使用するフィールドを示します。

トークン生成手順：

コード例：

// 1. 次のフィールドを連結します： AppID+AppKey+ChannelID+UserID+Nonce+Timestamp
// 2. 連結した文字列に sha256 関数を適用してトークンを生成します。
token = sha256(AppID+AppKey+ChannelID+UserID+Nonce+Timestamp)
// 例：
AppID = "abc",AppKey="abckey",ChannelID="abcChannel",UserID="abcUser",Nonce="",Timestamp=1699423634
token = sha256("abcabckeyabcChannelabcUser1699423634") = "3c9ee8d9f8734f0b7560ed8022a0590659113955819724fc9345ab8eedf84f31"

単一パラメーターメソッド (推奨)

ARTC SDK は、チャンネルに参加するための簡素化された単一パラメーターの API を提供します。このメソッドは、サーバーで生成されたパラメーターとクライアントから渡されたパラメーターの不一致による参加失敗を防ぐための糖衣構文として機能するため、使用を推奨します。

このメソッドを使用するには、Token、AppID、ChannelID、Nonce、UserID、Timestamp パラメーターを JSON オブジェクトに結合します。次に、JSON 文字列を Base64 エンコードして、新しい認証文字列 (Base64 トークン) を生成します。

package com.example;

import java.nio.charset.StandardCharsets;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.Base64;
import java.util.Calendar;
import org.json.JSONObject;

public class App {

    public static String createBase64Token(String appid, String appkey, String channelid, String userid) {
        // 有効期限のタイムスタンプを計算します (現在から 24 時間後)
        Calendar calendar = Calendar.getInstance();
        calendar.add(Calendar.HOUR_OF_DAY, 24);
        long timestamp = calendar.getTimeInMillis() / 1000;

        // 文字列を連結します
        String stringBuilder = appid + appkey + channelid + userid + timestamp;

        // SHA-256 ハッシュを計算します
        String token = sha256(stringBuilder);

        // JSON オブジェクトを作成します
        JSONObject base64tokenJson = new JSONObject();
        base64tokenJson.put("appid", appid);
        base64tokenJson.put("channelid", channelid);
        base64tokenJson.put("userid", userid);
        base64tokenJson.put("nonce", "");
        base64tokenJson.put("timestamp", timestamp);
        base64tokenJson.put("token", token);

        // JSON オブジェクトを文字列に変換し、Base64 でエンコードします
        String jsonStr = base64tokenJson.toString();
        String base64token = Base64.getEncoder().encodeToString(jsonStr.getBytes(StandardCharsets.UTF_8));
        return base64token;
    }

    private static String sha256(String input) {
        try {
            MessageDigest digest = MessageDigest.getInstance("SHA-256");
            byte[] hash = digest.digest(input.getBytes(StandardCharsets.UTF_8));
            StringBuilder hexString = new StringBuilder();
            for (byte b : hash) {
                String hex = Integer.toHexString(0xff & b);
                if (hex.length() == 1)
                    hexString.append('0');
                hexString.append(hex);
            }
            return hexString.toString();
        } catch (NoSuchAlgorithmException e) {
            throw new RuntimeException(e);
        }
    }

    public static void main(String[] args) {
        String appid = "your_appid";
        String appkey = "your_appkey";
        String channel_id = "your_channel_id";
        String user_id = "your_user_id";

        String base64token = createBase64Token(appid, appkey, channel_id, user_id);
        System.out.println("Base64 Token: " + base64token);
    }
}

package main

import (
	"crypto/sha256"
	"encoding/base64"
	"encoding/hex"
	"encoding/json"
	"fmt"
	"time"
)

func createBase64Token(appid, appkey, channelID, userID string) (string, error) {
	// 有効期限のタイムスタンプを計算します (現在から 24 時間後)
	timestamp := time.Now().Add(24 * time.Hour).Unix()

	// 文字列を連結します
	stringBuilder := appid + appkey + channelID + userID + fmt.Sprintf("%d", timestamp)

	// SHA-256 ハッシュを計算します
	hasher := sha256.New()
	hasher.Write([]byte(stringBuilder))
	token := hasher.Sum(nil)

	// encoding/hex を使用してハッシュを 16 進文字列に変換します
	tokenHex := hex.EncodeToString(token)

	// JSON オブジェクトを作成します
	tokenJSON := map[string]interface{}{
		"appid":     appid,
		"channelid": channelID,
		"userid":    userID,
		"nonce":     "",
		"timestamp": timestamp,
		"token":     tokenHex,
	}

	// JSON オブジェクトを文字列に変換し、Base64 でエンコードします
	jsonBytes, err := json.Marshal(tokenJSON)
	if err != nil {
		return "", err
	}
	base64Token := base64.StdEncoding.EncodeToString(jsonBytes)

	return base64Token, nil
}

func main() {
	appid := "your_appid"
	appkey := "your_appkey"
	channelID := "your_channel_id"
	userID := "your_user_id"

	token, err := createBase64Token(appid, appkey, channelID, userID)
	if err != nil {
		fmt.Println("Error creating token:", err)
		return
	}
	fmt.Println("Base64 Token:", token)
}

#!/usr/bin/env python
# -*- coding: UTF-8 -*-

import hashlib
import datetime
import time
import base64
import json

def create_base64_token(app_id, app_key, channel_id, user_id):
    expire = datetime.datetime.now() + datetime.timedelta(days=1)
    timestamp = int(time.mktime(expire.timetuple()))
    h = hashlib.sha256()
    h.update(str(app_id).encode('utf-8'))
    h.update(str(app_key).encode('utf-8'))
    h.update(str(channel_id).encode('utf-8'))
    h.update(str(user_id).encode('utf-8'))
    h.update(str(timestamp).encode('utf-8'))
    token = h.hexdigest()

    jsonToken = {'appid':app_id,
                 'channelid':channel_id,
                 'userid':user_id,
                 'nonce':'',
                 'timestamp':timestamp,
                 'token':token
                }
    base64Token = base64.b64encode(json.dumps(jsonToken).encode())

    return base64Token

def main():
    app_id = 'your_appid'
    app_key = 'your_appkey'
    channel_id = 'your_channel_id'
    user_id = 'your_user_id'

    base64Token = create_base64_token(app_id, app_key, channel_id, user_id)
    
    print(base64Token)

if __name__ == '__main__':
    main()

'use strict'
const crypto = require('crypto')
function create_base64_token(appid, appkey, channelid, userid) {
    let timestamp = Math.floor(Date.now() / 1000 + 24 * 60 * 60)

    let string_builder = appid + appkey + channelid + userid + timestamp.toString()
    let token = crypto.createHash('sha256').update(string_builder).digest('hex')
    let base64tokenJson = {
        appid:appid,
        channelid:channelid,
        userid:userid,
        nonce:'',
        timestamp:timestamp,
        token:token
    }
    let base64token = Buffer.from(JSON.stringify(base64tokenJson), 'utf-8').toString('base64')
    return base64token
}

let appid = "your_appid";
let appkey = "your_appkey";
let channel_id = "your_channel_id";
let user_id = "your_user_id";

let base64token = create_base64_token(appid, appkey, channel_id, user_id)
console.log(base64token)

use chrono::{Duration, Utc};
use sha2::{Sha256, Digest};
use serde_json::json;
use base64::encode;

fn create_base64_token(appid: &str, appkey: &str, channel_id: &str, user_id: &str) -> String {
    // 有効期限のタイムスタンプを計算します (現在から 24 時間後)
    let timestamp = (Utc::now() + Duration::hours(24)).timestamp();

    // 文字列を連結します
    let string_builder = format!("{}{}{}{}{}", appid, appkey, channel_id, user_id, timestamp);

    // SHA-256 ハッシュを計算します
    let mut hasher = Sha256::new();
    hasher.update(string_builder);
    let token = hasher.finalize();
    let token_hex = format!("{:x}", token);

    // JSON オブジェクトを作成します
    let token_json = json!({
        "appid": appid,
        "channelid": channel_id,
        "userid": user_id,
        "nonce": "",
        "timestamp": timestamp,
        "token": token_hex
    });

    // JSON オブジェクトを文字列に変換し、Base64 でエンコードします
    let base64_token = encode(token_json.to_string());

    base64_token
}

fn main() {
    let appid = "your_appid";
    let appkey = "your_appkey";
    let channel_id = "your_channel_id";
    let user_id = "your_user_id";

    let token = create_base64_token(appid, appkey, channel_id, user_id);
    println!("Base64 Token: {}", token);
}

クライアントサイド： joinChannel の呼び出し

クライアントはサーバーから Base64 トークン を受け取り、joinChannel API を呼び出してチャンネルに参加します。

• Android：

  // channelId と userId の値は Base64 トークンに含まれているため、null を渡すことができます。値を渡す場合は、トークンの生成に使用した値と一致させる必要があります。この機能は、サーバーとクライアント間のパラメーターの一貫性を検証するために使用できます。
  // base64Token は Base64 エンコードされたトークンです。
  // username は、トラブルシューティングのために渡すことができる ID です。
  mAliRtcEngine.joinChannel(base64Token, null, null, "username");

• iOS：

  // channelId と userId の値は Base64 トークンに含まれているため、null を渡すことができます。値を渡す場合は、トークンの生成に使用した値と一致させる必要があります。この機能は、サーバーとクライアント間のパラメーターの一貫性を検証するために使用できます。
  // base64Token は Base64 エンコードされたトークンです。
  // username は、トラブルシューティングのために渡すことができる ID です。
  [self.engine joinChannel:base64Token channelId:nil userId:nil name:@"username" onResultWithUserId:nil];

複数パラメーターメソッド

ARTC SDK は、複数のパラメーターでチャンネルに参加する API も提供しています。このメソッドは、AliRtcAuthInfo データ構造を使用してトークンとユーザー情報を保持します。

• Android：

  // トークンとユーザー情報を渡します。
  AliRtcAuthInfo authInfo = new AliRtcAuthInfo();
  authInfo.appId = appId;
  authInfo.channelId = channelId;
  authInfo.userId = userId;
  authInfo.timestamp = timestamp;
  authInfo.nonce = nonce;
  authInfo.token = token;
  // チャンネルに参加します。
  mAliRtcEngine.joinChannel(authInfo, "");

• iOS：

  // トークンとユーザー情報を渡します。
  let authInfo = AliRtcAuthInfo()
  authInfo.appId = appId
  authInfo.channelId = channelId
  authInfo.nonce = nonce
  authInfo.userId = userId
  authInfo.timestamp = timestamp
  authInfo.token = authToken
  // チャンネルに参加します。
  self.rtcEngine?.joinChannel(authInfo, name: nil)