vendor/nelmio/security-bundle/EventListener/ForcedSslListener.php line 81

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of the Nelmio SecurityBundle.
  5. *
  6. * (c) Nelmio <hello@nelm.io>
  7. *
  8. * For the full copyright and license information, please view the LICENSE
  9. * file that was distributed with this source code.
  10. */
  12. namespace Nelmio\SecurityBundle\EventListener;
  14. use Symfony\Component\HttpFoundation\RedirectResponse;
  15. use Symfony\Component\HttpKernel\Event\GetResponseEvent;
  16. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  17. use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
  18. use Symfony\Component\HttpKernel\Event\RequestEvent;
  19. use Symfony\Component\HttpKernel\HttpKernelInterface;
  21. /**
  22. * @final
  23. */
  24. class ForcedSslListener
  25. {
  26. private $hstsMaxAge;
  27. private $hstsSubdomains;
  28. private $hstsPreload;
  29. private $whitelist;
  30. private $hosts;
  31. private $redirectStatusCode;
  33. public function __construct($hstsMaxAge, $hstsSubdomains, $hstsPreload = false, array $whitelist = array(), array $hosts = array(), $redirectStatusCode = 302)
  34. {
  35. $this->hstsMaxAge = $hstsMaxAge;
  36. $this->hstsSubdomains = $hstsSubdomains;
  37. $this->hstsPreload = $hstsPreload;
  38. $this->whitelist = $whitelist ? '('.implode('|', $whitelist).')' : null;
  39. $this->hosts = $hosts ? '('.implode('|', $hosts).')' : null;
  40. $this->redirectStatusCode = $redirectStatusCode;
  41. }
  43. /**
  44. * @param GetResponseEvent|RequestEvent $e
  45. */
  46. public function onKernelRequest($e)
  47. {
  48. // Compatibility with Symfony < 5 and Symfony >=5
  49. if (!$e instanceof GetResponseEvent && !$e instanceof RequestEvent) {
  50. throw new \InvalidArgumentException(\sprintf('Expected instance of type %s, %s given', \class_exists(RequestEvent::class) ? RequestEvent::class : GetResponseEvent::class, \is_object($e) ? \get_class($e) : \gettype($e)));
  51. }
  53. if (HttpKernelInterface::MASTER_REQUEST !== $e->getRequestType()) {
  54. return;
  55. }
  57. $request = $e->getRequest();
  59. // skip SSL & non-GET/HEAD requests
  60. if ($request->isSecure() || !$request->isMethodSafe()) {
  61. return;
  62. }
  64. // skip whitelisted URLs
  65. if ($this->whitelist && preg_match('{'.$this->whitelist.'}i', $request->getPathInfo() ?: '/')) {
  66. return;
  67. }
  69. // skip non-listed hosts
  70. if ($this->hosts && !preg_match('{'.$this->hosts.'}i', $request->getHost() ?: '/')) {
  71. return;
  72. }
  74. // redirect the rest to SSL
  75. $e->setResponse(new RedirectResponse('https://'.substr($request->getUri(), 7), $this->redirectStatusCode));
  76. }
  78. /**
  79. * @param FilterResponseEvent|ResponseEvent $e
  80. */
  81. public function onKernelResponse($e)
  82. {
  83. // Compatibility with Symfony < 5 and Symfony >=5
  84. if (!$e instanceof FilterResponseEvent && !$e instanceof ResponseEvent) {
  85. throw new \InvalidArgumentException(\sprintf('Expected instance of type %s, %s given', \class_exists(ResponseEvent::class) ? ResponseEvent::class : FilterResponseEvent::class, \is_object($e) ? \get_class($e) : \gettype($e)));
  86. }
  88. if (HttpKernelInterface::MASTER_REQUEST !== $e->getRequestType()) {
  89. return;
  90. }
  92. // skip non-SSL requests as per the RFC
  93. // "An HSTS Host MUST NOT include the STS header field in HTTP responses conveyed over non-secure transport."
  94. $request = $e->getRequest();
  95. if (!$request->isSecure()) {
  96. return;
  97. }
  99. $response = $e->getResponse();
  101. if (!$response->headers->has('Strict-Transport-Security')) {
  102. $header = 'max-age='.$this->hstsMaxAge;
  103. $header .= ($this->hstsSubdomains ? '; includeSubDomains' : '');
  104. $header .= ($this->hstsPreload ? '; preload' : '');
  105. $response->headers->set('Strict-Transport-Security', $header);
  106. }
  107. }
  108. }