ForgeRock JASPI (JSR-196) OpenID Connect Authentication Module 20.1.0 Documentation
B C F G H I J K L O P R S V W 

B

BaseOpenIdResolver - Class in org.forgerock.jaspi.modules.openid.resolvers
Implementation of the OpenIdResolver interface.
BaseOpenIdResolver(String) - Constructor for class org.forgerock.jaspi.modules.openid.resolvers.BaseOpenIdResolver
Abstract constructor for setting the issuer's identity.
build(URL) - Method in class org.forgerock.jaspi.modules.openid.resolvers.WellKnownOpenIdConfigurationFactory
Returns a JWKOpenIdResolverImpl representing the contents of the supplied URL.

C

cleanSubject(MessageInfoContext, Subject) - Method in class org.forgerock.jaspi.modules.openid.OpenIdConnectModule
Nothing to clean.
CLIENT_SECRET_KEY - Static variable in interface org.forgerock.jaspi.modules.openid.resolvers.OpenIdResolver
Lookup key for the client secret.
configureResolverWithJWK(String, URL) - Method in interface org.forgerock.jaspi.modules.openid.resolvers.service.OpenIdResolverService
Configures a new resolver implementation using the given parameters for this service which is later retrievable.
configureResolverWithJWK(String, URL) - Method in class org.forgerock.jaspi.modules.openid.resolvers.service.OpenIdResolverServiceImpl
Configures a new Resolver by setting it up to download public keys from the supplied url.
configureResolverWithKey(String, String, String, String, String) - Method in interface org.forgerock.jaspi.modules.openid.resolvers.service.OpenIdResolverService
Configures a new resolver implementation using the given parameters for this service which is later retrievable.
configureResolverWithKey(String, String, String, String, String) - Method in class org.forgerock.jaspi.modules.openid.resolvers.service.OpenIdResolverServiceImpl
Configures a new Resolver by finding the appropriate public key in the supplied keystore, and adds it to the Map of current resolvers.
configureResolverWithSecret(String, String) - Method in interface org.forgerock.jaspi.modules.openid.resolvers.service.OpenIdResolverService
Configures a new resolver implementation using the given parameters for this service which is later retrievable.
configureResolverWithSecret(String, String) - Method in class org.forgerock.jaspi.modules.openid.resolvers.service.OpenIdResolverServiceImpl
Configures a new Resolver by finding the appropriate public key in the supplied keystore, and adds it to the Map of current resolvers.
configureResolverWithWellKnownOpenIdConfiguration(URL) - Method in interface org.forgerock.jaspi.modules.openid.resolvers.service.OpenIdResolverService
Configures a new resolver implementation using the given configUrl as the location from which to draw all necessary information pertaining to the resolver.
configureResolverWithWellKnownOpenIdConfiguration(URL) - Method in class org.forgerock.jaspi.modules.openid.resolvers.service.OpenIdResolverServiceImpl
Configures a new Resolver by setting it up to download public keys from the supplied well-known Open Id Connect URL.
configureService(OpenIdResolverService, List<Map<String, String>>) - Method in interface org.forgerock.jaspi.modules.openid.resolvers.service.OpenIdResolverServiceConfigurator
Configures a provided OpenIdResolverService using the resolver information held in a List of Map.
configureService(OpenIdResolverService, List<Map<String, String>>) - Method in class org.forgerock.jaspi.modules.openid.resolvers.service.OpenIdResolverServiceConfiguratorImpl
This implementation includes a priority system for ensuring invalid configs still attempt to be loaded.
CONNECTION_TIMEOUT_KEY - Static variable in class org.forgerock.jaspi.modules.openid.OpenIdConnectModule
Lookup key for the configured HTTP connection's connection timeout for this module.
createFromOpenIDConfigUrl(URL) - Method in class org.forgerock.jaspi.modules.openid.resolvers.OpenIdResolverFactory
Creates a public key resolver for the supplied issuer using keys supplied at the .well-known open ID configuration URL.
createJWKResolver(String, URL, int, int) - Method in class org.forgerock.jaspi.modules.openid.resolvers.OpenIdResolverFactory
Creates a public key resolver for the supplied issuer using keys supplied at the JWK Set URL.
createPublicKeyResolver(String, PublicKey) - Method in class org.forgerock.jaspi.modules.openid.resolvers.OpenIdResolverFactory
Creates a public key resolver for the supplied issuer.
createSharedSecretResolver(String, String) - Method in class org.forgerock.jaspi.modules.openid.resolvers.OpenIdResolverFactory
Creates a shared secret (HMAC) key resolver for the supplied issuer.
createSigningHandlerForKey(SigningManager, Key) - Method in class org.forgerock.jaspi.modules.openid.resolvers.BaseOpenIdResolver
Determine an appropriate signing handler to use for verifying signatures using the given verification key.

