src/Security/TokenAuthenticator.php line 16

Open in your IDE?
  1. <?php
  2. // src/Security/TokenAuthenticator.php
  3. namespace App\Security;
  5. use App\Entity\User;
  6. use Doctrine\ORM\EntityManagerInterface;
  7. use Symfony\Component\HttpFoundation\JsonResponse;
  8. use Symfony\Component\HttpFoundation\Request;
  9. use Symfony\Component\HttpFoundation\Response;
  10. use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
  11. use Symfony\Component\Security\Core\Exception\AuthenticationException;
  12. use Symfony\Component\Security\Core\User\UserInterface;
  13. use Symfony\Component\Security\Core\User\UserProviderInterface;
  14. use Symfony\Component\Security\Guard\AbstractGuardAuthenticator;
  16. class TokenAuthenticator extends AbstractGuardAuthenticator
  17. {
  18.     private $em;
  20.     public function __construct(EntityManagerInterface $em)
  21.     {
  22.         $this->em = $em;
  23.     }
  25.     /**
  26.      * Called on every request to decide if this authenticator should be
  27.      * used for the request. Returning `false` will cause this authenticator
  28.      * to be skipped.
  29.      */
  30.     public function supports(Request $request)
  31.     {
  32.         return $request->headers->has('InQuize-AUTH-TOKEN');
  33.     }
  35.     /**
  36.      * Called on every request. Return whatever credentials you want to
  37.      * be passed to getUser() as $credentials.
  38.      */
  39.     public function getCredentials(Request $request)
  40.     {
  41.         return $request->headers->get('InQuize-AUTH-TOKEN');
  42.     }
  44.     public function getUser($credentials, UserProviderInterface $userProvider)
  45.     {
  46.         if (null === $credentials) {
  47.             // The token header was empty, authentication fails with HTTP Status
  48.             // Code 401 "Unauthorized"
  49.             return null;
  50.         }
  52.         // The "username" in this case is the apiToken, see the key `property`
  53.         // of `your_db_provider` in `security.yaml`.
  54.         // If this returns a user, checkCredentials() is called next:
  55.         return $userProvider->loadUserByUsername($credentials);
  56.     }
  58.     public function checkCredentials($credentials, UserInterface $user)
  59.     {
  60.         // Check credentials - e.g. make sure the password is valid.
  61.         // In case of an API token, no credential check is needed.
  63.         // Return `true` to cause authentication success
  64.         return true;
  65.     }
  67.     public function onAuthenticationSuccess(Request $request, TokenInterface $token, $providerKey)
  68.     {
  69.         // on success, let the request continue
  70.         return null;
  71.     }
  73.     public function onAuthenticationFailure(Request $request, AuthenticationException $exception)
  74.     {
  75.         $data = [
  76.             // you may want to customize or obfuscate the message first
  77.             'message' => strtr($exception->getMessageKey(), $exception->getMessageData())
  79.             // or to translate this message
  80.             // $this->translator->trans($exception->getMessageKey(), $exception->getMessageData())
  81.         ];
  83.         return new JsonResponse($data, Response::HTTP_UNAUTHORIZED);
  84.     }
  86.     /**
  87.      * Called when authentication is needed, but it's not sent
  88.      */
  89.     public function start(Request $request, AuthenticationException $authException = null)
  90.     {
  91.         $data = [
  92.             // you might translate this message
  93.             'message' => 'Authentication Required'
  94.         ];
  96.         return new JsonResponse($data, Response::HTTP_UNAUTHORIZED);
  97.     }
  99.     public function supportsRememberMe()
  100.     {
  101.         return false;
  102.     }
  103. }