All Classes and Interfaces
Class
Description
Base class for admin flow actions producing JSON responses.
A Abstract function extended by lookups searching fields from authentication request.
A Abstract function extended by lookups searching fields from authorization request.
AbstractBuildErrorResponseFromEvent<T extends com.nimbusds.oauth2.sdk.ErrorResponse>
This action is extended by error response actions.
Action that adds an outbound
MessageContext and related OIDC contexts to the ProfileRequestContext.Abstract class for actions performing actions on
AuthorizationRequest found via
InOutOperationContext.getInboundMessageContext() and MessageContext.getMessage().Abstract class for actions performing actions on
OIDCAuthenticationResponseContext located under
InOutOperationContext.getOutboundMessageContext().Abstract class for actions performing actions on
AuthenticationRequest found via
InOutOperationContext.getInboundMessageContext() and MessageContext.getMessage().Abstract class for actions performing actions on
OIDCAuthenticationResponseContext located under
InOutOperationContext.getOutboundMessageContext().An abstract action for OIDC back-channel logout actions dealing with
OIDCBackChannelLogoutPropagationContext.Abstract action for populating metadata from the
ClientRegistrationRequest message to the response
message.An abstract action for OIDC logout actions dealing with
OIDCLogoutPropagationContext.Abstract class for actions performing actions on a oidc request found via
InOutOperationContext.getInboundMessageContext() and MessageContext.getMessage().Abstract class for actions performing actions on
OIDCAuthenticationResponseContext located under
InOutOperationContext.getOutboundMessageContext().An abstract action for OIDC logout actions dealing with OIDC RP-initiated logout.
Abstract action to be extended by oidc response actions requiring signing parameters.
Abstract class for actions performing actions on
TokenRequest found via
InOutOperationContext.getInboundMessageContext() and MessageContext.getMessage().Abstract class for actions performing actions on
OIDCAuthenticationResponseContext located under
InOutOperationContext.getOutboundMessageContext().Abstract class for actions performing actions on
UserInfoRequest found via
InOutOperationContext.getInboundMessageContext() and MessageContext.getMessage().Abstract class for actions performing actions on
OIDCMetadataContext located under
InOutOperationContext.getInboundMessageContext().Abstract class for actions performing actions on
OIDCAuthenticationResponseContext located under
InOutOperationContext.getOutboundMessageContext().Action that processes a token by validating it and populating the resulting
JWTClaimsSet
into an OAuth2TokenMgmtResponseContext placed beneath the outbound MessageContext.A Abstract function extended by lookups searching fields from tokens (Authorization Code, Access Token).
A Abstract function extended by lookups searching fields from token request.
Class wrapping claims set for access token.
Builder to create instance of AccessTokenClaimsSet.
A function that returns the access token claims set from response context.
Subcontext carrying information used to produce access tokens.
Action that adds access token hash claim to a
IDTokenClaimsSet.Action that adds acr claim to a
IDTokenClaimsSet.Adds the application_type to the
OIDCClientRegistrationResponseContext.Action that adds claims to a
ClaimsSet.Action that adds authorization code hash claim to a
IDTokenClaimsSet.Action that adds auth_time claim to a
IDTokenClaimsSet.Adds client name from the input metadata to the output
OIDCClientMetadata.Adds the contents of the contacts attribute from the input metadata to the output
OIDCClientMetadata.An action that adds the grant_type to the client metadata.
Action that creates a
IDTokenClaimsSet object shell, and sets it to work context
OIDCAuthenticationResponseContext located under InOutOperationContext.getOutboundMessageContext().An action that adds the jwks or jwks_uri to the client metadata, if one of those were defined in the request.
This action adds the logo_uri(s) to the client metadata.
Adds the parameters related to OIDC logout to the output
OIDCClientMetadata.An action that adds the trusted metadata_statement chain (containing OP's signed key) to the metadata_statement
claim in the response metadata.
Action that adds nonce claim to a
IDTokenClaimsSet.This action adds the policy_uri(s) to the client metadata.
Adds the (mandatory) redirect_uris to the output
OIDCClientMetadata.Adds the remaining claims from the input metadata to the output
OIDCClientMetadata, which haven't been
added there already, but which are recognized in the metadata policy.Verifies and adds the request object configuration details (request_object_signing_alg,
request_object_encryption_alg and request_object_encryption_enc) to the client metadata.
Adds the pre-registered request_uri values to the output
OIDCClientMetadata.An action that adds response_types to the OIDC client metadata.
Adds the
Scope from the input metadata to the output OIDCClientMetadata.Verifies and adds the security configuration details (*_response_alg and *_response_enc) to the client metadata.
An action that adds the subject_type to the client metadata.
Action that adds claims to a
ClaimsSet.An action that adds the token_endpoint_auth_method to the client metadata.
This action adds the tos_uri(s) to the client metadata.
Action that creates a
UserInfo object shell, and sets it to work context
OIDCAuthenticationResponseContext located under InOutOperationContext.getOutboundMessageContext().A
MetadataValueResolver for resolving signing/encryption algorithm information from the current
SecurityConfiguration.An implementation to
MetadataValueResolver that contains an array of other MetadataValueResolvers.A predicate implementation that checks if attribute consent flag is enabled.
Namespace handler for the oidc specific attribute filter engine functions.
Class for matching attribute to requested claims.
Bean definition parser for
AttributeInOIDCRequestedClaimsMatcher.Compare the scopes of oidc authentication request with the provided value.
Bean definition parser for
AttributeOIDCScopePolicyRule.A function that returns subject identifier from filtered claims.
Returns a
ClientID from the first value found in OIDCAuthenticationResponseContext.getAudience().Constants to use for audit logging fields stored in an
AuditContext.Looks up the 'acr' value from the OIDC authentication response context.
A function that resolves a claim value from the authentication request.
Class wrapping claims set for authorize code.
Builder to create instance of AuthorizeCodeClaimsSet.
BaseOAuth2RequestDecoder<T extends com.nimbusds.oauth2.sdk.Request>
Base decoder for Nimbus OAuth2 request messages.
Action that creates an Access Token, and stores it to an
AccessTokenContext.This action reads an event from the configured
EventContext lookup strategy, constructs an OIDC
authentication error response message and attaches it as the outbound message.An action that uses the information from
OIDCClientRegistrationResponseContext attached to the message
context for creating a new ClientInformationResponse.This action reads an event from the configured
EventContext lookup strategy, constructs an OAuth2 Token
Introspection error response message and attaches it as the outbound message.This action reads an event from the configured
EventContext lookup strategy, constructs a json error response
message and attaches it as the outbound message.This action reads an event from the configured
EventContext lookup strategy, constructs an OIDC client
registration error response message and attaches it as the outbound message.This action reads an event from the configured
EventContext lookup strategy, constructs an OAuth2 Token
Revocation error response message and attaches it as the outbound message.This action reads an event from the configured
EventContext lookup strategy, constructs an OIDC token error
response message and attaches it as the outbound message.This action reads an event from the configured
EventContext lookup strategy, constructs an OIDC user info
error response message and attaches it as the outbound message.Iff a chain expiration time (c_exp) claim is present, verifies that it is ahead of the current time, else the JWT
claims set is rejected.
The action that verifies the redirect_uris from the request.
Function that returns the released claims for the endpoint.Looks up the client ID value from the OIDC client registration response context.
A function that returns
OIDCMetadataContext.A function that returns
OIDCMetadataContext.Command line processing for OIDC client mgmt flow.
An implementation of
MetadataValueResolver that converts public parts of the attached
Credential to the value.Default function for looking up the allowed scope.
Validation strategy for the inbound message.
A function that returns auth time via a lookup function.
Default lookup function for fetching the chain revocation lifetime.
A function that returns client id of the authentication request via a lookup function.
A function that computes a hash value for the authorization code via required configurable lookup function.
Default implementation for deserializing an incoming JWT refresh token into the refresh token claims set.
Default implementation for serializing the refresh token claims set into a JWT refresh token.
Default validation strategy for logout hints.
A function returning a
CriteriaSet which contains the metadata policy document location as ResourceLocationCriterion.A function that merges two maps of metadata policies according to the rules specified in the OIDC federation spec
(draft 17), section 5.1.3.1:
A function that returns a
OIDCClientRegistrationTokenClaimsContext from the inbound message context, located
as a subcontext for the profile request context.A function that returns a map of metadata policies from the
RegistrationClaimsSet.A function that returns
OIDCMetadataContext.Default validation strategy for post logout redirection URIs.
A function that returns resource value of the authorization request.
A function that returns code challenge value of the authorization request via a lookup function.
A function that returns code challenge method value of the authorization request via a lookup function.
For Token endpoint.
A function that returns copy of requested acr values via a lookup function.
A function that returns copy of requested claims via a lookup function.
A function that returns copy of requested prompt via a lookup function.
A function that returns copy of requested scopes via a lookup function.
A function that returns request login hint via a lookup function.
A function that returns authentication max age parameter the request via a lookup function.
A function that returns copy of Nonce via a lookup function.
A function that returns redirect uri of the authentication request via a lookup function.
A function that returns copy of the response mode of the request via a lookup function.
A function that returns copy of response type via a lookup function.
A function that returns copy of the state the request via a lookup function.
A function that returns id token claims set from response context.
Default predicate to decide if the pre-existing consent should be revoked.
Default lookup function for fetching the root token identifier from the given claims set.
Function to decide on subject type.
Default lookup function for fetching the token revocation lifetime from the given claims set.
Default lookup function for fetching the allowed scope from the unregistered client policy.
Default validator for the unregistered client policies.
Deprecated, for removal: This API element is subject to removal in a future version.
The response type validation is handled against the policy in the SWF action
A function that returns registered userinfo signing algorithm from metadata.
A function that returns registered post logout redirection uris from metadata.
A function that returns registered redirection uris from metadata.
A function that returns a set of valid response type for the authorization request.
Action that implements a JSON REST API for querying and deleting OIDC client information.
An extension to
FilesystemProviderMetadataResolver that enables some of the claims to be dynamically updated
outside the file.An action that executes the OIDC back-channel logout request and sets the result via
LogoutPropagationContext.setResult(net.shibboleth.idp.session.context.LogoutPropagationContext.Result).Extracts OAuth 2 client authentication details from a request and stores them in an
OAuth2ClientAuthenticationContext beneath the AuthenticationContext for subsequent
validation.An implementation to
RefreshableMetadataValueResolver that fetches the information from a file.Based on
FilesystemMetadataResolver.Action that forms outbound message based on request and response context.
This action builds a response for the OP configuration discovery request.
Action that forms outbound token introspection success message.
Action that forms outbound message based on request and response context.
Action that forms outbound token revocation success message.
Action that forms outbound message based on token request and response context.
Action that forms outbound message based on response context.
Action that forms outbound message based on request and response context.
A Nimbus
Response implementation representing a front-channel logout propagation message that is sent to the
RP's front-channel logout URI endpoint.An implementation of
MetadataValueResolver that resolves the value via attached Function.Creates the client ID for the registration.
Creates a new client secret with the
IdentifierGenerationStrategy attached to this action.A function that resolves a claim value from the id_token claims set.
An action that creates an
AuthenticationContext and attaches it to the current ProfileRequestContext.Action that adds an outbound
MessageContext and related OIDC contexts to the ProfileRequestContext
based on the identity of a relying party accessed via a lookup strategy, by default an immediate child of the profile
request context.Action that adds an outbound
MessageContext and related OIDC context
to the ProfileRequestContext.Action that adds an outbound
MessageContext and related contexts to the ProfileRequestContext.Action that adds an outbound
MessageContext and related contexts to the ProfileRequestContext.Action that adds an outbound
MessageContext and related OIDC contexts to the ProfileRequestContext
not knowing the relying party yet.Action that adds an outbound
MessageContext and related OIDC contexts to the ProfileRequestContext
not knowing the relying party yet.Initializes the
OIDCClientRegistrationMetadataPolicyContext and attaches it as a subcontext for the incoming
MessageContext.Action that adds a
RelyingPartyContext to the current ProfileRequestContext tree via a creation
function.An action that creates an
SubjectContext and attaches it to the current ProfileRequestContext.Action that adds a
RelyingPartyContext to the current ProfileRequestContext tree via a creation
function.Function that returns true is prompt contains 'none' in AuthenticationRequest.Activation condition returning true if validated scope contains 'openid' scope.
A
Criterion representing an OIDC (provider) issuer.Action that issues access token to be used for the OIDC dynamic registration endpoint.
Command line processing for issue-registration-access-token flow.
Descriptor for flow that issues access tokens for client registration.
Class for creating JSON Error response for requests expecting JSON response.
Class for creating JSON Success response.
Add the
JWT back to the AccessTokenContext.Extract the
JWTClaimsSet from the id_token in OIDCAuthenticationResponseContext.Extract the
JWTClaimsSet from the JWT in AccessTokenContext.Extract the
JWTClaimsSet from the JWT in OIDCBackChannelLogoutPropagationContext.Extract the
Payload from the user info in OIDCAuthenticationResponseContext.A validator that handles authentication via signed JWT.
KeySet success message class.
A function that returns client id of the OIDC logout request.
An action that can be used for manipulating id_token claims via configurable strategy (bi-function).
A function that returns metadata_statements (oidcfed) obtained via a lookup function.
A predicate for matching if the OIDC metadata value with a configurable key is equal to a configurable value.
A resolver that is capable of resolving dynamic metadata values (as
Objects) which meet certain supplied
criteria.A message encodes that encodes the Nimbus
Response in the message context inside the attached
HttpServletResponse.Message decoder decoding OAuth2
AuthorizationRequests.Message decoder decoding OpenID Connect
TokenIntrospectionRequests.OAuth2 Token Revocation Error message class.
Message decoder decoding OpenID Connect
TokenRevocationRequests.OAuth2 Token Revocation Success message class.
Subcontext carrying information for an OAuth token management responses such as introspection
or revocation.
A predicate returning true if validated scope contains 'offline_access' value.
Message decoder decoding OpenID Connect
AuthenticationRequests.Subcontext carrying user consent information in a form suitable for OIDC processing.
Subcontext carrying information to form authentication, token and userinfo responses for relying party.
A
ContextDataLookupFunction that returns the outbound OIDCAuthenticationResponseContext for a
ProfileRequestContext.Subcontext carrying information to form token and userinfo responses for relying party.
Subcontext carrying information about OIDC back-channel logout.
A password validator that authenticates against OIDC client metadata (which may itself be emulated
via SAML metadata).
Subcontext carrying information on the metadata policy related to the dynamic client registration.
Message decoder decoding OpenID Connect
ClientRegistrationRequests.A function that returns
OIDCClientMetadata if such is available in the message from a MessageContext
obtained via InOutOperationContext.getInboundMessageContext().Subcontext carrying information on OIDC client registration response.
A function that returns
OIDCClientMetadata if such is available in the message from a
OIDCClientRegistrationResponseContext.Subcontext carrying information on the claims included in the initial access token used for accessing the dynamic
client registration endpoint.
Subcontext carrying information about OIDC logout propagation (both front- and back-channel).
Message decoder decoding OpenID Connect
LogoutRequests.Handler for inbound OIDC protocol messages that attempts to locate OIDC metadata for a rp, and attaches it with a
OIDCMetadataContext as a child of a pre-existing instance of MessageContext.IdPModule implementation.Details about the OIDC OP plugin.
A lookup function for fetching policy-enforced client metadata related to the dynamic client registration request.
A
ContextDataLookupFunction that returns the outbound OIDCClientRegistrationResponseContext for a
ProfileRequestContext.A source of encoders that first verifies a message being an instance of Nimbus
Response and then returns the attached MessageEncoder.Subcontext carrying information about OIDC RP-initiated logout.
A concrete
SPSession implementation for OIDC relying parties.Builder class for building
OIDCRPSession.A lookup function that fetches
ClientID value from the OIDCRPSession found from the session stored in
the LogoutPropagationContext.A function to create a
OIDCRPSession based on profile execution state.A serializer for
OIDCRPSession objects.Message decoder decoding OpenID Connect
TokenRequests.Message decoder decoding OpenID Connect
UserInfoRequests.OpenID Configuration success message class.
Activation condition returning true if pairwise subject is requested.
Action that parses an access token and initially populates the claims for later
validation.
Extract the
Payload from the JWT in AccessTokenContext.Extract the
Payload from the processed token in OIDCAuthenticationResponseContext.Extract the
Payload from the user info in OIDCAuthenticationResponseContext.This action creates
OIDCLogoutPropagationContext and populates it with the front- and back-channel URIs if
found from the RP metadata.A message handler that attempts to locate OIDC client information from the SAML entity descriptor containing role
descriptor of type
SPSSODescriptor.Populates the
OIDCRpInitiatedLogoutContext with the values found from the incoming logout request.An action that constructs
LogoutTokenClaimsSet and attaches it to the
OIDCBackChannelLogoutPropagationContext.Add the
JWT back to the processed ID token hint in the OIDCRpInitiatedLogoutContext.Add the
JWT back to the processed token in the OIDCAuthenticationResponseContext.An action that creates an
RequestedPrincipalContext or PreferredPrincipalContext and attaches it to
the current AuthenticationContext.Profile action that processes
LogoutRequest and OIDCRpInitiatedLogoutContext by resolving matching
sessions and populating the associated SPSession objects into a LogoutContext.Action that processes a token for introspection.
Action that processes a token for revocation.
A function that returns responder id based on profile.
A resolver that is capable of resolving
OIDCProviderMetadata instances which meet certain supplied criteria.Strategy for summoning up a
ProviderMetadataResolver from a populated ApplicationContext.Activation condition returning true if public subject is requested.
A resolver that is capable of resolving dynamic metadata values (as
Objects) which meet certain supplied
criteria.Specialization of
ProviderMetadataResolver that supports on-demand refresh.Class wrapping claims set for refresh token.
Builder to create instance of RefreshTokenClaimsSet.
Class wrapping claims for the initial registration access token.
The builder for
RegistrationClaimsSet.Checks whether a
TokenRequest was for one of a set of candidate grant_type values.Add the
JWT back to the request object in the OIDCAuthenticationResponseContext.Request logging helper class.
A function that returns raw authorization code value from the
OIDCAuthenticationResponseContext.Response logging helper class.
Revocation cache contexts shared across actions.
Action that revokes consent if the configurable predicate returns true.
Function that returns token to be revoked by TokenRevocationRequest.Action that revokes a single token or the full chain of tokens, depending on the result of the configured lookup
strategy for the revocation method.
An action that revokes the token chain related to the logout propagation.
Verifies the root identifier (
TokenClaimsSet.KEY_ROOT_JTI from the JWT against revocation via configurable
RevocationCache.A Nimbus
Response implementation representing a post front-channel logout redirection message that is sent
to the RP's post front-channel logout URI endpoint.Static helper methods for handling
Scope objects, especially with IdP attributes.A function that returns sector identifier obtained via a lookup function.
A serviceable implementation of
ProviderMetadataResolver.Action that creates a Access Token, and sets it to work context
OIDCAuthenticationResponseContext.getAccessToken() located under
InOutOperationContext.getOutboundMessageContext().Action that sets authentication context class reference to work context
OIDCAuthenticationResponseContext
located under InOutOperationContext.getOutboundMessageContext().Action that sets authentication context class reference to work context
OIDCAuthenticationResponseContext
located under InOutOperationContext.getOutboundMessageContext().Action that sets authentication instant to work context
OIDCAuthenticationResponseContext located under
InOutOperationContext.getOutboundMessageContext().Action that creates a Authorization Code, and sets it to work context
OIDCAuthenticationResponseContext.getAuthorizationCode() located under
InOutOperationContext.getOutboundMessageContext().Action that locates consent from authorization code / access token.
Action that checks for adds the currently existing attributes from
AttributeContext for token delivery.MessageHandler that sets the entityID to the given SAMLPeerEntityContext class.Action that sets the
LogoutPropagationContext.setResult(Result) as 'success'.Action that creates a Refresh Token, and sets it to work context
OIDCAuthenticationResponseContext.getRefreshToken() located under
InOutOperationContext.getOutboundMessageContext().Action that sets requested claims to response context.
Action that sets requested sub value to response context.
Action that stored request object to
OIDCAuthenticationResponseContext.This action reads an event from the configured
EventContext lookup strategy and sets the status code for
HttpServletResponse according to the attached configuration.An action that sets
AttributeResolutionContext.setAttributeRecipientGroupID(java.lang.String) to sector identifier if pairwise
subject is requested.Action that locates session id using configurable lookup strategy.
Action that locates subject using strategy.
Action that locates any token delivery claims from authorization code / access token.
Action that checks for any released attributes marked for token delivery.
An action that stores the
ClientInformation from the OIDCClientRegistrationResponseContext to the
associated ClientInformationManager.Activation condition returning true if subject cannot be located from oidc response context.
Function that returns the type of the subject from OIDCAuthenticationResponseContext.Function that returns the value of the subject from OIDCAuthenticationResponseContext.Class to extend for token claims sets.
Abstract builder to extend builders from that are instantiating claims sets extending TokenClaimsSet.
Factory used for obtaining token extension beans of the desired type, identifier and scope.
Enumeration of the supported token extension types.
A function that returns a copy of requested resource list from a
TokenRequest.A function that returns raw authorization code value via a lookup function.
For Token and UserInfo end points.
For Token, Revocation and other end points supporting client authentication.
For Token and UserInfo end points.
For Token and UserInfo end points.
For Token end point.
For Token and UserInfo end points.
For Token endpoint.
For Token and UserInfo end points.
A function that returns a copy of requested scopes from a
TokenRequest.For Token and UserInfo end points.
For Token and UserInfo end points.
A bi-function that returns value for the given claim via a lookup function.
For user info end point.
For Token and UserInfo end points.
For UserInfo end point.
A function that returns user info claims set from response context.
Action that validates the claims pulled from an access token as usable for access
to the OP's UserInfo endpoint.
Action that validates requested resource/audience values against a computed set of "allowed"
values and populates the resulting set into the
OIDCAuthenticationResponseContext
and a ProxiedRequesterContext.An action that validates the incoming OAuth2 authorization request via configurable strategy.
Validates the client authentication type with the token_endpoint_auth_method stored in the client's metadata
and the profile configuration.
Validates a client ID against unregistered client policy via configurable policy enforcer.
Validates the presence of PKCE code challenge parameter from the incoming authentication request.
A function that returns
OIDCAuthenticationResponseContext.getAudience().A function that returns validated redirect uri from response context.
A function that returns
OIDCAuthenticationResponseContext.getScope().Predicate that evaluates a
ProfileRequestContext by looking for the validated Scope that matches
one of a designated set of string values, a single value, or a generic predicate.Action that validates an authorization grant.
An action that validates the grant type is registered to the requesting RP.
Action validates ID token hint in response context.
Action performs PKCE (https://oauth.net/2/pkce/) validation.
Action that validates post redirect URI is expected if it's being requested.
Action that validates redirect uri is expected.
Action that validates registration access token is a valid one.
Validates the incoming dynamic client registration request against the metadata policy stored in the
OIDCClientRegistrationMetadataPolicyContext.Action validates request object in response context.
An action that validates the requested response_mode is compliant with the profile configuration.
An action that validates the requested response_type is (1) registered to the requesting RP (or accepted in the
policy for unregistered clients) and (2) valid for the protocol used for request.
Action that validates requested and previously granted scopes are also registered in client metadata
and stores the resulting set in the response context.
Action verifies that produced subject equals to requested subject if such exists.