vendor/symfony/security-core/Authorization/Voter/ExpressionVoter.php line 27

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\Core\Authorization\Voter;
  14. use Symfony\Component\ExpressionLanguage\Expression;
  15. use Symfony\Component\HttpFoundation\Request;
  16. use Symfony\Component\Security\Core\Authentication\AuthenticationTrustResolverInterface;
  17. use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
  18. use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
  19. use Symfony\Component\Security\Core\Authorization\ExpressionLanguage;
  20. use Symfony\Component\Security\Core\Role\RoleHierarchyInterface;
  22. /**
  23. * ExpressionVoter votes based on the evaluation of an expression.
  24. *
  25. * @author Fabien Potencier <fabien@symfony.com>
  26. */
  27. class ExpressionVoter implements CacheableVoterInterface
  28. {
  29. private ExpressionLanguage $expressionLanguage;
  30. private AuthenticationTrustResolverInterface $trustResolver;
  31. private AuthorizationCheckerInterface $authChecker;
  32. private ?RoleHierarchyInterface $roleHierarchy;
  34. public function __construct(ExpressionLanguage $expressionLanguage, AuthenticationTrustResolverInterface $trustResolver, AuthorizationCheckerInterface $authChecker, ?RoleHierarchyInterface $roleHierarchy = null)
  35. {
  36. $this->expressionLanguage = $expressionLanguage;
  37. $this->trustResolver = $trustResolver;
  38. $this->authChecker = $authChecker;
  39. $this->roleHierarchy = $roleHierarchy;
  40. }
  42. public function supportsAttribute(string $attribute): bool
  43. {
  44. return false;
  45. }
  47. public function supportsType(string $subjectType): bool
  48. {
  49. return true;
  50. }
  52. public function vote(TokenInterface $token, mixed $subject, array $attributes): int
  53. {
  54. $result = VoterInterface::ACCESS_ABSTAIN;
  55. $variables = null;
  56. foreach ($attributes as $attribute) {
  57. if (!$attribute instanceof Expression) {
  58. continue;
  59. }
  61. $variables ??= $this->getVariables($token, $subject);
  63. $result = VoterInterface::ACCESS_DENIED;
  64. if ($this->expressionLanguage->evaluate($attribute, $variables)) {
  65. return VoterInterface::ACCESS_GRANTED;
  66. }
  67. }
  69. return $result;
  70. }
  72. private function getVariables(TokenInterface $token, mixed $subject): array
  73. {
  74. $roleNames = $token->getRoleNames();
  76. if (null !== $this->roleHierarchy) {
  77. $roleNames = $this->roleHierarchy->getReachableRoleNames($roleNames);
  78. }
  80. $variables = [
  81. 'token' => $token,
  82. 'user' => $token->getUser(),
  83. 'object' => $subject,
  84. 'subject' => $subject,
  85. 'role_names' => $roleNames,
  86. 'trust_resolver' => $this->trustResolver,
  87. 'auth_checker' => $this->authChecker,
  88. ];
  90. // this is mainly to propose a better experience when the expression is used
  91. // in an access control rule, as the developer does not know that it's going
  92. // to be handled by this voter
  93. if ($subject instanceof Request) {
  94. $variables['request'] = $subject;
  95. }
  97. return $variables;
  98. }
  99. }