vendor/symfony/security-http/EventListener/IsGrantedAttributeListener.php line 38

Open in your IDE?
  1. <?php
  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.  */
  12. namespace Symfony\Component\Security\Http\EventListener;
  14. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  15. use Symfony\Component\ExpressionLanguage\Expression;
  16. use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
  17. use Symfony\Component\HttpKernel\Event\ControllerArgumentsEvent;
  18. use Symfony\Component\HttpKernel\Exception\HttpException;
  19. use Symfony\Component\HttpKernel\KernelEvents;
  20. use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
  21. use Symfony\Component\Security\Core\Exception\AccessDeniedException;
  22. use Symfony\Component\Security\Core\Exception\RuntimeException;
  23. use Symfony\Component\Security\Http\Attribute\IsGranted;
  25. /**
  26.  * Handles the IsGranted attribute on controllers.
  27.  *
  28.  * @author Ryan Weaver <ryan@knpuniversity.com>
  29.  */
  30. class IsGrantedAttributeListener implements EventSubscriberInterface
  31. {
  32.     public function __construct(
  33.         private readonly AuthorizationCheckerInterface $authChecker,
  34.         private ?ExpressionLanguage $expressionLanguage = null,
  35.     ) {
  36.     }
  38.     public function onKernelControllerArguments(ControllerArgumentsEvent $event)
  39.     {
  40.         /** @var IsGranted[] $attributes */
  41.         if (!\is_array($attributes = $event->getAttributes()[IsGranted::class] ?? null)) {
  42.             return;
  43.         }
  45.         $arguments = $event->getNamedArguments();
  47.         foreach ($attributes as $attribute) {
  48.             $subject = null;
  50.             if ($subjectRef = $attribute->subject) {
  51.                 if (\is_array($subjectRef)) {
  52.                     foreach ($subjectRef as $refKey => $ref) {
  53.                         $subject[\is_string($refKey) ? $refKey : (string) $ref] = $this->getIsGrantedSubject($ref, $arguments);
  54.                     }
  55.                 } else {
  56.                     $subject = $this->getIsGrantedSubject($subjectRef, $arguments);
  57.                 }
  58.             }
  60.             if (!$this->authChecker->isGranted($attribute->attribute, $subject)) {
  61.                 $message = $attribute->message ?: sprintf('Access Denied by #[IsGranted(%s)] on controller', $this->getIsGrantedString($attribute));
  63.                 if ($statusCode = $attribute->statusCode) {
  64.                     throw new HttpException($statusCode, $message);
  65.                 }
  67.                 $accessDeniedException = new AccessDeniedException($message);
  68.                 $accessDeniedException->setAttributes($attribute->attribute);
  69.                 $accessDeniedException->setSubject($subject);
  71.                 throw $accessDeniedException;
  72.             }
  73.         }
  74.     }
  76.     public static function getSubscribedEvents(): array
  77.     {
  78.         return [KernelEvents::CONTROLLER_ARGUMENTS => ['onKernelControllerArguments', 10]];
  79.     }
  81.     private function getIsGrantedSubject(string|Expression $subjectRef, array $arguments): mixed
  82.     {
  83.         if ($subjectRef instanceof Expression) {
  84.             $this->expressionLanguage ??= new ExpressionLanguage();
  86.             return $this->expressionLanguage->evaluate($subjectRef, [
  87.                 'args' => $arguments,
  88.             ]);
  89.         }
  91.         if (!\array_key_exists($subjectRef, $arguments)) {
  92.             throw new RuntimeException(sprintf('Could not find the subject "%s" for the #[IsGranted] attribute. Try adding a "$%s" argument to your controller method.', $subjectRef, $subjectRef));
  93.         }
  95.         return $arguments[$subjectRef];
  96.     }
  98.     private function getIsGrantedString(IsGranted $isGranted): string
  99.     {
  100.         $processValue = fn ($value) => sprintf($value instanceof Expression ? 'new Expression("%s")' : '"%s"', $value);
  102.         $argsString = $processValue($isGranted->attribute);
  104.         if (null !== $subject = $isGranted->subject) {
  105.             $subject = !\is_array($subject) ? $processValue($subject) : array_map(function ($key, $value) use ($processValue) {
  106.                 $value = $processValue($value);
  108.                 return \is_string($key) ? sprintf('"%s" => %s', $key, $value) : $value;
  109.             }, array_keys($subject), $subject);
  111.             $argsString .= ', '.(!\is_array($subject) ? $subject : '['.implode(', ', $subject).']');
  112.         }
  114.         return $argsString;
  115.     }
  116. }