F

FailedToLoadJWKException - Exception in org.forgerock.jaspi.modules.openid.exceptions
Unable to load the JWK/x5u location points.
FailedToLoadJWKException() - Constructor for exception org.forgerock.jaspi.modules.openid.exceptions.FailedToLoadJWKException
Construct the exception.
FailedToLoadJWKException(String) - Constructor for exception org.forgerock.jaspi.modules.openid.exceptions.FailedToLoadJWKException
Construct the exception with the given message.
FailedToLoadJWKException(String, Throwable) - Constructor for exception org.forgerock.jaspi.modules.openid.exceptions.FailedToLoadJWKException
Construct the exception with the given message and cause.
FailedToLoadJWKException(Throwable) - Constructor for exception org.forgerock.jaspi.modules.openid.exceptions.FailedToLoadJWKException
Construct the exception with the given cause.

G

generateMapFromJWK(URL) - Method in class org.forgerock.jaspi.modules.openid.helpers.JWKSetParser
Provides a Map of KeyId:Keys as indicated by the JWKSet's URL.
get(URL) - Method in class org.forgerock.jaspi.modules.openid.helpers.SimpleHTTPClient
Utility method for gathering the contents of an HTTP page.
getIssuer() - Method in class org.forgerock.jaspi.modules.openid.resolvers.BaseOpenIdResolver
Returns the issuer (IdP) for which this resolver will resolve identities.
getIssuer() - Method in interface org.forgerock.jaspi.modules.openid.resolvers.OpenIdResolver
Returns the issuer (IdP) for which this resolver will resolve identities.
getModuleId() - Method in class org.forgerock.jaspi.modules.openid.OpenIdConnectModule
 
getResolverForIssuer(String) - Method in interface org.forgerock.jaspi.modules.openid.resolvers.service.OpenIdResolverService
Returns the appropriate OpenId Connect resolver for the issuer.
getResolverForIssuer(String) - Method in class org.forgerock.jaspi.modules.openid.resolvers.service.OpenIdResolverServiceImpl
Returns the appropriate resolver for the given issuer - if it exists.
getSupportedMessageTypes() - Method in class org.forgerock.jaspi.modules.openid.OpenIdConnectModule

H

HEADER_KEY - Static variable in class org.forgerock.jaspi.modules.openid.OpenIdConnectModule
Lookup key for the configured HTTP header used by this module to locate JWSs.

I

initialize(MessagePolicy, MessagePolicy, CallbackHandler, Map<String, Object>) - Method in class org.forgerock.jaspi.modules.openid.OpenIdConnectModule
InvalidAudException - Exception in org.forgerock.jaspi.modules.openid.exceptions
Invalid audience.
InvalidAudException() - Constructor for exception org.forgerock.jaspi.modules.openid.exceptions.InvalidAudException
Construct the exception.
InvalidAudException(String) - Constructor for exception org.forgerock.jaspi.modules.openid.exceptions.InvalidAudException
Construct the exception with the given message.
InvalidAudException(String, Throwable) - Constructor for exception org.forgerock.jaspi.modules.openid.exceptions.InvalidAudException
Construct the exception with the given message and cause.
InvalidAudException(Throwable) - Constructor for exception org.forgerock.jaspi.modules.openid.exceptions.InvalidAudException
Construct the exception with the given cause.
InvalidIssException - Exception in org.forgerock.jaspi.modules.openid.exceptions
Invalid issuer.
InvalidIssException() - Constructor for exception org.forgerock.jaspi.modules.openid.exceptions.InvalidIssException
Construct the exception.
InvalidIssException(String) - Constructor for exception org.forgerock.jaspi.modules.openid.exceptions.InvalidIssException
Construct the exception with the given message.
InvalidIssException(String, Throwable) - Constructor for exception org.forgerock.jaspi.modules.openid.exceptions.InvalidIssException
Construct the exception with the given message and cause.
InvalidIssException(Throwable) - Constructor for exception org.forgerock.jaspi.modules.openid.exceptions.InvalidIssException
Construct the exception with the given cause.
InvalidJWTException - Exception in org.forgerock.jaspi.modules.openid.exceptions
Invalid JWT.
InvalidJWTException() - Constructor for exception org.forgerock.jaspi.modules.openid.exceptions.InvalidJWTException
Construct the exception.
InvalidJWTException(String) - Constructor for exception org.forgerock.jaspi.modules.openid.exceptions.InvalidJWTException
Construct the exception with the given message.
InvalidJWTException(String, Throwable) - Constructor for exception org.forgerock.jaspi.modules.openid.exceptions.InvalidJWTException
Construct the exception with the given message and cause.
InvalidJWTException(Throwable) - Constructor for exception org.forgerock.jaspi.modules.openid.exceptions.InvalidJWTException
Construct the exception with the given cause.
InvalidSignatureException - Exception in org.forgerock.jaspi.modules.openid.exceptions
Invalid signature.
InvalidSignatureException() - Constructor for exception org.forgerock.jaspi.modules.openid.exceptions.InvalidSignatureException
Construct the exception.
InvalidSignatureException(String) - Constructor for exception org.forgerock.jaspi.modules.openid.exceptions.InvalidSignatureException
Construct the exception with the given message.
InvalidSignatureException(String, Throwable) - Constructor for exception org.forgerock.jaspi.modules.openid.exceptions.InvalidSignatureException
Construct the exception with the given message and cause.
InvalidSignatureException(Throwable) - Constructor for exception org.forgerock.jaspi.modules.openid.exceptions.InvalidSignatureException
Construct the exception with the given cause.
ISSUER_KEY - Static variable in interface org.forgerock.jaspi.modules.openid.resolvers.OpenIdResolver
Lookup key for the issuer's name.

