Uses of Class
org.forgerock.secrets.GenericSecret

Packages that use GenericSecret

Package	Description
org.forgerock.http.filter	Core Filter implementations.
org.forgerock.http.oauth2	This package provides APIs for OAuth 2.0 services implementations.
org.forgerock.openig.filter.oauth2.client.authentication	Collection of heaplets supporting OAuth2 client authentication Filters.
org.forgerock.openig.proxy	Contains proxy related heaplets.
org.forgerock.openig.secrets	Provides the Common Secrets API for accessing secrets of various kinds.
org.forgerock.openig.tools.am	Access Management Server.
org.forgerock.openig.tools.authentication	AM authentication service.
org.forgerock.openig.util	Miscellaneous utility classes.
org.forgerock.secrets	Provides a unified API for accessing secrets of various kinds.
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.

Uses of GenericSecret in org.forgerock.http.filter

Method parameters in org.forgerock.http.filter with type arguments of type GenericSecret

Modifier and Type	Method	Description
static Filter	Filters.newBearerTokenAuthFilter(SecretReference<GenericSecret> tokenReference)	Creates an authentication Filter that puts a Bearer Authorization header in the request.
static Filter	Filters.newBearerTokenAuthFilterWithoutRetry(SecretReference<GenericSecret> tokenReference)	Creates an authentication Filter that puts a Bearer Authorization header in the request.
static Filter	Filters.newHttpBasicAuthenticationFilter(String username, SecretReference<GenericSecret> password)	Creates an authentication Filter that put a Basic Authorization header in the request.
static Filter	Filters.newHttpBasicAuthenticationFilter(String username, SecretReference<GenericSecret> password, Charset charset)	Creates an authentication Filter that put a Basic Authorization header in the request.
static Filter	Filters.newUrlEncodedHttpBasicAuthFilter(String username, SecretReference<GenericSecret> password)	Creates an authentication Filter that put a Basic Authorization header in the request.

Uses of GenericSecret in org.forgerock.http.oauth2

Constructor parameters in org.forgerock.http.oauth2 with type arguments of type GenericSecret

Constructor	Description
ClientSecretBasicAuthenticationFilter(String clientId, SecretReference<GenericSecret> secretReference)	Deprecated. Creates and instance of ClientSecretBasicAuthenticationFilter.
ClientSecretPostAuthenticationFilter(String clientId, SecretReference<GenericSecret> secretReference)	Creates an instance of this class.

Uses of GenericSecret in org.forgerock.openig.filter.oauth2.client.authentication

Method parameters in org.forgerock.openig.filter.oauth2.client.authentication with type arguments of type GenericSecret

Modifier and Type	Method	Description
protected Filter	ClientSecretBasicAuthenticationFilterHeaplet.createFilter(String clientId, SecretReference<GenericSecret> clientSecretRef)
protected Filter	ClientSecretPostAuthenticationFilterHeaplet.createFilter(String clientId, SecretReference<GenericSecret> clientSecretRef)

Uses of GenericSecret in org.forgerock.openig.proxy

Constructor parameters in org.forgerock.openig.proxy with type arguments of type GenericSecret

Constructor	Description
CustomProxyOptions(URI uri, String username, SecretReference<GenericSecret> passwordReference)	Creates a new CustomProxyOptions with login/password.

Uses of GenericSecret in org.forgerock.openig.secrets

Methods in org.forgerock.openig.secrets with type parameters of type GenericSecret

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

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

Modifier and Type	Method	Description
Class<GenericSecret>	Base64EncodedSecretStore.getStoredType()
static SecretReference<GenericSecret>	SecretsUtils.retrievePasswordAsReference(SecretsProvider secretsProvider, JsonValue secretIdNode, JsonValue deprecatedNode, org.slf4j.Logger logger)	Retrieve a required password as a SecretReference from the given secretIdNode and deprecatedNode nodes.
static SecretReference<GenericSecret>	SecretsUtils.retrievePasswordAsReference(SecretsProvider secretsProvider, JsonValue secretIdNode, JsonValue deprecatedNode, org.slf4j.Logger logger, boolean isRequired)	Retrieve a password as a SecretReference from the given secretIdNode and deprecatedNode nodes.

Method parameters in org.forgerock.openig.secrets with type arguments of type GenericSecret

Modifier and Type	Method	Description
KeyStoreSecretStore	HsmSecretStoreHeaplet.keyStore(SecretsProvider secretsProvider, Purpose<GenericSecret> storePasswordPurpose, Options options)
KeyStoreSecretStore	KeyStoreSecretStoreHeaplet.keyStore(SecretsProvider secretsProvider, Purpose<GenericSecret> storePasswordPurpose, Options options)

Uses of GenericSecret in org.forgerock.openig.tools.am

Method parameters in org.forgerock.openig.tools.am with type arguments of type GenericSecret

Modifier and Type	Method	Description
static AmService.Discovery	AmService.discovery(URI baseUri, Realm realm, String cookieName, Version versionHint, String agentId, SecretReference<GenericSecret> agentPassword, Handler amHandler)	Create an AM Discovery object which will get information from AM upon building.

Uses of GenericSecret in org.forgerock.openig.tools.authentication

Method parameters in org.forgerock.openig.tools.authentication with type arguments of type GenericSecret

