README

A Laravel package to facilitate the server side validation of Cloudflare's Turnstile captcha service.

Configuration

First you'll need an account Cloudflare and Turnstile setup for your website.

https://developers.cloudflare.com/turnstile/

Installation

Install via composer

composer require derekcodes/turnstile-laravel

Adding your secret key in the .env file

TURNSTILE_SITE_KEY="0x4AAAAAAAXXXXXXXXXXXXXX"
TURNSTILE_SECRET_KEY="0x4AAAAAAAXXXXXXXXXXXXXX"

Create a config/turnstile.php

php artisan vendor:publish --tag=turnstile-config

Front-end

Be sure to add the front-end JavaScript from Turnstile: https://developers.cloudflare.com/turnstile/get-started/client-side-rendering/

To save you some time, here's the Turnstile JavaScript necessary for an HTML form. Note that I assume you're using a Blade template, thus the {{ config('turnstile.site_key') }}.

<script src="https://challenges.cloudflare.com/turnstile/v0/api.js?onload=onloadTurnstileCallback" defer></script>

window.onloadTurnstileCallback = function () {
    turnstile.render('#your-form-id', {
        sitekey: '{{ config('turnstile.site_key') }}',
        callback: function(token) {
            console.log(`Challenge Success ${token}`);
        },
    });
};

Usage

Add the use statement at the top of your file

use DerekCodes\TurnstileLaravel\TurnstileLaravel;

Initiate the TursileLaravel object and call the validate method passing the client response Turnstile's JavaScript provides

$turnstile = new TurnstileLaravel;
$response = $turnstile->validate($request->get('cf-turnstile-response'));

Ensure the response is valid

if (get_data($response, 'status', 0) == 1) {
  // TODO: add success code here
}

Responses

Example success response

{
  "status": 1
}

Example error response

{
  "status": 0,
  "turnstile_response": {
    "success": false,
    "error-codes": [
      "invalid-input-response"
    ],
    "messages": []
  }
}

Credits

~ Derek Codes

Website: https://www.derekcodes.io
Twitter: https://twitter.com/DerekCodes_io

Derek Codes is a comprehensive collection of tutorials on the most popular languages in the industry. You’ll find videos, guides and downloadable assets to help you learn to code PHP, Laravel, JavaScript, CSS and more. Thanks for watching!

derekcodes / turnstile-laravel

Maintainers

Details