From 8290cdb7e734679f093f100a23d161e65eba0bfb Mon Sep 17 00:00:00 2001
From: Marc Alexander <admin@m-a-styles.de>
Date: Sun, 13 Oct 2024 11:04:59 +0200
Subject: [PATCH] [ticket/17413] Make turnstile captcha work on registration
 page

PHPBB-17413
---
 .../adm/style/captcha_turnstile_acp_demo.html |   2 +-
 phpBB/language/en/captcha_turnstile.php       |  13 +-
 phpBB/phpbb/captcha/plugins/base.php          |  19 +++
 .../phpbb/captcha/plugins/legacy_wrapper.php  |   8 ++
 .../captcha/plugins/plugin_interface.php      |   7 +
 phpBB/phpbb/captcha/plugins/turnstile.php     | 123 ++++++++++--------
 .../prosilver/template/captcha_turnstile.html |  12 ++
 7 files changed, 127 insertions(+), 57 deletions(-)
 create mode 100644 phpBB/styles/prosilver/template/captcha_turnstile.html

diff --git a/phpBB/adm/style/captcha_turnstile_acp_demo.html b/phpBB/adm/style/captcha_turnstile_acp_demo.html
index 5d21532783..348e96967a 100644
--- a/phpBB/adm/style/captcha_turnstile_acp_demo.html
+++ b/phpBB/adm/style/captcha_turnstile_acp_demo.html
@@ -1,7 +1,7 @@
 <dl>
 	<dt><div id="captcha_turnstile"></div></dt>
 </dl>
