Uses of Class
org.forgerock.secrets.SecretReference

Packages that use SecretReference

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.json.jose.jws	Classes and interfaces for JWT signing and JWS'.
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.tools.jwt.factory	Provides JWT capabilities to the Identity Gateway.
org.forgerock.openig.util	Miscellaneous utility classes.
org.forgerock.secrets	Provides a unified API for accessing secrets of various kinds.
org.forgerock.secrets.credentials	Contains secret credential 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.
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.

Uses of SecretReference in org.forgerock.http.filter

Methods in org.forgerock.http.filter with parameters of type SecretReference

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)	Deprecated, for removal: This API element is subject to removal in a future version. use Filters.newHttpBasicAuthenticationFilter(CredentialPair) instead
static Filter	Filters.newHttpBasicAuthenticationFilter(String username, SecretReference<GenericSecret> password, Charset charset)	Deprecated, for removal: This API element is subject to removal in a future version. use Filters.newHttpBasicAuthenticationFilter(CredentialPair, Charset) instead
static Filter	Filters.newUrlEncodedHttpBasicAuthFilter(String username, SecretReference<GenericSecret> password)	Deprecated, for removal: This API element is subject to removal in a future version. use Filters.newUrlEncodedHttpBasicAuthFilter(CredentialPair) instead

Uses of SecretReference in org.forgerock.http.oauth2

Methods in org.forgerock.http.oauth2 with parameters of type SecretReference

Modifier and Type	Method	Description
EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder	EncryptedPrivateKeyJwtClientAuthenticationFilter.Builder.withEncryptionSecretReference(SecretReference<DataEncryptionKey> secretReference)	Sets SecretReference to use as the encryption key.
T	PrivateKeyJwtClientAuthenticationFilter.Builder.withSigningSecretReference(SecretReference<SigningKey> secretReference)	Sets SecretReference to use as the signing key.

Constructors in org.forgerock.http.oauth2 with parameters of type SecretReference

Modifier	Constructor	Description
	ClientSecretBasicAuthenticationFilter(String clientId, SecretReference<GenericSecret> secretReference)	Deprecated. Creates and instance of ClientSecretBasicAuthenticationFilter.
	ClientSecretPostAuthenticationFilter(String clientId, SecretReference<GenericSecret> secretReference)	Deprecated, for removal: This API element is subject to removal in a future version. Use ClientSecretPostAuthenticationFilter(CredentialPair) instead.

Uses of SecretReference in org.forgerock.json.jose.jws

Methods in org.forgerock.json.jose.jws with parameters of type SecretReference

Modifier and Type	Method	Description
Promise<SigningHandler,NoSuchSecretException>	SigningManager.newSigningHandler(SecretReference<SigningKey> secretReference)	Constructs a new SigningHandler configured for signing with the provided secret reference.

Uses of SecretReference in org.forgerock.openig.proxy

Constructors in org.forgerock.openig.proxy with parameters of type SecretReference

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

Uses of SecretReference in org.forgerock.openig.secrets

Methods in org.forgerock.openig.secrets that return SecretReference

Modifier and Type	Method	Description
<S extends Secret> SecretReference<S>	SecretsService.createActiveReference(Purpose<S> purpose)	Create a SecretReference for the given Purpose.
<S extends Secret> SecretReference<S>	SecretsService.createNamedReference(Purpose<S> purpose, String name)	Creates a reference to a secret with the given name (stable id) for the given purpose.

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

Methods in org.forgerock.openig.tools.am with parameters of type SecretReference

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 SecretReference in org.forgerock.openig.tools.authentication

Methods in org.forgerock.openig.tools.authentication with parameters of type SecretReference

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 SecretReference in org.forgerock.openig.tools.jwt.factory

Constructors in org.forgerock.openig.tools.jwt.factory with parameters of type SecretReference

Modifier	Constructor	Description
	EncryptedJwtFactory(JweAlgorithm encryptionAlgorithm, EncryptionMethod encryptionMethod, SecretReference<DataEncryptionKey> encryptionKeyReference)	Create a new instance of an JwtFactory for EncryptedJwt.
	SignedJwtFactory(SigningManager signingManager, SecretReference<SigningKey> secretReference, JwsAlgorithm signingAlgorithm)	Create a new instance of SignedJwtFactory.
	SignedJwtFactory(SigningManager signingManager, SecretReference<SigningKey> secretReference, JwsAlgorithm signingAlgorithm, boolean includeKeyId)	Create a new instance of SignedJwtFactory.
	SignedThenEncryptedJwtFactory(SignedJwtFactory signedJwtFactory, JweAlgorithm encryptionAlgorithm, EncryptionMethod encryptionMethod, SecretReference<DataEncryptionKey> encryptionKeyReference)	Create a new instance of SignedThenEncryptedJwtFactory.

