PolarDB-X1.0如何在发送OpenAPI请求时进行签名处理_云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

发送OpenAPI请求时，请按照下面的方法对请求进行签名处理：

PolarDB-X 1.0服务会对每个API的调用请求进行身份验证，所以无论使用HTTP还是HTTPS协议提交请求，都需要在请求中包含由Access Key ID与Access Key Secret所产生的签名（Signature）信息。
Access Key ID和Access Key Secret由阿里云官方颁发给访问者（可以通过阿里云官方网站申请和管理），其中Access Key ID用于标识访问者的身份。
Access Key Secret是用于加密签名字符串和服务器端验证签名字符串的密钥，必须严格保密，只有阿里云和用户知道。

签名方法

使用请求参数构造规范化的请求字符串（Canonicalized Query String）。
1.1. 按照参数名称的字典顺序对请求中所有的请求参数（包括文档中描述的“公共请求参数”和给定了的请求接口的自定义参数，但不能包括“公共请求参数”中提到Signature参数本身）进行排序。

重要使用GET方法提交请求时，这些参数就是请求URI中的参数部分（即URI中“?”之后由“&”连接的部分）。

1.2. 对每个请求参数的名称和值进行编码。名称和值要使用UTF-8字符集进行URL编码，URL编码的编码规则是：
- 对于字符A-Z、a-z、0-9以及字符“-”、“_”、“.”、“~”不编码；
- 对于其他字符编码成“%XY”的格式，其中XY是字符对应ASCII码的16进制表示。比如英文的双引号（”）对应的编码就是%22；
- 对于扩展的UTF-8字符，编码成“%XY%ZA…”的格式；
- 英文空格（）要被编码是%20，而不是加号（+）。
  
  重要一般支持URL编码的库（比如Java中的java.net.URLEncoder）都是按照“application/x-www-form-urlencoded”的MIME类型的规则进行编码的。实现时可以直接使用这类方式进行编码，把编码后的字符串中加号（+）替换成%20、星号（*）替换成%2A、%7E替换回波浪号（~），即可得到上述规则描述的编码字符串。
1.3. 对编码后的参数名称和值使用英文等号（=）进行连接。

1.4. 把英文等号连接得到的字符串按参数名称的字典顺序依次使用&符号连接，即得到规范化请求字符串。
使用上一步构造的规范化字符串按照下面的规则构造用于计算签名的字符串。
```
 StringToSign=
 HTTPMethod + "&" +
 percentEncode("/") + "&" +
 percentEncode(CanonicalizedQueryString)
```
- 其中HTTPMethod是提交请求用的HTTP方法，例如GET。
- percentEncode（“/”）是按照1.2中描述的URL编码规则对字符“/”进行编码得到的值，即“%2F”。
- percentEncode（CanonicalizedQueryString）是对第1步中构造的规范化请求字符串按1.2中描述的URL编码规则编码后得到的字符串。
按照RFC2104的定义，使用上面的用于签名的字符串计算签名HMAC值。

重要计算签名时使用的Key就是用户持有的Access Key Secret并加上一个“&”字符（ASCII:38），使用的哈希算法是SHA1。
按照Base64编码规则把上面的HMAC值编码成字符串，即得到签名值（Signature）。
将得到的签名值作为Signature参数添加到请求参数中，即完成对请求签名的过程。

重要得到的签名值在作为最后的请求参数值提交给PolarDB-X 1.0服务器的时候，要和其他参数一样，按照RFC3986的规则进行URL编码。

示例

以DescribeDrdsInstances为例，签名前的请求参数字符串为：

AccessKeyId=testid&Action=DescribeDrdsInstances&Format=XML&RegionId=cn-hangzhou&SignatureMethod=HMAC-SHA1&SignatureNonce=ae5bdbeb-9b44-40a1-8bb4-b40784bff686&SignatureVersion=1.0&Timestamp=2016-01-20T14%3A26%3A15Z&Version=2015-04-13

对这个字符串进行编码，那么StringToSign为：

