Package net.shibboleth.oidc.security.jwt.claims.impl

Class ChainingJWTClaimsValidator

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

net.shibboleth.oidc.security.jwt.claims.impl.ChainingJWTClaimsValidator

All Implemented Interfaces:

ClaimsValidator, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent

@ThreadSafeAfterInit
public class ChainingJWTClaimsValidator
extends AbstractIdentifiableInitializableComponent
implements ClaimsValidator

A ClaimsValidator implementation that validates a JWT claims set from a chain of configured validators.

Normally, validation terminates when one of the validators throws a JWTValidationException. If no JWTValidationException is thrown, the claims set is 'valid'.

Optionally this can be toggled such that any of the validators succeeeding implies overall success.

Note, does not represent a chain of responsibility pattern despite the name.

Field Summary

Fields

Modifier and Type	Field	Description
private List<ClaimsValidator>	claimValidators	List of claim validators.
private final org.slf4j.Logger	log	Class logger.
private boolean	requireAll	Require all of the validators to be successful.

Constructor Summary

Constructors

Constructor	Description
ChainingJWTClaimsValidator()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doInitialize()
void	setClaimValidators(List<ClaimsValidator> validators)	Set the list of validators to use.
void	setRequireAll(boolean flag)	Set whether to require all validators to be successful.
void	validate(JWTClaimsSet claims, ProfileRequestContext context)	Validate all, or part of, the given JWT claims set.

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

setId

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

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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

setId

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

getId

Field Details

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

claimValidators

@NonnullAfterInit
@NonnullElements
private List<ClaimsValidator> claimValidators

List of claim validators. Ordering is not important.

requireAll

private boolean requireAll

Require all of the validators to be successful.

Constructor Details

ChainingJWTClaimsValidator

public ChainingJWTClaimsValidator()

Constructor.

Method Details

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractIdentifiedInitializableComponent

Throws:

ComponentInitializationException

setRequireAll

public void setRequireAll(boolean flag)

Set whether to require all validators to be successful.

Defaults to true.

Parameters:

flag - flag to set

setClaimValidators

public void setClaimValidators(@Nullable @NonnullElements
 List<ClaimsValidator> validators)

Set the list of validators to use.

Parameters:

validators - validators to use

validate

public void validate(@Nullable
 JWTClaimsSet claims,
 @Nonnull
 ProfileRequestContext context)
              throws JWTValidationException

Validate all, or part of, the given JWT claims set. Can take supporting information from the given context tree.

Throws an exception if validation fails.

Specified by:

validate in interface ClaimsValidator

Parameters:

claims - the claims to validate.

context - the profile request context.

Throws:

JWTValidationException - when validation is unsuccessful due to a failed attempt