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

Class GenerateClientSecret

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

All Implemented Interfaces:

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

public class GenerateClientSecret
extends AbstractProfileAction

Creates a new client secret with the IdentifierGenerationStrategy attached to this action. The client secret is included to the OIDCClientRegistrationResponseContext together with its validity period, if defined.

Field Summary

Fields

Modifier and Type	Field	Description
private IdentifierGenerationStrategy	idGenerator	The client secret generator to use.
private Function<ProfileRequestContext,IdentifierGenerationStrategy>	idGeneratorLookupStrategy	Strategy used to locate the IdentifierGenerationStrategy to use.
private final org.slf4j.Logger	log	Class logger.
private Function<MessageContext,OIDCClientRegistrationResponseContext>	oidcResponseContextLookupStrategy	Strategy used to locate the OIDCClientRegistrationResponseContext associated with a given MessageContext.
private OIDCClientRegistrationResponseContext	oidcResponseCtx	The OIDCClientRegistrationResponseContext to create the client secret to.
private Function<ProfileRequestContext,Duration>	secretExpirationPeriodStrategy	Strategy to obtain client secret validity period policy.
private boolean	xmlSafeIdentifier	The xmlSafe-flag passed to the identifier generator.

Constructor Summary

Constructors

Constructor	Description
GenerateClientSecret()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
void	setIdentifierGeneratorLookupStrategy(Function<ProfileRequestContext,IdentifierGenerationStrategy> strategy)	Set the strategy used to locate the IdentifierGenerationStrategy to use.
void	setOidcResponseContextLookupStrategy(Function<MessageContext,OIDCClientRegistrationResponseContext> strategy)	Set the strategy used to locate the OIDCClientRegistrationResponseContext associated with a given MessageContext.
void	setSecretExpirationPeriodStrategy(Function<ProfileRequestContext,Duration> strategy)	Set strategy to obtain client secret expiration period policy.
void	setXmlSafeIdentifier(boolean flag)	Set the xmlSafe-flag passed to the identifier generator

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

oidcResponseContextLookupStrategy

@Nonnull
private Function<MessageContext,OIDCClientRegistrationResponseContext> oidcResponseContextLookupStrategy

Strategy used to locate the OIDCClientRegistrationResponseContext associated with a given MessageContext.

idGenerator

@Nullable
private IdentifierGenerationStrategy idGenerator

The client secret generator to use.

idGeneratorLookupStrategy

@Nonnull
private Function<ProfileRequestContext,IdentifierGenerationStrategy> idGeneratorLookupStrategy

Strategy used to locate the IdentifierGenerationStrategy to use.

oidcResponseCtx

@Nullable
private OIDCClientRegistrationResponseContext oidcResponseCtx

The OIDCClientRegistrationResponseContext to create the client secret to.

secretExpirationPeriodStrategy

@Nullable
private Function<ProfileRequestContext,Duration> secretExpirationPeriodStrategy

Strategy to obtain client secret validity period policy.

xmlSafeIdentifier

private boolean xmlSafeIdentifier

The xmlSafe-flag passed to the identifier generator.

Constructor Details

GenerateClientSecret

public GenerateClientSecret()

Constructor.

Method Details

setSecretExpirationPeriodStrategy

public void setSecretExpirationPeriodStrategy(@Nullable
 Function<ProfileRequestContext,Duration> strategy)

Set strategy to obtain client secret expiration period policy.

Parameters:

strategy - What to set.

setOidcResponseContextLookupStrategy

public void setOidcResponseContextLookupStrategy(@Nonnull
 Function<MessageContext,OIDCClientRegistrationResponseContext> strategy)

Set the strategy used to locate the OIDCClientRegistrationResponseContext associated with a given MessageContext.

Parameters:

strategy - What to set.

setIdentifierGeneratorLookupStrategy

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

Set the strategy used to locate the IdentifierGenerationStrategy to use.

Parameters:

strategy - What to set.

setXmlSafeIdentifier

public void setXmlSafeIdentifier(boolean flag)

Set the xmlSafe-flag passed to the identifier generator

Parameters:

flag - xmlSafe-flag

doPreExecute

protected boolean doPreExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractConditionalProfileAction

doExecute

protected void doExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction