阿里云会对每个访问的请求进行身份验证,所以无论使用 HTTP 还是 HTTPS 协议提交请求,都需要在请求中包含签名(Signature)信息。

通过使用 Access Key ID 和 Access Key Secret 进行对称加密的方法来验证请求的发送者身份。Access Key ID 和 Access Key Secret 由阿里云官方颁发给访问者(可以通过阿里云官方网站申请和管理),其中 Access Key ID 用于标识访问者的身份;Access Key Secret 是用于加密签名字符串和服务器端验证签名字符串的密钥,必须严格保密,只有阿里云和用户知道。
重要 阿里云提供了多种语言的 SDK 及第三方 SDK,可以免去您对签名算法进行编码的麻烦。您可以从阿里云开发工具包了解更多阿里云 SDK 的信息。

签名操作

您在访问时,请按照如下步骤对请求进行签名处理:
  1. 使用请求参数构造规范化的请求字符串(Canonicalized Query String)。
    1. 参数排序

      按照参数名称的字典顺序对请求中所有的请求参数(包括“公共请求参数”和接口的自定义参数,但不能包括“公共请求参数”中提到的 Signature 参数本身)进行排序。

      重要 当使用 GET 方法提交请求时,这些参数就是请求 URI 中的参数部分(即 URI 中“?”之后由“&”连接的部分)。
    2. 参数编码
      对排序之后的请求参数的名称和值分别用 UTF-8 字符集进行 URL 编码。编码的规则如下:
      • 对于字符 A-Z、a-z、0-9 以及字符“-”、“_”、“.”、“~”不编码;

      • 对于其他字符编码成 “%XY” 的格式,其中 XY 是字符对应 ASCII 码的 16 进制表示。例如英文的双引号(”)对应的编码就是 %22;

      • 对于扩展的 UTF-8 字符,编码成 “%XY%ZA…” 的格式;

      • 英文空格( )要被编码是 %20,而不是加号(+);

      重要 该编码方式和一般采用的 application/x-www-form-urlencoded MIME 格式编码算法(例如 Java 标准库中的 java.net.URLEncoder 的实现)相似,但又有所不同。实现时,可以先用标准库的方式进行编码,然后把编码后的字符串中加号(+)替换成 %20、星号(*)替换成 %2A、%7E 替换回波浪号(~),即可得到上述规则描述的编码字符串。这个算法可以用下面的 percentEncode 方法来实现:
      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. 将等号连接得到的参数组合按步骤(a)排好的顺序依次使用&符号连接,即得到规范化请求字符串。
  2. 将步骤 1 中构造的规范化字符串按照下面的规则构造成待签名的字符串:
    StringToSign=
      HTTPMethod + “&” +
      percentEncode(“/”) + ”&” +
       percentEncode(CanonicalizedQueryString)
    其中:
    • HTTPMethod 是提交请求用的 HTTP 方法,例如 GET。
    • percentEncode(“/”) 是按照 1.ii 中描述的 URL 编码规则对字符 “/” 进行编码得到的值,即 “%2F”。
    • percentEncode (CanonicalizedQueryString) 是对步骤 1 中构造的规范化请求字符串按 1.ii 中描述的 URL 编码规则编码后得到的字符串。
  3. 按照 RFC2104 的定义,计算待签名字符串 StringToSign 的 HMAC 值。
    重要 计算签名时使用的 Key 就是用户持有的 AccessKey Secret 并加上一个 “&” 字符(ASCII:38),使用的哈希算法是 SHA1。
  4. 按照 Base64 编码规则把上面的 HMAC 值编码成字符串,即得到签名值(Signature)。
  5. 将得到的签名值作为 Signature 参数添加到请求参数中,即完成对请求签名的过程。
    重要 得到的签名值在作为最后的请求参数值提交给 ECS 服务器的时候,要和其他参数一样,按照 RFC3986 的规则进行 URL 编码。

示例

以 DescribeRegions 为例,假设使用的 AccessKey Id 是 testid, AccessKey Secret 是 testsecret。 那么签名前的请求 URL 为:
http://ecs.aliyuncs.com/?TimeStamp=2016-02-23T12:46:24Z&Format=XML&AccessKeyId=testid&Action=DescribeRegions&SignatureMethod=HMAC-SHA1&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&Version=2014-05-26&SignatureVersion=1.0
而计算得到的待签名字符串 StringToSign 为:
GET&%2F&AccessKeyId%3Dtestid&Action%3DDescribeRegions&Format%3DXML&SignatureMethod%3DHMAC-SHA1&SignatureNonce%3D3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&SignatureVersion%3D1.0&TimeStamp%3D2016-02-23T12%253A46%253A24Z&Version%3D2014-05-26

因为AccessKey Secret 是 testsecret,所以用于计算 HMAC 的 Key 为 testsecret&,计算得到的签名值为CT9X0VtwR86fNWSnsc6v8YGOjuE

