public enum CloudHsmKeyAttributePermissiveProfile extends java.lang.Enum<CloudHsmKeyAttributePermissiveProfile>
When a Cavium ParameterSpec class is instantiated with either a CloudHsmKeyAttributesMap
or CloudHsmKeyPairAttributesMap object, an appropriate profile will be called upon to
pre-configure the Cavium ParameterSpec's key attributes and values.
The specific profile used is determined automatically by the key operation and type of Cavium ParameterSpec object being configured.
After a profile is applied, the key attributes and values stored in
CloudHsmKeyAttributesMap or CloudHsmKeyPairAttributesMap (if any) will be
superimposed. Therefore, the creator of the CloudHsmKeyAttributesMap or
CloudHsmKeyPairAttributesMap object is responsible for explicitly disabling (setting to
false) any key attributes that should not remain permissive.
The instantiated Cavium 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.
| Enum Constant and Description |
|---|
GENERATE_KEY
This profile will be applied during the generation and import of Symmetric, AES, DES3 and
Generic Secret keys.
|
GENERATE_KEY_PAIR
This profile will be applied during the generation of key pairs.
|
UNWRAP_KEY
This profile will be applied during a key unwrap operation.
|
| Modifier and Type | Method and Description |
|---|---|
CloudHsmKeyAttributesMap |
getKeyDefaultsMap()
Retrieves this profile's key attributes and values stored in a
CloudHsmKeyAttributesMap object. |
CloudHsmKeyPairAttributesMap |
getKeyPairDefaultsMap()
Retrieves this profile's key attributes and values stored in a
CloudHsmKeyPairAttributesMap object. |
static CloudHsmKeyAttributePermissiveProfile |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.
|
static CloudHsmKeyAttributePermissiveProfile[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final CloudHsmKeyAttributePermissiveProfile GENERATE_KEY_PAIR
The following key attributes and values will act as defaults before a
CloudHsmKeyPairAttributesMap is applied:
| Attribute | Value |
|---|---|
| CKA_TOKEN | false |
| CKA_PRIVATE | true |
| CKA_ENCRYPT | true |
| CKA_VERIFY | true |
| CKA_WRAP | true |
| Attribute | Value |
|---|---|
| CKA_TOKEN | false |
| CKA_PRIVATE | true |
| CKA_EXTRACTABLE | true |
| CKA_DECRYPT | true |
| CKA_SIGN | true |
| CKA_UNWRAP | true |
public static final CloudHsmKeyAttributePermissiveProfile GENERATE_KEY
The following key attributes and values will act as defaults before a
CloudHsmKeyAttributesMap is applied:
| Attribute | Value |
|---|---|
| CKA_TOKEN | false |
| CKA_PRIVATE | true |
| CKA_EXTRACTABLE | true |
| CKA_ENCRYPT | true |
| CKA_DECRYPT | true |
| CKA_SIGN | true |
| CKA_VERIFY | true |
| CKA_WRAP | true |
| CKA_UNWRAP | true |
public static final CloudHsmKeyAttributePermissiveProfile UNWRAP_KEY
The following key attributes and values will act as defaults before a
CloudHsmKeyAttributesMap is applied:
| Attribute | Value |
|---|---|
| CKA_TOKEN | false |
| CKA_PRIVATE | true |
| CKA_EXTRACTABLE | true |
| CKA_ENCRYPT | true |
| CKA_DECRYPT | true |
| CKA_SIGN | true |
| CKA_VERIFY | true |
| CKA_WRAP | true |
| CKA_UNWRAP | true |
public static CloudHsmKeyAttributePermissiveProfile[] values()
for (CloudHsmKeyAttributePermissiveProfile c : CloudHsmKeyAttributePermissiveProfile.values()) System.out.println(c);
public static CloudHsmKeyAttributePermissiveProfile valueOf(java.lang.String name)
name - the name of the enum constant to be returned.java.lang.IllegalArgumentException - if this enum type has no constant with the specified namejava.lang.NullPointerException - if the argument is nullpublic CloudHsmKeyAttributesMap getKeyDefaultsMap()
CloudHsmKeyAttributesMap object.CloudHsmKeyAttributesMap object.java.lang.UnsupportedOperationException - If called against GENERATE_KEY_PAIR.public CloudHsmKeyPairAttributesMap getKeyPairDefaultsMap()
CloudHsmKeyPairAttributesMap object.CloudHsmKeyPairAttributesMap object.java.lang.UnsupportedOperationException - If called against GENERATE_KEY or
UNWRAP_KEY.