agora-token 2.0.0

package/README.md

@@ -0,0 +1,36 @@
+# Authenticate Users with a token
+
+To enhance communication security, Agora uses tokens to authenticate users before they access the Agora service, or joining an RTC channel.
+
+## Code structure
+
+Under the `nodejs` directory:
+
+* `/src/` contains the source code for generating a token, where `RtcTokenBuilder.js` is used for generating an RTC token, and `RtmTokenBuilder.js` is used for generating an RTM token.
+* `/sample/` contains the sample code for generating a token, where `RtcTokenBuilderSample.js` is used for generating an RTC token, and `RtmTokenBuilderSample.js` is used for generating an RTM token.
+
+## Generate a token with the sample code
+
+This section takes `RtcTokenBuilderSample.js` as an example to show how to generate a token with the sample code.
+
+Before proceeding, ensure that you have installed the LTS version of Node.js.
+
+1. Run the following command to install the Node.js dependencies:
+
+   ```
+   npm install
+   ```
+
+2. Download or clone the [Tools](https://github.com/AgoraIO/Tools) repository.
+
+3. Open the `DynamicKey/AgoraDynamicKey/nodejs/sample/RtcTokenBuilderSample.js` file, replace the value of `appID`, `appCertificate`, `channelName`, and `uid` with your own, and comment out the code snippets of `buildTokenWithUserAccount`.
+
+4. Open your Terminal, navigate to the same directory that holds `RtcTokenBuilderSample.js`, and run the following command. The token is generated and printed in your Terminal window.
+
+   ```
+   node RtcTokenBuilderSample.js
+   ```
+
+## Reference
+
+For a complete authentication flow between the app server and app client, see [Authenticate Your Users with Tokens]().

package/index.d.ts

@@ -0,0 +1,232 @@
+
+export namespace RtcRole {
+    export const PUBLISHER: number;
+    export const SUBSCRIBER: number;
+}
+
+export namespace RtcTokenBuilder {
+
+    /**
+     * Builds an RTC token using an Integer uid.
+     * @param {*} appId  The App ID issued to you by Agora.
+     * @param {*} appCertificate Certificate of the application that you registered in the Agora Dashboard.
+     * @param {*} channelName The unique channel name for the AgoraRTC session in the string format. The string length must be less than 64 bytes. Supported character scopes are:
+     * - The 26 lowercase English letters: a to z.
+     * - The 26 uppercase English letters: A to Z.
+     * - The 10 digits: 0 to 9.
+     * - The space.
+     * - "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",".
+     * @param {*} uid User ID. A 32-bit unsigned integer with a value ranging from 1 to (2^32-1).
+     * @param {*} role See #userRole.
+     * - Role.PUBLISHER; RECOMMENDED. Use this role for a voice/video call or a live broadcast.
+     * - Role.SUBSCRIBER: ONLY use this role if your live-broadcast scenario requires authentication for [Hosting-in](https://docs.agora.io/en/Agora%20Platform/terms?platform=All%20Platforms#hosting-in). In order for this role to take effect, please contact our support team to enable authentication for Hosting-in for you. Otherwise, Role_Subscriber still has the same privileges as Role_Publisher.
+     * @param {*} token_expire epresented by the number of seconds elapsed since now. If, for example, you want to access the Agora Service within 10 minutes after the token is generated, set token_expire as 600(seconds)
+     * @param {*} privilege_expire represented by the number of seconds elapsed since now. If, for example, you want to enable your privilege for 10 minutes, set privilege_expire as 600(seconds).     * @return The new Token.
+     */
+     export function buildTokenWithUid(appId: string, appCertificate: string, channelName: string, uid: string | number, role: number,  token_expire: number, privilege_expire: number): string;
+
+    /**
+     * Builds an RTC token using an Integer uid.
+     * @param {*} appId  The App ID issued to you by Agora.
+     * @param {*} appCertificate Certificate of the application that you registered in the Agora Dashboard.
+     * @param {*} channelName The unique channel name for the AgoraRTC session in the string format. The string length must be less than 64 bytes. Supported character scopes are:
+     * - The 26 lowercase English letters: a to z.
+     * - The 26 uppercase English letters: A to Z.
+     * - The 10 digits: 0 to 9.
+     * - The space.
+     * - "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",".
+     * @param {*} account The user account.
+     * @param {*} role See #userRole.
+     * - Role.PUBLISHER; RECOMMENDED. Use this role for a voice/video call or a live broadcast.
+     * - Role.SUBSCRIBER: ONLY use this role if your live-broadcast scenario requires authentication for [Hosting-in](https://docs.agora.io/en/Agora%20Platform/terms?platform=All%20Platforms#hosting-in). In order for this role to take effect, please contact our support team to enable authentication for Hosting-in for you. Otherwise, Role_Subscriber still has the same privileges as Role_Publisher.
+     * @param {*} token_expire epresented by the number of seconds elapsed since now. If, for example, you want to access the Agora Service within 10 minutes after the token is generated, set token_expire as 600(seconds)
+     * @param {*} privilege_expire represented by the number of seconds elapsed since now. If, for example, you want to enable your privilege for 10 minutes, set privilege_expire as 600(seconds).
+     * @return The new Token.
+     */
+     export function buildTokenWithUserAccount(appId: string, appCertificate: string, channelName: string, account: string | number, role: number, token_expire: number, privilege_expire: number): string;
+
+     /**
+     * Generates an RTC token with the specified privilege.
+     *
+     * This method supports generating a token with the following privileges:
+     * - Joining an RTC channel.
+     * - Publishing audio in an RTC channel.
+     * - Publishing video in an RTC channel.
+     * - Publishing data streams in an RTC channel.
+     *
+     * The privileges for publishing audio, video, and data streams in an RTC channel apply only if you have
+     * enabled co-host authentication.
+     *
+     * A user can have multiple privileges. Each privilege is valid for a maximum of 24 hours.
+     * The SDK triggers the onTokenPrivilegeWillExpire and onRequestToken callbacks when the token is about to expire
+     * or has expired. The callbacks do not report the specific privilege affected, and you need to maintain
+     * the respective timestamp for each privilege in your app logic. After receiving the callback, you need
+     * to generate a new token, and then call renewToken to pass the new token to the SDK, or call joinChannel to re-join
+     * the channel.
+     *
+     * @note
+     * Agora recommends setting a reasonable timestamp for each privilege according to your scenario.
+     * Suppose the expiration timestamp for joining the channel is set earlier than that for publishing audio.
+     * When the token for joining the channel expires, the user is immediately kicked off the RTC channel
+     * and cannot publish any audio stream, even though the timestamp for publishing audio has not expired.
+     *
+     * @param appId The App ID of your Agora project.
+     * @param appCertificate The App Certificate of your Agora project.
+     * @param channelName The unique channel name for the Agora RTC session in string format. The string length must be less than 64 bytes. The channel name may contain the following characters:
+     * - All lowercase English letters: a to z.
+     * - All uppercase English letters: A to Z.
+     * - All numeric characters: 0 to 9.
+     * - The space character.
+     * - "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",".
+     * @param uid The user ID. A 32-bit unsigned integer with a value range from 1 to (2^32 - 1). It must be unique. Set uid as 0, if you do not want to authenticate the user ID, that is, any uid from the app client can join the channel.
+     * @param tokenExpire represented by the number of seconds elapsed since now. If, for example, you want to access the
+     * Agora Service within 10 minutes after the token is generated, set token_expire as 600(seconds).
+     * @param joinChannelPrivilegeExpire The Unix timestamp when the privilege for joining the channel expires, represented
+     * by the sum of the current timestamp plus the valid time period of the token. For example, if you set joinChannelPrivilegeExpire as the
+     * current timestamp plus 600 seconds, the token expires in 10 minutes.
+     * @param pubAudioPrivilegeExpire The Unix timestamp when the privilege for publishing audio expires, represented
+     * by the sum of the current timestamp plus the valid time period of the token. For example, if you set pubAudioPrivilegeExpire as the
+     * current timestamp plus 600 seconds, the token expires in 10 minutes. If you do not want to enable this privilege,
+     * set pubAudioPrivilegeExpire as the current Unix timestamp.
+     * @param pubVideoPrivilegeExpire The Unix timestamp when the privilege for publishing video expires, represented
+     * by the sum of the current timestamp plus the valid time period of the token. For example, if you set pubVideoPrivilegeExpire as the
+     * current timestamp plus 600 seconds, the token expires in 10 minutes. If you do not want to enable this privilege,
+     * set pubVideoPrivilegeExpire as the current Unix timestamp.
+     * @param pubDataStreamPrivilegeExpire The Unix timestamp when the privilege for publishing data streams expires, represented
+     * by the sum of the current timestamp plus the valid time period of the token. For example, if you set pubDataStreamPrivilegeExpire as the
+     * current timestamp plus 600 seconds, the token expires in 10 minutes. If you do not want to enable this privilege,
+     * set pubDataStreamPrivilegeExpire as the current Unix timestamp.
+     * @return The new Token
+     */
+    export function buildTokenWithUidAndPrivilege(appId: string, appCertificate: string, channelName: string, uid: string | number,
+        tokenExpire: number, joinChannelPrivilegeExpire: number, pubAudioPrivilegeExpire: number,
+        pubVideoPrivilegeExpire: number, pubDataStreamPrivilegeExpire: number): string;
+
+    /**
+     * Generates an RTC token with the specified privilege.
+     *
+     * This method supports generating a token with the following privileges:
+     * - Joining an RTC channel.
+     * - Publishing audio in an RTC channel.
+     * - Publishing video in an RTC channel.
+     * - Publishing data streams in an RTC channel.
+     *
+     * The privileges for publishing audio, video, and data streams in an RTC channel apply only if you have
+     * enabled co-host authentication.
+     *
+     * A user can have multiple privileges. Each privilege is valid for a maximum of 24 hours.
+     * The SDK triggers the onTokenPrivilegeWillExpire and onRequestToken callbacks when the token is about to expire
+     * or has expired. The callbacks do not report the specific privilege affected, and you need to maintain
+     * the respective timestamp for each privilege in your app logic. After receiving the callback, you need
+     * to generate a new token, and then call renewToken to pass the new token to the SDK, or call joinChannel to re-join
+     * the channel.
+     *
+     * @note
+     * Agora recommends setting a reasonable timestamp for each privilege according to your scenario.
+     * Suppose the expiration timestamp for joining the channel is set earlier than that for publishing audio.
+     * When the token for joining the channel expires, the user is immediately kicked off the RTC channel
+     * and cannot publish any audio stream, even though the timestamp for publishing audio has not expired.
+     *
+     * @param appId The App ID of your Agora project.
+     * @param appCertificate The App Certificate of your Agora project.
+     * @param channelName The unique channel name for the Agora RTC session in string format. The string length must be less than 64 bytes. The channel name may contain the following characters:
+     * - All lowercase English letters: a to z.
+     * - All uppercase English letters: A to Z.
+     * - All numeric characters: 0 to 9.
+     * - The space character.
+     * - "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",".
+     * @param userAccount The user account.
+     * @param tokenExpire represented by the number of seconds elapsed since now. If, for example, you want to access the
+     * Agora Service within 10 minutes after the token is generated, set token_expire as 600(seconds).
+     * @param joinChannelPrivilegeExpire The Unix timestamp when the privilege for joining the channel expires, represented
+     * by the sum of the current timestamp plus the valid time period of the token. For example, if you set joinChannelPrivilegeExpire as the
+     * current timestamp plus 600 seconds, the token expires in 10 minutes.
+     * @param pubAudioPrivilegeExpire The Unix timestamp when the privilege for publishing audio expires, represented
+     * by the sum of the current timestamp plus the valid time period of the token. For example, if you set pubAudioPrivilegeExpire as the
+     * current timestamp plus 600 seconds, the token expires in 10 minutes. If you do not want to enable this privilege,
+     * set pubAudioPrivilegeExpire as the current Unix timestamp.
+     * @param pubVideoPrivilegeExpire The Unix timestamp when the privilege for publishing video expires, represented
+     * by the sum of the current timestamp plus the valid time period of the token. For example, if you set pubVideoPrivilegeExpire as the
+     * current timestamp plus 600 seconds, the token expires in 10 minutes. If you do not want to enable this privilege,
+     * set pubVideoPrivilegeExpire as the current Unix timestamp.
+     * @param pubDataStreamPrivilegeExpire The Unix timestamp when the privilege for publishing data streams expires, represented
+     * by the sum of the current timestamp plus the valid time period of the token. For example, if you set pubDataStreamPrivilegeExpire as the
+     * current timestamp plus 600 seconds, the token expires in 10 minutes. If you do not want to enable this privilege,
+     * set pubDataStreamPrivilegeExpire as the current Unix timestamp.
+     * @return The new Token.
+     */
+    export function BuildTokenWithUserAccountAndPrivilege(appId: string, appCertificate: string, channelName: string, account: string | number,
+        tokenExpire: number, joinChannelPrivilegeExpire: number, pubAudioPrivilegeExpire: number,
+        pubVideoPrivilegeExpire: number, pubDataStreamPrivilegeExpire: number): string;
+}
+
+export namespace RtmTokenBuilder {
+
+    /**
+     * Build the RTM token.
+     *
+     * @param appId The App ID issued to you by Agora. Apply for a new App ID from
+     * Agora Dashboard if it is missing from your kit. See Get an App ID.
+     * @param appCertificate Certificate of the application that you registered in
+     * the Agora Dashboard. See Get an App Certificate.
+     * @param userId The user's account, max length is 64 Bytes.
+     * @param expire represented by the number of seconds elapsed since now. If, for example, you want to access the
+     * Agora Service within 10 minutes after the token is generated, set expireTimestamp as 600(seconds).
+     * @return The RTM token.
+     */
+     export function buildToken(appId: string, appCertificate: string, userId: string | number, expire: number): string;
+}
+
+export namespace EducationTokenBuilder {
+    /**
+     * build user room token
+     * @param appId             The App ID issued to you by Agora. Apply for a new App ID from
+     *                          Agora Dashboard if it is missing from your kit. See Get an App ID.
+     * @param appCertificate    Certificate of the application that you registered in
+     *                          the Agora Dashboard. See Get an App Certificate.
+     * @param roomUuid          The room's id, must be unique.
+     * @param userUuid          The user's id, must be unique.
+     * @param role              The user's role, such as 0(invisible), 1(teacher), 2(student), 3(assistant), 4(observer) etc.
+     * @param expire            represented by the number of seconds elapsed since now. If, for example, you want to access the
+     *                          Agora Service within 10 minutes after the token is generated, set expireTimestamp as 600(seconds).
+     * @return The education user room token.
+     */
+     export function buildRoomUserToken(appId: string, appCertificate: string, roomUuid: string, userUuid: string | number, role: number, expire: number): string;
+
+    /**
+     * build user individual token
+     * @param appId             The App ID issued to you by Agora. Apply for a new App ID from
+     *                          Agora Dashboard if it is missing from your kit. See Get an App ID.
+     * @param appCertificate    Certificate of the application that you registered in
+     *                          the Agora Dashboard. See Get an App Certificate.
+     * @param userUuid          The user's id, must be unique.
+     * @param expire            represented by the number of seconds elapsed since now. If, for example, you want to access the
+     *                          Agora Service within 10 minutes after the token is generated, set expireTimestamp as 600(seconds).
+     * @return The education user token.
+     */
+    export function buildUserToken(appId: string, appCertificate: string, userUuid: string | number, expire: number): string;
+
+    /**
+     * build app global token
+     * @param appId          The App ID issued to you by Agora. Apply for a new App ID from
+     *                       Agora Dashboard if it is missing from your kit. See Get an App ID.
+     * @param appCertificate Certificate of the application that you registered in
+     *                       the Agora Dashboard. See Get an App Certificate.
+     * @param expire         represented by the number of seconds elapsed since now. If, for example, you want to access the
+     *                       Agora Service within 10 minutes after the token is generated, set expireTimestamp as 600(seconds).
+     * @return The education global token.
+     */
+     export function buildAppToken(appId: string, appCertificate: string, expire: number): string;
+}
+
+export namespace FpaTokenBuilder {
+    /**
+     * Build the FPA token.
+     * @param appId The App ID issued to you by Agora. Apply for a new App ID from
+     * Agora Dashboard if it is missing from your kit. See Get an App ID.
+     * @param appCertificate Certificate of the application that you registered in
+     * the Agora Dashboard. See Get an App Certificate.
+     * @return The FPA token.
+     */
+    export function buildToken(appId: string, appCertificate: string): string;
+}

package/index.js

@@ -0,0 +1,7 @@
+module.exports = {
+  RtcTokenBuilder: require('./src/RtcTokenBuilder2').RtcTokenBuilder,
+  RtcRole: require('./src/RtcTokenBuilder2').Role,
+  RtmTokenBuilder: require('./src/RtmTokenBuilder2').RtmTokenBuilder,
+  EducationTokenBuilder: require('./src/EducationTokenBuilder').EducationTokenBuilder,
+  FpaTokenBuilder: require('./src/FpaTokenBuilder').FpaTokenBuilder
+};

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "agora-token",
+  "version": "2.0.0",
+  "description": "",
+  "homepage": "https://github.com/AgoraIO/Tools/tree/master/DynamicKey/AgoraDynamicKey/nodejs",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "types": "index.d.ts",
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "crc-32": "^1.2.0",
+    "cuint": "0.2.2",
+    "md5": "^2.3.0",
+    "nodeunit": "^0.11.3"
+  }
+}

