lostlink/laravel-recaptchav3

Recaptcha V3 for Laravel package

dev-main 2024-10-17 14:59 UTC

Requires

• php: ^7.4|^8.0|^8.1|^8.2|^8.3
• guzzlehttp/guzzle: ^6.2|^7.0
• illuminate/container: ~5.7.0|~5.8.0|^6.0|^7.0|^8.0|^9.0|^10.0|^11.0
• illuminate/http: ~5.7.0|~5.8.0|^6.0|^7.0|^8.0|^9.0|^10.0|^11.0
• illuminate/support: ~5.7.0|~5.8.0|^6.0|^7.0|^8.0|^9.0|^10.0|^11.0

Requires (Dev)

• mockery/mockery: ^1.2
• orchestra/testbench: ~3.7.0|~3.8.0|^4.0|^5.0|^6.0|^7.0|^8.0|^9.0
• phpunit/phpunit: 6.2|^7.0|^8.0|^9.5.10|^10.0|^11.0

MIT

• Josias Montag
• Nuno Souto

• php
• recaptcha
• captcha
• laravel

README

Laravel package for Google's Recaptcha V3. This is a lightweight package which focuses on the backend validation of Recaptcha V3 captchas.

Installation

To get started, use Composer to add the package to your project's dependencies:

composer require lostlink/laravel-recaptchav3

Add RECAPTCHAV3_SITEKEY and RECAPTCHAV3_SECRET to your .env file. (You can get them here)

RECAPTCHAV3_SITEKEY=sitekey
RECAPTCHAV3_SECRET=secret

Optionally, you can publish the config file:

php artisan vendor:publish --provider="Lostlink\RecaptchaV3\Providers\RecaptchaV3ServiceProvider"

Usage

Init Recaptcha Javascript

Recaptcha v3 works best when it is loaded on every page to get the most context about interactions. Therefore, add to your header or footer template:

{!! RecaptchaV3::initJs() !!}

Forms

RecaptchaV3::field($form, $action, $name='g-recaptcha-response') creates an invisible input field that gets filled with a Recaptcha token on form submit.

<form name="register" method="post" action="/register">
    {!! RecaptchaV3::field('register', 'register') !!}
    <input type="submit" value="Register"></input>
</form>

Validation

Add the recaptchav3 validator to the rules array. The rule accepts two parameters: The action name and the minimum required score (defaults to 0.5).

$validate = Validator::make(Input::all(), [
	'g-recaptcha-response' => 'required|recaptchav3:register,0.5'
]);

Getting the score

Alternatively, you can get the score and take variable action:

// Import the facade class
use Lostlink\RecaptchaV3\Facades\RecaptchaV3;
//  RecaptchaV3::verify($token, $action)
$score = RecaptchaV3::verify($request->get('g-recaptcha-response'), 'register')
if($score > 0.7) {
    // go
} elseif($score > 0.3) {
    // require additional email verification
} else {
    return abort(400, 'You are most likely a bot');
}

Custom validation error message

Add the following values to the custom array in the validation language file:

'custom' => [
    'g-recaptcha-response' => [
        'recaptchav3' => 'Captcha error message',
    ],
],

Hiding the ReCAPTCHA Badge

Add to your CSS file:

.grecaptcha-badge { visibility: hidden !important; }

Localization

By default, the package follows the default application locale, which is defined in config/app.php. If you want to change this behavior, you can specify what locale to use by adding a new environment variable :

RECAPTCHAV3_LOCALE=ar

Testing

To make your forms testable, you can mock the RecaptchaV3 facade:

RecaptchaV3::shouldReceive('verify')
    ->once()
    ->andReturn(1.0);