Version credentials (#54)

Renames `Credential` to `CredentialV1`, for the upcoming addition of `CredentialV2` which tracks additional data. Extracted from #53.
Firehed · Nov 19, 2023 · 66d9dfc · 66d9dfc
1 parent 8e7f191
commit 66d9dfc
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 14 deletions.
diff --git a/src/Codecs/Credential.php b/src/Codecs/Credential.php
@@ -7,7 +7,7 @@
 use Firehed\WebAuthn\BinaryString;
 use Firehed\WebAuthn\COSEKey;
 use Firehed\WebAuthn\CredentialInterface;
-use Firehed\WebAuthn\Credential as CredentialObj;
+use Firehed\WebAuthn\CredentialV1;
 
 /**
  * This codec is responsible for serializing a CredentialInterface object to
@@ -113,7 +113,7 @@ public function decode(string $encoded): CredentialInterface
 
         $signCount = $bytes->readUint32();
 
-        return new CredentialObj(
+        return new CredentialV1(
             new BinaryString($id),
             new COSEKey(new BinaryString($cbor)),
             $signCount,

diff --git a/src/CreateResponse.php b/src/CreateResponse.php
@@ -154,7 +154,7 @@ public function verify(
         // associate credential with new user
         // done in client code
         $data = $authData->getAttestedCredentialData();
-        $credential = new Credential(
+        $credential = new CredentialV1(
             id: $this->id,
             signCount: $authData->getSignCount(),
             coseKey: $data->coseKey,

diff --git a/src/Credential.php → src/CredentialV1.php b/src/Credential.php → src/CredentialV1.php
@@ -5,9 +5,12 @@
 namespace Firehed\WebAuthn;
 
 /**
+ * Data format for WebAuthn Level 2 formats which lacked data for backup
+ * eligibility and did not track transports.
+ *
  * @internal
  */
-class Credential implements CredentialInterface
+class CredentialV1 implements CredentialInterface
 {
     // Risk factors:
     //   Create:
@@ -49,10 +52,10 @@ public function getPublicKey(): PublicKey\PublicKeyInterface
 
     public function withUpdatedSignCount(int $newSignCount): CredentialInterface
     {
-        return new Credential(
-            $this->id,
-            $this->coseKey,
-            $newSignCount,
+        return new CredentialV1(
+            id: $this->id,
+            coseKey: $this->coseKey,
+            signCount: $newSignCount,
         );
     }
 }
diff --git a/tests/Codecs/CredentialTest.php b/tests/Codecs/CredentialTest.php
@@ -8,7 +8,7 @@
     BinaryString,
     COSEKey,
     CredentialInterface,
-    Credential as CredentialObj,
+    CredentialV1,
 };
 
 /**
@@ -24,7 +24,7 @@ public function testRoundtrip(): void
         $cbor = hex2bin($cborHex);
         assert($cbor !== false);
         $coseKey = new COSEKey(new BinaryString($cbor));
-        $credential = new CredentialObj(
+        $credential = new CredentialV1(
             new BinaryString(random_bytes(10)),
             $coseKey,
             15,

diff --git a/tests/CredentialTest.php → tests/CredentialV1Test.php b/tests/CredentialTest.php → tests/CredentialV1Test.php
@@ -5,17 +5,17 @@
 namespace Firehed\WebAuthn;
 
 /**
- * @covers Firehed\WebAuthn\Credential
+ * @covers Firehed\WebAuthn\CredentialV1
  */
-class CredentialTest extends \PHPUnit\Framework\TestCase
+class CredentialV1Test extends \PHPUnit\Framework\TestCase
 {
     public function testAccessors(): void
     {
         $pk = self::createMock(PublicKey\PublicKeyInterface::class);
         $coseKey = self::createMock(COSEKey::class);
         $coseKey->method('getPublicKey')
             ->willReturn($pk);
-        $credential = new Credential(
+        $credential = new CredentialV1(
             id: BinaryString::fromHex('FFFF'),
             coseKey: $coseKey,
             signCount: 10,
@@ -36,7 +36,7 @@ public function testUpdatingSignCount(): void
         $coseKey = self::createMock(COSEKey::class);
         $coseKey->method('getPublicKey')
             ->willReturn($pk);
-        $credential = new Credential(
+        $credential = new CredentialV1(
             id: BinaryString::fromHex('0000'),
             coseKey: $coseKey,
             signCount: 20,