CloudFlare's Turnstile For Laravel

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_SECRET_KEY="0x4AAAAAAAXXXXXXXXXXXXXX"

Create a config/turnstile.php

<?php
    return [
        'secret_key' => env('TURNSTILE_SECRET_KEY', null),
    ];

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 ($response['status'] == true) {
  // 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