KeyAttribute (AWS CloudHSM JCE Provider)

java.lang.Object
- java.lang.Enum<KeyAttribute>
- - com.amazonaws.cloudhsm.jce.provider.attributes.KeyAttribute

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<KeyAttribute>
```
public enum KeyAttribute
extends java.lang.Enum<KeyAttribute>
```
A KeyAttribute contains key attribute values supported by the CloudHSM JCE provider. This type is used with KeyAttributesMap and KeyPairAttributesMap to specify multiple key attributes for an operation.

See Also:

Key Attribute Reference

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CRT_COEFFICIENT` Chinese Remainder Theorem coefficient.
`DECRYPT` Allows a key to be used for decrypt operations.
`DERIVE` Allows a key to be used to derive other keys.
`EC_PARAMS` EC domain parameters.
`EC_POINT` EC point represented as affine coordinates.
`ENCRYPT` Allows a key to be used for encrypt operations.
`EXTRACTABLE` Allows a key to be wrapped.
`ID` An Identifier that can be later used to retrieve a key by id.
`KCV` Used to verify the integrity of a key.
`KEY_TYPE` Contains a CloudHSM key algorithm.
`LABEL` A label that can be later used to retrieve a key by name.
`LOCAL` Indicates a key was generated by an HSM.
`MODULUS` Sets the modulus value for an RSA key.
`MODULUS_BITS` A modulus length given in bits.
`OBJECT_CLASS` Contains a CloudHSM object type.
`PRIME_EXPONENT_P` RSA prime exponent `p`.
`PRIME_EXPONENT_Q` RSA prime exponent `q`.
`PRIME_P` RSA prime factor `p`.
`PRIME_Q` RSA prime factor `q`.
`PRIVATE` Indicates a key is a private key.
`PRIVATE_EXPONENT` Sets the private exponent of an RSA key.
`PUBLIC_EXPONENT` Sets the public exponent of an RSA key.
`SIGN` Allows a key to be used for sign operations.
`SIZE` A key size given in bits.
`TOKEN` Designates a key as persistent.
`UNWRAP` Allows a key to be used for unwrap operations.
`VALUE` Sets the encoded value of a key.
`VERIFY` Allows a key to be used for verify operations.
`WRAP` Allows a key to be used for wrap operations.
`WRAP_WITH_TRUSTED` Allows a key to be wrapped only by keys with the `TRUSTED` attribute (not modeled in the JCE library).

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static KeyAttribute`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static KeyAttribute[]`	`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
  - OBJECT_CLASS
```
public static final KeyAttribute OBJECT_CLASS
```
    Contains a CloudHSM object type.
    
    See Also:
    
    ObjectClassType
  - KEY_TYPE
```
public static final KeyAttribute KEY_TYPE
```
    Contains a CloudHSM key algorithm.
    
    See Also:
    
    KeyType
  - LABEL
```
public static final KeyAttribute LABEL
```
    A label that can be later used to retrieve a key by name.
  - ID
```
public static final KeyAttribute ID
```
    An Identifier that can be later used to retrieve a key by id.
  - SIZE
```
public static final KeyAttribute SIZE
```
    A key size given in bits.
  - MODULUS_BITS
```
public static final KeyAttribute MODULUS_BITS
```
    A modulus length given in bits.
  - DECRYPT
```
public static final KeyAttribute DECRYPT
```
    Allows a key to be used for decrypt operations.
  - DERIVE
```
public static final KeyAttribute DERIVE
```
    Allows a key to be used to derive other keys.
  - ENCRYPT
```
public static final KeyAttribute ENCRYPT
```
    Allows a key to be used for encrypt operations.
  - EXTRACTABLE
```
public static final KeyAttribute EXTRACTABLE
```
    Allows a key to be wrapped.
  - LOCAL
```
public static final KeyAttribute LOCAL
```
    Indicates a key was generated by an HSM.
  - PRIVATE
```
public static final KeyAttribute PRIVATE
```
    Indicates a key is a private key.
  - SIGN
```
public static final KeyAttribute SIGN
```
    Allows a key to be used for sign operations.
  - TOKEN
```
public static final KeyAttribute TOKEN
```
    Designates a key as persistent.
    
    See Also:
    
    AWS CloudHSM Quotas for key limits.
  - UNWRAP
```
public static final KeyAttribute UNWRAP
```
    Allows a key to be used for unwrap operations.
  - VERIFY
```
public static final KeyAttribute VERIFY
```
    Allows a key to be used for verify operations.
  - WRAP
```
public static final KeyAttribute WRAP
```
    Allows a key to be used for wrap operations.
  - VALUE
```
public static final KeyAttribute VALUE
```
    Sets the encoded value of a key. Used for importing keys into CloudHSM.
  - MODULUS
```
public static final KeyAttribute MODULUS
```
    Sets the modulus value for an RSA key.
  - PUBLIC_EXPONENT
```
public static final KeyAttribute PUBLIC_EXPONENT
```
    Sets the public exponent of an RSA key.
  - KCV
```
public static final KeyAttribute KCV
```
    Used to verify the integrity of a key.
    
    See Also:
    
    Key check value (KCV)
  - PRIVATE_EXPONENT
```
public static final KeyAttribute PRIVATE_EXPONENT
```
    Sets the private exponent of an RSA key.
  - PRIME_P
```
public static final KeyAttribute PRIME_P
```
    RSA prime factor p.
  - PRIME_Q
```
public static final KeyAttribute PRIME_Q
```
    RSA prime factor q.
  - PRIME_EXPONENT_P
```
public static final KeyAttribute PRIME_EXPONENT_P
```
    RSA prime exponent p.
  - PRIME_EXPONENT_Q
```
public static final KeyAttribute PRIME_EXPONENT_Q
```
    RSA prime exponent q.
  - CRT_COEFFICIENT
```
public static final KeyAttribute CRT_COEFFICIENT
```
    Chinese Remainder Theorem coefficient.
  - EC_PARAMS
```
public static final KeyAttribute EC_PARAMS
```
    EC domain parameters.
    
    See Also:
    
    ECParameterSpec
  - EC_POINT
```
public static final KeyAttribute EC_POINT
```
    EC point represented as affine coordinates.
    
    See Also:
    
    ECPoint
  - WRAP_WITH_TRUSTED
```
public static final KeyAttribute WRAP_WITH_TRUSTED
```
    Allows a key to be wrapped only by keys with the TRUSTED attribute (not modeled in the JCE library).
    
    See Also:
    
    Key Attribute Reference
- Method Detail
  - values
```
public static KeyAttribute[] 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 (KeyAttribute c : KeyAttribute.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static KeyAttribute 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

Enum KeyAttribute

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

OBJECT_CLASS

KEY_TYPE

LABEL

ID

SIZE

MODULUS_BITS

DECRYPT

DERIVE

ENCRYPT

EXTRACTABLE

LOCAL

PRIVATE

SIGN

TOKEN

UNWRAP

VERIFY

WRAP

VALUE

MODULUS

PUBLIC_EXPONENT

KCV

PRIVATE_EXPONENT

PRIME_P

PRIME_Q

PRIME_EXPONENT_P

PRIME_EXPONENT_Q

CRT_COEFFICIENT

EC_PARAMS

EC_POINT

WRAP_WITH_TRUSTED

Method Detail

values

valueOf