增加使用字符串房间号生成privateMapKey

yutingzeng · yutingzeng · commit b1617c9473fb · 2020-09-08T16:39:01.000+08:00
diff --git a/src/TLSSigAPIv2.php b/src/TLSSigAPIv2.php
@@ -51,7 +51,37 @@ public function genUserSig( $userid, $expire = 86400*180 ) {
     */
 
     public function genPrivateMapKey( $userid, $expire, $roomid, $privilegeMap ) {
-        $userbuf = $this->__genUserBuf( $userid, $roomid, $expire, $privilegeMap, 0 );
+        $userbuf = $this->__genUserBuf( $userid, $roomid, $expire, $privilegeMap, 0, '' );
+        echo $userbuf . '\n';
+        return $this->__genSig( $userid, $expire, $userbuf, true );
+    }
+    /**
+    *【功能说明】
+    * 用于签发 TRTC 进房参数中可选的 PrivateMapKey 权限票据。
+    * PrivateMapKey 需要跟 UserSig 一起使用，但 PrivateMapKey 比 UserSig 有更强的权限控制能力：
+    *  - UserSig 只能控制某个 UserID 有无使用 TRTC 服务的权限，只要 UserSig 正确，其对应的 UserID 可以进出任意房间。
+    *  - PrivateMapKey 则是将 UserID 的权限控制的更加严格，包括能不能进入某个房间，能不能在该房间里上行音视频等等。
+    * 如果要开启 PrivateMapKey 严格权限位校验，需要在【实时音视频控制台】=>【应用管理】=>【应用信息】中打开“启动权限密钥”开关。
+    *
+    *【参数说明】
+    * @param userid - 用户id，限制长度为32字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线和连词符。
+    * @param expire - PrivateMapKey 票据的过期时间，单位是秒，比如 86400 生成的 PrivateMapKey 票据在一天后就无法再使用了。
+    * @param roomstr - 房间号，用于指定该 userid 可以进入的房间号
+    * @param 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 拥有加入房间和接收音视频数据的权限，但不具备其他权限。
+    */
+
+    public function genPrivateMapKeyWithStringRoomID( $userid, $expire, $roomstr, $privilegeMap ) {
+        $userbuf = $this->__genUserBuf( $userid, 0, $expire, $privilegeMap, 0, $roomstr );
         echo $userbuf . '\n';
         return $this->__genSig( $userid, $expire, $userbuf, true );
     }
@@ -104,12 +134,18 @@ private function base64_url_decode( $base64 ) {
     * @param dwExpTime 过期时间：该权限加密串的过期时间. 过期时间 = now+dwExpTime
     * @param dwPrivilegeMap 用户权限，255表示所有权限
     * @param dwAccountType 用户类型, 默认为0
+    * @param roomStr 字符串房间号
     * @return userbuf string  返回的userbuf
     */
 
-    private function __genUserBuf( $account, $dwAuthID, $dwExpTime, $dwPrivilegeMap, $dwAccountType ) {
-        $userbuf = pack( 'C1', '0' );
+    private function __genUserBuf( $account, $dwAuthID, $dwExpTime, $dwPrivilegeMap, $dwAccountType,$roomStr ) {
+     
         //cVer  unsigned char/1 版本号，填0
+        if($roomStr == '')
+            $userbuf = pack( 'C1', '0' );
+        else
+            $userbuf = pack( 'C1', '1' );
+        
         $userbuf .= pack( 'n', strlen( $account ) );
         //wAccountLen   unsigned short /2   第三方自己的帐号长度
         $userbuf .= pack( 'a'.strlen( $account ), $account );
@@ -125,6 +161,13 @@ private function __genUserBuf( $account, $dwAuthID, $dwExpTime, $dwPrivilegeMap,
         //dwPrivilegeMap unsigned int/4  权限位
         $userbuf .= pack( 'N', $dwAccountType );
         //dwAccountType  unsigned int/4
+        if($roomStr != '')
+        {
+            $userbuf .= pack( 'n', strlen( $roomStr ) );
+            //roomStrLen   unsigned short /2   字符串房间号长度
+            $userbuf .= pack( 'a'.strlen( $roomStr ), $roomStr );
+            //roomStr   roomStrLen 字符串房间号
+        }
         return $userbuf;
     }
     /**
diff --git a/test/test.php b/test/test.php
@@ -23,6 +23,8 @@
 }
 $sig = $api->genPrivateMapKey( 'xiaojun', 86400*180, 10000, 255 );
 echo $sig . '\n';
+$sig = $api->genPrivateMapKeyWithStringRoomID( 'xiaojun', 86400*180, "aaa", 255 );
+echo $sig . '\n';
 $init_time = 0;
 $expire = 0;
 $err_msg = '';

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,8 @@`
`23`	`23`	`}`
`24`	`24`	`$sig = $api->genPrivateMapKey( 'xiaojun', 86400*180, 10000, 255 );`
`25`	`25`	`echo $sig . '\n';`
	`26`	`+$sig = $api->genPrivateMapKeyWithStringRoomID( 'xiaojun', 86400*180, "aaa", 255 );`
	`27`	`+echo $sig . '\n';`
`26`	`28`	`$init_time = 0;`
`27`	`29`	`$expire = 0;`
`28`	`30`	`$err_msg = '';`