Merge pull request #291 from dotkernel/issue-290

Refactored ReCaptcha logic

Author: arhimede

composer.json

@@ -44,6 +44,8 @@
     },
     "require": {
         "php": "^7.4 || ~8.0.0 || ~8.1.0",
+        "ext-curl": "*",
+        "ext-json": "*",
         "dotkernel/dot-annotated-services": "^3.2.1",
         "dotkernel/dot-authorization": "^3.2.0",
         "dotkernel/dot-controller": "^3.2.1",

config/autoload/local.php.dist

@@ -76,8 +76,10 @@ return [
         'base_dir' => getcwd() . '/data/language',
     ],
     'recaptcha' => [
+        'scoreThreshold' => (float) 0.5,
         'siteKey' => '',
-        'secretKey' => ''
+        'secretKey' => '',
+        'verifyUrl' => 'https://www.google.com/recaptcha/api/siteverify'
     ],
 
     'rememberMe' => [

src/App/src/ConfigProvider.php

@@ -4,16 +4,17 @@
 
 namespace Frontend\App;
 
-use ContainerInteropDoctrine\EntityManagerFactory;
 use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\EntityManagerInterface;
 use Dot\AnnotatedServices\Factory\AnnotatedServiceFactory;
 use Frontend\App\Controller\LanguageController;
 use Frontend\App\Factory\EntityListenerResolverFactory;
 use Frontend\App\Resolver\EntityListenerResolver;
+use Frontend\App\Service\RecaptchaService;
 use Frontend\App\Service\TranslateService;
 use Frontend\App\Service\TranslateServiceInterface;
 use Mezzio\Application;
+use Roave\PsrContainerDoctrine\EntityManagerFactory;
 
 /**
  * The configuration provider for the App module
@@ -56,6 +57,7 @@ public function getDependencies(): array
                 EntityListenerResolver::class => EntityListenerResolverFactory::class,
                 TranslateService::class => AnnotatedServiceFactory::class,
                 LanguageController::class => AnnotatedServiceFactory::class,
+                RecaptchaService::class => AnnotatedServiceFactory::class,
             ],
             'aliases' => [
                 EntityManager::class => 'doctrine.entity_manager.orm_default',
@@ -68,7 +70,7 @@ public function getDependencies(): array
     /**
      * @return array
      */
-    public function getDoctrineConfig()
+    public function getDoctrineConfig(): array
     {
         return [
             'configuration' => [

src/App/src/Service/RecaptchaService.php

@@ -0,0 +1,95 @@
+<?php
+
+
+namespace Frontend\App\Service;
+
+use Dot\AnnotatedServices\Annotation\Inject;
+use Fig\Http\Message\StatusCodeInterface;
+use InvalidArgumentException;
+
+/**
+ * Class RecaptchaService
+ * @package Frontend\App\Service
+ */
+class RecaptchaService
+{
+    private array $config;
+
+    private string $response;
+
+    /**
+     * RecaptchaService constructor.
+     * @param array $config
+     *
+     * @Inject({"config.recaptcha"})
+     */
+    public function __construct(array $config)
+    {
+        $this->validateConfig($config);
+
+        $this->config = $config;
+    }
+
+    /**
+     * @param string $response
+     * @return $this
+     */
+    public function setResponse(string $response): self
+    {
+        $this->response = $response;
+
+        return $this;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isValid(): bool
+    {
+        if (! isset($this->response)) {
+            throw new InvalidArgumentException('Recaptcha response not initialized.');
+        }
+
+        $data = [
+            'secret' => $this->config['secretKey'],
+            'response' => $this->response,
+        ];
+
+        $curl = curl_init();
+
+        curl_setopt($curl, CURLOPT_POST, true);
+        curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, true);
+        curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
+        curl_setopt($curl, CURLOPT_URL, $this->config['verifyUrl']);
+        curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));
+
+        $response = curl_exec($curl);
+        $response = json_decode($response, true);
+        $statusCode = curl_getinfo($curl, CURLINFO_HTTP_CODE);
+
+        if ($statusCode !== StatusCodeInterface::STATUS_OK) {
+            return false;
+        }
+
+        $success = $response['success'] ?? false;
+        $score = $response['score'] ?? 0;
+
+        return $success && $score > $this->config['scoreThreshold'];
+    }
+
+    private function validateConfig(array $config): void
+    {
+        $keysToValidate = ['siteKey', 'secretKey', 'verifyUrl', 'scoreThreshold'];
+        foreach ($keysToValidate as $key) {
+            if (empty($config[$key])) {
+                throw new InvalidArgumentException("Invalid `{$key}` provided.");
+            }
+        }
+
+        if (! is_float($config['scoreThreshold']) || $config['scoreThreshold'] < 0 || $config['scoreThreshold'] > 1) {
+            throw new InvalidArgumentException(
+                "Invalid `{$key}` provided. The value must be a float between 0.0 and 1.0"
+            );
+        }
+    }
+}

src/Contact/src/Controller/ContactController.php

@@ -9,6 +9,7 @@
 use Dot\FlashMessenger\FlashMessenger;
 use Dot\Mail\Exception\MailException;
 use Fig\Http\Message\RequestMethodInterface;
+use Frontend\App\Service\RecaptchaService;
 use Frontend\Contact\Form\ContactForm;
 use Frontend\Contact\Service\MessageService;
 use Frontend\Plugin\FormsPlugin;
@@ -31,6 +32,9 @@ class ContactController extends AbstractActionController
     /** @var MessageService $messageService */
     protected MessageService $messageService;
 
+    /** @var RecaptchaService $recaptchaService */
+    protected RecaptchaService $recaptchaService;
+
     /** @var AuthenticationServiceInterface $authenticationService */
     protected AuthenticationServiceInterface $authenticationService;
 
@@ -46,13 +50,16 @@ class ContactController extends AbstractActionController
     /**
      * UserController constructor.
      * @param MessageService $messageService
+     * @param RecaptchaService $recaptchaService
      * @param RouterInterface $router
      * @param TemplateRendererInterface $template
      * @param AuthenticationService $authenticationService
      * @param FlashMessenger $messenger
      * @param FormsPlugin $forms
+     * @param array $config
      * @Inject({
      *     MessageService::class,
+     *     RecaptchaService::class,
      *     RouterInterface::class,
      *     TemplateRendererInterface::class,
      *     AuthenticationService::class,
@@ -63,6 +70,7 @@ class ContactController extends AbstractActionController
      */
     public function __construct(
         MessageService $messageService,
+        RecaptchaService $recaptchaService,
         RouterInterface $router,
         TemplateRendererInterface $template,
         AuthenticationService $authenticationService,
@@ -71,6 +79,7 @@ public function __construct(
         array $config = []
     ) {
         $this->messageService = $messageService;
+        $this->recaptchaService = $recaptchaService;
         $this->router = $router;
         $this->template = $template;
         $this->authenticationService = $authenticationService;
@@ -94,9 +103,9 @@ public function formAction(): ResponseInterface
             $data = $request->getParsedBody();
             //check recaptcha
             if (isset($data['g-recaptcha-response'])) {
-                if (!$this->messageService->recaptchaIsValid($data['g-recaptcha-response'])) {
+                if (! $this->recaptchaService->setResponse($data['g-recaptcha-response'])->isValid()) {
                     unset($data['g-recaptcha-response']);
-                    $this->messenger->addError('Wrong recaptcha');
+                    $this->messenger->addError('Captcha verification failed. Please try again.');
                     return new RedirectResponse($request->getUri(), 303);
                 }
             } else {

src/Contact/src/Service/MessageService.php

@@ -7,7 +7,6 @@
 use Frontend\Contact\Entity\Message;
 use Frontend\Contact\Repository\MessageRepository;
 use Doctrine\ORM\EntityManager;
-use Doctrine\ORM\EntityNotFoundException;
 use Dot\AnnotatedServices\Annotation\Inject;
 use Dot\Mail\Exception\MailException;
 use Dot\Mail\Service\MailService;