物联网平台会对每个接口访问请求的发送者进行身份验证,所以无论使用HTTP还是HTTPS协议提交请求,都需要在请求中包含签名(Signature)信息。
签名方法
签名时,您需在控制台AccessKey管理页面查看您的阿里云账号的AccessKey ID和AccessKey Secret,然后生成签名验证码(MAC)。其中,AccessKey ID用于标识访问者身份;AccessKey Secret是用于加密签名字符串和服务器端验证签名字符串的密钥,必须严格保密。
物联网平台提供了Java、Python、PHP等语言的服务端SDK。使用这些SDK,可以免去签名过程。各SDK的使用说明,请参见云端SDK(原版)、云端SDK(升级版)。
请按照下面的方法对请求进行签名处理:
使用请求参数构造规范化的请求字符串(Canonicalized Query String)。
排序参数。
按照参数名称的字典顺序,对请求参数(包括公共请求参数和接口的自定义参数,但不能包括“公共请求参数”的Signature参数本身)进行排序。
当使用GET方法提交请求时,这些参数就是请求URL中的参数部分,即URL中
?
之后由&
连接的部分。对每个请求参数的名称和值进行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; }
对编码后的参数名称和值使用英文等号(=)进行连接。
把英文等号连接得到的字符串按参数名称的字典顺序依次使用
&
符号连接。
完成后,即得到规范化请求字符串(CanonicalizedQueryString)。
构造签名字符串。
使用
percentEncode
处理步骤1得到的规范化字符串,构造用于计算签名的字符串。可参考如下规则:StringToSign= HTTPMethod + "&" + percentEncode("/") + "&" + percentEncode(CanonicalizedQueryString)
参数说明:
HTTPMethod:发送请求的HTTP方法,例如GET。
percentEncode("/"):字符“/”进行UTF-8编码得到的值,即“%2F”。
percentEncode(CanonicalizedQueryString):您的规范化请求字符串。
计算HMAC值。
按照RFC2104的定义,使用步骤2得到的字符串
StringToSign
计算签名HMAC值。HMAC-SHA1( AccessSecret, UTF-8-Encoding-Of(StringToSign) )
计算签名时使用的Key就是您的AccessKeySecret并加上一个与号
&
字符(ASCII:38),使用的哈希算法是SHA1。计算签名值。
按照Base64编码规则把步骤3中的HMAC值编码成字符串,即得到签名值(Signature)。
Signature = Base64( HMAC-SHA1( AccessSecret, UTF-8-Encoding-Of(StringToSign) ) )
添加签名。
将得到的签名值作为Signature参数,按照RFC3986的规则进行URL编码后,再添加到请求参数中,即完成对请求签名的过程。
签名示例
以调用Pub接口为例。假设您的AccessKeyId=testid
,AccessKeySecret=testsecret
,ProductKey=12345abcde
、TopicFullName=/12345abcde/testdevice/user/get
、MessageContent=aGVsbG8gd29ybGQ
、Qos=0
。
组成签名前的请求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
计算得到待签名字符串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
计算签名值。
因为
AccessKeySecret=testsecret
,用于计算的Key为testsecret&,计算得到的签名值为:NUh3otvAoXOZmG/a2gDShh6Ze9w=
将签名作为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供您参考。
添加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>
配置文件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
配置文件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 ""; } }
配置文件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); } }
配置主入口文件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(); } }
- 本页导读 (1)
- 签名方法
- 签名示例
- Java代码示例