Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ryangjchandler/laravel-cloudflare-turnstile
A simple package to help integrate Cloudflare Turnstile.
https://github.com/ryangjchandler/laravel-cloudflare-turnstile
Last synced: 1 day ago
JSON representation
A simple package to help integrate Cloudflare Turnstile.
- Host: GitHub
- URL: https://github.com/ryangjchandler/laravel-cloudflare-turnstile
- Owner: ryangjchandler
- License: mit
- Created: 2022-09-30T08:48:53.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-26T17:20:50.000Z (8 months ago)
- Last Synced: 2025-01-03T13:38:06.361Z (6 days ago)
- Language: PHP
- Size: 64.5 KB
- Stars: 247
- Watchers: 5
- Forks: 14
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# A simple package to help integrate Cloudflare Turnstile.
[](https://packagist.org/packages/ryangjchandler/laravel-cloudflare-turnstile)
[](https://github.com/ryangjchandler/laravel-cloudflare-turnstile/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/ryangjchandler/laravel-cloudflare-turnstile/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[](https://packagist.org/packages/ryangjchandler/laravel-cloudflare-turnstile)
This packages provides helper for setting up and validating Cloudflare Turnstile CAPTCHA responses.
## Installation
You can install the package via Composer:
```bash
composer require ryangjchandler/laravel-cloudflare-turnstile
```
You should then add the following configuration values to your `config/services.php` file:
```php
return [
// ...,
'turnstile' => [
'key' => env('TURNSTILE_SITE_KEY'),
'secret' => env('TURNSTILE_SECRET_KEY'),
],
];
```
Visit Cloudflare to create your site key and secret key and add them to your `.env` file.
```
TURNSTILE_SITE_KEY="1x00000000000000000000AA"
TURNSTILE_SECRET_KEY="2x0000000000000000000000000000000AA"
```
## Usage
In your layout file, include the Turnstile scripts using the `@turnstileScripts` Blade directive. This should be added to the `` of your document.
```blade
@turnstileScripts()
{{ $slot }}
```
Once that's done, you can use the `` component inside of a `` to output the appropriate markup with your site key configured.
```blade
Submit
```
On the server, use the provided validation rule to validate the CAPTCHA response.
```php
use Illuminate\Validation\Rule;
public function submit(Request $request)
{
$request->validate([
'cf-turnstile-response' => ['required', Rule::turnstile()],
]);
}
```
If you prefer to not use a macro, you can resolve an instance of the rule from the container via dependency injection or the `app()` helper.
```php
use RyanChandler\LaravelCloudflareTurnstile\Rules\Turnstile;
public function submit(Request $request, Turnstile $turnstile)
{
$request->validate([
'cf-turnstile-response' => ['required', $turnstile],
]);
}
```
```php
use RyanChandler\LaravelCloudflareTurnstile\Rules\Turnstile;
public function submit(Request $request)
{
$request->validate([
'cf-turnstile-response' => ['required', app(Turnstile::class)],
]);
}
```
### Customizing the widget
You can customize the widget by passing attributes to the `` component.
> To learn more about these parameters, refer to [the offical documentation](https://developers.cloudflare.com/turnstile/get-started/client-side-rendering/#configurations).
```blade
Submit
```
This package can also integrate seamlessly with [Livewire](https://laravel-livewire.com). Upon successful validation, the property specified inside of `wire:model` will be updated with the Turnstile token.
```blade
```
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Ryan Chandler](https://github.com/ryangjchandler)
- [All contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.