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

Class ExactMatchClaimsValidator

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

net.shibboleth.oidc.jwt.claims.AbstractClaimsValidator

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

All Implemented Interfaces:

ClaimsValidator, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent

@ThreadSafeAfterInit
public class ExactMatchClaimsValidator
extends AbstractClaimsValidator

Validator that checks a JWT claim exactly matches (by Object equality) a value returned by a lookup strategy.

Field Summary

Fields

Modifier and Type	Field	Description
private String	claimName	The name of the claim to match from the ID token.
private final org.slf4j.Logger	log	Class logger.
private BiFunction<ProfileRequestContext,com.nimbusds.jwt.JWTClaimsSet,String>	valueToMatchLookupStrategy	Strategy to retrieve the value to match to an ID Token claim.

Constructor Summary

Constructors

Constructor	Description
ExactMatchClaimsValidator()

Method Summary

Modifier and Type	Method	Description
protected void	doInitialize()
protected void	doValidate(com.nimbusds.jwt.JWTClaimsSet claims, ProfileRequestContext context)	Perform validation of the given claims supported by the supplied context.
void	setClaimName(String name)	Set the name of the claim to match.
void	setValueToMatchLookupStrategy(BiFunction<ProfileRequestContext,com.nimbusds.jwt.JWTClaimsSet,String> strategy)	Set the value to match lookup strategy.

Methods inherited from class net.shibboleth.oidc.jwt.claims.AbstractClaimsValidator

setActivationCondition, validate

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.

valueToMatchLookupStrategy

@NonnullAfterInit
private BiFunction<ProfileRequestContext,com.nimbusds.jwt.JWTClaimsSet,String> valueToMatchLookupStrategy

Strategy to retrieve the value to match to an ID Token claim. Should return null if there is a failure to lookup the value.

claimName

@NonnullAfterInit
@NotEmpty
private String claimName

The name of the claim to match from the ID token.

Constructor Details

ExactMatchClaimsValidator

public ExactMatchClaimsValidator()

Method Details

setClaimName

public void setClaimName(@Nonnull @NotEmpty
 String name)

Set the name of the claim to match.

Parameters:

name - the claim name.

setValueToMatchLookupStrategy

public void setValueToMatchLookupStrategy(@Nonnull
 BiFunction<ProfileRequestContext,com.nimbusds.jwt.JWTClaimsSet,String> strategy)

Set the value to match lookup strategy.

Parameters:

strategy - the strategy to use.

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractIdentifiedInitializableComponent

Throws:

ComponentInitializationException

doValidate

protected void doValidate(@Nonnull
 com.nimbusds.jwt.JWTClaimsSet claims,
 @Nonnull
 ProfileRequestContext context)
                   throws JWTValidationException

Perform validation of the given claims supported by the supplied context.

Specified by:

doValidate in class AbstractClaimsValidator

Parameters:

claims - the claims to validate.

context - the profile request context.

Throws:

JWTValidationException - when validation is unsuccessful due to a failed attempt