com.aliyun.encryptionsdk.kms

Interface AliyunKms

All Known Implementing Classes:

DefaultAliyunKms

public interface AliyunKms

定义了请求kms服务端的接口

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AliyunKms.AsymmetricSignResult
static class	AliyunKms.AsymmetricVerifyResult
static class	AliyunKms.BaseResult
static class	AliyunKms.CreateSecretResult
static class	AliyunKms.DecryptDataKeyResult
static class	AliyunKms.GenerateDataKeyResult
static class	AliyunKms.GetSecretValueResult

Method Summary

Modifier and Type	Method and Description
AliyunKms.AsymmetricSignResult	asymmetricSign(CmkId keyId, String keyVersionId, SignatureAlgorithm algorithm, byte[] message) 使用非对称密钥进行签名
AliyunKms.AsymmetricVerifyResult	asymmetricVerify(CmkId keyId, String keyVersionId, SignatureAlgorithm algorithm, byte[] message, byte[] signature) 使用非对称密钥进行验签
AliyunKms.CreateSecretResult	createSecret(CmkId keyId, String secretName, String versionId, String secretData, String secretDataType) 使用主密钥创建一个凭据，以及凭据的初始版本
AliyunKms.DecryptDataKeyResult	decryptDataKey(EncryptedDataKey encryptedDataKey, Map<String,String> context) 解密一个数据密钥密文
EncryptedDataKey	encryptDataKey(CmkId keyId, String plaintext, Map<String,String> context) 加密一个数据密文明文
AliyunKms.GenerateDataKeyResult	generateDataKey(CmkId keyId, CryptoAlgorithm algorithm, Map<String,String> context) 使用主密钥生成一个数据密钥
String	getPublicKey(CmkId keyId, String keyVersionId) 获取非对称密钥的公钥。用户可以在本地使用公钥进行加密、验签。
AliyunKms.GetSecretValueResult	getSecretValue(CmkId keyId, String secretName) 获取被凭据保护的凭据值内容
AliyunKms.GetSecretValueResult	getSecretValue(CmkId keyId, String secretName, String versionId)
EncryptedDataKey	reEncryptDataKey(CmkId keyId, EncryptedDataKey encryptedDataKey, Map<String,String> context) 转加密一个数据密钥密文

Method Detail

generateDataKey

AliyunKms.GenerateDataKeyResult generateDataKey(CmkId keyId,
                                                CryptoAlgorithm algorithm,
                                                Map<String,String> context)

使用主密钥生成一个数据密钥

Parameters:

keyId - keyId

algorithm - 算法信息

context - dataKey密钥上下文信息，后续解密对应的dataKey需要相同的上下文信息

Returns:

返回包含数据密钥明文（Base64编码）和经过keyId对应的主密钥加密后的数据密钥密文

decryptDataKey

AliyunKms.DecryptDataKeyResult decryptDataKey(EncryptedDataKey encryptedDataKey,
                                              Map<String,String> context)

解密一个数据密钥密文

Parameters:

encryptedDataKey - 数据密钥密文

context - dataKey密钥上下文信息

Returns:

数据密钥明文（Base64编码）

encryptDataKey

EncryptedDataKey encryptDataKey(CmkId keyId,
                                String plaintext,
                                Map<String,String> context)

加密一个数据密文明文

Parameters:

keyId - keyId

plaintext - 数据密钥明文（Base64编码）

Returns:

数据密钥密文

reEncryptDataKey

EncryptedDataKey reEncryptDataKey(CmkId keyId,
                                  EncryptedDataKey encryptedDataKey,
                                  Map<String,String> context)

转加密一个数据密钥密文

Parameters:

keyId - 待加密的keyId

encryptedDataKey - 数据密钥密文

context - dataKey密钥上下文信息

Returns:

数据密钥密文（内部为待加密的keyId对应的主密钥加密后的数据密钥密文）

asymmetricSign

AliyunKms.AsymmetricSignResult asymmetricSign(CmkId keyId,
                                              String keyVersionId,
                                              SignatureAlgorithm algorithm,
                                              byte[] message)

使用非对称密钥进行签名

Parameters:

keyId - keyId

keyVersionId - keyId对应主密钥的版本

algorithm - 非对称算法

message - 签名信息

Returns:

计算出来的签名结果（Base64编码）

asymmetricVerify

AliyunKms.AsymmetricVerifyResult asymmetricVerify(CmkId keyId,
                                                  String keyVersionId,
                                                  SignatureAlgorithm algorithm,
                                                  byte[] message,
                                                  byte[] signature)

使用非对称密钥进行验签

Parameters:

keyId - keyId

keyVersionId - keyId对应主密钥的版本

algorithm - 非对称算法

message - 使用Algorithm中对应的哈希算法，对原始message生成的摘要

signature - 待验证的签名结果

Returns:

验签结果

getPublicKey

String getPublicKey(CmkId keyId,
                    String keyVersionId)

获取非对称密钥的公钥。用户可以在本地使用公钥进行加密、验签。

Parameters:

keyId - keyId

keyVersionId - keyId对应主密钥的版本

Returns:

公钥

createSecret

AliyunKms.CreateSecretResult createSecret(CmkId keyId,
                                          String secretName,
                                          String versionId,
                                          String secretData,
                                          String secretDataType)

使用主密钥创建一个凭据，以及凭据的初始版本

Parameters:

keyId - keyId

secretName - 凭据名称

versionId - 凭据初始版本

secretData - 凭据值

secretDataType - 凭据值的类型

Returns:

CreateSecretResult

getSecretValue

AliyunKms.GetSecretValueResult getSecretValue(CmkId keyId,
                                              String secretName)

获取被凭据保护的凭据值内容

Parameters:

keyId - keyId

secretName - 凭据名称

Returns:

凭据值和凭据值的类型

getSecretValue

AliyunKms.GetSecretValueResult getSecretValue(CmkId keyId,
                                              String secretName,
                                              String versionId)