com.aliyun.encryptionsdk.provider

Class BaseDataKeyProvider

java.lang.Object

com.aliyun.encryptionsdk.provider.BaseDataKeyProvider

Direct Known Subclasses:

AbstractExternalStoreDataKeyProvider, DefaultDataKeyProvider

public abstract class BaseDataKeyProvider
extends Object

数据密钥生成抽象类，提供对数据密钥处理方法

Field Summary

Fields

Modifier and Type	Field and Description
protected CryptoAlgorithm	algorithm
protected FormatHandler	handler
protected CmkId	keyId
protected AliyunKms	kms

Constructor Summary

Constructors

Constructor and Description
BaseDataKeyProvider(String keyId)
BaseDataKeyProvider(String keyId, CryptoAlgorithm algorithm)

Method Summary

Modifier and Type	Method and Description
DecryptionMaterial	decryptDataKey(DecryptionMaterial material, List<EncryptedDataKey> encryptedDataKeys) 解密数据密钥
EncryptionMaterial	encryptDataKey(EncryptionMaterial material) 生成一个数据密钥并进行加密处理
CryptoAlgorithm	getAlgorithm()
abstract CipherMaterial	getCipherMaterial(byte[] cipherText) 通过密文或数据密钥关键字获取数据密钥并生成密码材料
abstract byte[]	processCipherMaterial(CipherMaterial cipherMaterial) 处理密码材料生成字节数组，字节数组内容可能包含： 1.CipherMaterial 的所有内容 2.CipherMaterial 中的 CipherBody 部分（CipherHeader 部分由 AbstractExternalStoreDataKeyProvider 的实现自行处理）
void	setAlgorithm(CryptoAlgorithm algorithm)
void	setAliyunKms(AliyunKms kms)
void	setFormatHandler(FormatHandler handler)
void	setMultiCmkId(List<String> keyIds)

Methods inherited from class java.lang.Object

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

Field Detail

algorithm

protected CryptoAlgorithm algorithm

handler

protected FormatHandler handler

kms

protected AliyunKms kms

keyId

protected CmkId keyId

Constructor Detail

BaseDataKeyProvider

public BaseDataKeyProvider(String keyId)

BaseDataKeyProvider

public BaseDataKeyProvider(String keyId,
                           CryptoAlgorithm algorithm)

Method Detail

setAliyunKms

public void setAliyunKms(AliyunKms kms)

setMultiCmkId

public void setMultiCmkId(List<String> keyIds)

getAlgorithm

public CryptoAlgorithm getAlgorithm()

setAlgorithm

public void setAlgorithm(CryptoAlgorithm algorithm)

setFormatHandler

public void setFormatHandler(FormatHandler handler)

encryptDataKey

public EncryptionMaterial encryptDataKey(EncryptionMaterial material)

生成一个数据密钥并进行加密处理

Parameters:

material - 加密密钥材料（不包含获取数据密钥）

Returns:

加密密钥材料

decryptDataKey

public DecryptionMaterial decryptDataKey(DecryptionMaterial material,
                                         List<EncryptedDataKey> encryptedDataKeys)

解密数据密钥

Parameters:

material - 解密密钥材料（不包含数据密钥明文）

encryptedDataKeys - 数据密钥明文列表

Returns:

加密密钥材料

getCipherMaterial

public abstract CipherMaterial getCipherMaterial(byte[] cipherText)

通过密文或数据密钥关键字获取数据密钥并生成密码材料

Parameters:

cipherText - 密文

Returns:

密码材料

processCipherMaterial

public abstract byte[] processCipherMaterial(CipherMaterial cipherMaterial)

处理密码材料生成字节数组，字节数组内容可能包含： 1.CipherMaterial 的所有内容 2.CipherMaterial 中的 CipherBody 部分（CipherHeader 部分由 AbstractExternalStoreDataKeyProvider 的实现自行处理）

Parameters:

cipherMaterial - 密码材料

Returns:

加密结果