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

Class ExtractTOTPFromFormRequest

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.authn.AbstractAuthenticationAction

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

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

All Implemented Interfaces:

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

public class ExtractTOTPFromFormRequest
extends AbstractTOTPExtractionAction

An action that derives the TOTP code from a form parameter.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_FIELD_NAME	Default token code field name.
private String	fieldName	Name of header.
private final org.slf4j.Logger	log	Class logger.

Constructor Summary

Constructors

Constructor	Description
ExtractTOTPFromFormRequest()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected String	extractCode(HttpServletRequest httpRequest)	Gets the token code from the HTTP request.
void	setFieldName(String field)	Set the name of the field to examine.

Methods inherited from class net.shibboleth.idp.plugin.authn.totp.impl.AbstractTOTPExtractionAction

doExecute, setTOTPContextCreationStrategy, setUsernameLookupStrategy

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

doExecute, doPreExecute, doPreExecute, setAuthenticationContextLookupStrategy

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

DEFAULT_FIELD_NAME

@Nonnull
@NotEmpty
public static final String DEFAULT_FIELD_NAME

Default token code field name.

See Also:

• Constant Field Values

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

fieldName

@NonnullAfterInit
@NotEmpty
private String fieldName

Name of header.

Constructor Details

ExtractTOTPFromFormRequest

public ExtractTOTPFromFormRequest()

Constructor.

Method Details

setFieldName

public void setFieldName(@Nonnull @NotEmpty
 String field)

Set the name of the field to examine.

Parameters:

field - field name

extractCode

@Nullable
protected String extractCode(@Nonnull
 HttpServletRequest httpRequest)

Gets the token code from the HTTP request.

Specified by:

extractCode in class AbstractTOTPExtractionAction

Parameters:

httpRequest - current HTTP request

Returns:

the token code, or null