package/sample/AccessToken2Sample.js

@@ -0,0 +1,18 @@
+const {AccessToken2, ServiceRtc} = require('../src/AccessToken2')
+const RtcRole = require('../src/RtcTokenBuilder').Role;
+
+const appID = '970CA35de60c44645bbae8a215061b33';
+const appCertificate = '5CFd2fd1755d40ecb72977518be15d3b';
+const channelName = '7d72365eb983485397e3e3f9d460bdda';
+const uid = 2882341273;
+const account = "2882341273";
+const role = RtcRole.PUBLISHER;
+
+const expirationTimeInSeconds = 3600
+
+const currentTimestamp = Math.floor(Date.now() / 1000)
+
+let token = new AccessToken2(appID, appCertificate, currentTimestamp, expirationTimeInSeconds)
+let rtc_service = new ServiceRtc(channelName, uid)
+token.add_service(rtc_service)
+console.log(token.build())

package/sample/EducationTokenSample.js

@@ -0,0 +1,21 @@
+/**
+ * run this test with command:
+ * nodeunit test/RtcTokenBuilder2Test.js
+ * see https://github.com/caolan/nodeunit
+ */
+ const EduTokenBuilder = require('../src/EducationTokenBuilder').EducationTokenBuilder
+ const {AccessToken2, ServiceEducation, kEducationServiceType} = require('../src/AccessToken2')
+ const appId = "970CA35de60c44645bbae8a215061b33"
+ const appCertificate = "5CFd2fd1755d40ecb72977518be15d3b"
+ const expire = 600
+ const roomUuid = "123"
+ const userUuid = "2882341273"
+ const role = 1
+
+const tokenA = EduTokenBuilder.buildRoomUserToken(appId, appCertificate, roomUuid, userUuid, role, expire)
+console.log("Build room user token: " + tokenA);
+const tokenB = EduTokenBuilder.buildUserToken(appId, appCertificate, userUuid, expire)
+console.log("Build user token " + tokenB);
+const tokenC = EduTokenBuilder.buildAppToken(appId, appCertificate, expire)
+console.log("Build app token: " + tokenC);
+ 

