vendor/lexik/jwt-authentication-bundle/Services/JWTManager.php line 67

  1. <?php
  3. namespace Lexik\Bundle\JWTAuthenticationBundle\Services;
  5. use Lexik\Bundle\JWTAuthenticationBundle\Encoder\HeaderAwareJWTEncoderInterface;
  6. use Lexik\Bundle\JWTAuthenticationBundle\Encoder\JWTEncoderInterface;
  7. use Lexik\Bundle\JWTAuthenticationBundle\Event\JWTCreatedEvent;
  8. use Lexik\Bundle\JWTAuthenticationBundle\Event\JWTDecodedEvent;
  9. use Lexik\Bundle\JWTAuthenticationBundle\Event\JWTEncodedEvent;
  10. use Lexik\Bundle\JWTAuthenticationBundle\Events;
  11. use Lexik\Bundle\JWTAuthenticationBundle\Exception\JWTDecodeFailureException;
  12. use Symfony\Component\PropertyAccess\PropertyAccess;
  13. use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
  14. use Symfony\Component\Security\Core\User\InMemoryUser;
  15. use Symfony\Component\Security\Core\User\UserInterface;
  16. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  18. /**
  19.  * Provides convenient methods to manage JWT creation/verification.
  20.  *
  21.  * @author Nicolas Cabot <n.cabot@lexik.fr>
  22.  * @author Robin Chalas <robin.chalas@gmail.com>
  23.  */
  24. class JWTManager implements JWTManagerInterface, JWTTokenManagerInterface
  25. {
  26.     /**
  27.      * @var JWTEncoderInterface
  28.      */
  29.     protected $jwtEncoder;
  31.     /**
  32.      * @var EventDispatcherInterface
  33.      */
  34.     protected $dispatcher;
  36.     /**
  37.      * @var string
  38.      *
  39.      * @deprecated since v2.15
  40.      */
  41.     protected $userIdentityField;
  43.     /**
  44.      * @var string
  45.      */
  46.     protected $userIdClaim;
  48.     /**
  49.      * @param string|null $userIdClaim
  50.      */
  51.     public function __construct(JWTEncoderInterface $encoder, EventDispatcherInterface $dispatcher, $userIdClaim = null)
  52.     {
  53.         $this->jwtEncoder = $encoder;
  54.         $this->dispatcher = $dispatcher;
  55.         $this->userIdentityField = 'username';
  56.         $this->userIdClaim = $userIdClaim;
  57.     }
  59.     /**
  60.      * @return string The JWT token
  61.      */
  62.     public function create(UserInterface $user): string
  63.     {
  64.         $payload = ['roles' => $user->getRoles()];
  65.         $this->addUserIdentityToPayload($user, $payload);
  67.         return $this->generateJwtStringAndDispatchEvents($user, $payload);
  68.     }
  70.     /**
  71.      * @return string The JWT token
  72.      */
  73.     public function createFromPayload(UserInterface $user, array $payload): string
  74.     {
  75.         $payload = array_merge(['roles' => $user->getRoles()], $payload);
  76.         $this->addUserIdentityToPayload($user, $payload);
  78.         return $this->generateJwtStringAndDispatchEvents($user, $payload);
  79.     }
  81.     /**
  82.      * @return string The JWT token
  83.      */
  84.     private function generateJwtStringAndDispatchEvents(UserInterface $user, array $payload): string
  85.     {
  86.         $jwtCreatedEvent = new JWTCreatedEvent($payload, $user);
  87.         $this->dispatcher->dispatch($jwtCreatedEvent, Events::JWT_CREATED);
  89.         if ($this->jwtEncoder instanceof HeaderAwareJWTEncoderInterface) {
  90.             $jwtString = $this->jwtEncoder->encode($jwtCreatedEvent->getData(), $jwtCreatedEvent->getHeader());
  91.         } else {
  92.             $jwtString = $this->jwtEncoder->encode($jwtCreatedEvent->getData());
  93.         }
  95.         $jwtEncodedEvent = new JWTEncodedEvent($jwtString);
  97.         $this->dispatcher->dispatch($jwtEncodedEvent, Events::JWT_ENCODED);
  99.         return $jwtString;
  100.     }
  102.     /**
  103.      * {@inheritdoc}
  104.      * @throws JWTDecodeFailureException
  105.      */
  106.     public function decode(TokenInterface $token)
  107.     {
  108.         if (!($payload = $this->jwtEncoder->decode($token->getCredentials()))) {
  109.             return false;
  110.         }
  112.         $event = new JWTDecodedEvent($payload);
  113.         $this->dispatcher->dispatch($event, Events::JWT_DECODED);
  115.         if (!$event->isValid()) {
  116.             return false;
  117.         }
  119.         return $event->getPayload();
  120.     }
  122.     /**
  123.      * {@inheritdoc}
  124.      */
  125.     public function parse(string $jwtToken): array
  126.     {
  127.         $payload = $this->jwtEncoder->decode($jwtToken);
  129.         $event = new JWTDecodedEvent($payload);
  130.         $this->dispatcher->dispatch($event, Events::JWT_DECODED);
  132.         if (!$event->isValid()) {
  133.             throw new JWTDecodeFailureException(JWTDecodeFailureException::INVALID_TOKEN, 'The token was marked as invalid by an event listener after successful decoding.');
  134.         }
  136.         return $event->getPayload();
  137.     }
  139.     /**
  140.      * Add user identity to payload, username by default.
  141.      * Override this if you need to identify it by another property.
  142.      *
  143.      * @param array &$payload
  144.      */
  145.     protected function addUserIdentityToPayload(UserInterface $user, array &$payload)
  146.     {
  147.         $accessor = PropertyAccess::createPropertyAccessor();
  149.         if ($user instanceof InMemoryUser && ('username' === $this->userIdClaim || 'username' === $this->userIdentityField)) {
  150.             $payload[$this->userIdClaim ?: $this->userIdentityField] = $accessor->getValue($user, 'userIdentifier');
  152.             return;
  153.         }
  155.         $payload[$this->userIdClaim ?: $this->userIdentityField] = $accessor->getValue($user, $accessor->isReadable($user, $this->userIdentityField) ? $this->userIdentityField : 'user_identifier');
  156.     }
  158.     /**
  159.      * {@inheritdoc}
  160.      */
  161.     public function getUserIdentityField(): string
  162.     {
  163.         if (0 === func_num_args() || func_get_arg(0)) {
  164.             trigger_deprecation('lexik/jwt-authentication-bundle', '2.15', 'The "%s()" method is deprecated.', __METHOD__);
  165.         }
  167.         return $this->userIdentityField;
  168.     }
  170.     /**
  171.      * {@inheritdoc}
  172.      */
  173.     public function setUserIdentityField($field)
  174.     {
  175.         if (1 >= func_num_args() || func_get_arg(1)) {
  176.             trigger_deprecation('lexik/jwt-authentication-bundle', '2.15', 'The "%s()" method is deprecated.', __METHOD__);
  177.         }
  179.         $this->userIdentityField = $field;
  180.     }
  182.     /**
  183.      * @return string
  184.      */
  185.     public function getUserIdClaim(): ?string
  186.     {
  187.         return $this->userIdClaim;
  188.     }
  189. }