akrabat/proxy-detection-middleware

PSR-7/PSR-15 Middleware that determines the scheme, host and port from the 'X-Forwarded-Proto', 'X-Forwarded-Host' and 'X-Forwarded-Port' headers and updates the Request's Uri object.

1.1 2024-11-21 19:16 UTC

Requires

• psr/http-message: ^1.0 || ^2.0
• psr/http-server-middleware: ^1.0

Requires (Dev)

• php: ^8.0
• laminas/laminas-diactoros: ^2.24
• phpunit/phpunit: ^9.6
• squizlabs/php_codesniffer: ^3.7

BSD-3-Clause

• Rob Allen

• middleware
• IP
• psr7

README

PSR-15 Middleware that determines the scheme, host and port from the 'X-Forwarded-Proto', 'X-Forwarded-Host' and 'X-Forwarded-Port' headers and updates the Request's Uri object.

You can set a list of proxies that are trusted as the second constructor parameter. If this list is set, then the proxy headers will only be checked if the REMOTE_ADDR is in the trusted list.

Installation

composer require akrabat/proxy-detection-middleware

Usage

In Slim 3:

$trustedProxies = ['10.0.0.1', '10.0.0.2'];
$app->add(new RKA\Middleware\ProxyDetection($trustedProxies));

$app->get('/', function ($request, $response, $args) {
    $scheme = $request->getUri()->getScheme();
    $host = $request->getUri()->getHost();
    $port = $request->getUri()->getPort();

    return $response;
});

Testing

• Code coverage: $ vendor/bin/phpcs
• Unit tests: $ vendor/bin/phpunit
• Code coverage: $ vendor/bin/phpunit --coverage-html ./build