Class WebAuthnAuthenticator
- java.lang.Object
-
- org.keycloak.authentication.authenticators.browser.WebAuthnAuthenticator
-
- All Implemented Interfaces:
org.keycloak.authentication.Authenticator
,org.keycloak.authentication.CredentialValidator<WebAuthnCredentialProvider>
,org.keycloak.provider.Provider
- Direct Known Subclasses:
WebAuthnPasswordlessAuthenticator
public class WebAuthnAuthenticator extends Object implements org.keycloak.authentication.Authenticator, org.keycloak.authentication.CredentialValidator<WebAuthnCredentialProvider>
Authenticator for WebAuthn authentication, which will be typically used when WebAuthn is used as second factor.
-
-
Constructor Summary
Constructors Constructor Description WebAuthnAuthenticator(org.keycloak.models.KeycloakSession session)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
action(org.keycloak.authentication.AuthenticationFlowContext context)
void
authenticate(org.keycloak.authentication.AuthenticationFlowContext context)
void
close()
boolean
configuredFor(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user)
WebAuthnCredentialProvider
getCredentialProvider(org.keycloak.models.KeycloakSession session)
protected String
getCredentialType()
List<org.keycloak.authentication.RequiredActionFactory>
getRequiredActions(org.keycloak.models.KeycloakSession session)
protected String
getRpID(org.keycloak.authentication.AuthenticationFlowContext context)
protected org.keycloak.models.WebAuthnPolicy
getWebAuthnPolicy(org.keycloak.authentication.AuthenticationFlowContext context)
boolean
requiresUser()
void
setRequiredActions(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user)
protected boolean
shouldDisplayAuthenticators(org.keycloak.authentication.AuthenticationFlowContext context)
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
Method Detail
-
authenticate
public void authenticate(org.keycloak.authentication.AuthenticationFlowContext context)
- Specified by:
authenticate
in interfaceorg.keycloak.authentication.Authenticator
-
getWebAuthnPolicy
protected org.keycloak.models.WebAuthnPolicy getWebAuthnPolicy(org.keycloak.authentication.AuthenticationFlowContext context)
-
getRpID
protected String getRpID(org.keycloak.authentication.AuthenticationFlowContext context)
-
getCredentialType
protected String getCredentialType()
-
shouldDisplayAuthenticators
protected boolean shouldDisplayAuthenticators(org.keycloak.authentication.AuthenticationFlowContext context)
-
action
public void action(org.keycloak.authentication.AuthenticationFlowContext context)
- Specified by:
action
in interfaceorg.keycloak.authentication.Authenticator
-
requiresUser
public boolean requiresUser()
- Specified by:
requiresUser
in interfaceorg.keycloak.authentication.Authenticator
-
configuredFor
public boolean configuredFor(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user)
- Specified by:
configuredFor
in interfaceorg.keycloak.authentication.Authenticator
-
setRequiredActions
public void setRequiredActions(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user)
- Specified by:
setRequiredActions
in interfaceorg.keycloak.authentication.Authenticator
-
getRequiredActions
public List<org.keycloak.authentication.RequiredActionFactory> getRequiredActions(org.keycloak.models.KeycloakSession session)
- Specified by:
getRequiredActions
in interfaceorg.keycloak.authentication.Authenticator
-
close
public void close()
- Specified by:
close
in interfaceorg.keycloak.provider.Provider
-
getCredentialProvider
public WebAuthnCredentialProvider getCredentialProvider(org.keycloak.models.KeycloakSession session)
- Specified by:
getCredentialProvider
in interfaceorg.keycloak.authentication.CredentialValidator<WebAuthnCredentialProvider>
-
-