-{% INCLUDEJS 'https://challenges.cloudflare.com/turnstile/v0/api.js' %}
+{% INCLUDEJS U_TURNSTILE_SCRIPT %}
 <script>
 	function domReady(callBack) {
 		if (document.readyState === 'loading') {
diff --git a/phpBB/language/en/captcha_turnstile.php b/phpBB/language/en/captcha_turnstile.php
index 0b60867dd1..0fcf2c43d8 100644
--- a/phpBB/language/en/captcha_turnstile.php
+++ b/phpBB/language/en/captcha_turnstile.php
@@ -37,9 +37,12 @@ if (empty($lang) || !is_array($lang))
 // in a url you again do not need to specify an order e.g., 'Click %sHERE%s' is fine
 
 $lang = array_merge($lang, [
-	'CAPTCHA_TURNSTILE'					=> 'Turnstile',
-	'CAPTCHA_TURNSTILE_SITEKEY'			=> 'Sitekey',
-	'CAPTCHA_TURNSTILE_SITEKEY_EXPLAIN'	=> 'Your Turnstile sitekey. The sitekey can be retrieved from your <a href="https://dash.cloudflare.com/?to=/:account/turnstile">Cloudflare dashboard</a>.',
-	'CAPTCHA_TURNSTILE_SECRET'			=> 'Secret key',
-	'CAPTCHA_TURNSTILE_SECRET_EXPLAIN'	=> 'Your Turnstile secret key. The secret key can be retrieved from your <a href="https://dash.cloudflare.com/?to=/:account/turnstile">Cloudflare dashboard</a>.',
+	'CAPTCHA_TURNSTILE'						=> 'Turnstile',
+	'CAPTCHA_TURNSTILE_INCORRECT'			=> 'The solution you provided was incorrect',
+	'CAPTCHA_TURNSTILE_NOSCRIPT'			=> 'Please enable JavaScript in your browser to load the challenge.',
+	'CAPTCHA_TURNSTILE_SECRET'				=> 'Secret key',
+	'CAPTCHA_TURNSTILE_SECRET_EXPLAIN'		=> 'Your Turnstile secret key. The secret key can be retrieved from your <a href="https://dash.cloudflare.com/?to=/:account/turnstile">Cloudflare dashboard</a>.',
+	'CAPTCHA_TURNSTILE_SITEKEY'				=> 'Sitekey',
+	'CAPTCHA_TURNSTILE_SITEKEY_EXPLAIN'		=> 'Your Turnstile sitekey. The sitekey can be retrieved from your <a href="https://dash.cloudflare.com/?to=/:account/turnstile">Cloudflare dashboard</a>.',
+	'CAPTCHA_TURNSTILE_NOT_AVAILABLE'		=> 'In order to use Turnstile you must create a <a href="https://www.cloudflare.com/products/turnstile/">Cloudflare account</a>.',
 ]);
diff --git a/phpBB/phpbb/captcha/plugins/base.php b/phpBB/phpbb/captcha/plugins/base.php
index 2b07ccaa64..be3b77ade1 100644
--- a/phpBB/phpbb/captcha/plugins/base.php
+++ b/phpBB/phpbb/captcha/plugins/base.php
@@ -19,6 +19,9 @@ abstract class base implements plugin_interface
 	/** @var string Confirm id hash */
 	protected string $confirm_id = '';
 
+	/** @var string Last error message */
+	protected string $last_error = '';
+
 	/**
 	 * Constructor for abstract captcha base class
 	 *
@@ -29,6 +32,22 @@ abstract class base implements plugin_interface
 		$this->db = $db;
 	}
 
+	/**
+	 * {@inheritDoc}
+	 */
+	public function is_solved(): bool
+	{
+		return $this->solved;
+	}
+
+	/**
+	 * {@inheritDoc}
+	 */
+	public function get_error(): string
+	{
+		return $this->last_error;
+	}
+
 	/**
 	 * @inheritDoc
 	 */
diff --git a/phpBB/phpbb/captcha/plugins/legacy_wrapper.php b/phpBB/phpbb/captcha/plugins/legacy_wrapper.php
index bc317e711a..48b91ef3d2 100644
--- a/phpBB/phpbb/captcha/plugins/legacy_wrapper.php
+++ b/phpBB/phpbb/captcha/plugins/legacy_wrapper.php
@@ -118,6 +118,14 @@ class legacy_wrapper implements plugin_interface
 		return false;
 	}
 
+	/**
+	 * {@inheritDoc}
+	 */
+	public function get_error(): string
+	{
+		return $this->last_error;
+	}
+
 	/**
 	 * {@inheritDoc}
 	 */
diff --git a/phpBB/phpbb/captcha/plugins/plugin_interface.php b/phpBB/phpbb/captcha/plugins/plugin_interface.php
index ee2ba8461d..bc20b2e703 100644
--- a/phpBB/phpbb/captcha/plugins/plugin_interface.php
+++ b/phpBB/phpbb/captcha/plugins/plugin_interface.php
@@ -73,6 +73,13 @@ interface plugin_interface
 	 */
 	public function validate(): bool;
 
+	/**
+	 * Get error string from captcha
+	 *
+	 * @return string Error string, empty string if there is no error
+	 */
+	public function get_error(): string;
+
 	/**
 	 * Return whether captcha was solved
 	 *
diff --git a/phpBB/phpbb/captcha/plugins/turnstile.php b/phpBB/phpbb/captcha/plugins/turnstile.php
index 210ae03610..0e56a340e4 100644
--- a/phpBB/phpbb/captcha/plugins/turnstile.php
+++ b/phpBB/phpbb/captcha/plugins/turnstile.php
@@ -13,6 +13,8 @@
 
 namespace phpbb\captcha\plugins;
 
+use GuzzleHttp\Client;
+use GuzzleHttp\Exception\GuzzleException;
 use phpbb\config\config;
 use phpbb\db\driver\driver;
 use phpbb\db\driver\driver_interface;
@@ -24,7 +26,11 @@ use phpbb\user;
 
 class turnstile extends base
 {
-	private const API_ENDPOINT = 'https://api.cloudflare.com/client/v4/captcha/validate';
+	/** @var string URL to cloudflare turnstile API javascript */
+	private const SCRIPT_URL = 'https://challenges.cloudflare.com/turnstile/v0/api.js';
+
+	/** @var string API endpoint for turnstile verification */
+	private const VERIFY_ENDPOINT = 'https://challenges.cloudflare.com/turnstile/v0/siteverify';
 
 	/** @var config */
 	protected config $config;
@@ -70,19 +76,28 @@ class turnstile extends base
 		$this->user = $user;
 	}
 
+	/**
+	 * {@inheritDoc}
+	 */
 	public function is_available(): bool
 	{
-		$this->language->add_lang('captcha_turnstile');
+		$this->init(0);
 
 		return !empty($this->config->offsetGet('captcha_turnstile_sitekey'))
 			&& !empty($this->config->offsetGet('captcha_turnstile_secret'));
 	}
 
+	/**
+	 * {@inheritDoc}
+	 */
 	public function has_config(): bool
 	{
 		return true;
 	}
 
+	/**
+	 * {@inheritDoc}
+	 */
 	public function get_name(): string
 	{
 		return 'CAPTCHA_TURNSTILE';
@@ -96,11 +111,17 @@ class turnstile extends base
 		$this->service_name = $name;
 	}
 
+	/**
+	 * {@inheritDoc}
+	 */
 	public function init(int $type): void
 	{
 		$this->language->add_lang('captcha_turnstile');
 	}
 
+	/**
+	 * {@inheritDoc}
+	 */
 	public function get_hidden_fields(): array
 	{
 		$hidden_fields = [];
@@ -114,70 +135,55 @@ class turnstile extends base
 		return $hidden_fields;
 	}
 
