签名数据
功能介绍
-
功能介绍:使用非对称密钥的私钥对消息或消息摘要进行数字签名。
接口约束
-
仅支持key_usage为SIGN_VERIFY的非对称密钥进行签名操作。
-
使用SM2密钥签名时,仅支持对消息摘要签名。根据GBT32918国家标准,计算SM2签名值时,消息摘要不是对原始消息直接计算SM3摘要,而是对Z(A)和M的拼接值计算的摘要,其中M是待签名的原始消息,Z(A)是GBT32918中定义的用户A的杂凑值。
调用方法
请参见如何调用API。
URI
POST /v1.0/{project_id}/kms/sign
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
key_id |
是 |
String |
密钥ID,36字节,满足正则匹配“^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$”。 例如:0d0466b0-e727-4d9c-b35d-f84bb474a37f。 |
message |
是 |
String |
待签名的消息摘要或者消息,消息长度要求小于4096字节,使用Base64编码。 |
signing_algorithm |
是 |
String |
签名算法,枚举如下:
|
message_type |
否 |
String |
消息类型,默认为“DIGEST”,枚举如下:
|
sequence |
否 |
String |
请求消息序列号,36字节序列号。 例如:919c82d4-8046-4722-9094-35c3c6524cff。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
key_id |
String |
密钥ID。 |
signature |
String |
签名值,使用base64编码。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error |
Object |
错误信息返回体。 |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误请求返回的错误码 |
error_msg |
String |
错误请求返回的错误信息 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error |
Object |
错误信息返回体。 |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误请求返回的错误码 |
error_msg |
String |
错误请求返回的错误信息 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error |
Object |
错误信息返回体。 |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误请求返回的错误码 |
error_msg |
String |
错误请求返回的错误信息 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error |
Object |
错误信息返回体。 |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误请求返回的错误码 |
error_msg |
String |
错误请求返回的错误信息 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error |
Object |
错误信息返回体。 |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误请求返回的错误码 |
error_msg |
String |
错误请求返回的错误信息 |
状态码: 502
参数 |
参数类型 |
描述 |
---|---|---|
error |
Object |
错误信息返回体。 |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误请求返回的错误码 |
error_msg |
String |
错误请求返回的错误信息 |
状态码: 504
参数 |
参数类型 |
描述 |
---|---|---|
error |
Object |
错误信息返回体。 |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误请求返回的错误码 |
error_msg |
String |
错误请求返回的错误信息 |
请求示例
签名消息信息,使用ID为"0d0466b0-e727-4d9c-b35d-f84bb474a37f"的密钥,采用"RSASSA_PKCS1_V1_5_SHA_256"签名算法,对摘要消息进行签名。
{ "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f", "signing_algorithm" : "RSASSA_PKCS1_V1_5_SHA_256", "message" : "MmFiZWE0ZjI3ZGIxYTkzY2RmYmEzM2YwMTA1YmJjYw==" }
响应示例
状态码: 200
请求已成功
{ "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f", "signature" : "jFUqQESGBc0j6k9BozzrP9YL4qk8/W9DZRvK6XXX..." }
SDK代码示例
SDK代码示例如下。
签名消息信息,使用ID为"0d0466b0-e727-4d9c-b35d-f84bb474a37f"的密钥,采用"RSASSA_PKCS1_V1_5_SHA_256"签名算法,对摘要消息进行签名。
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 |
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 SignSolution { 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(); SignRequest request = new SignRequest(); SignRequestBody body = new SignRequestBody(); body.withSigningAlgorithm(SignRequestBody.SigningAlgorithmEnum.fromValue("RSASSA_PKCS1_V1_5_SHA_256")); body.withMessage("MmFiZWE0ZjI3ZGIxYTkzY2RmYmEzM2YwMTA1YmJjYw=="); body.withKeyId("0d0466b0-e727-4d9c-b35d-f84bb474a37f"); request.withBody(body); try { SignResponse response = client.sign(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()); } } } |
签名消息信息,使用ID为"0d0466b0-e727-4d9c-b35d-f84bb474a37f"的密钥,采用"RSASSA_PKCS1_V1_5_SHA_256"签名算法,对摘要消息进行签名。
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 |
# 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 = SignRequest() request.body = SignRequestBody( signing_algorithm="RSASSA_PKCS1_V1_5_SHA_256", message="MmFiZWE0ZjI3ZGIxYTkzY2RmYmEzM2YwMTA1YmJjYw==", key_id="0d0466b0-e727-4d9c-b35d-f84bb474a37f" ) response = client.sign(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
签名消息信息,使用ID为"0d0466b0-e727-4d9c-b35d-f84bb474a37f"的密钥,采用"RSASSA_PKCS1_V1_5_SHA_256"签名算法,对摘要消息进行签名。
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 |
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.SignRequest{} request.Body = &model.SignRequestBody{ SigningAlgorithm: model.GetSignRequestBodySigningAlgorithmEnum().RSASSA_PKCS1_V1_5_SHA_256, Message: "MmFiZWE0ZjI3ZGIxYTkzY2RmYmEzM2YwMTA1YmJjYw==", KeyId: "0d0466b0-e727-4d9c-b35d-f84bb474a37f", } response, err := client.Sign(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
请求已成功 |
400 |
请求参数有误 |
401 |
被请求的页面需要用户名和密码 |
403 |
认证失败 |
404 |
资源不存在,资源未找到 |
500 |
服务内部错误 |
502 |
请求未完成。服务器从上游服务器收到一个无效的响应 |
504 |
网关超时 |
错误码
请参见错误码。