Skip to content

Latest commit

 

History

1 Commit

Folders and files

Repository files navigation

Cloudflare Turnstile solver in PHP

CI

Solve Cloudflare Turnstile in PHP: a tested example that gets a Cloudflare Turnstile token from the ZeroCaptcha API with the curl extension, retries and a deadline. No Composer packages, PHP 8.1+.

Website · Docs · Quickstart · API reference · Pricing

What it does

TurnstileSolver gets a valid Cloudflare Turnstile token for a page you are allowed to automate, and solve-turnstile.php prints one from the command line. You give it the page's URL and the widget's sitekey; it creates a task on the ZeroCaptcha API, waits for it, and returns the token to submit as the browser would.

  • No Composer packages: the curl and json extensions, as most PHP installs have them. PHP 8.1 or later.
  • Safe to retry: every task is created with its own Idempotency-Key, so a retry after a lost reply returns the same task instead of paying for a second one. 429, 502, 503 and 504 are retried after the wait the API asks for.
  • Bounded: polls every 2 seconds and stops at a deadline you set (3 minutes by default).
  • Clear failures: a refusal or a failed task throws ZeroCaptchaException with the API's errorCode, such as insufficient_funds or ERROR_CAPTCHA_UNSOLVABLE, and the requestId to quote to support.

Quickstart

  1. Create an account on the ZeroCaptcha website, create an API key on the dashboard and add funds (crypto, from $10). A task is charged only when it succeeds.

  2. Put the API's address and your key in your environment, never in your code:

    export ZEROCAPTCHA_API=https://api.zerocaptcha.io
    export ZEROCAPTCHA_KEY=zc_live_...
  3. Read the widget's data-sitekey, and its data-action and data-cdata if it sets them (the sitekey guide shows where else they hide, such as the options of turnstile.render()), then run:

    php solve-turnstile.php https://shop.example.com/login 0x4AAAAAAAB1cD2eF3gH4iJ5 login session-7f3a9c2e

    Many sites check the action and cData when they verify the token, so pass both whenever the widget sets them.

    It prints the token. Set PROXY_URL=http://user:pass@proxy.example.net:8080 to solve through your own proxy.

Use it in your code

<?php
require __DIR__ . '/src/TurnstileSolver.php';

$solver = new TurnstileSolver(getenv('ZEROCAPTCHA_API'), getenv('ZEROCAPTCHA_KEY'));
try {
    $token = $solver->solve(
        'https://shop.example.com/login',
        '0x4AAAAAAAB1cD2eF3gH4iJ5',
        // The widget's data-action and data-cdata, or turnstile.render()'s action and cData
        // options; leave out any the widget does not set.
        action: 'login',
        cdata: 'session-7f3a9c2e',
        // proxy: 'http://user:pass@proxy.example.net:8080', // to solve through your own proxy
    );
} catch (ZeroCaptchaException $error) {
    error_log("{$error->errorCode} (request {$error->requestId})");
    throw $error;
}

Submit the token

The widget sends its token in the cf-turnstile-response form field, and the site checks it with Cloudflare's siteverify when the form arrives. Send yours the same way, straight after you get it:

<?php
$curl = curl_init('https://shop.example.com/login');
curl_setopt_array($curl, [
    CURLOPT_POSTFIELDS => http_build_query([
        'email' => 'me@example.com',
        'cf-turnstile-response' => $token,
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$page = curl_exec($curl);

On WordPress sites the widget usually comes from a plugin; the WordPress article shows where each one puts the sitekey.

How it works

  1. POST /v1/tasks with the page, the sitekey, and the action and cData if the widget sets them. The task's price is held on your balance.
  2. GET /v1/tasks/{id} every 2 seconds while the task is queued or running.
  3. succeeded carries solution.token, and the held price is charged. failed or expired carries an errorCode, and the hold is released: nothing is charged.

The task lifecycle and the errors and retries guide have every detail.

Honest limits

  • A token works once, for 300 seconds. Get it just before you submit, and a new one for the next submission.
  • The action and cData must match the widget's. A token made without them can be refused by the site's siteverify check.
  • Proxies are http or https, with the port in the URL. SOCKS is not supported.
  • The solve blocks for as long as the task runs, typically seconds. Run it in a queue worker or a CLI script, not inside a web request that has a short time limit.
  • Only for sites you own or are allowed to automate. The Acceptable Use Policy applies to every task.

FAQ

Is there a PHP SDK? Not yet: the official clients are for JavaScript, Python and Go. This class is small enough to copy into your project.

I already use a createTask or 2Captcha client in PHP. Do I need this? No: ZeroCaptcha also answers createTask and in.php, so your client works after you change its host and key. See createtask-api-migration.

What does a solve cost? The pricing page lists the price per 1,000 solved tasks. Only a task that succeeds is charged.

Why is my token refused by the site? Most often it was used twice, used after 300 seconds, or made without the widget's action or cData. The siteverify errors article explains each code.

Run the tests

php tests/run.php

The tests start a stand-in API on PHP's built-in server and run the solver and the command against it: no key, no real task, nothing spent.

More from ZeroCaptcha

Licence

MIT: see LICENSE.

Disclaimer

ZeroCaptcha is an independent service, not affiliated with or endorsed by Cloudflare. Cloudflare and Turnstile are trademarks of Cloudflare, Inc. Use ZeroCaptcha only on sites you own or are allowed to automate, as the Acceptable Use Policy says; any site owner can opt out.

About

Solve Cloudflare Turnstile in PHP: a tested example that gets a Cloudflare Turnstile token from the ZeroCaptcha API with the curl extension, retries and a deadline. No Composer packages, PHP 8.1+.

Topics

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages