Package net.shibboleth.sp.saml.saml2.profile.impl

Class ProcessLogoutRequest

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.sp.profile.AbstractAgentRequestAction

net.shibboleth.sp.profile.AbstractAgentAction

net.shibboleth.sp.profile.AbstractApplicationAction

net.shibboleth.sp.saml.saml2.profile.impl.ProcessLogoutRequest

All Implemented Interfaces:

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

public class ProcessLogoutRequest
extends AbstractApplicationAction

Processes an inbound LogoutRequest from an IdP against the information supplied by the Agent.

Based on the results, we encode a state token for the Agent to return later to get a response issued to the IdP.

Event:

EventIds.PROCEED_EVENT_ID, EventIds.INVALID_PROFILE_CTX, EventIds.UNABLE_TO_DECODE

Precondition:

profileRequestContext.ensureInboundMessageContext().getMessage() instanceof org.opensaml.saml.saml2.core.LogoutRequest

Field Summary

Fields

Modifier and Type	Field	Description
private Function<ProfileRequestContext,String>	assertingPartyLookupStrategy	Lookup function for obtaining default NameQualifier.
private String	localIssuer	Local identity of Agent saved for use.
private final org.slf4j.Logger	log	Class logger.
private LogoutRequest	logoutRequest	Logout request message.
private DDF	output	Output message.
private ParserPool	parserPool	Parser machinery.
private Set<String>	qualifiedNameIDFormats	NameID Formats allowing defaulted qualifiers.
private Function<ProfileRequestContext,Collection<String>>	qualifiedNameIDFormatsLookupStrategy	Lookup strategy for obtaining qualifier-defaultable NameID Formats.
private Function<ProfileRequestContext,String>	relyingPartyLookupStrategy	Lookup function for obtaining default SPNameQualifier.
private StateManager	stateManager	State manager to issue token with.
static final String	TOKEN_PREFIX	"token" value prefix.

Constructor Summary

Constructors

Constructor	Description
ProcessLogoutRequest()	Constructor.

Method Summary

Modifier and Type	Method	Description
private void	addToken(ProfileRequestContext profileRequestContext, Issuer authority, boolean matched)	Generate token for Agent based on logout request and add to output.
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected void	doInitialize()
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
private boolean	isAsynchronous()	Gets whether the request contains the Asynchronous extension.
private boolean	requestMatchesSession(ProfileRequestContext profileRequestContext, Issuer issuer, NameID sessionNameID)	Determines whethe the NameID and optional SessionIndex in the LogoutRequest strongly match the values preserved for the session.
void	setAssertingPartyLookupStrategy(Function<ProfileRequestContext,String> strategy)	Set the lookup strategy to obtain the default IdP NameQualifier.
void	setParserPool(ParserPool pool)	Sets the ParserPool to parse session data with.
void	setQualifiedNameIDFormatsLookupStrategy(Function<ProfileRequestContext,Collection<String>> strategy)	Set the lookup strategy for the NameID Formats to allow defaulted qualifiers.
void	setRelyingPartyLookupStrategy(Function<ProfileRequestContext,String> strategy)	Set the lookup strategy to obtain the default SPNameQualifier.
void	setStateManager(StateManager manager)	Sets the StateManager to issue token with.

Methods inherited from class net.shibboleth.sp.profile.AbstractApplicationAction

ensureApplication, getApplication

Methods inherited from class net.shibboleth.sp.profile.AbstractAgentAction

ensureAgent, getAgent

Methods inherited from class net.shibboleth.sp.profile.AbstractAgentRequestAction

ensureAgentRequestContext, getAgentRequestContext, setAgentRequestContextLookupStrategy

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, 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

TOKEN_PREFIX

@Nonnull
@NotEmpty
public static final String TOKEN_PREFIX

"token" value prefix.

See Also:

• Constant Field Values

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

parserPool

@NonnullAfterInit
private ParserPool parserPool

Parser machinery.

stateManager

@NonnullAfterInit
private StateManager stateManager

State manager to issue token with.

qualifiedNameIDFormatsLookupStrategy

@Nonnull
private Function<ProfileRequestContext,Collection<String>> qualifiedNameIDFormatsLookupStrategy

Lookup strategy for obtaining qualifier-defaultable NameID Formats.

assertingPartyLookupStrategy

@Nonnull
private Function<ProfileRequestContext,String> assertingPartyLookupStrategy

Lookup function for obtaining default NameQualifier.

relyingPartyLookupStrategy

@Nonnull
private Function<ProfileRequestContext,String> relyingPartyLookupStrategy

Lookup function for obtaining default SPNameQualifier.

qualifiedNameIDFormats

@Nonnull
private Set<String> qualifiedNameIDFormats

NameID Formats allowing defaulted qualifiers.

logoutRequest

@NonnullBeforeExec
private LogoutRequest logoutRequest

Logout request message.

output

@NonnullBeforeExec
private DDF output

Output message.

localIssuer

@Nullable
private String localIssuer

Local identity of Agent saved for use.

Constructor Details

ProcessLogoutRequest

public ProcessLogoutRequest()

Constructor.

Method Details

setParserPool

public void setParserPool(@Nonnull
 ParserPool pool)

Sets the ParserPool to parse session data with.

Parameters:

pool - parser pool

setStateManager

public void setStateManager(@Nonnull
 StateManager manager)

Sets the StateManager to issue token with.

Parameters:

manager - state manager

setQualifiedNameIDFormatsLookupStrategy

public void setQualifiedNameIDFormatsLookupStrategy(@Nonnull
 Function<ProfileRequestContext,Collection<String>> strategy)

Set the lookup strategy for the NameID Formats to allow defaulted qualifiers.

Parameters:

strategy - lookup strategy

setAssertingPartyLookupStrategy

public void setAssertingPartyLookupStrategy(@Nonnull
 Function<ProfileRequestContext,String> strategy)

Set the lookup strategy to obtain the default IdP NameQualifier.

Parameters:

strategy - lookup strategy

setRelyingPartyLookupStrategy

public void setRelyingPartyLookupStrategy(@Nonnull
 Function<ProfileRequestContext,String> strategy)

Set the lookup strategy to obtain the default SPNameQualifier.

Parameters:

strategy - lookup strategy

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

doPreExecute

protected boolean doPreExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractApplicationAction

doExecute

protected void doExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction

requestMatchesSession

private boolean requestMatchesSession(@Nonnull
 ProfileRequestContext profileRequestContext,
 @Nullable
 Issuer issuer,
 @Nullable
 NameID sessionNameID)

Determines whethe the NameID and optional SessionIndex in the LogoutRequest strongly match the values preserved for the session.

Parameters:

profileRequestContext - profile request context

issuer - logout request issuer

sessionNameID - session-preserved NameID

Returns:

true iff the logout request strongly matched

isAsynchronous

private boolean isAsynchronous()

Gets whether the request contains the Asynchronous extension.

Returns:

true iff the request contains the extension

addToken

private void addToken(@Nonnull
 ProfileRequestContext profileRequestContext,
 @Nullable
 Issuer authority,
 boolean matched)

Generate token for Agent based on logout request and add to output.

The token tracks the request ID and the issuer.

Parameters:

profileRequestContext - profile request context

authority - issuer of request

matched - matched signal