如何构造规范化请求和签名-阿里云帮助中心

本文介绍了通过HTTP或HTTPS协议请求调用实人认证服务接口时，构造请求签名的方法。

对于每一次HTTP或者HTTPS协议请求，阿里云会根据访问中的签名信息验证访问请求者身份。具体由使用AccessKey ID和AccessKey Secret对称加密验证实现。AccessKey的获取请参见获取AccessKey。

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

参数排序。将所有公共请求参数按照首字母顺序排序。

说明当使用GET方法提交请求时，这些参数就是请求URL中的参数部分，即URL中?之后由&连接的部分。
参数编码。使用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;
}
```
使用等号（=）连接编码后的请求参数和参数取值。
使用与号（&）连接编码后的请求参数，注意参数排序与第1步描述一致。

通过以上步骤得到了规范化请求字符串（CanonicalizedQueryString），其结构遵循请求结构的要求。

步骤二：构造签名字符串

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

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

按照RFC2104的定义，计算待签名字符串StringToSign的HMAC-SHA1值。示例中使用的是Java Base64编码方法。
```
Signature = Base64( HMAC-SHA1( AccessSecret, UTF-8-Encoding-Of(StringToSign) ) )
```
说明计算签名时，RFC2104规定的Key值是您的AccessKey Secret并加上与号（&），其ASCII值为38。更多信息，请参见获取AccessKey。
添加根据RFC3986规则编码后的参数Signature到规范化请求字符串URL中。

示例一：参数拼接法

使用RPBioOnly认证方案，调用DescribeVerifyToken发起认证请求接口为例进行说明。

您获得了AccessKey ID=testid，AccessKey Secret=testsecret。
在控制台上创建了业务场景标识BizType为testforRPBioOnly。
本次认证任务的认证IDBizId为abc1234。
要认证用户的姓名为张三，身份证号为33010320191201****。

签名流程：

构造规范化请求字符串。

https://cloudauth.aliyuncs.com/?AccessKeyId=testid&Action=DescribeVerifyToken&BizId=abc1234&BizType=testforRPBioOnly&Format=XML&IdCardNumber=33010320191201****&Name=%e5%bc%a0%e4%b8%89&SignatureMethod=HMAC-SHA1&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&SignatureVersion=1.0&Timestamp=2016-02-23T12%3A46%3A24Z&Version=2019-03-07

构造待签名字符串StringToSign。

GET&%2F&AccessKeyId%3Dtestid%26Action%3DDescribeVerifyToken%26BizId%3Dabc1234%26BizType%3DtestforRPBioOnly%26Format%3DXML%26IdCardNumber%3D33010320191201****%26Name%3D%e5%bc%a0%e4%b8%89%26SignatureMethod%3DHMAC-SHA1%26SignatureNonce%3D3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf%26SignatureVersion%3D1.0%26Timestamp%3D2016-02-23T12%253A46%253A24Z%26Version%3D2019-03-07

计算签名值。因为AccessKey Secret=testsecret，用于计算的Key为testsecret&，计算得到的签名值为tZCundQUBD0t6B3adwH1615EH5c=。示例使用的是JavaBase64编码方法。
```
Signature = Base64( HMAC-SHA1( AccessSecret, UTF-8-Encoding-Of(StringToSign) ) )
```

添加RFC3986规则编码后的Signature=tZCundQUBD0t6B3adwH1615EH5c%3D到第1步的URL中。

https://cloudauth.aliyuncs.com/?AccessKeyId=testid&Action=DescribeVerifyToken&BizId=abc1234&BizType=testforRPBioOnly&Format=XML&IdCardNumber=33010320191201****&Name=%e5%bc%a0%e4%b8%89&Signature=tZCundQUBD0t6B3adwH1615EH5****&SignatureMethod=HMAC-SHA1&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&SignatureVersion=1.0&Timestamp=2016-02-23T12%3A46%3A24Z&Version=2019-03-07

通过以上URL，您可以使用浏览器、curl或者wget等工具发起HTTP请求。

示例二：编程语言法

使用RPBioOnly认证方案，调用DescribeVerifyToken发起认证请求接口为例进行说明。

您获得了AccessKey ID=testid，AccessKey Secret=testsecret。
在控制台上创建了业务场景标识BizType为testforRPBioOnly。
本次认证任务的认证IDBizId为abc1234。
要认证用户的姓名为张三，身份证号为33010320191201****。

假定所有请求参数放在一个Java Map<String, String>对象里，签名流程：

预定义编码方法。

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

预定义编码时间格式Timestamp。参数Timestamp必须符合ISO8601。

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

构造请求字符串。

final String HTTP_METHOD = "GET";
Map parameters = new HashMap();

//输入请求参数。
parameters.put("Action", "DescribeVerifyToken");
parameters.put("Version", "2019-03-07");
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", "XML");
parameters.put("BizType", "testforRPBioOnly");
parameters.put("BizId", "abc1234");
parameters.put("Name", "张三");
parameters.put("IdCardNumber", "33010320191201****");

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

签名。因为AccessKey Secret=testsecret，所以用于计算HMAC的Key为testsecret&，计算得到的签名值为tZCundQUBD0t6B3adwH1615EH5c%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));

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

https://cloudauth.aliyuncs.com/?AccessKeyId=testid&Action=DescribeVerifyToken&BizId=abc1234&BizType=testforRPBioOnly&Format=XML&IdCardNumber=330103201912010108&Name=%e5%bc%a0%e4%b8%89&Signature=tZCundQUBD0t6B3adwH1615EH5c%3D&SignatureMethod=HMAC-SHA1&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&SignatureVersion=1.0&Timestamp=2016-02-23T12%3A46%3A24Z&Version=2019-03-07

可选：使用浏览器、curl或者wget等工具访问步骤4中的URL链接，发起HTTP请求。