vendor/web-token/jwt-bundle/DataCollector/CheckerCollector.php line 110

  1. <?php
  3. declare(strict_types=1);
  5. namespace Jose\Bundle\JoseFramework\DataCollector;
  7. use Jose\Bundle\JoseFramework\Event\ClaimCheckedFailureEvent;
  8. use Jose\Bundle\JoseFramework\Event\ClaimCheckedSuccessEvent;
  9. use Jose\Bundle\JoseFramework\Event\HeaderCheckedFailureEvent;
  10. use Jose\Bundle\JoseFramework\Event\HeaderCheckedSuccessEvent;
  11. use Jose\Bundle\JoseFramework\Services\ClaimCheckerManager;
  12. use Jose\Bundle\JoseFramework\Services\ClaimCheckerManagerFactory;
  13. use Jose\Bundle\JoseFramework\Services\HeaderCheckerManager;
  14. use Jose\Bundle\JoseFramework\Services\HeaderCheckerManagerFactory;
  15. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  16. use Symfony\Component\HttpFoundation\Request;
  17. use Symfony\Component\HttpFoundation\Response;
  18. use Symfony\Component\VarDumper\Cloner\Data;
  19. use Symfony\Component\VarDumper\Cloner\VarCloner;
  20. use Throwable;
  22. class CheckerCollector implements Collector, EventSubscriberInterface
  23. {
  24.     /**
  25.      * @var array<Data>
  26.      */
  27.     private array $headerCheckedSuccesses = [];
  29.     /**
  30.      * @var array<Data>
  31.      */
  32.     private array $headerCheckedFailures = [];
  34.     /**
  35.      * @var array<Data>
  36.      */
  37.     private array $claimCheckedSuccesses = [];
  39.     /**
  40.      * @var array<Data>
  41.      */
  42.     private array $claimCheckedFailures = [];
  44.     /**
  45.      * @var array<HeaderCheckerManager>
  46.      */
  47.     private array $headerCheckerManagers = [];
  49.     /**
  50.      * @var array<ClaimCheckerManager>
  51.      */
  52.     private array $claimCheckerManagers = [];
  54.     public function __construct(
  55.         private readonly ?ClaimCheckerManagerFactory $claimCheckerManagerFactory = null,
  56.         private readonly ?HeaderCheckerManagerFactory $headerCheckerManagerFactory = null
  57.     ) {
  58.     }
  60.     /**
  61.      * @param array<string, mixed> $data
  62.      */
  63.     public function collect(array &$data, Request $request, Response $response, ?Throwable $exception = null): void
  64.     {
  65.         $this->collectHeaderCheckerManagers($data);
  66.         $this->collectSupportedHeaderCheckers($data);
  67.         $this->collectClaimCheckerManagers($data);
  68.         $this->collectSupportedClaimCheckers($data);
  69.         $this->collectEvents($data);
  70.     }
  72.     public function addHeaderCheckerManager(string $id, HeaderCheckerManager $headerCheckerManager): void
  73.     {
  74.         $this->headerCheckerManagers[$id] = $headerCheckerManager;
  75.     }
  77.     public function addClaimCheckerManager(string $id, ClaimCheckerManager $claimCheckerManager): void
  78.     {
  79.         $this->claimCheckerManagers[$id] = $claimCheckerManager;
  80.     }
  82.     public static function getSubscribedEvents(): array
  83.     {
  84.         return [
  85.             HeaderCheckedSuccessEvent::class => ['catchHeaderCheckSuccess'],
  86.             HeaderCheckedFailureEvent::class => ['catchHeaderCheckFailure'],
  87.             ClaimCheckedSuccessEvent::class => ['catchClaimCheckSuccess'],
  88.             ClaimCheckedFailureEvent::class => ['catchClaimCheckFailure'],
  89.         ];
  90.     }
  92.     public function catchHeaderCheckSuccess(HeaderCheckedSuccessEvent $event): void
  93.     {
  94.         $cloner = new VarCloner();
  95.         $this->headerCheckedSuccesses[] = $cloner->cloneVar($event);
  96.     }
  98.     public function catchHeaderCheckFailure(HeaderCheckedFailureEvent $event): void
  99.     {
  100.         $cloner = new VarCloner();
  101.         $this->headerCheckedFailures[] = $cloner->cloneVar($event);
  102.     }
  104.     public function catchClaimCheckSuccess(ClaimCheckedSuccessEvent $event): void
  105.     {
  106.         $cloner = new VarCloner();
  107.         $this->claimCheckedSuccesses[] = $cloner->cloneVar($event);
  108.     }
  110.     public function catchClaimCheckFailure(ClaimCheckedFailureEvent $event): void
  111.     {
  112.         $cloner = new VarCloner();
  113.         $this->claimCheckedFailures[] = $cloner->cloneVar($event);
  114.     }
  116.     /**
  117.      * @param array<string, array<string, mixed>> $data
  118.      */
  119.     private function collectHeaderCheckerManagers(array &$data): void
  120.     {
  121.         $data['checker']['header_checker_managers'] = [];
  122.         foreach ($this->headerCheckerManagers as $id => $checkerManager) {
  123.             $data['checker']['header_checker_managers'][$id] = [];
  124.             foreach ($checkerManager->getCheckers() as $checker) {
  125.                 $data['checker']['header_checker_managers'][$id][] = [
  126.                     'header' => $checker->supportedHeader(),
  127.                     'protected' => $checker->protectedHeaderOnly(),
  128.                 ];
  129.             }
  130.         }
  131.     }
  133.     /**
  134.      * @param array<string, array<string, mixed>> $data
  135.      */
  136.     private function collectSupportedHeaderCheckers(array &$data): void
  137.     {
  138.         $data['checker']['header_checkers'] = [];
  139.         if ($this->headerCheckerManagerFactory !== null) {
  140.             $aliases = $this->headerCheckerManagerFactory->all();
  141.             foreach ($aliases as $alias => $checker) {
  142.                 $data['checker']['header_checkers'][$alias] = [
  143.                     'header' => $checker->supportedHeader(),
  144.                     'protected' => $checker->protectedHeaderOnly(),
  145.                 ];
  146.             }
  147.         }
  148.     }
  150.     /**
  151.      * @param array<string, array<string, mixed>> $data
  152.      */
  153.     private function collectClaimCheckerManagers(array &$data): void
  154.     {
  155.         $data['checker']['claim_checker_managers'] = [];
  156.         foreach ($this->claimCheckerManagers as $id => $checkerManager) {
  157.             $data['checker']['claim_checker_managers'][$id] = [];
  158.             foreach ($checkerManager->getCheckers() as $checker) {
  159.                 $data['checker']['claim_checker_managers'][$id][] = [
  160.                     'claim' => $checker->supportedClaim(),
  161.                 ];
  162.             }
  163.         }
  164.     }
  166.     /**
  167.      * @param array<string, array<string, mixed>> $data
  168.      */
  169.     private function collectSupportedClaimCheckers(array &$data): void
  170.     {
  171.         $data['checker']['claim_checkers'] = [];
  172.         if ($this->claimCheckerManagerFactory !== null) {
  173.             $aliases = $this->claimCheckerManagerFactory->all();
  174.             foreach ($aliases as $alias => $checker) {
  175.                 $data['checker']['claim_checkers'][$alias] = [
  176.                     'claim' => $checker->supportedClaim(),
  177.                 ];
  178.             }
  179.         }
  180.     }
  182.     /**
  183.      * @param array<string, array<string, mixed>> $data
  184.      */
  185.     private function collectEvents(array &$data): void
  186.     {
  187.         $data['checker']['events'] = [
  188.             'header_check_success' => $this->headerCheckedSuccesses,
  189.             'header_check_failure' => $this->headerCheckedFailures,
  190.             'claim_check_success' => $this->claimCheckedSuccesses,
  191.             'claim_check_failure' => $this->claimCheckedFailures,
  192.         ];
  193.     }
  194. }