Package net.shibboleth.oidc.profile.impl

Class PopulateJWTSignatureSigningParametersHandler

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

org.opensaml.messaging.handler.AbstractMessageHandler

net.shibboleth.oidc.profile.impl.PopulateJWTSignatureSigningParametersHandler

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, MessageHandler

public class PopulateJWTSignatureSigningParametersHandler
extends AbstractMessageHandler

Handler that resolves and populates SignatureSigningParameters on a SecurityParametersContext created/accessed via a lookup function, by default as an immediate child context of the target MessageContext.

Extracts any OpenID client/provider metadata, SAML metadata, and static client credentials from relying party configuration as criteria to pass to the signing parameters resolver.

Since:

2.2.0

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
PopulateJWTSignatureSigningParametersHandler()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doInitialize()
protected void	doInvoke(MessageContext messageContext)
protected boolean	doPreInvoke(MessageContext messageContext)
void	setClientMetadataContextLookupStrategy(Function<MessageContext,OIDCMetadataContext> strategy)	Set lookup strategy for OIDCMetadataContext for input to resolution.
void	setConfigurationLookupStrategy(Function<MessageContext,List<SignatureSigningConfiguration>> strategy)	Set the strategy used to look up a per-request SignatureSigningConfiguration list.
void	setExistingParametersContextLookupStrategy(Function<MessageContext,SecurityParametersContext> strategy)	Set the strategy used to look up an existing SecurityParametersContext to copy instead of actually resolving the parameters to set.
void	setMetadataContextLookupStrategy(Function<MessageContext,SAMLMetadataContext> strategy)	Set lookup strategy for SAMLMetadataContext for input to resolution.
void	setNoResultIsError(boolean flag)	Set whether a failure to resolve any parameters should be raised as an exception.
void	setProviderMetadataContextLookupStrategy(Function<MessageContext,OIDCProviderMetadataContext> strategy)	Set lookup strategy for OIDCProviderMetadataContext for input to resolution.
void	setRelyingPartyContextLookupStrategy(Function<MessageContext,RelyingPartyContext> strategy)	Set lookup strategy for relying party context.
void	setSecurityParametersContextLookupStrategy(Function<MessageContext,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.messaging.handler.AbstractMessageHandler

doPostInvoke, doPostInvoke, getActivationCondition, getLogPrefix, invoke, isPreInvokeCalled, setActivationCondition

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 final org.slf4j.Logger log

Class logger.

securityParametersContextLookupStrategy

@Nonnull
private Function<MessageContext,SecurityParametersContext> securityParametersContextLookupStrategy

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

existingParametersContextLookupStrategy

@Nullable
private Function<MessageContext,SecurityParametersContext> existingParametersContextLookupStrategy

Strategy used to look up an existing SecurityParametersContext to copy.

configurationLookupStrategy

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

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

metadataContextLookupStrategy

@Nonnull
private Function<MessageContext,SAMLMetadataContext> metadataContextLookupStrategy

Strategy used to look up a SAML metadata context.

oidcClientMetadataContextLookupStrategy

@Nonnull
private Function<MessageContext,OIDCMetadataContext> oidcClientMetadataContextLookupStrategy

Strategy used to look up a OIDC client metadata context.

oidcProviderMetadataContextLookupStrategy

@Nonnull
private Function<MessageContext,OIDCProviderMetadataContext> oidcProviderMetadataContextLookupStrategy

Strategy used to look up a OIDC provider metadata context.

relyingPartyContextLookupStrategy

@Nonnull
private Function<MessageContext,RelyingPartyContext> relyingPartyContextLookupStrategy

Lookup function for relying party 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

PopulateJWTSignatureSigningParametersHandler

public PopulateJWTSignatureSigningParametersHandler()

Constructor.

Method Details

setRelyingPartyContextLookupStrategy

public void setRelyingPartyContextLookupStrategy(@Nonnull
 Function<MessageContext,RelyingPartyContext> strategy)

Set lookup strategy for relying party context.

Parameters:

strategy - lookup strategy

setSecurityParametersContextLookupStrategy

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

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

Parameters:

strategy - lookup strategy

setClientMetadataContextLookupStrategy

public void setClientMetadataContextLookupStrategy(@Nonnull
 Function<MessageContext,OIDCMetadataContext> strategy)

Set lookup strategy for OIDCMetadataContext for input to resolution.

Parameters:

strategy - lookup strategy

setProviderMetadataContextLookupStrategy

public void setProviderMetadataContextLookupStrategy(@Nonnull
 Function<MessageContext,OIDCProviderMetadataContext> strategy)

Set lookup strategy for OIDCProviderMetadataContext for input to resolution.

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

setExistingParametersContextLookupStrategy

public void setExistingParametersContextLookupStrategy(@Nullable
 Function<MessageContext,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

setMetadataContextLookupStrategy

public void setMetadataContextLookupStrategy(@Nonnull
 Function<MessageContext,SAMLMetadataContext> strategy)

Set lookup strategy for SAMLMetadataContext for input to resolution.

Parameters:

strategy - lookup strategy

setConfigurationLookupStrategy

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

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

Parameters:

strategy - lookup strategy

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

doPreInvoke

protected boolean doPreInvoke(@Nonnull
 MessageContext messageContext)
                       throws MessageHandlerException

Overrides:

doPreInvoke in class AbstractMessageHandler

Throws:

MessageHandlerException

doInvoke

protected void doInvoke(@Nonnull
 MessageContext messageContext)
                 throws MessageHandlerException

Specified by:

doInvoke in class AbstractMessageHandler

Throws:

MessageHandlerException