Uses of Class
org.forgerock.secrets.keys.CryptoKey

Packages that use CryptoKey

Package	Description
org.forgerock.openam.secrets	The AM supporting classes for centrally configuring secrets.
org.forgerock.secrets.jwkset	Secret store backend for retrieving keys from a local or remote JWK Set.
org.forgerock.secrets.keys	Contains cryptographic key related API objects.
org.forgerock.secrets.keystore	Implementations of SecretStore for accessing keys stored in Java KeyStores, such as PKCS#11 Hardware Security Modules (HSMs) and PKCS#12 file-based encrypted key stores.

Uses of CryptoKey in org.forgerock.openam.secrets

Methods in org.forgerock.openam.secrets with parameters of type CryptoKey

Modifier and Type	Method and Description
static Key	SecretsUtils.convertRawEncryptionKey(CryptoKey cryptoKey, JweAlgorithm jweAlgorithm, EncryptionMethod encryptionMethod) Converts symmetric encryption key that was created using the RAW algorithm to a more suitable key, but only if the key material is available.

Uses of CryptoKey in org.forgerock.secrets.jwkset

Methods in org.forgerock.secrets.jwkset with type parameters of type CryptoKey

Modifier and Type	Method and Description
<S extends CryptoKey> Promise<S,NoSuchSecretException>	JwkSetSecretStore.getActive(Purpose<S> purpose)
<S extends CryptoKey> Promise<S,NoSuchSecretException>	JwkSetSecretStore.getNamed(Purpose<S> purpose, String name)
<S extends CryptoKey> Promise<Stream<S>,NeverThrowsException>	JwkSetSecretStore.getValid(Purpose<S> purpose)

Methods in org.forgerock.secrets.jwkset that return types with arguments of type CryptoKey

Modifier and Type	Method and Description
Class<CryptoKey>	JwkSetSecretStore.getStoredType()

Methods in org.forgerock.secrets.jwkset with parameters of type CryptoKey

Modifier and Type	Method and Description
JWK	JwkKeyFormat.export(CryptoKey key, Key rawKey)

Uses of CryptoKey in org.forgerock.secrets.keys

Subclasses of CryptoKey in org.forgerock.secrets.keys

Modifier and Type	Class and Description
class	DataDecryptionKey A key that is used for decrypting confidential data.
class	DataEncryptionKey A key that is used for encrypting confidential data.
class	KeyAgreementKey A key that is used in a key-agreement protocol (such as Diffie-Hellman) to agree another key.
class	KeyDecryptionKey A key that is used to decrypt (or "unwrap") other keys that have been encrypted with a KeyEncryptionKey.
class	KeyEncryptionKey A key that is used to encrypt ("wrap") other keys.
class	SigningKey A key that is used for signing digital signatures.
class	VerificationKey A key used for verifying digital signatures.

Methods in org.forgerock.secrets.keys that return types with arguments of type CryptoKey

Modifier and Type	Method and Description
Class<? extends CryptoKey>	KeyUsage.getKeyType() The key type corresponding to this key usage.

Methods in org.forgerock.secrets.keys with parameters of type CryptoKey

Modifier and Type	Method and Description
Key	KeyFormatRaw.export(CryptoKey key, Key rawKey)
String	KeyFormatPem.export(CryptoKey key, Key rawKey)
T	KeyFormat.export(CryptoKey key, Key rawKey) Exports the given crypto key and raw key material.

Method parameters in org.forgerock.secrets.keys with type arguments of type CryptoKey

Modifier and Type	Method and Description
static EnumSet<KeyUsage>	KeyUsage.forKeyType(Class<? extends CryptoKey> keyType) Returns the set of all key usages that are applicable to the given key type.

Uses of CryptoKey in org.forgerock.secrets.keystore

Methods in org.forgerock.secrets.keystore with type parameters of type CryptoKey

Modifier and Type	Method and Description
<S extends CryptoKey> Promise<S,NoSuchSecretException>	KeyStoreSecretStore.getActive(Purpose<S> purpose)
<S extends CryptoKey> Promise<S,NoSuchSecretException>	KeyStoreSecretStore.getNamed(Purpose<S> purpose, String id)
<S extends CryptoKey> Promise<Stream<S>,NeverThrowsException>	KeyStoreSecretStore.getValid(Purpose<S> purpose)

Methods in org.forgerock.secrets.keystore that return types with arguments of type CryptoKey

Modifier and Type	Method and Description
Class<CryptoKey>	KeyStoreSecretStore.getStoredType()

Method parameters in org.forgerock.secrets.keystore with type arguments of type CryptoKey

Modifier and Type	Method and Description
void	KeyStoreSecretStore.retire(Purpose<? extends CryptoKey> purpose, String oldAlias) Retires a key previously used for a given purpose.
void	KeyStoreSecretStore.rotate(Purpose<? extends CryptoKey> purpose, String newAlias) Rotates the key associated with a given purpose.