+	/**
+	 * {@inheritDoc}
+	 */
 	public function validate(): bool
 	{
-		// Implement server-side validation logic here
-		// Example: Validate the submitted CAPTCHA value using Cloudflare API
-
-		// Your Cloudflare API credentials
-		$api_email = 'your_email@example.com';
-		$api_key = 'your_api_key';
-
-		// Cloudflare API endpoint for CAPTCHA verification
-		$endpoint = 'https://api.cloudflare.com/client/v4/captcha/validate';
-
-		// CAPTCHA data to be sent in the request
-		$data = [
-			'email' => $api_email,
-			'key' => $api_key,
-			'response' => $this->confirm_code
+		// Retrieve form data for verification
+		$form_data = [
+			'secret'			=> $this->config['captcha_turnstile_secret'],
+			'response'			=> $this->request->variable('cf-turnstile-response', ''),
+			'remoteip'			=> $this->request->header('CF-Connecting-IP'),
+			//'idempotency_key'	=> $this->confirm_id, // check if we need this
 		];
 
-		// Initialize cURL session
-		$ch = curl_init();
+		// Create guzzle client
+		$client = new Client();
 
-		// Set cURL options
-		curl_setopt_array($ch, [
-			CURLOPT_URL => $endpoint,
-			CURLOPT_POST => true,
-			CURLOPT_POSTFIELDS => json_encode($data),
-			CURLOPT_HTTPHEADER => [
-				'Content-Type: application/json',
-				'Accept: application/json'
-			],
-			CURLOPT_RETURNTRANSFER => true
-		]);
-
-		// Execute the cURL request
-		$response = curl_exec($ch);
-
-		// Check for errors
-		if ($response === false) {
-			// Handle cURL error
-			curl_close($ch);
+		// Check captcha with turnstile API
+		try
+		{
+			$response = $client->request('POST', self::VERIFY_ENDPOINT, [
+				'form_params' => $form_data,
+			]);
+		}
+		catch (GuzzleException)
+		{
+			// Something went wrong during the request to Cloudflare, assume captcha was bad
+			$this->solved = false;
 			return false;
 		}
 
 		// Decode the JSON response
-		$result = json_decode($response, true);
+		$result = json_decode($response->getBody(), true);
 
 		// Check if the response indicates success
-		if (isset($result['success']) && $result['success'] === true) {
-			// CAPTCHA validation passed
-			curl_close($ch);
+		if (isset($result['success']) && $result['success'] === true)
+		{
+			$this->solved = true;
 			return true;
-		} else {
-			// CAPTCHA validation failed
-			curl_close($ch);
+		}
+		else
+		{
+			$this->last_error = $this->language->lang('CAPTCHA_TURNSTILE_INCORRECT');
 			return false;
 		}
 	}
 
-	public function is_solved(): bool
-	{
-		return false;
-	}
-
+	/**
+	 * {@inheritDoc}
+	 */
 	public function reset(): void
 	{
 		// TODO: Implement reset() method.
@@ -191,11 +197,26 @@ class turnstile extends base
 
 	public function get_template(): string
 	{
-		return 'custom_captcha.html'; // Template file for displaying the CAPTCHA
+		if ($this->is_solved())
+		{
+			return '';
+		}
+
+		$this->template->assign_vars([
+			'S_TURNSTILE_AVAILABLE'	=> $this->is_available(),
+			'TURNSTILE_SITEKEY'		=> $this->config->offsetGet('captcha_turnstile_sitekey'),
+			'U_TURNSTILE_SCRIPT'	=> self::SCRIPT_URL,
+		]);
+
+		return 'captcha_turnstile.html';
 	}
 
 	public function get_demo_template(): string
 	{
+		$this->template->assign_vars([
+			'U_TURNSTILE_SCRIPT'	=> self::SCRIPT_URL,
+		]);
+
 		return 'captcha_turnstile_acp_demo.html';
 	}
 
diff --git a/phpBB/styles/prosilver/template/captcha_turnstile.html b/phpBB/styles/prosilver/template/captcha_turnstile.html
new file mode 100644
index 0000000000..f13d1fa882
--- /dev/null
+++ b/phpBB/styles/prosilver/template/captcha_turnstile.html
@@ -0,0 +1,12 @@
+{% if S_TURNSTILE_AVAILABLE %}
+	<noscript>
+		<div>{{ lang('CAPTCHA_TURNSTILE_NOSCRIPT') }}</div>
+	</noscript>
+
+	<script src="{{ U_TURNSTILE_SCRIPT }}" async defer></script>
+
+	{# The cf-turnstile class is used in JavaScript #}
+	<div class="cf-turnstile" data-sitekey="{{ TURNSTILE_SITEKEY }}"></div>
+{% else %}
+	{{ lang('CAPTCHA_TURNSTILE_NOT_AVAILABLE') }}
+{% endif %}