Uses of SecretReference in org.forgerock.openig.util

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

Modifier and Type	Method	Description
static Function<JsonValue,SecretReference<GenericSecret>,JsonValueException>	JsonValues.constantSecretReference()	Returns a constant(Secret) from a GenericSecret attribute value.
static <S extends Secret> Function<JsonValue,SecretReference<S>,JsonValueException>	JsonValues.secretReferenceOf(Function<JsonValue,Purpose<S>,JsonValueException> purposeTransformer, SecretsProvider secretsProvider)	Returns a function that returns a SecretReference for the Purpose represented by the given String value label and known to the supplied SecretsProvider.

Uses of SecretReference in org.forgerock.secrets

Methods in org.forgerock.secrets that return SecretReference

Modifier and Type	Method	Description
static <T extends Secret> SecretReference<T>	SecretReference.active(SecretsProvider secretsProvider, Purpose<T> purpose, Clock clock)	Creates a reference to the active secret for the given purpose using the given secrets provider.
static <T extends Secret> SecretReference<T>	SecretReference.constant(T secret)	Create a constant SecretReference for the given secret, that will never expire.
<S extends Secret> SecretReference<S>	SecretsProvider.createActiveReference(Purpose<S> purpose)	Creates the secret reference from the given purpose.
<S extends Secret> SecretReference<S>	SecretsProvider.createNamedReference(Purpose<S> purpose, String name)	Creates a reference to a secret with the given name (stable id) for the given purpose.
static <T extends Secret> SecretReference<T>	SecretReference.named(SecretsProvider secretsProvider, Purpose<T> purpose, String name, Clock clock)	Creates a reference to a named secret using the given secrets provider.
SecretReference<T>	SecretReference.refresh()	Force the refresh of the secret reference.

Uses of SecretReference in org.forgerock.secrets.credentials

Methods in org.forgerock.secrets.credentials with parameters of type SecretReference

Modifier and Type	Method	Description
static <T extends Secret> CredentialPair<T>	CredentialPair.credentialPair(SecretReference<T> secretReference, Function<T,PrincipalAndSecret<T>> mapper)	Factory method to create a new instance of CredentialPair from a reference to a secret containing both the principal and secret.
static <T extends Secret> CredentialPair<T>	CredentialPair.fixedPrincipalCredentialPair(String principal, SecretReference<T> secretReference)	Factory method to create a new instance of CredentialPair with a static principal and a dynamic principal secret.

Uses of SecretReference in org.forgerock.secrets.keystore

Constructors in org.forgerock.secrets.keystore with parameters of type SecretReference

Modifier	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 SecretReference in org.forgerock.secrets.oauth2

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

Modifier and Type	Method	Description
AccessTokenSecretStore.Builder	AccessTokenSecretStore.Builder.withClientSecretBasicAuth(String clientId, SecretReference<GenericSecret> clientSecretRef)	Deprecated, for removal: This API element is subject to removal in a future version. use AccessTokenSecretStore.Builder.withClientSecretBasicAuth(CredentialPair) instead
AccessTokenSecretStore.Builder	AccessTokenSecretStore.Builder.withClientSecretPostAuth(String clientId, SecretReference<GenericSecret> clientSecretRef)	Deprecated, for removal: This API element is subject to removal in a future version. use AccessTokenSecretStore.Builder.withClientSecretPostAuth(CredentialPair) instead

Constructors in org.forgerock.secrets.oauth2 with parameters of type SecretReference

Modifier	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)	Deprecated, for removal: This API element is subject to removal in a future version. Use ResourceOwnerPasswordGrantTypeHandler(String, CredentialPair) instead.
	ResourceOwnerPasswordGrantTypeHandler(String clientId, String username, SecretReference<GenericSecret> password, Collection<String> scope)	Deprecated, for removal: This API element is subject to removal in a future version. Use ResourceOwnerPasswordGrantTypeHandler(String, CredentialPair, Collection) instead.