Package net.shibboleth.idp.plugin.authn.oidc.rp.messaging.impl

Class AbstractOIDCAuthenticationRequestActionMessageHandler

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

org.opensaml.messaging.handler.AbstractMessageHandler

net.shibboleth.idp.plugin.authn.oidc.rp.messaging.impl.AbstractOIDCAuthenticationRequestActionMessageHandler

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, MessageHandler

Direct Known Subclasses:

AddAuthenticationContextClassReferencesHandler, AddEndpointURIHandler, AddForceAuthenticationHandler, AddLoginHintHandler, AddMaxAgeHandler, AddNonceHandler, AddPassiveAuthenticationHandler, AddRedirectURIHandler, AddRequestedClaimsHandler, AddResponseTypeAndModeHandler, AddScopesHandler

public abstract class AbstractOIDCAuthenticationRequestActionMessageHandler
extends AbstractMessageHandler

An abstract message handler that runs inside an WebFlowMessageHandlerAdaptor that provides functions to make available various OIDC contexts.

The MessageContext will either be INBOUND or OUTBOUND depending on the direction defined by the calling WebFlowMessageHandlerAdaptor action.

Field Summary

Fields

Modifier and Type	Field	Description
private OIDCAuthenticationRequest	authnRequest	OIDC authentication request built by the IdP.
private NonnullSupplier<HttpServletRequest>	httpServletRequestSupplier	Current HTTP request, if available.
private final org.slf4j.Logger	log	Class logger.
private static final ParentProfileRequestContextLookup<MessageContext>	PRC_LOOKUP	Lookup function for parent ProfileRequestContext.
private OIDCAuthenticationRelyingPartyProfileConfiguration	profileConfiguration	Applicable profile configuration.
private com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata	providerMetadata	OpenID Provider metadata .
private Function<MessageContext,OIDCProviderMetadataContext>	providerMetadataLookupStrategy	Lookup strategy to locate the OpenID Provider metadata to use.
private Function<ProfileRequestContext,RelyingPartyContext>	relyingPartyContextLookupStrategy	Lookup function for relying party context.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractOIDCAuthenticationRequestActionMessageHandler()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected <T> Function<MessageContext,T>	adapt(Function<ProfileRequestContext,T> function)	Adapt a ProfileRequestContext function to a MessageContext function via composing with a lookup function.
protected Predicate<MessageContext>	adapt(Predicate<ProfileRequestContext> predicate)	Adapt a ProfileRequestContext predicate into a MessageContext predicate via composing with a lookup function.
protected boolean	doPreInvoke(MessageContext messageContext)
protected OIDCAuthenticationRequest	getAuthenticationRequest()	Returns the authentication request build by this IdP.
HttpServletRequest	getHttpServletRequest()	Get the HTTP servlet request supplier.
NonnullSupplier<HttpServletRequest>	getHttpServletRequestSupplier()	Get the supplier for HTTP request if available.
protected OIDCAuthenticationRelyingPartyProfileConfiguration	getProfileConfiguration()	Returns the profile configuration associated with this request.
protected com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata	getProviderMetadata()	Returns the OpenID Provider metadata.
protected ProfileRequestContext	lookupProfileRequestContext(MessageContext messageContext)	Lookup the profile request context from the given message context using the function PRC_LOOKUP.
void	setHttpServletRequestSupplier(NonnullSupplier<HttpServletRequest> requestSupplier)	Set the HTTP servlet request supplier.
void	setProviderMetadataLookupStrategy(Function<MessageContext,OIDCProviderMetadataContext> strategy)	Set the lookup strategy to locate the OpenID providers metadata.
void	setRelyingPartyContextLookupStrategy(Function<ProfileRequestContext,RelyingPartyContext> strategy)	Set the strategy used to locate the RelyingPartyContext associated with a given ProfileRequestContext.

Methods inherited from class org.opensaml.messaging.handler.AbstractMessageHandler

doInvoke, doPostInvoke, doPostInvoke, getActivationCondition, getLogPrefix, invoke, isPreInvokeCalled, setActivationCondition

Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

checkComponentActive, checkSetterPreconditions, destroy, doDestroy, doInitialize, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.shibboleth.shared.component.InitializableComponent

initialize, isInitialized

Field Details

PRC_LOOKUP