GET&%2F&AccessKeyId%3Dtestid&Action%3DDescribeDrdsInstances&Format%3DXML&RegionId%3Dcn-hangzhou&SignatureMethod%3DHMAC-SHA1&SignatureNonce%3Dae5bdbeb-9b44-40a1-8bb4-b40784bff686&SignatureVersion%3D1.0&Timestamp%3D2016-01-20T14%253A26%253A15Z&Version%3D2015-04-13

假如使用的Access Key ID是“testid”，Access Key Secret是“testsecret”，用于计算HMAC的Key就是“testsecret&”，则计算得到的签名值是：

h/ka/jNO+WZv8Tqgo4a75sp6eTs=

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

http://drds.aliyuncs.com/?AccessKeyId=testid&Action=DescribeDrdsInstances&Format=XML&RegionId=cn-hangzhou&SignatureMethod=HMAC-SHA1&SignatureNonce=ae5bdbeb-9b44-40a1-8bb4-b40784bff686&SignatureVersion=1.0&Timestamp=2016-01-20T14%3A26%3A15Z&Version=2015-04-13&Signature=h%2Fka%2FjNO%2BWZv8Tqgo4a75sp6eTs%3D

调用接口DescribeDrdsInstances的Java示例如下：

public static void drdsOpenAPI() throws NoSuchAlgorithmException, InvalidKeyException, IOException {
        //AK与SK
        String accessKey = "testid";
        String accessSecret = "testsecret";
        //公共参数
        Map<String, String> parameters = new TreeMap<String, String>();
        parameters.put("Format", "JSON");
        parameters.put("Action", "DescribeDrdsInstances");//调用 DescribeDrdsInstances 接口
        parameters.put("Version", "2015-04-13");
        parameters.put("AccessKeyId", accessKey);
        parameters.put("SignatureMethod", "HMAC-SHA1");
        parameters.put("Timestamp", getISO8601Time());
        parameters.put("SignatureVersion", "1.0");
        parameters.put("SignatureNonce", UUID.randomUUID().toString());
        parameters.put("RegionId", "cn-hangzhou");
        StringBuilder paramStr = new StringBuilder();
        //拼接请求参数
        for(Map.Entry<String, String> entry : parameters.entrySet()) {
          paramStr.append(percentEncode(entry.getKey())).append("=").append(percentEncode(entry.getValue())).append("&");
        }
        paramStr.deleteCharAt(paramStr.length()-1);

        //计算签名
        StringBuilder stringToSign = new StringBuilder();
            stringToSign.append("GET").append("&").append(percentEncode("/"))
                  .append("&").append(percentEncode(paramStr.toString()));
            Mac mac = Mac.getInstance("HmacSHA1");
        mac.init(new SecretKeySpec((accessSecret + "&").getBytes("UTF-8"),"HmacSHA1"));
        byte[] signData = mac.doFinal(stringToSign.toString().getBytes("UTF-8"));
        String signStr = Base64Helper.encode(signData);
        //拼接URL
        String requestUrl = "http://drds.aliyuncs.com/?" + paramStr.toString() + 
            "&Signature=" +  percentEncode(signStr);
        //准备发送HTTP请求
        URL url = new URL(requestUrl);
        HttpURLConnection httpConn = (HttpURLConnection)url.openConnection();
        httpConn.setRequestMethod("GET");
        httpConn.setDoOutput(true);
        httpConn.setDoInput(true);
        httpConn.setUseCaches(false);
        httpConn.connect();
        InputStream content = httpConn.getInputStream();
        ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
        byte[] buff = new byte[1024];
        while(true) {
           final int read = content.read(buff);
           if(read == -1) break;
           outputStream.write(buff,0,read);
        }
        System.out.println(new String(outputStream.toByteArray()));;
  }

  public static String percentEncode(String value) throws UnsupportedEncodingException{
        return value != null ? URLEncoder.encode(value, "UTF-8").replace("+", "%20")
                .replace("*", "%2A").replace("%7E", "~") : null;
    }

  static String getISO8601Time() {
        SimpleDateFormat df = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'");
        df.setTimeZone(new SimpleTimeZone(0, "GMT"));
        return df.format(new Date());
  }