Package org.keycloak.authentication.forms

Class AbstractRegistrationRecaptcha

java.lang.Object

org.keycloak.authentication.forms.AbstractRegistrationRecaptcha

All Implemented Interfaces:

ConfigurableAuthenticatorFactory, FormAction, FormActionFactory, ConfiguredProvider, Provider, ProviderFactory<FormAction>

Direct Known Subclasses:

RegistrationRecaptcha, RegistrationRecaptchaEnterprise

public abstract class AbstractRegistrationRecaptcha
extends Object
implements FormAction, FormActionFactory

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACTION
static final String	G_RECAPTCHA_RESPONSE
static final String	INVISIBLE
static final String	RECAPTCHA_REFERENCE_CATEGORY
static final String	SITE_KEY
static final String	USE_RECAPTCHA_NET

Fields inherited from interface org.keycloak.authentication.ConfigurableAuthenticatorFactory

REQUIREMENT_CHOICES

Constructor Summary

Constructors

Constructor	Description
AbstractRegistrationRecaptcha()

Method Summary

Modifier and Type	Method	Description
void	buildPage(FormContext context, LoginFormsProvider form)	When a FormAuthenticator is rendering the challenge page, even FormAction.buildPage() method will be called This gives the FormAction the opportunity to add additional attributes to the form to be displayed.
void	close()	This is called when the server shuts down.
boolean	configuredFor(KeycloakSession session, RealmModel realm, UserModel user)	Is this FormAction configured for the current user?
FormAction	create(KeycloakSession session)
List<ProviderConfigProperty>	getConfigProperties()
protected String	getRecaptchaDomain(Map<String,String> config)
String	getReferenceCategory()	General authenticator type, i.e.
AuthenticationExecutionModel.Requirement[]	getRequirementChoices()	What requirement settings are allowed.
protected abstract String	getScriptUrl(Map<String,String> config, String userLanguageTag)
void	init(Config.Scope config)	Only called once when the factory is first created.
boolean	isConfigurable()	Is this authenticator configurable?
boolean	isUserSetupAllowed()	Does this authenticator have required actions that can set if the user does not have this authenticator set up?
void	postInit(KeycloakSessionFactory factory)	Called after all provider factories have been initialized
boolean	requiresUser()	Does this FormAction require that a user be set? For registration, this method will always return false.
void	setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user)	Set actions to configure authenticator
void	success(FormContext context)	Called after all validate() calls of all FormAction providers are successful.
void	validate(ValidationContext context)	This is the first phase of form processing.
protected abstract boolean	validate(ValidationContext context, String captcha, Map<String,String> config)
protected abstract boolean	validateConfig(Map<String,String> config)

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.ConfigurableAuthenticatorFactory

getDisplayType

Methods inherited from interface org.keycloak.provider.ConfiguredProvider

getConfig, getHelpText

Methods inherited from interface org.keycloak.provider.ProviderFactory

getConfigMetadata, getId, order

Field Details

G_RECAPTCHA_RESPONSE

public static final String G_RECAPTCHA_RESPONSE

See Also:

• Constant Field Values

RECAPTCHA_REFERENCE_CATEGORY

public static final String RECAPTCHA_REFERENCE_CATEGORY

See Also:

• Constant Field Values

SITE_KEY

public static final String SITE_KEY

See Also:

• Constant Field Values

ACTION

public static final String ACTION

See Also:

• Constant Field Values

INVISIBLE

public static final String INVISIBLE

See Also:

• Constant Field Values

USE_RECAPTCHA_NET

public static final String USE_RECAPTCHA_NET

See Also:

• Constant Field Values

Constructor Details

AbstractRegistrationRecaptcha

public AbstractRegistrationRecaptcha()

Method Details

getReferenceCategory

public String getReferenceCategory()

Description copied from interface: ConfigurableAuthenticatorFactory

General authenticator type, i.e. totp, password, cert.

Specified by:

getReferenceCategory in interface ConfigurableAuthenticatorFactory

Returns:

null if not a referenceable category

isConfigurable

public boolean isConfigurable()

Description copied from interface: ConfigurableAuthenticatorFactory

Is this authenticator configurable?

Specified by:

isConfigurable in interface ConfigurableAuthenticatorFactory

Returns:

getRequirementChoices

public AuthenticationExecutionModel.Requirement[] getRequirementChoices()

Description copied from interface: ConfigurableAuthenticatorFactory

What requirement settings are allowed.

Specified by:

getRequirementChoices in interface ConfigurableAuthenticatorFactory

Returns:

getRecaptchaDomain

protected String getRecaptchaDomain(Map<String,String> config)

buildPage

public void buildPage(FormContext context,
 LoginFormsProvider form)

Description copied from interface: FormAction

When a FormAuthenticator is rendering the challenge page, even FormAction.buildPage() method will be called This gives the FormAction the opportunity to add additional attributes to the form to be displayed.

Specified by:

buildPage in interface FormAction

getScriptUrl

protected abstract String getScriptUrl(Map<String,String> config,
 String userLanguageTag)

validateConfig

protected abstract boolean validateConfig(Map<String,String> config)

validate

public void validate(ValidationContext context)

Description copied from interface: FormAction

This is the first phase of form processing. Each FormAction.validate() method is called. This gives the FormAction a chance to validate and challenge if user input is invalid.

Specified by:

validate in interface FormAction

validate

protected abstract boolean validate(ValidationContext context,
 String captcha,
 Map<String,String> config)

success

public void success(FormContext context)

Description copied from interface: FormAction

Called after all validate() calls of all FormAction providers are successful.

Specified by:

success in interface FormAction

requiresUser

public boolean requiresUser()

Description copied from interface: FormAction

Does this FormAction require that a user be set? For registration, this method will always return false.

Specified by:

requiresUser in interface FormAction

Returns:

configuredFor

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

Description copied from interface: FormAction

Is this FormAction configured for the current user?

Specified by:

configuredFor in interface FormAction

Returns:

setRequiredActions

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

Description copied from interface: FormAction

Set actions to configure authenticator

Specified by:

setRequiredActions in interface FormAction

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?

Specified by:

isUserSetupAllowed in interface ConfigurableAuthenticatorFactory

Returns:

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface Provider

Specified by:

close in interface ProviderFactory<FormAction>

create

public FormAction create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<FormAction>

init

public void init(Config.Scope config)

Description copied from interface: ProviderFactory

Only called once when the factory is first created. This config is pulled from keycloak_server.json

Specified by:

init in interface ProviderFactory<FormAction>

postInit

public void postInit(KeycloakSessionFactory factory)

Description copied from interface: ProviderFactory

Called after all provider factories have been initialized

Specified by:

postInit in interface ProviderFactory<FormAction>

getConfigProperties

public List<ProviderConfigProperty> getConfigProperties()

Specified by:

getConfigProperties in interface ConfiguredProvider