物联网平台会对每个接口访问请求的发送者进行身份验证,所以无论使用HTTP还是HTTPS协议提交请求,都需要在请求中包含签名(Signature)信息。

签名方法

签名时,您需在控制台 Access Key 管理 页面查看您的阿里云账号的 AccessKeyId 和 AccessKeySecret,然后进行对称加密。其中,AccessKeyId 用于标识访问者身份;AccessKeySecret 是用于加密签名字符串和服务器端验证签名字符串的密钥,必须严格保密。

说明 物联网平台提供了Java、Python、PHP等语言的服务端SDK。使用我们提供的SDK,可以免去签名过程。请参见SDK下载及各SDK的使用说明。

请按照下面的方法对请求进行签名:

  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-urlencoded MIME格式编码算法相似,但又有所不同。

      如果您使用的是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. 使用与号&连接编码后的请求参数。参数排序与步骤 a 的排序一致。

    完成后,即获得规范化请求字符串(CanonicalizedQueryString)。

  2. 构造签名字符串。

    可以使用 percentEncode 处理步骤 1 得到的规范化字符串,构造签名字符串。可参考如下规则:

    StringToSign=
      HTTPMethod + "&" + //HTTPMethod:发送请求的 HTTP 方法,例如 GET。
      percentEncode("/") + "&" + //percentEncode("/"):字符(/)UTF-8 编码得到的值,即 %2F。
      percentEncode(CanonicalizedQueryString) //您的规范化请求字符串。
  3. 计算 HMAC 值。

    按照 RFC2104 的定义,使用步骤 2 得到的字符串StringToSign计算签名 HMAC 值。示例使用的是Java Base64编码方法。

    Signature = Base64( HMAC-SHA1( AccessSecret, UTF-8-Encoding-Of(StringToSign) ) )
    说明 计算签名时,使用的 Key 就是您的 AccessKeySecret 并加上一个与号 &字符(ASCII:38)。使用的哈希算法是 SHA1。
  4. 计算签名值。

    按照 Base64 编码规则把步骤 3 中的 HMAC 值编码成字符串,即得到签名值(Signature)。

  5. 添加签名。

    将得到的签名值作为 Signature 参数,按照 RFC3986 的规则进行 URL 编码后,再添加到请求参数中,即完成对请求签名的过程。

签名示例

以调用Pub接口为例。假设您的AccessKeyId=testidAccessKeySecret=testsecret

  1. 签名前的请求URL:
    http://iot.cn-shanghai.aliyuncs.com/?MessageContent=aGVsbG93b3JsZA%3D&Action=Pub&Timestamp=2017-10-02T09%3A39%3A41Z&SignatureVersion=1.0&ServiceCode=iot&Format=XML&Qos=0&SignatureNonce=0715a395-aedf-4a41-bab7-746b43d38d88&Version=2017-04-20&AccessKeyId=testid&SignatureMethod=HMAC-SHA1&RegionId=cn-shanghai&ProductKey=12345abcdeZ&TopicFullName=%2FproductKey%2Ftestdevice%2Fget
  2. 计算得到的待签名字符串StringToSign
    GET&%2F&AccessKeyId%3Dtestid%26Action%3DPub%26Format%3DXML%26MessageContent%3DaGVsbG93b3JsZA%253D%26ProductKey%3D12345abcdeZ%26Qos%3D0%26RegionId%3Dcn-shanghai%26ServiceCode%3Diot%26SignatureMethod%3DHMAC-SHA1%26SignatureNonce%3D0715a395-aedf-4a41-bab7-746b43d38d88%26SignatureVersion%3D1.0%26Timestamp%3D2017-10-02T09%253A39%253A41Z%26TopicFullName%3D%252FproductKey%252Ftestdevice%252Fget%26Version%3D2017-04-20
  3. 计算签名值。

    因为AccessKeySecret=testsecret,用于计算的Key为testsecret&,计算得到的签名值为:

    Y9eWn4nF8QPh3c4zAFkM/k/u7eA=
  4. 将签名作为Signature参数加入到URL请求中,最后得到的URL为:
    http://iot.cn-shanghai.aliyuncs.com/?MessageContent=aGVsbG93b3JsZA%3D&Action=Pub&Timestamp=2017-10-02T09%3A39%3A41Z&SignatureVersion=1.0&ServiceCode=iot&Format=XML&Qos=0&SignatureNonce=0715a395-aedf-4a41-bab7-746b43d38d88&Version=2017-04-20&AccessKeyId=testid&Signature=Y9eWn4nF8QPh3c4zAFkM%2Fk%2Fu7eA%3D&SignatureMethod=HMAC-SHA1&RegionId=cn-shanghai&ProductKey=12345abcdeZ&TopicFullName=%2FproductKey%2Ftestdevice%2Fget

JAVA代码示例

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

  1. 配置文件 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 = "1234567890123456";
    	public static String accessKeySecret = "123456789012345678901234567890";
    
    	public final static String CHARSET_UTF8 = "utf8";
    }
  2. 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 "";
    	}
    }
  3. 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 = "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.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();
    	}
    }