org.keycloak.authentication.forms.RegistrationRecaptcha クラス

org.keycloak.authentication.forms.RegistrationRecaptcha の継承関係図

org.keycloak.authentication.forms.RegistrationRecaptcha 連携図

公開メンバ関数
String	getDisplayType ()
String	getReferenceCategory ()
boolean	isConfigurable ()
AuthenticationExecutionModel.Requirement []	getRequirementChoices ()
void	buildPage (FormContext context, LoginFormsProvider form)
void	validate (ValidationContext context)
void	success (FormContext context)
boolean	requiresUser ()
boolean	configuredFor (KeycloakSession session, RealmModel realm, UserModel user)
void	setRequiredActions (KeycloakSession session, RealmModel realm, UserModel user)
boolean	isUserSetupAllowed ()
void	close ()
FormAction	create (KeycloakSession session)
void	init (Config.Scope config)
void	postInit (KeycloakSessionFactory factory)
String	getId ()
String	getHelpText ()
List< ProviderConfigProperty >	getConfigProperties ()

静的公開変数類
static final String	G_RECAPTCHA_RESPONSE = "g-recaptcha-response"
static final String	RECAPTCHA_REFERENCE_CATEGORY = "recaptcha"
static final String	SITE_KEY = "site.key"
static final String	SITE_SECRET = "secret"
static final String	PROVIDER_ID = "registration-recaptcha-action"

限定公開メンバ関数
boolean	validateRecaptcha (ValidationContext context, boolean success, String captcha, String secret)

静的関数
	[static initializer]

静的非公開変数類
static final Logger	logger = Logger.getLogger(RegistrationRecaptcha.class)
static AuthenticationExecutionModel.Requirement []	REQUIREMENT_CHOICES
static final List< ProviderConfigProperty >	CONFIG_PROPERTIES = new ArrayList<ProviderConfigProperty>()

詳解

著者

Bill Burke

バージョン

Revision

1

関数詳解

[static initializer]()

org.keycloak.authentication.forms.RegistrationRecaptcha.[static initializer] ( )

inlinestaticpackage

buildPage()

void org.keycloak.authentication.forms.RegistrationRecaptcha.buildPage ( FormContext  context, LoginFormsProvider  form  )

inline

                                                                        {
        AuthenticatorConfigModel captchaConfig = context.getAuthenticatorConfig();
        String userLanguageTag = context.getSession().getContext().resolveLocale(context.getUser()).toLanguageTag();
        if (captchaConfig == null || captchaConfig.getConfig() == null
                || captchaConfig.getConfig().get(SITE_KEY) == null
                || captchaConfig.getConfig().get(SITE_SECRET) == null
                ) {
            form.addError(new FormMessage(null, Messages.RECAPTCHA_NOT_CONFIGURED));
            return;
        }
        String siteKey = captchaConfig.getConfig().get(SITE_KEY);
        form.setAttribute("recaptchaRequired", true);
        form.setAttribute("recaptchaSiteKey", siteKey);
        form.addScript("https://www.google.com/recaptcha/api.js?hl=" + userLanguageTag);
    }

close()

void org.keycloak.authentication.forms.RegistrationRecaptcha.close ( )

inline

                        {

    }

configuredFor()

boolean org.keycloak.authentication.forms.RegistrationRecaptcha.configuredFor ( KeycloakSession  session, RealmModel  realm, UserModel  user  )

inline

                                                                                            {
        return true;
    }

create()

FormAction org.keycloak.authentication.forms.RegistrationRecaptcha.create ( KeycloakSession  session )

inline

                                                      {
        return this;
    }

getConfigProperties()

List<ProviderConfigProperty> org.keycloak.authentication.forms.RegistrationRecaptcha.getConfigProperties ( )

inline

                                                              {
        return CONFIG_PROPERTIES;
    }

getDisplayType()

String org.keycloak.authentication.forms.RegistrationRecaptcha.getDisplayType ( )

inline

                                   {
        return "Recaptcha";
    }

getHelpText()

String org.keycloak.authentication.forms.RegistrationRecaptcha.getHelpText ( )

inline

                                {
        return "Adds Google Recaptcha button.  Recaptchas verify that the entity that is registering is a human.  This can only be used on the internet and must be configured after you add it.";
    }

getId()

String org.keycloak.authentication.forms.RegistrationRecaptcha.getId ( )

inline

                          {
        return PROVIDER_ID;
    }

getReferenceCategory()

String org.keycloak.authentication.forms.RegistrationRecaptcha.getReferenceCategory ( )

inline

                                         {
        return RECAPTCHA_REFERENCE_CATEGORY;
    }

getRequirementChoices()

AuthenticationExecutionModel.Requirement [] org.keycloak.authentication.forms.RegistrationRecaptcha.getRequirementChoices ( )

inline

                                                                              {
        return REQUIREMENT_CHOICES;
    }

init()

void org.keycloak.authentication.forms.RegistrationRecaptcha.init ( Config.Scope  config )

inline

                                          {

    }

isConfigurable()

