Package org.keycloak.authentication.authenticators.browser

Class UsernameForm

java.lang.Object

org.keycloak.authentication.AbstractFormAuthenticator

org.keycloak.authentication.authenticators.browser.AbstractUsernameFormAuthenticator

org.keycloak.authentication.authenticators.browser.UsernamePasswordForm

org.keycloak.authentication.authenticators.browser.UsernameForm

All Implemented Interfaces:

Authenticator, Provider

public final class UsernameForm
extends UsernamePasswordForm

Field Summary

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

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
UsernameForm()
UsernameForm(KeycloakSession session)

Method Summary

Modifier and Type	Method	Description
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	createLoginForm(LoginFormsProvider form)
protected String	getDefaultChallengeMessage(AuthenticationFlowContext context)
protected boolean	validateForm(AuthenticationFlowContext context, jakarta.ws.rs.core.MultivaluedMap<String,String> formData)

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

action, alreadyAuthenticatedUsingPasswordlessCredential, alreadyAuthenticatedUsingPasswordlessCredential, challenge, close, configuredFor, isConditionalPasskeysEnabled, requiresUser, setRequiredActions

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

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

Constructor Details

UsernameForm

public UsernameForm()

UsernameForm

public UsernameForm(KeycloakSession session)

Method Details

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

Overrides:

authenticate in class UsernamePasswordForm

validateForm

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

Overrides:

validateForm in class UsernamePasswordForm

challenge

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

Overrides:

challenge in class UsernamePasswordForm

createLoginForm

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

Overrides:

createLoginForm in class AbstractUsernameFormAuthenticator

getDefaultChallengeMessage

protected String getDefaultChallengeMessage(AuthenticationFlowContext context)

Overrides:

getDefaultChallengeMessage in class AbstractUsernameFormAuthenticator