# 加密数据密钥 - EncryptDatakey #### 功能介绍 - 功能介绍：加密数据密钥，用指定的主密钥加密数据密钥。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dew/dew_02_0002.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dew/dew_02_0308.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | kms:cmk:encryptDataKey | Write | KeyId \* | - kms:KeyOrigin - kms:KeySpec - kms:KeyUsage - kms:MultiRegionKeyType - g:EnterpriseProjectId - g:ResourceTag/\ | - kms:dek:crypto - kms:dek:encrypt | - | | kms:cmk:encryptDataKey | Write | - | - kms:RequestAlias - kms:ResourceAliases - kms:EncryptionContext | - kms:dek:crypto - kms:dek:encrypt | - | #### URI POST /v1.0/{project_id}/kms/encrypt-datakey 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，用于唯一标识用户项目。可参考[获取项目ID](https://support.huaweicloud.com/api-dew/dew_02_0009.html)获取，以IAM服务接口返回值为准 **约束限制：** 不涉及 **取值范围：** 字符长度32-32。 **默认取值：** 不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值），以IAM服务查询用户Token接口为准 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key_id | 是 | String | **参数解释：** 密钥ID **约束限制：** - 36字节ID - 满足正则匹配"\^\[0-9a-z\]{8}-\[0-9a-z\]{4}-\[0-9a-z\]{4}-\[0-9a-z\]{4}-\[0-9a-z\]{12}$" **取值范围：** 不涉及 **默认取值：** 不涉及 | | plain_text | 是 | String | **参数解释：** 使用的主密钥算法为AES时，传入数据密钥的明文+数据密钥明文的SHA256值（32字节）；使用的主密钥算法为SM4时，传入数据密钥的明文+数据密钥明文的SM3值（32字节），均为16进制字符串表示。本参数中的两部分，通过字符串拼接后作为参数即可 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | datakey_plain_length | 是 | String | **参数解释：** DEK明文字节长度 **约束限制：** 不涉及 **取值范围：** 1\~1024 **默认取值：** 不涉及 | | additional_authenticated_data | 否 | String | **参数解释：** 身份验证的非敏感额外数据 **约束限制：** 长度不超过128字节 **取值范围：** 任意字符串 **默认取值：** 不涉及 | | pin | 否 | String | **参数解释：** pin码，用于数据密钥的认证，仅四级密评场景生效 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | pin_type | 否 | String | **参数解释：** pin码的类型 **约束限制：** 不涉及 **取值范围：** - PlainText：表示明文pin - CipherText：表示密文pin **默认取值：** CipherText | | key_spec | 否 | String | **参数解释：** 指定待加密数据密钥的类型 **约束限制：** 仅四级密评场景生效 **取值范围：** - SM2：表示SM2密钥 - RSA：表示RSA密钥 **默认取值：** 不涉及 | | sequence | 否 | String | **参数解释：** 请求消息序列号，36字节序列号，例如：919c82d4-8046-4722-9094-35c3c6524cff **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key_id | String | **参数解释：** 密钥ID **取值范围：** 不涉及 | | cipher_text | String | **参数解释：** EDK明文的16进制 **取值范围：** 不涉及 | | datakey_length | String | **参数解释：** EDK明文的字节长度 **取值范围：** 不涉及 | #### 请求示例 加密明文数据密钥，使用ID为"0d0466b0-e727-4d9c-b35d-f84bb474a37f"的密钥，加密512位长度的明文密钥,附加数据为"123add"。 ``` { "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f", "plain_text" : "7549d9aea901767bf3c0b3e14b10722eaf6f59053bbd82045d04e075e809a0fe6ccab48f8e5efe74e4b18ff0512525e527b10331100f357bf42125d8d5ced94ffbc8ac72b0785ca7fe33eb6776ce3990b11e32b299d9c0a9ee0305fb9540f797", "datakey_plain_length" : "64", "additional_authenticated_data" : "123aad" } ``` #### 响应示例 **状态码：200** ``` { "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f", "datakey_length" : "64", "cipher_text" : "020098009EEAFCE122CAA5927D2XXX..." } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 加密明文数据密钥，使用ID为"0d0466b0-e727-4d9c-b35d-f84bb474a37f"的密钥，加密512位长度的明文密钥,附加数据为"123add"。 ``` 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 EncryptDatakeySolution { 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("")) .build(); EncryptDatakeyRequest request = new EncryptDatakeyRequest(); EncryptDatakeyRequestBody body = new EncryptDatakeyRequestBody(); body.withAdditionalAuthenticatedData("123aad"); body.withDatakeyPlainLength("64"); body.withPlainText("7549d9aea901767bf3c0b3e14b10722eaf6f59053bbd82045d04e075e809a0fe6ccab48f8e5efe74e4b18ff0512525e527b10331100f357bf42125d8d5ced94ffbc8ac72b0785ca7fe33eb6776ce3990b11e32b299d9c0a9ee0305fb9540f797"); body.withKeyId("0d0466b0-e727-4d9c-b35d-f84bb474a37f"); request.withBody(body); try { EncryptDatakeyResponse response = client.encryptDatakey(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()); } } } ``` - [Python] 加密明文数据密钥，使用ID为"0d0466b0-e727-4d9c-b35d-f84bb474a37f"的密钥，加密512位长度的明文密钥,附加数据为"123add"。 ``` # 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("")) \ .build() try: request = EncryptDatakeyRequest() request.body = EncryptDatakeyRequestBody( additional_authenticated_data="123aad", datakey_plain_length="64", plain_text="7549d9aea901767bf3c0b3e14b10722eaf6f59053bbd82045d04e075e809a0fe6ccab48f8e5efe74e4b18ff0512525e527b10331100f357bf42125d8d5ced94ffbc8ac72b0785ca7fe33eb6776ce3990b11e32b299d9c0a9ee0305fb9540f797", key_id="0d0466b0-e727-4d9c-b35d-f84bb474a37f" ) response = client.encrypt_datakey(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] 加密明文数据密钥，使用ID为"0d0466b0-e727-4d9c-b35d-f84bb474a37f"的密钥，加密512位长度的明文密钥,附加数据为"123add"。 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := kms.KmsClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := kms.NewKmsClient(hcClient) request := &model.EncryptDatakeyRequest{} additionalAuthenticatedDataEncryptDatakeyRequestBody:= "123aad" request.Body = &model.EncryptDatakeyRequestBody{ AdditionalAuthenticatedData: &additionalAuthenticatedDataEncryptDatakeyRequestBody, DatakeyPlainLength: "64", PlainText: "7549d9aea901767bf3c0b3e14b10722eaf6f59053bbd82045d04e075e809a0fe6ccab48f8e5efe74e4b18ff0512525e527b10331100f357bf42125d8d5ced94ffbc8ac72b0785ca7fe33eb6776ce3990b11e32b299d9c0a9ee0305fb9540f797", KeyId: "0d0466b0-e727-4d9c-b35d-f84bb474a37f", } response, err := client.EncryptDatakey(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/KMS/sdk?api=EncryptDatakey)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求已成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dew/ErrorCode.html)。