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

Class AddResidentKeyRequirement

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

All Implemented Interfaces:

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

public class AddResidentKeyRequirement
extends AbstractWebAuthnAction<WebAuthnRegistrationContext>

Add a ResidentKey requirement to the context. Default is 'preferred'.

Precondition:

ProfileRequestContext.getSubcontext(WebAuthnRegistrationContext.class) != null

Postcondition:

WebAuthnRegistrationContext.getResidentKeyRequirement() != null

Field Summary

Fields

Modifier and Type	Field	Description
private final org.slf4j.Logger	log	Class logger.
private Function<ProfileRequestContext,com.yubico.webauthn.data.ResidentKeyRequirement>	residentKeyRequirementLookupStrategy	A strategy to lookup the ResidentKey requirement.

Constructor Summary

Constructors

Constructor	Description
AddResidentKeyRequirement()	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	setResidentKeyRequirement(String requirement)	Set the ResidentKey requirement.
void	setResidentKeyRequirementLookupStrategy(Function<ProfileRequestContext,com.yubico.webauthn.data.ResidentKeyRequirement> strategy)	Set the lookup strategy to determine the ResidentKey requirement.

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

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

residentKeyRequirementLookupStrategy

@Nonnull
private Function<ProfileRequestContext,com.yubico.webauthn.data.ResidentKeyRequirement> residentKeyRequirementLookupStrategy

A strategy to lookup the ResidentKey requirement. Default is PREFERRED.

Constructor Details

AddResidentKeyRequirement

public AddResidentKeyRequirement()

Constructor.

Method Details

setResidentKeyRequirement

public void setResidentKeyRequirement(@Nullable
 String requirement)

Set the ResidentKey requirement.

Parameters:

requirement - The ResidentKey requirement to set.

setResidentKeyRequirementLookupStrategy

public void setResidentKeyRequirementLookupStrategy(@Nullable
 Function<ProfileRequestContext,com.yubico.webauthn.data.ResidentKeyRequirement> strategy)

Set the lookup strategy to determine the ResidentKey requirement.

Parameters:

strategy - The resident key requirement lookup strategy to set.

doExecute

protected void doExecute(ProfileRequestContext profileRequestContext,
 WebAuthnRegistrationContext context)

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