Modifier and Type	Method	Description
Promise<SsoToken,AuthenticationException>	AuthenticationService.authenticate(Context context, String username, SecretReference<GenericSecret> passwordRef)	Authenticates a subject (identified with the given username and passwordRef credentials), returning asynchronously an SSO token (if the authentication succeeded) or an AuthenticationException on failures (I/O, invalid credentials, ...).
Promise<SsoToken,AuthenticationException>	AuthenticatorAuthenticationService.authenticate(Context context, String username, SecretReference<GenericSecret> passwordRef)

Uses of GenericSecret in org.forgerock.openig.util

Methods in org.forgerock.openig.util that return types with arguments of type GenericSecret

Modifier and Type	Method	Description
static Function<JsonValue,SecretReference<GenericSecret>,JsonValueException>	JsonValues.constantSecretReference()	Returns a SecretReference.constant(Secret) from a GenericSecret attribute value.

Uses of GenericSecret in org.forgerock.secrets

Fields in org.forgerock.secrets with type parameters of type GenericSecret

Modifier and Type	Field	Description
static Purpose<GenericSecret>	Purpose.PASSWORD	Indicates a secret intended to be used as a password for authentication to some service.

Methods in org.forgerock.secrets that return GenericSecret

Modifier and Type	Method	Description
static GenericSecret	GenericSecret.password(char[] password)	A helper utility for constructing a Generic Secret from a password that never expires.
static GenericSecret	GenericSecret.password(String id, char[] password)	A helper utility for constructing a Generic Secret from a password that never expires.
static GenericSecret	GenericSecret.password(String id, char[] password, Clock clock)	A helper utility for constructing a Generic Secret from a password with a default expiry time.

Uses of GenericSecret in org.forgerock.secrets.keystore

Constructor parameters in org.forgerock.secrets.keystore with type arguments of type GenericSecret

Constructor	Description
KeyStoreSecretStore(Function<char[],KeyStore,KeyStoreException> keyStoreLoader, SecretReference<GenericSecret> keyStorePassword)	Initialises the keystore using the same password for the keystore and all keys and default configuration options.
KeyStoreSecretStore(Function<char[],KeyStore,KeyStoreException> keyStoreLoader, SecretReference<GenericSecret> keyStorePassword, SecretReference<GenericSecret> keyEntryPassword, Options options, KeyStoreSecretStore.StableIdProvider stableIdProvider)	Initialises the key store.
KeyStoreSecretStore(Function<char[],KeyStore,KeyStoreException> keyStoreLoader, SecretReference<GenericSecret> keyStorePassword, Options options)	Initialises the keystore using the same password for the keystore and all keys.

Uses of GenericSecret in org.forgerock.secrets.oauth2

Methods in org.forgerock.secrets.oauth2 with type parameters of type GenericSecret

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

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

Modifier and Type	Method	Description
Class<GenericSecret>	AccessTokenSecretStore.getStoredType()

Method parameters in org.forgerock.secrets.oauth2 with type arguments of type GenericSecret

Modifier and Type	Method	Description
AccessTokenSecretStore.Builder	AccessTokenSecretStore.Builder.forPurpose(Purpose<GenericSecret> purpose)	Configures the purpose for which this access token store is to be used.
AccessTokenSecretStore.Builder	AccessTokenSecretStore.Builder.withClientSecretBasicAuth(String clientId, SecretReference<GenericSecret> clientSecretRef)	Configures the token store to supply client credentials via HTTP Basic Authentication.
AccessTokenSecretStore.Builder	AccessTokenSecretStore.Builder.withClientSecretPostAuth(String clientId, SecretReference<GenericSecret> clientSecretRef)	Configures the token store to supply client credentials via client_secret_post method.

Constructor parameters in org.forgerock.secrets.oauth2 with type arguments of type GenericSecret

Constructor	Description
JwtBearerGrantTypeHandler(SecretReference<GenericSecret> jwtReference)	Constructs the handler with the given source of JWTs.
JwtBearerGrantTypeHandler(SecretReference<GenericSecret> jwtReference, String clientId, Collection<String> scope)	Constructs the handler with the given source of JWTs, for the given client and scope.
JwtBearerGrantTypeHandler(SecretReference<GenericSecret> jwtReference, Collection<String> scope)	Constructs the handler with the given source of JWTs, for the given scope.
ResourceOwnerPasswordGrantTypeHandler(String clientId, String username, SecretReference<GenericSecret> password)	Initialises the grant type handler with the given credentials and the default scope for this client.
ResourceOwnerPasswordGrantTypeHandler(String clientId, String username, SecretReference<GenericSecret> password, Collection<String> scope)	Initialises the grant type handler with the given credentials.

Uses of GenericSecret in org.forgerock.secrets.propertyresolver

Constructor parameters in org.forgerock.secrets.propertyresolver with type arguments of type GenericSecret

Constructor	Description
PemPropertyFormat(SecretsProvider secretsProvider, Purpose<GenericSecret> decryptionPasswordPurpose)	Initializes the property format with the given secrets provider and purpose for decrypting password-encrypted PEM files.
PemPropertyFormat(SecretsProvider secretsProvider, Purpose<GenericSecret> decryptionPasswordPurpose, Supplier<SecretBuilder> secretBuilderSupplier)	Initializes the property format with the given secrets provider and purpose for decrypting password-encrypted PEM files.