全部产品
云市场

签名机制

更新时间:2019-06-27 17:37:06

对于每一次HTTP或者HTTPS协议请求,我们会根据访问中的签名信息验证访问请求者身份。具体由使用AccessKeyID和AccessKeySecret对称加密验证实现。

AccessKey相当于用户密码,AccessKey用于调用API,而用户密码用于登录 OOS 控制台 。其中AccessKeyID是访问者身份,AccessKeySecret是加密签名字符串和服务器端验证签名字符串的密钥,必须严格保密谨防泄露。

说明 我们提供了多种编程语言的SDK及第三方SDK,可以免去您签名的烦恼。更多详情,请下载 SDK

构造规范化请求字符串

  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 替换为波浪号(~),即可得到上述规则描述的编码字符串。
      1. private static final String ENCODING = "UTF-8";
      2. private static String percentEncode(String value) throws UnsupportedEncodingException {
      3. return value != null ? URLEncoder.encode(value, ENCODING).replace("+", "%20").replace("*", "%2A").replace("%7E", "~") : null;
      4. }
  3. 使用等号(=)连接编码后的请求参数和参数取值。

  4. 使用与号(&)连接编码后的请求参数,注意参数排序与 步骤1 一致。

现在,您得到了规范化请求字符串(CanonicalizedQueryString),其结构遵循 请求结构

构造签名字符串

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

    1. StringToSign=
    2. HTTPMethod + "&" + //HTTPMethod:发送请求的 HTTP 方法,例如 GET。
    3. percentEncode("/") + "&" + //percentEncode("/"):字符(/)UTF-8 编码得到的值,即 %2F。
    4. percentEncode(CanonicalizedQueryString) //您的规范化请求字符串。
  2. 按照 RFC2104 的定义,计算待签名字符串 StringToSign 的HMAC-SHA1值。示例使用的是Java Base64编码方法。

    1. Signature = Base64( HMAC-SHA1( AccessSecret, UTF-8-Encoding-Of(StringToSign) ) )
  3. 添加根据 RFC3986 规则编码后的参数 Signature 到规范化请求字符串URL中。

说明: 计算签名时,RFC2104规定的Key值是您的 AccessKeySecret 并加上与号( &),其ASCII值为38。

示例 1. 参数拼接法

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

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

    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

    1. 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编码方法。

    1. Signature = Base64( HMAC-SHA1( AccessSecret, UTF-8-Encoding-Of(StringToSign) ) )
  4. 添加 RFC3986 规则编码后的Signature=1FcsD6%2FAvH2KugeowoCJSi8lBd8%3D步骤1 的URL中。

    1. 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. 预定义编码方法。

    1. private static final String ENCODING = "UTF-8";
    2. private static String percentEncode(String value) throws UnsupportedEncodingException {
    3. return value != null ? URLEncoder.encode(value, ENCODING).replace("+", "%20").replace("*", "%2A").replace("%7E", "~") : null;
    4. }
  2. 预定义编码时间格式 Timestamp。参数 Timestamp 必须符合 ISO8601 规范,并需要使用UTC时间,时区为+0。

    1. private static final String ISO8601_DATE_FORMAT = "yyyy-MM-dd'T'HH:mm:ss'Z'";
    2. private static String formatIso8601Date(Date date) {
    3. SimpleDateFormat df = new SimpleDateFormat(ISO8601_DATE_FORMAT);
    4. df.setTimeZone(new SimpleTimeZone(0, "GMT"));
    5. return df.format(date);
    6. }
  3. 构造请求字符串。

    1. final String HTTP_METHOD = "GET";
    2. Map parameters = new HashMap();
    3. // 输入请求参数
    4. parameters.put("Action", "ListTemplates");
    5. parameters.put("Version", "2019-06-01");
    6. parameters.put("AccessKeyId", "testid");
    7. parameters.put("Timestamp", formatIso8601Date(new Date()));
    8. parameters.put("SignatureMethod", "HMAC-SHA1");
    9. parameters.put("SignatureVersion", "1.0");
    10. parameters.put("SignatureNonce", UUID.randomUUID().toString());
    11. parameters.put("Format", "JSON");
    12. // 排序请求参数
    13. String[] sortedKeys = parameters.keySet().toArray(new String[]{});
    14. Arrays.sort(sortedKeys);
    15. final String SEPARATOR = "&";
    16. // 构造 stringToSign 字符串
    17. StringBuilder stringToSign = new StringBuilder();
    18. stringToSign.append(HTTP_METHOD).append(SEPARATOR);
    19. stringToSign.append(percentEncode("/")).append(SEPARATOR);
    20. StringBuilder canonicalizedQueryString = new StringBuilder();
    21. for(String key : sortedKeys) {
    22. // 这里注意编码 key 和 value
    23. canonicalizedQueryString.append("&")
    24. .append(percentEncode(key)).append("=")
    25. .append(percentEncode(parameters.get(key)));
    26. }
    27. // 这里注意编码 canonicalizedQueryString
    28. stringToSign.append(percentEncode(
    29. canonicalizedQueryString.toString().substring(1)));
  4. 签名。因为 AccessKeySecret=testsecret,所以用于计算HMAC的Key为 testsecret&,计算得到的签名值为 1FcsD6/AvH2KugeowoCJSi8lBd8=

    1. // 以下是一段计算签名的示例代码
    2. final String ALGORITHM = "HmacSHA1";
    3. final String ENCODING = "UTF-8";
    4. key = "testsecret&";
    5. Mac mac = Mac.getInstance(ALGORITHM);
    6. mac.init(new SecretKeySpec(key.getBytes(ENCODING), ALGORITHM));
    7. byte[] signData = mac.doFinal(stringToSign.getBytes(ENCODING));
    8. String signature = new String(Base64.encodeBase64(signData));
  5. 增加签名参数后,按照 RFC3986 规则编码后的URL如下所示:

    1. 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请求。

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

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