FORGEBOX Enterprise 🚀 - Take your ColdFusion (CFML) Development to Modern Times! Learn More...
This module contains helpers for using Google's ReCAPTCHA API.
reCAPTCHA is a free service that protects your site from spam and abuse. It uses advanced risk analysis techniques to tell humans and bots apart. With the 2.0 API, a significant number of your valid human users will pass the reCAPTCHA challenge without having to solve a CAPTCHA. reCAPTCHA comes in the form of a widget that you can easily add to your blog, forum, registration form, etc.
Apache License, Version 2.0.
Just drop into your modules
folder or use the CommandBox to install
box install recaptcha2
Get an API key pair at http://www.google.com/recaptcha/admin and add the following settings to your Coldbox.cfc
under a recaptcha
structure within the moduleSettings
structure:
moduleSettings = {
// recaptcha settings
recaptcha = {
secretKey = "Secret key",
publickey = "Site key",
};
}
In any form you wish to add the reCaptcha widget use the following:
<div class="form-group">
#renderview(
view="widget",
module="recaptcha",
args={
size = "normal" // normal or compact
}
)#
</div>
The only argument the widget receives is the size
of the captcha:
normal
compact
Validation can be done manually or using or custom validator that leverages the cbValidation
module (https://forgebox.io/view/cbValidation).
In your handler for the post of the form, or in a model object you can then use the included Validator. Here is an example of using it in a model object:
this.constraints = {
"body" : { required : true },
"recaptcha" : { validator: "[email protected]" }
}
In the above example, your handler would just need to set the recaptcha property on the model object to the g-recaptcha-response
value that is part of the form payload.
There also is a [email protected]
Wirebox mapping you can use to validate manually if you prefer to not use the cbvalidation
integration. In your handler:
var recaptchaOK = getInstance( "[email protected]" ).isValid( rc[ "g-recaptcha-response" ] );
if ( !recaptchaOK ){
writeOutput( "Prove you have a soul!" );
}
Here are all the versions for this package. Please note that you can leverage CommandBox package versioning to install any package you like. Please refer to our managing package version guide for more information.