get ip address using akr middleware

Author: OStefan2001

composer.json

@@ -29,6 +29,7 @@
         "php": "~8.5.0",
         "ext-curl": "*",
         "ext-dom": "*",
+        "akrabat/ip-address-middleware": "^2.6",
         "doctrine/data-fixtures": "^2.2",
         "doctrine/doctrine-fixtures-bundle": "^4.3",
         "dotkernel/dot-cache": "^4.0",

config/autoload/ip-address.global.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+    'rka' => [
+        'ip_address' => [
+            'check_proxy_headers' => false,
+            'trusted_proxies'     => [],
+            'attribute_name'      => 'ip_address',
+            'headers_to_inspect'  => [],
+        ],
+    ],
+];

config/autoload/ip_address.global.php

@@ -23,6 +23,7 @@
     \Mezzio\Router\ConfigProvider::class,
     \Mezzio\Router\FastRouteRouter\ConfigProvider::class,
     \Mezzio\Twig\ConfigProvider::class,
+    \RKA\Middleware\Mezzio\ConfigProvider::class,
 
     // Dotkernel packages
     \Dot\DependencyInjection\ConfigProvider::class,

config/config.php

@@ -4,7 +4,6 @@
 
 use Dot\ErrorHandler\ErrorHandlerInterface;
 use Dot\ResponseHeader\Middleware\ResponseHeaderMiddleware;
-use Light\App\Middleware\IpAddressMiddleware;
 use Mezzio\Application;
 use Mezzio\Handler\NotFoundHandler;
 use Mezzio\Helper\ServerUrlMiddleware;
@@ -14,13 +13,13 @@
 use Mezzio\Router\Middleware\ImplicitOptionsMiddleware;
 use Mezzio\Router\Middleware\MethodNotAllowedMiddleware;
 use Mezzio\Router\Middleware\RouteMiddleware;
