簽名方法

簽名時，您需在控制臺AccessKey管理頁面查看您的阿里云賬號的AccessKey ID和AccessKey Secret，然后生成簽名驗證碼（MAC）。其中，AccessKey ID用于標識訪問者身份；AccessKey Secret是用于加密簽名字符串和服務器端驗證簽名字符串的密鑰，必須嚴格保密。

請按照下面的方法對請求進行簽名處理：

1. 使用請求參數構造規范化的請求字符串（Canonicalized Query String）。

   1. 排序參數。

      按照參數名稱的字典順序，對請求參數（包括公共請求參數和接口的自定義參數，但不能包括“公共請求參數”的Signature參數本身）進行排序。

      說明

      當使用GET方法提交請求時，這些參數就是請求URL中的參數部分，即URL中?之后由&連接的部分。

   2. 對每個請求參數的名稱和值進行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;
      }

   3. 對編碼后的參數名稱和值使用英文等號（=）進行連接。

   4. 把英文等號連接得到的字符串按參數名稱的字典順序依次使用&符號連接。

   完成后，即得到規范化請求字符串（CanonicalizedQueryString）。

2. 構造簽名字符串。

   使用percentEncode處理步驟1得到的規范化字符串，構造用于計算簽名的字符串。可參考如下規則：

   StringToSign=
     HTTPMethod + "&" +                      
     percentEncode("/") + "&" +              
     percentEncode(CanonicalizedQueryString)

   參數說明：

   • HTTPMethod：發送請求的HTTP方法，例如GET。

   • percentEncode("/")：字符“/”進行UTF-8編碼得到的值，即“%2F”。

   • percentEncode(CanonicalizedQueryString)：您的規范化請求字符串。

3. 計算HMAC值。

   按照RFC2104的定義，使用步驟2得到的字符串StringToSign計算簽名HMAC值。

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

   重要

   計算簽名時使用的Key就是您的AccessKeySecret并加上一個與號&字符（ASCII:38），使用的哈希算法是SHA1。

4. 計算簽名值。

   按照Base64編碼規則把步驟3中的HMAC值編碼成字符串，即得到簽名值（Signature）。

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

5. 添加簽名。

   將得到的簽名值作為Signature參數，按照RFC3986的規則進行URL編碼后，再添加到請求參數中，即完成對請求簽名的過程。

簽名示例

以調用Pub接口為例。假設您的AccessKeyId=testid，AccessKeySecret=testsecret，ProductKey=12345abcde、TopicFullName=/12345abcde/testdevice/user/get、MessageContent=aGVsbG8gd29ybGQ、Qos=0。

1. 組成簽名前的請求URL。

   http://iot.cn-shanghai.aliyuncs.com/?Action=Pub&MessageContent=aGVsbG8gd29ybGQ&Timestamp=2018-07-31T07:43:57Z&SignatureVersion=1.0&Format=XML&Qos=0&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&Version=2018-01-20&AccessKeyId=testid&SignatureMethod=HMAC-SHA1&RegionId=cn-shanghai&ProductKey=12345abcde&TopicFullName=/12345abcde/testdevice/user/get

2. 計算得到待簽名字符串StringToSign。

   GET&%2F&AccessKeyId%3Dtestid%26Action%3DPub%26Format%3DXML%26MessageContent%3DaGVsbG8gd29ybGQ%26ProductKey%3D12345abcde%26Qos%3D0%26RegionId%3Dcn-shanghai%26SignatureMethod%3DHMAC-SHA1%26SignatureNonce%3D3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf%26SignatureVersion%3D1.0%26Timestamp%3D2018-07-31T07%253A43%253A57Z%26TopicFullName%3D%252F12345abcde%252Ftestdevice%252Fuser%252Fget%26Version%3D2018-01-20

3. 計算簽名值。

   因為AccessKeySecret=testsecret，用于計算的Key為testsecret&，計算得到的簽名值為：

   NUh3otvAoXOZmG/a2gDShh6Ze9w=

4. 將簽名作為Signature參數加入到URL請求中，最后得到的URL為：

   http://iot.cn-shanghai.aliyuncs.com/?MessageContent=aGVsbG8gd29ybGQ&Action=Pub&Timestamp=2018-07-31T07%253A43%253A57Z&SignatureVersion=1.0&Format=XML&Qos=0&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&Version=2018-01-20&AccessKeyId=testid&Signature=NUh3otvAoXOZmG%2Fa2gDShh6Ze9w%3D&SignatureMethod=HMAC-SHA1&RegionId=cn-shanghai&ProductKey=12345abcde&TopicFullName=%2F12345abcde%2Ftestdevice%2Fuser%2Fget