将签名作为 Signature 参数加入到 URL 请求中, 最后得到的 URL 为:
http://ecs.aliyuncs.com/?SignatureVersion=1.0&Action=DescribeRegions&Format=XML&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&Version=2014-05-26&AccessKeyId=testid&Signature=CT9X0VtwR86fNWSnsc6v8YGOju****&SignatureMethod=HMAC-SHA1&TimeStamp=2016-02-23T12%3A46%3A24Z

JAVA代码示例

以下为签名的JAVA demo供您参考。

  1. 配置文件Config.java。

    /*   
     * Copyright © 2020 Alibaba. All rights reserved.
     */
    package com.aliyun.databricks.demo.sign;
    
    /**
     * 服务端API签名配置文件
     * 
     * @author: ali
     * @version: 0.1 2020-07-16 16:45:54
     */
    public class Config {
    
        // AccessKey信息
        public static String accessKey = "1234567890123456";
        public static String accessKeySecret = "123456789012345678901234567890";
    
        public final static String CHARSET_UTF8 = "utf8";
    }
  2. 配置文件UrlUtil.java。

    /*   
     * Copyright © 2020 Alibaba. All rights reserved.
     */
    package com.aliyun.databricks.demo.sign;
    
    import java.net.URLEncoder;
    import java.util.Map;
    
    import org.apache.commons.lang3.StringUtils;
    
    /**
     * URL处理类
     * 
     * @author: ali
     * @version: 0.1 2020-07-16 16:45:54
     */
    public class UrlUtil {
    
        private final static String CHARSET_UTF8 = "utf8";
    
        public static String urlEncode(String url) {
            if (!StringUtils.isEmpty(url)) {
                try {
                    url = URLEncoder.encode(url, "UTF-8");
                } catch (Exception e) {
                    System.out.println("Url encode error:" + e.getMessage());
                }
            }
            return url;
        }
    
        public static String generateQueryString(Map<String, String> params, boolean isEncodeKV) {
            StringBuilder canonicalizedQueryString = new StringBuilder();
            for (Map.Entry<String, String> entry : params.entrySet()) {
                if (isEncodeKV)
                    canonicalizedQueryString.append(percentEncode(entry.getKey())).append("=")
                            .append(percentEncode(entry.getValue())).append("&");
                else
                    canonicalizedQueryString.append(entry.getKey()).append("=").append(entry.getValue()).append("&");
            }
            if (canonicalizedQueryString.length() > 1) {
                canonicalizedQueryString.setLength(canonicalizedQueryString.length() - 1);
            }
            return canonicalizedQueryString.toString();
        }
    
        public static String percentEncode(String value) {
            try {
                // 使用URLEncoder.encode编码后,将"+","*","%7E"做替换即满足API规定的编码规范
                return value == null ? null
                        : URLEncoder.encode(value, CHARSET_UTF8).replace("+", "%20").replace("*", "%2A").replace("%7E",
                                "~");
            } catch (Exception e) {
    
            }
            return "";
        }
    }
  3. 配置文件SignatureUtils.java。

    /*   
     * Copyright © 2020 Alibaba. All rights reserved.
     */
    package com.aliyun.databricks.demo.sign;
    
    import java.io.IOException;
    import java.io.UnsupportedEncodingException;
    import java.net.URI;
    import java.net.URISyntaxException;
    import java.net.URLDecoder;
    import java.net.URLEncoder;
    import java.util.Map;
    import java.util.TreeMap;
    
    import javax.crypto.Mac;
    import javax.crypto.spec.SecretKeySpec;
    
    import org.apache.commons.codec.binary.Base64;
    import org.apache.commons.lang3.StringUtils;
    
    /**
     * 服务端API签名
     * 
     * @author: ali
     * @version: 0.1 2020-07-16 16:45:54
     */
    public class SignatureUtils {
    
        private final static String CHARSET_UTF8 = "utf8";
        private final static String ALGORITHM = "UTF-8";
        private final static String SEPARATOR = "&";
    
        public static Map<String, String> splitQueryString(String url)
                throws URISyntaxException, UnsupportedEncodingException {
            URI uri = new URI(url);
            String query = uri.getQuery();
            final String[] pairs = query.split("&");
            TreeMap<String, String> queryMap = new TreeMap<String, String>();
            for (String pair : pairs) {
                final int idx = pair.indexOf("=");
                final String key = idx > 0 ? pair.substring(0, idx) : pair;
                if (!queryMap.containsKey(key)) {
                    queryMap.put(key, URLDecoder.decode(pair.substring(idx + 1), CHARSET_UTF8));
                }
            }
            return queryMap;
        }
    
        public static String generate(String method, Map<String, String> parameter, String accessKeySecret)
                throws Exception {
            String signString = generateSignString(method, parameter);
            System.out.println("signString---" + signString);
            byte[] signBytes = hmacSHA1Signature(accessKeySecret + "&", signString);
            String signature = newStringByBase64(signBytes);
            System.out.println("signature----" + signature);
            if ("POST".equals(method))
                return signature;
            return URLEncoder.encode(signature, "UTF-8");
        }
    
        public static String generateSignString(String httpMethod, Map<String, String> parameter) throws IOException {
            TreeMap<String, String> sortParameter = new TreeMap<String, String>();
            sortParameter.putAll(parameter);
            String canonicalizedQueryString = UrlUtil.generateQueryString(sortParameter, true);
            if (null == httpMethod) {
                throw new RuntimeException("httpMethod can not be empty");
            }
            StringBuilder stringToSign = new StringBuilder();
            stringToSign.append(httpMethod).append(SEPARATOR);
            stringToSign.append(percentEncode("/")).append(SEPARATOR);
            stringToSign.append(percentEncode(canonicalizedQueryString));
            return stringToSign.toString();
        }
    
        public static String percentEncode(String value) {
            try {
                return value == null ? null
                        : URLEncoder.encode(value, CHARSET_UTF8).replace("+", "%20").replace("*", "%2A").replace("%7E",
                                "~");
            } catch (Exception e) {
            }
            return "";
        }
    
        public static byte[] hmacSHA1Signature(String secret, String baseString) throws Exception {
            if (StringUtils.isEmpty(secret)) {
                throw new IOException("secret can not be empty");
            }
            if (StringUtils.isEmpty(baseString)) {
                return null;
            }
            Mac mac = Mac.getInstance("HmacSHA1");
            SecretKeySpec keySpec = new SecretKeySpec(secret.getBytes(CHARSET_UTF8), ALGORITHM);
            mac.init(keySpec);
            return mac.doFinal(baseString.getBytes(CHARSET_UTF8));
        }
    
        public static String newStringByBase64(byte[] bytes) throws UnsupportedEncodingException {
            if (bytes == null || bytes.length == 0) {
                return null;
            }
            return new String(Base64.encodeBase64(bytes, false), CHARSET_UTF8);
        }
    }
  4. 配置主入口文件Main.java。

    /*
     * Copyright © 2018 Alibaba. All rights reserved. 
     */
    package com.aliyun.databricks.demo.sign;
    
    import java.io.UnsupportedEncodingException;
    import java.net.URLEncoder;import java.util.HashMap;
    import java.util.Map;
    
    /**
     * 签名工具主入口
     *
     * @author: ali
     * @version: 0.1 2020-07-16 16:45:54
     */
    
    public class Main {
        // 1.需求修改Config.java中的AccessKey信息
        // 2.建议使用方法二,所有参数都需要一一填写
        // 3."最终signature"才是你需要的签名最终结果
        public static void main(String[] args) throws UnsupportedEncodingException {
            // 方法一
            System.out.println("方法一:");
            String str = "GET&%2F&AccessKeyId%3D"
                 + Config.accessKey
                 + "%26Action%3DDescribeFlowProject%26Format"
                 + "%3DJSON%26ProjectId%3D1533023037%26RegionId%3Dcn-hangzhou%26SignatureMethod%3DHMAC-SHA1"
                 + "%26SignatureNonce%3D1533023037%26SignatureVersion%3D1"
                 + ".0%26Timestamp%3D2020-07-16T07%253A43%253A57Z%26Version%3D2020-06-17";
            byte[] signBytes;
            try {
                signBytes = SignatureUtils.hmacSHA1Signature(Config.accessKeySecret + "&", str.toString());
                String signature = SignatureUtils.newStringByBase64(signBytes);
                System.out.println("signString---" + str);
                System.out.println("signature----" + signature);
                System.out.println("最终signature:" + URLEncoder.encode(signature, Config.CHARSET_UTF8));
            } catch (Exception e) {
                e.printStackTrace();
            }
            System.out.println();
            
            // 方法二
            System.out.println("方法二:");
            Map<String, String> map = new HashMap<String, String>();
            // 公共参数
            map.put("Format", "JSON");
            map.put("Version", "2020-06-17");
            map.put("AccessKeyId", Config.accessKey);
            map.put("SignatureMethod", "HMAC-SHA1");
            map.put("Timestamp", "2020-07-16T07:43:57Z");
            map.put("SignatureVersion", "1.0");
    
            map.put("SignatureNonce", "1533023037");
            map.put("RegionId", "cn-hangzhou");
            // 请求参数
            map.put("Action", "DescribeFlowProject");
            map.put("ProjectId", "1533023037");
            try {
                String signature = SignatureUtils.generate("GET", map, Config.accessKeySecret);
                System.out.println("最终signature:" + signature);
            } catch (Exception e) {
                e.printStackTrace();
            }
            System.out.println();
        }
    }