如何对API请求进行签名处理_云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

PolarDB服务会对每个访问的请求进行身份验证，所以无论使用HTTP还是HTTPS协议提交请求，都需要在请求中包含签名（Signature）信息。

PolarDB通过使用AccessKey ID和AccessKey Secret进行对称加密的方法来验证请求的发送者身份。AccessKey ID和AccessKey Secret由阿里云官方颁发给访问者（可以通过阿里云官方网站申请和管理）。其中，AccessKey ID用于标识访问者的身份，AccessKey Secret是用于加密签名字符串和服务器端验证签名字符串的密钥，必须严格保密，只有阿里云和用户知道。

签名处理

用户在访问时，按照下面的方法对请求进行签名处理：

使用请求参数构造规范化的请求字符串（Canonicalized Query String）。
1. 按照参数名称的字典顺序对请求中所有的请求参数（包括文档中描述的“公共请求参数”和给定了的请求接口的自定义参数，但不能包括“公共请求参数”中提到Signature参数本身）进行排序。
  重要
  当使用GET方法提交请求时，这些参数就是请求URL中的参数部分（即URL中“?”之后由“&”连接的部分）。
2. 对每个请求参数的名称和值进行编码。
  名称和值要使用UTF-8字符集进行URL编码，URL编码的编码规则如下：
  1. 对于字符 AZ、az、09以及字符（-）、（_）、（.）、（~）不编码。
  2. 对于其他字符编码成%XY的格式，其中XY是字符对应ASCII码的16进制表示方式。例如英文的双引号（”）对应的编码就是%22。
  3. 对于扩展的UTF-8字符，编码成%XY%ZA…的格式。
  4. 需要说明的是英文空格（）要被编码是%20，而不是加号（+）。
    重要
    一般支持URL编码的库（比如Java中的java.net.URLEncoder）都是按照application/x-www-form-urlencoded的MIME类型的规则进行编码。实现时可以直接使用这类方式进行编码，把编码后的字符串中加号（+）替换成%20、星号（*）替换成%2A、%7E替换回波浪号（~），即可得到上述规则描述的编码字符串。
3. 对编码后的参数名称和值使用英文等号（=）进行连接。
4. 再把英文等号连接得到的字符串按参数名称的字典顺序依次使用&符号连接，即得到规范化的请求字符串。
使用上一步构造的规范化字符串按照下面的规则构造用于计算签名的字符串：
```
StringToSign=
HTTPMethod + "&" +
percentEncode("/") + "&" +
percentEncode(CanonicalizedQueryString)
```
参数说明：
- HTTPMethod：提交请求用的HTTP方法，例如GET。
- percentEncode(“/“)：按照1.ii中描述的URL编码规则对字符“/”进行编码得到的值，即%2F。
- percentEncode(CanonicalizedQueryString)：对第1步中构造的规范化请求字符串按步骤1.ii中描述的URL编码规则编码后得到的字符串。
按照RFC2104的定义，使用上面的用于签名的字符串计算签名HMAC值。
重要
计算签名时使用的Key就是用户持有的AccessKey Secret并加上一个“&”字符（ASCII:38），使用的哈希算法是SHA1。
按照Base64编码规则把上面的HMAC值编码成字符串，即得到签名值（Signature）。
将得到的签名值作为Signature参数添加到请求参数中，即完成对请求签名的过程。
说明
得到的签名值在作为最后的请求参数值提交给PolarDB服务器的时候，要和其他参数一样，按照RFC3986的规则进行URL编码）。

示例

以DescribeDBClusters为例，签名前的请求URL为：

http://polardb.aliyuncs.com/?Timestamp=2013-06-01T10:33:56Z&Format=XML&AccessKeyId=testid&Action=DescribeDBClusters&SignatureMethod=HMAC-SHA1&RegionId=region1&SignatureNonce=NwDAxvLU6tFE0DVb&Version=2014-08-15&SignatureVersion=1.0

计算得到的待签名字符串StringToSign为：

GET&%2F&AccessKeyId%3Dtestid&Action%3DDescribeDBClusters&Format%3DXML&RegionId%3Dregion1&SignatureMethod%3DHMAC-SHA1&SignatureNonce%3DNwDAxvLU6tFE0DVb&SignatureVersion%3D1.0&TimeStamp%3D2013-06-01T10%253A33%253A56Z&Version%3D2014-08-15

假如使用的AccessKey Id是“testid”，AccessKey Secret是“testsecret”，用于计算HMAC的Key就是“testsecret&”，则计算得到的签名值是BIPOMlu8LXBeZtLQkJTw6iFvw1E=

签名后的请求URL为（注意增加了Signature参数）：

http://polardb.aliyuncs.com/?Timestamp=2013-06-01T10%3A33%3A56Z&Format=XML&AccessKeyId=testid&Action=DescribeDBClusters&SignatureMethod=HMAC-SHA1&RegionId=region1&SignatureNonce=NwDAxvLU6tFE0DVb&SignatureVersion=1.0&Version=2014-08-15&Signature=BIPOMlu8LXBeZtLQkJTw6iFvw1E%3D