文档中心 > 签名机制
签名机制

最近更新时间:2022-01-18

XXX 服务会对每个访问的请求进行身份验证,无论使用 HTTP 还是 HTTPS 协议提交请求,都需要在请求中包含签名信息。XXX 通过使用 access key ID 和 access key secret 进行对称加密的方法来验证请求的发送者身份。

说明: XXX 服务会对每个访问的请求进行身份验证,无论使用 HTTP 还是 HTTPS 协议提交请求,都需要在请求中包含签名信息。STS 通过使用 access key ID 和 access key secret 进行对称加密的方法来验证请求的发送者身份。

签名步骤

  1. 使用请求参数构造规范化的请求字符串。

    • 排序参数。

      排序规则以首字母顺序排序,排序参数包括 公共参数和接口自定义参数。不包括公共请求参数中的Signature参数。

      说明: 当使用 GET 方法提交请求时,这些参数就是请求 URL 中的参数部分,即 URL 中?之后由&连接的部分。

    • 编码参数。

      使用 UTF-8 字符集对每个请求参数的名称和参数取值进行 URL 编码,URL 编码规则如下:

      • 对于字符 A-Z、a-z、0-9 以及字符-、_、.、~不编码;

      • 对于其他字符编码成%XY的格式,其中XY是字符对应 ASCII 码的 16 进制。例如:半角双引号(")对应的编码为:%22。

      • 空格( )需要被编码成:%20,而不是+。

        说明: 一般支持 URL 编码的库都按照application/x-www-form-urlencoded的 MIME 格式的规则进行编码,例如:Java 中的

        java.net.URLEncoder。您可以直接使用这类方式进行编码,然后将编码后的字符串中加号+替换成%20、*替换成%2A、%7E替换~,

        即可得到上述规则描述的编码字符串。

    • 使用=连接编码后的参数名称和参数取值。

    • 使用&连接编码后的参数,得到规范化请求字符串。

      说明:参数排序需与排序参数保持一致。

  2. 使用规范化请求字符串构造用于计算签名的字符串,规则如下:

    StringToSign=
    HTTPMethod + “&” + //发送请求的 HTTP 方法,例如 GET。
    percentEncode(“/”) + ”&” + //字符(/)UTF-8 编码得到的值,即 %2F。
    percentEncode(CanonicalizedQueryString)//规范化请求字符串

  3. 按照 RFC2104 的定义,计算签名 HMAC 值。

    说明:计算签名时使用的key就是用户持有的access key secret加上一个&字符,其ASCII值为:38,使用的哈希算法是:SHA1。

  4. 按照Base64编码规则将 HMAC 值编码成字符串,得到签名值。

  5. 将签名值作为Signature添加到请求参数中。

    说明: 将签名值添加到请求参数时,需要按照 RFC3986 的规则进行 URL 编码。

示例

以 CreateUser 为例,签名前的请求 URL 为:

https://api.unicloud.com/ram?UserName=test&SignatureVersion=1.0&Format=JSON&Timestamp=2015-08-18T03%3A15%3A45Z&AccessKeyId=testid&SignatureMethod=HMAC-SHA1&Version=2015-05-01&Action=CreateUser&SignatureNonce=6a6e0ca6-4557-11e5-86a2-b8e8563dc8d2

对应的StringToSign是:

GET&%2F&AccessKeyId%3Dtestid%26Action%3DCreateUser%26Format%3DJSON%26SignatureMethod%3DHMAC-SHA1%26SignatureNonce%3D6a6e0ca6-4557-11e5-86a2-b8e8563dc8d2%26SignatureVersion%3D1.0%26Timestamp%3D2015-08-18T03%253A15%253A45Z%26UserName%3Dtest%26Version%3D2015-05-01

例如:access key ID 为:testid,access key secret 为:testsecret,用于计算 HMAC 的 key 就是:testsecret&,则计算得到的签名值是:

kRA2cnpJVacIhDMzXnoNZG9tDCI%3D

签名后的请求URL为:

https://api.unicloud.com/ram?UserName=test&SignatureVersion=1.0&Format=JSON&Timestamp=2015-08-18T03%3A15%3A45Z&AccessKeyId=testid&SignatureMethod=HMAC-SHA1&Version=2015-05-01&Signature=kRA2cnpJVacIhDMzXnoNZG9tDCI%3D&Action=CreateUser&SignatureNonce=6a6e0ca6-4557-11e5-86a2-b8e8563dc8d2