Skip to content

[HttpFoundation] reintroduce set trusted header name in request #32961

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

Closed
wants to merge 1 commit into from
+32 −0
Closed

[HttpFoundation] reintroduce set trusted header name in request #32961

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 src/Symfony/Component/HttpFoundation/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ CHANGELOG

* passing arguments to `Request::isMethodSafe()` is deprecated.
* `ApacheRequest` is deprecated, use the `Request` class instead.
* added `setTrustedHeaderName()` method to the `Request` class.

4.3.0
-----
Expand Down
17 changes: 17 additions & 0 deletions src/Symfony/Component/HttpFoundation/Request.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -610,6 +610,23 @@ public static function setTrustedHosts(array $hostPatterns)
self::$trustedHosts = [];
}

/**
* Sets the name for trusted headers.
*
* @param int $type A bit field like Request::HEADER_*, to set which headers to trust from your proxies
* @param string $value The header name
*
* @throws \InvalidArgumentException
*/
public static function setTrustedHeaderName(int $type, string $value): void
{
if (!isset(self::$trustedHeaders[$type])) {
throw new \InvalidArgumentException(sprintf('Unable to set the trusted header name for type "%s".', $type));
}

self::$trustedHeaders[$type] = $value;
}

/**
* Gets the list of trusted host patterns.
*
Expand Down
14 changes: 14 additions & 0 deletions src/Symfony/Component/HttpFoundation/Tests/RequestTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2325,6 +2325,20 @@ public function testTrustedPortDoesNotDefaultToZero()

$this->assertSame(80, $request->getPort());
}

public function testSetTrustedHeaderName()
{
$request = Request::create('http://example.com/');
$request->server->set('REMOTE_ADDR', '1.1.1.1');
$request->headers->set('X_CUSTOM_FORWARDED_PORT', '8888');

$this->assertSame(80, $request->getPort());

$request::setTrustedHeaderName(Request::HEADER_X_FORWARDED_PORT, 'X_CUSTOM_FORWARDED_PORT');
Request::setTrustedProxies(['1.1.1.1'], Request::HEADER_X_FORWARDED_PORT);

$this->assertSame(8888, $request->getPort());
}
}

class RequestContentProxy extends Request
Expand Down