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

Class SetAuthorizationCodeToResponseContext

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<AuthorizationRequest>

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

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

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

All Implemented Interfaces:

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

public class SetAuthorizationCodeToResponseContext
extends AbstractOAuthAuthorizationResponseAction

Action that creates a Authorization Code, and sets it to work context OIDCAuthenticationResponseContext.getAuthorizationCode() located under InOutOperationContext.getOutboundMessageContext().

Field Summary

Fields

Modifier and Type	Field	Description
private Duration	authzCodeLifetime	Authorization code lifetime.
private Function<ProfileRequestContext,Duration>	authzCodeLifetimeLookupStrategy	Strategy used to obtain the authz code lifetime.
private String	codeChallenge	Code challenge and the code challenge method stored to authz code.
private Function<ProfileRequestContext,String>	codeChallengeLookupStrategy	Strategy used to locate the code challenge.
private Function<ProfileRequestContext,String>	codeChallengeMethodLookupStrategy	Strategy used to locate the code challenge method.
private Function<ProfileRequestContext,OIDCAuthenticationResponseConsentContext>	consentContextLookupStrategy	Strategy used to locate the OIDCAuthenticationResponseConsentContext.
private Predicate<ProfileRequestContext>	consentEnabledPredicate	Predicate used to check if consent is enabled with a given ProfileRequestContext.
private DataSealer	dataSealer	Data sealer for handling authorization code.
private IdentifierGenerationStrategy	idGenerator	The generator to use.
private Function<ProfileRequestContext,IdentifierGenerationStrategy>	idGeneratorLookupStrategy	Strategy used to locate the IdentifierGenerationStrategy to use.
private Function<ProfileRequestContext,String>	issuerLookupStrategy	Strategy used to obtain the response issuer value.
private org.slf4j.Logger	log	Class logger.
private BiFunction<ProfileRequestContext,Map<String,Object>,Map<String,Object>>	manipulationStrategy	The strategy used for manipulating the token claims set.
private Function<ProfileRequestContext,Nonce>	requestNonceLookupStrategy	Strategy used to obtain the request nonce.
private SubjectContext	subjectCtx	Subject context.
private Function<ProfileRequestContext,OIDCAuthenticationResponseTokenClaimsContext>	tokenClaimsContextLookupStrategy	Strategy used to locate the OIDCAuthenticationResponseTokenClaimsContext.
private Function<ProfileRequestContext,BiFunction<ProfileRequestContext,Map<String,Object>,Map<String,Object>>>	tokenClaimsSetManipulationStrategyLookupStrategy	Lookup function to supply strategy bi-function for manipulating token claims set.
private boolean	xmlSafeIdentifier	The xmlSafe-flag passed to the identifier generator.

Constructor Summary

Constructors