package/sample/FpaTokenBuilderSample.js

@@ -0,0 +1,7 @@
+const FpaTokenBuilder = require('../src/FpaTokenBuilder').FpaTokenBuilder
+
+const appID = '970CA35de60c44645bbae8a215061b33'
+const appCertificate = '5CFd2fd1755d40ecb72977518be15d3b'
+
+let token = FpaTokenBuilder.buildToken(appID, appCertificate)
+console.log("Token with FPA service: " + token)

package/sample/README.md

@@ -0,0 +1,12 @@
+- **RtcTokenBuilder.js**: Source code for generating a token for the following SDKs:
+  - Agora Native SDK v2.1+
+
+  - Agora Web SDK v2.4+
+
+  - Agora Recording SDK v2.1+
+
+  - Agora RTSA SDK
+
+> The Agora RTSA SDK supports joining multiple channels. If you join multiple channels at the same time, then you MUST generate a specific token for each channel you join. 
+- **RtmTokenBuilder.js**: Source code for generating a token for the Agora RTM SDK. 
+- **AccessToken.js**: Implements all the underlying algorithms for generating a token. Both **RtcTokenBuilder.js** and **RtmTokenBuilder.js** are a wrapper of **AccessToken.js** and have much easier-to-use APIs. We recommend using **RtcTokenBuilder.js** for generating an RTC token or **RtmTokenBuilder.js** for an RTM token.

