调用AsymmetricVerify接口使用非对称密钥进行验签。
注意事项
- 非KMS实例中的密钥:进行密码运算时,仅支持通过阿里云SDK调用OpenAPI。
- KMS实例中的密钥:进行密码运算时,支持如下两种方式。
- 方式一(推荐):通过KMS实例SDK调用KMS实例API。详细介绍,请参见KMS实例SDK、KMS实例API。
- 方式二:通过阿里云SDK调用OpenAPI,但认证方式仅支持可信实体为阿里云服务的RAM角色。详细信息,请参见创建可信实体为阿里云服务的RAM角色。
QPS限制
本接口的单用户QPS限制为200次/秒。超过限制,API调用将会被限流,这可能影响您的业务,请合理调用。
详细说明
仅支持Usage为SIGN/VERIFY的非对称密钥。支持的签名算法如下表:
KeySpec |
Algorithm |
说明 |
RSA_2048 |
RSA_PSS_SHA_256 |
RSASSA-PSS using SHA-256 and MGF1 with SHA-256 |
RSA_2048 |
RSA_PKCS1_SHA_256 |
RSASSA-PKCS1-v1_5 using SHA-256 |
RSA_3072 |
RSA_PSS_SHA_256 |
RSASSA-PSS using SHA-256 and MGF1 with SHA-256 |
RSA_3072 |
RSA_PKCS1_SHA_256 |
RSASSA-PKCS1-v1_5 using SHA-256 |
EC_P256 |
ECDSA_SHA_256 |
ECDSA on the P-256 Curve(secp256r1) with a SHA-256 digest |
EC_P256K |
ECDSA_SHA_256 |
ECDSA on the P-256K Curve(secp256k1) with a SHA-256 digest |
EC_SM2 |
SM2DSA |
SM2椭圆曲线数字签名算法 |
本文将提供一个示例,使用密钥ID为5c438b18-05be-40ad-b6c2-3be6752c****
、密钥版本ID为2ab1a983-7072-4bbc-a582-584b5bd8****
的非对称密钥,通过签名算法RSA_PSS_SHA_256对摘要信息ZOyIygCyaOW6GjVnihtTFtIS9PNmskdyMlNKiuyjfzw=
生成的签名值M2CceNZH00ZgL9ED/ZHFp21YRAvYeZHknJUc207OCZ0N9wNn9As4z2bON3FF3je+1Nu+2+/8Zj50HpMTpzYpMp2R93cYmACCmhaYoKydxylbyGzJR8y9likZRCrkD38lRoS40aBBvv/6iRKzQuo9EGYVcel36cMNg00VmYNBy3pa1rwg3gA4l3cy6kjayZja1WGPkVhrVKsrJMdbpl0ApLjXKuD8rw1n1XLCwCUEL5eLPljTZaAveqdOFQOiZnZEGI27qIiZe7I1fN8tcz6anS/gTM7xRKE++5egEvRWlTQQTJeApnPSiUPA+8ZykNdelQsOQh5SrGoyI4A5pq****==
进行验证。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | AsymmetricVerify | 要执行的操作。取值:AsymmetricVerify。 |
KeyId | String | 是 | 5c438b18-05be-40ad-b6c2-3be6752c**** | 主密钥(CMK)的全局唯一标识符。 说明 该参数也可以被指定为主密钥绑定的别名。更多信息,请参加见别名使用说明。 |
KeyVersionId | String | 是 | 2ab1a983-7072-4bbc-a582-584b5bd8**** | 密钥版本ID。密钥版本的全局唯一标识符。 |
Algorithm | String | 是 | RSA_PSS_SHA_256 | 签名算法。 |
Digest | String | 是 | ZOyIygCyaOW6GjVnihtTFtIS9PNmskdyMlNKiuy****= | 使用Algorithm中对应的哈希算法,对原始消息生成的摘要。 说明 使用Base64编码。 |
Value | String | 是 | M2CceNZH00ZgL9ED/ZHFp21YRAvYeZHknJUc207OCZ0N9wNn9As4z2bON3FF3je+1Nu+2+/8Zj50HpMTpzYpMp2R93cYmACCmhaYoKydxylbyGzJR8y9likZRCrkD38lRoS40aBBvv/6iRKzQuo9EGYVcel36cMNg00VmYNBy3pa1rwg3gA4l3cy6kjayZja1WGPkVhrVKsrJMdbpl0ApLjXKuD8rw1n1XLCwCUEL5eLPljTZaAveqdOFQOiZnZEGI27qIiZe7I1fN8tcz6anS/gTM7xRKE++5egEvRWlTQQTJeApnPSiUPA+8ZykNdelQsOQh5SrGoyI4A5pq****== | 待验证的签名值。 说明 使用Base64编码。 |
DryRun | String | 否 | false | 是否开启DryRun模式。
DryRun模式用于测试API调用,验证您是否具有相应资源的权限,以及请求参数是否配置正确。DryRun模式开启后,KMS会始终返回失败并提示失败原因。失败原因包含如下:
|
返回数据
名称 |
类型 |
示例值 |
描述 |
KeyVersionId | String | 2ab1a983-7072-4bbc-a582-584b5bd8**** | 对明文数据进行加密的主密钥版本号。 |
KeyId | String | 5c438b18-05be-40ad-b6c2-3be6752c**** | 主密钥的全局唯一标识符。 说明 如果请求中的KeyId参数使用的是主密钥的别名,在响应中会返回别名对应的主密钥标识符。 |
Value | Boolean | true | 签名验证是否通过。 |
RequestId | String | 475f1620-b9d3-4d35-b5c6-3fbdd941423d | 本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。 |
示例
请求示例
http(s)://[Endpoint]/?Action=AsymmetricVerify
&KeyId=5c438b18-05be-40ad-b6c2-3be6752c****
&KeyVersionId=2ab1a983-7072-4bbc-a582-584b5bd8****
&Algorithm=RSA_PSS_SHA_256
&Digest=ZOyIygCyaOW6GjVnihtTFtIS9PNmskdyMlNKiuy****=
&Value=M2CceNZH00ZgL9ED/ZHFp21YRAvYeZHknJUc207OCZ0N9wNn9As4z2bON3FF3je+1Nu+2+/8Zj50HpMTpzYpMp2R93cYmACCmhaYoKydxylbyGzJR8y9likZRCrkD38lRoS40aBBvv/6iRKzQuo9EGYVcel36cMNg00VmYNBy3pa1rwg3gA4l3cy6kjayZja1WGPkVhrVKsrJMdbpl0ApLjXKuD8rw1n1XLCwCUEL5eLPljTZaAveqdOFQOiZnZEGI27qIiZe7I1fN8tcz6anS/gTM7xRKE++5egEvRWlTQQTJeApnPSiUPA+8ZykNdelQsOQh5SrGoyI4A5pq****==
&DryRun=false
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<AsymmetricVerifyResponse>
<KeyVersionId>2ab1a983-7072-4bbc-a582-584b5bd8****</KeyVersionId>
<KeyId>5c438b18-05be-40ad-b6c2-3be6752c****</KeyId>
<Value>true</Value>
<RequestId>475f1620-b9d3-4d35-b5c6-3fbdd941423d</RequestId>
</AsymmetricVerifyResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"KeyVersionId" : "2ab1a983-7072-4bbc-a582-584b5bd8****",
"KeyId" : "5c438b18-05be-40ad-b6c2-3be6752c****",
"Value" : true,
"RequestId" : "475f1620-b9d3-4d35-b5c6-3fbdd941423d"
}
错误码
HttpCode |
错误码 |
错误信息 |
描述 |
400 | InvalidParameter | The specified parameter is not valid. | 参数非法。 |
404 | Forbidden.AliasNotFound | The specified Alias is not found. | 指定的别名找不到 |
404 | Forbidden.KeyNotFound | The specified Key is not found. | 指定的密钥不存在。 |
访问错误中心查看更多错误码。