全部产品

签名机制

更新时间:2020-08-31 11:37:01

对于每一次HTTP或者HTTPS协议请求,我们会根据访问中的签名信息验证访问请求者身份。具体由使用AccessKeyID和AccessKeySecret对称加密验证实现。
说明 AccessKey相当于用户密码,AccessKey用于调用API。其中AccessKeyID是访问者身份,AccessKeySecret是加密签名字符串和服务器端验证签名字符串的密钥,必须严格保密谨防泄露。

步骤一:构造规范化请求字符串

  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-urlencodedMIME格式编码算法相似,但又有所不同。
      如果您使用的是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处理上一步构造的规范化请求字符串,规则如下:```java//HTTPMethod:发送请求的 HTTP 方法,例如 GET。//percentEncode(“/“):字符(/)UTF-8 编码得到的值,即 %2F。//CanonicalizedQueryString 您的规范化请求字符串。StringToSign=HTTPMethod + “&” +percentEncode(“/“) + “&” +percentEncode(CanonicalizedQueryString)
  1. 2.按照[RFC2104](http://www.ietf.org/rfc/rfc2104.txt)的定义,计算待签名字符串`StringToSign`的HMAC-SHA1值。示例使用的是Java Base64编码方法。
  2. ```java
  3. Signature = Base64( HMAC-SHA1( AccessSecret, UTF-8-Encoding-Of(StringToSign) ) )

说明 计算签名时,RFC2104规定的Key值是您的AccessKeySecret并加上与号(&),其ASCII值为38。更多详情,请参见创建AccessKey。

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

示例一:参数拼接法

以调用创建服务任务为例。假设您获得了AccessKeyID=testid以及AccessKeySecret=testsecret,签名流程如下所示:

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

    1. GET
    2. https://api-rpa.aliyun.com/rpa/openapi/client/queryClientViews?
    3. Timestamp=2020-04-23T12%3A46%3A24Z
    4. &AccessKeySecret=2020-04-23T12%3A46%3A24Z
    5. &Format=json&AccessKeyId=testid
    6. &SignatureMethod=HMAC-SHA1
    7. &SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf
    8. &Version=20200430
    9. &SignatureVersion=1.0
  2. 构造待签名字符串StringToSign。

    1. GET&%2F&AccessKeyId%3Dd91ef7e3e7564f9f&Format%3Djson&SignatureMethod%3DHMAC-SHA1&SignatureNonce%3Dinrqdafyjbocuvwkgptlzsmexh&SignatureVersion%3D1.0&Timestamp%3D2020-08-24T07%253A47%253A30Z&Version%3D20200430
  3. 计算签名值。因为AccessKeySecret=testsecret,用于计算的Key为testsecret&,计算得到的签名值为OLeaidS1JvxuMvnyHOwuJ+uX5qY=。示例使用的是JavaBase64编码方法。

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

    1. https://api-rpa.aliyun.com/rpa/openapi/client/queryClientViews?AccessKeyId=f8cd79977657e3d1&Signature=0RhDKkPUS5Y8ul2HHZWao4Ahof8=&SignatureMethod=HMAC-SHA1&SignatureVersion=1.0&SignatureNonce=lrfcyonxmujbqdkwstzahipvge&Timestamp=2020-08-12T07:06:20Z&Version=20200430&Format=json&clientName=机器人名称

示例二:编程语言法