package/sample/RtcTokenBuilder2Sample.js

@@ -0,0 +1,28 @@
+const RtcTokenBuilder = require('../src/RtcTokenBuilder2').RtcTokenBuilder
+const RtcRole = require('../src/RtcTokenBuilder2').Role
+
+const appID = '970CA35de60c44645bbae8a215061b33'
+const appCertificate = '5CFd2fd1755d40ecb72977518be15d3b'
+const channelName = '7d72365eb983485397e3e3f9d460bdda'
+const uid = 2882341273
+const account = "2882341273"
+const role = RtcRole.PUBLISHER
+const expirationInSeconds = 3600
+
+const tokenExpirationInSecond = 3600
+const privilegeExpirationInSecond = 3600
+// Build token with uid
+const tokenA = RtcTokenBuilder.buildTokenWithUid(appID, appCertificate, channelName, uid, role, tokenExpirationInSecond, privilegeExpirationInSecond)
+console.log("Token with int uid: " + tokenA)
+
+// Build token with user account
+const tokenB = RtcTokenBuilder.buildTokenWithUserAccount(appID, appCertificate, channelName, account, role, tokenExpirationInSecond, privilegeExpirationInSecond)
+console.log("Token with user account: " + tokenB)
+
+const tokenC = RtcTokenBuilder.buildTokenWithUidAndPrivilege(appID, appCertificate, channelName, uid,
+    expirationInSeconds, expirationInSeconds, expirationInSeconds, expirationInSeconds, expirationInSeconds)
+console.log("Token with int uid and privilege:" + tokenC)
+
+const tokenD = RtcTokenBuilder.BuildTokenWithUserAccountAndPrivilege(appID, appCertificate, channelName, account,
+    expirationInSeconds, expirationInSeconds, expirationInSeconds, expirationInSeconds, expirationInSeconds)
+console.log("Token with user account and privilege:" + tokenD)

