文档首页/ 密码安全中心 DEW/ API参考/ API/ 管理加密密钥/ 密钥派生/ 派生共享密钥 - DeriveSharedSecret
更新时间:2026-05-20 GMT+08:00
分享

派生共享密钥 - DeriveSharedSecret

功能介绍

功能介绍:派生共享密钥

接口约束

  • 仅支持key_usage为KEY_AGREEMENT的密钥进行操作。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

POST /v1.0/{project_id}/kms/derive-shared-secret

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID。可参考获取项目ID获取。

约束限制:

不涉及

取值范围:

以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}$”

取值范围:

不涉及

默认取值:

不涉及

key_agreement_algorithm

String

参数解释:

密钥协商算法,仅支持ECDH

约束限制:

不涉及

取值范围:

  • ECDH

默认取值:

不涉及

public_key

String

参数解释:

对端密钥对的的公钥,您需要保证是EC_P256,EC_384,SECP256K1或SM2(仅中国区域支持)密钥对的公钥

约束限制:

  • 公钥的格式必须是DER-encoded X.509类型的Base64的字符串

取值范围:

不涉及

默认取值:

不涉及

recipient

Recipient object

参数解释:

擎天加密计算

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表4 Recipient

参数

是否必选

参数类型

描述

attestation_document

String

参数解释:

擎天机密计算证明文档

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

key_encryption_algorithm

String

参数解释:

指定加密算法,仅支持RSAES_OAEP_SHA_256

约束限制:

不涉及

取值范围:

  • RSAES_OAEP_SHA_256

默认取值:

不涉及

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

key_id

String

参数解释:

密钥ID

取值范围:

不涉及

key_agreement_algorithm

String

参数解释:

密钥协商算法

取值范围:

不涉及

shared_secret

String

参数解释:

由KMS私钥和您的对端公钥协商出的密钥,Base64格式,如果响应体包含了ciphertext_recipient,则不会包含shared_secret

取值范围:

不涉及

ciphertext_recipient

String

参数解释:

KMS私钥和您的对端公钥协商出的密钥经过擎天证明文档加密后的密文,密文仅能被机密环境中的私钥解密,指定擎天证明文档后,才会响应ciphertext_recipient,否则通过shared_secret响应明文的共享密钥

取值范围:

不涉及

请求示例

https://kms.cn-north-4.myhuaweicloud.com/v1.0/d4e559b49b3b403da5279723299ed4a6/kms/derive-shared-secret

{
  "key_id" : "f1b8b45f-9f87-43e2-b00c-8a4ca6eb1e39",
  "key_agreement_algorithm" : "ECDH",
  "public_key" : "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE4UPptf7NVo2H+8Mz1V1dMz9x+DGdQSFxwLsqkUSXy4XNgs6bnxMtUB3WuI9GGzIYw21R/+w4lJvNDxYjd/Q1sQ=="
}

响应示例

状态码:200

请求已成功

{
  "key_id" : "f1b8b45f-9f87-43e2-b00c-8a4ca6eb1e39",
  "key_agreement_algorithm" : "ECDH",
  "shared_secret" : "9ZV21q1r/zKBEibefcb0BgssKTwK0wTTstze45vZ358="
}

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
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 DeriveSharedSecretSolution {

    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();
        DeriveSharedSecretRequest request = new DeriveSharedSecretRequest();
        DeriveSharedSecretRequestBody body = new DeriveSharedSecretRequestBody();
        body.withPublicKey("MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE4UPptf7NVo2H+8Mz1V1dMz9x+DGdQSFxwLsqkUSXy4XNgs6bnxMtUB3WuI9GGzIYw21R/+w4lJvNDxYjd/Q1sQ==");
        body.withKeyAgreementAlgorithm(DeriveSharedSecretRequestBody.KeyAgreementAlgorithmEnum.fromValue("ECDH"));
        body.withKeyId("f1b8b45f-9f87-43e2-b00c-8a4ca6eb1e39");
        request.withBody(body);
        try {
            DeriveSharedSecretResponse response = client.deriveSharedSecret(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
# 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 = DeriveSharedSecretRequest()
        request.body = DeriveSharedSecretRequestBody(
            public_key="MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE4UPptf7NVo2H+8Mz1V1dMz9x+DGdQSFxwLsqkUSXy4XNgs6bnxMtUB3WuI9GGzIYw21R/+w4lJvNDxYjd/Q1sQ==",
            key_agreement_algorithm="ECDH",
            key_id="f1b8b45f-9f87-43e2-b00c-8a4ca6eb1e39"
        )
        response = client.derive_shared_secret(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
44
45
46
47
48
49
50
51
52
53
54
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("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := kms.NewKmsClient(hcClient)

    request := &model.DeriveSharedSecretRequest{}
	request.Body = &model.DeriveSharedSecretRequestBody{
		PublicKey: "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE4UPptf7NVo2H+8Mz1V1dMz9x+DGdQSFxwLsqkUSXy4XNgs6bnxMtUB3WuI9GGzIYw21R/+w4lJvNDxYjd/Q1sQ==",
		KeyAgreementAlgorithm: model.GetDeriveSharedSecretRequestBodyKeyAgreementAlgorithmEnum().ECDH,
		KeyId: "f1b8b45f-9f87-43e2-b00c-8a4ca6eb1e39",
	}
	response, err := client.DeriveSharedSecret(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档