com.amazonaws.services.s3.internal.crypto.keywrap

Enum InternalKeyWrapAlgorithm

java.lang.Object

java.lang.Enum<InternalKeyWrapAlgorithm>

com.amazonaws.services.s3.internal.crypto.keywrap.InternalKeyWrapAlgorithm

All Implemented Interfaces:

Serializable, Comparable<InternalKeyWrapAlgorithm>

public enum InternalKeyWrapAlgorithm
extends Enum<InternalKeyWrapAlgorithm>

Denotes the key wrap (encryption) algorithm to use for encryption/decryption. Both symmetric and asymmetric algorithms are defined; the algorithm must be consistent with the type of key specified in the materials. For asymmetric keys only asymmetric algorithm types are allowed, for symmetric keys symmetric algorithms. see also the externally available encryption values: CryptoKeyWrapAlgorithm.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AES_GCM_NoPadding Default symmetric encryption algorithm
AESWrap Symmetric legacy encryption algorithm supported for decryption purposes only.
KMS When the delivery mechanism is KMS (not an algorithm per se)
KMS_V1 KMS in legacy mode
RSA_ECB_OAEPWithSHA256AndMGF1Padding Asymmetric legacy encryption algorithm supported for decryption purposes only.
RSA_OAEP_SHA1 Default asymmetric encryption algorithm.

Method Summary

Modifier and Type	Method and Description
String	algorithmName() The String representation of the algorithm common to AWS independently of language used.
static InternalKeyWrapAlgorithm	fromAlgorithmName(String algorithmName)
static InternalKeyWrapAlgorithm	fromExternal(CryptoKeyWrapAlgorithm external)
boolean	isAsymmetric()
boolean	isKMS()
boolean	isSymmetric()
boolean	isV1Algorithm()
static InternalKeyWrapAlgorithm	valueOf(String name) Returns the enum constant of this type with the specified name.
static InternalKeyWrapAlgorithm[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AES_GCM_NoPadding

public static final InternalKeyWrapAlgorithm AES_GCM_NoPadding

Default symmetric encryption algorithm

AESWrap

public static final InternalKeyWrapAlgorithm AESWrap

Symmetric legacy encryption algorithm supported for decryption purposes only.

RSA_OAEP_SHA1

public static final InternalKeyWrapAlgorithm RSA_OAEP_SHA1

Default asymmetric encryption algorithm. The encryption algorithm is RSA/ECB/OAEPPadding using SHA1 for MGF1 (masking gate function)

RSA_ECB_OAEPWithSHA256AndMGF1Padding

public static final InternalKeyWrapAlgorithm RSA_ECB_OAEPWithSHA256AndMGF1Padding

Asymmetric legacy encryption algorithm supported for decryption purposes only.

KMS

public static final InternalKeyWrapAlgorithm KMS

When the delivery mechanism is KMS (not an algorithm per se)

KMS_V1

public static final InternalKeyWrapAlgorithm KMS_V1

KMS in legacy mode

Method Detail

values

public static InternalKeyWrapAlgorithm[] 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 (InternalKeyWrapAlgorithm c : InternalKeyWrapAlgorithm.values())
    System.out.println(c);

Returns:

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

valueOf

public static InternalKeyWrapAlgorithm 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

algorithmName

public String algorithmName()

The String representation of the algorithm common to AWS independently of language used.

fromExternal

public static InternalKeyWrapAlgorithm fromExternal(CryptoKeyWrapAlgorithm external)

fromAlgorithmName

public static InternalKeyWrapAlgorithm fromAlgorithmName(String algorithmName)

isV1Algorithm

public boolean isV1Algorithm()

isAsymmetric

public boolean isAsymmetric()

isSymmetric

public boolean isSymmetric()

isKMS

public boolean isKMS()