Module ibm.crypto.hdwrcca
Package com.ibm.crypto.hdwrCCA.provider

Enum Class SymmetricKeyConstants.KeyUsage

java.lang.Object
java.lang.Enum<SymmetricKeyConstants.KeyUsage>
com.ibm.crypto.hdwrCCA.provider.SymmetricKeyConstants.KeyUsage
All Implemented Interfaces:
Serializable, Comparable<SymmetricKeyConstants.KeyUsage>, Constable
Enclosing class:
SymmetricKeyConstants
public static enum SymmetricKeyConstants.KeyUsage extends 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 Details

    • 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 Details

    • values

      public static SymmetricKeyConstants.KeyUsage[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static SymmetricKeyConstants.KeyUsage valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null