Package net.shibboleth.oidc.profile.impl

Class PopulateJWTDecryptionParameters

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.oidc.profile.impl.PopulateJWTDecryptionParameters

All Implemented Interfaces:

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

public class PopulateJWTDecryptionParameters
extends AbstractProfileAction

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

The default, per-RelyingParty, and default per-profile EncryptionConfiguration objects are input to the resolution process, along with any static, symmetric key credentials configured on the relying party i.e. the client_secret.

Since:

2.2.0

Event:

EventIds.PROCEED_EVENT_ID, EventIds.INVALID_PROFILE_CTX, EventIds.INVALID_SEC_CFG

Postcondition:

set the decryption parameters onto the security parameters context

Field Summary

Fields

Modifier and Type	Field	Description
private Function<ProfileRequestContext,List<DecryptionConfiguration>>	configurationLookupStrategy	Strategy used to lookup a per-request DecryptionConfiguration list.
private final org.slf4j.Logger	log	Class logger.
private Function<ProfileRequestContext,OIDCMetadataContext>	oidcClientMetadataContextLookupStrategy	Strategy used to look up a OIDC client metadata context.
private Function<ProfileRequestContext,RelyingPartyContext>	relyingPartyContextLookupStrategy	Lookup function for relying party context.
private DecryptionParametersResolver	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
PopulateJWTDecryptionParameters()	Constructor.

Method Summary

Modifier and Type	Method	Description
private CriteriaSet	buildCriteriaSet(ProfileRequestContext profileRequestContext, List<DecryptionConfiguration> configs)	Build the criteria used as input to the DecryptionParametersResolver.
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected void	doInitialize()
void	setClientMetadataContextLookupStrategy(Function<ProfileRequestContext,OIDCMetadataContext> strategy)	Set lookup strategy for OIDCMetadataContext for input to resolution.
void	setConfigurationLookupStrategy(Function<ProfileRequestContext,List<DecryptionConfiguration>> strategy)	Set the strategy used to look up a per-request DecryptionConfiguration list.
void	setDecryptionParametersResolver(DecryptionParametersResolver newResolver)	Set the resolver to use for the parameters to store into the context.
void	setRelyingPartyContextLookupStrategy(Function<ProfileRequestContext,RelyingPartyContext> strategy)	Set lookup strategy for relying party context.
void	setSecurityParametersContextLookupStrategy(Function<ProfileRequestContext,SecurityParametersContext> strategy)	Set the strategy used to look up the SecurityParametersContext to set the parameters for.

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

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

configurationLookupStrategy

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

Strategy used to lookup a per-request DecryptionConfiguration list.

oidcClientMetadataContextLookupStrategy

@Nullable
private Function<ProfileRequestContext,OIDCMetadataContext> oidcClientMetadataContextLookupStrategy

Strategy used to look up a OIDC client metadata context.

relyingPartyContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,RelyingPartyContext> relyingPartyContextLookupStrategy

Lookup function for relying party context.

resolver

@NonnullAfterInit
private DecryptionParametersResolver resolver

Resolver for parameters to store into context.

Constructor Details

PopulateJWTDecryptionParameters

public PopulateJWTDecryptionParameters()

Constructor.

Method Details

setRelyingPartyContextLookupStrategy

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

Set lookup strategy for relying party context.

Parameters:

strategy - lookup strategy

setDecryptionParametersResolver

public void setDecryptionParametersResolver(@Nonnull
 DecryptionParametersResolver newResolver)

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

Parameters:

newResolver - resolver to use

setConfigurationLookupStrategy

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

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

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

setClientMetadataContextLookupStrategy

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

Set lookup strategy for OIDCMetadataContext for input to resolution.

Parameters:

strategy - lookup strategy

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

doExecute

protected void doExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction

buildCriteriaSet

@Nonnull
private CriteriaSet buildCriteriaSet(@Nonnull
 ProfileRequestContext profileRequestContext,
 @Nonnull
 List<DecryptionConfiguration> configs)

Build the criteria used as input to the DecryptionParametersResolver.

Parameters:

profileRequestContext - current profile request context

configs - a list of DecryptionConfigurations to add to the criteria set.

Returns:

the criteria set to use