Package org.forgerock.openig.fapi.jwks

Interface JwkSetService

All Known Implementing Classes:

CachingJwkSetService

public interface JwkSetService

Service providing access to JWK set stores in support of FAPI operations. Note that implementors should expect Purposes as below to retrieve secrets from its stores:

• JwkSetServicePurposes.signingPurpose() to retrieve signing keys
• JwkSetServicePurposes.transportPurpose() to retrieve transport keys

Client code should also use the same purposes to retrieve secrets on the underlying store.

See Also:

• RFC7517

Method Summary

Modifier and Type	Method	Description
Promise<JwkSetSecretStore,FailedToLoadJWKException>	getJwkSetSecretStore(URI jwkSetUri)	Retrieves a JwkSetSecretStore for the JWK Set hosted at the specified uri.

Method Details

getJwkSetSecretStore

Promise<JwkSetSecretStore,FailedToLoadJWKException> getJwkSetSecretStore(URI jwkSetUri)

Retrieves a JwkSetSecretStore for the JWK Set hosted at the specified uri. The secret store returned can be used to verify signatures of JWTs.

Parameters:

jwkSetUri - URI used to locate the JWK Set.

Returns:

Promise containing a JwkSetSecretStore or a FailedToLoadJWKException if there was an error retrieving the JWK Set.