com.amazonaws.cloudhsm.jce.provider.attributes

Enum KeyAttributePermissiveProfile

java.lang.Object

java.lang.Enum<KeyAttributePermissiveProfile>

com.amazonaws.cloudhsm.jce.provider.attributes.KeyAttributePermissiveProfile

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<KeyAttributePermissiveProfile>

public enum KeyAttributePermissiveProfile
extends java.lang.Enum<KeyAttributePermissiveProfile>

A collection of profiles which apply specific key attributes and permissive values during various key operations.

When a KeyAttributesMap or KeyPairAttributesMap is instantiated, an appropriate profile will be called upon to pre-configure the ParameterSpec's key attributes and values.

The specific profile used is determined automatically by the key operation and type of ParameterSpec object being configured.

After a profile is applied, the key attributes and values stored in KeyAttributesMap or KeyPairAttributesMap (if any) will be superimposed. Therefore, the creator of the KeyAttributesMap or KeyPairAttributesMap object is responsible for explicitly disabling (setting to false) any key attributes that should not remain permissive.

The instantiated ParameterSpec object may then be passed as a parameter to an appropriate key operation method or class, where the combined key attributes and values will be utilized by the key operation.

See Also:

KeyAttributesMap, KeyPairAttributesMap

Enum Constant Summary

Enum Constants

Enum Constant and Description
KEY_CREATION This profile will be applied during the generation and import of Symmetric, AES, DES3 and Generic Secret keys.
KEY_PAIR_CREATION This profile will be applied during the generation of key pairs.

Method Summary

Modifier and Type	Method and Description
KeyAttributesMap	getKeyDefaultsMap() Retrieves this profile's key attributes and values stored in a KeyAttributesMap object.
KeyPairAttributesMap	getKeyPairDefaultsMap() Retrieves this profile's key attributes and values stored in a KeyPairAttributesMap object.
static KeyAttributePermissiveProfile	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static KeyAttributePermissiveProfile[]	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

KEY_PAIR_CREATION

public static final KeyAttributePermissiveProfile KEY_PAIR_CREATION

This profile will be applied during the generation of key pairs.

The following key attributes and values will act as defaults before a KeyPairAttributesMap is applied:

Public Key

Attribute	Value
TOKEN	false
PRIVATE	true
ENCRYPT	true
VERIFY	true
WRAP	true

Private Key

Attribute	Value
TOKEN	false
PRIVATE	true
EXTRACTABLE	true
DECRYPT	true
SIGN	true
UNWRAP	true

KEY_CREATION

public static final KeyAttributePermissiveProfile KEY_CREATION

This profile will be applied during the generation and import of Symmetric, AES, DES3 and Generic Secret keys.

The following key attributes and values will act as defaults before a KeyAttributesMap is applied:

Attribute	Value
TOKEN	false
PRIVATE	true
EXTRACTABLE	true
ENCRYPT	true
DECRYPT	true
SIGN	true
VERIFY	true
WRAP	true
UNWRAP	true

Method Detail

values

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

Returns:

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

valueOf

public static KeyAttributePermissiveProfile valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getKeyDefaultsMap

public KeyAttributesMap getKeyDefaultsMap()

Retrieves this profile's key attributes and values stored in a KeyAttributesMap object.

Returns:

A KeyAttributesMap object.

Throws:

java.lang.UnsupportedOperationException - If called against KEY_PAIR_CREATION.

getKeyPairDefaultsMap

public KeyPairAttributesMap getKeyPairDefaultsMap()

Retrieves this profile's key attributes and values stored in a KeyPairAttributesMap object.

Returns:

A KeyPairAttributesMap object.

Throws:

java.lang.UnsupportedOperationException - If called against KEY_CREATION.