Package net.shibboleth.oidc.profile.oauth2.config.impl

Class DefaultOAuth2TokenRevocationConfiguration

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

net.shibboleth.profile.config.AbstractProfileConfiguration

net.shibboleth.profile.config.AbstractConditionalProfileConfiguration

net.shibboleth.idp.profile.config.AbstractInterceptorAwareProfileConfiguration

net.shibboleth.oidc.profile.oauth2.config.impl.AbstractOAuth2InterceptorAwareProfileConfiguration

net.shibboleth.oidc.profile.oauth2.config.impl.AbstractOAuth2ClientAuthenticableProfileConfiguration

net.shibboleth.oidc.profile.oauth2.config.impl.AbstractOAuth2TokenValidatingConfiguration

net.shibboleth.oidc.profile.oauth2.config.impl.DefaultOAuth2TokenRevocationConfiguration

All Implemented Interfaces:

AuthenticationProfileConfiguration, InterceptorAwareProfileConfiguration, OAuth2ClientAuthenticableClientProfileConfiguration, OAuth2ClientAuthenticableProfileConfiguration, OAuth2DPoPProofValidatingProfileConfiguration, OAuth2InterceptorAwareProfileConfiguration, OAuth2ProfileConfiguration, OAuth2TokenRevocationConfiguration, OAuth2TokenValidatingProfileConfiguration, ConditionalProfileConfiguration, OverriddenIssuerProfileConfiguration, ProfileConfiguration, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent

public class DefaultOAuth2TokenRevocationConfiguration
extends AbstractOAuth2TokenValidatingConfiguration
implements OAuth2TokenRevocationConfiguration

Implementation of a profile configuration for OAuth2 Token Revocation.

Nested Class Summary

Nested classes/interfaces inherited from interface net.shibboleth.oidc.profile.oauth2.config.OAuth2TokenRevocationConfiguration

OAuth2TokenRevocationConfiguration.OAuth2TokenRevocationMethod

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROFILE_COUNTER	OAuth2 token revocation profile counter name.
private Function<ProfileRequestContext,Duration>	revocationLifetimeLookupStrategy	Lookup function to supply revocation lifetime.
private Function<ProfileRequestContext,String>	revocationMethodLookupStrategy	Which revocation method should be used when revoking a token.

Fields inherited from interface net.shibboleth.oidc.profile.oauth2.config.OAuth2TokenRevocationConfiguration

PROFILE_ID, PROTOCOL_URI

Fields inherited from interface net.shibboleth.profile.config.ProfileConfiguration

DEFAULT_DISALLOWED_FEATURES

Constructor Summary

Constructors

Constructor	Description
DefaultOAuth2TokenRevocationConfiguration()	Constructor.
DefaultOAuth2TokenRevocationConfiguration(String profileId)	Creates a new configuration instance.

Method Summary

Modifier and Type	Method	Description
Duration	getRevocationLifetime(ProfileRequestContext profileRequestContext)	Get revocation lifetime.
OAuth2TokenRevocationConfiguration.OAuth2TokenRevocationMethod	getRevocationMethod(ProfileRequestContext profileRequestContext)	Get the revocation method used when revoking a token.
void	setRevocationLifetime(Duration lifetime)	Set the lifetime of revocation.
void	setRevocationLifetimeLookupStrategy(Function<ProfileRequestContext,Duration> strategy)	Set a lookup strategy for the revocation lifetime.
void	setRevocationMethod(OAuth2TokenRevocationConfiguration.OAuth2TokenRevocationMethod method)	Set which revocation method should be used when revoking a token.
void	setRevocationMethodLookupStrategy(Function<ProfileRequestContext,String> strategy)	Set strategy for looking up which revocation method should be used when revoking a token.

Methods inherited from class net.shibboleth.oidc.profile.oauth2.config.impl.AbstractOAuth2TokenValidatingConfiguration

getIssuedClaimsValidator, getIssuer, setIssuedClaimsValidator, setIssuedClaimsValidatorLookupStrategy, setIssuer, setIssuerLookupStrategy

Methods inherited from class net.shibboleth.oidc.profile.oauth2.config.impl.AbstractOAuth2ClientAuthenticableProfileConfiguration

getAuthenticationFlows, getClaimsValidator, getClientCredential, getClientId, getDefaultAuthenticationMethods, getDpopProofClaimsValidator, getDpopProofNonceGenerator, getDpopProofSignatureValidationConfiguration, getPostAuthenticationFlows, getProxyCount, getTokenEndpointAuthMethod, getTokenEndpointAuthMethods, getUnregisteredClientPolicy, isForceAuthn, isRequireDpopProof, setAuthenticationFlows, setAuthenticationFlowsLookupStrategy, setClaimsValidator, setClaimsValidatorLookupStrategy, setClientCredential, setClientCredentialLookupStrategy, setClientId, setClientIdLookupStrategy, setDefaultAuthenticationMethods, setDefaultAuthenticationMethodsLookupStrategy, setDpopProofClaimsValidator, setDpopProofClaimsValidatorLookupStrategy, setDpopProofNonceGenerator, setDpopProofNonceGeneratorLookupStrategy, setDpopProofSignatureValidationConfiguration, setDpopProofSignatureValidationConfigurationLookupStrategy, setForceAuthn, setForceAuthnPredicate, setPostAuthenticationFlows, setPostAuthenticationFlowsLookupStrategy, setProxyCount, setProxyCountLookupStrategy, setRequireDpopProof, setRequireDpopProofPredicate, setTokenEndpointAuthMethod, setTokenEndpointAuthMethodLookupStrategy, setTokenEndpointAuthMethods, setTokenEndpointAuthMethodsLookupStrategy, setUnregisteredClientPolicy, setUnregisteredClientPolicyLookupStrategy

