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:

Authenticator, Provider

Direct Known Subclasses:

ConditionalOtpFormAuthenticator, ConsoleOTPFormAuthenticator

public class OTPFormAuthenticator
extends AbstractUsernameFormAuthenticator
implements Authenticator

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

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

ATTEMPTED_USERNAME, REGISTRATION_FORM_ACTION

Constructor Summary

Constructors

Constructor and Description
OTPFormAuthenticator()

Method Summary

Modifier and Type	Method and Description
void	action(AuthenticationFlowContext context)
void	authenticate(AuthenticationFlowContext context)
void	close()
boolean	configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
protected javax.ws.rs.core.Response	createLoginForm(LoginFormsProvider form)
boolean	requiresUser()
void	setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)
protected String	tempDisabledError()
void	validateOTP(AuthenticationFlowContext context)

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

challenge, dummyHash, enabledUser, invalidUser, isTemporarilyDisabledByBruteForce, runDefaultDummyHash, setDuplicateUserChallenge, validatePassword, validateUserAndPassword

Methods inherited from class java.lang.Object

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

Constructor Detail

OTPFormAuthenticator

public OTPFormAuthenticator()

Method Detail

action

public void action(AuthenticationFlowContext context)

Specified by:

action in interface Authenticator

Overrides:

action in class AbstractUsernameFormAuthenticator

authenticate

public void authenticate(AuthenticationFlowContext context)

Specified by:

authenticate in interface Authenticator

validateOTP

public void validateOTP(AuthenticationFlowContext context)

requiresUser

public boolean requiresUser()

Specified by:

requiresUser in interface Authenticator

tempDisabledError

protected String tempDisabledError()

Overrides:

tempDisabledError in class AbstractUsernameFormAuthenticator

createLoginForm

protected javax.ws.rs.core.Response createLoginForm(LoginFormsProvider form)

Overrides:

createLoginForm in class AbstractUsernameFormAuthenticator

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

close

public void close()

Specified by:

close in interface Provider

Overrides:

close in class AbstractFormAuthenticator