Java代碼示例

以下為簽名的Java Demo供您參考。

1. 添加Maven項目依賴。

   <!-- Apache Commons Lang 3.x -->
   <dependency>
       <groupId>org.apache.commons</groupId>
       <artifactId>commons-lang3</artifactId>
       <version>3.12.0</version> <!-- Use the latest version -->
   </dependency>
   
   <!-- Apache Commons Codec -->
   <dependency>
       <groupId>org.apache.commons</groupId>
       <artifactId>commons-codec</artifactId>
       <version>1.15</version> <!-- Use the latest version -->
   </dependency>

2. 配置文件Config.java。

   /*   
    * Copyright  2018 Alibaba. All rights reserved.
    */
   package com.aliyun.iot.demo.sign;
   
   /**
    * 服務端API簽名配置文件
    * 
    * @author: ali
    * @version: 0.1 2018-08-08 08:23:54
    */
   public class Config {
   
       // AccessKey信息
       public static String accessKey = "123456******3456";
       public static String accessKeySecret = "123456******34567******4567890";
   
       public final static String CHARSET_UTF8 = "utf8";
   }

   參數	示例	說明
   accessKey	123456******3456	登錄物聯網平臺控制臺，將鼠標移至賬號頭像上，然后單擊AccessKey管理，獲取AccessKey ID和AccessKey Secret。 說明 如果使用RAM用戶，您需授予該RAM用戶管理物聯網平臺的權限（AliyunIOTFullAccess），否則將連接失敗。授權方法請參見授權RAM用戶訪問物聯網平臺。
   accessKeySecret	123456******34567******4567890

3. 配置文件UrlUtil.java。

   /*   
    * Copyright  2018 Alibaba. All rights reserved.
    */
   package com.aliyun.iot.demo.sign;
   
   import java.net.URLEncoder;
   import java.util.Map;
   
   import org.apache.commons.lang3.StringUtils;
   
   /**
    * URL處理類
    * 
    * @author: ali
    * @version: 0.1 2018-06-21 20:40:52
    */
   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 "";
       }
   }

4. 配置文件SignatureUtils.java。

   /*   
    * Copyright  2018 Alibaba. All rights reserved.
    */
   package com.aliyun.iot.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 2018-06-21 20:47:05
    */
   public class SignatureUtils {
   
       private final static String CHARSET_UTF8 = "utf8";
       private final static String ALGORITHM = "HmacSHA1";
       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);
       }
   }

5. 配置主入口文件Main.java。

   /*   
    * Copyright  2018 Alibaba. All rights reserved.
    */
   package com.aliyun.iot.demo.sign;
   
   import java.io.UnsupportedEncodingException;
   import java.net.URLEncoder;
   import java.util.HashMap;
   import java.util.Map;
   
   /**
    * 簽名工具主入口
    * 
    * @author: ali
    * @version: 0.1 2018-09-18 15:06:48
    */
   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%3DRegisterDevice%26DeviceName%3D1533023037%26Format%3DJSON%26ProductKey%3DaxxxUtgaRLB%26RegionId%3Dcn-shanghai%26SignatureMethod%3DHMAC-SHA1%26SignatureNonce%3D1533023037%26SignatureVersion%3D1.0%26Timestamp%3D2018-07-31T07%253A43%253A57Z%26Version%3D2018-01-20";
           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", "2018-01-20");
           map.put("AccessKeyId", Config.accessKey);
           map.put("SignatureMethod", "HMAC-SHA1");
           map.put("Timestamp", "2018-07-31T07:43:57Z");
           map.put("SignatureVersion", "1.0");
           map.put("SignatureNonce", "1533023037");
           map.put("RegionId", "cn-shanghai");
           // 請求參數
           map.put("Action", "RegisterDevice");
           map.put("DeviceName", "1533023037");
           map.put("ProductKey", "axxxUtgaRLB");
           try {
               String signature = SignatureUtils.generate("GET", map, Config.accessKeySecret);
               System.out.println("最終signature: " + signature);
           } catch (Exception e) {
               e.printStackTrace();
           }
           System.out.println();
       }
   }