Package org.keycloak.authentication.authenticators.browser

Class AbstractUsernameFormAuthenticator

java.lang.Object

org.keycloak.authentication.AbstractFormAuthenticator

org.keycloak.authentication.authenticators.browser.AbstractUsernameFormAuthenticator

All Implemented Interfaces:

Authenticator, Provider

Direct Known Subclasses:

OTPFormAuthenticator, SpnegoAuthenticator, UsernamePasswordForm

public abstract class AbstractUsernameFormAuthenticator
extends AbstractFormAuthenticator

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTEMPTED_USERNAME
static final String	SESSION_INVALID
static final String	USER_SET_BEFORE_USERNAME_PASSWORD_AUTH
static final String	USERNAME_HIDDEN	An authentication session not to indicate that the username field should be hidden.

Constructor Summary

Constructors

Constructor	Description
AbstractUsernameFormAuthenticator()

Method Summary

Modifier and Type	Method	Description
void	action(AuthenticationFlowContext context)	Called from a form action invocation.
protected jakarta.ws.rs.core.Response	challenge(AuthenticationFlowContext context, String error)
protected jakarta.ws.rs.core.Response	challenge(AuthenticationFlowContext context, String error, String field)
protected jakarta.ws.rs.core.Response	createLoginForm(LoginFormsProvider form)
protected String	disabledByBruteForceError(String error)
protected String	disabledByBruteForceFieldError()
boolean	enabledUser(AuthenticationFlowContext context, UserModel user)
protected String	getDefaultChallengeMessage(AuthenticationFlowContext context)
protected boolean	isDisabledByBruteForce(AuthenticationFlowContext context, UserModel user)
protected boolean	isUserAlreadySetBeforeUsernamePasswordAuth(AuthenticationFlowContext context)
protected jakarta.ws.rs.core.Response	setDuplicateUserChallenge(AuthenticationFlowContext context, String eventError, String loginFormError, AuthenticationFlowError authenticatorError)
void	testInvalidUser(AuthenticationFlowContext context, UserModel user)
boolean	validatePassword(AuthenticationFlowContext context, UserModel user, jakarta.ws.rs.core.MultivaluedMap<String,String> inputData, boolean clearUser)
boolean	validateUser(AuthenticationFlowContext context, jakarta.ws.rs.core.MultivaluedMap<String,String> inputData)
boolean	validateUserAndPassword(AuthenticationFlowContext context, jakarta.ws.rs.core.MultivaluedMap<String,String> inputData)

Methods inherited from class org.keycloak.authentication.AbstractFormAuthenticator

close

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, authenticate, configuredFor, getRequiredActions, requiresUser, setRequiredActions

Field Details

ATTEMPTED_USERNAME

public static final String ATTEMPTED_USERNAME

See Also:

• Constant Field Values

USERNAME_HIDDEN

public static final String USERNAME_HIDDEN

An authentication session not to indicate that the username field should be hidden. This note is usually set together with ATTEMPTED_USERNAME to indicated that the user can restart the flow by choosing a different username. It should be set by authenticators that happen before this authenticator in the flow so that the original intent is kept when this authenticator is executed on subsequent requests.

See Also:

• Constant Field Values

SESSION_INVALID

public static final String SESSION_INVALID

See Also:

• Constant Field Values

USER_SET_BEFORE_USERNAME_PASSWORD_AUTH

public static final String USER_SET_BEFORE_USERNAME_PASSWORD_AUTH

See Also:

• Constant Field Values

Constructor Details

AbstractUsernameFormAuthenticator

public AbstractUsernameFormAuthenticator()

Method Details

action

public void action(AuthenticationFlowContext context)

Description copied from interface: Authenticator

Called from a form action invocation.

challenge

protected jakarta.ws.rs.core.Response challenge(AuthenticationFlowContext context,
 String error)

challenge

protected jakarta.ws.rs.core.Response challenge(AuthenticationFlowContext context,
 String error,
 String field)

createLoginForm

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

disabledByBruteForceError

protected String disabledByBruteForceError(String error)

disabledByBruteForceFieldError

protected String disabledByBruteForceFieldError()

setDuplicateUserChallenge

protected jakarta.ws.rs.core.Response setDuplicateUserChallenge(AuthenticationFlowContext context,
 String eventError,
 String loginFormError,
 AuthenticationFlowError authenticatorError)

testInvalidUser

public void testInvalidUser(AuthenticationFlowContext context,
 UserModel user)

enabledUser

public boolean enabledUser(AuthenticationFlowContext context,
 UserModel user)

validateUserAndPassword

public boolean validateUserAndPassword(AuthenticationFlowContext context,
 jakarta.ws.rs.core.MultivaluedMap<String,String> inputData)

validateUser

public boolean validateUser(AuthenticationFlowContext context,
 jakarta.ws.rs.core.MultivaluedMap<String,String> inputData)

validatePassword

public boolean validatePassword(AuthenticationFlowContext context,
 UserModel user,
 jakarta.ws.rs.core.MultivaluedMap<String,String> inputData,
 boolean clearUser)

isDisabledByBruteForce

protected boolean isDisabledByBruteForce(AuthenticationFlowContext context,
 UserModel user)

getDefaultChallengeMessage

protected String getDefaultChallengeMessage(AuthenticationFlowContext context)

isUserAlreadySetBeforeUsernamePasswordAuth

protected boolean isUserAlreadySetBeforeUsernamePasswordAuth(AuthenticationFlowContext context)