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

Class AddStateHandler

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

org.opensaml.messaging.handler.AbstractMessageHandler

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

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

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, MessageHandler

public class AddStateHandler
extends AbstractOIDCAuthenticationRequestMessageHandler

Add state to the authentication request URL and the request object claims (if present). By default this is generated by concatenating the Hex value of the spring webflow execution key with a secure random 32 character nonce.

Field Summary

Fields

Modifier and Type	Field	Description
private final org.slf4j.Logger	log	Logger.
private static final String	STATE_CLAIM	The 'state' claim name.
private Function<MessageContext,String>	stateGenerationStrategy	Function to create a suitable 'state' to add to the authentication request.

Constructor Summary

Constructors

Constructor	Description
AddStateHandler()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doInvoke(MessageContext messageContext)
void	setStateGenerationStrategy(Function<MessageContext,String> strategy)	Set the creation strategy used to compute the 'state'.

Methods inherited from class net.shibboleth.idp.plugin.authn.oidc.rp.messaging.impl.AbstractOIDCAuthenticationRequestMessageHandler

doPreInvoke, getAuthenticationRequest, getOutboundMessageContext, setAuthenticationRequestLookupStrategy, setOutboundMessageHandlerContextLookupStrategy

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

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

STATE_CLAIM

@Nonnull
private static final String STATE_CLAIM

The 'state' claim name.

See Also:

• Constant Field Values

log

@Nonnull
private final org.slf4j.Logger log

Logger.

stateGenerationStrategy

@Nonnull
private Function<MessageContext,String> stateGenerationStrategy

Function to create a suitable 'state' to add to the authentication request.

Constructor Details

AddStateHandler

public AddStateHandler()

Constructor.

Method Details

setStateGenerationStrategy

public void setStateGenerationStrategy(@Nullable
 Function<MessageContext,String> strategy)

Set the creation strategy used to compute the 'state'.

Parameters:

strategy - the creation strategy

doInvoke

protected void doInvoke(@Nonnull
 MessageContext messageContext)
                 throws MessageHandlerException

Specified by:

doInvoke in class AbstractMessageHandler

Throws:

MessageHandlerException