com.ibm.crypto.hdwrCCA.provider

Enum SymmetricKeyConstants.KeyUsage

java.lang.Object

java.lang.Enum<SymmetricKeyConstants.KeyUsage>

com.ibm.crypto.hdwrCCA.provider.SymmetricKeyConstants.KeyUsage

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SymmetricKeyConstants.KeyUsage>

Enclosing class:

SymmetricKeyConstants

public static enum SymmetricKeyConstants.KeyUsage
extends java.lang.Enum<SymmetricKeyConstants.KeyUsage>

Key usage attributes consisting of a combination of key form and key functionality. OP key represents a single operational key that is wrapped by the ICSF master key and may be used in crypto operations on the current system. OPEX keys represent a pair of keys, the first one operational, and the second exportable. Exportable keys are wrapped by a key encrypting key for export to a different system, and cannot be used in crypto operations on the current system. Key usage attributes only apply to SymmetricKeyConstants.KeyType.CKDS and SymmetricKeyConstants.KeyType.SECURE_INTERNAL_TOKEN keys, and do not apply to SymmetricKeyConstants.KeyType.CLEAR keys, since SymmetricKeyConstants.KeyType.CLEAR keys do not have usage restrictions.

Enum Constant Summary

Enum Constants

Enum Constant and Description
OP_CIPHER A single operational CIPHER key.
OP_DATA A single operational DATA key.
OP_EXPORTER Operational EXPORTER key encrypting key.
OP_IMPORTER Operational IMPORTER key encrypting key.
OPEX_EXPORTER_IMPORTER A key pair.
OPEX_IMPORTER_EXPORTER A key pair.

Method Summary

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

OP_DATA

public static final SymmetricKeyConstants.KeyUsage OP_DATA

A single operational DATA key.

OP_CIPHER

public static final SymmetricKeyConstants.KeyUsage OP_CIPHER

A single operational CIPHER key.

OP_IMPORTER

public static final SymmetricKeyConstants.KeyUsage OP_IMPORTER

Operational IMPORTER key encrypting key. Protects keys of any type that are sent from another system to the local system. Only supported for DESede and AES keys.

OP_EXPORTER

public static final SymmetricKeyConstants.KeyUsage OP_EXPORTER

Operational EXPORTER key encrypting key. Protects keys of any type that are sent from the local system to another system. Only supported for DESede and AES keys.

OPEX_EXPORTER_IMPORTER

public static final SymmetricKeyConstants.KeyUsage OPEX_EXPORTER_IMPORTER

A key pair. The first key is an operational EXPORTER key, and the second key is the corresponding exportable IMPORTER key.

OPEX_IMPORTER_EXPORTER

public static final SymmetricKeyConstants.KeyUsage OPEX_IMPORTER_EXPORTER

A key pair. The first key is an operational IMPORTER key, and the second key is the corresponding exportable EXPORTER key.

Method Detail

values

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

Returns:

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

valueOf

public static SymmetricKeyConstants.KeyUsage 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