签名机制

对于每一次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替换为波浪号（~），即可得到上述规则描述的编码字符串。

     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处理上一步构造的规范化请求字符串，规则如下：```java//HTTPMethod：发送请求的 HTTP 方法，例如 GET。//percentEncode(“/“)：字符（/）UTF-8 编码得到的值，即 %2F。//CanonicalizedQueryString 您的规范化请求字符串。StringToSign=HTTPMethod + “&” +percentEncode(“/“) + “&” +percentEncode(CanonicalizedQueryString)

2.按照[RFC2104]（http://www.ietf.org/rfc/rfc2104.txt）的定义，计算待签名字符串`StringToSign`的HMAC-SHA1值。示例使用的是Java Base64编码方法。
```java
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. 构造规范化请求字符串。

   GET
   https://console-rpa.aliyun.com/rpa/openapi/client/queryClientViews?
   Timestamp=2020-04-23T12%3A46%3A24Z
   &AccessKeySecret=2020-04-23T12%3A46%3A24Z
   &Format=json&AccessKeyId=testid
   &SignatureMethod=HMAC-SHA1
   &SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf
   &Version=20200430
   &SignatureVersion=1.0

2. 构造待签名字符串StringToSign。

   GET&%2F&AccessKeyId%3Dd91e************&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编码方法。

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

4. 添加RFC3986规则编码后的Signature=OLeaidS1JvxuMvnyHOwuJ%2BuX5qY%3D到签名机制的URL中。

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

示例二：编程语言法（Java为例）

依然以调用queryClientViews查询RPA机器人名称为例。假设您获得了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必须符合ISO8601规范，并需要使用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";//（如果是POST请求，则此处应为POST）
Map parameters = new HashMap();
// 输入公共请求参数
parameters.put("Version", "20200430");
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");

// 输入接口独有参数（以queryClientViews该接口为例）
parameters.put("clientName", "机器人名称");

// 排序请求参数
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)));

1. 签名。因为AccessKeySecret=testsecret，所以用于计算HMAC的Key为testsecret&，计算得到的签名值为OLeaidS1JvxuMvnyHOwuJ%2BuX5qY%3D。

   // 以下是一段计算签名的示例代码
   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));

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

   https://console-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%253A24Z&clientName=机器人名称

完整生成签名示例（以python为例）

import base64
import datetime
import hmac
import random
from _sha1 import sha1
from urllib import parse

#以获取客户端信息接口为例


#用户私钥
AccessSecret = os.getenv('RPA_SK_ENV')


#请求方式
method = 'GET'


#公共请求参数
AccessKeyId = os.getenv('RPA_AK_ENV')
signature_method = "HMAC-SHA1"
signature_version = "1.0"
signature_nonce = ''.join(random.sample('abcdefghijklmnopqrstuvwxyz', 26))
timestamp = datetime.datetime.utcnow().strftime("%Y-%m-%dT%H:%M:%SZ")
version = "20200430"
data_format = "json"


#接口独有的请求参数
clientName = '测试'


params = {"AccessKeyId": AccessKeyId,
          "Format": data_format,
          "SignatureMethod": signature_method,
          "SignatureNonce": signature_nonce,
          "SignatureVersion": signature_version,
          "Timestamp": timestamp,
          "Version": version,
          'clientName':clientName
          }


#参与加签的参数：用户私钥、请求方式、公共请求参数、接口独有的参数

#步骤一：将公共请求参数以及接口独有参数进行排序
items = list(params.keys())
items.sort()
temp_list = []
for i in items:
    temp_list.append(parse.quote(i) + "=" + parse.quote(params[i]))
temp_string = "&".join(temp_list)


#步骤二：构造规范化请求字符串
StringToSign = method.upper() + "&%2F&" + parse.quote(temp_string)


#步骤三：生成签名参数
h = hmac.new((AccessSecret + '&').encode("utf-8"), StringToSign.encode("utf-8"), sha1).digest()
Signature = base64.b64encode(h)

#打印签名参数
print(Signature)

#打印其他参数（发送请求时的timestamp以及SignatureNonce参数需要使用）
print(timestamp)
print(signature_nonce)