vendor/web-token/jwt-bundle/DataCollector/JWSCollector.php line 119

  1. <?php
  3. declare(strict_types=1);
  5. namespace Jose\Bundle\JoseFramework\DataCollector;
  7. use Jose\Bundle\JoseFramework\Event\JWSBuiltFailureEvent;
  8. use Jose\Bundle\JoseFramework\Event\JWSBuiltSuccessEvent;
  9. use Jose\Bundle\JoseFramework\Event\JWSVerificationFailureEvent;
  10. use Jose\Bundle\JoseFramework\Event\JWSVerificationSuccessEvent;
  11. use Jose\Component\Signature\JWSBuilder;
  12. use Jose\Component\Signature\JWSLoader;
  13. use Jose\Component\Signature\JWSVerifier;
  14. use Jose\Component\Signature\Serializer\JWSSerializerManagerFactory;
  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 JWSCollector implements Collector, EventSubscriberInterface
  23. {
  24.     /**
  25.      * @var array<JWSBuilder>
  26.      */
  27.     private array $jwsBuilders = [];
  29.     /**
  30.      * @var JWSVerifier[]
  31.      */
  32.     private array $jwsVerifiers = [];
  34.     /**
  35.      * @var JWSLoader[]
  36.      */
  37.     private array $jwsLoaders = [];
  39.     /**
  40.      * @var array<Data>
  41.      */
  42.     private array $jwsVerificationSuccesses = [];
  44.     /**
  45.      * @var array<Data>
  46.      */
  47.     private array $jwsVerificationFailures = [];
  49.     /**
  50.      * @var array<Data>
  51.      */
  52.     private array $jwsBuiltSuccesses = [];
  54.     /**
  55.      * @var array<Data>
  56.      */
  57.     private array $jwsBuiltFailures = [];
  59.     public function __construct(
  60.         private readonly ?JWSSerializerManagerFactory $jwsSerializerManagerFactory = null
  61.     ) {
  62.     }
  64.     /**
  65.      * @param array<string, mixed> $data
  66.      */
  67.     public function collect(array &$data, Request $request, Response $response, ?Throwable $exception = null): void
  68.     {
  69.         $this->collectSupportedJWSSerializations($data);
  70.         $this->collectSupportedJWSBuilders($data);
  71.         $this->collectSupportedJWSVerifiers($data);
  72.         $this->collectSupportedJWSLoaders($data);
  73.         $this->collectEvents($data);
  74.     }
  76.     public function addJWSBuilder(string $id, JWSBuilder $jwsBuilder): void
  77.     {
  78.         $this->jwsBuilders[$id] = $jwsBuilder;
  79.     }
  81.     public function addJWSVerifier(string $id, JWSVerifier $jwsVerifier): void
  82.     {
  83.         $this->jwsVerifiers[$id] = $jwsVerifier;
  84.     }
  86.     public function addJWSLoader(string $id, JWSLoader $jwsLoader): void
  87.     {
  88.         $this->jwsLoaders[$id] = $jwsLoader;
  89.     }
  91.     public static function getSubscribedEvents(): array
  92.     {
  93.         return [
  94.             JWSVerificationSuccessEvent::class => ['catchJwsVerificationSuccess'],
  95.             JWSVerificationFailureEvent::class => ['catchJwsVerificationFailure'],
  96.             JWSBuiltSuccessEvent::class => ['catchJwsBuiltSuccess'],
  97.             JWSBuiltFailureEvent::class => ['catchJwsBuiltFailure'],
  98.         ];
  99.     }
  101.     public function catchJwsVerificationSuccess(JWSVerificationSuccessEvent $event): void
  102.     {
  103.         $cloner = new VarCloner();
  104.         $this->jwsVerificationSuccesses[] = $cloner->cloneVar($event);
  105.     }
  107.     public function catchJwsVerificationFailure(JWSVerificationFailureEvent $event): void
  108.     {
  109.         $cloner = new VarCloner();
  110.         $this->jwsVerificationFailures[] = $cloner->cloneVar($event);
  111.     }
  113.     public function catchJwsBuiltSuccess(JWSBuiltSuccessEvent $event): void
  114.     {
  115.         $cloner = new VarCloner();
  116.         $this->jwsBuiltSuccesses[] = $cloner->cloneVar($event);
  117.     }
  119.     public function catchJwsBuiltFailure(JWSBuiltFailureEvent $event): void
  120.     {
  121.         $cloner = new VarCloner();
  122.         $this->jwsBuiltFailures[] = $cloner->cloneVar($event);
  123.     }
  125.     /**
  126.      * @param array<string, array<string, mixed>> $data
  127.      */
  128.     private function collectSupportedJWSSerializations(array &$data): void
  129.     {
  130.         $data['jws']['jws_serialization'] = [];
  131.         if ($this->jwsSerializerManagerFactory === null) {
  132.             return;
  133.         }
  134.         $serializers = $this->jwsSerializerManagerFactory->all();
  135.         foreach ($serializers as $serializer) {
  136.             $data['jws']['jws_serialization'][$serializer->name()] = $serializer->displayName();
  137.         }
  138.     }
  140.     /**
  141.      * @param array<string, array<string, mixed>> $data
  142.      */
  143.     private function collectSupportedJWSBuilders(array &$data): void
  144.     {
  145.         $data['jws']['jws_builders'] = [];
  146.         foreach ($this->jwsBuilders as $id => $jwsBuilder) {
  147.             $data['jws']['jws_builders'][$id] = [
  148.                 'signature_algorithms' => $jwsBuilder->getSignatureAlgorithmManager()
  149.                     ->list(),
  150.             ];
  151.         }
  152.     }
  154.     /**
  155.      * @param array<string, array<string, mixed>> $data
  156.      */
  157.     private function collectSupportedJWSVerifiers(array &$data): void
  158.     {
  159.         $data['jws']['jws_verifiers'] = [];
  160.         foreach ($this->jwsVerifiers as $id => $jwsVerifier) {
  161.             $data['jws']['jws_verifiers'][$id] = [
  162.                 'signature_algorithms' => $jwsVerifier->getSignatureAlgorithmManager()
  163.                     ->list(),
  164.             ];
  165.         }
  166.     }
  168.     /**
  169.      * @param array<string, array<string, mixed>> $data
  170.      */
  171.     private function collectSupportedJWSLoaders(array &$data): void
  172.     {
  173.         $data['jws']['jws_loaders'] = [];
  174.         foreach ($this->jwsLoaders as $id => $jwsLoader) {
  175.             $data['jws']['jws_loaders'][$id] = [
  176.                 'serializers' => $jwsLoader->getSerializerManager()
  177.                     ->list(),
  178.                 'signature_algorithms' => $jwsLoader->getJwsVerifier()
  179.                     ->getSignatureAlgorithmManager()
  180.                     ->list(),
  181.             ];
  182.         }
  183.     }
  185.     /**
  186.      * @param array<string, array<string, mixed>> $data
  187.      */
  188.     private function collectEvents(array &$data): void
  189.     {
  190.         $data['jws']['events'] = [
  191.             'verification_success' => $this->jwsVerificationSuccesses,
  192.             'verification_failure' => $this->jwsVerificationFailures,
  193.             'built_success' => $this->jwsBuiltSuccesses,
  194.             'built_failure' => $this->jwsBuiltFailures,
  195.         ];
  196.     }
  197. }