package/sample/RtcTokenBuilderSample.js

@@ -0,0 +1,25 @@
+const RtcTokenBuilder = require('../src/RtcTokenBuilder').RtcTokenBuilder;
+const RtcRole = require('../src/RtcTokenBuilder').Role;
+
+const appID = '970CA35de60c44645bbae8a215061b33';
+const appCertificate = '5CFd2fd1755d40ecb72977518be15d3b';
+const channelName = '7d72365eb983485397e3e3f9d460bdda';
+const uid = 2882341273;
+const account = "2882341273";
+const role = RtcRole.PUBLISHER;
+
+const expirationTimeInSeconds = 3600
+
+const currentTimestamp = Math.floor(Date.now() / 1000)
+
+const privilegeExpiredTs = currentTimestamp + expirationTimeInSeconds
+
+// IMPORTANT! Build token with either the uid or with the user account. Comment out the option you do not want to use below.
+
+// Build token with uid
+const tokenA = RtcTokenBuilder.buildTokenWithUid(appID, appCertificate, channelName, uid, role, privilegeExpiredTs);
+console.log("Token With Integer Number Uid: " + tokenA);
+
+// Build token with user account
+const tokenB = RtcTokenBuilder.buildTokenWithAccount(appID, appCertificate, channelName, account, role, privilegeExpiredTs);
+console.log("Token With UserAccount: " + tokenB);

