VerifyMac - VerifyMac--密钥管理系统-火山引擎

文档中心

立即注册

导航

VerifyMac - VerifyMac

最近更新时间：2025.01.02 15:14:16首次发布时间：2025.01.02 15:14:16

验证指定消息的基于哈希的消息认证码 (HMAC)、HMAC KMS 密钥和 MAC 算法。

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	VerifyMac	要执行的操作，取值：VerifyMac。
Version	String	是	2021-02-18	API的版本，取值：2021-02-18。
KeyringName	String	否	KeyringName	密钥环名称，长度为 2 - 31 个字符。合法字符：[a-zA-Z0-9-_]
KeyName	String	否	keyName	主密钥名称，长度为 2 - 31 个字符。合法字符：[a-zA-Z0-9-_]
KeyID	String	否	39a0e7c6-b7dd-4c83-b400-3449bb95403a	主密钥ID，二选一： KeyringName 和 KeyName KeyID
Message	String	是	testMessage	签名消息。当MessageType取值为RAW时：如果指定原始签名数据，会使用Algorithm中对应的哈希算法，对原始消息生成摘要，之后再进行签名，取值：[1, 4096] 当MessageType取值为DIGEST时：最大长度为32字节
MacAlgorithm	String	是	HMAC_SHA_256	MacAlgorithm 算法，只支持 HMAC_SM3\|HMAC_SHA_256
Mac	String	是	41cb6fdba8ef249312e4ce66f7d6b5b68e565ef84d6333793b5934d6779e847c	message authentication code

返回参数

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

参数	类型	示例值	描述
KeyID	String	39a0e7c6-b7dd-4c83-b400-3449bb95403a	主密钥唯一标识符，UUID形式
MacValid	Boolean	true	MacValid

请求示例

POST /?Action=VerifyMac&Version=2021-02-18 HTTP/1.1
Host: kms.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240708T151941Z
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": "5Lq65LmL5Yid5oCn5pys5ZaE5oCn55u46L+R5Lmg55u46L+c",
  "MacAlgorithm": "HMAC_SHA_256",
  "Mac": "49NIoYbYAkVv8tT6hoAY+jJ0gZCRQujiv7wc0S763ao=",
  "KeyringName": "fd65f1d1-9b0c-4254-897f-1965b2",
  "KeyName": "bbbb"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "02172956017734700000000000000000000ffff0a96f00d148f88",
    "Action": "VerifyMac",
    "Version": "2021-02-18",
    "Service": "kms",
    "Region": "cn-north-1"
  },
  "Result": {
    "KeyID": "1096b6a5-3bb5-430a-8c5b-65ae1ca73346",
    "MacValid": true
  }
}

错误码

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

状态码	错误码	错误信息
400	InvalidParameter	The request parameter %s is invalid.
400	MissingParameter	The request is missing %s parameter.
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.
404	Not Found	Not found %s [%s].
500	UndefinedError	Undefined Internal Error. Pls Contact With Admin.