[HttpKernel] Move handling of conflicting origin IPs to catch block #19233
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\HttpKernel\EventListener; | ||
|
|
||
| use Symfony\Component\EventDispatcher\EventSubscriberInterface; | ||
| use Symfony\Component\HttpKernel\Event\GetResponseEvent; | ||
| use Symfony\Component\HttpKernel\KernelEvents; | ||
|
|
||
| /** | ||
| * Validates that the headers and other information indicating the | ||
| * client IP address of a request are consistent. | ||
| * | ||
| * @author Magnus Nordlander <magnus@fervo.se> | ||
| */ | ||
| class ValidateRequestListener implements EventSubscriberInterface | ||
| { | ||
| /** | ||
| * Performs the validation. | ||
| * | ||
| * @param GetResponseEvent $event | ||
| */ | ||
| public function onKernelRequest(GetResponseEvent $event) | ||
| { | ||
| if (!$event->isMasterRequest()) { | ||
| return; | ||
| } | ||
| $request = $event->getRequest(); | ||
|
|
||
| if ($request::getTrustedProxies()) { | ||
| // This will throw an exception if the headers are inconsistent. | ||
| $request->getClientIps(); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public static function getSubscribedEvents() | ||
| { | ||
| return array( | ||
| KernelEvents::REQUEST => array( | ||
| array('onKernelRequest', 256), | ||
| ), | ||
| ); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\HttpKernel\Tests\EventListener; | ||
|
|
||
| use Symfony\Component\EventDispatcher\EventDispatcher; | ||
| use Symfony\Component\HttpFoundation\Request; | ||
| use Symfony\Component\HttpKernel\EventListener\ValidateRequestListener; | ||
| use Symfony\Component\HttpKernel\Event\GetResponseEvent; | ||
| use Symfony\Component\HttpKernel\HttpKernelInterface; | ||
| use Symfony\Component\HttpKernel\KernelEvents; | ||
|
|
||
| class ValidateRequestListenerTest extends \PHPUnit_Framework_TestCase | ||
|
There was a problem hiding this comment. Btw, this could be moved as a feature on master now. |
||
| { | ||
| /** | ||
| * @expectedException Symfony\Component\HttpFoundation\Exception\ConflictingHeadersException | ||
| */ | ||
| public function testListenerThrowsWhenMasterRequestHasInconsistentClientIps() | ||
| { | ||
| $dispatcher = new EventDispatcher(); | ||
| $kernel = $this->getMock('Symfony\Component\HttpKernel\HttpKernelInterface'); | ||
|
|
||
| $request = new Request(); | ||
| $request->setTrustedProxies(array('1.1.1.1')); | ||
| $request->server->set('REMOTE_ADDR', '1.1.1.1'); | ||
| $request->headers->set('FORWARDED', '2.2.2.2'); | ||
| $request->headers->set('X_FORWARDED_FOR', '3.3.3.3'); | ||
|
|
||
| $dispatcher->addListener(KernelEvents::REQUEST, array(new ValidateRequestListener(), 'onKernelRequest')); | ||
| $event = new GetResponseEvent($kernel, $request, HttpKernelInterface::MASTER_REQUEST); | ||
|
|
||
| $dispatcher->dispatch(KernelEvents::REQUEST, $event); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To me, this belongs to HttpKernel: it's a low level HttpFoundation exception (the only one), and HttpKernel job's is to map HttpFoundation to event's world, and deal with any kind of events, exceptions included. It's HttpKernel's responsibility to convert HttpFoundation exceptions to HttpKernel's world.
It's not optional at all, and existing HttpKernel users (e.g. Drupal) need to get a BadRequestHttpException that they already know how do deal with. Not this ConflictingHeadersException that comes from lower levels.
The listener below is a nice to have, that adds an early check in the request management process. Totally optional and a smooth feature for the FrameworkBundle.
Thus the split I made here.
That's only my humble opinion and maybe I miss the thing, so I'll move to the listener if you're sure it's the right place.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's indeed much better now. 👍