+use RKA\Middleware\IpAddress;
 
 return function (Application $app): void {
     // The error handler should be the first (most outer) middleware to catch
     // all Exceptions.
     $app->pipe(ErrorHandlerInterface::class);
     $app->pipe(ServerUrlMiddleware::class);
-    $app->pipe(IpAddressMiddleware::class);
 
     // Pipe more middleware here that you want to execute on every request:
     // - bootstrapping
@@ -65,6 +64,8 @@
     // - route-based validation
     // - etc.
 
+    $app->pipe(IpAddress::class);
+
     // Register the dispatch middleware in the middleware pipeline
     $app->pipe(DispatchMiddleware::class);
 

config/pipeline.php

@@ -33,7 +33,6 @@
 use Light\App\Handler\GetPackagesViewHandler;
 use Light\App\Handler\GetSitemapViewHandler;
 use Light\App\Handler\PostCreateContactHandler;
-use Light\App\Middleware\IpAddressMiddleware;
 use Light\App\Resolver\EntityListenerResolver;
 use Light\App\Service\ContactService;
 use Light\App\Service\FeedGenerator;
@@ -150,7 +149,6 @@ public function getDependencies(): array
                 GetCreateContactFormHandler::class    => AttributedServiceFactory::class,
                 PostCreateContactHandler::class       => AttributedServiceFactory::class,
                 ContactService::class                 => AttributedServiceFactory::class,
-                IpAddressMiddleware::class            => AttributedServiceFactory::class,
                 FeedGenerator::class                  => FeedGeneratorFactory::class,
                 SitemapGenerator::class               => SitemapGeneratorFactory::class,
                 GitHubClient::class                   => GitHubClientFactory::class,

src/App/src/ConfigProvider.php

@@ -8,7 +8,6 @@
 use Laminas\Diactoros\Response\HtmlResponse;
 use Laminas\Diactoros\Response\RedirectResponse;
 use Light\App\Enum\ContactTopicEnum;
-use Light\App\Middleware\IpAddressMiddleware;
 use Light\App\Service\ContactService;
 use Mezzio\Helper\UrlHelper;
 use Mezzio\Template\TemplateRendererInterface;
@@ -43,13 +42,13 @@ public function handle(ServerRequestInterface $request): ResponseInterface
         $token   = is_array($rawBody) && is_string($rawBody['cf-turnstile-response'] ?? null)
             ? $rawBody['cf-turnstile-response']
             : '';
-        $ip      = $request->getAttribute(IpAddressMiddleware::ATTRIBUTE);
+        $ip      = $request->getAttribute('ip_address');
 
-        if (! $this->contactService->verifyTurnstile($token, is_string($ip) ? $ip : null)) {
+        if (! $this->contactService->verifyTurnstile($token, $ip)) {
             $errors['captcha'] = "We couldn't verify you're human. Please try again.";
         }
 
-        if ($errors === [] && ! $this->contactService->send($data)) {
+        if ($errors === [] && ! $this->contactService->send($data, $ip)) {
             $mailFailed = true;
         }
 

src/App/src/Handler/PostCreateContactHandler.php

@@ -176,11 +176,11 @@ public function validate(array $data): array
     /**
      * @param ContactData $data
      */
-    public function send(array $data): bool
+    public function send(array $data, ?string $ipAddress = null): bool
     {
         $this->mailService->getMessage()->setReplyTo($data['email'], $data['name']);
         $this->mailService->setSubject('New contact form submission on dotkernel.com');
-        $this->mailService->setBody($this->buildBody($data));
+        $this->mailService->setBody($this->buildBody($data, $ipAddress));
 
         try {
             $result = $this->mailService->send();
@@ -237,7 +237,7 @@ private function stringValue(array $raw, string $key): string
     /**
      * @param ContactData $data
      */
-    private function buildBody(array $data): string
+    private function buildBody(array $data, ?string $ipAddress): string
     {
         $rows = [
             'Topic'         => ContactTopicEnum::tryFrom($data['topic'])?->label() ?? '',
@@ -247,6 +247,7 @@ private function buildBody(array $data): string
             'Current stack' => $data['stack'],
             'Message'       => $data['message'],
             'Query params'  => $data['query'],
+            'IP address'    => $ipAddress ?? '',
         ];
 
         $html = '';

src/App/src/Middleware/IpAddressMiddleware.php

@@ -12,7 +12,6 @@
 use Laminas\Diactoros\Response\RedirectResponse;
 use Light\App\Enum\ContactTopicEnum;
 use Light\App\Handler\PostCreateContactHandler;
-use Light\App\Middleware\IpAddressMiddleware;
 use Light\App\Service\ContactService;
 use Mezzio\Helper\UrlHelper;
 use Mezzio\Template\TemplateRendererInterface;
@@ -198,7 +197,7 @@ public function testFailedTurnstileRerendersWithCaptchaErrorAndSendsNothing(): v
 
         $request = $this->createStub(ServerRequestInterface::class);
         $request->method('getParsedBody')->willReturn($data);
-        $request->method('getAttribute')->willReturnMap([[IpAddressMiddleware::ATTRIBUTE, null, '203.0.113.5']]);
+        $request->method('getAttribute')->willReturnMap([['ip_address', null, '203.0.113.5']]);
 
         $contactService = $this->createMock(ContactService::class);
         $contactService->method('normalize')->willReturn([
@@ -239,4 +238,43 @@ public function testFailedTurnstileRerendersWithCaptchaErrorAndSendsNothing(): v
         $this->assertInstanceOf(HtmlResponse::class, $response);
         $this->assertSame(200, $response->getStatusCode());
     }
+
+    /**
+     * @throws Exception
+     */
+    public function testValidSubmissionSendsTheIpAddressFromTheRequestAttribute(): void
+    {
+        $request = $this->createStub(ServerRequestInterface::class);
+        $request->method('getParsedBody')->willReturn($this->validData());
+        $request->method('getAttribute')->willReturnMap([['ip_address', null, '203.0.113.5']]);
+
+        $contactService = $this->createMock(ContactService::class);
+        $contactService->method('normalize')->willReturn([
+            'topic'   => 'migration',
+            'name'    => 'Jane Doe',
+            'email'   => 'jane@example.com',
+            'company' => 'Acme Inc',
+            'stack'   => 'ZF3, PHP 7.4',
+            'message' => 'We would like to talk about migrating our platform.',
+            'query'   => '',
+        ]);
+        $contactService->method('validate')->willReturn([]);
+        $contactService->method('verifyTurnstile')->willReturn(true);
+        $contactService
+            ->expects($this->once())
+            ->method('send')
+            ->with($this->anything(), '203.0.113.5')
+            ->willReturn(true);
+
+        $urlHelper = $this->createStub(UrlHelper::class);
+        $urlHelper->method('generate')->willReturn('/contact/?contact=sent#contact-form');
+
+        $response = (new PostCreateContactHandler(
+            $this->createStub(TemplateRendererInterface::class),
+            $urlHelper,
+            $contactService
+        ))->handle($request);
+
+        $this->assertInstanceOf(RedirectResponse::class, $response);
+    }
 }