java.lang.Object
org.keycloak.authentication.authenticators.directgrant.AbstractDirectGrantAuthenticator
org.keycloak.authentication.authenticators.directgrant.ValidatePassword
All Implemented Interfaces:
Authenticator, AuthenticatorFactory, ConfigurableAuthenticatorFactory, ConfiguredProvider, Provider, ProviderFactory<Authenticator>

public class ValidatePassword extends AbstractDirectGrantAuthenticator
Version:
$Revision: 1 $
Author:
Bill Burke
  • Field Details

  • Constructor Details

    • ValidatePassword

      public ValidatePassword()
  • 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.
    • 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?
      Returns:
    • configuredFor

      public boolean configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
      Description copied from interface: Authenticator
      Is this authenticator configured for this user.
      Returns:
    • setRequiredActions

      public void setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)
      Description copied from interface: Authenticator
      Set actions to configure authenticator
    • isUserSetupAllowed

      public boolean isUserSetupAllowed()
      Description copied from interface: ConfigurableAuthenticatorFactory
      Does this authenticator have required actions that can set if the user does not have this authenticator set up?
      Returns:
    • getDisplayType

      public String getDisplayType()
      Description copied from interface: ConfigurableAuthenticatorFactory
      Friendly name for the authenticator
      Returns:
    • getReferenceCategory

      public String getReferenceCategory()
      Description copied from interface: ConfigurableAuthenticatorFactory
      General authenticator type, i.e. totp, password, cert.
      Returns:
      null if not a referenceable category
    • isConfigurable

      public boolean isConfigurable()
      Description copied from interface: ConfigurableAuthenticatorFactory
      Is this authenticator configurable?
      Returns:
    • getRequirementChoices

      public AuthenticationExecutionModel.Requirement[] getRequirementChoices()
      Description copied from interface: ConfigurableAuthenticatorFactory
      What requirement settings are allowed.
      Returns:
    • getHelpText

      public String getHelpText()
    • getConfigProperties

      public List<ProviderConfigProperty> getConfigProperties()
    • getId

      public String getId()
    • retrievePassword

      protected String retrievePassword(AuthenticationFlowContext context)