J

JWK - Static variable in interface org.forgerock.jaspi.modules.openid.resolvers.OpenIdResolver
Lookup key for JWK configuration.
JWKLookup - Class in org.forgerock.jaspi.modules.openid.helpers
Helper class to look up and return the keys from specific JWK implementation algorithm types.
JWKLookup() - Constructor for class org.forgerock.jaspi.modules.openid.helpers.JWKLookup
 
JWKOpenIdResolverImpl - Class in org.forgerock.jaspi.modules.openid.resolvers
This class exists to allow Open Id Providers to supply or promote a JWK exposure point for their public keys.
JWKOpenIdResolverImpl(String, URL, int, int) - Constructor for class org.forgerock.jaspi.modules.openid.resolvers.JWKOpenIdResolverImpl
Constructor using provided timeout values to generate the SimpleHTTPClient used for communicating over HTTP.
JWKOpenIdResolverImpl(String, URL, SimpleHTTPClient) - Constructor for class org.forgerock.jaspi.modules.openid.resolvers.JWKOpenIdResolverImpl
Constructor using an already-created SimpleHTTPClient.
JWKSetParser - Class in org.forgerock.jaspi.modules.openid.helpers
Provides methods to gather a JWKSet from a URL and return a map of key ids to keys as dictated by that JWKS.
JWKSetParser(int, int) - Constructor for class org.forgerock.jaspi.modules.openid.helpers.JWKSetParser
Constructor allowing the configuration of the read and connection timeouts used by the HTTP client for this parser.
JWKSetParser(SimpleHTTPClient) - Constructor for class org.forgerock.jaspi.modules.openid.helpers.JWKSetParser
Alternative constructor allowing the calling class to pass in an already-configured SimpleHTTPClient.
JWKSetParser(SimpleHTTPClient, JWKLookup) - Constructor for class org.forgerock.jaspi.modules.openid.helpers.JWKSetParser
Alternative constructor allowing the calling class to pass in an already-configured SimpleHTTPClient.
jwkSetToMap(JWKSet) - Method in class org.forgerock.jaspi.modules.openid.helpers.JWKSetParser
Converts a supplied JWKSet into a map of key:values, where the keys are the keyIds and the values are verification keys.
JwtExpiredException - Exception in org.forgerock.jaspi.modules.openid.exceptions
Expired JWT.
JwtExpiredException() - Constructor for exception org.forgerock.jaspi.modules.openid.exceptions.JwtExpiredException
Construct the exception.
JwtExpiredException(String) - Constructor for exception org.forgerock.jaspi.modules.openid.exceptions.JwtExpiredException
Construct the exception with the given message.
JwtExpiredException(String, Throwable) - Constructor for exception org.forgerock.jaspi.modules.openid.exceptions.JwtExpiredException
Construct the exception with the given message and cause.
JwtExpiredException(Throwable) - Constructor for exception org.forgerock.jaspi.modules.openid.exceptions.JwtExpiredException
Construct the exception with the given cause.

K

