vendor/sensio/framework-extra-bundle/EventListener/SecurityListener.php line 48

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony framework.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * This source file is subject to the MIT license that is bundled
  9.  * with this source code in the file LICENSE.
  10.  */
  12. namespace Sensio\Bundle\FrameworkExtraBundle\EventListener;
  14. use Sensio\Bundle\FrameworkExtraBundle\Security\ExpressionLanguage;
  15. use Symfony\Component\HttpKernel\Event\FilterControllerEvent;
  16. use Symfony\Component\HttpKernel\KernelEvents;
  17. use Symfony\Component\HttpFoundation\Request;
  18. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  19. use Symfony\Component\Security\Core\Authentication\AuthenticationTrustResolverInterface;
  20. use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
  21. use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
  22. use Symfony\Component\Security\Core\SecurityContextInterface;
  23. use Symfony\Component\Security\Core\Exception\AccessDeniedException;
  24. use Symfony\Component\Security\Core\Role\RoleHierarchyInterface;
  26. /**
  27.  * SecurityListener handles security restrictions on controllers.
  28.  *
  29.  * @author Fabien Potencier <fabien@symfony.com>
  30.  */
  31. class SecurityListener implements EventSubscriberInterface
  32. {
  33.     private $tokenStorage;
  34.     private $authChecker;
  35.     private $language;
  36.     private $trustResolver;
  37.     private $roleHierarchy;
  39.     public function __construct(SecurityContextInterface $securityContext = null, ExpressionLanguage $language = null, AuthenticationTrustResolverInterface $trustResolver = null, RoleHierarchyInterface $roleHierarchy = null, TokenStorageInterface $tokenStorage = null, AuthorizationCheckerInterface $authChecker = null)
  40.     {
  41.         $this->tokenStorage = $tokenStorage ?: $securityContext;
  42.         $this->authChecker = $authChecker ?: $securityContext;
  43.         $this->language = $language;
  44.         $this->trustResolver = $trustResolver;
  45.         $this->roleHierarchy = $roleHierarchy;
  46.     }
  48.     public function onKernelController(FilterControllerEvent $event)
  49.     {
  50.         $request = $event->getRequest();
  51.         if (!$configuration = $request->attributes->get('_security')) {
  52.             return;
  53.         }
  55.         if (null === $this->tokenStorage || null === $this->trustResolver) {
  56.             throw new \LogicException('To use the @Security tag, you need to install the Symfony Security bundle.');
  57.         }
  59.         if (null === $this->tokenStorage->getToken()) {
  60.             throw new \LogicException('To use the @Security tag, your controller needs to be behind a firewall.');
  61.         }
  63.         if (null === $this->language) {
  64.             throw new \LogicException('To use the @Security tag, you need to use the Security component 2.4 or newer and install the ExpressionLanguage component.');
  65.         }
  67.         if (!$this->language->evaluate($configuration->getExpression(), $this->getVariables($request))) {
  68.             throw new AccessDeniedException(sprintf('Expression "%s" denied access.', $configuration->getExpression()));
  69.         }
  70.     }
  72.     // code should be sync with Symfony\Component\Security\Core\Authorization\Voter\ExpressionVoter
  73.     private function getVariables(Request $request)
  74.     {
  75.         $token = $this->tokenStorage->getToken();
  77.         if (null !== $this->roleHierarchy) {
  78.             $roles = $this->roleHierarchy->getReachableRoles($token->getRoles());
  79.         } else {
  80.             $roles = $token->getRoles();
  81.         }
  83.         $variables = array(
  84.             'token' => $token,
  85.             'user' => $token->getUser(),
  86.             'object' => $request,
  87.             'subject' => $request,
  88.             'request' => $request,
  89.             'roles' => array_map(function ($role) { return $role->getRole(); }, $roles),
  90.             'trust_resolver' => $this->trustResolver,
  91.             // needed for the is_granted expression function
  92.             'auth_checker' => $this->authChecker,
  93.         );
  95.         // controller variables should also be accessible
  96.         return array_merge($request->attributes->all(), $variables);
  97.     }
  99.     public static function getSubscribedEvents()
  100.     {
  101.         return array(KernelEvents::CONTROLLER => 'onKernelController');
  102.     }
  103. }