签名机制 - 运维编排服务

构造规范化请求字符串

1. 排序参数。排序规则以首字母顺序排序，排序参数包括公共请求参数和接口自定义参数，不包括公共请求参数中的Signature参数。
   说明 当使用GET方法提交请求时，这些参数就是请求URL中的参数部分，即URL中?之后由&连接的部分。
2. 编码参数。使用UTF-8字符集按照RFC3986规则编码请求参数和参数取值，编码规则如下：
   • 字符A~Z、a~z、0~9以及字符 -、_、.、~不编码。
   • 其它字符编码成%XY的格式，其中XY是字符对应ASCII码的16进制。示例：半角双引号（"）对应%22。
   • 扩展的UTF-8字符，编码成%XY%ZA…的格式。
   • 空格（ ）编码成%20，而不是加号（+）。该编码方式与application/x-www-form-urlencoded MIME格式编码算法相似，但又有所不同。如果您使用的是Java标准库中的java.net.URLEncoder，可以先用标准库中percentEncode编码，随后将编码后的字符中加号（+）替换为%20、星号（*）替换为%2A、%7E替换为波浪号（~），即可得到上述规则描述的编码字符串。

     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. 使用与号（&）连接编码后的请求参数，注意参数排序与步骤一：构造规范化请求字符串一致。

现在，您得到了规范化请求字符串（CanonicalizedQueryString），其结构遵循请求结构。

构造签名字符串

1. 构造待签名字符串StringToSign。您可以同样使用percentEncode处理上一步构造的规范化请求字符串，规则如下：

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

2. 按照RFC2104的定义，计算待签名字符串StringToSign的HMAC-SHA1值。示例使用的是Java Base64编码方法。

   Signature = Base64( HMAC-SHA1( AccessSecret, UTF-8-Encoding-Of(StringToSign) ) )

3. 添加根据RFC3986规则编码后的参数Signature到规范化请求字符串URL中。

示例 1. 参数拼接法

以调用ListTemplates查询模板为例。假设您获得了AccessKeyID=testid以及AccessKeySecret=testsecret，签名流程如下所示：

1. 构造规范化请求字符串。

   AccessKeyId=testid&Action=ListTemplates&Format=json&SignatureMethod=HMAC-SHA1&SignatureNonce=9a3fdf30-8049-11e9-8875-6c96cfdd1fa1&SignatureVersion=1.0&Timestamp=2019-05-27T06%3A35%3A22Z&Version=2019-06-01

2. 构造待签名字符串StringToSign，详情请参见步骤二：构造签名字符串。

   GET&%2F&AccessKeyId%3Dtestid&Action%3DListTemplates&Format%3Djson&SignatureMethod%3DHMAC-SHA1&SignatureNonce%3D9a3fdf30-8049-11e9-8875-6c96cfdd1fa1&SignatureVersion%3D1.0&Timestamp%3D2019-05-27T06%253A35%253A22Z&Version%3D2019-06-01

3. 计算签名值。因为AccessKeySecret=testsecret，用于计算的Key为testsecret&，计算得到的签名值为 1FcsD6/AvH2KugeowoCJSi8lBd8=。示例使用的是Java Base64编码方法。

   Signature = Base64( HMAC-SHA1( AccessSecret, UTF-8-Encoding-Of(StringToSign) ) )

4. 添加RFC3986规则编码后的Signature=1FcsD6%2FAvH2KugeowoCJSi8lBd8%3D到步骤一：构造规范化请求字符串的URL中。

   http://oos.cn-hangzhou.aliyuncs.com/?SignatureVersion=1.0&Format=json&Timestamp=2019-05-27T06%3A35%3A22Z&AccessKeyId=testid&SignatureMethod=HMAC-SHA1&Version=2019-06-01&Signature=1FcsD6%2FAvH2KugeowoCJSi8lBd8%3D&Action=ListTemplates&SignatureNonce=9a3fdf30-8049-11e9-8875-6c96cfdd1fa1

通过以上URL，您可以使用浏览器、curl或者wget等工具发起HTTP请求调用ListTemplates，查询您的模板。

示例 2. 编程语言法

依然以调用ListTemplates查询模板为例。假设您获得了AccessKeyID=testid以及AccessKeySecret=testsecret，并且假定所有请求参数放在一个Java Map<String, String>对象里。

1. 预定义编码方法。

   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;
   }

2. 预定义编码时间格式Timestamp。参数Timestamp必须符合时间格式规范，并需要使用UTC时间，时区为+0。

   private static final String ISO8601_DATE_FORMAT = "yyyy-MM-dd'T'HH:mm:ss'Z'";
   private static String formatIso8601Date(Date date) {
   SimpleDateFormat df = new SimpleDateFormat(ISO8601_DATE_FORMAT);
   df.setTimeZone(new SimpleTimeZone(0, "GMT"));
   return df.format(date);
   }

