'Auth header required' ]; return new JsonResponse($data, Response::HTTP_UNAUTHORIZED); } /** * Does the authenticator support the given Request? * * If this returns false, the authenticator will be skipped. * * @param Request $request * * @return bool */ public function supports(Request $request) { return !empty($request->headers->get('Authorization')); } /** * Get the authentication credentials from the request and return them * as any type (e.g. an associate array). * * Whatever value you return here will be passed to getUser() and checkCredentials() * * For example, for a form login, you might: * * return [ * 'username' => $request->request->get('_username'), * 'password' => $request->request->get('_password'), * ]; * * Or for an API token that's on a header, you might use: * * return ['api_key' => $request->headers->get('X-API-TOKEN')]; * * @param Request $request * * @return mixed Any non-null value * * @throws \UnexpectedValueException If null is returned */ public function getCredentials(Request $request) { return [ 'token' => $request->headers->get('Authorization'), ]; } /** * Return a UserInterface object based on the credentials. * * The *credentials* are the return value from getCredentials() * * You may throw an AuthenticationException if you wish. If you return * null, then a UsernameNotFoundException is thrown for you. * * @param mixed $credentials * @param UserProviderInterface $userProvider * * @throws AuthenticationException * * @return UserInterface|null */ public function getUser($credentials, UserProviderInterface $userProvider) { $token = $credentials['token']; if (!$token) { throw new BadCredentialsException('Token is not present in the request headers'); } try { $user = $userProvider->loadUserByUsername($this->formatToken($token)); } catch (\Exception $e) { throw new BadCredentialsException(sprintf('Error when introspecting the token: %s', $e->getMessage())); } return $user; } /** * Returns true if the credentials are valid. * * If any value other than true is returned, authentication will * fail. You may also throw an AuthenticationException if you wish * to cause authentication to fail. * * The *credentials* are the return value from getCredentials() * * @param mixed $credentials * @param UserInterface $user * * @return bool * * @throws AuthenticationException */ public function checkCredentials($credentials, UserInterface $user) { return true; } /** * Called when authentication executed, but failed (e.g. wrong username password). * * This should return the Response sent back to the user, like a * RedirectResponse to the login page or a 403 response. * * If you return null, the request will continue, but the user will * not be authenticated. This is probably not what you want to do. * * @param Request $request * @param AuthenticationException $exception * * @return Response|null */ public function onAuthenticationFailure(Request $request, AuthenticationException $exception) { return new JsonResponse(['error' => $exception->getMessage()], Response::HTTP_FORBIDDEN); } /** * Called when authentication executed and was successful! * * This should return the Response sent back to the user, like a * RedirectResponse to the last page they visited. * * If you return null, the current request will continue, and the user * will be authenticated. This makes sense, for example, with an API. * * @param Request $request * @param TokenInterface $token * @param string $providerKey The provider (i.e. firewall) key * * @return Response|null */ public function onAuthenticationSuccess(Request $request, TokenInterface $token, $providerKey) { return null; } /** * Does this method support remember me cookies? * * Remember me cookie will be set if *all* of the following are met: * A) This method returns true * B) The remember_me key under your firewall is configured * C) The "remember me" functionality is activated. This is usually * done by having a _remember_me checkbox in your form, but * can be configured by the "always_remember_me" and "remember_me_parameter" * parameters under the "remember_me" firewall key * D) The onAuthenticationSuccess method returns a Response object * * @return bool */ public function supportsRememberMe() { return false; } /** * @param string $token * @return string */ protected function formatToken(string $token): string { return trim(preg_replace('/^(?:\s+)?[B-b]earer\s/', '', $token)); } }