package/sample/RtmTokenBuilder2Sample.js

@@ -0,0 +1,8 @@
+const RtmTokenBuilder = require("../src/RtmTokenBuilder2").RtmTokenBuilder;
+const appId = "970CA35de60c44645bbae8a215061b33";
+const appCertificate = "5CFd2fd1755d40ecb72977518be15d3b";
+const userId = "test_user_id";
+const expirationInSeconds = 3600;
+
+const token = RtmTokenBuilder.buildToken(appId, appCertificate, userId, expirationInSeconds);
+console.log("Rtm Token: " + token);

package/sample/RtmTokenBuilderSample.js

@@ -0,0 +1,14 @@
+const RtmTokenBuilder = require('../src/RtmTokenBuilder').RtmTokenBuilder;
+const RtmRole = require('../src/RtmTokenBuilder').Role;
+const Priviledges = require('../src/AccessToken').priviledges;
+const appID  = "970CA35de60c44645bbae8a215061b33";
+const appCertificate = "5CFd2fd1755d40ecb72977518be15d3b";
+const account = "test_user_id";
+
+const expirationTimeInSeconds = 3600
+const currentTimestamp = Math.floor(Date.now() / 1000)
+
+const privilegeExpiredTs = currentTimestamp + expirationTimeInSeconds
+
+const token = RtmTokenBuilder.buildToken(appID, appCertificate, account, RtmRole, privilegeExpiredTs);
+console.log("Rtm Token: " + token);

