com.aliyun.encryptionsdk.kms

Class DefaultAliyunKms

java.lang.Object

com.aliyun.encryptionsdk.kms.DefaultAliyunKms

All Implemented Interfaces:

AliyunKms

public class DefaultAliyunKms
extends Object
implements AliyunKms

AliyunKms 默认实现 依赖aliyun-java-sdk-core和aliyun-java-sdk-kms两个jar包

Nested Class Summary

Nested classes/interfaces inherited from interface com.aliyun.encryptionsdk.kms.AliyunKms

AliyunKms.AsymmetricSignResult, AliyunKms.AsymmetricVerifyResult, AliyunKms.BaseResult, AliyunKms.CreateSecretResult, AliyunKms.DecryptDataKeyResult, AliyunKms.GenerateDataKeyResult, AliyunKms.GetSecretValueResult

Constructor Summary

Constructors

Constructor and Description
DefaultAliyunKms(AliyunConfig config)

Method Summary

Modifier and Type	Method and Description
AliyunKms.AsymmetricSignResult	asymmetricSign(CmkId keyId, String keyVersionId, SignatureAlgorithm algorithm, byte[] digest) 使用非对称密钥进行签名
AliyunKms.AsymmetricVerifyResult	asymmetricVerify(CmkId keyId, String keyVersionId, SignatureAlgorithm algorithm, byte[] digest, 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) 转加密一个数据密钥密文

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultAliyunKms

public DefaultAliyunKms(AliyunConfig config)

Method Detail

generateDataKey

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

Description copied from interface: AliyunKms

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

Specified by:

generateDataKey in interface AliyunKms

Parameters:

keyId - keyId

algorithm - 算法信息

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

Returns:

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

decryptDataKey

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

Description copied from interface: AliyunKms

解密一个数据密钥密文

Specified by:

decryptDataKey in interface AliyunKms

Parameters:

encryptedDataKey - 数据密钥密文

context - dataKey密钥上下文信息

Returns:

数据密钥明文（Base64编码）

encryptDataKey

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

Description copied from interface: AliyunKms

加密一个数据密文明文

Specified by:

encryptDataKey in interface AliyunKms

Parameters:

keyId - keyId

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

Returns:

数据密钥密文

reEncryptDataKey

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

Description copied from interface: AliyunKms

转加密一个数据密钥密文

Specified by:

reEncryptDataKey in interface AliyunKms

Parameters:

keyId - 待加密的keyId

encryptedDataKey - 数据密钥密文

context - dataKey密钥上下文信息

Returns:

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

asymmetricSign

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

Description copied from interface: AliyunKms

使用非对称密钥进行签名

Specified by:

asymmetricSign in interface AliyunKms

Parameters:

keyId - keyId

keyVersionId - keyId对应主密钥的版本

algorithm - 非对称算法

digest - 签名信息

Returns:

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

asymmetricVerify

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

Description copied from interface: AliyunKms

使用非对称密钥进行验签

Specified by:

asymmetricVerify in interface AliyunKms

Parameters:

keyId - keyId

keyVersionId - keyId对应主密钥的版本

algorithm - 非对称算法

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

signature - 待验证的签名结果

Returns:

验签结果

createSecret

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

Description copied from interface: AliyunKms

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

Specified by:

createSecret in interface AliyunKms

Parameters:

keyId - keyId

secretName - 凭据名称

versionId - 凭据初始版本

secretData - 凭据值

secretDataType - 凭据值的类型

Returns:

CreateSecretResult

getSecretValue

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

Description copied from interface: AliyunKms

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

Specified by:

getSecretValue in interface AliyunKms

Parameters:

keyId - keyId

secretName - 凭据名称

Returns:

凭据值和凭据值的类型

getSecretValue

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

Specified by:

getSecretValue in interface AliyunKms

getPublicKey

public String getPublicKey(CmkId keyId,
                           String keyVersionId)

Description copied from interface: AliyunKms

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

Specified by:

getPublicKey in interface AliyunKms

Parameters:

keyId - keyId

keyVersionId - keyId对应主密钥的版本

Returns:

公钥