com.aliyun.encryptionsdk.provider.dataKey

Class AbstractExternalStoreDataKeyProvider

java.lang.Object

com.aliyun.encryptionsdk.provider.BaseDataKeyProvider

com.aliyun.encryptionsdk.provider.dataKey.AbstractExternalStoreDataKeyProvider

Direct Known Subclasses:

SecretManagerDataKeyProvider

public abstract class AbstractExternalStoreDataKeyProvider
extends BaseDataKeyProvider

BaseDataKeyProvider 的一个外部保存 CipherHeader 抽象实现， 密文中仅保存 CipherBody 部分

Field Summary

Fields

Modifier and Type	Field and Description
protected String	dataKeyName

Fields inherited from class com.aliyun.encryptionsdk.provider.BaseDataKeyProvider

algorithm, handler, keyId, kms

Constructor Summary

Constructors

Constructor and Description
AbstractExternalStoreDataKeyProvider(String keyId, CryptoAlgorithm algorithm, String dataKeyName)
AbstractExternalStoreDataKeyProvider(String keyId, String dataKeyName)

Method Summary

Modifier and Type	Method and Description
protected void	calculateHeaderAuthTag(EncryptionMaterial newMaterial, CipherHeader cipherHeader)
DecryptionMaterial	decryptDataKey(DecryptionMaterial material, List<EncryptedDataKey> encryptedDataKeys) 解密数据密钥
protected abstract CipherHeader	getCipherHeader(String dataKeyName)
CipherMaterial	getCipherMaterial(byte[] cipherText) 通过密文或数据密钥关键字获取数据密钥并生成密码材料
byte[]	processCipherMaterial(CipherMaterial cipherMaterial) 处理密码材料生成字节数组，字节数组内容可能包含： 1.CipherMaterial 的所有内容 2.CipherMaterial 中的 CipherBody 部分（CipherHeader 部分由 AbstractExternalStoreDataKeyProvider 的实现自行处理）

Methods inherited from class com.aliyun.encryptionsdk.provider.BaseDataKeyProvider

encryptDataKey, getAlgorithm, setAlgorithm, setAliyunKms, setFormatHandler, setMultiCmkId

Methods inherited from class java.lang.Object

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

Field Detail

dataKeyName

protected String dataKeyName

Constructor Detail

AbstractExternalStoreDataKeyProvider

public AbstractExternalStoreDataKeyProvider(String keyId,
                                            String dataKeyName)

AbstractExternalStoreDataKeyProvider

public AbstractExternalStoreDataKeyProvider(String keyId,
                                            CryptoAlgorithm algorithm,
                                            String dataKeyName)

Method Detail

decryptDataKey

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

Description copied from class: BaseDataKeyProvider

解密数据密钥

Overrides:

decryptDataKey in class BaseDataKeyProvider

Parameters:

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

encryptedDataKeys - 数据密钥明文列表

Returns:

加密密钥材料

getCipherMaterial

public CipherMaterial getCipherMaterial(byte[] cipherText)

Description copied from class: BaseDataKeyProvider

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

Specified by:

getCipherMaterial in class BaseDataKeyProvider

Parameters:

cipherText - 密文

Returns:

密码材料

processCipherMaterial

public byte[] processCipherMaterial(CipherMaterial cipherMaterial)

Description copied from class: BaseDataKeyProvider

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

Specified by:

processCipherMaterial in class BaseDataKeyProvider

Parameters:

cipherMaterial - 密码材料

Returns:

加密结果

getCipherHeader

protected abstract CipherHeader getCipherHeader(String dataKeyName)

calculateHeaderAuthTag

protected void calculateHeaderAuthTag(EncryptionMaterial newMaterial,
                                      CipherHeader cipherHeader)