vendor/symfony/security-core/Authorization/Voter/AuthenticatedVoter.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\Security\Core\Authentication\AuthenticationTrustResolverInterface;
  15. use Symfony\Component\Security\Core\Authentication\Token\SwitchUserToken;
  16. use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
  18. /**
  19.  * AuthenticatedVoter votes if an attribute like IS_AUTHENTICATED_FULLY,
  20.  * IS_AUTHENTICATED_REMEMBERED, IS_AUTHENTICATED is present.
  21.  *
  22.  * This list is most restrictive to least restrictive checking.
  23.  *
  24.  * @author Fabien Potencier <fabien@symfony.com>
  25.  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  26.  */
  27. class AuthenticatedVoter implements CacheableVoterInterface
  28. {
  29.     public const IS_AUTHENTICATED_FULLY = 'IS_AUTHENTICATED_FULLY';
  30.     public const IS_AUTHENTICATED_REMEMBERED = 'IS_AUTHENTICATED_REMEMBERED';
  31.     /**
  32.      * @deprecated since Symfony 5.4
  33.      */
  34.     public const IS_AUTHENTICATED_ANONYMOUSLY = 'IS_AUTHENTICATED_ANONYMOUSLY';
  35.     /**
  36.      * @deprecated since Symfony 5.4
  37.      */
  38.     public const IS_ANONYMOUS = 'IS_ANONYMOUS';
  39.     public const IS_AUTHENTICATED = 'IS_AUTHENTICATED';
  40.     public const IS_IMPERSONATOR = 'IS_IMPERSONATOR';
  41.     public const IS_REMEMBERED = 'IS_REMEMBERED';
  42.     public const PUBLIC_ACCESS = 'PUBLIC_ACCESS';
  44.     private $authenticationTrustResolver;
  46.     public function __construct(AuthenticationTrustResolverInterface $authenticationTrustResolver)
  47.     {
  48.         $this->authenticationTrustResolver = $authenticationTrustResolver;
  49.     }
  51.     /**
  52.      * {@inheritdoc}
  53.      */
  54.     public function vote(TokenInterface $token, $subject, array $attributes)
  55.     {
  56.         if ($attributes === [self::PUBLIC_ACCESS]) {
  57.             return VoterInterface::ACCESS_GRANTED;
  58.         }
  60.         $result = VoterInterface::ACCESS_ABSTAIN;
  61.         foreach ($attributes as $attribute) {
  62.             if (null === $attribute || (self::IS_AUTHENTICATED_FULLY !== $attribute
  63.                     && self::IS_AUTHENTICATED_REMEMBERED !== $attribute
  64.                     && self::IS_AUTHENTICATED_ANONYMOUSLY !== $attribute
  65.                     && self::IS_AUTHENTICATED !== $attribute
  66.                     && self::IS_ANONYMOUS !== $attribute
  67.                     && self::IS_IMPERSONATOR !== $attribute
  68.                     && self::IS_REMEMBERED !== $attribute)) {
  69.                 continue;
  70.             }
  72.             $result = VoterInterface::ACCESS_DENIED;
  74.             if (self::IS_AUTHENTICATED_FULLY === $attribute
  75.                 && $this->authenticationTrustResolver->isFullFledged($token)) {
  76.                 return VoterInterface::ACCESS_GRANTED;
  77.             }
  79.             if (self::IS_AUTHENTICATED_REMEMBERED === $attribute
  80.                 && ($this->authenticationTrustResolver->isRememberMe($token)
  81.                     || $this->authenticationTrustResolver->isFullFledged($token))) {
  82.                 return VoterInterface::ACCESS_GRANTED;
  83.             }
  85.             if (self::IS_AUTHENTICATED_ANONYMOUSLY === $attribute
  86.                 && ($this->authenticationTrustResolver->isAnonymous($token)
  87.                     || $this->authenticationTrustResolver->isRememberMe($token)
  88.                     || $this->authenticationTrustResolver->isFullFledged($token))) {
  89.                 trigger_deprecation('symfony/security-core', '5.4', 'The "IS_AUTHENTICATED_ANONYMOUSLY" security attribute is deprecated, use "IS_AUTHENTICATED" or "IS_AUTHENTICATED_FULLY" instead if you want to check if the request is (fully) authenticated.');
  91.                 return VoterInterface::ACCESS_GRANTED;
  92.             }
  94.             // @deprecated $this->authenticationTrustResolver must implement isAuthenticated() in 6.0
  95.             if (self::IS_AUTHENTICATED === $attribute
  96.                 && (method_exists($this->authenticationTrustResolver, 'isAuthenticated')
  97.                     ? $this->authenticationTrustResolver->isAuthenticated($token)
  98.                     : ($token && $token->getUser()))) {
  99.                 return VoterInterface::ACCESS_GRANTED;
  100.             }
  102.             if (self::IS_REMEMBERED === $attribute && $this->authenticationTrustResolver->isRememberMe($token)) {
  103.                 return VoterInterface::ACCESS_GRANTED;
  104.             }
  106.             if (self::IS_ANONYMOUS === $attribute && $this->authenticationTrustResolver->isAnonymous($token)) {
  107.                 trigger_deprecation('symfony/security-core', '5.4', 'The "IS_ANONYMOUSLY" security attribute is deprecated, anonymous no longer exists in version 6.');
  109.                 return VoterInterface::ACCESS_GRANTED;
  110.             }
  112.             if (self::IS_IMPERSONATOR === $attribute && $token instanceof SwitchUserToken) {
  113.                 return VoterInterface::ACCESS_GRANTED;
  114.             }
  115.         }
  117.         return $result;
  118.     }
  120.     public function supportsAttribute(string $attribute): bool
  121.     {
  122.         return \in_array($attribute, [
  123.             self::IS_AUTHENTICATED_FULLY,
  124.             self::IS_AUTHENTICATED_REMEMBERED,
  125.             self::IS_AUTHENTICATED_ANONYMOUSLY,
  126.             self::IS_AUTHENTICATED,
  127.             self::IS_ANONYMOUS,
  128.             self::IS_IMPERSONATOR,
  129.             self::IS_REMEMBERED,
  130.             self::PUBLIC_ACCESS,
  131.         ], true);
  132.     }
  134.     public function supportsType(string $subjectType): bool
  135.     {
  136.         return true;
  137.     }
  138. }