Package net.shibboleth.idp.plugin.oidc.op.oauth2.profile.impl

Class InitializeDPoPProofContext

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.plugin.oidc.op.profile.impl.AbstractOIDCRequestAction<Request>

net.shibboleth.idp.plugin.oidc.op.oauth2.profile.impl.InitializeDPoPProofContext

All Implemented Interfaces:

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

public class InitializeDPoPProofContext
extends AbstractOIDCRequestAction<Request>

Action that stores DPoP proof JWT to OAuth2DPoPProofContext. The value is extracted from the HTTP request header. If the DPoP-header contains a value, this action verifies that it's a single SignedJWT value as mandated by the specification.

Since:

4.2.0

Field Summary

Fields

Modifier and Type	Field	Description
private org.slf4j.Logger	log	Class logger.
private com.fasterxml.jackson.databind.ObjectMapper	objectMapper	Object mapper used for pretty-printing JWT contents.
private org.slf4j.Logger	protocolMessageLog	Used to log protocol messages.
private Predicate<ProfileRequestContext>	requireDpopProofCondition	Predicate for enforcing the use of DPoP proofs.

Constructor Summary

Constructors

Constructor	Description
InitializeDPoPProofContext()

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected void	doInitialize()
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
protected void	doProtocolLog(ProfileRequestContext profileRequestContext, JWT jwt, String messagePrefix)	Create a protocol message containing the pretty-printed contents of the given JWT.
protected String	getSingleValueOrNull(Enumeration<String> enumeration)	Returns the value from given enumeration if only single value exists, null otherwise.
void	setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper mapper)	Set the object mapper used for pretty-printing JWT contents.
void	setRequireDpopProofCondition(Predicate<ProfileRequestContext> predicate)	Set the predicate for enforcing the use of DPoP proofs.

Methods inherited from class net.shibboleth.idp.plugin.oidc.op.profile.impl.AbstractOIDCRequestAction

getRequest

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

log

@Nonnull
private org.slf4j.Logger log

Class logger.

protocolMessageLog

@Nonnull
private org.slf4j.Logger protocolMessageLog

Used to log protocol messages.

requireDpopProofCondition

@NonnullAfterInit
private Predicate<ProfileRequestContext> requireDpopProofCondition

Predicate for enforcing the use of DPoP proofs.

objectMapper

@NonnullAfterInit
private com.fasterxml.jackson.databind.ObjectMapper objectMapper

Object mapper used for pretty-printing JWT contents.

Constructor Details

InitializeDPoPProofContext

public InitializeDPoPProofContext()

Method Details

setRequireDpopProofCondition

public void setRequireDpopProofCondition(@Nonnull
 Predicate<ProfileRequestContext> predicate)

Set the predicate for enforcing the use of DPoP proofs.

Parameters:

predicate - the predicate for enforcing the use of DPoP proofs

setObjectMapper

public void setObjectMapper(@Nonnull
 com.fasterxml.jackson.databind.ObjectMapper mapper)

Set the object mapper used for pretty-printing JWT contents.

Parameters:

mapper - What to set.

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

doPreExecute

protected boolean doPreExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractOIDCRequestAction<Request>

doExecute

protected void doExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction

getSingleValueOrNull

@Nullable
protected String getSingleValueOrNull(@Nullable
 Enumeration<String> enumeration)

Returns the value from given enumeration if only single value exists, null otherwise.

Parameters:

enumeration - the input enumeration

Returns:

the single value if exists, null otherwise

doProtocolLog

protected void doProtocolLog(@Nonnull
 ProfileRequestContext profileRequestContext,
 @Nonnull
 JWT jwt,
 @Nonnull
 String messagePrefix)

Create a protocol message containing the pretty-printed contents of the given JWT.

Parameters:

profileRequestContext - Profile request context where to publish possible error event

jwt - The token to be logged

messagePrefix - The prefix for the protocol log message