Package | Description |
---|---|
org.forgerock.openig.secrets |
Provides the Common Secrets API for accessing secrets of various kinds.
|
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. |
Modifier and Type | Method and Description |
---|---|
static <S extends CryptoKey> |
SecretsUtils.retrieveCryptoKeyFromSecretId(SecretsService secretsService,
JsonValue secretIdNode,
Class<S> type)
Retrieves a
CryptoKey from the given node. |
static <S extends CryptoKey> |
SecretsUtils.retrieveKeyFromSecretId(SecretsService secretsService,
JsonValue secretIdNode,
Class<S> type)
Retrieves a
Key from the given node. |
Modifier and Type | Method and Description |
---|---|
static Key |
SecretsUtils.exportAsKey(CryptoKey cryptoKey)
Exports the key material in the raw format.
|
static Key |
SecretsUtils.exportAsKeyAndClose(CryptoKey cryptoKey)
Exports the key material in the raw format and close the provided key material.
|
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.
|
Modifier and Type | Method and Description |
---|---|
Class<? extends CryptoKey> |
KeyUsage.getKeyType()
The key type corresponding to this key usage.
|
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.
|
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.
|
Modifier and Type | Method and Description |
---|---|
<S extends CryptoKey> |
KeyStoreSecretStore.getActive(Purpose<S> purpose) |
<S extends CryptoKey> |
KeyStoreSecretStore.getNamed(Purpose<S> purpose,
String id) |
<S extends CryptoKey> |
KeyStoreSecretStore.getValid(Purpose<S> purpose) |
Modifier and Type | Method and Description |
---|---|
Class<CryptoKey> |
KeyStoreSecretStore.getStoredType() |
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.
|
Copyright 2011-2017 ForgeRock AS.