README

Symfony bundle that provides CAPTCHA form field to solve challenge-response tests. Supports multiple adapters as well as custom ones. Built-in adapter for:

• Google reCAPTCHA
• Google reCAPTCHA v3
• Gregwar/Captcha
• Honeypot captcha technique

New contributors are welcome!

Installation

composer require gremo/captcha-form-bundle

Then enable the bundle:

<?php // config/bundles.php return [ // ... Gremo\CaptchaFormBundle\GremoCaptchaFormBundle::class => ['all' => true], ];

If you are using a previous version of Symfony:

<?php // app/AppKernel.php public function registerBundles() { $bundles = array( // ... new Gremo\CaptchaFormBundle\GremoCaptchaFormBundle(), ); }

Configuration

gremo_captcha_form: # Default template, change only if you know what your are doing template: 'GremoCaptchaFormBundle::default.html.twig' # Default adapter (default to the first adapter) default_adapter: ~ # Adapters (one or more) configuration adapters: # Adapter key and its options adapter_key1: [] # ... and another adapter adapter_key2: []

In order to use the CAPTCHA form you need to configure at least one adapter (see "Adapters" section).

Usage

You can use the generic form type instead of the form provided by each adapter. This is more maintainable as you depends only on one form type.

The generic type use the default adapter and options provided in the configuration. An example usage:

// For Symfony >= 2.8 and PHP >= 5.5 use the class name resolution via ::class use Gremo\CaptchaFormBundle\Form\Type\CaptchaType; $builder->add('captcha', CaptchaType::class, [ // Pass custom options to override defaults from configuration ]); // For Symfony >= 2.8 and PHP < 5.5 use the fully-qualified class name as string $builder->add('captcha', 'Gremo\CaptchaFormBundle\Form\Type\CaptchaType', [ // Pass custom options to override defaults from configuration ]); // For Symfony < 2.8 $builder->add('captcha', 'gremo_captcha', [ // Pass custom options to override defaults from configuration ]);

Adapters

At least one adapter must be configured.

Google reCAPTCHA v2 adapter

Adapter key: recaptcha Form Type: Gremo\CaptchaFormBundle\Form\Type\RecaptchaType

Add the google/recaptcha library to your project:

composer require google/recaptcha^1

Configure the adapter (options explanation):

# ... adapters: # ... recaptcha: # Mandatory options key: ~ # string secret: ~ # string # Not mandatory options theme: ~ # string type: ~ # string size: ~ # string tabindex: ~ # integer callback: ~ # string expired_callback: ~ # string

Finally, add the reCAPTCHA <script> tag to your base template:

<script src="https://www.google.com/recaptcha/api.js" async defer></script>

Tip: add the hl parameter to the script in order to localize the CAPTCHA, i.e. in Twig hl={{ app.request.locale }}.

Example usage:

// For Symfony >= 2.8 and PHP >= 5.5 use the class name resolution via ::class use Gremo\CaptchaFormBundle\Form\Type\RecaptchaType; $builder->add('captcha', RecaptchaType::class, [ // Pass custom options to override defaults from configuration ]); // For Symfony >= 2.8 and PHP < 5.5 use the fully-qualified class name as string $builder->add('captcha', 'Gremo\CaptchaFormBundle\Form\Type\RecaptchaType', [ // Pass custom options to override defaults from configuration ]); // For Symfony < 2.8 $builder->add('captcha', 'gremo_captcha_recaptcha', [ // Pass custom options to override defaults from configuration ]);

Google reCAPTCHA v3 adapter

Adapter key: recaptcha_v3 Form Type: Gremo\CaptchaFormBundle\Form\Type\RecaptchaV3Type

Add the google/recaptcha library to your project:

composer require google/recaptcha^1

Configure the adapter (options explanation):

# ... adapters: # ... recaptcha_v3: # Mandatory options key: ~ # string secret: ~ # string # Not mandatory options score_threshold: ~ # float

There is no need to add any <script> tag because the form theme will do it for you.

Example usage:

// For Symfony >= 2.8 and PHP >= 5.5 use the class name resolution via ::class use Gremo\CaptchaFormBundle\Form\Type\RecaptchaV3Type; $builder->add('captcha', RecaptchaV3Type::class, [ // For options ]); // For Symfony >= 2.8 and PHP < 5.5 use the fully-qualified class name as string $builder->add('captcha', 'Gremo\CaptchaFormBundle\Form\Type\RecaptchaV3Type', [ // For options ]); // For Symfony < 2.8 $builder->add('captcha', 'gremo_captcha_recaptcha_v3', [ // For options ]);

Gregwar captcha adapter

Adapter key: gregwar_captcha Form Type: Gremo\CaptchaFormBundle\Form\Type\GregwarCaptchaType

Add the gregwar/recaptcha library to your project:

composer require gregwar/recaptcha^1

Configure the adapter (options explanation):

# ... adapters: # ... gregwar_captcha: # Not mandatory options storage_key: _gregwar_captcha width: ~ # integer height: ~ # integer quality: ~ # integer font: ~ # string distorsion: ~ # boolean interpolation: ~ # boolean ignore_all_effects: ~ # boolean orc: ~ # boolean

Example usage:

// For Symfony >= 2.8 and PHP >= 5.5 use the class name resolution via ::class use Gremo\CaptchaFormBundle\Form\Type\GregwarCaptchaType; $builder->add('captcha', GregwarCaptchaType::class, [ // Pass custom options to override defaults from configuration ]); // For Symfony >= 2.8 and PHP < 5.5 use the fully-qualified class name as string $builder->add('captcha', 'Gremo\CaptchaFormBundle\Form\Type\GregwarCaptchaType', [ // Pass custom options to override defaults from configuration ]); // For Symfony < 2.8 $builder->add('captcha', 'gremo_captcha_gregwar', [ // Pass custom options to override defaults from configuration ]);

Honeypot adapter

Adapter key: honeypot Form Type: Gremo\CaptchaFormBundle\Form\Type\HoneypotType

Configure the adapter:

# ... adapters: # ... honeypot: # Mandatory options type: ~ # string, "text" or "hidden" or their FQCN (Symfony >= 2.8)

Example usage:

// For Symfony >= 2.8 and PHP >= 5.5 use the class name resolution via ::class use Gremo\CaptchaFormBundle\Form\Type\HoneypotType; $builder->add('captcha', HoneypotType::class, [ // Pass custom options to override defaults from configuration ]); // For Symfony >= 2.8 and PHP < 5.5 use the fully-qualified class name as string $builder->add('captcha', 'Gremo\CaptchaFormBundle\Form\Type\HoneypotType', [ // Pass custom options to override defaults from configuration ]); // For Symfony < 2.8 $builder->add('captcha', 'gremo_captcha_honeypot', [ // Pass custom options to override defaults from configuration ]);