SecretId and SecretKey.An HTTP signature request initiated to CLS through an API is transmitted by using the standard HTTP Authorization header as shown in the following example:
GET /logset?logset_id=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx HTTP/1.1
Host: ap-shanghai.cls.tencentyun.com
Authorization: q-sign-algorithm=sha1&q-ak=AKIDc9YlmrBcFk4C8sbmXQ8i65XXXXXXXXXX&q-sign-time=1510109254;1510109314&q-key-time=1510109254;1510109314&q-header-list=content-type;host&q-url-param-list=logset_name&q-signature=e8b23b818caf4e33f196f895218bdabdbd1f1423CLS request domain names divide into private domain names and public domain names:
${region}.cls.tencentyun.com, which is only valid for access requests from the same region, that is, CVM or Tencent Cloud services access the CLS service in the same region through the private domain name.${region}.cls.tencentcs.com. After the access source is connected to the internet, the public domain name of CLS can be accessed under normal circumstances.The region field is the abbreviation of a CLS service region, such as ap-beijing for the Beijing region. For the complete region list, please see Region List.
ap-beijing - Beijing
ap-shanghai - Shanghai
ap-guangzhou - Guangzhou
ap-chengdu - Chengdu
...The signing information in a request is composed of multiple key=value pairs concatenated by & in the following format:
q-sign-algorithm=[Algorithm]&q-ak=[SecretId]&q-sign-time=[SignTime]&q-key-time=[KeyTime]&q-header-list=[SignedHeaderList]&q-url-param-list=[SignedParamList]&q-signature=[Signature]The key-value (Key=Value) pairs constituting the signing information above are described as follows:
| Key | Value | Description |
|---|---|---|
| q-sign-algorithm | sha1 | Signature algorithm, which is required and currently supports only `sha1` |
| q-ak | Parameter [SecretId] | `SecretId` of account API key, which is required |
| q-sign-time | Parameter [SignTime] | Start time and end time of signature validity period in seconds in the format of Unix timestamp and separated with ;, such as 1510109254;1510109314 |
| q-key-time | Parameter [KeyTime] | Same as the `q-sign-time` value, which is required |
| q-header-list | Parameter [SignedHeaderList] | Key of the HTTP request header that needs to be signed, which is required. A key needs to be converted to lowercase, and multiple keys should be sorted in lexicographical order; for example, if there are multiple keys, separate them with ;. If you don't want to sign any header, you can enter an empty string |
| q-url-param-list | Parameter [SignedParamList] | Parameter of the HTTP request URI that needs to be signed, which is required. A key needs to be converted to lowercase, and multiple keys should be sorted in lexicographical order; for example, if there are multiple keys, separate them with ;. If you don't want to sign any parameter, you can enter an empty string |
| q-signature | Parameter [Signature] | Calculated signing information in lowercase, which is required |
For
q-sign-timeandq-key-time, the end time should be after the start time; otherwise, the signature will expire immediately.
Signature calculation steps:
HttpRequestInfo according to the specified format.sha1 algorithm to calculate the hash value of HttpRequestInfo, and concatenate other specified parameters into the original string of the signature StringToSign according to the specified format.SecretKey to encrypt q-key-time to get SignKey.SignKey to encrypt StringToSign to generate Signature.URL-encoded special symbols should be in uppercase; for example,
/should be encoded as%2Finstead of%2f,
HttpRequestInfo consists of Method, Uri, Headers, and Parameters in the HTTP request. It is concatenated in the following way:
HttpRequestInfo = Method + "\n"
+ Uri + "\n"
+ FormatedParameters + "\n"
+ FormatedHeaders + "\n"The \n above indicates a line break escape character, + indicates a string concatenation operation, and other parameters are defined as follows:
| Field Name | Description |
|---|---|
| Method | HTTP request method in lowercase, such as get and post |
| Uri | Resource name of HTTP request excluding the query string part, such as /logset |
| FormatedParameters | String generated by serializing parameters in the HTTP request query string, i.e., the parameters specified in q-url-param-list. If there is no need to specify this parameter, use an empty string. Key and value are concatenated with =, and different key-value pairs are concatenate with &, which need to be sorted in lexicographic order. Key is in lowercase, and value needs to be URL-encoded |
| FormatedHeaders | HTTP request headers, i.e., HTTP headers specified in q-header-list. If there is no need to specify this parameter, use an empty string. Key and value are concatenated with =, and different key-value pairs are concatenate with &, which need to be sorted in lexicographic order. Key is in lowercase, and value needs to be URL-encoded |
To get logset information, the HTTP request is as follows:
GET /logset?logset_id=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx HTTP/1.1
Host: ap-shanghai.cls.tencentyun.comThe corresponding HttpRequestInfo is as follows:
With request parameter:
get\n/logset\nlogset_id=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\nhost=ap-shanghai.cls.tencentyun.com\nWithout request parameter:
get\n/logset\n\nhost=ap-shanghai.cls.tencentyun.com\nEven without parameters,
\ncannot be omitted, so\n\nis generated.
StringToSign is composed of q-sign-algorithm, q-sign-time, and sha1 hash value of HttpRequestInfo. It is concatenated in the following way:
StringToSign = q-sign-algorithm + "\n"
+ q-sign-time + "\n"
+ sha1(HttpRequestInfo) + "\n"The \n above indicates a line break escape character, + indicates a string concatenation operation, and other parameters have been described above, where the sha1 hash value of HttpRequestInfo is a hexadecimal lowercase string.
You need to escape
\nto a line break first and then performsha1calculation onHttpRequestInfo.
The corresponding result is as follows:
StringToSign = sha1\n1578973108;1578974918\n7be58ef9a64ecca66f96b79dc70d279bd93915cf\nCurrently, the API only supports one digital signature algorithm, i.e., the default signature algorithm hmac-sha1. The pseudo code is as follows:
SignKey = Hexdigest(HMAC-SHA1(q-key-time, SecretKey))Here, HMAC-SHA1 is the encryption algorithm, and Hexdigest is the method for conversion to hexadecimal string. The output result of the encryption algorithm in some languages is directly a hexadecimal string, so no conversion is required.
The corresponding result is as follows:
SignKey = Hexdigest(HMAC-SHA1(1578973108;1578974918, LUSE4nPK1d4tX5SHyXv6tZXXXXXXXXXX))