Package org.keycloak.authentication.authenticators.browser

Class OTPFormAuthenticator

java.lang.Object

org.keycloak.authentication.AbstractFormAuthenticator

org.keycloak.authentication.authenticators.browser.AbstractUsernameFormAuthenticator

org.keycloak.authentication.authenticators.browser.OTPFormAuthenticator

All Implemented Interfaces:

org.keycloak.authentication.Authenticator, org.keycloak.authentication.CredentialValidator<OTPCredentialProvider>, org.keycloak.provider.Provider

Direct Known Subclasses:

ConditionalOtpFormAuthenticator

public class OTPFormAuthenticator
extends AbstractUsernameFormAuthenticator
implements org.keycloak.authentication.Authenticator, org.keycloak.authentication.CredentialValidator<OTPCredentialProvider>

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SELECTED_OTP_CREDENTIAL_ID
static final String	UNNAMED

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

ATTEMPTED_USERNAME, SESSION_INVALID, USER_SET_BEFORE_USERNAME_PASSWORD_AUTH, USERNAME_HIDDEN

Constructor Summary

Constructors

Constructor	Description
OTPFormAuthenticator()

Method Summary

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)
protected jakarta.ws.rs.core.Response	createLoginForm(org.keycloak.forms.login.LoginFormsProvider form)
protected String	disabledByBruteForceError(String error)
protected String	disabledByBruteForceFieldError()
OTPCredentialProvider	getCredentialProvider(org.keycloak.models.KeycloakSession session)
List<org.keycloak.authentication.RequiredActionFactory>	getRequiredActions(org.keycloak.models.KeycloakSession session)
boolean	requiresUser()
void	setRequiredActions(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user)
void	validateOTP(org.keycloak.authentication.AuthenticationFlowContext context)

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

challenge, challenge, enabledUser, getDefaultChallengeMessage, isDisabledByBruteForce, isUserAlreadySetBeforeUsernamePasswordAuth, setDuplicateUserChallenge, testInvalidUser, validatePassword, validateUser, validateUserAndPassword

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

SELECTED_OTP_CREDENTIAL_ID

public static final String SELECTED_OTP_CREDENTIAL_ID

See Also:

• Constant Field Values

UNNAMED

public static final String UNNAMED

See Also:

• Constant Field Values

Constructor Details

OTPFormAuthenticator

public OTPFormAuthenticator()

Method Details

action

public void action(org.keycloak.authentication.AuthenticationFlowContext context)

Specified by:

action in interface org.keycloak.authentication.Authenticator

Overrides:

action in class AbstractUsernameFormAuthenticator

authenticate

public void authenticate(org.keycloak.authentication.AuthenticationFlowContext context)

Specified by:

authenticate in interface org.keycloak.authentication.Authenticator

validateOTP

public void validateOTP(org.keycloak.authentication.AuthenticationFlowContext context)

requiresUser

public boolean requiresUser()

Specified by:

requiresUser in interface org.keycloak.authentication.Authenticator

disabledByBruteForceError

protected String disabledByBruteForceError(String error)

Overrides:

disabledByBruteForceError in class AbstractUsernameFormAuthenticator

disabledByBruteForceFieldError

protected String disabledByBruteForceFieldError()

Overrides:

disabledByBruteForceFieldError in class AbstractUsernameFormAuthenticator

createLoginForm

protected jakarta.ws.rs.core.Response createLoginForm(org.keycloak.forms.login.LoginFormsProvider form)

Overrides:

createLoginForm in class AbstractUsernameFormAuthenticator

configuredFor

public boolean configuredFor(org.keycloak.models.KeycloakSession session,
 org.keycloak.models.RealmModel realm,
 org.keycloak.models.UserModel user)

Specified by:

configuredFor in interface org.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 interface org.keycloak.authentication.Authenticator

getRequiredActions

public List<org.keycloak.authentication.RequiredActionFactory> getRequiredActions(org.keycloak.models.KeycloakSession session)

Specified by:

getRequiredActions in interface org.keycloak.authentication.Authenticator

close

public void close()

Specified by:

close in interface org.keycloak.provider.Provider

Overrides:

close in class AbstractFormAuthenticator

getCredentialProvider

public OTPCredentialProvider getCredentialProvider(org.keycloak.models.KeycloakSession session)

Specified by:

getCredentialProvider in interface org.keycloak.authentication.CredentialValidator<OTPCredentialProvider>