3. 构造请求字符串。

   final String HTTP_METHOD = "GET";
   Map parameters = new HashMap();
   // 输入请求参数
   parameters.put("Action", "ListTemplates");
   parameters.put("Version", "2019-06-01");
   parameters.put("AccessKeyId", "testid");
   parameters.put("Timestamp", formatIso8601Date(new Date()));
   parameters.put("SignatureMethod", "HMAC-SHA1");
   parameters.put("SignatureVersion", "1.0");
   parameters.put("SignatureNonce", UUID.randomUUID().toString());
   parameters.put("Format", "JSON");
   // 排序请求参数
   String[] sortedKeys = parameters.keySet().toArray(new String[]{});
   Arrays.sort(sortedKeys);
   final String SEPARATOR = "&";
   // 构造 stringToSign 字符串
   StringBuilder stringToSign = new StringBuilder();
   stringToSign.append(HTTP_METHOD).append(SEPARATOR);
   stringToSign.append(percentEncode("/")).append(SEPARATOR);
   StringBuilder canonicalizedQueryString = new StringBuilder();
   for(String key : sortedKeys) {
   // 这里注意编码 key 和 value
   canonicalizedQueryString.append("&")
   .append(percentEncode(key)).append("=")
   .append(percentEncode(parameters.get(key)));
   }
   // 这里注意编码 canonicalizedQueryString
   stringToSign.append(percentEncode(
   canonicalizedQueryString.toString().substring(1)));

4. 签名。因为 AccessKeySecret=testsecret，所以用于计算HMAC的Key为testsecret&，计算得到的签名值为1FcsD6/AvH2KugeowoCJSi8lBd8=。

   // 以下是一段计算签名的示例代码
   final String ALGORITHM = "HmacSHA1";
   final String ENCODING = "UTF-8";
   key = "testsecret&";
   Mac mac = Mac.getInstance(ALGORITHM);
   mac.init(new SecretKeySpec(key.getBytes(ENCODING), ALGORITHM));
   byte[] signData = mac.doFinal(stringToSign.getBytes(ENCODING));
   String signature = new String(Base64.encodeBase64(signData));

5. 增加签名参数后，按照RFC3986规则编码后的URL如下所示：

   http://oos.cn-hangzhou.aliyuncs.com/?SignatureVersion=1.0&Format=json&Timestamp=2019-05-27T06%3A35%3A22Z&AccessKeyId=testid&SignatureMethod=HMAC-SHA1&Version=2019-06-01&Signature=1FcsD6%2FAvH2KugeowoCJSi8lBd8%3D&Action=ListTemplates&SignatureNonce=9a3fdf30-8049-11e9-8875-6c96cfdd1fa1
   					

6. 使用浏览器、curl或者wget等工具发送HTTP请求。

   {
   "Templates": [
    {
      "Hash": "9ea05673ea6c7d03fe8707ddd3d347d74f9e47963538097d120583c0b5385edf",
      "Description": "",
      "TemplateName": "demo",
      "ShareType": "Private",
      "Tags": [],
      "TemplateFormat": "JSON",
      "CreatedBy": "1000008528360000",
      "CreatedDate": "2019-06-01T12:00:00Z",
      "TemplateVersion": "v1",
      "TotalExecutionCount": 1
    },...],
    "NextToken": "gAAAAABc5pnvl_meBuZkGEbZNmzTOA1RotEjFs4q8q2fICes_oGk4qenxGB5UeyXYWa5eF4TeZLQMpnVc6rmhr2BC0Kahyx1P5brt_fQvLFTLBEcXQzzqsWwxDS-Y1xL7pkhOOgU_K3Z0-dMQHOkIQwWhodp4qutzKNO7gQ-EPWQvM1ugrGkonFDe_bV3TckHyHqgJDTLwk8Swfm1NvnZTXg9AH8YLvhu0fTK8sgXI6nBkvqTkozedWFhq8jmH1SFbs1yVZoKoKpFaYV6-vuTFcUO9G9-5W0YVdfliTuEOf42QHtkWLZ8jj1Xhmk9rTBYjb7P4KmRm7b7UhQ6FamvpVv9vXlCQvWAafnPgT98ViFlr6z7ByNHrI=",
    "RequestId": "8B813042-7F00-45CE-AF8C-85CCEEFC6BA2",
    "MaxResults": 50
   }

返回结果列举了模板信息。