依然以调用queryClientViews查询RPA机器人名称为例。假设您获得了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";(如果是POST请求,则此处应为POST)
  2. Map parameters = new HashMap();
  3. // 输入公共请求参数
  4. parameters.put("Version", "20200430");
  5. parameters.put("AccessKeyId", "testid");
  6. parameters.put("Timestamp", formatIso8601Date(new Date()));
  7. parameters.put("SignatureMethod", "HMAC-SHA1");
  8. parameters.put("SignatureVersion", "1.0");
  9. parameters.put("SignatureNonce", UUID.randomUUID().toString());
  10. parameters.put("Format", "json");
  11. // 输入接口独有参数(以queryClientViews该接口为例)
  12. parameters.put("clientName", "机器人名称");
  13. // 排序请求参数
  14. String[] sortedKeys = parameters.keySet().toArray(new String[]{});
  15. Arrays.sort(sortedKeys);
  16. final String SEPARATOR = "&";
  17. // 构造 stringToSign 字符串
  18. StringBuilder stringToSign = new StringBuilder();
  19. stringToSign.append(HTTP_METHOD).append(SEPARATOR);
  20. stringToSign.append(percentEncode("/")).append(SEPARATOR);
  21. StringBuilder canonicalizedQueryString = new StringBuilder();
  22. for(String key : sortedKeys) {
  23. // 这里注意编码 key 和 value
  24. canonicalizedQueryString.append("&")
  25. .append(percentEncode(key)).append("=")
  26. .append(percentEncode(parameters.get(key)));
  27. }
  28. // 这里注意编码 canonicalizedQueryString
  29. stringToSign.append(percentEncode(
  30. canonicalizedQueryString.toString().substring(1)));
  1. 签名。因为AccessKeySecret=testsecret,所以用于计算HMAC的Key为testsecret&,计算得到的签名值为OLeaidS1JvxuMvnyHOwuJ%2BuX5qY%3D

    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));
  2. 增加签名参数后,按照RFC3986规则编码后的URL如下所示:

    1. https://api-rpa.aliyun.com/rpa/openapi/client/queryClientViews?SignatureVersion=1.0&Format=json&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&Version=20200430&AccessKeyId=testid&Signature=OLeaidS1JvxuMvnyHOwuJ%2BuX5qY%3D&SignatureMethod=HMAC-SHA1&Timestamp=2016-02-23T12%253A46%253A24ZclientName=机器人名称

完整生成签名示例(以python为例)

  1. import base64
  2. import datetime
  3. import hmac
  4. import random
  5. from _sha1 import sha1
  6. from urllib import parse
  7. #以获取客户端信息接口为例
  8. #用户私钥
  9. AccessSecret = "32860996-XXXXXXXX-a009-a37ae44a5a3d"
  10. #请求方式
  11. method = 'GET'
  12. #公共请求参数
  13. AccessKeyId = "d91ef7e3e7XXXXX"
  14. signature_method = "HMAC-SHA1"
  15. signature_version = "1.0"
  16. signature_nonce = ''.join(random.sample('abcdefghijklmnopqrstuvwxyz', 26))
  17. timestamp = datetime.datetime.utcnow().strftime("%Y-%m-%dT%H:%M:%SZ")
  18. version = "20200430"
  19. data_format = "json"
  20. #接口独有的请求参数
  21. clientName = '测试'
  22. params = {"AccessKeyId": AccessKeyId,
  23. "Format": data_format,
  24. "SignatureMethod": signature_method,
  25. "SignatureNonce": signature_nonce,
  26. "SignatureVersion": signature_version,
  27. "Timestamp": timestamp,
  28. "Version": version,
  29. 'clientName':clientName
  30. }
  31. #参与加签的参数:用户私钥、请求方式、公共请求参数、接口独有的参数
  32. #步骤一:将公共请求参数以及接口独有参数进行排序
  33. items = list(params.keys())
  34. items.sort()
  35. temp_list = []
  36. for i in items:
  37. temp_list.append(parse.quote(i) + "=" + parse.quote(params[i]))
  38. temp_string = "&".join(temp_list)
  39. #步骤二:构造规范化请求字符串
  40. StringToSign = method.upper() + "&%2F&" + parse.quote(temp_string)
  41. #步骤三:生成签名参数
  42. h = hmac.new((AccessSecret + '&').encode("utf-8"), StringToSign.encode("utf-8"), sha1).digest()
  43. Signaure = base64.b64encode(h)
  44. #打印签名参数
  45. print(Signaure)
  46. #打印其他参数(发送请求时的timestamp以及SignatureNonce参数需要使用)
  47. print(timestamp)
  48. print(signature_nonce)