com.tencentcloudapi.common

Class Sign

java.lang.Object

com.tencentcloudapi.common.Sign

public class Sign
extends Object

Constructor Summary

Constructors

Constructor and Description
Sign()

Method Summary

Modifier and Type	Method and Description
protected static String	buildParamStr(TreeMap<String,String> requestParams, String requestMethod) Builds the parameter string for signing, formatting the parameters in a query string format.
static byte[]	hmac256(byte[] key, String msg) Calculates the HMAC-SHA-256 signature of the given message using the specified key.
static String	makeSignPlainText(TreeMap<String,String> requestParams, String reqMethod, String host, String path) Constructs the plain text string for signing.
static String	sha256Hex(byte[] b) Calculates the SHA-256 hash of the given byte array and returns it as a hexadecimal string.
static String	sha256Hex(String s) Calculates the SHA-256 hash of the given string and returns it as a hexadecimal string.
static String	sign(String secretKey, String sigStr, String sigMethod) Signs the given string using the specified method and secret key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Sign

public Sign()

Method Detail

sign

public static String sign(String secretKey,
                          String sigStr,
                          String sigMethod)
                   throws TencentCloudSDKException

Signs the given string using the specified method and secret key.

Parameters:

secretKey - The secret key used to generate the signature.

sigStr - The string to sign.

sigMethod - The signing method (e.g., "HmacSHA256").

Returns:

The generated signature in Base64 encoding.

Throws:

TencentCloudSDKException - If there is an error during signing.

makeSignPlainText

public static String makeSignPlainText(TreeMap<String,String> requestParams,
                                       String reqMethod,
                                       String host,
                                       String path)

Constructs the plain text string for signing.

Parameters:

requestParams - The request parameters to include in the string.

reqMethod - The HTTP request method (GET, POST, etc.).

host - The host (API endpoint).

path - The request path.

Returns:

The plain text string used for signing.

buildParamStr

protected static String buildParamStr(TreeMap<String,String> requestParams,
                                      String requestMethod)

Builds the parameter string for signing, formatting the parameters in a query string format.

Parameters:

requestParams - The request parameters to include in the string.

requestMethod - The HTTP request method (GET, POST, etc.).

Returns:

The formatted parameter string.

sha256Hex

public static String sha256Hex(String s)
                        throws TencentCloudSDKException

Calculates the SHA-256 hash of the given string and returns it as a hexadecimal string.

Parameters:

s - The string to hash.

Returns:

The SHA-256 hash as a hexadecimal string.

Throws:

TencentCloudSDKException - If SHA-256 is not supported.

sha256Hex

public static String sha256Hex(byte[] b)
                        throws TencentCloudSDKException

Calculates the SHA-256 hash of the given byte array and returns it as a hexadecimal string.

Parameters:

b - The byte array to hash.

Returns:

The SHA-256 hash as a hexadecimal string.

Throws:

TencentCloudSDKException - If SHA-256 is not supported.

hmac256

public static byte[] hmac256(byte[] key,
                             String msg)
                      throws TencentCloudSDKException

Calculates the HMAC-SHA-256 signature of the given message using the specified key.

Parameters:

key - The key to use for HMAC.

msg - The message to sign.

Returns:

The HMAC-SHA-256 signature as a byte array.

Throws:

TencentCloudSDKException - If HMAC-SHA-256 is not supported.