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

  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\HttpFoundation\Request;
  18. use Symfony\Component\HttpKernel\Event\ControllerArgumentsEvent;
  19. use Symfony\Component\HttpKernel\Exception\HttpException;
  20. use Symfony\Component\HttpKernel\KernelEvents;
  21. use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
  22. use Symfony\Component\Security\Core\Exception\AccessDeniedException;
  23. use Symfony\Component\Security\Core\Exception\RuntimeException;
  24. use Symfony\Component\Security\Http\Attribute\IsGranted;
  26. /**
  27.  * Handles the IsGranted attribute on controllers.
  28.  *
  29.  * @author Ryan Weaver <ryan@knpuniversity.com>
  30.  */
  31. class IsGrantedAttributeListener implements EventSubscriberInterface
  32. {
  33.     public function __construct(
  34.         private readonly AuthorizationCheckerInterface $authChecker,
  35.         private ?ExpressionLanguage $expressionLanguage = null,
  36.     ) {
  37.     }
  39.     public function onKernelControllerArguments(ControllerArgumentsEvent $event)
  40.     {
  41.         /** @var IsGranted[] $attributes */
  42.         if (!\is_array($attributes = $event->getAttributes()[IsGranted::class] ?? null)) {
  43.             return;
  44.         }
  46.         $request = $event->getRequest();
  47.         $arguments = $event->getNamedArguments();
  49.         foreach ($attributes as $attribute) {
  50.             $subject = null;
  52.             if ($subjectRef = $attribute->subject) {
  53.                 if (\is_array($subjectRef)) {
  54.                     foreach ($subjectRef as $refKey => $ref) {
  55.                         $subject[\is_string($refKey) ? $refKey : (string) $ref] = $this->getIsGrantedSubject($ref, $request, $arguments);
  56.                     }
  57.                 } else {
  58.                     $subject = $this->getIsGrantedSubject($subjectRef, $request, $arguments);
  59.                 }
  60.             }
  62.             if (!$this->authChecker->isGranted($attribute->attribute, $subject)) {
  63.                 $message = $attribute->message ?: sprintf('Access Denied by #[IsGranted(%s)] on controller', $this->getIsGrantedString($attribute));
  65.                 if ($statusCode = $attribute->statusCode) {
  66.                     throw new HttpException($statusCode, $message);
  67.                 }
  69.                 $accessDeniedException = new AccessDeniedException($message);
  70.                 $accessDeniedException->setAttributes($attribute->attribute);
  71.                 $accessDeniedException->setSubject($subject);
  73.                 throw $accessDeniedException;
  74.             }
  75.         }
  76.     }
  78.     public static function getSubscribedEvents(): array
  79.     {
  80.         return [KernelEvents::CONTROLLER_ARGUMENTS => ['onKernelControllerArguments', 20]];
  81.     }
  83.     private function getIsGrantedSubject(string|Expression $subjectRef, Request $request, array $arguments): mixed
  84.     {
  85.         if ($subjectRef instanceof Expression) {
  86.             $this->expressionLanguage ??= new ExpressionLanguage();
  88.             return $this->expressionLanguage->evaluate($subjectRef, [
  89.                 'request' => $request,
  90.                 'args' => $arguments,
  91.             ]);
  92.         }
  94.         if (!\array_key_exists($subjectRef, $arguments)) {
  95.             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));
  96.         }
  98.         return $arguments[$subjectRef];
  99.     }
  101.     private function getIsGrantedString(IsGranted $isGranted): string
  102.     {
  103.         $processValue = fn ($value) => sprintf($value instanceof Expression ? 'new Expression("%s")' : '"%s"', $value);
  105.         $argsString = $processValue($isGranted->attribute);
  107.         if (null !== $subject = $isGranted->subject) {
  108.             $subject = !\is_array($subject) ? $processValue($subject) : array_map(function ($key, $value) use ($processValue) {
  109.                 $value = $processValue($value);
  111.                 return \is_string($key) ? sprintf('"%s" => %s', $key, $value) : $value;
  112.             }, array_keys($subject), $subject);
  114.             $argsString .= ', '.(!\is_array($subject) ? $subject : '['.implode(', ', $subject).']');
  115.         }
  117.         return $argsString;
  118.     }
  119. }