tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Chat
    Documentation
    Download PDF

    Generating UserSig

    Last updated: 2024-02-07 17:33:32
    Download PDF
      UserSig is a password used to log in to IM. It is the ciphertext obtained after data such as UserID is encrypted. This document describes how to generate a UserSig.

      Obtaining a Key

      1. Log in to the IM console.
      Note:
      If you do not have any app, create an app and then perform step 2.
      2. Click the target app card to go to its basic configuration page.
      3. In the Basic Information section, click Display key to the right of Key.
      4. Click Copy to copy and save the key information.
      Caution:
      Store the key information properly to prevent disclosure.

      Calculating UserSig on the Client

      The GenerateTestUserSig open-source module provided in the sample code of the IM SDK can help you quickly generate a UserSig. You only need to configure three member variables, including SDKAPPID (SDKAppID of the app), EXPIRETIME (UserSig expiration time), and SECRETKEY (key information), and then call the genTestUserSig() function to quickly obtain a UserSig. To simplify this process, we provide the source code for computing a UserSig for the following languages and platforms. You can directly download and integrate the source code into your client.
      Programing Language
      Platform
      GenerateTestUserSig Source Code
      Java
      Android
      Objective-C
      iOS
      Objective-C
      Mac
      C++
      Windows
      Javascript
      Web
      Dart
      Flutter
      Caution:
      In this method, the SECRETKEY is vulnerable to decompilation and reverse engineering. Once your SECRETKEY is disclosed, attackers can steal your Tencent Cloud traffic. Therefore, this method is only suitable for locally running a demo project and feature debugging. The correct way to issue a UserSig is to integrate the UserSig computing code into your server and provide app-oriented APIs. When UserSig is needed, your app will send a request to the business server to obtain a dynamic UserSig. For more information, see How to Calculate UserSig.
      

      Calculating UserSig on the Server

      Generating a UserSig on the server provides maximum protection against the disclosure of the key used for calculating the UserSig. You only need to deploy the code for calculating the UserSig on your server and provide an app-oriented API. When a UserSig is needed, your app will send a request to the business server to obtain a dynamic UserSig. To simplify this process, we provide the source code for calculating a UserSig for the following languages and platforms. You can directly download and integrate the source code into your server.
      Programming Language
      Key Function
      Download URL
      Java
      HMAC-SHA256
      GO
      HMAC-SHA256
      PHP
      HMAC-SHA256
      Nodejs
      HMAC-SHA256
      Python
      HMAC-SHA256
      C#
      HMAC-SHA256
      C++
      HMAC-SHA256
      Key fields in a UserSig calculation function include the SDKAppID, UserID, and UserSig validity period, as described in the following table.
      Note:
      The following table uses the field names in the Java source code as an example. The field names may be different in other languages.
      Field Name (Example)
      Description
      sdkappid
      SDKAppID of the app. You can obtain the SDKAppID on the app card in the IM console.
      userId
      User ID (former name: Identifier).
      expire
      UserSig validity period, in seconds.
      userbuf
      This field is set to null by default because APIs without UserBuf are used in IM by default.<br>APIs with UserBuf may be required in some TRTC use cases, for example, when entering a room. For more information, see Enabling Advanced Permission Control.
      key
      Key. You can obtain a key on the app details page in the IM console. For more information, see Obtaining a Key.
      

      Old Version of Algorithm

      To simplify signature computing so that customers can conveniently and quickly use Tencent Cloud services, the signature algorithm of the IM service has been upgraded from ECDSA-SHA256 to HMAC-SHA256 since July 19, 2019. This means that all SDKAppIDs created after July 19, 2019 will use the new HMAC-SHA256 algorithm.
      If your SDKAppID was created before July 19, 2019, we recommend that you upgrade the signature algorithm to HMAC-SHA256. The upgrade will not affect your business. Alternatively, you can still use the signature algorithm of an earlier version. The URLs for downloading the source code for the ECDSA-SHA256 algorithm are as follows:
      Programming Language
      Signature Algorithm
      Download Link
      Java
      ECDSA-SHA256
      GO
      ECDSA-SHA256
      PHP
      ECDSA-SHA256
      Nodejs
      ECDSA-SHA256
      Python
      ECDSA-SHA256
      C#
      ECDSA-SHA256
      C++
      ECDSA-SHA256
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy