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

Enum CryptoKeyWrapAlgorithm

java.lang.Object

java.lang.Enum<CryptoKeyWrapAlgorithm>

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

All Implemented Interfaces:

Serializable, Comparable<CryptoKeyWrapAlgorithm>

public enum CryptoKeyWrapAlgorithm
extends Enum<CryptoKeyWrapAlgorithm>

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.

Configure the key wrap algorithm to be used for encryption in in CryptoConfigurationV2.

Note:This value can only be used in conjunction with the V2 version of the encryption client, com.ibm.cloud.objectstorage.services.s3.AmazonS3EncryptionClientV2.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AES_GCM_NoPadding Default symmetric encryption algorithm
KMS When the delivery mechanism is KMS (not an algorithm per se)
RSA_OAEP_SHA1 Default asymmetric encryption algorithm.

Method Summary

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

AES_GCM_NoPadding

public static final CryptoKeyWrapAlgorithm AES_GCM_NoPadding

Default symmetric encryption algorithm

RSA_OAEP_SHA1

public static final CryptoKeyWrapAlgorithm RSA_OAEP_SHA1

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

KMS

public static final CryptoKeyWrapAlgorithm KMS

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

Method Detail

values

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

Returns:

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

valueOf

public static CryptoKeyWrapAlgorithm 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()