KEY_ALIAS_KEY - Static variable in interface org.forgerock.jaspi.modules.openid.resolvers.OpenIdResolver
Lookup key for a key stored in a keystore.
KEYSTORE_LOCATION_KEY - Static variable in interface org.forgerock.jaspi.modules.openid.resolvers.OpenIdResolver
Lookup key for the location of a keystore.
KEYSTORE_PASS_KEY - Static variable in interface org.forgerock.jaspi.modules.openid.resolvers.OpenIdResolver
Lookup key for the password to a keystore.
KEYSTORE_TYPE_KEY - Static variable in interface org.forgerock.jaspi.modules.openid.resolvers.OpenIdResolver
Lookup key for the type of a keystore.

L

lookup(String, KeyType) - Method in class org.forgerock.jaspi.modules.openid.helpers.JWKLookup
Lookup returns the key from the given json, under the assumption it's of the correct keyType.

O

OpenIdConnectModule - Class in org.forgerock.jaspi.modules.openid
OpenID Connect module that allows access when a valid OpenID Connect JWT which our server trusts is presented in the specific header field.
OpenIdConnectModule() - Constructor for class org.forgerock.jaspi.modules.openid.OpenIdConnectModule
Default constructor.
OpenIdConnectVerificationException - Exception in org.forgerock.jaspi.modules.openid.exceptions
Problem during the verification of an OpenId Connect module.
OpenIdConnectVerificationException() - Constructor for exception org.forgerock.jaspi.modules.openid.exceptions.OpenIdConnectVerificationException
Construct the exception.
OpenIdConnectVerificationException(String) - Constructor for exception org.forgerock.jaspi.modules.openid.exceptions.OpenIdConnectVerificationException
Construct the exception with the given message.
OpenIdConnectVerificationException(String, Throwable) - Constructor for exception org.forgerock.jaspi.modules.openid.exceptions.OpenIdConnectVerificationException
Construct the exception with the given message and cause.
OpenIdConnectVerificationException(Throwable) - Constructor for exception org.forgerock.jaspi.modules.openid.exceptions.OpenIdConnectVerificationException
Construct the exception with the given cause.
OpenIdResolver - Interface in org.forgerock.jaspi.modules.openid.resolvers
Validation of Open ID Connect JWTs via verification of their internals (issuer, audience, signature, etc.).
OpenIdResolverFactory - Class in org.forgerock.jaspi.modules.openid.resolvers
For producing OpenId Resolvers.
OpenIdResolverFactory(int, int) - Constructor for class org.forgerock.jaspi.modules.openid.resolvers.OpenIdResolverFactory
For generating an OpenIDResolverFactory with the supplied timeouts which will be used for all HTTP communication originating form this factory.
OpenIdResolverService - Interface in org.forgerock.jaspi.modules.openid.resolvers.service
Interface through which OpenIdResolvers are obtained, and the service providing them is configured.
OpenIdResolverServiceConfigurator - Interface in org.forgerock.jaspi.modules.openid.resolvers.service
OpenIdResolverServiceConfiguratorImpl - Class in org.forgerock.jaspi.modules.openid.resolvers.service
Implementation of the OpenIdResolverServiceConfigurator interface which applies a simple priority ordering when reading a service configuration.
OpenIdResolverServiceConfiguratorImpl() - Constructor for class org.forgerock.jaspi.modules.openid.resolvers.service.OpenIdResolverServiceConfiguratorImpl
 
OpenIdResolverServiceImpl - Class in org.forgerock.jaspi.modules.openid.resolvers.service
Holds a copy of the current OpenID Resolvers.
OpenIdResolverServiceImpl(int, int) - Constructor for class org.forgerock.jaspi.modules.openid.resolvers.service.OpenIdResolverServiceImpl
Constructor for the OpenIdResolverServiceImpl which will use the supplied read and connection timeouts when communicating over HTTP.
org.forgerock.jaspi.modules.openid - package org.forgerock.jaspi.modules.openid
This package contains classes which form the Open ID Connect JASPIc AuthN module.
org.forgerock.jaspi.modules.openid.exceptions - package org.forgerock.jaspi.modules.openid.exceptions
This package contains classes to represent the different exceptions that can be thrown by the OpenID Connect JASPI module.
org.forgerock.jaspi.modules.openid.helpers - package org.forgerock.jaspi.modules.openid.helpers
This package contains util classes used in the generation and processing of Open ID Connect authentication verification resolvers.
org.forgerock.jaspi.modules.openid.resolvers - package org.forgerock.jaspi.modules.openid.resolvers
This package contains classes to generate Open ID Resolvers, which can validate a supplied JWS against an Open ID Connect provider.
org.forgerock.jaspi.modules.openid.resolvers.service - package org.forgerock.jaspi.modules.openid.resolvers.service
This package contains classes for a service which can be configured to produce OpenID Connect Resolvers.

P

