Package com.amazonaws.encryptionsdk

Enum CommitmentPolicy

java.lang.Object

java.lang.Enum<CommitmentPolicy>

com.amazonaws.encryptionsdk.CommitmentPolicy

All Implemented Interfaces:

Serializable, Comparable<CommitmentPolicy>

public enum CommitmentPolicy
extends Enum<CommitmentPolicy>

Governs how a AwsCrypto behaves during configuration, encryption, and decryption, with respect to key commitment.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ForbidEncryptAllowDecrypt	On encrypty, algorithm suite must NOT support key commitment; On decrypt, if a key commitment is present on the ciphertext, then the key commitment must be valid.
RequireEncryptAllowDecrypt	On encrypt, algorithm suite must support key commitment; On decrypt, if a key commitment is present on the ciphertext, then the key commitment must be valid.
RequireEncryptRequireDecrypt	Algorithm suite must support key commitment.

Method Summary

Modifier and Type	Method	Description
boolean	algorithmAllowedForDecrypt(CryptoAlgorithm algorithm)	Validates that an algorithm meets the Policy's On decrypt key commitment.
boolean	algorithmAllowedForEncrypt(CryptoAlgorithm algorithm)	Validates that an algorithm meets the Policy's On encrypt key commitment.
software.amazon.cryptography.materialproviders.model.CommitmentPolicy	getMplCommitmentPolicy()
static CommitmentPolicy	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CommitmentPolicy[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ForbidEncryptAllowDecrypt

public static final CommitmentPolicy ForbidEncryptAllowDecrypt

On encrypty, algorithm suite must NOT support key commitment; On decrypt, if a key commitment is present on the ciphertext, then the key commitment must be valid. Key commitment will NOT be included in ciphertext on encrypt.

RequireEncryptAllowDecrypt

public static final CommitmentPolicy RequireEncryptAllowDecrypt

On encrypt, algorithm suite must support key commitment; On decrypt, if a key commitment is present on the ciphertext, then the key commitment must be valid. Key commitment will be included in ciphertext on encrypt.

RequireEncryptRequireDecrypt

public static final CommitmentPolicy RequireEncryptRequireDecrypt

Algorithm suite must support key commitment. Key commitment will be included in ciphertext on encrypt. Valid key commitment must be present in ciphertext on decrypt.

Method Detail

values

public static CommitmentPolicy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CommitmentPolicy c : CommitmentPolicy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CommitmentPolicy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getMplCommitmentPolicy

public software.amazon.cryptography.materialproviders.model.CommitmentPolicy getMplCommitmentPolicy()

algorithmAllowedForEncrypt

public boolean algorithmAllowedForEncrypt(CryptoAlgorithm algorithm)

Validates that an algorithm meets the Policy's On encrypt key commitment.

algorithmAllowedForDecrypt

public boolean algorithmAllowedForDecrypt(CryptoAlgorithm algorithm)

Validates that an algorithm meets the Policy's On decrypt key commitment.