package/sample.js

@@ -0,0 +1,46 @@
+const {RtcTokenBuilder, RtmTokenBuilder, RtcRole, RtmRole} = require('./index')
+
+const generateRtcToken = () => {
+  // Rtc Examples
+  const appID = '970CA35de60c44645bbae8a215061b33';
+  const appCertificate = '5CFd2fd1755d40ecb72977518be15d3b';
+  const channelName = '7d72365eb983485397e3e3f9d460bdda';
+  const uid = 2882341273;
+  const account = "2882341273";
+  const role = RtcRole.PUBLISHER;
+
+  const expirationTimeInSeconds = 3600
+
+  const currentTimestamp = Math.floor(Date.now() / 1000)
+
+  const privilegeExpiredTs = currentTimestamp + expirationTimeInSeconds
+
+  // IMPORTANT! Build token with either the uid or with the user account. Comment out the option you do not want to use below.
+
+  // Build token with uid
+  const tokenA = RtcTokenBuilder.buildTokenWithUid(appID, appCertificate, channelName, uid, role, privilegeExpiredTs);
+  console.log("Token With Integer Number Uid: " + tokenA);
+
+  // Build token with user account
+  const tokenB = RtcTokenBuilder.buildTokenWithAccount(appID, appCertificate, channelName, account, role, privilegeExpiredTs);
+  console.log("Token With UserAccount: " + tokenB);
+}
+
+
+const generateRtmToken = () => {
+  // Rtm Examples
+  const appID  = "970CA35de60c44645bbae8a215061b33";
+  const appCertificate = "5CFd2fd1755d40ecb72977518be15d3b";
+  const account = "test_user_id";
+
+  const expirationTimeInSeconds = 3600
+  const currentTimestamp = Math.floor(Date.now() / 1000)
+
+  const privilegeExpiredTs = currentTimestamp + expirationTimeInSeconds
+
+  const token = RtmTokenBuilder.buildToken(appID, appCertificate, account, RtmRole, privilegeExpiredTs);
+  console.log("Rtm Token: " + token);
+}
+
+generateRtcToken()
+generateRtmToken()

