文档中心

获取指定非对称密钥的公钥

最近更新时间：2024.04.16 11:54:33

首次发布时间：2024.04.16 11:54:33

描述：获取指定非对称密钥的公钥。
请求方法：GET
请求业务参数：

名称	类型	是否必选	示范值	描述
action	String	Yes	GetPublicKey	接口名，取值: GetPublicKey
Version	String	Yes	2021-02-18	版本号，取值: 2021-02-18
KeyringName*	String	No	test_keyring-1	密钥环的别名。长度为 2 - 31 个字符。合法字符：[a-zA-Z0-9-_]
KeyName*	String	No	test_key-1	主密钥的别名。长度为 2 - 31 个字符。合法字符：[a-zA-Z0-9-_]
KeyID*	String	No	39a0e7c6-b7dd-4c83-b400-3449bb95403a	在CreateKey中创建的密钥的密钥ID。长度为36个字符。合法字符：[a-zA-Z0-9-]

关于KeyID、KeyringName和KeyName的参数说明
虽然KeyID、KeyringName和KeyName是可选字段，但请求必须附带KeyID或KeyringName和KeyName的组合。

返回的公钥格式
非对称密钥的公钥以不同的格式进行编码。在 HSM 外运行加密/验证时，重要的是考虑公钥的格式并使用适当的库来处理公钥的格式。下表总结了 GetPublicKey API 返回的非对称公钥的格式

密钥规格	密钥保护级别	公钥格式
RSA_2048 RSA_3072 RSA_4098	Software	PKCS #1, ASN.1 DER form
RSA_2048 RSA_3072 RSA_4098	Hardware	PKCS #1, ASN.1 DER form
EC_256K EC_256 EC_384 EC_521	Hardware	ANSI X9.62
EC_256K EC_256 EC_384 EC_521	Software	PKIX, ASN.1 DER form See section Section 4.1 in RFC 5280
EC_SM2	Hardware	ASN.1 DER form

从GetPublicKey返回的参数

名称	类型	描述
ResponseMetaData	ResponseMetaData	返回公共参数
Result	PublicKey	Type: Base64-encoded binary data object	PEM格式的公钥。 -----BEGIN PUBLIC KEY----- MFkwEwYHKoZIzj0CAQYIKoEcz1UBgi0DQgAEy1ywbEU17uqak8PNqv54BDdtE7+n CGXuj8nKmhPNl3AmN8z2roAowQYORs4JTTfmmLq0jvIU0hBCsSS3aY****== -----END PUBLIC KEY----- 长度限制: 最小长度为1字符；最大长度为8192字符
KeyID	String	使用的非对称密钥的密钥ID

名称

类型

描述

ResponseMetaData

返回公共参数

Result

PublicKey

Type: Base64-encoded binary data object

PEM格式的公钥。
-----BEGIN PUBLIC KEY----- MFkwEwYHKoZIzj0CAQYIKoEcz1UBgi0DQgAEy1ywbEU17uqak8PNqv54BDdtE7+n CGXuj8nKmhPNl3AmN8z2roAowQYORs4JTTfmmLq0jvIU0hBCsSS3aY****== -----END PUBLIC KEY-----

长度限制: 最小长度为1字符；最大长度为8192字符

KeyID

String

使用的非对称密钥的密钥ID

请求示例：

https://kms.volcengineapi.com?Action=GetPublicKey&Version=2021-02-18&KeyringName=test_keyring-1&KeyName=test_key-1

返回示例：

{
    "ResponseMetadata": {
        "RequestId": "202107121937490102252431000312DA6D",
        "Action": "GetPublicKey",
        "Version": "2021-02-18",
        "Service": "kms",
        "Region": "cn-north-1"
    },
    "Result": {
  "PublicKey":MFkwEwYHKoZIzj0CAQYIKoEcz1UBgi0DQgAEy1ywbEU17uqak8PNqv54BDdtE7+n CGXuj8nKmhPNl3AmN8z2roAowQYORs4JTTfmmLq0jvIU0hBCsSS3aY==,
      "KeyID": "39a0e7c6-b7dd-4c83-b400-3449bb95403a"
    }
}

密钥管理系统

获取指定非对称密钥的公钥