Methods inherited from class net.shibboleth.oidc.profile.oauth2.config.impl.AbstractOAuth2InterceptorAwareProfileConfiguration

getMessageHandler, setMessageHandler, setMessageHandlerLookupStrategy

Methods inherited from class net.shibboleth.idp.profile.config.AbstractInterceptorAwareProfileConfiguration

getInboundInterceptorFlows, getOutboundInterceptorFlows, setInboundInterceptorFlows, setInboundInterceptorFlowsLookupStrategy, setOutboundInterceptorFlows, setOutboundInterceptorFlowsLookupStrategy

Methods inherited from class net.shibboleth.profile.config.AbstractConditionalProfileConfiguration

getActivationCondition, setActivationCondition

Methods inherited from class net.shibboleth.profile.config.AbstractProfileConfiguration

equals, getDisallowedFeatures, getSecurityConfiguration, hashCode, isFeatureDisallowed, setDisallowedFeatures, setDisallowedFeaturesLookupStrategy, setSecurityConfiguration, setSecurityConfigurationLookupStrategy

Methods inherited from class net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

setId

Methods inherited from class net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

doInitialize, ensureId, getId, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException

Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

checkComponentActive, checkSetterPreconditions, destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.shibboleth.idp.authn.config.AuthenticationProfileConfiguration

getAuthenticationFlows, getDefaultAuthenticationMethods, getPostAuthenticationFlows, getProxyCount, isForceAuthn, isLocal

Methods inherited from interface net.shibboleth.profile.config.ConditionalProfileConfiguration

getActivationCondition

Methods inherited from interface net.shibboleth.shared.component.IdentifiedComponent

getId

Methods inherited from interface net.shibboleth.idp.profile.config.InterceptorAwareProfileConfiguration

getInboundInterceptorFlows, getOutboundInterceptorFlows

Methods inherited from interface net.shibboleth.oidc.profile.oauth2.config.OAuth2ClientAuthenticableProfileConfiguration

getClaimsValidator, getTokenEndpointAuthMethods, getUnregisteredClientPolicy

Methods inherited from interface net.shibboleth.oidc.profile.oauth2.config.OAuth2DPoPProofValidatingProfileConfiguration

getDpopProofClaimsValidator, getDpopProofNonceGenerator, getDpopProofSignatureValidationConfiguration, isRequireDpopProof

Methods inherited from interface net.shibboleth.oidc.profile.oauth2.config.OAuth2TokenValidatingProfileConfiguration

getIssuedClaimsValidator

Methods inherited from interface net.shibboleth.profile.config.OverriddenIssuerProfileConfiguration

getIssuer

Methods inherited from interface net.shibboleth.profile.config.ProfileConfiguration

getDisallowedFeatures, getSecurityConfiguration, isFeatureDisallowed

Field Details

PROFILE_COUNTER

@Nonnull
@NotEmpty
public static final String PROFILE_COUNTER

OAuth2 token revocation profile counter name.

See Also:

• Constant Field Values

revocationMethodLookupStrategy

@Nonnull
private Function<ProfileRequestContext,String> revocationMethodLookupStrategy

Which revocation method should be used when revoking a token. Supported values are CHAIN and TOKEN. The default is CHAIN.

revocationLifetimeLookupStrategy

@Nonnull
private Function<ProfileRequestContext,Duration> revocationLifetimeLookupStrategy

Lookup function to supply revocation lifetime.

Constructor Details

DefaultOAuth2TokenRevocationConfiguration

public DefaultOAuth2TokenRevocationConfiguration()

Constructor.

DefaultOAuth2TokenRevocationConfiguration

public DefaultOAuth2TokenRevocationConfiguration(@Nonnull @NotEmpty
 String profileId)

Creates a new configuration instance.

Parameters:

profileId - Unique profile identifier.

Method Details

setRevocationMethodLookupStrategy

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

Set strategy for looking up which revocation method should be used when revoking a token.

Parameters:

strategy - What to set.

Since:

2.1.0

setRevocationMethod

public void setRevocationMethod(@Nullable
 OAuth2TokenRevocationConfiguration.OAuth2TokenRevocationMethod method)

Set which revocation method should be used when revoking a token.

Parameters:

method - What to set.

Since:

2.1.0

getRevocationMethod

public OAuth2TokenRevocationConfiguration.OAuth2TokenRevocationMethod getRevocationMethod(@Nullable
 ProfileRequestContext profileRequestContext)

Get the revocation method used when revoking a token.

Specified by:

getRevocationMethod in interface OAuth2TokenRevocationConfiguration

Parameters:

profileRequestContext - profile request context.

Returns:

The revocation method used when revoking a token.

setRevocationLifetimeLookupStrategy

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

Set a lookup strategy for the revocation lifetime.

Parameters:

strategy - What to set.

Since:

2.1.0

getRevocationLifetime

@Positive
@Nonnull
public Duration getRevocationLifetime(@Nullable
 ProfileRequestContext profileRequestContext)

Get revocation lifetime.

Defaults to 6 hours.

Specified by:

getRevocationLifetime in interface OAuth2TokenRevocationConfiguration

Parameters:

profileRequestContext - profile request context

Returns:

revocation lifetime

setRevocationLifetime

public void setRevocationLifetime(@Positive @Nonnull
 Duration lifetime)

Set the lifetime of revocation.

Parameters:

lifetime - What to set.

Since:

2.1.0