全部產品
Search

搜尋本產品

    ActionTrail：簽名機制

    文件中心

    ActionTrail：簽名機制

    更新時間：Jul 01, 2024

    為保證API的安全調用，在調用API時阿里雲會對每個API請求通過簽名（Signature）進行身分識別驗證。無論使用HTTP還是HTTPS協議提交請求，都需要在請求中包含簽名資訊。

    概述

    RPC API要按以下格式在API請求的Query中增加簽名（Signature）。

    https://Endpoint/?SignatureVersion=1.0&SignatureMethod=HMAC-SHA1&Signature=CT9X0VtwR86fNWSnsc6v8YGOjuE%3D&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf
    其中：
    • SignatureMethod：簽名方式，目前支援HMAC-SHA1。
    • SignatureVersion：簽名演算法版本，目前版本是1.0。
    • SignatureNonce：唯一隨機數，用於防止網路重放攻擊。使用者在不同請求間要使用不同的隨機數值，建議使用通用唯一識別碼UUID（Universally Unique Identifier）。
    • Signature：使用AccessKey Secret對請求進行對稱式加密後產生的簽名。
    簽名演算法遵循RFC 2104 HMAC-SHA1規範，使用AccessKey Secret對編碼、排序後的整個請求串計算HMAC值作為簽名。簽名的元素是請求自身的一些參數，由於每個API請求內容不同，所以簽名的結果也不盡相同。可參考本文的操作步驟，計算簽名值。 
    Signature = Base64( HMAC-SHA1( AccessKey Secret, UTF-8-Encoding-Of(StringToSign)) )

    步驟一：構造待簽名字串

    1. 使用請求參數構造正常化的請求字串（Canonicalized Query String）。
      1. 按照參數名稱的字典順序對請求中所有的請求參數（包括公用請求參數和介面的自訂參數，但不包括公用請求參數中的Signature參數）進行排序。
        說明 當使用GET方法提交請求時，這些參數就是請求URI中的參數部分，即URI中“?”之後由“&”串連的部分。
      2. 對排序之後的請求參數的名稱和值分別用UTF-8字元集進行URL編碼。編碼規則請參考下表。
        字元編碼方式
        A~Z、a~z和0~9以及“-”、“_”、“.”和“~”不編碼。
        其它字元編碼成 %XY 的格式，其中 XY 是字元對應ASCII碼的16進位表示。例如英文的雙引號（"）對應的編碼為 %22。
        擴充的UTF-8字元編碼成 %XY%ZA…的格式。
        英文空格編碼成 %20，而不是加號（+）。
        該編碼方式和一般採用的application/x-www-form-urlencodedMIME格式編碼演算法（例如Java標準庫中的java.net.URLEncoder的實現）存在區別。編碼時可以先用標準庫的方式進行編碼，然後把編碼後的字串中的加號（+）替換成%20，星號（*）替換成%2A，%7E替換回波浪號（~），即可得到上述規則描述的編碼字串。本演算法可以用下面的percentEncode方法來實現： 
        private static final String ENCODING = "UTF-8";
private static String percentEncode(String value) throws UnsupportedEncodingException 
{
return value != null ? URLEncoder.encode(value, ENCODING).replace("+", "%20").replace("*", "%2A").replace("%7E", "~") : null;
}
      3. 將編碼後的參數名稱和值用英文等號（=）進行串連。
      4. 將等號串連得到的參數組合按順序依次使用“&”符號串連，即得到正常化請求字串。
    2. 將構造的正常化字串按照下面的規則構造成待簽名的字串。 
      StringToSign=
      HTTPMethod + "&" +
      percentEncode("/") + "&" +
      percentEncode(CanonicalizedQueryString)

      其中：

      • HTTPMethod 是提交請求用的HTTP方法，例如GET。
      • percentEncode("/") 是按照URL編碼規則對字元“/”進行編碼得到的值，即%2F。
      • percentEncode(CanonicalizedQueryString) 是對構造的正常化請求字串按URL編碼規則編碼後得到的字串。

    步驟二：計算簽名值

    1. 按照RFC2104的定義，計算待簽名字串（StringToSign）的HMAC值。
      說明 計算簽名時使用的Key就是您持有的AccessKey Secret並加上一個“&”字元（ASCII:38）, 使用的雜湊演算法是SHA1。
    2. 按照Base64編碼規則把上面的HMAC值編碼成字串，即得到簽名值（Signature）。
    3. 將得到的簽名值作為Signature參數添加到請求參數中。
      說明 得到的簽名值在作為最後的請求參數值提交時要和其它參數一樣，按照RFC3986的規則進行URL編碼。

    樣本

    以CreateTrail為例，簽名前的請求URL為：

    https://actiontrail.cn-hangzhou.aliyuncs.com/?AccessKeyId=testid&Action=CreateTrail&Format=JSON&Name=test&RegionId=cn-hangzhou&RoleName=AliyunServiceRoleForActionTrail&SignatureMethod=HMAC-SHA1&SignatureNonce=d7730860-e66f-11ea-a3a5-d5f3b52e66a1&SignatureVersion=1.0&Timestamp=2020-08-25T01%3A11%3A01Z&Version=2017-12-04

    對應的StringToSign是：

    POST&%2F&AccessKeyId%3Dtestid%26Action%3DCreateTrail%26Format%3DJSON%26Name%3Dtest%26RegionId%3Dcn-hangzhou%26RoleName%3DAliyunServiceRoleForActionTrail%26SignatureMethod%3DHMAC-SHA1%26SignatureNonce%3Dd7730860-e66f-11ea-a3a5-d5f3b52e66a1%26SignatureVersion%3D1.0%26Timestamp%3D2020-08-25T01%25253A11%25253A01Z%26Version%3D2017-12-04

    例如：AccessKey ID為：testid，AccessKeySecret為：testsecret，則用於計算HMAC的key為：testsecret&。

    計算得到的簽名值為：d15sJSZ0cc+y6a6FHlWxGK/qcUA=。

    簽名後的請求URL為：

    https://actiontrail.cn-hangzhou.aliyuncs.com/?Signature=d15sJSZ0cc+y6a6FHlWxGK/qcUA=&AccessKeyId=testid&Action=CreateTrail&Format=JSON&Name=test&RegionId=cn-hangzhou&RoleName=AliyunServiceRoleForActionTrail&SignatureMethod=HMAC-SHA1&SignatureNonce=d7730860-e66f-11ea-a3a5-d5f3b52e66a1&SignatureVersion=1.0&Timestamp=2020-08-25T01%3A11%3A01Z&Version=2017-12-04