Package org.keycloak.authentication.authenticators.browser

Class RecoveryAuthnCodesFormAuthenticator

java.lang.Object

org.keycloak.authentication.authenticators.browser.RecoveryAuthnCodesFormAuthenticator

All Implemented Interfaces:

Authenticator, CredentialValidator<RecoveryAuthnCodesCredentialProvider>, Provider

public class RecoveryAuthnCodesFormAuthenticator
extends Object
implements Authenticator, CredentialValidator<RecoveryAuthnCodesCredentialProvider>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GENERATED_AT_NOTE
static final String	GENERATED_RECOVERY_AUTHN_CODES_NOTE

Constructor Summary

Constructors

Constructor	Description
RecoveryAuthnCodesFormAuthenticator(KeycloakSession keycloakSession)

Method Summary

Modifier and Type	Method	Description
void	action(AuthenticationFlowContext context)
protected void	addRequiredAction(AuthenticationFlowContext authnFlowContext)
void	authenticate(AuthenticationFlowContext context)
void	close()
boolean	configuredFor(KeycloakSession session, RealmModel realm, UserModel user)
RecoveryAuthnCodesCredentialProvider	getCredentialProvider(KeycloakSession session)
protected String	getDisabledByBruteForceEventError(AuthenticationFlowContext authnFlowContext, UserModel authenticatedUser)
String	getType(KeycloakSession session)
protected boolean	isDisabledByBruteForce(AuthenticationFlowContext authnFlowContext, UserModel authenticatedUser)
boolean	requiresUser()
void	setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)

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

Methods inherited from interface org.keycloak.authentication.CredentialValidator

getCredentials

Field Details

GENERATED_RECOVERY_AUTHN_CODES_NOTE

public static final String GENERATED_RECOVERY_AUTHN_CODES_NOTE

See Also:

• Constant Field Values

GENERATED_AT_NOTE

public static final String GENERATED_AT_NOTE

See Also:

• Constant Field Values

Constructor Details

RecoveryAuthnCodesFormAuthenticator

public RecoveryAuthnCodesFormAuthenticator(KeycloakSession keycloakSession)

Method Details

authenticate

public void authenticate(AuthenticationFlowContext context)

Specified by:

authenticate in interface Authenticator

action

public void action(AuthenticationFlowContext context)

Specified by:

action in interface Authenticator

addRequiredAction

protected void addRequiredAction(AuthenticationFlowContext authnFlowContext)

isDisabledByBruteForce

protected boolean isDisabledByBruteForce(AuthenticationFlowContext authnFlowContext,
 UserModel authenticatedUser)

getDisabledByBruteForceEventError

protected String getDisabledByBruteForceEventError(AuthenticationFlowContext authnFlowContext,
 UserModel authenticatedUser)

requiresUser

public boolean requiresUser()

Specified by:

requiresUser in interface Authenticator

configuredFor

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

Specified by:

configuredFor in interface Authenticator

setRequiredActions

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

Specified by:

setRequiredActions in interface Authenticator

close

public void close()

Specified by:

close in interface Provider

getCredentialProvider

public RecoveryAuthnCodesCredentialProvider getCredentialProvider(KeycloakSession session)

Specified by:

getCredentialProvider in interface CredentialValidator<RecoveryAuthnCodesCredentialProvider>

getType

public String getType(KeycloakSession session)

Specified by:

getType in interface CredentialValidator<RecoveryAuthnCodesCredentialProvider>