Skip to content

Commit a2f2942

Browse files
nicolas-grekasnicolas-grekas
committed
[FrameworkBundle] allow configuring trusted proxies using semantic configuration
1 parent 82bf885 commit a2f2942

File tree

9 files changed

+48
-13
lines changed

9 files changed

+48
-13
lines changed

‎src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ CHANGELOG
55
-----
66

77
* Added `framework.http_cache` configuration tree
8+
* Added `framework.trusted_proxies` and `framework.trusted_headers` configuration options
89

910
5.1.0
1011
-----

‎src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
use Symfony\Component\Form\Form;
2525
use Symfony\Component\HttpClient\HttpClient;
2626
use Symfony\Component\HttpFoundation\Cookie;
27+
use Symfony\Component\HttpFoundation\Request;
2728
use Symfony\Component\Lock\Lock;
2829
use Symfony\Component\Lock\Store\SemaphoreStore;
2930
use Symfony\Component\Mailer\Mailer;
@@ -85,6 +86,8 @@ public function getConfigTreeBuilder()
8586
->beforeNormalization()->ifString()->then(function ($v) { return [$v]; })->end()
8687
->prototype('scalar')->end()
8788
->end()
89+
->scalarNode('trusted_proxies')->end()
90+
->integerNode('trusted_headers')->defaultValue(Request::HEADER_X_FORWARDED_ALL ^ Request::HEADER_X_FORWARDED_HOST)->end()
8891
->scalarNode('error_controller')
8992
->defaultValue('error_controller')
9093
->end()

‎src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -241,6 +241,11 @@ public function load(array $configs, ContainerBuilder $container)
241241
$container->setParameter('kernel.default_locale', $config['default_locale']);
242242
$container->setParameter('kernel.error_controller', $config['error_controller']);
243243

244+
if (isset($config['trusted_proxies'], $config['trusted_headers'])) {
245+
$container->setParameter('kernel.trusted_proxies', $config['trusted_proxies']);
246+
$container->setParameter('kernel.trusted_headers', $config['trusted_headers']);
247+
}
248+
244249
if (!$container->hasParameter('debug.file_link_format')) {
245250
$links = [
246251
'textmate' => 'txmt://open?url=file://%%f&line=%%l',

‎src/Symfony/Bundle/FrameworkBundle/FrameworkBundle.php‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -95,10 +95,6 @@ public function boot()
9595
if ($this->container->getParameter('kernel.http_method_override')) {
9696
Request::enableHttpMethodParameterOverride();
9797
}
98-
99-
if ($trustedHosts = $this->container->getParameter('kernel.trusted_hosts')) {
100-
Request::setTrustedHosts($trustedHosts);
101-
}
10298
}
10399

104100
public function build(ContainerBuilder $container)

‎src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
1919
use Symfony\Component\Config\Definition\Processor;
2020
use Symfony\Component\HttpClient\HttpClient;
21+
use Symfony\Component\HttpFoundation\Request;
2122
use Symfony\Component\Lock\Store\SemaphoreStore;
2223
use Symfony\Component\Mailer\Mailer;
2324
use Symfony\Component\Messenger\MessageBusInterface;
@@ -341,6 +342,7 @@ protected static function getBundleDefaultConfig()
341342
'http_method_override' => true,
342343
'ide' => null,
343344
'default_locale' => 'en',
345+
'trusted_headers' => Request::HEADER_X_FORWARDED_ALL ^ Request::HEADER_X_FORWARDED_HOST,
344346
'csrf_protection' => [
345347
'enabled' => false,
346348
],

‎src/Symfony/Component/HttpKernel/CHANGELOG.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ CHANGELOG
55
-----
66

77
* made the public `http_cache` service handle requests when available
8+
* allowed enabling trusted hosts and proxies using new `kernel.trusted_hosts`,
9+
`kernel.trusted_proxies` and `kernel.trusted_headers` parameters
810

911
5.1.0
1012
-----

‎src/Symfony/Component/HttpKernel/Kernel.php‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -764,7 +764,17 @@ private function preBoot(): ContainerInterface
764764
$this->initializeBundles();
765765
$this->initializeContainer();
766766

767-
return $this->container;
767+
$container = $this->container;
768+
769+
if ($container->hasParameter('kernel.trusted_hosts') && $trustedHosts = $container->getParameter('kernel.trusted_hosts')) {
770+
Request::setTrustedHosts($trustedHosts);
771+
}
772+
773+
if ($container->hasParameter('kernel.trusted_proxies') && $container->hasParameter('kernel.trusted_headers') && $trustedProxies = $container->getParameter('kernel.trusted_proxies')) {
774+
Request::setTrustedProxies(explode(',', $trustedProxies), $container->getParameter('kernel.trusted_headers'));
775+
}
776+
777+
return $container;
768778
}
769779

