com.ibm.cloud.objectstorage.services.s3.model

Enum CryptoMode

java.lang.Object

java.lang.Enum<CryptoMode>

com.ibm.cloud.objectstorage.services.s3.model.CryptoMode

All Implemented Interfaces:

Serializable, Comparable<CryptoMode>

public enum CryptoMode
extends Enum<CryptoMode>

Denotes the different cryptographic modes available for securing an S3 object via client-side encryption.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AuthenticatedEncryption Authenticated encryption mode using AES/GCM, AESWrap, etc.
EncryptionOnly Deprecated. This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
StrictAuthenticatedEncryption Strictly enforce the use of authenticated encryption via AES/GCM, AESWrap, etc., and will throw security exception if an S3 object retrieved is found to be not protected using authenticated encryption.

Method Summary

Modifier and Type	Method and Description
static CryptoMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static CryptoMode[]	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

EncryptionOnly

@Deprecated
public static final CryptoMode EncryptionOnly

Deprecated. This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.

Encryption-only mode using AES/CBC.

AuthenticatedEncryption

public static final CryptoMode AuthenticatedEncryption

Authenticated encryption mode using AES/GCM, AESWrap, etc. Please note the limitation on the maximum message size in bytes that can be encrypted under this mode is 2^36-32, or ~64G, due to the security limitation of AES/GCM as recommended by NIST.

When decrypting with AES-GCM, read the entire object to the end before you start using the decrypted data. This is to verify that the object has not been modified since it was encrypted.

StrictAuthenticatedEncryption

public static final CryptoMode StrictAuthenticatedEncryption

Strictly enforce the use of authenticated encryption via AES/GCM, AESWrap, etc., and will throw security exception if an S3 object retrieved is found to be not protected using authenticated encryption. This means range-get operation is not supported in this mode, since range-get is not authenticated.

Please note the limitation on the maximum message size in bytes that can be encrypted under this mode is 2^36-32, or ~64G, due to the security limitation of AES/GCM as recommended by NIST.

When decrypting with AES-GCM, read the entire object to the end before you start using the decrypted data. This is to verify that the object has not been modified since it was encrypted.

Method Detail

values

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

Returns:

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

valueOf

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