Package org.keycloak.authentication.authenticators.browser

Class WebAuthnAuthenticator

java.lang.Object

org.keycloak.authentication.authenticators.browser.WebAuthnAuthenticator

All Implemented Interfaces:

Authenticator, CredentialValidator<WebAuthnCredentialProvider>, Provider

Direct Known Subclasses:

WebAuthnPasswordlessAuthenticator

public class WebAuthnAuthenticator
extends Object
implements Authenticator, CredentialValidator<WebAuthnCredentialProvider>

Authenticator for WebAuthn authentication, which will be typically used when WebAuthn is used as second factor.

Field Summary

Fields

Modifier and Type	Field	Description
protected final KeycloakSession	session

Constructor Summary

Constructors

Constructor	Description
WebAuthnAuthenticator(KeycloakSession session)

Method Summary

Modifier and Type	Method	Description
void	action(AuthenticationFlowContext context)
void	authenticate(AuthenticationFlowContext context)
void	close()
boolean	configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
protected jakarta.ws.rs.core.Response	createErrorResponse(AuthenticationFlowContext context, String errorCase)
LoginFormsProvider	fillContextForm(AuthenticationFlowContext context)
WebAuthnCredentialProvider	getCredentialProvider(KeycloakSession session)
protected String	getCredentialType()
List<RequiredActionFactory>	getRequiredActions(KeycloakSession session)
protected String	getRpID(AuthenticationFlowContext context)
protected WebAuthnPolicy	getWebAuthnPolicy(AuthenticationFlowContext context)
boolean	requiresUser()
protected void	setErrorResponse(AuthenticationFlowContext context, String errorCase, String errorMessage)
void	setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)
protected boolean	shouldDisplayAuthenticators(AuthenticationFlowContext 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.Authenticator

areRequiredActionsEnabled

Methods inherited from interface org.keycloak.authentication.CredentialValidator

getCredentials, getType

Field Details

session

protected final KeycloakSession session

Constructor Details

WebAuthnAuthenticator

public WebAuthnAuthenticator(KeycloakSession session)

Method Details

authenticate

public void authenticate(AuthenticationFlowContext context)

Specified by:

authenticate in interface Authenticator

fillContextForm

public LoginFormsProvider fillContextForm(AuthenticationFlowContext context)

getWebAuthnPolicy

protected WebAuthnPolicy getWebAuthnPolicy(AuthenticationFlowContext context)

getRpID

protected String getRpID(AuthenticationFlowContext context)

getCredentialType

protected String getCredentialType()

shouldDisplayAuthenticators

protected boolean shouldDisplayAuthenticators(AuthenticationFlowContext context)

action

public void action(AuthenticationFlowContext context)

Specified by:

action in interface Authenticator

requiresUser

public boolean requiresUser()

Specified by:

requiresUser in interface Authenticator

configuredFor

public boolean configuredFor(KeycloakSession session,
 RealmModel realm,
 UserModel user)

Specified by:

configuredFor in interface Authenticator

setRequiredActions

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

Specified by:

setRequiredActions in interface Authenticator

getRequiredActions

public List<RequiredActionFactory> getRequiredActions(KeycloakSession session)

Specified by:

getRequiredActions in interface Authenticator

close

public void close()

Specified by:

close in interface Provider

getCredentialProvider

public WebAuthnCredentialProvider getCredentialProvider(KeycloakSession session)

Specified by:

getCredentialProvider in interface CredentialValidator<WebAuthnCredentialProvider>

setErrorResponse

protected void setErrorResponse(AuthenticationFlowContext context,
 String errorCase,
 String errorMessage)

createErrorResponse

protected jakarta.ws.rs.core.Response createErrorResponse(AuthenticationFlowContext context,
 String errorCase)