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

Class AbstractOIDCAuthenticationResponseAction

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

org.opensaml.profile.action.AbstractProfileAction

org.opensaml.profile.action.AbstractConditionalProfileAction

net.shibboleth.idp.profile.AbstractProfileAction

net.shibboleth.idp.authn.AbstractAuthenticationAction

net.shibboleth.idp.plugin.authn.oidc.rp.impl.AbstractOIDCAuthenticationResponseAction

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, ProfileAction, Aware, MessageSource, MessageSourceAware, Action

Direct Known Subclasses:

AbstractHttpOIDCAuthenticationAction, ValidateResponseState

public abstract class AbstractOIDCAuthenticationResponseAction
extends AbstractAuthenticationAction

Abstract class for actions based on the AuthenticationResponse located under the InOutOperationContext.getInboundMessageContext() and the built OIDCAuthenticationRequest located under the InOutOperationContext.getOutboundMessageContext().

Also makes available the OpenID Provider metadata context.

Field Summary

Fields

Modifier and Type	Field	Description
private OIDCAuthenticationRequest	authnRequest	OIDC authentication request built by the IdP.
private com.nimbusds.openid.connect.sdk.AuthenticationSuccessResponse	authnResponse	OIDC authentication response from upstream OP.
private final org.slf4j.Logger	log	Class logger.
private OIDCProviderMetadataContext	providerMetadataContext	OIDC Metadata context.
private Function<ProfileRequestContext,OIDCProviderMetadataContext>	providerMetadataLookupStrategy	Lookup strategy to locate the OP metadata to use.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractOIDCAuthenticationResponseAction()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext, AuthenticationContext authenticationContext)
protected OIDCAuthenticationRequest	getAuthenticationRequest()	Returns the authentication request build by this IdP.
protected com.nimbusds.openid.connect.sdk.AuthenticationSuccessResponse	getAuthenticationResponse()	Returns the authentication response from the upstream OP.
protected OIDCProviderMetadataContext	getProviderMetadataContext()	Returns the OIDC provider metadata context.
void	setProviderMetadataLookupStrategy(Function<ProfileRequestContext,OIDCProviderMetadataContext> strategy)	Set the lookup strategy to locate the OpenID providers metadata.

Methods inherited from class net.shibboleth.idp.authn.AbstractAuthenticationAction

doExecute, doExecute, doPreExecute, setAuthenticationContextLookupStrategy

Methods inherited from class net.shibboleth.idp.profile.AbstractProfileAction

doExecute, execute, getBean, getBean, getMessage, getMessage, getMessage, getParameter, getParameter, getProfileContextLookupStrategy, getRequestContext, getResult, setMessageSource, setProfileContextLookupStrategy

Methods inherited from class org.opensaml.profile.action.AbstractConditionalProfileAction

getActivationCondition, setActivationCondition

Methods inherited from class org.opensaml.profile.action.AbstractProfileAction

doPostExecute, doPostExecute, ensureHttpServletRequest, ensureHttpServletResponse, execute, getHttpServletRequest, getHttpServletRequestSupplier, getHttpServletResponse, getHttpServletResponseSupplier, getLogPrefix, isPreExecuteCalled, setHttpServletRequestSupplier, setHttpServletResponseSupplier

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

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

providerMetadataLookupStrategy

@Nonnull
private Function<ProfileRequestContext,OIDCProviderMetadataContext> providerMetadataLookupStrategy

Lookup strategy to locate the OP metadata to use.

authnResponse

@Nullable
private com.nimbusds.openid.connect.sdk.AuthenticationSuccessResponse authnResponse

OIDC authentication response from upstream OP.

authnRequest

@Nullable
private OIDCAuthenticationRequest authnRequest

OIDC authentication request built by the IdP.

providerMetadataContext

@Nullable
private OIDCProviderMetadataContext providerMetadataContext

OIDC Metadata context.

Constructor Details

AbstractOIDCAuthenticationResponseAction

protected AbstractOIDCAuthenticationResponseAction()

Constructor.

Method Details

setProviderMetadataLookupStrategy

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

Set the lookup strategy to locate the OpenID providers metadata.

Parameters:

strategy - the strategy.

getAuthenticationResponse

@Nullable
protected com.nimbusds.openid.connect.sdk.AuthenticationSuccessResponse getAuthenticationResponse()

Returns the authentication response from the upstream OP. Should never be null after AbstractAuthenticationAction.doPreExecute(ProfileRequestContext) has been called.

Returns:

the authentication response.

getAuthenticationRequest

@Nullable
protected OIDCAuthenticationRequest getAuthenticationRequest()

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

Returns:

the authentication request.

getProviderMetadataContext

@Nullable
protected OIDCProviderMetadataContext getProviderMetadataContext()

Returns the OIDC provider metadata context. Should never be null after AbstractAuthenticationAction.doPreExecute(ProfileRequestContext) has been called.

Returns:

The provider metadata context.

doPreExecute

protected boolean doPreExecute(@Nonnull
 ProfileRequestContext profileRequestContext,
 @Nonnull
 AuthenticationContext authenticationContext)

Overrides:

doPreExecute in class AbstractAuthenticationAction