Package net.shibboleth.idp.plugin.authn.totp.impl

Class TOTPCredentialValidator

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

net.shibboleth.idp.authn.AbstractCredentialValidator

net.shibboleth.idp.plugin.authn.totp.impl.TOTPCredentialValidator

All Implemented Interfaces:

CredentialValidator, PrincipalSupportingComponent, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent

public class TOTPCredentialValidator
extends AbstractCredentialValidator

A CredentialValidator that checks for a TOTPContext.

Nested Class Summary

Nested classes/interfaces inherited from interface net.shibboleth.idp.authn.CredentialValidator

CredentialValidator.ErrorHandler, CredentialValidator.WarningHandler

Field Summary

Fields

Modifier and Type	Field	Description
private TOTPAuthenticator	authenticator	TOTP implementation.
private static final String	DEFAULT_METRIC_NAME	Default prefix for metrics.
private final org.slf4j.Logger	log	Class logger.
private Pattern	matchExpression	A regular expression to apply for acceptance testing.
private Consumer<ProfileRequestContext>	seedSource	Source of token seeds.
private Function<AuthenticationContext,TOTPContext>	totpContextLookupStrategy	Lookup strategy for TOTP context.

Constructor Summary

Constructors

Constructor	Description
TOTPCredentialValidator()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doInitialize()
protected Subject	doValidate(ProfileRequestContext profileRequestContext, AuthenticationContext authenticationContext, CredentialValidator.WarningHandler warningHandler, CredentialValidator.ErrorHandler errorHandler)
protected Subject	populateSubject(Subject subject, ProfileRequestContext profileRequestContext, TOTPContext totpContext)	Decorate the subject with "standard" content from the validation.
void	setAuthenticator(TOTPAuthenticator impl)	Set TOTP implementation to use.
void	setMatchExpression(Pattern expression)	Set a matching expression to apply to the username for acceptance.
void	setSeedSource(Consumer<ProfileRequestContext> source)	Set source of token seeds.
void	setTOTPContextLookupStrategy(Function<AuthenticationContext,TOTPContext> strategy)	Set the lookup strategy to locate the TOTPContext.

Methods inherited from class net.shibboleth.idp.authn.AbstractCredentialValidator

getLogPrefix, getSupportedPrincipals, isAcceptable, populateSubject, setActivationCondition, setId, setSupportedPrincipals, validate

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

getId

Field Details

DEFAULT_METRIC_NAME

@Nonnull
@NotEmpty
private static final String DEFAULT_METRIC_NAME

Default prefix for metrics.

See Also:

• Constant Field Values

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

totpContextLookupStrategy

@Nonnull
private Function<AuthenticationContext,TOTPContext> totpContextLookupStrategy

Lookup strategy for TOTP context.

authenticator

@NonnullAfterInit
private TOTPAuthenticator authenticator

TOTP implementation.

seedSource

@NonnullAfterInit
private Consumer<ProfileRequestContext> seedSource

Source of token seeds.

matchExpression

@Nullable
private Pattern matchExpression

A regular expression to apply for acceptance testing.

Constructor Details

TOTPCredentialValidator

public TOTPCredentialValidator()

Constructor.

Method Details

setTOTPContextLookupStrategy

public void setTOTPContextLookupStrategy(@Nonnull
 Function<AuthenticationContext,TOTPContext> strategy)

Set the lookup strategy to locate the TOTPContext.

Parameters:

strategy - lookup strategy

setAuthenticator

public void setAuthenticator(@Nonnull
 TOTPAuthenticator impl)

Set TOTP implementation to use.

Parameters:

impl - TOTP implementation

setSeedSource

public void setSeedSource(@Nonnull
 Consumer<ProfileRequestContext> source)

Set source of token seeds.

Parameters:

source - seed source

setMatchExpression

public void setMatchExpression(@Nullable
 Pattern expression)

Set a matching expression to apply to the username for acceptance.

Parameters:

expression - a matching expression

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractIdentifiedInitializableComponent

Throws:

ComponentInitializationException

doValidate

protected Subject doValidate(@Nonnull
 ProfileRequestContext profileRequestContext,
 @Nonnull
 AuthenticationContext authenticationContext,
 @Nullable
 CredentialValidator.WarningHandler warningHandler,
 @Nullable
 CredentialValidator.ErrorHandler errorHandler)
                      throws Exception

Specified by:

doValidate in class AbstractCredentialValidator

Throws:

Exception

populateSubject

@Nonnull
protected Subject populateSubject(@Nonnull
 Subject subject,
 @Nonnull
 ProfileRequestContext profileRequestContext,
 @Nonnull
 TOTPContext totpContext)

Decorate the subject with "standard" content from the validation.

Parameters:

subject - the subject being returned

profileRequestContext - current profile request context

totpContext - the TOTP context being validated

Returns:

the decorated subject