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

  1. <?php
  3. declare(strict_types=1);
  5. namespace Jose\Bundle\JoseFramework\DataCollector;
  7. use Jose\Bundle\JoseFramework\Event\JWEBuiltFailureEvent;
  8. use Jose\Bundle\JoseFramework\Event\JWEBuiltSuccessEvent;
  9. use Jose\Bundle\JoseFramework\Event\JWEDecryptionFailureEvent;
  10. use Jose\Bundle\JoseFramework\Event\JWEDecryptionSuccessEvent;
  11. use Jose\Component\Encryption\Compression\CompressionMethodManagerFactory;
  12. use Jose\Component\Encryption\JWEBuilder;
  13. use Jose\Component\Encryption\JWEDecrypter;
  14. use Jose\Component\Encryption\JWELoader;
  15. use Jose\Component\Encryption\Serializer\JWESerializerManagerFactory;
  16. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  17. use Symfony\Component\HttpFoundation\Request;
  18. use Symfony\Component\HttpFoundation\Response;
  19. use Symfony\Component\VarDumper\Cloner\Data;
  20. use Symfony\Component\VarDumper\Cloner\VarCloner;
  21. use Throwable;
  23. class JWECollector implements Collector, EventSubscriberInterface
  24. {
  25.     /**
  26.      * @var array<Data>
  27.      */
  28.     private array $jweDecryptionSuccesses = [];
  30.     /**
  31.      * @var array<Data>
  32.      */
  33.     private array $jweDecryptionFailures = [];
  35.     /**
  36.      * @var array<Data>
  37.      */
  38.     private array $jweBuiltSuccesses = [];
  40.     /**
  41.      * @var array<Data>
  42.      */
  43.     private array $jweBuiltFailures = [];
  45.     /**
  46.      * @var array<JWEBuilder>
  47.      */
  48.     private array $jweBuilders = [];
  50.     /**
  51.      * @var array<JWEDecrypter>
  52.      */
  53.     private array $jweDecrypters = [];
  55.     /**
  56.      * @var array<JWELoader>
  57.      */
  58.     private array $jweLoaders = [];
  60.     public function __construct(
  61.         private readonly ?CompressionMethodManagerFactory $compressionMethodManagerFactory = null,
  62.         private readonly ?JWESerializerManagerFactory $jweSerializerManagerFactory = null
  63.     ) {
  64.     }
  66.     /**
  67.      * @param array<string, mixed> $data
  68.      */
  69.     public function collect(array &$data, Request $request, Response $response, ?Throwable $exception = null): void
  70.     {
  71.         $this->collectSupportedCompressionMethods($data);
  72.         $this->collectSupportedJWESerializations($data);
  73.         $this->collectSupportedJWEBuilders($data);
  74.         $this->collectSupportedJWEDecrypters($data);
  75.         $this->collectSupportedJWELoaders($data);
  76.         $this->collectEvents($data);
  77.     }
  79.     public function addJWEBuilder(string $id, JWEBuilder $jweBuilder): void
  80.     {
  81.         $this->jweBuilders[$id] = $jweBuilder;
  82.     }
  84.     public function addJWEDecrypter(string $id, JWEDecrypter $jweDecrypter): void
  85.     {
  86.         $this->jweDecrypters[$id] = $jweDecrypter;
  87.     }
  89.     public function addJWELoader(string $id, JWELoader $jweLoader): void
  90.     {
  91.         $this->jweLoaders[$id] = $jweLoader;
  92.     }
  94.     public static function getSubscribedEvents(): array
  95.     {
  96.         return [
  97.             JWEDecryptionSuccessEvent::class => ['catchJweDecryptionSuccess'],
  98.             JWEDecryptionFailureEvent::class => ['catchJweDecryptionFailure'],
  99.             JWEBuiltSuccessEvent::class => ['catchJweBuiltSuccess'],
  100.             JWEBuiltFailureEvent::class => ['catchJweBuiltFailure'],
  101.         ];
  102.     }
  104.     public function catchJweDecryptionSuccess(JWEDecryptionSuccessEvent $event): void
  105.     {
  106.         $cloner = new VarCloner();
  107.         $this->jweDecryptionSuccesses[] = $cloner->cloneVar($event);
  108.     }
  110.     public function catchJweDecryptionFailure(JWEDecryptionFailureEvent $event): void
  111.     {
  112.         $cloner = new VarCloner();
  113.         $this->jweDecryptionFailures[] = $cloner->cloneVar($event);
  114.     }
  116.     public function catchJweBuiltSuccess(JWEBuiltSuccessEvent $event): void
  117.     {
  118.         $cloner = new VarCloner();
  119.         $this->jweBuiltSuccesses[] = $cloner->cloneVar($event);
  120.     }
  122.     public function catchJweBuiltFailure(JWEBuiltFailureEvent $event): void
  123.     {
  124.         $cloner = new VarCloner();
  125.         $this->jweBuiltFailures[] = $cloner->cloneVar($event);
  126.     }
  128.     /**
  129.      * @param array<string, array<string, mixed>> $data
  130.      * @deprecated This method is deprecated and will be removed in v4.0. Compression is not recommended for JWE.
  131.      */
  132.     private function collectSupportedCompressionMethods(array &$data): void
  133.     {
  134.         $data['jwe']['compression_methods'] = [];
  135.         if ($this->compressionMethodManagerFactory === null) {
  136.             return;
  137.         }
  138.         $compressionMethods = $this->compressionMethodManagerFactory->all();
  139.         foreach ($compressionMethods as $alias => $compressionMethod) {
  140.             $data['jwe']['compression_methods'][$alias] = $compressionMethod->name();
  141.         }
  142.     }
  144.     /**
  145.      * @param array<string, array<string, mixed>> $data
  146.      */
  147.     private function collectSupportedJWESerializations(array &$data): void
  148.     {
  149.         $data['jwe']['jwe_serialization'] = [];
  150.         if ($this->jweSerializerManagerFactory === null) {
  151.             return;
  152.         }
  153.         $serializers = $this->jweSerializerManagerFactory->all();
  154.         foreach ($serializers as $serializer) {
  155.             $data['jwe']['jwe_serialization'][$serializer->name()] = $serializer->displayName();
  156.         }
  157.     }
  159.     /**
  160.      * @param array<string, array<string, mixed>> $data
  161.      */
  162.     private function collectSupportedJWEBuilders(array &$data): void
  163.     {
  164.         $data['jwe']['jwe_builders'] = [];
  165.         foreach ($this->jweBuilders as $id => $jweBuilder) {
  166.             $data['jwe']['jwe_builders'][$id] = [
  167.                 'key_encryption_algorithms' => $jweBuilder->getKeyEncryptionAlgorithmManager()
  168.                     ->list(),
  169.                 'content_encryption_algorithms' => $jweBuilder->getContentEncryptionAlgorithmManager()
  170.                     ->list(),
  171.                 'compression_methods' => $jweBuilder->getCompressionMethodManager()
  172.                     ?->list(),
  173.             ];
  174.         }
  175.     }
  177.     /**
  178.      * @param array<string, array<string, mixed>> $data
  179.      */
  180.     private function collectSupportedJWEDecrypters(array &$data): void
  181.     {
  182.         $data['jwe']['jwe_decrypters'] = [];
  183.         foreach ($this->jweDecrypters as $id => $jweDecrypter) {
  184.             $data['jwe']['jwe_decrypters'][$id] = [
  185.                 'key_encryption_algorithms' => $jweDecrypter->getKeyEncryptionAlgorithmManager()
  186.                     ->list(),
  187.                 'content_encryption_algorithms' => $jweDecrypter->getContentEncryptionAlgorithmManager()
  188.                     ->list(),
  189.                 'compression_methods' => $jweDecrypter->getCompressionMethodManager()
  190.                     ?->list(),
  191.             ];
  192.         }
  193.     }
  195.     /**
  196.      * @param array<string, array<string, mixed>> $data
  197.      */
  198.     private function collectSupportedJWELoaders(array &$data): void
  199.     {
  200.         $data['jwe']['jwe_loaders'] = [];
  201.         foreach ($this->jweLoaders as $id => $jweLoader) {
  202.             $data['jwe']['jwe_loaders'][$id] = [
  203.                 'serializers' => $jweLoader->getSerializerManager()
  204.                     ->names(),
  205.                 'key_encryption_algorithms' => $jweLoader->getJweDecrypter()
  206.                     ->getKeyEncryptionAlgorithmManager()
  207.                     ->list(),
  208.                 'content_encryption_algorithms' => $jweLoader->getJweDecrypter()
  209.                     ->getContentEncryptionAlgorithmManager()
  210.                     ->list(),
  211.                 'compression_methods' => $jweLoader->getJweDecrypter()
  212.                     ->getCompressionMethodManager()
  213.                     ?->list(),
  214.             ];
  215.         }
  216.     }
  218.     /**
  219.      * @param array<string, array<string, mixed>> $data
  220.      */
  221.     private function collectEvents(array &$data): void
  222.     {
  223.         $data['jwe']['events'] = [
  224.             'decryption_success' => $this->jweDecryptionSuccesses,
  225.             'decryption_failure' => $this->jweDecryptionFailures,
  226.             'built_success' => $this->jweBuiltSuccesses,
  227.             'built_failure' => $this->jweBuiltFailures,
  228.         ];
  229.     }
  230. }