全部产品
Search

搜索本产品

    密钥管理服务：AsymmetricSign

    文档中心

    密钥管理服务：AsymmetricSign

    更新时间：Aug 27, 2024

    调用AsymmetricSign接口使用非对称密钥进行签名。

    注意事项

    • 非KMS实例中的密钥：进行密码运算时，仅支持通过阿里云SDK调用OpenAPI。
    • KMS实例中的密钥：进行密码运算时，支持如下两种方式。

    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椭圆曲线数字签名算法

    说明 按照国家标准GB/T 32918.2《信息安全技术 SM2 椭圆曲线公钥密码算法 第2部分：数字签名算法》，计算SM2签名值时，Digest参数不是对原始消息直接计算SM3摘要，而是对Z(A)和M的拼接值计算的摘要，其中M是待签名的原始消息，Z(A)是GB/T 32918.2中定义的用户A的杂凑值。

    本文将提供一个示例，使用密钥ID为5c438b18-05be-40ad-b6c2-3be6752c****、密钥版本ID为2ab1a983-7072-4bbc-a582-584b5bd8****的非对称密钥，通过签名算法RSA_PSS_SHA_256对摘要信息ZOyIygCyaOW6GjVnihtTFtIS9PNmskdyMlNKiuy****=进行签名。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    请求参数

    名称

    类型

    是否必选

    示例值

    描述
    Action String 是 AsymmetricSign

    要执行的操作。取值：AsymmetricSign。
    KeyId String 是 5c438b18-05be-40ad-b6c2-3be6752c****

    主密钥（CMK）的全局唯一标识符。

    说明 该参数也可以被指定为主密钥绑定的别名。更多信息，请参见别名使用说明。
    KeyVersionId String 是 2ab1a983-7072-4bbc-a582-584b5bd8****

    密钥版本ID。密钥版本的全局唯一标识符。
    Algorithm String 是 RSA_PSS_SHA_256

    签名算法。
    Digest String 是 ZOyIygCyaOW6GjVnihtTFtIS9PNmskdyMlNKiu****=

    使用Algorithm中对应的哈希算法，对原始消息生成的摘要。

    说明
    • 使用Base64编码。
    • 关于如何计算消息摘要，请参见非对称数字签名的签名预处理：计算消息摘要章节。
    DryRun String 否 false

    是否开启DryRun模式。

    • true：开启
    • false（默认值）：关闭

    DryRun模式用于测试API调用，验证您是否具有相应资源的权限，以及请求参数是否配置正确。DryRun模式开启后，KMS会始终返回失败并提示失败原因。失败原因包含如下：

    • DryRunOperationError：不配置DryRun参数时，请求会成功。
    • ValidationError：请求中指定的参数有误。
    • AccessDeniedError：您无权在KMS资源上执行该操作。

    返回数据

    名称

    类型

    示例值

    描述
    KeyVersionId String 2ab1a983-7072-4bbc-a582-584b5bd8****

    密钥版本ID。密钥版本的全局唯一标识符。
    KeyId String 5c438b18-05be-40ad-b6c2-3be6752c****

    主密钥的全局唯一标识符。

    说明 如果请求中的KeyId参数使用的是主密钥的别名，在响应中会返回别名对应的主密钥标识符。
    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
&公共请求参数

    正常返回示例

    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. 参数非法。
    404 Forbidden.KeyNotFound The specified Key is not found. 指定的密钥不存在。
    404 Forbidden.AliasNotFound The specified Alias is not found. 指定的别名找不到

    访问错误中心查看更多错误码。