Package org.keycloak.authentication.requiredactions

Class WebAuthnRegister

java.lang.Object

org.keycloak.authentication.requiredactions.WebAuthnRegister

All Implemented Interfaces:

CredentialAction, CredentialRegistrator, RequiredActionProvider, Provider

Direct Known Subclasses:

WebAuthnPasswordlessRegister

public class WebAuthnRegister
extends Object
implements RequiredActionProvider, CredentialRegistrator

Required action for register WebAuthn 2-factor credential for the user

Constructor Summary

Constructors

Constructor	Description
WebAuthnRegister(KeycloakSession session, com.webauthn4j.validator.attestation.trustworthiness.certpath.CertPathTrustworthinessValidator certPathtrustValidator)

Method Summary

Modifier and Type	Method	Description
void	close()
protected com.webauthn4j.WebAuthnRegistrationManager	createWebAuthnRegistrationManager()	Create WebAuthnRegistrationManager instance Can be overridden in subclasses to customize the used attestation validators
void	evaluateTriggers(RequiredActionContext context)
protected String	getCredentialProviderId()
protected String	getCredentialType()
String	getCredentialType(KeycloakSession session, AuthenticationSessionModel authenticationSession)
protected EventType	getOriginalEventTypeForBackwardsCompatibility(RequiredActionContext context)	Deprecated. For compatibility sake as long as we use @link EventType.UPDATE_PASSWORD , EventType.UPDATE_TOTP a.s.o.
protected WebAuthnPolicy	getWebAuthnPolicy(RequiredActionContext context)
InitiatedActionSupport	initiatedActionSupport()
void	processAction(RequiredActionContext context)
void	requiredActionChallenge(RequiredActionContext context)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.keycloak.authentication.RequiredActionProvider

getMaxAuthAge, initiatedActionCanceled

Constructor Details

WebAuthnRegister

public WebAuthnRegister(KeycloakSession session,
 com.webauthn4j.validator.attestation.trustworthiness.certpath.CertPathTrustworthinessValidator certPathtrustValidator)

Method Details

initiatedActionSupport

public InitiatedActionSupport initiatedActionSupport()

Specified by:

initiatedActionSupport in interface RequiredActionProvider

requiredActionChallenge

public void requiredActionChallenge(RequiredActionContext context)

Specified by:

requiredActionChallenge in interface RequiredActionProvider

getWebAuthnPolicy

protected WebAuthnPolicy getWebAuthnPolicy(RequiredActionContext context)

getCredentialType

public String getCredentialType(KeycloakSession session,
 AuthenticationSessionModel authenticationSession)

Specified by:

getCredentialType in interface CredentialAction

getCredentialType

protected String getCredentialType()

getCredentialProviderId

protected String getCredentialProviderId()

getOriginalEventTypeForBackwardsCompatibility

@Deprecated
protected EventType getOriginalEventTypeForBackwardsCompatibility(RequiredActionContext context)

Deprecated.

For compatibility sake as long as we use @link EventType.UPDATE_PASSWORD , EventType.UPDATE_TOTP a.s.o.

Method to provide removal and deprecation hint

processAction

public void processAction(RequiredActionContext context)

Specified by:

processAction in interface RequiredActionProvider

createWebAuthnRegistrationManager

protected com.webauthn4j.WebAuthnRegistrationManager createWebAuthnRegistrationManager()

Create WebAuthnRegistrationManager instance Can be overridden in subclasses to customize the used attestation validators

Returns:

webauthn4j WebAuthnRegistrationManager instance

close

public void close()

Specified by:

close in interface Provider

evaluateTriggers

public void evaluateTriggers(RequiredActionContext context)

Specified by:

evaluateTriggers in interface RequiredActionProvider