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

Packages that use CryptoKey

Package	Description
org.forgerock.secrets	Provides a unified API for accessing secrets of various kinds.
org.forgerock.secrets.keys	Contains cryptographic key related API objects.

Uses of CryptoKey in org.forgerock.secrets

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

Modifier and Type	Method	Description
<T extends CryptoKey> KeyStore	SecretsProvider.asKeyStore(Purpose<T> purpose)	Returns a view of this secrets provider as a keystore for the given purpose.

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

Modifier and Type	Method	Description
static SecretConstraint<CryptoKey>	SecretConstraint.allowedAlgorithm(String algorithm)	Enforces that the key is allowed to be used with the given algorithm.
static SecretConstraint<CryptoKey>	SecretConstraint.allowedKeyUsages(Set<KeyUsage> keyUsages)	Enforces that the key satisfies at least one of the given key usage constraints.
static SecretConstraint<CryptoKey>	SecretConstraint.allowedKeyUsages(KeyUsage first, KeyUsage... rest)	Enforces that the key satisfies at least one of the given key usage constraints.
static SecretConstraint<CryptoKey>	SecretConstraint.ellipticCurveKeyParameters(ECParameterSpec requiredParameters)	Enforces that the key is an elliptic curve key with the given parameters.
static SecretConstraint<CryptoKey>	SecretConstraint.keyAlgorithm(String keyAlgorithm)	Enforces a particular key algorithm (case insensitive).
static SecretConstraint<CryptoKey>	SecretConstraint.requiredKeyUsages(Set<KeyUsage> keyUsages)	Enforces that the key satisfies all of the given key usage constraints.
static SecretConstraint<CryptoKey>	SecretConstraint.requiredKeyUsages(KeyUsage first, KeyUsage... rest)	Enforces that the key satisfies all of the given key usage constraints.

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

Modifier and Type	Method	Description
X509ExtendedKeyManager	SecretsProvider.getKeyManager(Purpose<? extends CryptoKey> purpose)	Returns a KeyManager that can be used to initialize an SSLContext, allowing certificates and private keys to be retrieved from this secrets provider.
X509ExtendedKeyManager	SecretsProvider.getKeyManager(Purpose<? extends CryptoKey> purpose, Options options)	Returns a KeyManager that can be used to initialize an SSLContext, allowing certificates and private keys to be retrieved from this secrets provider.
SecretsTrustManager	SecretsProvider.getTrustManager(Purpose<? extends CryptoKey> purpose)	Constructs an X509ExtendedTrustManager that will retrieve certificates from this secrets provider for the provided purpose.
SecretsTrustManager	SecretsProvider.getTrustManager(Purpose<? extends CryptoKey> purpose, Options options)	Constructs an X509ExtendedTrustManager that will retrieve certificates from this secrets provider for the provided purpose.

Constructor parameters in org.forgerock.secrets with type arguments of type CryptoKey

Constructor	Description
SecretsLoadStoreParameter(SecretsProvider secretsProvider, Purpose<? extends CryptoKey> purpose, Clock clock)	Initialises the keystore with the given secrets API objects.

Uses of CryptoKey in org.forgerock.secrets.keys

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

Modifier and Type	Interface	Description
interface	DecryptionKey<T extends CryptoKey>	Marker interface for all key types that can be used for decryption.
interface	EncryptionKey<T extends CryptoKey>	Marker interface for all key types that can be used for encryption.

Subclasses of CryptoKey in org.forgerock.secrets.keys

Modifier and Type	Class	Description
class	CertificateVerificationKey	A key used for verifying certificate signatures.
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	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	Description
T	KeyFormat.export(CryptoKey key, Key rawKey)	Exports the given crypto key and raw key material.
String	KeyFormatPem.export(CryptoKey key, Key rawKey)
Key	KeyFormatRaw.export(CryptoKey key, Key rawKey)

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

Modifier and Type	Method	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.