签名方法

最近更新时间:2018-12-17 10:32:28

腾讯云 API 会对每个访问的请求进行身份验证,即每个请求都需要在公共请求参数中包含签名信息(Signature)以验证用户身份。签名信息由用户所执有的安全凭证生成,安全凭证包括 SecretId 和 SecretKey,若用户还没有安全凭证,则需要在腾讯云官网上自主申请,否则就无法调用云 API 接口。

1. 申请安全凭证

在第一次使用云 API 之前,用户需要在腾讯云 CVM 控制台上申请安全凭证。
安全凭证包括 SecretId 和 SecretKey,其中:

  • SecretId:用于标识 API 调用者身份。
  • SecretKey:用于加密签名字符串和服务器端验证签名字符串的密钥。

注意:

API 密钥是构建腾讯云 API 请求的重要凭证,使用腾讯云 API 可以操作您名下的所有腾讯云资源,为了您的财产和服务安全,请妥善保存和定期更换密钥,当您更换密钥后,请及时删除旧密钥。

申请安全凭证的具体步骤如下:

  1. 登录 腾讯云管理中心控制台
  2. 单击【云产品】,选择【监控与管理】栏下的【云API密钥】,进入云 API 密钥管理页面。
  3. 云 API 访问密钥管理 页面,单击【新建】即可以创建一对 SecretId/SecretKey。

    注意:

    • 开发商帐号最多可以拥有两对 SecretId/SecretKey。
    • 被开发商添加为子用户的 QQ 帐号,在不同开发商控制台,可以申请不同的安全凭证。
    • 子用户的安全凭证,目前仅可调用部分接口的云 API。

2. 生成签名串

有了安全凭证 SecretId 和 SecretKey 后,就可以生成签名串了。下面给出了一个生成签名串的详细过程。

假设用户的 SecretId 和 SecretKey 分别是:

  • SecretId:AKIDz8krbsJ5yKBZQpn74WFkmLPx3gnPhESA
  • SecretKey:Gu5t9xGARNpq86cd98joQYCN3Cozk1qA

注意:

这里只是示例,请用户根据自己实际的 SecretId 和 SecretKey 进行后续操作。

查看实例列表 (DescribeInstances)请求为例,当用户调用这一接口时,其请求参数可能如下:

参数名称 中文 参数值
Action 方法名 DescribeInstances
SecretId 密钥Id AKIDz8krbsJ5yKBZQpn74WFkmLPx3EXAMPLE
Timestamp 当前时间戳 1465185768
Nonce 随机正整数 11886
Region 实例所在区域 ap-guangzhou
InstanceIds.0 待查询的实例ID ins-09dx96dg
Offset 偏移量 0
Limit 最大允许输出 20
Version 接口版本号 2017-03-12

2.1. 对参数排序

首先对所有请求参数按参数名的字典序( ASCII 码)升序排序。

注意:

  • 只按参数名进行排序,参数值保持对应即可,不参与比大小。
  • 按 ASCII 码比大小,如 InstanceIds.2 要排在 InstanceIds.12 后面,不是按字母表,也不是按数值。

用户可以借助编程语言中的相关排序函数来实现这一功能,如 php 中的 ksort 函数。上述示例参数的排序结果如下:

{
    'Action' : 'DescribeInstances',
    'InstanceIds.0' : 'ins-09dx96dg',
    'Limit' : 20,
    'Nonce' : 11886,
    'Offset' : 0,
    'Region' : 'ap-guangzhou',
    'SecretId' : 'AKIDz8krbsJ5yKBZQpn74WFkmLPx3EXAMPLE',
    'Timestamp' : 1465185768,
    'Version': '2017-03-12',
}

使用其它程序设计语言开发时,可对上面示例中的参数进行排序,得到的结果一致即可。

2.2. 拼接请求字符串

