src/Security/Guard/TokenAuthenticator.php line 15

Open in your IDE?
  1. <?php
  3. namespace App\Security\Guard;
  5. use Symfony\Component\HttpFoundation\JsonResponse;
  6. use Symfony\Component\HttpFoundation\Request;
  7. use Symfony\Component\HttpFoundation\Response;
  8. use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
  9. use Symfony\Component\Security\Core\Exception\AuthenticationException;
  10. use Symfony\Component\Security\Core\Exception\CustomUserMessageAuthenticationException;
  11. use Symfony\Component\Security\Http\Authenticator\AbstractAuthenticator;
  12. use Symfony\Component\Security\Http\Authenticator\Passport\Badge\UserBadge;
  13. use Symfony\Component\Security\Http\Authenticator\Passport\SelfValidatingPassport;
  15. class TokenAuthenticator extends AbstractAuthenticator
  16. {
  17.     /**
  18.      * Called on every request to decide if this authenticator should be
  19.      * used for the request. Returning `false` will cause this authenticator
  20.      * to be skipped.
  21.      * @param Request $request
  22.      * @return bool
  23.      */
  24.     public function supports(Request $request): ?bool
  25.     {
  26.         return $request->headers->has('X-AUTH-TOKEN');
  27.     }
  29.     public function authenticate(Request $request): SelfValidatingPassport
  30.     {
  31.         $apiToken = $request->headers->get('X-AUTH-TOKEN');
  32.         $apiKey = $_ENV['PUBLIC_API_KEY'] ?? null;
  33.         if (null === $apiToken || null === $apiKey || $apiToken !== $apiKey) {
  34.             // The token header was empty, authentication fails with HTTP Status
  35.             // Code 401 "Unauthorized"
  36.             throw new CustomUserMessageAuthenticationException('No API token provided');
  37.         }
  39.         return new SelfValidatingPassport(new UserBadge($apiToken));
  40.     }
  42.     public function onAuthenticationSuccess(Request $request, TokenInterface $token, string $firewallName): ?Response
  43.     {
  44.         // on success, let the request continue
  45.         return null;
  46.     }
  48.     public function onAuthenticationFailure(Request $request, AuthenticationException $exception): JsonResponse
  49.     {
  50.         $data = [
  51.             // you may want to customize or obfuscate the message first
  52.             'message' => strtr($exception->getMessageKey(), $exception->getMessageData())
  54.             // or to translate this message
  55.             // $this->translator->trans($exception->getMessageKey(), $exception->getMessageData())
  56.         ];
  58.         return new JsonResponse($data, Response::HTTP_UNAUTHORIZED);
  59.     }
  61.     /**
  62.      * Called when authentication is needed, but it's not sent
  63.      */
  64.     public function start(Request $request, AuthenticationException $authException = null): JsonResponse
  65.     {
  66.         $data = [
  67.             // you might translate this message
  68.             'message' => 'Authentication Required'
  69.         ];
  71.         return new JsonResponse($data, Response::HTTP_UNAUTHORIZED);
  72.     }
  74.     public function supportsRememberMe(): bool
  75.     {
  76.         return false;
  77.     }
  78. }