boolean org.keycloak.authentication.forms.RegistrationRecaptcha.isConfigurable ( )

inline

                                    {
        return true;
    }

isUserSetupAllowed()

boolean org.keycloak.authentication.forms.RegistrationRecaptcha.isUserSetupAllowed ( )

inline

                                        {
        return false;
    }

postInit()

void org.keycloak.authentication.forms.RegistrationRecaptcha.postInit ( KeycloakSessionFactory  factory )

inline

                                                         {

    }

requiresUser()

boolean org.keycloak.authentication.forms.RegistrationRecaptcha.requiresUser ( )

inline

                                  {
        return false;
    }

setRequiredActions()

void org.keycloak.authentication.forms.RegistrationRecaptcha.setRequiredActions ( KeycloakSession  session, RealmModel  realm, UserModel  user  )

inline

                                                                                              {

    }

success()

void org.keycloak.authentication.forms.RegistrationRecaptcha.success ( FormContext  context )

inline

                                             {

    }

validate()

void org.keycloak.authentication.forms.RegistrationRecaptcha.validate ( ValidationContext  context )

inline

                                                    {
        MultivaluedMap<String, String> formData = context.getHttpRequest().getDecodedFormParameters();
        List<FormMessage> errors = new ArrayList<>();
        boolean success = false;
        context.getEvent().detail(Details.REGISTER_METHOD, "form");

        String captcha = formData.getFirst(G_RECAPTCHA_RESPONSE);
        if (!Validation.isBlank(captcha)) {
            AuthenticatorConfigModel captchaConfig = context.getAuthenticatorConfig();
            String secret = captchaConfig.getConfig().get(SITE_SECRET);

            success = validateRecaptcha(context, success, captcha, secret);
        }
        if (success) {
            context.success();
        } else {
            errors.add(new FormMessage(null, Messages.RECAPTCHA_FAILED));
            formData.remove(G_RECAPTCHA_RESPONSE);
            context.error(Errors.INVALID_REGISTRATION);
            context.validationError(formData, errors);
            context.excludeOtherErrors();
            return;


        }
    }

validateRecaptcha()

boolean org.keycloak.authentication.forms.RegistrationRecaptcha.validateRecaptcha ( ValidationContext  context, boolean  success, String  captcha, String  secret  )

inlineprotected

                                                                                                                   {
        HttpClient httpClient = context.getSession().getProvider(HttpClientProvider.class).getHttpClient();
        HttpPost post = new HttpPost("https://www.google.com/recaptcha/api/siteverify");
        List<NameValuePair> formparams = new LinkedList<>();
        formparams.add(new BasicNameValuePair("secret", secret));
        formparams.add(new BasicNameValuePair("response", captcha));
        formparams.add(new BasicNameValuePair("remoteip", context.getConnection().getRemoteAddr()));
        try {
            UrlEncodedFormEntity form = new UrlEncodedFormEntity(formparams, "UTF-8");
            post.setEntity(form);
            HttpResponse response = httpClient.execute(post);
            InputStream content = response.getEntity().getContent();
            try {
                Map json = JsonSerialization.readValue(content, Map.class);
                Object val = json.get("success");
                success = Boolean.TRUE.equals(val);
            } finally {
                content.close();
            }
        } catch (Exception e) {
            ServicesLogger.LOGGER.recaptchaFailed(e);
        }
        return success;
    }

メンバ詳解

CONFIG_PROPERTIES

final List<ProviderConfigProperty> org.keycloak.authentication.forms.RegistrationRecaptcha.CONFIG_PROPERTIES = new ArrayList<ProviderConfigProperty>()

staticprivate

G_RECAPTCHA_RESPONSE

final String org.keycloak.authentication.forms.RegistrationRecaptcha.G_RECAPTCHA_RESPONSE = "g-recaptcha-response"

static

logger

final Logger org.keycloak.authentication.forms.RegistrationRecaptcha.logger = Logger.getLogger(RegistrationRecaptcha.class)

staticprivate

PROVIDER_ID

final String org.keycloak.authentication.forms.RegistrationRecaptcha.PROVIDER_ID = "registration-recaptcha-action"

static

RECAPTCHA_REFERENCE_CATEGORY

final String org.keycloak.authentication.forms.RegistrationRecaptcha.RECAPTCHA_REFERENCE_CATEGORY = "recaptcha"

static

REQUIREMENT_CHOICES

AuthenticationExecutionModel.Requirement [] org.keycloak.authentication.forms.RegistrationRecaptcha.REQUIREMENT_CHOICES

staticprivate

初期値:

= {
            AuthenticationExecutionModel.Requirement.REQUIRED,
            AuthenticationExecutionModel.Requirement.DISABLED
    }

SITE_KEY

final String org.keycloak.authentication.forms.RegistrationRecaptcha.SITE_KEY = "site.key"

static

SITE_SECRET

final String org.keycloak.authentication.forms.RegistrationRecaptcha.SITE_SECRET = "secret"

static

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/rest-service/src/services/src/main/java/org/keycloak/authentication/forms/RegistrationRecaptcha.java