fix: attempt verifier v0.5 support - requires more domain knowledge

facile-it · Jun 13, 2024 · 960d7b4 · 960d7b4
1 parent 922093b
commit 960d7b4
Show file tree

Hide file tree

Showing 15 changed files with 70 additions and 97 deletions.
diff --git a/src/Client/Metadata/ClientMetadata.php b/src/Client/Metadata/ClientMetadata.php
@@ -4,6 +4,7 @@
 
 namespace Facile\OpenIDClient\Client\Metadata;
 
+use Facile\JoseVerifier\TokenVerifierInterface;
 use function array_diff;
 use function array_key_exists;
 use function array_keys;
@@ -13,14 +14,14 @@
 use function implode;
 
 /**
- * @psalm-import-type ClientMetadataObject from \Facile\JoseVerifier\Psalm\PsalmTypes
+ * @psalm-import-type ClientMetadataType from TokenVerifierInterface
  */
 final class ClientMetadata implements ClientMetadataInterface
 {
     /**
      * @var array<string, mixed>
      *
-     * @psalm-var ClientMetadataObject
+     * @psalm-var ClientMetadataType
      */
     private $metadata;
 
@@ -37,7 +38,7 @@ final class ClientMetadata implements ClientMetadataInterface
      *
      * @param array<string, mixed> $claims
      *
-     * @psalm-param ClientMetadataObject|array<empty, empty> $claims
+     * @psalm-param ClientMetadataType|array<empty, empty> $claims
      */
     public function __construct(string $clientId, array $claims = [])
     {
@@ -47,7 +48,7 @@ public function __construct(string $clientId, array $claims = [])
 
         $defaults = self::$defaults;
 
-        /** @var ClientMetadataObject $merged */
+        /** @var ClientMetadataType $merged */
         $merged = array_merge($defaults, $claims, $requiredClaims);
         $this->metadata = $merged;
     }
@@ -57,7 +58,7 @@ public function __construct(string $clientId, array $claims = [])
      *
      * @return static
      *
-     * @psalm-param ClientMetadataObject $claims
+     * @psalm-param ClientMetadataType $claims
      */
     public static function fromArray(array $claims): self
     {

diff --git a/src/Client/Metadata/ClientMetadataInterface.php b/src/Client/Metadata/ClientMetadataInterface.php
@@ -4,12 +4,13 @@
 
 namespace Facile\OpenIDClient\Client\Metadata;
 
+use Facile\JoseVerifier\TokenVerifierInterface;
 use JsonSerializable;
 
 /**
- * @psalm-import-type ClientMetadataObject from \Facile\JoseVerifier\Psalm\PsalmTypes
- * @psalm-import-type JWKObject from \Facile\JoseVerifier\Psalm\PsalmTypes
- * @psalm-import-type JWKSetObject from \Facile\JoseVerifier\Psalm\PsalmTypes
+ * @psalm-import-type ClientMetadataType from TokenVerifierInterface
+ * @psalm-import-type JWTPayloadType from TokenVerifierInterface
+ * @psalm-import-type JWKSetType from TokenVerifierInterface
  */
 interface ClientMetadataInterface extends JsonSerializable
 {
@@ -65,21 +66,21 @@ public function getIntrospectionEndpointAuthMethod(): string;
     public function getRevocationEndpointAuthMethod(): string;
 
     /**
-     * @psalm-return JWKSetObject|null
+     * @psalm-return JWKSetType|null
      */
     public function getJwks(): ?array;
 
     /**
      * @return array<string, mixed>
      *
-     * @psalm-return ClientMetadataObject
+     * @psalm-return ClientMetadataType
      */
     public function jsonSerialize(): array;
 
     /**
      * @return array<string, mixed>
      *
-     * @psalm-return ClientMetadataObject
+     * @psalm-return ClientMetadataType
      */
     public function toArray(): array;
 }
diff --git a/src/Client/Metadata/MetadataFactoryInterface.php b/src/Client/Metadata/MetadataFactoryInterface.php
@@ -4,15 +4,17 @@
 
 namespace Facile\OpenIDClient\Client\Metadata;
 
+use Facile\JoseVerifier\TokenVerifierInterface;
+
 /**
- * @psalm-import-type ClientMetadataObject from \Facile\JoseVerifier\Psalm\PsalmTypes
+ * @psalm-import-type ClientMetadataType from TokenVerifierInterface
  */
 interface MetadataFactoryInterface
 {
     /**
      * @param array<string, mixed> $metadata
      *
-     * @psalm-param ClientMetadataObject $metadata
+     * @psalm-param ClientMetadataType $metadata
      */
     public function fromArray(array $metadata): ClientMetadataInterface;
 }
diff --git a/src/Issuer/IssuerBuilder.php b/src/Issuer/IssuerBuilder.php
@@ -46,7 +46,7 @@ public function build(string $resource): IssuerInterface
         $metadata = IssuerMetadata::fromArray($metadataBuilder->build()->fetch($resource));
 
         $jwksProviderBuilder = $this->buildJwksProviderBuilder();
-        $jwksProviderBuilder->setJwksUri($metadata->getJwksUri());
+        $jwksProviderBuilder->withJwksUri($metadata->getJwksUri());
         $jwksProvider = $jwksProviderBuilder->build();
 
         return new Issuer(

diff --git a/src/Issuer/Metadata/IssuerMetadata.php b/src/Issuer/Metadata/IssuerMetadata.php
@@ -4,6 +4,7 @@
 
 namespace Facile\OpenIDClient\Issuer\Metadata;
 
+use Facile\JoseVerifier\TokenVerifierInterface;
 use function array_diff;
 use function array_key_exists;
 use function array_keys;
@@ -13,14 +14,14 @@
 use function implode;
 
 /**
- * @psalm-import-type IssuerMetadataObject from \Facile\JoseVerifier\Psalm\PsalmTypes
+ * @psalm-import-type IssuerMetadataType from TokenVerifierInterface
  */
 final class IssuerMetadata implements IssuerMetadataInterface
 {
     /**
      * @var array<string, mixed>
      *
-     * @psalm-var IssuerMetadataObject
+     * @psalm-var IssuerMetadataType
      */
     private $metadata;
 
@@ -48,7 +49,7 @@ public function __construct(
             'jwks_uri' => $jwksUri,
         ];
 
-        /** @var IssuerMetadataObject $merged */
+        /** @var IssuerMetadataType $merged */
         $merged = array_merge($claims, $requiredClaims);
         $this->metadata = $merged;
     }
@@ -58,7 +59,7 @@ public function __construct(
      *
      * @return static
      *
-     * @psalm-param IssuerMetadataObject $claims
+     * @psalm-param IssuerMetadataType $claims
      */
     public static function fromArray(array $claims): self
     {

diff --git a/src/Issuer/Metadata/IssuerMetadataInterface.php b/src/Issuer/Metadata/IssuerMetadataInterface.php
@@ -4,18 +4,15 @@
 
 namespace Facile\OpenIDClient\Issuer\Metadata;
 
+use Facile\JoseVerifier\TokenVerifierInterface;
 use JsonSerializable;
 
 /**
- * @psalm-import-type IssuerMetadataObject from \Facile\JoseVerifier\Psalm\PsalmTypes
- * @psalm-import-type OpenIdDisplayType from \Facile\JoseVerifier\Psalm\PsalmTypes
- * @psalm-import-type OpenIdClaimType from \Facile\JoseVerifier\Psalm\PsalmTypes
- * @psalm-import-type OpenIdResponseType from \Facile\JoseVerifier\Psalm\PsalmTypes
- * @psalm-import-type OpenIdResponseMode from \Facile\JoseVerifier\Psalm\PsalmTypes
- * @psalm-import-type OpenIdGrantType from \Facile\JoseVerifier\Psalm\PsalmTypes
- * @psalm-import-type OpenIdApplicationType from \Facile\JoseVerifier\Psalm\PsalmTypes
- * @psalm-import-type OpenIdSubjectType from \Facile\JoseVerifier\Psalm\PsalmTypes
- * @psalm-import-type OpenIdAuthMethod from \Facile\JoseVerifier\Psalm\PsalmTypes
+ * @psalm-import-type IssuerMetadataType from TokenVerifierInterface
+ * @psalm-import-type OpenIdResponseMode from TokenVerifierInterface
+ * @psalm-import-type OpenIdGrantType from TokenVerifierInterface
+ * @psalm-import-type OpenIdClaimType from TokenVerifierInterface
+ * @psalm-import-type OpenIdSubjectType from TokenVerifierInterface
  */
 interface IssuerMetadataInterface extends JsonSerializable
 {
@@ -348,14 +345,14 @@ public function getMtlsEndpointAliases(): array;
     /**
      * @return array<string, mixed>
      *
-     * @psalm-return IssuerMetadataObject
+     * @psalm-return IssuerMetadataType
      */
     public function jsonSerialize(): array;
 
     /**
      * @return array<string, mixed>
      *
-     * @psalm-return IssuerMetadataObject
+     * @psalm-return IssuerMetadataType
      */
     public function toArray(): array;
 }
diff --git a/src/Issuer/Metadata/Provider/CachedProviderDecorator.php b/src/Issuer/Metadata/Provider/CachedProviderDecorator.php
@@ -4,6 +4,7 @@
 
 namespace Facile\OpenIDClient\Issuer\Metadata\Provider;
 
+use Facile\JoseVerifier\TokenVerifierInterface;
 use function is_array;
 use function json_decode;
 use function json_encode;
@@ -13,7 +14,7 @@
 use function substr;
 
 /**
- * @psalm-import-type IssuerMetadataObject from \Facile\JoseVerifier\Psalm\PsalmTypes
+ * @psalm-import-type IssuerMetadataType from TokenVerifierInterface
  */
 final class CachedProviderDecorator implements RemoteProviderInterface
 {
@@ -51,7 +52,7 @@ public function __construct(
     /**
      * @return array<string, mixed>
      *
-     * @psalm-return IssuerMetadataObject
+     * @psalm-return IssuerMetadataType
      *
      * @psalm-suppress MixedReturnTypeCoercion
      */
@@ -63,7 +64,7 @@ public function fetch(string $uri): array
         $cached = $this->cache->get($cacheId) ?? '';
 
         try {
-            /** @psalm-var null|string|IssuerMetadataObject $data */
+            /** @psalm-var null|string|IssuerMetadataType $data */
             $data = json_decode($cached, true, 512, JSON_THROW_ON_ERROR);
         } catch (JsonException $e) {
             $data = null;

diff --git a/src/Issuer/Metadata/Provider/DiscoveryProvider.php b/src/Issuer/Metadata/Provider/DiscoveryProvider.php
@@ -4,6 +4,7 @@
 
 namespace Facile\OpenIDClient\Issuer\Metadata\Provider;
 
+use Facile\JoseVerifier\TokenVerifierInterface;
 use function array_key_exists;
 use Facile\OpenIDClient\Exception\RuntimeException;
 use function Facile\OpenIDClient\parse_metadata_response;
@@ -16,7 +17,7 @@
 use function strpos;
 
 /**
- * @psalm-import-type IssuerMetadataObject from \Facile\JoseVerifier\Psalm\PsalmTypes
+ * @psalm-import-type IssuerMetadataType from TokenVerifierInterface
  */
 final class DiscoveryProvider implements DiscoveryProviderInterface
 {
@@ -51,7 +52,7 @@ public function isAllowedUri(string $uri): bool
     /**
      * @return array<string, mixed>
      *
-     * @psalm-return IssuerMetadataObject
+     * @psalm-return IssuerMetadataType
      *
      * @psalm-suppress MixedReturnTypeCoercion
      */
@@ -84,15 +85,15 @@ public function discovery(string $url): array
     /**
      * @return array<mixed, string>
      *
-     * @psalm-return IssuerMetadataObject
+     * @psalm-return IssuerMetadataType
      */
     private function fetchOpenIdConfiguration(string $uri): array
     {
         $request = $this->requestFactory->createRequest('GET', $uri)
             ->withHeader('accept', 'application/json');
 
         try {
-            /** @psalm-var IssuerMetadataObject $data */
+            /** @psalm-var IssuerMetadataType $data */
             $data = parse_metadata_response($this->client->sendRequest($request));
         } catch (ClientExceptionInterface $e) {
             throw new RuntimeException('Unable to fetch provider metadata', 0, $e);

diff --git a/src/Issuer/Metadata/Provider/DiscoveryProviderInterface.php b/src/Issuer/Metadata/Provider/DiscoveryProviderInterface.php
@@ -4,15 +4,17 @@
 
 namespace Facile\OpenIDClient\Issuer\Metadata\Provider;
 
+use Facile\JoseVerifier\TokenVerifierInterface;
+
 /**
- * @psalm-import-type IssuerMetadataObject from \Facile\JoseVerifier\Psalm\PsalmTypes
+ * @psalm-import-type IssuerMetadataType from TokenVerifierInterface
  */
 interface DiscoveryProviderInterface extends RemoteProviderInterface
 {
     /**
      * @return array<string, mixed>
      *
-     * @psalm-return IssuerMetadataObject
+     * @psalm-return IssuerMetadataType
      */
     public function discovery(string $url): array;
 }
diff --git a/src/Issuer/Metadata/Provider/RemoteProviderInterface.php b/src/Issuer/Metadata/Provider/RemoteProviderInterface.php
@@ -4,8 +4,10 @@
 
 namespace Facile\OpenIDClient\Issuer\Metadata\Provider;
 
+use Facile\JoseVerifier\TokenVerifierInterface;
+
 /**
- * @psalm-import-type IssuerMetadataObject from \Facile\JoseVerifier\Psalm\PsalmTypes
+ * @psalm-import-type IssuerMetadataType from TokenVerifierInterface
  */
 interface RemoteProviderInterface
 {
@@ -14,7 +16,7 @@ public function isAllowedUri(string $uri): bool;
     /**
      * @return array<string, mixed>
      *
-     * @psalm-return IssuerMetadataObject
+     * @psalm-return IssuerMetadataType
      */
     public function fetch(string $uri): array;
 }
diff --git a/src/Issuer/Metadata/Provider/WebFingerProvider.php b/src/Issuer/Metadata/Provider/WebFingerProvider.php
@@ -4,6 +4,7 @@
 
 namespace Facile\OpenIDClient\Issuer\Metadata\Provider;
 
+use Facile\JoseVerifier\TokenVerifierInterface;
 use function array_key_exists;
 use function array_pop;
 use function explode;
@@ -24,7 +25,7 @@
 use function substr;
 
 /**
- * @psalm-import-type IssuerMetadataObject from \Facile\JoseVerifier\Psalm\PsalmTypes
+ * @psalm-import-type IssuerMetadataType from TokenVerifierInterface
  */
 final class WebFingerProvider implements RemoteProviderInterface, WebFingerProviderInterface
 {
@@ -128,7 +129,7 @@ public function fetch(string $uri): array
             throw new RuntimeException('Discovered issuer mismatch');
         }
 
-        /** @var IssuerMetadataObject $metadata */
+        /** @var IssuerMetadataType $metadata */
         return $metadata;
     }