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 String
SELECTED_OTP_CREDENTIAL_ID
static String
UNNAMED
-
Fields inherited from class org.keycloak.authentication.authenticators.browser.AbstractUsernameFormAuthenticator
ATTEMPTED_USERNAME, REGISTRATION_FORM_ACTION, USER_SET_BEFORE_USERNAME_PASSWORD_AUTH
-
-
Constructor Summary
Constructors Constructor Description OTPFormAuthenticator()
-
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)
protected javax.ws.rs.core.Response
createLoginForm(org.keycloak.forms.login.LoginFormsProvider form)
protected String
disabledByBruteForceError()
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, dummyHash, enabledUser, getDefaultChallengeMessage, isDisabledByBruteForce, isUserAlreadySetBeforeUsernamePasswordAuth, runDefaultDummyHash, setDuplicateUserChallenge, testInvalidUser, validatePassword, validateUser, validateUserAndPassword
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
Field Detail
-
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
-
-
Method Detail
-
action
public void action(org.keycloak.authentication.AuthenticationFlowContext context)
- Specified by:
action
in interfaceorg.keycloak.authentication.Authenticator
- Overrides:
action
in classAbstractUsernameFormAuthenticator
-
authenticate
public void authenticate(org.keycloak.authentication.AuthenticationFlowContext context)
- Specified by:
authenticate
in interfaceorg.keycloak.authentication.Authenticator
-
validateOTP
public void validateOTP(org.keycloak.authentication.AuthenticationFlowContext context)
-
requiresUser
public boolean requiresUser()
- Specified by:
requiresUser
in interfaceorg.keycloak.authentication.Authenticator
-
disabledByBruteForceError
protected String disabledByBruteForceError()
- Overrides:
disabledByBruteForceError
in classAbstractUsernameFormAuthenticator
-
disabledByBruteForceFieldError
protected String disabledByBruteForceFieldError()
- Overrides:
disabledByBruteForceFieldError
in classAbstractUsernameFormAuthenticator
-
createLoginForm
protected javax.ws.rs.core.Response createLoginForm(org.keycloak.forms.login.LoginFormsProvider form)
- Overrides:
createLoginForm
in classAbstractUsernameFormAuthenticator
-
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
- Overrides:
close
in classAbstractFormAuthenticator
-
getCredentialProvider
public OTPCredentialProvider getCredentialProvider(org.keycloak.models.KeycloakSession session)
- Specified by:
getCredentialProvider
in interfaceorg.keycloak.authentication.CredentialValidator<OTPCredentialProvider>
-
-