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

Class ExtractPublicKeyCredentialAttestationFromFormRequest

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

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

All Implemented Interfaces:

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

public class ExtractPublicKeyCredentialAttestationFromFormRequest
extends AbstractWebAuthnAction<WebAuthnRegistrationContext>

An action that extracts the PublicKeyCredential containing the authenticator attestation response from the incoming HTTP request. Failure to find the attestation results in an a non-proceed event.

Event:

{WebAuthnRegistrationEventIds#INVALID_REGISTRATION}, {AuthnEventIds#NO_CREDENTIALS}

Precondition:

ProfileRequestContext.getSubcontext(WebAuthnRegistrationContext.class) != null

Postcondition:

add an AuthenticatorAttestationResponse to the registration context

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_PARAMETER_NAME	Default public key credential attestation parameter name.
private final org.slf4j.Logger	log	Class logger.
private String	publicKeyCredentialAttestationParameterName	Name of the public key credential attestation parameter.

Constructor Summary

Constructors

Constructor	Description
ExtractPublicKeyCredentialAttestationFromFormRequest()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(ProfileRequestContext profileRequestContext, WebAuthnRegistrationContext context)	Performs this WebAuthn authentication action using the supplied WebAuthn context.
void	setPublickKeyCredentialAttestationParameterName(String field)	Set the name of the parameter to extract the public key credential attestation response 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 public key credential attestation parameter name.

See Also:

• Constant Field Values

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

publicKeyCredentialAttestationParameterName

@Nonnull
@NotEmpty
private String publicKeyCredentialAttestationParameterName

Name of the public key credential attestation parameter.

Constructor Details

ExtractPublicKeyCredentialAttestationFromFormRequest

public ExtractPublicKeyCredentialAttestationFromFormRequest()

Constructor.

Method Details

setPublickKeyCredentialAttestationParameterName

public void setPublickKeyCredentialAttestationParameterName(@Nonnull @NotEmpty
 String field)

Set the name of the parameter to extract the public key credential attestation response from.

Parameters:

field - the field name

doExecute

protected void doExecute(@Nonnull
 ProfileRequestContext profileRequestContext,
 @Nonnull
 WebAuthnRegistrationContext 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<WebAuthnRegistrationContext>

Parameters:

profileRequestContext - the current IdP profile request context

context - the WebAuthn context