Package org.keycloak.authentication.authenticators.browser

Class WebAuthnPasswordlessAuthenticator

java.lang.Object

org.keycloak.authentication.authenticators.browser.WebAuthnAuthenticator

org.keycloak.authentication.authenticators.browser.WebAuthnPasswordlessAuthenticator

All Implemented Interfaces:

Authenticator, CredentialValidator<WebAuthnCredentialProvider>, Provider

Direct Known Subclasses:

PasskeysConditionalUIAuthenticator, WebAuthnConditionalUIAuthenticator

public class WebAuthnPasswordlessAuthenticator
extends WebAuthnAuthenticator

Authenticator for WebAuthn authentication with passwordless credential. This class is temporary and will be likely removed in the future during future improvements in authentication SPI

Field Summary

Fields inherited from class org.keycloak.authentication.authenticators.browser.WebAuthnAuthenticator

session

Constructor Summary

Constructors

Constructor	Description
WebAuthnPasswordlessAuthenticator(KeycloakSession session)

Method Summary

Modifier and Type	Method	Description
void	action(AuthenticationFlowContext context)	Called from a form action invocation.
WebAuthnPasswordlessCredentialProvider	getCredentialProvider(KeycloakSession session)
protected String	getCredentialType()
List<RequiredActionFactory>	getRequiredActions(KeycloakSession session)	Overwrite this if the authenticator is associated with
protected WebAuthnPolicy	getWebAuthnPolicy(AuthenticationFlowContext context)
boolean	requiresUser()	Does this authenticator require that the user has already been identified? That AuthenticatorContext.getUser() is not null?
void	setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)	Set actions to configure authenticator
protected boolean	shouldDisplayAuthenticators(AuthenticationFlowContext context)
protected boolean	validateUsername(AuthenticationFlowContext context, jakarta.ws.rs.core.MultivaluedMap<String,String> formData, String username)

Methods inherited from class org.keycloak.authentication.authenticators.browser.WebAuthnAuthenticator

authenticate, close, configuredFor, createErrorResponse, fillContextForm, getRpID, setErrorResponse

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

areRequiredActionsEnabled

Methods inherited from interface org.keycloak.authentication.CredentialValidator

getCredentials, getType

Constructor Details

WebAuthnPasswordlessAuthenticator

public WebAuthnPasswordlessAuthenticator(KeycloakSession session)

Method Details

getWebAuthnPolicy

protected WebAuthnPolicy getWebAuthnPolicy(AuthenticationFlowContext context)

Overrides:

getWebAuthnPolicy in class WebAuthnAuthenticator

getCredentialType

protected String getCredentialType()

Overrides:

getCredentialType in class WebAuthnAuthenticator

shouldDisplayAuthenticators

protected boolean shouldDisplayAuthenticators(AuthenticationFlowContext context)

Overrides:

shouldDisplayAuthenticators in class WebAuthnAuthenticator

setRequiredActions

public void setRequiredActions(KeycloakSession session,
 RealmModel realm,
 UserModel user)

Description copied from interface: Authenticator

Set actions to configure authenticator

Specified by:

setRequiredActions in interface Authenticator

Overrides:

setRequiredActions in class WebAuthnAuthenticator

getRequiredActions

public List<RequiredActionFactory> getRequiredActions(KeycloakSession session)

Description copied from interface: Authenticator

Overwrite this if the authenticator is associated with

Specified by:

getRequiredActions in interface Authenticator

Overrides:

getRequiredActions in class WebAuthnAuthenticator

Returns:

getCredentialProvider

public WebAuthnPasswordlessCredentialProvider getCredentialProvider(KeycloakSession session)

Specified by:

getCredentialProvider in interface CredentialValidator<WebAuthnCredentialProvider>

Overrides:

getCredentialProvider in class WebAuthnAuthenticator

requiresUser

public boolean requiresUser()

Description copied from interface: Authenticator

Does this authenticator require that the user has already been identified? That AuthenticatorContext.getUser() is not null?

Specified by:

requiresUser in interface Authenticator

Overrides:

requiresUser in class WebAuthnAuthenticator

Returns:

action

public void action(AuthenticationFlowContext context)

Description copied from interface: Authenticator

Called from a form action invocation.

Specified by:

action in interface Authenticator

Overrides:

action in class WebAuthnAuthenticator

validateUsername

protected boolean validateUsername(AuthenticationFlowContext context,
 jakarta.ws.rs.core.MultivaluedMap<String,String> formData,
 String username)