hybula / whmcs-turnstile

Cloudflare's Turnstile captcha integration for WHMCS.
Other
12 stars 3 forks source link

WHMCS Turnstile Captcha

Enables Cloudflare's Turnstile Captcha service in abandonware WHMCS. This is currently a proof-of-concept, please report issues.

Introduction

By default WHMCS offers two types of captchas, the built-in-easily-cracked GD based captcha and the easily-cracked-privacy-violating reCAPTCHA by Google. Because WHMCS fails to maintain their product, we developed this simple to use hook which enables Turnstile while completely bypassing WHMCS' logic.

Please note that this implementation required some filthy JS query code to make it work, because WHMCS is a complete mess: in some pages they used HTML buttons for forms, on other pages they used input submits, with or without IDs, inside divs, without divs, no use of IDs. Meaning that there was no streamlined way to do this clean and proper. Here are some awkward examples:

<input class="btn btn-lg btn-primary" type="submit" value="Register">
<button id="login" type="submit" class="btn btn-primary">Login</button>
<button type="submit" name="validatepromo" class="btn btn-block btn-default" value="Validate Code">Validate Code</button>
<button type="submit" class="btn btn-primary">Send Message</button>
<a href="https://github.com/hybula/whmcs-turnstile/blob/main/cart.php?a=checkout&amp;e=false" class="btn btn-success btn-lg btn-checkout disabled" id="checkout">Checkout</a>

Features

Requirements

Installation

  1. Download the latest release and unzip it in the root of your WHMCS installation.
  2. Get your Turnstile Site Key and Secret Key from your Cloudflare dashboard.
  3. Edit and add the following settings in either your configuration.php or at the top of the hook file:
    const hybulaTurnstileEnabled = true;
    const hybulaTurnstileCredits = true;
    const hybulaTurnstileExcludeLogin = true;
    const hybulaTurnstileSite = '';
    const hybulaTurnstileSecret = '';
    const hybulaTurnstileTheme = 'auto';
    const hybulaTurnstileError = 'Something went wrong with your captcha challenge!';
    const hybulaTurnstileLocations = ['login', 'register', 'checkout', 'ticket', 'contact'];

Contribute

Contributions are welcome in a form of a pull request (PR).

Sponsored

This project is developed and sponsored by Hybula B.V.

License

Apache License, Version 2.0 and the Commons Clause Restriction