Uses of Interface
org.forgerock.secrets.SecretStore

Packages that use SecretStore

Package	Description
org.forgerock.openam.secrets	The AM supporting classes for centrally configuring secrets.
org.forgerock.openam.secrets.config	Classes and interfaces to create configurable secret store backends.
org.forgerock.secrets	Provides a unified API for accessing secrets of various kinds.
org.forgerock.secrets.gcp.sm	Classes for integrating Google Secret Manager into the ForgeRock Secrets API.
org.forgerock.secrets.gcpkms	A secret store implementation that can retrieve keys from a Google Cloud Platform Key Management Service.
org.forgerock.secrets.jwkset	Secret store backend for retrieving keys from a local or remote JWK Set.
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.
org.forgerock.secrets.oauth2	A Secrets API backend that can obtain OAuth 2 access tokens from a token endpoint, along with a collection of grant type handlers.
org.forgerock.secrets.propertyresolver	Provides a SecretStore implementation that loads secrets from a Common Configuration PropertyResolver and then decodes it with a SecretPropertyFormat.
org.forgerock.secrets.vault	Secrets backend that reads secrets from a remote Hashicorp Vault server.

Uses of SecretStore in org.forgerock.openam.secrets

Methods in org.forgerock.openam.secrets that return SecretStore

Modifier and Type	Method	Description
SecretStore<? extends Secret>	LockedSecretStoreProvider.getStore(SecretStoreContext context, SecretsReferenceProvider secrets)	Get the commons SecretStore instance for this instance.
SecretStore<? extends Secret>	SimpleSecretStoreProvider.getStore(SecretStoreContext context)	Get the commons SecretStore instance for this instance.

Method parameters in org.forgerock.openam.secrets with type arguments of type SecretStore

Modifier and Type	Method	Description
protected SecretsReferenceProvider	Secrets.getSecretsReferenceProvider(List<SecretStore> allStores)

Uses of SecretStore in org.forgerock.openam.secrets.config

Methods in org.forgerock.openam.secrets.config that return SecretStore

Modifier and Type	Method	Description
default SecretStore<? extends Secret>	GoogleSecretManagerSecretStoreProvider.getStore(SecretStoreContext context, SecretsReferenceProvider secretsReferenceProvider)

Uses of SecretStore in org.forgerock.secrets

Classes in org.forgerock.secrets that implement SecretStore

Modifier and Type	Class	Description
final class	ThreadPoolSecretStore<T extends Secret>	A secret store that wraps another secret store and performs all query operations in a background thread using a thread pool.

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

Modifier and Type	Method	Description
protected <T extends Secret> void	SecretsProvider.setActiveStore(SecretStore<? super T> store, Purpose<? extends T> purpose)	Sets the active store to use for the given purpose.
final <T extends Secret> SecretsProvider	SecretsProvider.setActiveStore(SecretStore<? super T> store, Purpose<? extends T>... purposes)	Sets the active store to use for the given purpose.
SecretsProvider	SecretsProvider.setDefaultStores(SecretStore<?> activeStore, SecretStore<?>... defaultStores)	Sets the default store(s) to use if there is no specific store configured for a particular purpose.
static <S extends Secret> ThreadPoolSecretStore<S>	ThreadPoolSecretStore.wrap(SecretStore<S> store)	Wraps the given store in an asynchronous thread-pool executor using the system ForkJoinPool.commonPool().
static <S extends Secret> ThreadPoolSecretStore<S>	ThreadPoolSecretStore.wrap(SecretStore<S> store, ExecutorService executor)	Wraps the given store in an asynchronous thread-pool executor using the given thread pool.

Uses of SecretStore in org.forgerock.secrets.gcp.sm

Classes in org.forgerock.secrets.gcp.sm that implement SecretStore

Modifier and Type	Class	Description
final class	GoogleSecretManagerSecretStore	A secret store that can read secrets directly from Google Secret Manager.

Uses of SecretStore in org.forgerock.secrets.gcpkms

Classes in org.forgerock.secrets.gcpkms that implement SecretStore

Modifier and Type	Class	Description
final class	GoogleKmsSecretStore	A secret store that can provide cryptographic keys based on the Google Cloud Platform Key Management Service.

Uses of SecretStore in org.forgerock.secrets.jwkset

Classes in org.forgerock.secrets.jwkset that implement SecretStore

Modifier and Type	Class	Description
class	JwkSetSecretStore	A secret store that loads cryptographic keys from a local or remote JWKSet.

Uses of SecretStore in org.forgerock.secrets.keystore

Classes in org.forgerock.secrets.keystore that implement SecretStore

Modifier and Type	Class	Description
class	KeyStoreSecretStore	A secret store for cryptographic keys based on a standard Java KeyStore.

Uses of SecretStore in org.forgerock.secrets.oauth2

Classes in org.forgerock.secrets.oauth2 that implement SecretStore

Modifier and Type	Class	Description
final class	AccessTokenSecretStore	A secret store that can obtain access tokens from an OAuth 2 provider.

Uses of SecretStore in org.forgerock.secrets.propertyresolver

Classes in org.forgerock.secrets.propertyresolver that implement SecretStore

Modifier and Type	Class	Description
final class	FileSystemSecretStore	A SecretStore that reads secrets from a directory with the expectation that each file contains a separate secret.
class	PropertyResolverSecretStore	A SecretStore implementation that resolves secrets as base64-encoded strings from an underlying PropertyResolver.

Uses of SecretStore in org.forgerock.secrets.vault

Classes in org.forgerock.secrets.vault that implement SecretStore

Modifier and Type	Class	Description
class	AppRoleTokenStore	Authenticates to Vault using the AppRole authentication backend to obtain a token that can be used for further operations.
final class	JwtAuthenticationTokenStore	A secret store that authenticates to Vault using a JWT.
class	VaultDatabaseCredentialsSecretStore	A secret store that can fetch fresh database credentials from the Vault Database secret engine.
class	VaultKeyValueSecretStore	A secret store that fetches secrets from a Hashicorp Vault server, using version 2 of the key-value backend.
class	VaultPkiSecretStore	A secret store that is able to retrieve PKI certificates and private keys from the Hashicorp Vault PKI backend.
class	VaultTransitSecretStore	Implements a store for cryptographic keys based on Vault's transit engine, which implements cryptography as a service.