770780
/**

‎src/Symfony/Component/HttpKernel/Tests/Fixtures/KernelForTest.php‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,20 @@
1212
namespace Symfony\Component\HttpKernel\Tests\Fixtures;
1313

1414
use Symfony\Component\Config\Loader\LoaderInterface;
15+
use Symfony\Component\DependencyInjection\ContainerBuilder;
1516
use Symfony\Component\HttpKernel\Bundle\BundleInterface;
1617
use Symfony\Component\HttpKernel\Kernel;
1718

1819
class KernelForTest extends Kernel
1920
{
21+
private $fakeContainer;
22+
23+
public function __construct(string $environment, bool $debug, bool $fakeContainer = true)
24+
{
25+
parent::__construct($environment, $debug);
26+
$this->fakeContainer = $fakeContainer;
27+
}
28+
2029
public function getBundleMap()
2130
{
2231
return $this->bundleMap;
@@ -40,4 +49,13 @@ public function getProjectDir(): string
4049
{
4150
return __DIR__;
4251
}
52+
53+
protected function initializeContainer()
54+
{
55+
if ($this->fakeContainer) {
56+
$this->container = new ContainerBuilder();
57+
} else {
58+
parent::initializeContainer();
59+
}
60+
}
4361
}

‎src/Symfony/Component/HttpKernel/Tests/KernelTest.php‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ public function testClassNameValidityGetter()
6969
// We check the classname that will be generated by using a $env that
7070
// contains invalid characters.
7171
$env = 'test.env';
72-
$kernel = new KernelForTest($env, false);
72+
$kernel = new KernelForTest($env, false, false);
7373

7474
$kernel->boot();
7575
}
@@ -101,11 +101,9 @@ public function testInitializeContainerClearsOldContainers()
101101

102102
public function testBootInitializesBundlesAndContainer()
103103
{
104-
$kernel = $this->getKernel(['initializeBundles', 'initializeContainer']);
104+
$kernel = $this->getKernel(['initializeBundles']);
105105
$kernel->expects($this->once())
106106
->method('initializeBundles');
107-
$kernel->expects($this->once())
108-
->method('initializeContainer');
109107

110108
$kernel->boot();
111109
}
@@ -116,7 +114,7 @@ public function testBootSetsTheContainerToTheBundles()
116114
$bundle->expects($this->once())
117115
->method('setContainer');
118116

119-
$kernel = $this->getKernel(['initializeBundles', 'initializeContainer', 'getBundles']);
117+
$kernel = $this->getKernel(['initializeBundles', 'getBundles']);
120118
$kernel->expects($this->once())
121119
->method('getBundles')
122120
->willReturn([$bundle]);
@@ -127,15 +125,15 @@ public function testBootSetsTheContainerToTheBundles()
127125
public function testBootSetsTheBootedFlagToTrue()
128126
{
129127
// use test kernel to access isBooted()
130-
$kernel = $this->getKernel(['initializeBundles', 'initializeContainer']);
128+
$kernel = $this->getKernel(['initializeBundles']);
131129
$kernel->boot();
132130

133131
$this->assertTrue($kernel->isBooted());
134132
}
135133

136134
public function testClassCacheIsNotLoadedByDefault()
137135
{
138-
$kernel = $this->getKernel(['initializeBundles', 'initializeContainer', 'doLoadClassCache']);
136+
$kernel = $this->getKernel(['initializeBundles', 'doLoadClassCache']);
139137
$kernel->expects($this->never())
140138
->method('doLoadClassCache');
141139

@@ -144,7 +142,7 @@ public function testClassCacheIsNotLoadedByDefault()
144142

145143
public function testBootKernelSeveralTimesOnlyInitializesBundlesOnce()
146144
{
147-
$kernel = $this->getKernel(['initializeBundles', 'initializeContainer']);
145+
$kernel = $this->getKernel(['initializeBundles']);
148146
$kernel->expects($this->once())
149147
->method('initializeBundles');
150148

0 commit comments

Comments
 (0)