vendor/symfony/security-http/Authenticator/Debug/TraceableAuthenticator.php line 60

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Security\Http\Authenticator\Debug;
  14. use Symfony\Component\HttpFoundation\Request;
  15. use Symfony\Component\HttpFoundation\Response;
  16. use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
  17. use Symfony\Component\Security\Core\Exception\AuthenticationException;
  18. use Symfony\Component\Security\Http\Authenticator\AuthenticatorInterface;
  19. use Symfony\Component\Security\Http\Authenticator\InteractiveAuthenticatorInterface;
  20. use Symfony\Component\Security\Http\Authenticator\Passport\Passport;
  21. use Symfony\Component\Security\Http\EntryPoint\AuthenticationEntryPointInterface;
  22. use Symfony\Component\Security\Http\EntryPoint\Exception\NotAnEntryPointException;
  23. use Symfony\Component\VarDumper\Caster\ClassStub;
  25. /**
  26.  * Collects info about an authenticator for debugging purposes.
  27.  *
  28.  * @author Robin Chalas <robin.chalas@gmail.com>
  29.  */
  30. final class TraceableAuthenticator implements AuthenticatorInterface, InteractiveAuthenticatorInterface, AuthenticationEntryPointInterface
  31. {
  32.     private AuthenticatorInterface $authenticator;
  33.     private ?Passport $passport = null;
  34.     private ?float $duration = null;
  35.     private ClassStub|string $stub;
  37.     public function __construct(AuthenticatorInterface $authenticator)
  38.     {
  39.         $this->authenticator = $authenticator;
  40.     }
  42.     public function getInfo(): array
  43.     {
  44.         return [
  45.             'supports' => true,
  46.             'passport' => $this->passport,
  47.             'duration' => $this->duration,
  48.             'stub' => $this->stub ??= class_exists(ClassStub::class) ? new ClassStub(\get_class($this->authenticator)) : \get_class($this->authenticator),
  49.         ];
  50.     }
  52.     public function supports(Request $request): ?bool
  53.     {
  54.         return $this->authenticator->supports($request);
  55.     }
  57.     public function authenticate(Request $request): Passport
  58.     {
  59.         $startTime = microtime(true);
  60.         $this->passport = $this->authenticator->authenticate($request);
  61.         $this->duration = microtime(true) - $startTime;
  63.         return $this->passport;
  64.     }
  66.     public function createToken(Passport $passport, string $firewallName): TokenInterface
  67.     {
  68.         return $this->authenticator->createToken($passport, $firewallName);
  69.     }
  71.     public function onAuthenticationSuccess(Request $request, TokenInterface $token, string $firewallName): ?Response
  72.     {
  73.         return $this->authenticator->onAuthenticationSuccess($request, $token, $firewallName);
  74.     }
  76.     public function onAuthenticationFailure(Request $request, AuthenticationException $exception): ?Response
  77.     {
  78.         return $this->authenticator->onAuthenticationFailure($request, $exception);
  79.     }
  81.     public function start(Request $request, AuthenticationException $authException = null): Response
  82.     {
  83.         if (!$this->authenticator instanceof AuthenticationEntryPointInterface) {
  84.             throw new NotAnEntryPointException();
  85.         }
  87.         return $this->authenticator->start($request, $authException);
  88.     }
  90.     public function isInteractive(): bool
  91.     {
  92.         return $this->authenticator instanceof InteractiveAuthenticatorInterface && $this->authenticator->isInteractive();
  93.     }
  95.     /**
  96.      * @internal
  97.      */
  98.     public function getAuthenticator(): AuthenticatorInterface
  99.     {
  100.         return $this->authenticator;
  101.     }
  103.     public function __call($method, $args)
  104.     {
  105.         return $this->authenticator->{$method}(...$args);
  106.     }
  107. }