修改函数名和注释

yutingzeng · yutingzeng · commit 51091b49c396 · 2020-08-04T11:01:37.000+08:00
diff --git a/TLSSigAPITest.js b/TLSSigAPITest.js
@@ -1,7 +1,7 @@
 var TLSSigAPIv2 = require('./TLSSigAPIv2');
 
 var api = new TLSSigAPIv2.Api(1400000000, "5bd2850fff3ecb11d7c805251c51ee463a25727bddc2385f3fa8bfee1bb93b5e");
-var sig = api.genSig("xiaojun", 86400*180);
+var sig = api.genUserSig("xiaojun", 86400*180);
 console.log("sig " + sig);
-var sig = api.genSigWithUserbuf("xiaojun", 86400*180, 10000,255);
+var sig = api.genPrivateMapKey("xiaojun", 86400*180, 10000,255);
 console.log("sig with userbuf " + sig);
diff --git a/TLSSigAPIv2.js b/TLSSigAPIv2.js
@@ -55,7 +55,7 @@ Api.prototype._genUserbuf = function (account, dwAuthID, dwExpTime,
 
     let accountLength = account.length;
     let offset = 0;
-    let userBuf = new Buffer(1+2+accountLength+4+4+4+4+4);
+    let userBuf = new Buffer.alloc(1+2+accountLength+4+4+4+4+4);
 
     //cVer
     userBuf[offset++] = 0;
@@ -123,35 +123,53 @@ Api.prototype._hmacsha256 = function(identifier, currTime, expire, base64UserBuf
 };
 
 /**
- * 生成 usersig
- * @param string $identifier 用户名
- * @return string 生成的失败时为false
+ *【功能说明】用于签发 TRTC 和 IM 服务中必须要使用的 UserSig 鉴权票据
+ *
+ *【参数说明】
+ * userid - 用户id，限制长度为32字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线和连词符。
+ * expire - UserSig 票据的过期时间，单位是秒，比如 86400 代表生成的 UserSig 票据在一天后就无法再使用了。
  */
-/**
- * 生成 usersig
- * @param identifier 用户账号
- * @param expire 有效期，单位秒
- * @returns {string} 返回的 sig 值
- */
-Api.prototype.genSig = function(identifier, expire){
-    return this.genSigWithUserbuf(identifier, expire, null);
+Api.prototype.genUserSig = function(userid, expire){
+    return this.genPrivateMapKey(userid, expire, null,null);
 };
 
+
+
 /**
- * 生成带 userbuf 的 usersig
- * @param identifier  用户账号
- * @param expire 有效期，单位秒
- * @param userBuf 用户数据
- * @returns {string} 返回的 sig 值
+ *【功能说明】
+ * 用于签发 TRTC 进房参数中可选的 PrivateMapKey 权限票据。
+ * PrivateMapKey 需要跟 UserSig 一起使用，但 PrivateMapKey 比 UserSig 有更强的权限控制能力：
+ *  - UserSig 只能控制某个 UserID 有无使用 TRTC 服务的权限，只要 UserSig 正确，其对应的 UserID 可以进出任意房间。
+ *  - PrivateMapKey 则是将 UserID 的权限控制的更加严格，包括能不能进入某个房间，能不能在该房间里上行音视频等等。
+ * 如果要开启 PrivateMapKey 严格权限位校验，需要在【实时音视频控制台】=>【应用管理】=>【应用信息】中打开“启动权限密钥”开关。
+ *
+ *【参数说明】
+ * userid - 用户id，限制长度为32字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线和连词符。
+ * expire - PrivateMapKey 票据的过期时间，单位是秒，比如 86400 生成的 PrivateMapKey 票据在一天后就无法再使用了。
+ * roomid - 房间号，用于指定该 userid 可以进入的房间号
+ * privilegeMap - 权限位，使用了一个字节中的 8 个比特位，分别代表八个具体的功能权限开关：
+ *  - 第 1 位：0000 0001 = 1，创建房间的权限
+ *  - 第 2 位：0000 0010 = 2，加入房间的权限
+ *  - 第 3 位：0000 0100 = 4，发送语音的权限
+ *  - 第 4 位：0000 1000 = 8，接收语音的权限
+ *  - 第 5 位：0001 0000 = 16，发送视频的权限  
+ *  - 第 6 位：0010 0000 = 32，接收视频的权限  
+ *  - 第 7 位：0100 0000 = 64，发送辅路（也就是屏幕分享）视频的权限
+ *  - 第 8 位：1000 0000 = 200，接收辅路（也就是屏幕分享）视频的权限  
+ *  - privilegeMap == 1111 1111 == 255 代表该 userid 在该 roomid 房间内的所有功能权限。
+ *  - privilegeMap == 0010 1010 == 42  代表该 userid 拥有加入房间和接收音视频数据的权限，但不具备其他权限。
  */
-Api.prototype.genSigWithUserbuf = function(identifier, expire, roomnum,privilege,){
+Api.prototype.genPrivateMapKey = function(userid, expire, roomid,privilegeMap){
 
-    var userBuf = this._genUserbuf(identifier,roomnum,expire,privilege,0);
+    if(null == roomid || null == privilegeMap )
+        var userBuf = null ;
+    else
+        var userBuf = this._genUserbuf(userid,roomid,expire,privilegeMap,0);
     var currTime = Math.floor(Date.now()/1000);
 
     var sigDoc = {
         'TLS.ver': "2.0",
-        'TLS.identifier': ""+identifier,
+        'TLS.identifier': ""+userid,
         'TLS.sdkappid': Number(this.sdkappid),
         'TLS.time': Number(currTime),
         'TLS.expire': Number(expire)
@@ -161,9 +179,9 @@ Api.prototype.genSigWithUserbuf = function(identifier, expire, roomnum,privilege
     if (null != userBuf) {
         var base64UserBuf = base64encode(userBuf);
         sigDoc['TLS.userbuf'] = base64UserBuf;
-        sig = this._hmacsha256(identifier, currTime, expire, base64UserBuf);
+        sig = this._hmacsha256(userid, currTime, expire, base64UserBuf);
     } else {
-        sig = this._hmacsha256(identifier, currTime, expire, null);
+        sig = this._hmacsha256(userid, currTime, expire, null);
     }
     sigDoc['TLS.sig'] = sig;
 
