Package net.shibboleth.idp.plugin.authn.webauthn.admin.impl

Class ExtractUsernameSearchFromFormRequest

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.plugin.authn.webauthn.impl.AbstractWebAuthnAction<WebAuthnManagementContext>

net.shibboleth.idp.plugin.authn.webauthn.admin.impl.ExtractUsernameSearchFromFormRequest

All Implemented Interfaces:

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

public class ExtractUsernameSearchFromFormRequest
extends AbstractWebAuthnAction<WebAuthnManagementContext>

An action that extracts the username search value from the incoming HTTP request.

Event:

{AuthnEventIds#NO_CREDENTIALS}, {EventIds#IO_ERROR}

Precondition:

ProfileRequestContext.getSubcontext(WebAuthnRegistrationContext.class) != null

Postcondition:

add the search parameter value to the context

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_PARAMETER_NAME	Default credential Id parameter name.
private final org.slf4j.Logger	log	Class logger.
private String	requestParameterToExtract	Name of the request parameter to extract.

Constructor Summary

Constructors

Constructor	Description
ExtractUsernameSearchFromFormRequest()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(ProfileRequestContext profileRequestContext, WebAuthnManagementContext context)	Performs this WebAuthn authentication action using the supplied WebAuthn context.
void	setRequestParameterName(String parameter)	Set the name of the request parameter to extract the value from.

Methods inherited from class net.shibboleth.idp.plugin.authn.webauthn.impl.AbstractWebAuthnAction

doExecute, doInitialize, doPreExecute, doPreExecute, enhancedCredentialRecord, getAaguidMetadata, getAaguidService, getAuthenticatorMetadata, getCredentialRepository, getFidoMetadataService, getWebAuthnClient, setAaguidService, setCredentialRepository, setFidoMetadataService, setWebAuthnClient, setWebAuthnContextLookupStrategy

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, 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_PARAMETER_NAME

@Nonnull
@NotEmpty
public static final String DEFAULT_PARAMETER_NAME

Default credential Id parameter name.

See Also:

• Constant Field Values

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

requestParameterToExtract

@NonnullAfterInit
@NotEmpty
private String requestParameterToExtract

Name of the request parameter to extract.

Constructor Details

ExtractUsernameSearchFromFormRequest

public ExtractUsernameSearchFromFormRequest()

Constructor.

Method Details

setRequestParameterName

public void setRequestParameterName(@Nonnull @NotEmpty
 String parameter)

Set the name of the request parameter to extract the value from.

Parameters:

parameter - field name

doExecute

protected void doExecute(@Nonnull
 ProfileRequestContext profileRequestContext,
 @Nonnull
 WebAuthnManagementContext context)

Description copied from class: AbstractWebAuthnAction

Performs this WebAuthn authentication action using the supplied WebAuthn context. Implementations should override this method.

Overrides:

doExecute in class AbstractWebAuthnAction<WebAuthnManagementContext>

Parameters:

profileRequestContext - the current IdP profile request context

context - the WebAuthn context