Package org.keycloak.authentication.authenticators.browser

Class UsernamePasswordForm

java.lang.Object

org.keycloak.authentication.AbstractFormAuthenticator

org.keycloak.authentication.authenticators.browser.AbstractUsernameFormAuthenticator

org.keycloak.authentication.authenticators.browser.UsernamePasswordForm

All Implemented Interfaces:

Authenticator, Provider

Direct Known Subclasses:

IdpUsernamePasswordForm, PasswordForm, UsernameForm

public class UsernamePasswordForm
extends AbstractUsernameFormAuthenticator
implements Authenticator

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field	Description
protected final WebAuthnConditionalUIAuthenticator	webauthnAuth

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

ATTEMPTED_USERNAME, REGISTRATION_FORM_ACTION, SESSION_INVALID, USER_SET_BEFORE_USERNAME_PASSWORD_AUTH

Constructor Summary

Constructors

Constructor	Description
UsernamePasswordForm()
UsernamePasswordForm(KeycloakSession session)

Method Summary

Modifier and Type	Method	Description
void	action(AuthenticationFlowContext context)	Called from a form action invocation.
protected boolean	alreadyAuthenticatedUsingPasswordlessCredential(AuthenticationFlowContext context)
protected boolean	alreadyAuthenticatedUsingPasswordlessCredential(AuthenticationSessionModel authSession)
void	authenticate(AuthenticationFlowContext context)	Initial call for the authenticator.
protected jakarta.ws.rs.core.Response	challenge(AuthenticationFlowContext context, jakarta.ws.rs.core.MultivaluedMap<String,String> formData)
protected jakarta.ws.rs.core.Response	challenge(AuthenticationFlowContext context, String error, String field)
void	close()
boolean	configuredFor(KeycloakSession session, RealmModel realm, UserModel user)	Is this authenticator configured for this user.
protected boolean	isConditionalPasskeysEnabled(UserModel currentUser)
boolean	requiresUser()	Does this authenticator require that the user has already been identified? That AuthenticatorContext.getUser() is not null?
void	setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)	Set actions to configure authenticator
protected boolean	validateForm(AuthenticationFlowContext context, jakarta.ws.rs.core.MultivaluedMap<String,String> formData)

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

challenge, createLoginForm, disabledByBruteForceError, disabledByBruteForceFieldError, 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, getRequiredActions

Field Details

webauthnAuth

protected final WebAuthnConditionalUIAuthenticator webauthnAuth

Constructor Details

UsernamePasswordForm

public UsernamePasswordForm()

UsernamePasswordForm

public UsernamePasswordForm(KeycloakSession session)

Method Details

action

public void action(AuthenticationFlowContext context)

Description copied from interface: Authenticator

Called from a form action invocation.

Specified by:

action in interface Authenticator

Overrides:

action in class AbstractUsernameFormAuthenticator

validateForm

protected boolean validateForm(AuthenticationFlowContext context,
 jakarta.ws.rs.core.MultivaluedMap<String,String> formData)

alreadyAuthenticatedUsingPasswordlessCredential

protected boolean alreadyAuthenticatedUsingPasswordlessCredential(AuthenticationFlowContext context)

alreadyAuthenticatedUsingPasswordlessCredential

protected boolean alreadyAuthenticatedUsingPasswordlessCredential(AuthenticationSessionModel authSession)

authenticate

public void authenticate(AuthenticationFlowContext context)

Description copied from interface: Authenticator

Initial call for the authenticator. This method should check the current HTTP request to determine if the request satisfies the Authenticator's requirements. If it doesn't, it should send back a challenge response by calling the AuthenticationFlowContext.challenge(Response). If this challenge is a authentication, the action URL of the form must point to /realms/{realm}/login-actions/authenticate?code={session-code}&execution={executionId} or /realms/{realm}/login-actions/registration?code={session-code}&execution={executionId} {session-code} pertains to the code generated from AuthenticationFlowContext.generateAccessCode(). The {executionId} pertains to the AuthenticationExecutionModel.getId() value obtained from AuthenticationFlowContext.getExecution(). The action URL will invoke the action() method described below.

Specified by:

authenticate in interface Authenticator

requiresUser

public boolean requiresUser()

Description copied from interface: Authenticator

Does this authenticator require that the user has already been identified? That AuthenticatorContext.getUser() is not null?

Specified by:

requiresUser in interface Authenticator

Returns:

challenge

protected jakarta.ws.rs.core.Response challenge(AuthenticationFlowContext context,
 jakarta.ws.rs.core.MultivaluedMap<String,String> formData)

challenge

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

Overrides:

challenge in class AbstractUsernameFormAuthenticator

configuredFor

public boolean configuredFor(KeycloakSession session,
 RealmModel realm,
 UserModel user)

Description copied from interface: Authenticator

Is this authenticator configured for this user.

Specified by:

configuredFor in interface Authenticator

Returns:

setRequiredActions

public void setRequiredActions(KeycloakSession session,
 RealmModel realm,
 UserModel user)

Description copied from interface: Authenticator

Set actions to configure authenticator

Specified by:

setRequiredActions in interface Authenticator

close

public void close()

Specified by:

close in interface Provider

Overrides:

close in class AbstractFormAuthenticator

isConditionalPasskeysEnabled

protected boolean isConditionalPasskeysEnabled(UserModel currentUser)