Package net.shibboleth.oidc.profile.impl

Class PopulateJWTSignatureSigningParameters

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

org.opensaml.profile.action.AbstractProfileAction

org.opensaml.profile.action.AbstractConditionalProfileAction

org.opensaml.profile.action.AbstractHandlerDelegatingProfileAction<PopulateJWTSignatureSigningParametersHandler>

net.shibboleth.oidc.profile.impl.PopulateJWTSignatureSigningParameters

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, ProfileAction

public class PopulateJWTSignatureSigningParameters
extends AbstractHandlerDelegatingProfileAction<PopulateJWTSignatureSigningParametersHandler>

Action that resolves and populates SignatureSigningParameters on a SecurityParametersContext created/accessed via a lookup function, by default on the outbound message context.

Since:

2.2.0

Event:

EventIds.PROCEED_EVENT_ID, EventIds.INVALID_MSG_CTX, EventIds.INVALID_SEC_CFG

Field Summary

Fields

Modifier and Type	Field	Description
private Function<ProfileRequestContext,List<SignatureSigningConfiguration>>	configurationLookupStrategy	Strategy used to look up a per-request SignatureSigningConfiguration list.
private Function<ProfileRequestContext,SecurityParametersContext>	existingParametersContextLookupStrategy	Strategy used to look up an existing SecurityParametersContext to copy.
private final org.slf4j.Logger	log	Class logger.
private boolean	noResultIsError	Whether failure to resolve parameters should be raised as an error.
private Function<ProfileRequestContext,OIDCMetadataContext>	oidcClientMetadataContextLookupStrategy	Strategy used to look up a OIDC client metadata context.
private Function<ProfileRequestContext,OIDCProviderMetadataContext>	oidcProviderMetadataContextLookupStrategy	Strategy used to look up a OIDC provider metadata context.
private SignatureSigningParametersResolver	resolver	Resolver for parameters to store into context.
private Function<ProfileRequestContext,SecurityParametersContext>	securityParametersContextLookupStrategy	Strategy used to look up the SecurityParametersContext to set the parameters for.

Constructor Summary

Constructors

Constructor	Description
PopulateJWTSignatureSigningParameters(ContextDataLookupFunction<ProfileRequestContext,MessageContext> strategy)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doInitialize()
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
void	setClientMetadataContextLookupStrategy(Function<ProfileRequestContext,OIDCMetadataContext> strategy)	Set lookup strategy for OIDCMetadataContext for input to resolution.
void	setConfigurationLookupStrategy(Function<ProfileRequestContext,List<SignatureSigningConfiguration>> strategy)	Set the strategy used to look up a per-request SignatureSigningConfiguration list.
void	setExistingParametersContextLookupStrategy(Function<ProfileRequestContext,SecurityParametersContext> strategy)	Set the strategy used to look up an existing SecurityParametersContext to copy instead of actually resolving the parameters to set.
void	setNoResultIsError(boolean flag)	Set whether a failure to resolve any parameters should be raised as an exception.
void	setProviderMetadataContextLookupStrategy(Function<ProfileRequestContext,OIDCProviderMetadataContext> strategy)	Set lookup strategy for OIDCProviderMetadataContext for input to resolution.
void	setSecurityParametersContextLookupStrategy(Function<ProfileRequestContext,SecurityParametersContext> strategy)	Set the strategy used to look up the SecurityParametersContext to set the parameters for.
void	setSignatureSigningParametersResolver(SignatureSigningParametersResolver newResolver)	Set the resolver to use for the parameters to store into the context.

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

adapt, adapt, adaptRequired, doDestroy, doExecute, getDelegate, setErrorEvent

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

securityParametersContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,SecurityParametersContext> securityParametersContextLookupStrategy

Strategy used to look up the SecurityParametersContext to set the parameters for.

existingParametersContextLookupStrategy

@Nullable
private Function<ProfileRequestContext,SecurityParametersContext> existingParametersContextLookupStrategy

Strategy used to look up an existing SecurityParametersContext to copy.

configurationLookupStrategy

@NonnullAfterInit
private Function<ProfileRequestContext,List<SignatureSigningConfiguration>> configurationLookupStrategy

Strategy used to look up a per-request SignatureSigningConfiguration list.

oidcClientMetadataContextLookupStrategy

@Nullable
private Function<ProfileRequestContext,OIDCMetadataContext> oidcClientMetadataContextLookupStrategy

Strategy used to look up a OIDC client metadata context.

oidcProviderMetadataContextLookupStrategy

@Nullable
private Function<ProfileRequestContext,OIDCProviderMetadataContext> oidcProviderMetadataContextLookupStrategy

Strategy used to look up a OIDC provider metadata context.

resolver

@NonnullAfterInit
private SignatureSigningParametersResolver resolver

Resolver for parameters to store into context.

noResultIsError

private boolean noResultIsError

Whether failure to resolve parameters should be raised as an error.

Constructor Details

PopulateJWTSignatureSigningParameters

public PopulateJWTSignatureSigningParameters(@ParameterName(name="strategy") @Nonnull
 ContextDataLookupFunction<ProfileRequestContext,MessageContext> strategy)

Constructor.

Parameters:

strategy - lookup strategy for message context

Method Details

setClientMetadataContextLookupStrategy

public void setClientMetadataContextLookupStrategy(@Nullable
 Function<ProfileRequestContext,OIDCMetadataContext> strategy)

Set lookup strategy for OIDCMetadataContext for input to resolution.

Parameters:

strategy - lookup strategy

setProviderMetadataContextLookupStrategy

public void setProviderMetadataContextLookupStrategy(@Nullable
 Function<ProfileRequestContext,OIDCProviderMetadataContext> strategy)

Set lookup strategy for OIDCProviderMetadataContext for input to resolution.

Parameters:

strategy - lookup strategy

setExistingParametersContextLookupStrategy

public void setExistingParametersContextLookupStrategy(@Nullable
 Function<ProfileRequestContext,SecurityParametersContext> strategy)

Set the strategy used to look up an existing SecurityParametersContext to copy instead of actually resolving the parameters to set.

Parameters:

strategy - lookup strategy

setSecurityParametersContextLookupStrategy

public void setSecurityParametersContextLookupStrategy(@Nonnull
 Function<ProfileRequestContext,SecurityParametersContext> strategy)

Set the strategy used to look up the SecurityParametersContext to set the parameters for.

Parameters:

strategy - lookup strategy

setConfigurationLookupStrategy

public void setConfigurationLookupStrategy(@Nonnull
 Function<ProfileRequestContext,List<SignatureSigningConfiguration>> strategy)

Set the strategy used to look up a per-request SignatureSigningConfiguration list.

Parameters:

strategy - lookup strategy

setSignatureSigningParametersResolver

public void setSignatureSigningParametersResolver(@Nonnull
 SignatureSigningParametersResolver newResolver)

Set the resolver to use for the parameters to store into the context.

Parameters:

newResolver - resolver to use

setNoResultIsError

public void setNoResultIsError(boolean flag)

Set whether a failure to resolve any parameters should be raised as an exception.

Defaults to false.

Parameters:

flag - flag 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 AbstractConditionalProfileAction