Skip to content

Fix #59: Parse comma-separated IP chains in non-RFC forwarded headers #60

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
samdark merged 1 commit into from
Aug 31, 2026
Merged

Fix #59: Parse comma-separated IP chains in non-RFC forwarded headers #60

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

## 1.0.3 under development

- Bug #59: Parse comma-separated IP chains in non-RFC forwarded headers (@samdark)
- Chg #44: Change PHP constraint in `composer.json` to `8.0 - 8.4` (@vjik)
- Enh #55: Explicitly import constants in "use" section (@vjik)

Expand Down
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,9 @@ one data unit (for example, IP). Headers with "X" prefix are quite common despit
The header groups are processed in the order they are defined. If the header containing IP is present and is non-empty,
this group will be selected and further ones will be ignored.

IP headers in array-based groups are parsed as comma-separated lists. Multiple values of the same header are combined
in their original order before the connection chain is resolved.

You can add support for custom headers and/or change priority:

```php
Expand Down
10 changes: 6 additions & 4 deletions src/TrustedHostsNetworkResolver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -547,17 +547,19 @@ private function getConnectionChainItems(string $remoteAddr, ServerRequestInterf
break;
}

/** @psalm-var list<string> $forwardedHeaderValue */
$forwardedHeaderValue = $request->getHeader($forwardedHeaderGroup['ip']);
if (empty($forwardedHeaderValue) || empty($request->getHeaderLine($forwardedHeaderGroup['ip']))) {
$forwardedHeaderValue = $request->getHeaderLine($forwardedHeaderGroup['ip']);
if ($forwardedHeaderValue === '') {
continue;
}

$items = [];
/**
* @psalm-var non-empty-list<string> $requestIps It needs for PHP 8.0 only
*/
$requestIps = array_merge([$remoteAddr], array_reverse($forwardedHeaderValue));
$requestIps = array_merge(
[$remoteAddr],
array_reverse(array_map('\trim', explode(',', $forwardedHeaderValue))),
);
foreach ($requestIps as $requestIp) {
$items[] = $this->getConnectionChainItem(
ip: $requestIp,
Expand Down
82 changes: 80 additions & 2 deletions tests/TrustedHostsNetworkResolver/ProcessTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -444,6 +444,84 @@ public function dataProcess(): iterable
],
],
],
yield 'headers with "X" prefix, comma-separated IPs' => [
$this
->createMiddleware()
->withTrustedIps(['8.8.8.8', '5.5.5.5', '2.2.2.2', '18.18.18.18'])
->withConnectionChainItemsAttribute('connectionChainItems'),
$this->createRequest(
headers: ['X-Forwarded-For' => '9.9.9.9, 7.7.7.7, 5.5.5.5, 2.2.2.2'],
serverParams: ['REMOTE_ADDR' => '18.18.18.18'],
),
[
'requestClientIp' => '7.7.7.7',
'connectionChainItemsAttribute' => [
'connectionChainItems',
[
[
'ip' => '18.18.18.18',
'protocol' => null,
'host' => null,
'port' => null,
'ipIdentifier' => null,
],
[
'ip' => '2.2.2.2',
'protocol' => null,
'host' => null,
'port' => null,
'ipIdentifier' => null,
],
[
'ip' => '5.5.5.5',
'protocol' => null,
'host' => null,
'port' => null,
'ipIdentifier' => null,
],
],
],
],
],
yield 'headers with "X" prefix, multiple comma-separated header values' => [
$this
->createMiddleware()
->withTrustedIps(['8.8.8.8', '5.5.5.5', '2.2.2.2', '18.18.18.18'])
->withConnectionChainItemsAttribute('connectionChainItems'),
$this->createRequest(
headers: ['X-Forwarded-For' => ['9.9.9.9, 7.7.7.7', '5.5.5.5, 2.2.2.2']],
serverParams: ['REMOTE_ADDR' => '18.18.18.18'],
),
[
'requestClientIp' => '7.7.7.7',
'connectionChainItemsAttribute' => [
'connectionChainItems',
[
[
'ip' => '18.18.18.18',
'protocol' => null,
'host' => null,
'port' => null,
'ipIdentifier' => null,
],
[
'ip' => '2.2.2.2',
'protocol' => null,
'host' => null,
'port' => null,
'ipIdentifier' => null,
],
[
'ip' => '5.5.5.5',
'protocol' => null,
'host' => null,
'port' => null,
'ipIdentifier' => null,
],
],
],
],
],
yield 'RFC header, contains IP from private network, IPv4' => [
$this
->createMiddleware()
Expand Down Expand Up @@ -821,7 +899,7 @@ public function dataProcess(): iterable
'port' => 8080,
],
],
yield 'custom headers, highest priority, IP related data' => [
yield 'custom headers, highest priority, comma-separated IP related data' => [
$this
->createMiddleware()
->withTrustedIps(['8.8.8.8', '2.2.2.2', '18.18.18.18'])
Expand All @@ -847,7 +925,7 @@ public function dataProcess(): iterable
'X-Forwarded-Proto' => ['http'],
'X-Forwarded-Host' => ['example2.com'],
'X-Forwarded-Port' => ['8020'],
'Y-Forwarded-For' => ['9.9.9.9', '5.5.5.5', '2.2.2.2'],
'Y-Forwarded-For' => '9.9.9.9, 5.5.5.5, 2.2.2.2',
'Y-Forwarded-Proto' => ['https'],
'Y-Forwarded-Host' => ['example3.com'],
'Y-Forwarded-Port' => ['8030'],
Expand Down
10 changes: 10 additions & 0 deletions tests/TrustedHostsNetworkResolver/RuntimeExceptionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,16 @@ public function dataInvalidConnectionChainItemException(): iterable
),
'"invalid5.5.5.5" is not a valid IP.',
],
yield 'IP, empty item in comma-separated header with "X" prefix' => [
$this->createMiddleware()->withTrustedIps(['8.8.8.8', '2.2.2.2', '18.18.18.18']),
$this->createRequest(
headers: [
'X-Forwarded-For' => '9.9.9.9, , 2.2.2.2',
],
serverParams: ['REMOTE_ADDR' => '18.18.18.18'],
),
'"" is not a valid IP.',
],
yield 'IP with port, headers with "X" prefix' => [
$this->createMiddleware()->withTrustedIps(['8.8.8.8', '2.2.2.2', '18.18.18.18']),
$this->createRequest(
Expand Down