1	<?php
2
3	namespace App\Security\Authenticator;
4
5	use App\Security\ApiUser;
6	use App\Service\Data\ApiKeyServiceInterface;
7	use Symfony\Component\DependencyInjection\Attribute\Autowire;
8	use Symfony\Component\HttpFoundation\JsonResponse;
9	use Symfony\Component\HttpFoundation\Request;
10	use Symfony\Component\HttpFoundation\Response;
11	use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
12	use Symfony\Component\Security\Core\Exception\AuthenticationException;
13	use Symfony\Component\Security\Http\Authenticator\AbstractAuthenticator;
14	use Symfony\Component\Security\Http\Authenticator\Passport\Badge\UserBadge;
15	use Symfony\Component\Security\Http\Authenticator\Passport\Passport;
16	use Symfony\Component\Security\Http\Authenticator\Passport\SelfValidatingPassport;
17
18	/**
19	* @author Wilhelm Zwertvaegher
20	*/
21	class ClientAuthenticator extends AbstractAuthenticator
22	{
23	public function __construct(
24	#[Autowire('%client.api_key_header%')]
25	private readonly string $clientApiKeyHeader,
26	private readonly ApiKeyServiceInterface $apiKeyService,
27	) {
28	}
29
30	public function authenticate(Request $request): Passport
31	{
32	$clientApiKey = $request->headers->get($this->clientApiKeyHeader);
33
34	if (!$clientApiKey) {
35	throw new AuthenticationException('Invalid api key');
36	}
37
38	$apiKey = $this->apiKeyService->findValidKey($clientApiKey);
39	if (!$apiKey) {
40	throw new AuthenticationException('Invalid api key');
41	}
42
43	return new SelfValidatingPassport(
44	new UserBadge('client', fn (string $userIdentifier) => new ApiUser($userIdentifier, ['ROLE_CLIENT']))
45	);
46	}
47
48	public function supports(Request $request): ?bool
49	{
50	return $request->headers->has($this->clientApiKeyHeader);
51	}
52
53	public function onAuthenticationSuccess(Request $request, TokenInterface $token, string $firewallName): ?Response
54	{
55	return null;
56	}
57
58	public function onAuthenticationFailure(Request $request, AuthenticationException $exception): ?Response
59	{
60	$data = [
61	'message' => $exception->getMessage(),
62	];
63
64	return new JsonResponse($data, Response::HTTP_UNAUTHORIZED);
65	}
66	}

---

Branches

Below are the source code lines that represent each code branch as identified by Xdebug. Please note a branch is not necessarily coterminous with a line, a line may contain multiple branches and therefore show up more than once. Please also be aware that some branches may be implicit rather than explicit, e.g. an if statement always has an else as part of its logical flow even if you didn't write one.

ClientAuthenticator->__construct

23	public function __construct(
24	#[Autowire('%client.api_key_header%')]
25	private readonly string $clientApiKeyHeader,
26	private readonly ApiKeyServiceInterface $apiKeyService,
27	) {
28	}

ClientAuthenticator->authenticate

30	public function authenticate(Request $request): Passport
31	{
32	$clientApiKey = $request->headers->get($this->clientApiKeyHeader);
33
34	if (!$clientApiKey) {

35	throw new AuthenticationException('Invalid api key');

38	$apiKey = $this->apiKeyService->findValidKey($clientApiKey);
39	if (!$apiKey) {

40	throw new AuthenticationException('Invalid api key');

43	return new SelfValidatingPassport(
44	new UserBadge('client', fn (string $userIdentifier) => new ApiUser($userIdentifier, ['ROLE_CLIENT']))
45	);
46	}

ClientAuthenticator->onAuthenticationFailure

58	public function onAuthenticationFailure(Request $request, AuthenticationException $exception): ?Response
59	{
60	$data = [
61	'message' => $exception->getMessage(),
62	];
63
64	return new JsonResponse($data, Response::HTTP_UNAUTHORIZED);
65	}

ClientAuthenticator->onAuthenticationSuccess

53	public function onAuthenticationSuccess(Request $request, TokenInterface $token, string $firewallName): ?Response
54	{
55	return null;
56	}

ClientAuthenticator->supports

48	public function supports(Request $request): ?bool
49	{
50	return $request->headers->has($this->clientApiKeyHeader);
51	}

{closure:/home/runner/work/nick-me/nick-me/backend/src/Security/Authenticator/ClientAuthenticator.php:44-44}

44	new UserBadge('client', fn (string $userIdentifier) => new ApiUser($userIdentifier, ['ROLE_CLIENT']))

{main}

3	namespace App\Security\Authenticator;
4
5	use App\Security\ApiUser;
6	use App\Service\Data\ApiKeyServiceInterface;
7	use Symfony\Component\DependencyInjection\Attribute\Autowire;
8	use Symfony\Component\HttpFoundation\JsonResponse;
9	use Symfony\Component\HttpFoundation\Request;
10	use Symfony\Component\HttpFoundation\Response;
11	use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
12	use Symfony\Component\Security\Core\Exception\AuthenticationException;
13	use Symfony\Component\Security\Http\Authenticator\AbstractAuthenticator;
14	use Symfony\Component\Security\Http\Authenticator\Passport\Badge\UserBadge;
15	use Symfony\Component\Security\Http\Authenticator\Passport\Passport;
16	use Symfony\Component\Security\Http\Authenticator\Passport\SelfValidatingPassport;
17
18	/**
19	* @author Wilhelm Zwertvaegher
20	*/
21	class ClientAuthenticator extends AbstractAuthenticator
22	{
23	public function __construct(
24	#[Autowire('%client.api_key_header%')]
25	private readonly string $clientApiKeyHeader,
26	private readonly ApiKeyServiceInterface $apiKeyService,
27	) {
28	}
29
30	public function authenticate(Request $request): Passport
31	{
32	$clientApiKey = $request->headers->get($this->clientApiKeyHeader);
33
34	if (!$clientApiKey) {
35	throw new AuthenticationException('Invalid api key');
36	}
37
38	$apiKey = $this->apiKeyService->findValidKey($clientApiKey);
39	if (!$apiKey) {
40	throw new AuthenticationException('Invalid api key');
41	}
42
43	return new SelfValidatingPassport(
44	new UserBadge('client', fn (string $userIdentifier) => new ApiUser($userIdentifier, ['ROLE_CLIENT']))
45	);
46	}
47
48	public function supports(Request $request): ?bool
49	{
50	return $request->headers->has($this->clientApiKeyHeader);
51	}
52
53	public function onAuthenticationSuccess(Request $request, TokenInterface $token, string $firewallName): ?Response
54	{
55	return null;
56	}
57
58	public function onAuthenticationFailure(Request $request, AuthenticationException $exception): ?Response
59	{
60	$data = [
61	'message' => $exception->getMessage(),
62	];
63
64	return new JsonResponse($data, Response::HTTP_UNAUTHORIZED);
65	}