src/Security/ApiKeyAuthenticator.php line 16

Open in your IDE?
  1. <?php
  3. namespace App\Security;
  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\Passport;
  14. use Symfony\Component\Security\Http\Authenticator\Passport\SelfValidatingPassport;
  16. class ApiKeyAuthenticator extends AbstractAuthenticator
  17. {
  18.     /**
  19.      * Called on every request to decide if this authenticator should be
  20.      * used for the request. Returning `false` will cause this authenticator
  21.      * to be skipped.
  22.      */
  23.     public function supports(Request $request): ?bool
  24.     {
  25.         return $request->headers->has('x-api-key');
  26.     }
  28.     public function authenticate(Request $request): Passport
  29.     {
  30.         $apiToken = $request->headers->get('x-api-key');
  31.         if (null === $apiToken) {
  32.             // The token header was empty, authentication fails with HTTP Status
  33.             // Code 401 "Unauthorized"
  34.             throw new CustomUserMessageAuthenticationException('No API token provided');
  35.         }
  37.         return new SelfValidatingPassport(new UserBadge($apiToken));
  38.     }
  40.     public function onAuthenticationSuccess(Request $request, TokenInterface $token, string $firewallName): ?Response
  41.     {
  42.         // on success, let the request continue
  43.         return null;
  44.     }
  46.     public function onAuthenticationFailure(Request $request, AuthenticationException $exception): ?Response
  47.     {
  48.         $data = [
  49.             // you may want to customize or obfuscate the message first
  50.             'message' => strtr($exception->getMessageKey(), $exception->getMessageData())
  52.             // or to translate this message
  53.             // $this->translator->trans($exception->getMessageKey(), $exception->getMessageData())
  54.         ];
  56.         return new JsonResponse($data, Response::HTTP_UNAUTHORIZED);
  57.     }
  58. }