vendor/symfony/security-http/Authenticator/JsonLoginAuthenticator.php line 82

  1. <?php
  3. /*
  4. * This file is part of the Symfony package.
  5. *
  6. * (c) Fabien Potencier <[email protected]>
  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\Authenticator;
  14. use Symfony\Component\HttpFoundation\JsonResponse;
  15. use Symfony\Component\HttpFoundation\Request;
  16. use Symfony\Component\HttpFoundation\Response;
  17. use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
  18. use Symfony\Component\PropertyAccess\Exception\AccessException;
  19. use Symfony\Component\PropertyAccess\PropertyAccess;
  20. use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
  21. use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
  22. use Symfony\Component\Security\Core\Authentication\Token\UsernamePasswordToken;
  23. use Symfony\Component\Security\Core\Exception\AuthenticationException;
  24. use Symfony\Component\Security\Core\User\PasswordUpgraderInterface;
  25. use Symfony\Component\Security\Core\User\UserProviderInterface;
  26. use Symfony\Component\Security\Http\Authentication\AuthenticationFailureHandlerInterface;
  27. use Symfony\Component\Security\Http\Authentication\AuthenticationSuccessHandlerInterface;
  28. use Symfony\Component\Security\Http\Authenticator\Passport\Badge\PasswordUpgradeBadge;
  29. use Symfony\Component\Security\Http\Authenticator\Passport\Badge\RememberMeBadge;
  30. use Symfony\Component\Security\Http\Authenticator\Passport\Badge\UserBadge;
  31. use Symfony\Component\Security\Http\Authenticator\Passport\Credentials\PasswordCredentials;
  32. use Symfony\Component\Security\Http\Authenticator\Passport\Passport;
  33. use Symfony\Component\Security\Http\HttpUtils;
  34. use Symfony\Contracts\Translation\TranslatorInterface;
  36. /**
  37. * Provides a stateless implementation of an authentication via
  38. * a JSON document composed of a username and a password.
  39. *
  40. * @author Kévin Dunglas <[email protected]>
  41. * @author Wouter de Jong <[email protected]>
  42. *
  43. * @final
  44. */
  45. class JsonLoginAuthenticator implements InteractiveAuthenticatorInterface
  46. {
  47. private array $options;
  48. private PropertyAccessorInterface $propertyAccessor;
  49. private ?TranslatorInterface $translator = null;
  51. public function __construct(
  52. private HttpUtils $httpUtils,
  53. private UserProviderInterface $userProvider,
  54. private ?AuthenticationSuccessHandlerInterface $successHandler = null,
  55. private ?AuthenticationFailureHandlerInterface $failureHandler = null,
  56. array $options = [],
  57. ?PropertyAccessorInterface $propertyAccessor = null,
  58. ) {
  59. $this->options = array_merge(['username_path' => 'username', 'password_path' => 'password'], $options);
  60. $this->propertyAccessor = $propertyAccessor ?: PropertyAccess::createPropertyAccessor();
  61. }
  63. public function supports(Request $request): ?bool
  64. {
  65. if (
  66. !str_contains($request->getRequestFormat() ?? '', 'json')
  67. && !str_contains($request->getContentTypeFormat() ?? '', 'json')
  68. ) {
  69. return false;
  70. }
  72. if (isset($this->options['check_path']) && !$this->httpUtils->checkRequestPath($request, $this->options['check_path'])) {
  73. return false;
  74. }
  76. return true;
  77. }
  79. public function authenticate(Request $request): Passport
  80. {
  81. try {
  82. $data = json_decode($request->getContent());
  83. if (!$data instanceof \stdClass) {
  84. throw new BadRequestHttpException('Invalid JSON.');
  85. }
  87. $credentials = $this->getCredentials($data);
  88. } catch (BadRequestHttpException $e) {
  89. $request->setRequestFormat('json');
  91. throw $e;
  92. }
  94. $userBadge = new UserBadge($credentials['username'], $this->userProvider->loadUserByIdentifier(...));
  95. $passport = new Passport($userBadge, new PasswordCredentials($credentials['password']), [new RememberMeBadge((array) $data)]);
  97. if ($this->userProvider instanceof PasswordUpgraderInterface) {
  98. $passport->addBadge(new PasswordUpgradeBadge($credentials['password'], $this->userProvider));
  99. }
  101. return $passport;
  102. }
  104. public function createToken(Passport $passport, string $firewallName): TokenInterface
  105. {
  106. return new UsernamePasswordToken($passport->getUser(), $firewallName, $passport->getUser()->getRoles());
  107. }
  109. public function onAuthenticationSuccess(Request $request, TokenInterface $token, string $firewallName): ?Response
  110. {
  111. if (null === $this->successHandler) {
  112. return null; // let the original request continue
  113. }
  115. return $this->successHandler->onAuthenticationSuccess($request, $token);
  116. }
  118. public function onAuthenticationFailure(Request $request, AuthenticationException $exception): ?Response
  119. {
  120. if (null === $this->failureHandler) {
  121. if (null !== $this->translator) {
  122. $errorMessage = $this->translator->trans($exception->getMessageKey(), $exception->getMessageData(), 'security');
  123. } else {
  124. $errorMessage = strtr($exception->getMessageKey(), $exception->getMessageData());
  125. }
  127. return new JsonResponse(['error' => $errorMessage], JsonResponse::HTTP_UNAUTHORIZED);
  128. }
  130. return $this->failureHandler->onAuthenticationFailure($request, $exception);
  131. }
  133. public function isInteractive(): bool
  134. {
  135. return true;
  136. }
  138. public function setTranslator(TranslatorInterface $translator): void
  139. {
  140. $this->translator = $translator;
  141. }
  143. private function getCredentials(\stdClass $data): array
  144. {
  145. $credentials = [];
  146. try {
  147. $credentials['username'] = $this->propertyAccessor->getValue($data, $this->options['username_path']);
  149. if (!\is_string($credentials['username']) || '' === $credentials['username']) {
  150. throw new BadRequestHttpException(\sprintf('The key "%s" must be a non-empty string.', $this->options['username_path']));
  151. }
  152. } catch (AccessException $e) {
  153. throw new BadRequestHttpException(\sprintf('The key "%s" must be provided.', $this->options['username_path']), $e);
  154. }
  156. try {
  157. $credentials['password'] = $this->propertyAccessor->getValue($data, $this->options['password_path']);
  158. $this->propertyAccessor->setValue($data, $this->options['password_path'], null);
  160. if (!\is_string($credentials['password']) || '' === $credentials['password']) {
  161. throw new BadRequestHttpException(\sprintf('The key "%s" must be a non-empty string.', $this->options['password_path']));
  162. }
  163. } catch (AccessException $e) {
  164. throw new BadRequestHttpException(\sprintf('The key "%s" must be provided.', $this->options['password_path']), $e);
  165. }
  167. return $credentials;
  168. }
  169. }