package/server/DemoServer.js

@@ -0,0 +1,66 @@
+//var fs = require('fs');
+//var https = require('https');
+var http = require('http');
+var express = require('express');
+var {RtcTokenBuilder, RtmTokenBuilder, RtcRole, RtmRole} = require('agora-access-token')
+
+var PORT = 8080;
+
+// Fill the appID and appCertificate key given by Agora.io
+var appID = "<YOUR APP ID>";
+var appCertificate = "<YOUR APP CERTIFICATE>";
+
+// token expire time, hardcode to 3600 seconds = 1 hour
+var expirationTimeInSeconds = 3600
+var role = RtcRole.PUBLISHER
+
+var app = express();
+app.disable('x-powered-by');
+app.set('port', PORT);
+app.use(express.favicon());
+app.use(app.router);
+
+var generateRtcToken = function(req, resp) {
+    var currentTimestamp = Math.floor(Date.now() / 1000)
+    var privilegeExpiredTs = currentTimestamp + expirationTimeInSeconds
+    var channelName = req.query.channelName;
+    // use 0 if uid is not specified
+    var uid = req.query.uid || 0
+    if (!channelName) {
+        return resp.status(400).json({ 'error': 'channel name is required' }).send();
+    }
+
+
+    var key = RtcTokenBuilder.buildTokenWithUid(appID, appCertificate, channelName, uid, role, privilegeExpiredTs);
+
+    resp.header("Access-Control-Allow-Origin", "*")
+        //resp.header("Access-Control-Allow-Origin", "http://ip:port")
+    return resp.json({ 'key': key }).send();
+};
+
+var generateRtmToken = function(req, resp) {
+    var currentTimestamp = Math.floor(Date.now() / 1000)
+    var privilegeExpiredTs = currentTimestamp + expirationTimeInSeconds
+    var account = req.query.account;
+    if (!account) {
+        return resp.status(400).json({ 'error': 'account is required' }).send();
+    }
+
+    var key = RtmTokenBuilder.buildToken(appID, appCertificate, account, RtmRole, privilegeExpiredTs);
+
+    resp.header("Access-Control-Allow-Origin", "*")
+        //resp.header("Access-Control-Allow-Origin", "http://ip:port")
+    return resp.json({ 'key': key }).send();
+};
+
+app.get('/rtcToken', generateRtcToken);
+app.get('/rtmToken', generateRtmToken);
+
+
+http.createServer(app).listen(app.get('port'), function() {
+    console.log('AgoraSignServer starts at ' + app.get('port'));
+});
+
+//https.createServer(credentials, app).listen(app.get('port') + 1, function() {
+//    console.log('AgoraSignServer starts at ' + (app.get('port') + 1));
+//});

package/server/README.md

@@ -0,0 +1,26 @@
+# How to use
+## Fill in your vendor information
+Open *DemoServer.js* and replace <YOUR APP ID> and <YOUR APP CERTIFICATE> with your value
+```
+// Fill the appID and appCertificate key given by Agora.io
+var appID = "<YOUR APP ID>";
+var appCertificate = "<YOUR APP CERTIFICATE>";
+```
+
+## Install Dependencies
+
+```shell
+npm i
+node DemoServer.js
+```
+
+## Generate Token
+### Generate RTC Token
+```shell
+curl http://localhost:8080/rtcToken?channelName=test
+```
+
+### Generate RTM Token
+```shell
+curl http://localhost:8080/rtmToken?account=testAccount
+```