Skip to content

Commit e2a8f77

Browse files
committed
Merge branch '2.8' into 3.0
* 2.8: [HttpKernel] Add listener that checks when request has both Forwarded and X-Forwarded-For [HttpKernel] Move conflicting origin IPs handling to catch block [travis] Fix deps=low/high patching
2 parents 2183634 + b6ff4b7 commit e2a8f77

File tree

4 files changed

+106
-19
lines changed

4 files changed

+106
-19
lines changed
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Component\HttpKernel\EventListener;
13+
14+
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
15+
use Symfony\Component\HttpKernel\Event\GetResponseEvent;
16+
use Symfony\Component\HttpKernel\KernelEvents;
17+
18+
/**
19+
* Validates that the headers and other information indicating the
20+
* client IP address of a request are consistent.
21+
*
22+
* @author Magnus Nordlander <magnus@fervo.se>
23+
*/
24+
class ValidateRequestListener implements EventSubscriberInterface
25+
{
26+
/**
27+
* Performs the validation.
28+
*
29+
* @param GetResponseEvent $event
30+
*/
31+
public function onKernelRequest(GetResponseEvent $event)
32+
{
33+
if (!$event->isMasterRequest()) {
34+
return;
35+
}
36+
$request = $event->getRequest();
37+
38+
if ($request::getTrustedProxies()) {
39+
// This will throw an exception if the headers are inconsistent.
40+
$request->getClientIps();
41+
}
42+
}
43+
44+
/**
45+
* {@inheritdoc}
46+
*/
47+
public static function getSubscribedEvents()
48+
{
49+
return array(
50+
KernelEvents::REQUEST => array(
51+
array('onKernelRequest', 256),
52+
),
53+
);
54+
}
55+
}

HttpKernel.php

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,9 @@ public function handle(Request $request, $type = HttpKernelInterface::MASTER_REQ
6363
try {
6464
return $this->handleRaw($request, $type);
6565
} catch (\Exception $e) {
66+
if ($e instanceof ConflictingHeadersException) {
67+
$e = new BadRequestHttpException('The request headers contain conflicting information regarding the origin of this request.', $e);
68+
}
6669
if (false === $catch) {
6770
$this->finishRequest($request, $type);
6871

@@ -115,13 +118,6 @@ public function terminateWithException(\Exception $exception)
115118
*/
116119
private function handleRaw(Request $request, $type = self::MASTER_REQUEST)
117120
{
118-
if (self::MASTER_REQUEST === $type && $request::getTrustedProxies()) {
119-
try {
120-
$request->getClientIps();
121-
} catch (ConflictingHeadersException $e) {
122-
throw new BadRequestHttpException('The request headers contain conflicting information regarding the origin of this request.', $e);
123-
}
124-
}
125121
$this->requestStack->push($request);
126122

127123
// request
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Component\HttpKernel\Tests\EventListener;
13+
14+
use Symfony\Component\EventDispatcher\EventDispatcher;
15+
use Symfony\Component\HttpFoundation\Request;
16+
use Symfony\Component\HttpKernel\EventListener\ValidateRequestListener;
17+
use Symfony\Component\HttpKernel\Event\GetResponseEvent;
18+
use Symfony\Component\HttpKernel\HttpKernelInterface;
19+
use Symfony\Component\HttpKernel\KernelEvents;
20+
21+
class ValidateRequestListenerTest extends \PHPUnit_Framework_TestCase
22+
{
23+
/**
24+
* @expectedException Symfony\Component\HttpFoundation\Exception\ConflictingHeadersException
25+
*/
26+
public function testListenerThrowsWhenMasterRequestHasInconsistentClientIps()
27+
{
28+
$dispatcher = new EventDispatcher();
29+
$kernel = $this->getMock('Symfony\Component\HttpKernel\HttpKernelInterface');
30+
31+
$request = new Request();
32+
$request->setTrustedProxies(array('1.1.1.1'));
33+
$request->server->set('REMOTE_ADDR', '1.1.1.1');
34+
$request->headers->set('FORWARDED', '2.2.2.2');
35+
$request->headers->set('X_FORWARDED_FOR', '3.3.3.3');
36+
37+
$dispatcher->addListener(KernelEvents::REQUEST, array(new ValidateRequestListener(), 'onKernelRequest'));
38+
$event = new GetResponseEvent($kernel, $request, HttpKernelInterface::MASTER_REQUEST);
39+
40+
$dispatcher->dispatch(KernelEvents::REQUEST, $event);
41+
}
42+
}

Tests/HttpKernelTest.php

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -265,26 +265,20 @@ public function testVerifyRequestStackPushPopDuringHandle()
265265
*/
266266
public function testInconsistentClientIpsOnMasterRequests()
267267
{
268-
$kernel = new HttpKernel(new EventDispatcher(), $this->getResolver());
269-
$request = new Request();
270-
$request->setTrustedProxies(array('1.1.1.1'));
271-
$request->server->set('REMOTE_ADDR', '1.1.1.1');
272-
$request->headers->set('FORWARDED', '2.2.2.2');
273-
$request->headers->set('X_FORWARDED_FOR', '3.3.3.3');
268+
$dispatcher = new EventDispatcher();
269+
$dispatcher->addListener(KernelEvents::REQUEST, function ($event) {
270+
$event->getRequest()->getClientIp();
271+
});
274272

275-
$kernel->handle($request, $kernel::MASTER_REQUEST, false);
276-
}
273+
$kernel = new HttpKernel($dispatcher, $this->getResolver());
277274

278-
public function testInconsistentClientIpsOnSubRequests()
279-
{
280-
$kernel = new HttpKernel(new EventDispatcher(), $this->getResolver());
281275
$request = new Request();
282276
$request->setTrustedProxies(array('1.1.1.1'));
283277
$request->server->set('REMOTE_ADDR', '1.1.1.1');
284278
$request->headers->set('FORWARDED', '2.2.2.2');
285279
$request->headers->set('X_FORWARDED_FOR', '3.3.3.3');
286280

287-
$this->assertInstanceOf('Symfony\Component\HttpFoundation\Response', $kernel->handle($request, $kernel::SUB_REQUEST, false));
281+
$kernel->handle($request, $kernel::MASTER_REQUEST, false);
288282
}
289283

290284
protected function getResolver($controller = null)

0 commit comments

Comments
 (0)