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

Class ExtractTOTPFromHeader

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

All Implemented Interfaces:

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

public class ExtractTOTPFromHeader
extends AbstractTOTPExtractionAction

An action that derives the TOTP code from an HTTP header.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_HEADER_NAME	Default token code header.
private String	headerName	Name of header.

Constructor Summary

Constructors

Constructor	Description
ExtractTOTPFromHeader()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected String	extractCode(HttpServletRequest httpRequest)	Gets the token code from the HTTP request.
void	setHeaderName(String header)	Set the name of the header 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_HEADER_NAME

@Nonnull
@NotEmpty
public static final String DEFAULT_HEADER_NAME

Default token code header.

See Also:

• Constant Field Values

headerName

@NonnullAfterInit
@NotEmpty
private String headerName

Name of header.

Constructor Details

ExtractTOTPFromHeader

public ExtractTOTPFromHeader()

Constructor.

Method Details

setHeaderName

public void setHeaderName(@Nonnull @NotEmpty
 String header)

Set the name of the header to examine.

Parameters:

header - header 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