Package org.keycloak.authentication.authenticators.browser

Class RecoveryAuthnCodesFormAuthenticator

java.lang.Object
org.keycloak.authentication.authenticators.browser.RecoveryAuthnCodesFormAuthenticator
All Implemented Interfaces:
Authenticator, Provider
public class RecoveryAuthnCodesFormAuthenticator extends Object implements Authenticator

  • Constructor Details

    • RecoveryAuthnCodesFormAuthenticator

      public RecoveryAuthnCodesFormAuthenticator(KeycloakSession keycloakSession)

  • 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 satifies 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

    • action

      public void action(AuthenticationFlowContext context)
      Description copied from interface: Authenticator
      Called from a form action invocation.
      Specified by:
      action in interface Authenticator

    • isDisabledByBruteForce

      protected boolean isDisabledByBruteForce(AuthenticationFlowContext authnFlowContext, UserModel authenticatedUser)

    • getDisabledByBruteForceEventError

      protected String getDisabledByBruteForceEventError(AuthenticationFlowContext authnFlowContext, UserModel authenticatedUser)

    • 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:

    • 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