校验消息验证码
功能介绍
功能介绍:校验消息验证码
接口约束
-
仅支持key_usage为GENERATE_VERIFY_MAC的密钥进行操作。
调用方法
请参见如何调用API。
URI
POST /v1.0/{project_id}/kms/verify-mac
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
key_id |
是 |
String |
密钥ID |
mac_algorithm |
是 |
String |
Mac算法,HMAC_SM3只有中国区支持。枚举如下:
|
message |
是 |
String |
待处理消息。原消息最小长度1、最大长度4096。请将原消息转为Base64格式后传入 |
mac |
是 |
String |
待校验的消息验证码 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
key_id |
String |
密钥ID |
mac_algorithm |
String |
MAC算法 |
mac_valid |
Boolean |
消息验证码校验结果 |
请求示例
{ "key_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46", "mac_algorithm" : "HMAC_SHA_256", "message" : "ZmRzYQ==", "mac" : "8549f9f5ef335184e23e6d477776f0fd338d02c59e48e52e8d81d158e2fc9262" }
响应示例
状态码: 200
请求已成功
{ "mac_algorithm" : "HMAC_SHA_256", "key_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46", "mac_valid" : false }
SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.kms.v2.region.KmsRegion; import com.huaweicloud.sdk.kms.v2.*; import com.huaweicloud.sdk.kms.v2.model.*; public class VerifyMacSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); KmsClient client = KmsClient.newBuilder() .withCredential(auth) .withRegion(KmsRegion.valueOf("<YOUR REGION>")) .build(); VerifyMacRequest request = new VerifyMacRequest(); VerifyMacRequestBody body = new VerifyMacRequestBody(); body.withMac("8549f9f5ef335184e23e6d477776f0fd338d02c59e48e52e8d81d158e2fc9262"); body.withMessage("ZmRzYQ=="); body.withMacAlgorithm(VerifyMacRequestBody.MacAlgorithmEnum.fromValue("HMAC_SHA_256")); body.withKeyId("826314dd-1b5b-4037-b976-5f9b7a17df46"); request.withBody(body); try { VerifyMacResponse response = client.verifyMac(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkkms.v2.region.kms_region import KmsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkkms.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = KmsClient.new_builder() \ .with_credentials(credentials) \ .with_region(KmsRegion.value_of("<YOUR REGION>")) \ .build() try: request = VerifyMacRequest() request.body = VerifyMacRequestBody( mac="8549f9f5ef335184e23e6d477776f0fd338d02c59e48e52e8d81d158e2fc9262", message="ZmRzYQ==", mac_algorithm="HMAC_SHA_256", key_id="826314dd-1b5b-4037-b976-5f9b7a17df46" ) response = client.verify_mac(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" kms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kms/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kms/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kms/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := kms.NewKmsClient( kms.KmsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.VerifyMacRequest{} request.Body = &model.VerifyMacRequestBody{ Mac: "8549f9f5ef335184e23e6d477776f0fd338d02c59e48e52e8d81d158e2fc9262", Message: "ZmRzYQ==", MacAlgorithm: model.GetVerifyMacRequestBodyMacAlgorithmEnum().HMAC_SHA_256, KeyId: "826314dd-1b5b-4037-b976-5f9b7a17df46", } response, err := client.VerifyMac(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
请求已成功 |
错误码
请参见错误码。