Constructor	Description
SetAuthorizationCodeToResponseContext()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected void	doInitialize()
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
void	setAuthzCodeLifetimeLookupStrategy(Function<ProfileRequestContext,Duration> strategy)	Set the strategy used to obtain the authz code lifetime.
void	setCodeChallengeLookupStrategy(Function<ProfileRequestContext,String> strategy)	Set the strategy used to locate the Code Challenge of the request.
void	setCodeChallengeMethodLookupStrategy(Function<ProfileRequestContext,String> strategy)	Set the strategy used to locate the Code Challenge Method of the request.
void	setConsentEnabledPredicate(Predicate<ProfileRequestContext> predicate)	Set the predicate used to check if consent is enabled with a given ProfileRequestContext.
void	setDataSealer(DataSealer sealer)	Set the data sealer instance to use.
void	setIdentifierGeneratorLookupStrategy(Function<ProfileRequestContext,IdentifierGenerationStrategy> strategy)	Set the strategy used to locate the IdentifierGenerationStrategy to use.
void	setIssuerLookupStrategy(Function<ProfileRequestContext,String> strategy)	Set the strategy used to locate the issuer value to use.
void	setOIDCAuthenticationResponseConsentContextLookupStrategy(Function<ProfileRequestContext,OIDCAuthenticationResponseConsentContext> strategy)	Set the strategy used to locate the OIDCAuthenticationResponseTokenClaimsContext associated with a given ProfileRequestContext.
void	setOIDCAuthenticationResponseTokenClaimsContextLookupStrategy(Function<ProfileRequestContext,OIDCAuthenticationResponseTokenClaimsContext> strategy)	Set the strategy used to locate the OIDCAuthenticationResponseTokenClaimsContext associated with a given ProfileRequestContext.
void	setRequestNonceLookupStrategy(Function<ProfileRequestContext,Nonce> strategy)	Set the strategy used to locate the nonce of authentication request.
void	setTokenClaimsSetManipulationStrategyLookupStrategy(Function<ProfileRequestContext,BiFunction<ProfileRequestContext,Map<String,Object>,Map<String,Object>>> strategy)	Set the lookup function to supply strategy bi-function for manipulating token claims set.
void	setXmlSafeIdentifier(boolean flag)	Set the xmlSafe-flag passed to the identifier generator

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

getMetadataContext, getOidcResponseContext

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

getAuthorizationRequest

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.

issuerLookupStrategy

@Nonnull
private Function<ProfileRequestContext,String> issuerLookupStrategy

Strategy used to obtain the response issuer value.

dataSealer

@NonnullAfterInit
private DataSealer dataSealer

Data sealer for handling authorization code.

idGenerator

@Nullable
private IdentifierGenerationStrategy idGenerator

The generator to use.

idGeneratorLookupStrategy

@Nonnull
private Function<ProfileRequestContext,IdentifierGenerationStrategy> idGeneratorLookupStrategy

Strategy used to locate the IdentifierGenerationStrategy to use.

authzCodeLifetimeLookupStrategy

@Nonnull
private Function<ProfileRequestContext,Duration> authzCodeLifetimeLookupStrategy

Strategy used to obtain the authz code lifetime.

tokenClaimsContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,OIDCAuthenticationResponseTokenClaimsContext> tokenClaimsContextLookupStrategy

Strategy used to locate the OIDCAuthenticationResponseTokenClaimsContext.

consentContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,OIDCAuthenticationResponseConsentContext> consentContextLookupStrategy

Strategy used to locate the OIDCAuthenticationResponseConsentContext.

consentEnabledPredicate

@Nonnull
private Predicate<ProfileRequestContext> consentEnabledPredicate

Predicate used to check if consent is enabled with a given ProfileRequestContext.

codeChallengeLookupStrategy

@NonnullAfterInit
private Function<ProfileRequestContext,String> codeChallengeLookupStrategy

Strategy used to locate the code challenge.

codeChallengeMethodLookupStrategy

@NonnullAfterInit
private Function<ProfileRequestContext,String> codeChallengeMethodLookupStrategy

Strategy used to locate the code challenge method.

tokenClaimsSetManipulationStrategyLookupStrategy

@Nonnull
private Function<ProfileRequestContext,BiFunction<ProfileRequestContext,Map<String,Object>,Map<String,Object>>> tokenClaimsSetManipulationStrategyLookupStrategy

Lookup function to supply strategy bi-function for manipulating token claims set.

requestNonceLookupStrategy

@NonnullAfterInit
private Function<ProfileRequestContext,Nonce> requestNonceLookupStrategy

Strategy used to obtain the request nonce.

manipulationStrategy

@Nullable
private BiFunction<ProfileRequestContext,Map<String,Object>,Map<String,Object>> manipulationStrategy

The strategy used for manipulating the token claims set.

subjectCtx

@Nullable
private SubjectContext subjectCtx

Subject context.

authzCodeLifetime

@Nullable
private Duration authzCodeLifetime

Authorization code lifetime.

codeChallenge

@Nullable
private String codeChallenge

