org.forgerock.secrets

Class Purpose<T extends Secret>

java.lang.Object

org.forgerock.secrets.Purpose<T>

Type Parameters:

T - the type of secret that this purpose requires.

public final class Purpose<T extends Secret>
extends Object

A purpose encapsulates both a name for a function that requires access to secrets, together with a hint as to the intended usage of those secrets. A purpose by itself may not uniquely identify a particular secret, as the secret for that purpose may change over time. A collection of general purposes are exposed by this class, but application developers are encouraged to create specific purpose instances that better describe the usage of a secret or key.

Field Summary

Fields

Modifier and Type	Field and Description
static Purpose<DataDecryptionKey>	DATA_DECRYPTION Indicates a key intended for decrypting data.
static Purpose<DataEncryptionKey>	DATA_ENCRYPTION Indicates a key intended for encrypting data.
static Purpose<KeyAgreementKey>	KEY_AGREEMENT Indicates a key intended for an interactive key agreement protocol, such as Diffie-Hellman (DH) or the elliptic curve equivalent (ECDH).
static Purpose<KeyDecryptionKey>	KEY_DECRYPTION Indicates a key intended for decrypting ("unwrapping") other keys.
static Purpose<KeyEncryptionKey>	KEY_ENCRYPTION Indicates a key intended for encrypting ("wrapping") other keys.
static Pattern	LABEL_PATTERN The regular expression to use when validating purpose labels.
static Purpose<GenericSecret>	PASSWORD Indicates a secret intended to be used as a password for authentication to some service.
static Purpose<SigningKey>	SIGN Indicates a key intended for creating digital signatures or message authentication codes (MACs).
static Purpose<VerificationKey>	VERIFY Indicates a key intended for verifying digital signatures or message authentication codes.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object that)
String	getLabel() Returns a symbolic label for this purpose that can be used in routing requests for secrets.
Class<T>	getSecretType() Returns the type of secrets that this purpose requires.
int	hashCode()
static <T extends Secret> Purpose<T>	purpose(String label, Class<T> type) Constructs a purpose object.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

LABEL_PATTERN

public static final Pattern LABEL_PATTERN

The regular expression to use when validating purpose labels.

SIGN

public static final Purpose<SigningKey> SIGN

Indicates a key intended for creating digital signatures or message authentication codes (MACs).

VERIFY

public static final Purpose<VerificationKey> VERIFY

Indicates a key intended for verifying digital signatures or message authentication codes.

DATA_ENCRYPTION

public static final Purpose<DataEncryptionKey> DATA_ENCRYPTION

Indicates a key intended for encrypting data.

DATA_DECRYPTION

public static final Purpose<DataDecryptionKey> DATA_DECRYPTION

Indicates a key intended for decrypting data.

KEY_ENCRYPTION

public static final Purpose<KeyEncryptionKey> KEY_ENCRYPTION

Indicates a key intended for encrypting ("wrapping") other keys. Often used to encrypt a temporary symmetric session key with a public key.

KEY_DECRYPTION

public static final Purpose<KeyDecryptionKey> KEY_DECRYPTION

Indicates a key intended for decrypting ("unwrapping") other keys.

KEY_AGREEMENT

public static final Purpose<KeyAgreementKey> KEY_AGREEMENT

Indicates a key intended for an interactive key agreement protocol, such as Diffie-Hellman (DH) or the elliptic curve equivalent (ECDH). Note that the agreed key should not be used directly, but typically passed through some key derivation process.

PASSWORD

public static final Purpose<GenericSecret> PASSWORD

Indicates a secret intended to be used as a password for authentication to some service.

Method Detail

purpose

public static <T extends Secret> Purpose<T> purpose(String label,
                                                    Class<T> type)

Constructs a purpose object.

Type Parameters:

T - the type of secret.

Parameters:

label - the symbolic label to identify this purpose. Must consist only of alphanumeric and dot characters.

type - the type of secret that this purpose requires.

Returns:

the purpose object.

getSecretType

public Class<T> getSecretType()

Returns the type of secrets that this purpose requires.

Returns:

the type of secrets.

getLabel

public String getLabel()

Returns a symbolic label for this purpose that can be used in routing requests for secrets.

Returns:

the symbolic label for this purpose.

equals

public boolean equals(Object that)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object