agora-token 2.0.4 → 2.0.6

package/test/FpaTokenBuilderTest.js

@@ -10,6 +10,7 @@ const appId = "970CA35de60c44645bbae8a215061b33"
 const appCertificate = "5CFd2fd1755d40ecb72977518be15d3b"
 const expire = 24 * 3600
 
+// Verifies FPA token generation and parsing.
 exports.buildToken_Test = function (test) {
     let token = FpaTokenBuilder.buildToken(appId, appCertificate)
     let accessToken = new AccessToken2('', '', 0, 0)
@@ -17,6 +18,6 @@ exports.buildToken_Test = function (test) {
 
     test.equal(appId, accessToken.appId)
     test.equal(expire, accessToken.expire)
-    test.equal(0, accessToken.services[kFpaServiceType].__privileges[ServiceFpa.kPrivilegeLogin])
+    test.equal(0, accessToken.getServices(kFpaServiceType)[0].__privileges[ServiceFpa.kPrivilegeLogin])
     test.done()
 }

package/test/RtcTokenBuilder2Test.js

@@ -17,6 +17,7 @@ const expire = 600;
 const tokenExpirationInSecond = 600;
 const privilegeExpirationInSecond = 600;
 
+// Verifies subscriber RTC token generation with a numeric user ID.
 exports.buildTokenWithUid_SUBSCRIBER_Test = function (test) {
     let token = RtcTokenBuilder.buildTokenWithUid(
         appId,
@@ -29,15 +30,17 @@ exports.buildTokenWithUid_SUBSCRIBER_Test = function (test) {
     );
     let accessToken = new AccessToken2("", "", 0, 0);
     accessToken.from_string(token);
+    const service = accessToken.getServices(kRtcServiceType)[0];
 
     test.equal(appId, accessToken.appId);
     test.equal(expire, accessToken.expire);
-    test.equal(channelName, accessToken.services[kRtcServiceType].__channel_name);
-    test.equal(uidStr, accessToken.services[kRtcServiceType].__uid);
-    test.equal(expire, accessToken.services[kRtcServiceType].__privileges[ServiceRtc.kPrivilegeJoinChannel]);
+    test.equal(channelName, service.__channel_name);
+    test.equal(uidStr, service.__uid);
+    test.equal(expire, service.__privileges[ServiceRtc.kPrivilegeJoinChannel]);
     test.done();
 };
 
+// Verifies publisher RTC token generation with a numeric user ID.
 exports.buildTokenWithUid_PUBLISHER_Test = function (test) {
     let token = RtcTokenBuilder.buildTokenWithUid(
         appId,
@@ -50,18 +53,20 @@ exports.buildTokenWithUid_PUBLISHER_Test = function (test) {
     );
     let accessToken = new AccessToken2("", "", 0, 0);
     accessToken.from_string(token);
+    const service = accessToken.getServices(kRtcServiceType)[0];
 
     test.equal(appId, accessToken.appId);
     test.equal(expire, accessToken.expire);
-    test.equal(channelName, accessToken.services[kRtcServiceType].__channel_name);
-    test.equal(uidStr, accessToken.services[kRtcServiceType].__uid);
-    test.equal(expire, accessToken.services[kRtcServiceType].__privileges[ServiceRtc.kPrivilegeJoinChannel]);
-    test.equal(expire, accessToken.services[kRtcServiceType].__privileges[ServiceRtc.kPrivilegePublishAudioStream]);
-    test.equal(expire, accessToken.services[kRtcServiceType].__privileges[ServiceRtc.kPrivilegePublishVideoStream]);
-    test.equal(expire, accessToken.services[kRtcServiceType].__privileges[ServiceRtc.kPrivilegePublishDataStream]);
+    test.equal(channelName, service.__channel_name);
+    test.equal(uidStr, service.__uid);
+    test.equal(expire, service.__privileges[ServiceRtc.kPrivilegeJoinChannel]);
+    test.equal(expire, service.__privileges[ServiceRtc.kPrivilegePublishAudioStream]);
+    test.equal(expire, service.__privileges[ServiceRtc.kPrivilegePublishVideoStream]);
+    test.equal(expire, service.__privileges[ServiceRtc.kPrivilegePublishDataStream]);
     test.done();
 };
 
+// Verifies subscriber RTC token generation with a user account.
 exports.buildTokenWithUserAccount_SUBSCRIBER_Test = function (test) {
     let token = RtcTokenBuilder.buildTokenWithUserAccount(
         appId,
@@ -74,15 +79,17 @@ exports.buildTokenWithUserAccount_SUBSCRIBER_Test = function (test) {
     );
     let accessToken = new AccessToken2("", "", 0, 0);
     accessToken.from_string(token);
+    const service = accessToken.getServices(kRtcServiceType)[0];
 
     test.equal(appId, accessToken.appId);
     test.equal(expire, accessToken.expire);
-    test.equal(channelName, accessToken.services[kRtcServiceType].__channel_name);
-    test.equal(uidStr, accessToken.services[kRtcServiceType].__uid);
-    test.equal(expire, accessToken.services[kRtcServiceType].__privileges[ServiceRtc.kPrivilegeJoinChannel]);
+    test.equal(channelName, service.__channel_name);
+    test.equal(uidStr, service.__uid);
+    test.equal(expire, service.__privileges[ServiceRtc.kPrivilegeJoinChannel]);
     test.done();
 };
 
+// Verifies publisher RTC token generation with a user account.
 exports.buildTokenWithUserAccount_PUBLISHER_Test = function (test) {
     let token = RtcTokenBuilder.buildTokenWithUserAccount(
         appId,
@@ -95,46 +102,83 @@ exports.buildTokenWithUserAccount_PUBLISHER_Test = function (test) {
     );
     let accessToken = new AccessToken2("", "", 0, 0);
     accessToken.from_string(token);
+    const service = accessToken.getServices(kRtcServiceType)[0];
 
     test.equal(appId, accessToken.appId);
     test.equal(expire, accessToken.expire);
-    test.equal(channelName, accessToken.services[kRtcServiceType].__channel_name);
-    test.equal(uidStr, accessToken.services[kRtcServiceType].__uid);
-    test.equal(expire, accessToken.services[kRtcServiceType].__privileges[ServiceRtc.kPrivilegeJoinChannel]);
-    test.equal(expire, accessToken.services[kRtcServiceType].__privileges[ServiceRtc.kPrivilegePublishAudioStream]);
-    test.equal(expire, accessToken.services[kRtcServiceType].__privileges[ServiceRtc.kPrivilegePublishVideoStream]);
-    test.equal(expire, accessToken.services[kRtcServiceType].__privileges[ServiceRtc.kPrivilegePublishDataStream]);
+    test.equal(channelName, service.__channel_name);
+    test.equal(uidStr, service.__uid);
+    test.equal(expire, service.__privileges[ServiceRtc.kPrivilegeJoinChannel]);
+    test.equal(expire, service.__privileges[ServiceRtc.kPrivilegePublishAudioStream]);
+    test.equal(expire, service.__privileges[ServiceRtc.kPrivilegePublishVideoStream]);
+    test.equal(expire, service.__privileges[ServiceRtc.kPrivilegePublishDataStream]);
     test.done();
 };
 
+// Verifies RTC token generation with explicit numeric-user privileges.
 exports.buildTokenWithUidAndPrivilege_Test = function (test) {
     let token = RtcTokenBuilder.buildTokenWithUidAndPrivilege(appId, appCertificate, channelName, uid, expire, expire, expire, expire, expire);
     let accessToken = new AccessToken2("", "", 0, 0);
     accessToken.from_string(token);
+    const service = accessToken.getServices(kRtcServiceType)[0];
 
     test.equal(appId, accessToken.appId);
     test.equal(expire, accessToken.expire);
-    test.equal(channelName, accessToken.services[kRtcServiceType].__channel_name);
-    test.equal(uidStr, accessToken.services[kRtcServiceType].__uid);
-    test.equal(expire, accessToken.services[kRtcServiceType].__privileges[ServiceRtc.kPrivilegeJoinChannel]);
-    test.equal(expire, accessToken.services[kRtcServiceType].__privileges[ServiceRtc.kPrivilegePublishAudioStream]);
-    test.equal(expire, accessToken.services[kRtcServiceType].__privileges[ServiceRtc.kPrivilegePublishVideoStream]);
-    test.equal(expire, accessToken.services[kRtcServiceType].__privileges[ServiceRtc.kPrivilegePublishDataStream]);
+    test.equal(channelName, service.__channel_name);
+    test.equal(uidStr, service.__uid);
+    test.equal(expire, service.__privileges[ServiceRtc.kPrivilegeJoinChannel]);
+    test.equal(expire, service.__privileges[ServiceRtc.kPrivilegePublishAudioStream]);
+    test.equal(expire, service.__privileges[ServiceRtc.kPrivilegePublishVideoStream]);
+    test.equal(expire, service.__privileges[ServiceRtc.kPrivilegePublishDataStream]);
     test.done();
 };
 
+// Verifies RTC token generation with explicit user-account privileges.
 exports.BuildTokenWithUserAccountAndPrivilege_Test = function (test) {
     let token = RtcTokenBuilder.BuildTokenWithUserAccountAndPrivilege(appId, appCertificate, channelName, uidStr, expire, expire, expire, expire, expire);
     let accessToken = new AccessToken2("", "", 0, 0);
     accessToken.from_string(token);
+    const service = accessToken.getServices(kRtcServiceType)[0];
 
     test.equal(appId, accessToken.appId);
     test.equal(expire, accessToken.expire);
-    test.equal(channelName, accessToken.services[kRtcServiceType].__channel_name);
-    test.equal(uidStr, accessToken.services[kRtcServiceType].__uid);
-    test.equal(expire, accessToken.services[kRtcServiceType].__privileges[ServiceRtc.kPrivilegeJoinChannel]);
-    test.equal(expire, accessToken.services[kRtcServiceType].__privileges[ServiceRtc.kPrivilegePublishAudioStream]);
-    test.equal(expire, accessToken.services[kRtcServiceType].__privileges[ServiceRtc.kPrivilegePublishVideoStream]);
-    test.equal(expire, accessToken.services[kRtcServiceType].__privileges[ServiceRtc.kPrivilegePublishDataStream]);
+    test.equal(channelName, service.__channel_name);
+    test.equal(uidStr, service.__uid);
+    test.equal(expire, service.__privileges[ServiceRtc.kPrivilegeJoinChannel]);
+    test.equal(expire, service.__privileges[ServiceRtc.kPrivilegePublishAudioStream]);
+    test.equal(expire, service.__privileges[ServiceRtc.kPrivilegePublishVideoStream]);
+    test.equal(expire, service.__privileges[ServiceRtc.kPrivilegePublishDataStream]);
     test.done();
 };
+
+// Verifies combined RTC and RTM token generation for both role branches.
+exports.buildTokenWithRtm_Test = function (test) {
+    const publisher = RtcTokenBuilder.buildTokenWithRtm(
+        appId, appCertificate, channelName, uidStr, Role.PUBLISHER, expire, expire)
+    const subscriber = RtcTokenBuilder.buildTokenWithRtm(
+        appId, appCertificate, channelName, uidStr, Role.SUBSCRIBER, expire, expire)
+
+    for (const token of [publisher, subscriber]) {
+        const parsed = new AccessToken2('', '', 0, 0)
+        test.equal(true, parsed.from_string(token))
+        test.equal(2, parsed.services.length)
+    }
+    test.done()
+};
+
+// Verifies combined RTC and RTM token generation with independent privileges.
+exports.buildTokenWithRtm2_Test = function (test) {
+    const publisher = RtcTokenBuilder.buildTokenWithRtm2(
+        appId, appCertificate, channelName, uidStr, Role.PUBLISHER, expire,
+        1, 2, 3, 4, uidStr, expire)
+    const subscriber = RtcTokenBuilder.buildTokenWithRtm2(
+        appId, appCertificate, channelName, uidStr, Role.SUBSCRIBER, expire,
+        1, 2, 3, 4, uidStr, expire)
+
+    for (const token of [publisher, subscriber]) {
+        const parsed = new AccessToken2('', '', 0, 0)
+        test.equal(true, parsed.from_string(token))
+        test.equal(2, parsed.services.length)
+    }
+    test.done()
+};

package/test/RtmTokenBuilder2Test.js

@@ -3,22 +3,71 @@
  * nodeunit test/RtmTokenBuilder2Test.js
  * see https://github.com/caolan/nodeunit
  */
-const RtmTokenBuilder = require("../src/RtmTokenBuilder2").RtmTokenBuilder;
-const { AccessToken2, ServiceRtm, kRtmServiceType } = require("../src/AccessToken2");
+const { Rtm2Permissions, RtmTokenBuilder } = require("../index");
+const { AccessToken2, ServiceRtm, ServiceRtm2, kRtmServiceType, kRtm2ServiceType } = require("../src/AccessToken2");
 
 const appId = "970CA35de60c44645bbae8a215061b33";
 const appCertificate = "5CFd2fd1755d40ecb72977518be15d3b";
 const userId = "test_user";
 const expire = 600;
 
+// Verifies RTM Token007 generation and parsing.
 exports.buildToken = function (test) {
     let token = RtmTokenBuilder.buildToken(appId, appCertificate, userId, expire);
     let accessToken = new AccessToken2("", "", 0, 0);
     accessToken.from_string(token);
+    const service = accessToken.getServices(kRtmServiceType)[0];
 
     test.equal(appId, accessToken.appId);
     test.equal(expire, accessToken.expire);
-    test.equal(userId, accessToken.services[kRtmServiceType].__user_id);
-    test.equal(expire, accessToken.services[kRtmServiceType].__privileges[ServiceRtm.kPrivilegeLogin]);
+    test.equal(userId, service.__user_id);
+    test.equal(expire, service.__privileges[ServiceRtm.kPrivilegeLogin]);
+    test.done();
+};
+
+// Verifies RTM2 permission token generation, parsing, and signature validation.
+exports.buildTokenWithPermissions = function (test) {
+    const permissions = new Rtm2Permissions();
+    permissions.add(Rtm2Permissions.kMessageChannels, Rtm2Permissions.kRead, ["message-a", "message-b"]);
+    permissions.add(Rtm2Permissions.kStreamChannels, Rtm2Permissions.kWrite, ["stream-a"]);
+
+    const token = RtmTokenBuilder.buildTokenWithPermissions(appId, appCertificate, userId, permissions, expire);
+    const parsed = new AccessToken2("", "", 0, 0);
+
+    test.equal(true, parsed.from_string(token));
+    test.equal(true, parsed.verifySignature(appCertificate));
+    const service = parsed.getServices(kRtm2ServiceType)[0];
+    test.equal(userId, service.__user_id.toString());
+    test.deepEqual(permissions.details, service.__permissions.details);
+    test.equal(expire, service.__privileges[ServiceRtm2.kPrivilegeLogin]);
+    test.done();
+};
+
+// Verifies that an RTM2 numeric user ID is encoded as its string representation.
+exports.buildTokenWithPermissionsAndNumericUserId = function (test) {
+    const numericUserId = 123;
+    const permissions = new Rtm2Permissions();
+    const token = RtmTokenBuilder.buildTokenWithPermissions(appId, appCertificate, numericUserId, permissions, expire);
+    const parsed = new AccessToken2("", "", 0, 0);
+
+    test.equal(true, parsed.from_string(token));
+    test.equal(true, parsed.verifySignature(appCertificate));
+    const service = parsed.getServices(kRtm2ServiceType)[0];
+    test.equal(String(numericUserId), service.__user_id.toString());
+    test.equal(expire, service.__privileges[ServiceRtm2.kPrivilegeLogin]);
+    test.done();
+};
+
+// Verifies that the numeric wildcard user ID is encoded as an empty string.
+exports.buildTokenWithPermissionsAndWildcardUserId = function (test) {
+    const permissions = new Rtm2Permissions();
+    const token = RtmTokenBuilder.buildTokenWithPermissions(appId, appCertificate, 0, permissions, expire);
+    const parsed = new AccessToken2("", "", 0, 0);
+
+    test.equal(true, parsed.from_string(token));
+    test.equal(true, parsed.verifySignature(appCertificate));
+    const service = parsed.getServices(kRtm2ServiceType)[0];
+    test.equal("", service.__user_id.toString());
+    test.equal(expire, service.__privileges[ServiceRtm2.kPrivilegeLogin]);
     test.done();
 };

package/test/RtmTokenBuilderTest.js

@@ -13,6 +13,7 @@ const appCertificate = "5CFd2fd1755d40ecb72977518be15d3b";
 const account = "test_user";
 const expireTimestamp = 1446455471;
 
+// Verifies legacy RTM token generation and parsing.
 exports.RtmToken_Test = function (test) {
     const token = RtmTokenBuilder.buildToken(appID, appCertificate, account, Role.Rtm_User, expireTimestamp);
     let accessToken = new AccessToken("", "", 0, 0);

package/test/SttTokenBuilderTest.js

@@ -0,0 +1,58 @@
+/**
+ * run this test with command:
+ * nodeunit test/SttTokenBuilderTest.js
+ */
+const { SttTokenBuilder } = require('../src/SttTokenBuilder')
+const { AccessToken2, kRtcServiceType, kRtmServiceType, kSttServiceType, ServiceRtc, ServiceRtm } = require('../src/AccessToken2')
+const { Role } = require('../src/RtcTokenBuilder2')
+
+const appId = '970CA35de60c44645bbae8a215061b33'
+const appCertificate = '5CFd2fd1755d40ecb72977518be15d3b'
+const channelName = '7d72365eb983485397e3e3f9d460bdda'
+const rtcAccount = '2882341273'
+const rtmUserId = '2882341273'
+const rtcTokenExpire = 600
+const joinChannelPrivilegeExpire = 600
+const pubAudioPrivilegeExpire = 600
+const pubVideoPrivilegeExpire = 600
+const pubDataStreamPrivilegeExpire = 600
+const rtmTokenExpire = 600
+
+exports.buildToken_PUBLISHER_Test = function (test) {
+    const token = SttTokenBuilder.buildToken(
+        appId, appCertificate, channelName, rtcAccount, Role.PUBLISHER, rtcTokenExpire,
+        joinChannelPrivilegeExpire, pubAudioPrivilegeExpire, pubVideoPrivilegeExpire,
+        pubDataStreamPrivilegeExpire, rtmUserId, rtmTokenExpire)
+    const parsed = new AccessToken2('', '', 0, 0)
+    parsed.from_string(token)
+
+    const rtc = parsed.getServices(kRtcServiceType)[0]
+    const rtm = parsed.getServices(kRtmServiceType)[0]
+    const stt = parsed.getServices(kSttServiceType)[0]
+
+    test.equal(appId, parsed.appId)
+    test.equal(rtcTokenExpire, parsed.expire)
+    test.equal(channelName, rtc.__channel_name)
+    test.equal(rtcAccount, rtc.__uid)
+    test.equal(joinChannelPrivilegeExpire, rtc.__privileges[ServiceRtc.kPrivilegeJoinChannel])
+    test.equal(pubAudioPrivilegeExpire, rtc.__privileges[ServiceRtc.kPrivilegePublishAudioStream])
+    test.equal(pubVideoPrivilegeExpire, rtc.__privileges[ServiceRtc.kPrivilegePublishVideoStream])
+    test.equal(pubDataStreamPrivilegeExpire, rtc.__privileges[ServiceRtc.kPrivilegePublishDataStream])
+    test.equal(rtmUserId, rtm.__user_id)
+    test.equal(rtmTokenExpire, rtm.__privileges[ServiceRtm.kPrivilegeLogin])
+    test.deepEqual({}, stt.__privileges)
+    test.done()
+}
+
+exports.buildToken_SUBSCRIBER_Test = function (test) {
+    const token = SttTokenBuilder.buildToken(
+        appId, appCertificate, channelName, rtcAccount, Role.SUBSCRIBER, rtcTokenExpire,
+        joinChannelPrivilegeExpire, pubAudioPrivilegeExpire, pubVideoPrivilegeExpire,
+        pubDataStreamPrivilegeExpire, rtmUserId, rtmTokenExpire)
+    const parsed = new AccessToken2('', '', 0, 0)
+    parsed.from_string(token)
+
+    const rtc = parsed.getServices(kRtcServiceType)[0]
+    test.deepEqual({ [ServiceRtc.kPrivilegeJoinChannel]: joinChannelPrivilegeExpire }, rtc.__privileges)
+    test.done()
+}

package/sample.js

@@ -1,46 +0,0 @@
-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.buildTokenWithUserAccount(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()