PublicKeyOpenIdResolverImpl - Class in org.forgerock.jaspi.modules.openid.resolvers
This class exists to allow functionality for those Open ID Connect providers which supply their signatures through asymmetric key algorithms (e.g.
PublicKeyOpenIdResolverImpl(String, PublicKey) - Constructor for class org.forgerock.jaspi.modules.openid.resolvers.PublicKeyOpenIdResolverImpl
Constructor for PublicKeyOpenIdResolverImpl.

R

READ_TIMEOUT_KEY - Static variable in class org.forgerock.jaspi.modules.openid.OpenIdConnectModule
Lookup key for the configured HTTP connection's read timeout for this module.
RESOLVERS_KEY - Static variable in class org.forgerock.jaspi.modules.openid.OpenIdConnectModule
Lookup key for the configured resolvers which will be used by this module.

S

secureResponse(MessageInfoContext, Subject) - Method in class org.forgerock.jaspi.modules.openid.OpenIdConnectModule
Sends SEND_SUCCESS automatically.
SharedSecretOpenIdResolverImpl - Class in org.forgerock.jaspi.modules.openid.resolvers
This class exists to allow functionality for those Open ID Connect providers which supply their signatures through symmetric key algorithms (e.g.
SharedSecretOpenIdResolverImpl(String, String) - Constructor for class org.forgerock.jaspi.modules.openid.resolvers.SharedSecretOpenIdResolverImpl
Constructor for SharedSecretOpenIdResolverImpl.
SimpleHTTPClient - Class in org.forgerock.jaspi.modules.openid.helpers
Simple helper client for connecting to URLs over HTTP and retrieving their contents via a GET request.
SimpleHTTPClient(int, int) - Constructor for class org.forgerock.jaspi.modules.openid.helpers.SimpleHTTPClient
Generates a new SimpleHTTPClient with the appropriate timeouts.

V

validateIdentity(SignedJwt) - Method in class org.forgerock.jaspi.modules.openid.resolvers.BaseOpenIdResolver
Validates the supplied Jwt against this OpenId Connect Idp.
validateIdentity(SignedJwt) - Method in class org.forgerock.jaspi.modules.openid.resolvers.JWKOpenIdResolverImpl
Validates the supplied Jwt against this OpenId Connect Idp.
validateIdentity(SignedJwt) - Method in interface org.forgerock.jaspi.modules.openid.resolvers.OpenIdResolver
Validates the supplied Jwt against this OpenId Connect Idp.
validateIdentity(SignedJwt) - Method in class org.forgerock.jaspi.modules.openid.resolvers.PublicKeyOpenIdResolverImpl
Validates the supplied Jwt against this OpenId Connect Idp.
validateIdentity(SignedJwt) - Method in class org.forgerock.jaspi.modules.openid.resolvers.SharedSecretOpenIdResolverImpl
Validates the supplied Jwt against this OpenId Connect Idp.
validateRequest(MessageInfoContext, Subject, Subject) - Method in class org.forgerock.jaspi.modules.openid.OpenIdConnectModule
Attempts to retrieve the value of the specified OpenID Connect header from the messageInfo, then converts this to a Jwt and attempts to decrypt.
verifySignature(SignedJwt) - Method in class org.forgerock.jaspi.modules.openid.resolvers.JWKOpenIdResolverImpl
Verifies that the JWS was signed by the supplied key.
verifySignature(SignedJwt) - Method in class org.forgerock.jaspi.modules.openid.resolvers.PublicKeyOpenIdResolverImpl
Verifies that the JWS was signed by the corresponding private key to this public key.
verifySignature(SignedJwt) - Method in class org.forgerock.jaspi.modules.openid.resolvers.SharedSecretOpenIdResolverImpl
Verifies that the JWS was signed by the supplied key.

W

WELL_KNOWN_CONFIGURATION - Static variable in interface org.forgerock.jaspi.modules.openid.resolvers.OpenIdResolver
Lookup key for a .well-known Open ID Connect config.
WellKnownOpenIdConfigurationFactory - Class in org.forgerock.jaspi.modules.openid.resolvers
This class creates JWKOpenIdResolverImpl's from a supplied well-known open id configuration url.
WellKnownOpenIdConfigurationFactory(int, int) - Constructor for class org.forgerock.jaspi.modules.openid.resolvers.WellKnownOpenIdConfigurationFactory
Generates a factory that will use the given timeouts when attempting to read the data form a remote location.
B C F G H I J K L O P R S V W 
ForgeRock JASPI (JSR-196) OpenID Connect Authentication Module 20.1.0 Documentation

Copyright © 2016 ForgeRock AS. All Rights Reserved.