com.amazonaws.encryptionsdk

Class MasterKeyProvider<K extends MasterKey<K>>

java.lang.Object

com.amazonaws.encryptionsdk.MasterKeyProvider<K>

Type Parameters:

K - the type of MasterKey returned by this provider

Direct Known Subclasses:

AwsKmsMrkAwareMasterKeyProvider, AwsKmsMrkAwareMasterKeyProvider, KeyStoreProvider, KmsMasterKeyProvider, KmsMasterKeyProvider, MasterKey

public abstract class MasterKeyProvider<K extends MasterKey<K>>
extends Object

Represents the logic necessary to select and construct MasterKeys for encrypting and decrypting messages. This is an abstract class.

Constructor Summary

Constructors

Constructor and Description
MasterKeyProvider()

Method Summary

Modifier and Type	Method and Description
protected AwsCryptoException	buildCannotDecryptDksException()
protected AwsCryptoException	buildCannotDecryptDksException(List<? extends Throwable> t)
protected AwsCryptoException	buildCannotDecryptDksException(Throwable t)
boolean	canProvide(String provider) Returns true if this MasterKeyProvider can provide keys from the specified @{code provider}.
abstract DataKey<K>	decryptDataKey(CryptoAlgorithm algorithm, Collection<? extends EncryptedDataKey> encryptedDataKeys, Map<String,String> encryptionContext) Iterates through encryptedDataKeys and returns the first one which can be successfully decrypted.
abstract String	getDefaultProviderId() ProviderId used by this instance when no other is specified.
K	getMasterKey(String keyId) Equivalent to calling getMasterKey(String, String) using getDefaultProviderId() as the provider.
abstract K	getMasterKey(String provider, String keyId) Returns the specified MasterKey if possible.
abstract List<K>	getMasterKeysForEncryption(MasterKeyRequest request) Returns all MasterKeys which should be used to protect the plaintext described by request.

Methods inherited from class java.lang.Object

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

Constructor Detail

MasterKeyProvider

public MasterKeyProvider()

Method Detail

getDefaultProviderId

public abstract String getDefaultProviderId()

ProviderId used by this instance when no other is specified.

canProvide

public boolean canProvide(String provider)

Returns true if this MasterKeyProvider can provide keys from the specified @{code provider}.

Parameters:

provider -

Returns:

getMasterKey

public K getMasterKey(String keyId)
               throws UnsupportedProviderException,
                      NoSuchMasterKeyException

Equivalent to calling getMasterKey(String, String) using getDefaultProviderId() as the provider.

Throws:

UnsupportedProviderException

NoSuchMasterKeyException

getMasterKey

public abstract K getMasterKey(String provider,
                               String keyId)
                        throws UnsupportedProviderException,
                               NoSuchMasterKeyException

Returns the specified MasterKey if possible.

Parameters:

provider -

keyId -

Returns:

Throws:

UnsupportedProviderException - if this object cannot return MasterKeys associated with the given provider

NoSuchMasterKeyException - if this object cannot find (and thus construct) the MasterKey associated with keyId

getMasterKeysForEncryption

public abstract List<K> getMasterKeysForEncryption(MasterKeyRequest request)

Returns all MasterKeys which should be used to protect the plaintext described by request.

decryptDataKey

public abstract DataKey<K> decryptDataKey(CryptoAlgorithm algorithm,
                                          Collection<? extends EncryptedDataKey> encryptedDataKeys,
                                          Map<String,String> encryptionContext)
                                   throws UnsupportedProviderException,
                                          AwsCryptoException

Iterates through encryptedDataKeys and returns the first one which can be successfully decrypted.

Returns:

a DataKey if one can be decrypted, otherwise returns null

Throws:

UnsupportedProviderException - if the encryptedDataKey is associated with an unsupported provider

CannotUnwrapDataKeyException - if the encryptedDataKey cannot be decrypted

AwsCryptoException

buildCannotDecryptDksException

protected AwsCryptoException buildCannotDecryptDksException()

buildCannotDecryptDksException

protected AwsCryptoException buildCannotDecryptDksException(Throwable t)

buildCannotDecryptDksException

protected AwsCryptoException buildCannotDecryptDksException(List<? extends Throwable> t)