Code challenge and the code challenge method stored to authz code.

xmlSafeIdentifier

private boolean xmlSafeIdentifier

The xmlSafe-flag passed to the identifier generator.

Constructor Details

SetAuthorizationCodeToResponseContext

public SetAuthorizationCodeToResponseContext()

Constructor.

Method Details

setDataSealer

public void setDataSealer(@Nonnull
 DataSealer sealer)

Set the data sealer instance to use.

Parameters:

sealer - data sealer to use

setCodeChallengeLookupStrategy

public void setCodeChallengeLookupStrategy(@Nonnull
 Function<ProfileRequestContext,String> strategy)

Set the strategy used to locate the Code Challenge of the request.

Parameters:

strategy - lookup strategy

setCodeChallengeMethodLookupStrategy

public void setCodeChallengeMethodLookupStrategy(@Nonnull
 Function<ProfileRequestContext,String> strategy)

Set the strategy used to locate the Code Challenge Method of the request.

Parameters:

strategy - lookup strategy

setOIDCAuthenticationResponseTokenClaimsContextLookupStrategy

public void setOIDCAuthenticationResponseTokenClaimsContextLookupStrategy(@Nonnull
 Function<ProfileRequestContext,OIDCAuthenticationResponseTokenClaimsContext> strategy)

Set the strategy used to locate the OIDCAuthenticationResponseTokenClaimsContext associated with a given ProfileRequestContext.

Parameters:

strategy - lookup strategy

setOIDCAuthenticationResponseConsentContextLookupStrategy

public void setOIDCAuthenticationResponseConsentContextLookupStrategy(@Nonnull
 Function<ProfileRequestContext,OIDCAuthenticationResponseConsentContext> strategy)

Set the strategy used to locate the OIDCAuthenticationResponseTokenClaimsContext associated with a given ProfileRequestContext.

Parameters:

strategy - lookup strategy

setAuthzCodeLifetimeLookupStrategy

public void setAuthzCodeLifetimeLookupStrategy(@Nonnull
 Function<ProfileRequestContext,Duration> strategy)

Set the strategy used to obtain the authz code lifetime.

Parameters:

strategy - lookup strategy

setIdentifierGeneratorLookupStrategy

public void setIdentifierGeneratorLookupStrategy(@Nonnull
 Function<ProfileRequestContext,IdentifierGenerationStrategy> strategy)

Set the strategy used to locate the IdentifierGenerationStrategy to use.

Parameters:

strategy - lookup strategy

setIssuerLookupStrategy

public void setIssuerLookupStrategy(@Nonnull
 Function<ProfileRequestContext,String> strategy)

Set the strategy used to locate the issuer value to use.

Parameters:

strategy - lookup strategy

setConsentEnabledPredicate

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

Set the predicate used to check if consent is enabled with a given ProfileRequestContext.

Parameters:

predicate - predicate used to check if consent is enabled with a given ProfileRequestContext.

setTokenClaimsSetManipulationStrategyLookupStrategy

public void setTokenClaimsSetManipulationStrategyLookupStrategy(@Nonnull
 Function<ProfileRequestContext,BiFunction<ProfileRequestContext,Map<String,Object>,Map<String,Object>>> strategy)

Set the lookup function to supply strategy bi-function for manipulating token claims set.

Parameters:

strategy - What to set

setXmlSafeIdentifier

public void setXmlSafeIdentifier(boolean flag)

Set the xmlSafe-flag passed to the identifier generator

Parameters:

flag - xmlSafe-flag

setRequestNonceLookupStrategy

public void setRequestNonceLookupStrategy(@Nonnull
 Function<ProfileRequestContext,Nonce> strategy)

Set the strategy used to locate the nonce of authentication request.

Parameters:

strategy - lookup strategy

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

doPreExecute

protected boolean doPreExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractOAuthAuthorizationResponseAction

doExecute

protected void doExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction