調用AsymmetricSign接口使用非對稱密鑰進行簽名。
注意事項
- 非KMS實例中的密鑰:進行密碼運算時,僅支持通過阿里云SDK調用OpenAPI。
- KMS實例中的密鑰:進行密碼運算時,支持如下兩種方式。
- 方式一(推薦):通過KMS實例SDK調用KMS實例API。詳細介紹,請參見KMS實例SDK、KMS實例API。
- 方式二:通過阿里云SDK調用OpenAPI,但認證方式僅支持可信實體為阿里云服務的RAM角色。詳細信息,請參見創(chuàng)建可信實體為阿里云服務的RAM角色。
QPS限制
本接口的單用戶QPS限制為200次/秒。超過限制,API調用將會被限流,這可能影響您的業(yè)務,請合理調用。
詳細說明
僅支持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橢圓曲線數(shù)字簽名算法 |
本文將提供一個示例,使用密鑰ID為5c438b18-05be-40ad-b6c2-3be6752c****
、密鑰版本ID為2ab1a983-7072-4bbc-a582-584b5bd8****
的非對稱密鑰,通過簽名算法RSA_PSS_SHA_256
對摘要信息ZOyIygCyaOW6GjVnihtTFtIS9PNmskdyMlNKiuy****=
進行簽名。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數(shù)
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | AsymmetricSign | 要執(zhí)行的操作。取值:AsymmetricSign。 |
KeyId | String | 是 | 5c438b18-05be-40ad-b6c2-3be6752c**** | 主密鑰(CMK)的全局唯一標識符。 說明 該參數(shù)也可以被指定為主密鑰綁定的別名。更多信息,請參見別名使用說明。 |
KeyVersionId | String | 是 | 2ab1a983-7072-4bbc-a582-584b5bd8**** | 密鑰版本ID。密鑰版本的全局唯一標識符。 |
Algorithm | String | 是 | RSA_PSS_SHA_256 | 簽名算法。 |
Digest | String | 是 | ZOyIygCyaOW6GjVnihtTFtIS9PNmskdyMlNKiu****= | 使用Algorithm中對應的哈希算法,對原始消息生成的摘要。 說明
|
DryRun | String | 否 | false | 是否開啟DryRun模式。
DryRun模式用于測試API調用,驗證您是否具有相應資源的權限,以及請求參數(shù)是否配置正確。DryRun模式開啟后,KMS會始終返回失敗并提示失敗原因。失敗原因包含如下:
|
返回數(shù)據(jù)
名稱 |
類型 |
示例值 |
描述 |
KeyVersionId | String | 2ab1a983-7072-4bbc-a582-584b5bd8**** | 密鑰版本ID。密鑰版本的全局唯一標識符。 |
KeyId | String | 5c438b18-05be-40ad-b6c2-3be6752c**** | 主密鑰的全局唯一標識符。 說明 如果請求中的KeyId參數(shù)使用的是主密鑰的別名,在響應中會返回別名對應的主密鑰標識符。 |
Value | String | M2CceNZH00ZgL9ED/ZHFp21YRAvYeZHknJUc207OCZ0N9wNn9As4z2bON3FF3je+1Nu+2+/8Zj50HpMTpzYpMp2R93cYmACCmhaYoKydxylbyGzJR8y9likZRCrkD38lRoS40aBBvv/6iRKzQuo9EGYVcel36cMNg00VmYNBy3pa1rwg3gA4l3cy6kjayZja1WGPkVhrVKsrJMdbpl0ApLjXKuD8rw1n1XLCwCUEL5eLPljTZaAveqdOFQOiZnZEGI27qIiZe7I1fN8tcz6anS/gTM7xRKE++5egEvRWlTQQTJeApnPSiUPA+8ZykNdelQsOQh5SrGoyI4A5pq****== | 計算出來的簽名。 說明 使用Base64編碼。 |
RequestId | String | 475f1620-b9d3-4d35-b5c6-3fbdd941423d | 本次調用請求的ID,是由阿里云為該請求生成的唯一標識符,可用于排查和定位問題。 |
示例
請求示例
http(s)://[Endpoint]/?Action=AsymmetricSign
&KeyId=5c438b18-05be-40ad-b6c2-3be6752c****
&KeyVersionId=2ab1a983-7072-4bbc-a582-584b5bd8****
&Algorithm=RSA_PSS_SHA_256
&Digest=ZOyIygCyaOW6GjVnihtTFtIS9PNmskdyMlNKiu****=
&DryRun=false
&公共請求參數(shù)
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<AsymmetricSignResponse>
<KeyVersionId>2ab1a983-7072-4bbc-a582-584b5bd8****</KeyVersionId>
<KeyId>5c438b18-05be-40ad-b6c2-3be6752c****</KeyId>
<Value>M2CceNZH00ZgL9ED/ZHFp21YRAvYeZHknJUc207OCZ0N9wNn9As4z2bON3FF3je+1Nu+2+/8Zj50HpMTpzYpMp2R93cYmACCmhaYoKydxylbyGzJR8y9likZRCrkD38lRoS40aBBvv/6iRKzQuo9EGYVcel36cMNg00VmYNBy3pa1rwg3gA4l3cy6kjayZja1WGPkVhrVKsrJMdbpl0ApLjXKuD8rw1n1XLCwCUEL5eLPljTZaAveqdOFQOiZnZEGI27qIiZe7I1fN8tcz6anS/gTM7xRKE++5egEvRWlTQQTJeApnPSiUPA+8ZykNdelQsOQh5SrGoyI4A5pq****==</Value>
<RequestId>475f1620-b9d3-4d35-b5c6-3fbdd941423d</RequestId>
</AsymmetricSignResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"KeyVersionId" : "2ab1a983-7072-4bbc-a582-584b5bd8****",
"KeyId" : "5c438b18-05be-40ad-b6c2-3be6752c****",
"Value" : "M2CceNZH00ZgL9ED/ZHFp21YRAvYeZHknJUc207OCZ0N9wNn9As4z2bON3FF3je+1Nu+2+/8Zj50HpMTpzYpMp2R93cYmACCmhaYoKydxylbyGzJR8y9likZRCrkD38lRoS40aBBvv/6iRKzQuo9EGYVcel36cMNg00VmYNBy3pa1rwg3gA4l3cy6kjayZja1WGPkVhrVKsrJMdbpl0ApLjXKuD8rw1n1XLCwCUEL5eLPljTZaAveqdOFQOiZnZEGI27qIiZe7I1fN8tcz6anS/gTM7xRKE++5egEvRWlTQQTJeApnPSiUPA+8ZykNdelQsOQh5SrGoyI4A5pq****==",
"RequestId" : "475f1620-b9d3-4d35-b5c6-3fbdd941423d"
}
錯誤碼
HttpCode |
錯誤碼 |
錯誤信息 |
描述 |
400 | InvalidParameter | The specified parameter is not valid. | 參數(shù)非法。 |
404 | Forbidden.KeyNotFound | The specified Key is not found. | 指定的密鑰不存在。 |
404 | Forbidden.AliasNotFound | The specified Alias is not found. | 指定的別名找不到 |
訪問錯誤中心查看更多錯誤碼。