@Nonnull
private static final ParentProfileRequestContextLookup<MessageContext> PRC_LOOKUP

Lookup function for parent ProfileRequestContext.

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

providerMetadataLookupStrategy

@Nonnull
private Function<MessageContext,OIDCProviderMetadataContext> providerMetadataLookupStrategy

Lookup strategy to locate the OpenID Provider metadata to use.

relyingPartyContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,RelyingPartyContext> relyingPartyContextLookupStrategy

Lookup function for relying party context.

authnRequest

@NonnullBeforeExec
private OIDCAuthenticationRequest authnRequest

OIDC authentication request built by the IdP.

providerMetadata

@NonnullBeforeExec
private com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata providerMetadata

OpenID Provider metadata .

profileConfiguration

@NonnullBeforeExec
private OIDCAuthenticationRelyingPartyProfileConfiguration profileConfiguration

Applicable profile configuration.

httpServletRequestSupplier

@Nullable
private NonnullSupplier<HttpServletRequest> httpServletRequestSupplier

Current HTTP request, if available.

Constructor Details

AbstractOIDCAuthenticationRequestActionMessageHandler

protected AbstractOIDCAuthenticationRequestActionMessageHandler()

Constructor.

Method Details

setHttpServletRequestSupplier

public void setHttpServletRequestSupplier(@Nullable
 NonnullSupplier<HttpServletRequest> requestSupplier)

Set the HTTP servlet request supplier.

Parameters:

requestSupplier - the supplier.

getHttpServletRequest

@Nullable
public HttpServletRequest getHttpServletRequest()

Get the HTTP servlet request supplier.

Returns:

the HTTP servlet request supplier

getHttpServletRequestSupplier

@Nullable
public NonnullSupplier<HttpServletRequest> getHttpServletRequestSupplier()

Get the supplier for HTTP request if available.

Returns:

current HTTP request

getAuthenticationRequest

@NonnullBeforeExec
protected OIDCAuthenticationRequest getAuthenticationRequest()

Returns the authentication request build by this IdP. Should never be null after after doPreExecute has been called.

Returns:

the authentication request.

getProfileConfiguration

@NonnullBeforeExec
protected OIDCAuthenticationRelyingPartyProfileConfiguration getProfileConfiguration()

Returns the profile configuration associated with this request. Should never be null after doPreExecute has been called.

Returns:

the profile configuration

getProviderMetadata

@NonnullBeforeExec
protected com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata getProviderMetadata()

Returns the OpenID Provider metadata. Should never be null after after doPreExecute has been called.

Returns:

The provider metadata context.

setRelyingPartyContextLookupStrategy

public void setRelyingPartyContextLookupStrategy(@Nonnull
 Function<ProfileRequestContext,RelyingPartyContext> strategy)

Set the strategy used to locate the RelyingPartyContext associated with a given ProfileRequestContext.

Parameters:

strategy - lookup strategy

setProviderMetadataLookupStrategy

public void setProviderMetadataLookupStrategy(@Nonnull
 Function<MessageContext,OIDCProviderMetadataContext> strategy)

Set the lookup strategy to locate the OpenID providers metadata.

Parameters:

strategy - the strategy.

adapt

@Nullable
protected <T> Function<MessageContext,T> adapt(@Nullable
 Function<ProfileRequestContext,T> function)

Adapt a ProfileRequestContext function to a MessageContext function via composing with a lookup function.

Type Parameters:

T - the output type of the functions

Parameters:

function - the profile request context function

Returns:

the message context function

lookupProfileRequestContext

@Nullable
protected ProfileRequestContext lookupProfileRequestContext(@Nonnull
 MessageContext messageContext)

Lookup the profile request context from the given message context using the function PRC_LOOKUP.

Parameters:

messageContext - the message context to find the profile request context from

Returns:

the profile request context, or null if not found

adapt

@Nullable
protected Predicate<MessageContext> adapt(@Nullable
 Predicate<ProfileRequestContext> predicate)

Adapt a ProfileRequestContext predicate into a MessageContext predicate via composing with a lookup function.

Parameters:

predicate - the profile request context predicate

Returns:

the message context predicate

doPreInvoke

protected boolean doPreInvoke(@Nonnull
 MessageContext messageContext)
                       throws MessageHandlerException

Overrides:

doPreInvoke in class AbstractMessageHandler

Throws:

MessageHandlerException