AsymmetricSign - 非对称密钥签名--密钥管理系统-火山引擎

文档中心

立即注册

导航

AsymmetricSign - 非对称密钥签名

最近更新时间：2024.08.29 17:28:57首次发布时间：2024.08.29 17:28:57

非对称密钥签名

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	AsymmetricSign	要执行的操作，取值：AsymmetricSign。
Version	String	是	2021-02-18	API的版本，取值：2021-02-18。
KeyringName	String	否	keyring-test	密钥环名称，长度为 2 - 31 个字符。合法字符：[a-zA-Z0-9-_]
KeyName	String	否	key-test	主密钥名称，长度为 2 - 31 个字符。合法字符：[a-zA-Z0-9-_]
KeyID	String	否	39a0e7c6-b7dd-4c83-b400-3449bb95403a	主密钥ID，二选一： KeyringName 和 KeyName KeyID
Message	String	是	MessageToBeSigned=	签名消息。当MessageType取值为RAW时：如果指定原始签名数据，会使用Algorithm中对应的哈希算法，对原始消息生成摘要，之后再进行签名，取值：[1, 4096] 当MessageType取值为DIGEST时：最大长度为32字节
MessageType	String	否	RAW	消息类型，取值： RAW（默认值）：原始数据 DIGEST：原始数据的消息摘要。KMS不会对原始数据的消息摘要进行数据处理，将直接使用私钥进行签名
Algorithm	String	是	RSA_PSS_SHA_256	签名算法，如下枚举之一 RSA_PSS_SHA_256 RSA_PKCS1_SHA_256 RSA_PSS_SHA_384 RSA_PKCS1_SHA_384 RSA_PSS_SHA_512 RSA_PKCS1_SHA_512 ECDSA_SHA_256 ECDSA_SHA_384 ECDSA_SHA_512 SM2_DSA 签名算法和密钥类型，对应关系

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
KeyID	String	39a0e7c6-b7dd-4c83-b400-3449bb95403a	主密钥唯一标识符，UUID形式
Signature	String	OuodVCE1zYpDFg1QvgOHtVQxkQWhfpE8i8NibiJ1pL8ILgAE+TogQZuIglAoo=	数据签名，Base64编码

请求示例

POST /?Action=AsymmetricSign&Version=2021-02-18&KeyringName=demo&KeyName=demo&MessageType=RAW&Algorithm=RSA_PSS_SHA_256 HTTP/1.1
Host: kms.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240708T150011Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240708/cn-beijing/kms/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "Message": "MessageToBeSigned="
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202407082300591051190940398C67B7",
    "Action": "AsymmetricSign",
    "Version": "2021-02-18",
    "Service": "kms",
    "Region": "cn-beijing"
  },
  "Result": {
    "KeyID": "39a0e7c6-b7dd-4c83-b400-3449bb95403a",
    "Signature": "OuodVCE1zYpDFg1QvgOHtVQxkQWhfpE8i8NibiJ1pL8ILgAE+TogQZuIglAoo="
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息
400	MissingParameter	The request is missing %s parameter.
400	InvalidParameter	The request parameter %s is invalid.
400	InvalidKeyStatus	Current key status: %s does not allow to perform this action
400	InvalidKeyUsage	Current key usage only allows: %s. Please use different keys for encryption/decryption and signing/verification.
403	AccessDenied	User is not authorized to do this action
403	Reject.Throttling.CMK	The request of CMK: %s upper limit is exceeded.
403	KeyMaterialExpire	Key expire in, %s
404	Not Found	Not found %s [%s].
500	UndefinedError	Undefined Internal Error. Pls Contact With Admin.