包简介

A simple package to help integrate Cloudflare Turnstile.

README 文档

README

This packages provides an API integrating Laravel with Cloudflare's Turnstile product.

Installation

You can install the package via Composer:

composer require ryangjchandler/laravel-cloudflare-turnstile

You should then add the following configuration values to your config/services.php file:

return [

    // ...,

    'turnstile' => [
        'key' => env('TURNSTILE_SITE_KEY'),
        'secret' => env('TURNSTILE_SECRET_KEY'),
    ],

];

Create your Turnstile keys through Cloudflare 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 <x-turnstile.scripts> component. This should be added to the <head> of your document.

<html>
    <head>
        <x-turnstile.scripts />
    </head>
    <body>
        {{ $slot }}
    </body>
</html>

Once that's done, you can use the <x-turnstile /> component inside of a <form> to output the appropriate markup with your site key configured.

<form action="/" method="POST">
    <x-turnstile />

    <button>
        Submit
    </button>
</form>

To validate the Turnstile response, use the Turnstile rule when validating your request.

use Illuminate\Validation\Rule;
use RyanChandler\LaravelCloudflareTurnstile\Rules\Turnstile;

public function submit(Request $request)
{
    $request->validate([
        'cf-turnstile-response' => ['required', new Turnstile],
    ]);
}

Customizing the widget

You can customize the widget by passing attributes to the <x-turnstile /> component.

To learn more about these parameters, refer to the offical documentation.

<form action="/" method="POST">
    <x-turnstile
        data-action="login"
        data-cdata="sessionid-123456789"
        data-callback="callback"
        data-expired-callback="expiredCallback"
        data-error-callback="errorCallback"
        data-theme="dark"
        data-tabindex="1"
    />

    <button>
        Submit
    </button>
</form>

Livewire support

This package can also integrate seamlessly with Livewire.

You can use wire:model to bind the Turnstile response to a Livewire property directly.

<x-turnstile wire:model="yourModel" />

Multiple widgets with Livewire

If you're using Livewire and need to have multiple widgets on the same page, each widget requires a unique ID.

<x-turnstile id="my_widget" wire:model="captcha" />

The id property must match this RegEx: /^[a-zA-Z_][a-zA-Z0-9_-]*$/. IDs that do not match the RegEx will trigger an exception.

Writing tests

If you wish to write tests for your application that uses Turnstile, you can use the Turnstile facade to fake responses.

use RyanChandler\LaravelCloudflareTurnstile\Facades\Turnstile;

Turnstile::fake(): // Force a successful response.
Turnstile::fake()->fail(); // Force a failed response.
Turnstile::fake()->expired(); // Force an expired token response.

Instead of hardcoding the submitted Turnstile token, you can use the Turnstile::dummy() method to generate a dummy token.

post('/my-form', [
    'cf-turnstile-response' => Turnstile::dummy(),
])

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

ryangjchandler/laravel-cloudflare-turnstile 适用场景与选型建议

ryangjchandler/laravel-cloudflare-turnstile 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 1.18M 次下载、GitHub Stars 达 449，最近一次更新时间为 2022 年 09 月 30 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「laravel」「ryangjchandler」「laravel-cloudflare-turnstile」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 ryangjchandler/laravel-cloudflare-turnstile 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 ryangjchandler/laravel-cloudflare-turnstile 我们能提供哪些服务？

定制开发 / 二次开发

基于 ryangjchandler/laravel-cloudflare-turnstile 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

与 ryangjchandler/laravel-cloudflare-turnstile 相关的其它包

同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：

ryangjchandler/bearer 81

Minimalistic token-based authentication for Laravel API endpoints.

ryangjchandler/laravel-comments 221

A dead-simple comments package for Laravel.

digitonic/filament-navigation 0

Build structured navigation menus in Filament.

ryangjchandler/laravel-json-settings 31

Store your Laravel application settings in an on-disk JSON file.

ryangjchandler/filament-user-resource 14

A simple resource for managing users in Filament.

danieledesantis/laravel-cloudflare-turnstile-react-blade 1

Cloudflare Turnstile integration for Laravel with support for React, Inertia.js and Blade

ryangjchandler/laravel-cloudflare-turnstile

包简介

关键字：