Merge pull request #626 from web-auth/temp-489135

Merge up 4.9.x to 5.0.x
web-auth · Jul 10, 2024 · 2b792f0 · 2b792f0
2 parents 23814a7 + 0fe15cc
commit 2b792f0
Show file tree

Hide file tree

Showing 12 changed files with 110 additions and 28 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -1176,6 +1176,14 @@ parameters:
 			count: 1
 			path: src/symfony/src/DependencyInjection/WebauthnExtension.php
 
+		-
+			message: """
+				#^Fetching class constant class of deprecated class Webauthn\\\\Bundle\\\\Doctrine\\\\Type\\\\PublicKeyCredentialDescriptorCollectionType\\:
+				since 4\\.9\\.0 and will be removed in 5\\.0\\.0\\.$#
+			"""
+			count: 1
+			path: src/symfony/src/DependencyInjection/WebauthnExtension.php
+
 		-
 			message: """
 				#^Fetching class constant class of deprecated interface Webauthn\\\\Bundle\\\\Repository\\\\PublicKeyCredentialUserEntityRepository\\:
@@ -1248,12 +1256,17 @@ parameters:
 			path: src/symfony/src/Doctrine/Type/AAGUIDDataType.php
 
 		-
-			message: "#^Cannot cast mixed to string\\.$#"
+			message: "#^Method Webauthn\\\\Bundle\\\\Doctrine\\\\Type\\\\AttestedCredentialDataType\\:\\:convertToDatabaseValue\\(\\) should return string\\|null but returns mixed\\.$#"
 			count: 1
 			path: src/symfony/src/Doctrine/Type/AttestedCredentialDataType.php
 
 		-
-			message: "#^Parameter \\#1 \\$json of static method Webauthn\\\\AttestedCredentialData\\:\\:createFromArray\\(\\) expects array, mixed given\\.$#"
+			message: "#^Method Webauthn\\\\Bundle\\\\Doctrine\\\\Type\\\\AttestedCredentialDataType\\:\\:convertToPHPValue\\(\\) should return Webauthn\\\\AttestedCredentialData\\|null but returns mixed\\.$#"
+			count: 1
+			path: src/symfony/src/Doctrine/Type/AttestedCredentialDataType.php
+
+		-
+			message: "#^Parameter \\#1 \\$data of method Webauthn\\\\Bundle\\\\Doctrine\\\\Type\\\\AttestedCredentialDataType\\:\\:deserialize\\(\\) expects string, mixed given\\.$#"
 			count: 1
 			path: src/symfony/src/Doctrine/Type/AttestedCredentialDataType.php
 
@@ -1298,17 +1311,32 @@ parameters:
 			path: src/symfony/src/Doctrine/Type/PublicKeyCredentialDescriptorCollection.php
 
 		-
-			message: "#^Parameter \\#1 \\$data of static method Webauthn\\\\PublicKeyCredentialDescriptor\\:\\:createFromString\\(\\) expects string, mixed given\\.$#"
+			message: "#^Method Webauthn\\\\Bundle\\\\Doctrine\\\\Type\\\\PublicKeyCredentialDescriptorType\\:\\:convertToDatabaseValue\\(\\) should return string\\|null but returns mixed\\.$#"
 			count: 1
 			path: src/symfony/src/Doctrine/Type/PublicKeyCredentialDescriptorType.php
 
 		-
-			message: "#^Cannot cast mixed to string\\.$#"
+			message: "#^Method Webauthn\\\\Bundle\\\\Doctrine\\\\Type\\\\PublicKeyCredentialDescriptorType\\:\\:convertToPHPValue\\(\\) should return Webauthn\\\\PublicKeyCredentialDescriptor\\|null but returns mixed\\.$#"
+			count: 1
+			path: src/symfony/src/Doctrine/Type/PublicKeyCredentialDescriptorType.php
+
+		-
+			message: "#^Parameter \\#1 \\$data of method Webauthn\\\\Bundle\\\\Doctrine\\\\Type\\\\PublicKeyCredentialDescriptorType\\:\\:deserialize\\(\\) expects string, mixed given\\.$#"
+			count: 1
+			path: src/symfony/src/Doctrine/Type/PublicKeyCredentialDescriptorType.php
+
+		-
+			message: "#^Method Webauthn\\\\Bundle\\\\Doctrine\\\\Type\\\\TrustPathDataType\\:\\:convertToDatabaseValue\\(\\) should return string\\|null but returns mixed\\.$#"
 			count: 1
 			path: src/symfony/src/Doctrine/Type/TrustPathDataType.php
 
 		-
-			message: "#^Parameter \\#1 \\$data of static method Webauthn\\\\TrustPath\\\\TrustPathLoader\\:\\:loadTrustPath\\(\\) expects array, mixed given\\.$#"
+			message: "#^Method Webauthn\\\\Bundle\\\\Doctrine\\\\Type\\\\TrustPathDataType\\:\\:convertToPHPValue\\(\\) should return Webauthn\\\\TrustPath\\\\TrustPath\\|null but returns mixed\\.$#"
+			count: 1
+			path: src/symfony/src/Doctrine/Type/TrustPathDataType.php
+
+		-
+			message: "#^Parameter \\#1 \\$data of method Webauthn\\\\Bundle\\\\Doctrine\\\\Type\\\\TrustPathDataType\\:\\:deserialize\\(\\) expects string, mixed given\\.$#"
 			count: 1
 			path: src/symfony/src/Doctrine/Type/TrustPathDataType.php
 

diff --git a/src/symfony/src/Doctrine/Type/AttestedCredentialDataType.php b/src/symfony/src/Doctrine/Type/AttestedCredentialDataType.php
@@ -7,32 +7,32 @@
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Types\Type;
 use Webauthn\AttestedCredentialData;
-use const JSON_THROW_ON_ERROR;
 
 final class AttestedCredentialDataType extends Type
 {
+    use SerializerTrait;
+
     public function convertToDatabaseValue($value, AbstractPlatform $platform): ?string
     {
-        if ($value === null) {
+        if (! $value instanceof AttestedCredentialData) {
             return $value;
         }
 
-        return json_encode($value, JSON_THROW_ON_ERROR);
+        return $this->serialize($value);
     }
 
     public function convertToPHPValue($value, AbstractPlatform $platform): ?AttestedCredentialData
     {
         if ($value === null || $value instanceof AttestedCredentialData) {
             return $value;
         }
-        $json = json_decode((string) $value, true, flags: JSON_THROW_ON_ERROR);
 
-        return AttestedCredentialData::createFromArray($json);
+        return $this->deserialize($value, AttestedCredentialData::class);
     }
 
-    public function getSQLDeclaration(array $fieldDeclaration, AbstractPlatform $platform): string
+    public function getSQLDeclaration(array $column, AbstractPlatform $platform): string
     {
-        return $platform->getJsonTypeDeclarationSQL($fieldDeclaration);
+        return $platform->getJsonTypeDeclarationSQL($column);
     }
 
     public function getName(): string

diff --git a/src/symfony/src/Doctrine/Type/PublicKeyCredentialDescriptorCollection.php b/src/symfony/src/Doctrine/Type/PublicKeyCredentialDescriptorCollection.php
@@ -19,6 +19,7 @@
 /**
  * @implements IteratorAggregate<PublicKeyCredentialDescriptor>
  * @internal
+ * @deprecated since 4.9.0 and will be removed in 5.0.0.
  */
 final class PublicKeyCredentialDescriptorCollection implements JsonSerializable, Countable, IteratorAggregate
 {

diff --git a/src/symfony/src/Doctrine/Type/PublicKeyCredentialDescriptorCollectionType.php b/src/symfony/src/Doctrine/Type/PublicKeyCredentialDescriptorCollectionType.php
@@ -10,6 +10,9 @@
 use function is_string;
 use const JSON_THROW_ON_ERROR;
 
+/**
+ * @deprecated since 4.9.0 and will be removed in 5.0.0.
+ */
 final class PublicKeyCredentialDescriptorCollectionType extends Type
 {
     public function convertToDatabaseValue($value, AbstractPlatform $platform): ?string
@@ -37,9 +40,9 @@ public function convertToPHPValue(
         return PublicKeyCredentialDescriptorCollection::createFromString($value);
     }
 
-    public function getSQLDeclaration(array $fieldDeclaration, AbstractPlatform $platform): string
+    public function getSQLDeclaration(array $column, AbstractPlatform $platform): string
     {
-        return $platform->getJsonTypeDeclarationSQL($fieldDeclaration);
+        return $platform->getJsonTypeDeclarationSQL($column);
     }
 
     public function getName(): string

diff --git a/src/symfony/src/Doctrine/Type/PublicKeyCredentialDescriptorType.php b/src/symfony/src/Doctrine/Type/PublicKeyCredentialDescriptorType.php
@@ -7,17 +7,18 @@
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Types\Type;
 use Webauthn\PublicKeyCredentialDescriptor;
-use const JSON_THROW_ON_ERROR;
 
 final class PublicKeyCredentialDescriptorType extends Type
 {
+    use SerializerTrait;
+
     public function convertToDatabaseValue($value, AbstractPlatform $platform): ?string
     {
-        if ($value === null) {
+        if (! $value instanceof PublicKeyCredentialDescriptor) {
             return $value;
         }
 
-        return json_encode($value, JSON_THROW_ON_ERROR);
+        return $this->serialize($value);
     }
 
     public function convertToPHPValue($value, AbstractPlatform $platform): ?PublicKeyCredentialDescriptor
@@ -26,12 +27,12 @@ public function convertToPHPValue($value, AbstractPlatform $platform): ?PublicKe
             return $value;
         }
 
-        return PublicKeyCredentialDescriptor::createFromString($value);
+        return $this->deserialize($value, PublicKeyCredentialDescriptor::class);
     }
 
-    public function getSQLDeclaration(array $fieldDeclaration, AbstractPlatform $platform): string
+    public function getSQLDeclaration(array $column, AbstractPlatform $platform): string
     {
-        return $platform->getJsonTypeDeclarationSQL($fieldDeclaration);
+        return $platform->getJsonTypeDeclarationSQL($column);
     }
 
     public function getName(): string

diff --git a/src/symfony/src/Doctrine/Type/SerializerTrait.php b/src/symfony/src/Doctrine/Type/SerializerTrait.php
@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Webauthn\Bundle\Doctrine\Type;
+
+use Symfony\Component\Serializer\Encoder\JsonEncode;
+use Symfony\Component\Serializer\Encoder\JsonEncoder;
+use Symfony\Component\Serializer\Normalizer\AbstractObjectNormalizer;
+use Webauthn\AttestationStatement\AttestationStatementSupportManager;
+use Webauthn\Denormalizer\WebauthnSerializerFactory;
+use const JSON_THROW_ON_ERROR;
+
+trait SerializerTrait
+{
+    protected function serialize(mixed $data): string
+    {
+        $serializer = (new WebauthnSerializerFactory(AttestationStatementSupportManager::create()))->create();
+
+        return $serializer->serialize($data, JsonEncoder::FORMAT, [
+            AbstractObjectNormalizer::SKIP_NULL_VALUES => true,
+            JsonEncode::OPTIONS => JSON_THROW_ON_ERROR,
+        ]);
+    }
+
+    protected function deserialize(string $data, string $class): mixed
+    {
+        $serializer = (new WebauthnSerializerFactory(AttestationStatementSupportManager::create()))->create();
+
+        return $serializer->deserialize($data, $class, JsonEncoder::FORMAT);
+    }
+}
diff --git a/src/symfony/src/Doctrine/Type/TrustPathDataType.php b/src/symfony/src/Doctrine/Type/TrustPathDataType.php
@@ -7,33 +7,32 @@
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Types\Type;
 use Webauthn\TrustPath\TrustPath;
-use Webauthn\TrustPath\TrustPathLoader;
-use const JSON_THROW_ON_ERROR;
 
 final class TrustPathDataType extends Type
 {
+    use SerializerTrait;
+
     public function convertToDatabaseValue($value, AbstractPlatform $platform): ?string
     {
-        if ($value === null) {
+        if (! $value instanceof TrustPath) {
             return $value;
         }
 
-        return json_encode($value, JSON_THROW_ON_ERROR);
+        return $this->serialize($value);
     }
 
     public function convertToPHPValue($value, AbstractPlatform $platform): ?TrustPath
     {
         if ($value === null || $value instanceof TrustPath) {
             return $value;
         }
-        $json = json_decode((string) $value, true, flags: JSON_THROW_ON_ERROR);
 
-        return TrustPathLoader::loadTrustPath($json);
+        return $this->deserialize($value, TrustPath::class);
     }
 
-    public function getSQLDeclaration(array $fieldDeclaration, AbstractPlatform $platform): string
+    public function getSQLDeclaration(array $column, AbstractPlatform $platform): string
     {
-        return $platform->getJsonTypeDeclarationSQL($fieldDeclaration);
+        return $platform->getJsonTypeDeclarationSQL($column);
     }
 
     public function getName(): string

diff --git a/src/webauthn/src/AttestedCredentialData.php b/src/webauthn/src/AttestedCredentialData.php
@@ -66,6 +66,7 @@ public function getCredentialPublicKey(): ?string
 
     /**
      * @param mixed[] $json
+     * @deprecated since 4.9.0 and will be removed in 5.0.0. Please use the serializer instead.
      */
     public static function createFromArray(array $json): self
     {

diff --git a/src/webauthn/src/Denormalizer/WebauthnSerializerFactory.php b/src/webauthn/src/Denormalizer/WebauthnSerializerFactory.php
@@ -15,6 +15,8 @@
 use Symfony\Component\Serializer\Serializer;
 use Symfony\Component\Serializer\SerializerInterface;
 use Webauthn\AttestationStatement\AttestationStatementSupportManager;
+use Webauthn\MetadataService\Denormalizer\ExtensionDescriptorDenormalizer;
+use Webauthn\MetadataService\Denormalizer\VerificationMethodANDCombinationsDenormalizer;
 
 final class WebauthnSerializerFactory
 {
@@ -42,6 +44,8 @@ public function create(): SerializerInterface
         }
 
         $denormalizers = [
+            new ExtensionDescriptorDenormalizer(),
+            new VerificationMethodANDCombinationsDenormalizer(),
             new AuthenticationExtensionNormalizer(),
             new PublicKeyCredentialDescriptorNormalizer(),
             new AttestedCredentialDataNormalizer(),

diff --git a/src/webauthn/src/PublicKeyCredentialDescriptor.php b/src/webauthn/src/PublicKeyCredentialDescriptor.php
@@ -79,6 +79,9 @@ public function getTransports(): array
         return $this->transports;
     }
 
+    /**
+     * @deprecated since 4.9.0 and will be removed in 5.0.0. Please use the serializer instead.
+     */
     public static function createFromString(string $data): self
     {
         $data = json_decode($data, true, flags: JSON_THROW_ON_ERROR);
@@ -88,6 +91,7 @@ public static function createFromString(string $data): self
 
     /**
      * @param mixed[] $json
+     * @deprecated since 4.9.0 and will be removed in 5.0.0. Please use the serializer instead.
      */
     public static function createFromArray(array $json): self
     {

diff --git a/src/webauthn/src/PublicKeyCredentialDescriptorCollection.php b/src/webauthn/src/PublicKeyCredentialDescriptorCollection.php
@@ -100,6 +100,12 @@ public function count(int $mode = COUNT_NORMAL): int
      */
     public function jsonSerialize(): array
     {
+        trigger_deprecation(
+            'web-auth/webauthn-bundle',
+            '4.9.0',
+            'The "%s" method is deprecated and will be removed in 5.0. Please use the serializer instead.',
+            __METHOD__
+        );
         return $this->publicKeyCredentialDescriptors;
     }
 

diff --git a/src/webauthn/src/TrustPath/TrustPathLoader.php b/src/webauthn/src/TrustPath/TrustPathLoader.php
@@ -9,6 +9,9 @@
 use function is_array;
 use function is_string;
 
+/**
+ * @deprecated since 4.9.0 and will be removed in 5.0.0. Use the serializer instead
+ */
 final class TrustPathLoader
 {
     /**
-Original file line number
+Diff line change
@@ Expand Up / @@ -66,6 +66,7 @@ public function getCredentialPublicKey(): ?string @@
         /**
          * @param mixed[] $json
+         * @deprecated since 4.9.0 and will be removed in 5.0.0. Please use the serializer instead.
          */
         public static function createFromArray(array $json): self
         {
@@ Expand Down @@