此步骤生成请求字符串。

  1. 将上一步排序好的请求参数格式化成 “参数名称”=“参数值” 的形式。例如,对 Action 参数,其参数名称为 "Action",参数值为 "DescribeInstances",格式化后即为 Action=DescribeInstances。

    注意:

    • “参数值” 为原始值而非 URL 编码后的值。
    • 若输入参数中包含下划线,则需要将其转换为 “.”。
  2. 将格式化后的各个参数用 "&" 拼接在一起,生成以下请求字符串:
    Action=DescribeInstances&Nonce=11886&Region=gz&SecretId=AKIDz8krbsJ5yKBZQpn74WFkmLPx3gnPhESA&Timestamp=1465185768&instanceIds.0=ins-09dx96dg&limit=20&offset=0

2.3. 拼接签名原文字符串

此步骤生成签名原文字符串。
签名原文字符串由以下几个参数构成:

  • 请求方法:支持 POST 和 GET 方式,这里使用 GET 请求,注意方法为全大写。
  • 请求主机:查看实例列表(DescribeInstances)的请求域名为:cvm.api.qcloud.com。实际的请求域名根据接口所属模块的不同而不同,详见各接口说明。
  • 请求路径:云API的请求路径固定为 /v2/index.php。
  • 请求字符串:即上一步生成的请求字符串。

签名原文串的拼接规则为:
请求方法 + 请求主机 +请求路径 + ? + 请求字符串

示例的拼接结果为:

GETcvm.api.qcloud.com/v2/index.php?Action=DescribeInstances&Nonce=11886&Region=gz&SecretId=AKIDz8krbsJ5yKBZQpn74WFkmLPx3gnPhESA&Timestamp=1465185768&instanceIds.0=ins-09dx96dg&limit=20&offset=0

2.4. 生成签名串

此步骤生成签名串。
首先使用 HMAC-SHA1 算法对上一步中获得的签名原文字符串进行签名,然后将生成的签名串使用 Base64 进行编码,即可获得最终的签名串。

具体代码如下,以 PHP 语言为例:

$secretKey = 'Gu5t9xGARNpq86cd98joQYCN3Cozk1qA';
$srcStr = 'GETcvm.api.qcloud.com/v2/index.php?Action=DescribeInstances&Nonce=11886&Region=gz&SecretId=AKIDz8krbsJ5yKBZQpn74WFkmLPx3gnPhESA&Timestamp=1465185768&instanceIds.0=ins-09dx96dg&limit=20&offset=0';
$signStr = base64_encode(hash_hmac('sha1', $srcStr, $secretKey, true));
echo $signStr;

最终得到的签名串为:

NSI3UqqD99b/UJb4tbG/xZpRW64=

使用其它程序设计语言开发时,可用上面示例中的原文进行签名验证,得到的签名串与例子中的一致即可。

3. 签名串编码

生成的签名串并不能直接作为请求参数,需要对其进行 URL 编码。
如上一步生成的签名串为 NSI3UqqD99b/UJb4tbG/xZpRW64=,则其编码后为 NSI3UqqD99b%2FUJb4tbG%2FxZpRW64%3D。因此,最终得到的签名串请求参数(Signature)为:NSI3UqqD99b%2FUJb4tbG%2FxZpRW64%3D,它将用于生成最终的请求 URL。

注意:

如果用户的请求方法是 GET,则对所有请求参数值均需要做 URL 编码。部分语言库会自动对 URL 进行编码,重复编码会导致签名校验失败。

4. 鉴权失败

当鉴权不通过时,可能出现的错误如下表:

错误代码 错误类型 错误描述
4100 鉴权失败 签名验证失败,请确保您请求参数中的 Signature 计算正确;也可能是密钥状态有误,请确保 API 密钥有效且未被禁用。
4101 未被开发商授权访问本接口 该子用户未被授权调用此接口。请联系开发商授权,详情请查阅 授权策略
4102 未被开发商授权访问本接口中所操作的资源 请问的资源参数中,存在未被开发商授权授权访问的资源,请在 message 字段中查看无权查看的资源ID。
请联系开发商授权,详情请查阅 授权策略
4103 非开发商的 SecretId 暂不支持调用本接口 子用户的 SecretID 不支持调用此接口,只有开发商有权调用。

如果有其他疑问,您也可以在问答社区中寻求帮助。前往问答社区 >