Merge pull request #154 from paragonie/version-helper

Add isForVersion() helper method to keys
paragonie · Apr 26, 2022 · cd48535 · cd48535
2 parents f73a309 + 97ba6e9
commit cd48535
Show file tree

Hide file tree

Showing 13 changed files with 97 additions and 11 deletions.
diff --git a/psalm.xml b/psalm.xml
@@ -2,7 +2,6 @@
 <psalm
     name="Paseto Static Analysis"
     useDocblockTypes="true"
-    totallyTyped="true"
 >
     <projectFiles>
         <directory name="src" />

diff --git a/src/Keys/AsymmetricPublicKey.php b/src/Keys/AsymmetricPublicKey.php
@@ -258,6 +258,15 @@ public function getProtocol(): ProtocolInterface
         return $this->protocol;
     }
 
+    /**
+     * @param ProtocolInterface $protocol
+     * @return bool
+     */
+    public function isForVersion(ProtocolInterface $protocol): bool
+    {
+        return $this->protocol instanceof $protocol;
+    }
+
     /**
      * Get the raw key contents.
      *

diff --git a/src/Keys/AsymmetricSecretKey.php b/src/Keys/AsymmetricSecretKey.php
@@ -265,6 +265,15 @@ public function getProtocol(): ProtocolInterface
         return $this->protocol;
     }
 
+    /**
+     * @param ProtocolInterface $protocol
+     * @return bool
+     */
+    public function isForVersion(ProtocolInterface $protocol): bool
+    {
+        return $this->protocol instanceof $protocol;
+    }
+
     /**
      * Get the public key that corresponds to this secret key.
      *

diff --git a/src/Keys/SymmetricKey.php b/src/Keys/SymmetricKey.php
@@ -177,6 +177,15 @@ public function getProtocol(): ProtocolInterface
         return $this->protocol;
     }
 
+    /**
+     * @param ProtocolInterface $protocol
+     * @return bool
+     */
+    public function isForVersion(ProtocolInterface $protocol): bool
+    {
+        return $this->protocol instanceof $protocol;
+    }
+
     /**
      * Get the raw key contents.
      *

diff --git a/src/Protocol/Version1.php b/src/Protocol/Version1.php
@@ -87,11 +87,11 @@ public function __construct()
     /**
      * Get the number of bytes in a symmetric key.
      *
-     * @return int
+     * @return positive-int
      */
     public static function getSymmetricKeyByteLength(): int
     {
-        return (int) static::SYMMETRIC_KEY_BYTES;
+        return static::SYMMETRIC_KEY_BYTES;
     }
 
     /**

diff --git a/src/Protocol/Version2.php b/src/Protocol/Version2.php
@@ -82,11 +82,11 @@ public static function supportsImplicitAssertions(): bool
     }
 
     /**
-     * @return int
+     * @return positive-int
      */
     public static function getSymmetricKeyByteLength(): int
     {
-        return (int) static::SYMMETRIC_KEY_BYTES;
+        return static::SYMMETRIC_KEY_BYTES;
     }
 
     /**

diff --git a/src/Protocol/Version3.php b/src/Protocol/Version3.php
@@ -75,11 +75,11 @@ public function __construct()
     }
 
     /**
-     * @return int
+     * @return positive-int
      */
     public static function getSymmetricKeyByteLength(): int
     {
-        return (int) static::SYMMETRIC_KEY_BYTES;
+        return static::SYMMETRIC_KEY_BYTES;
     }
 
     /**

diff --git a/src/Protocol/Version4.php b/src/Protocol/Version4.php
@@ -62,11 +62,11 @@ public function __construct()
     }
 
     /**
-     * @return int
+     * @return positive-int
      */
     public static function getSymmetricKeyByteLength(): int
     {
-        return (int) static::SYMMETRIC_KEY_BYTES;
+        return static::SYMMETRIC_KEY_BYTES;
     }
 
     /**

diff --git a/src/ProtocolInterface.php b/src/ProtocolInterface.php
@@ -45,7 +45,7 @@ public static function generateAsymmetricSecretKey(): AsymmetricSecretKey;
     public static function generateSymmetricKey(): SymmetricKey;
 
     /**
-     * @return int
+     * @return positive-int
      */
     public static function getSymmetricKeyByteLength(): int;
 

diff --git a/tests/Version1Test.php b/tests/Version1Test.php
@@ -10,6 +10,8 @@
 use ParagonIE\Paseto\Keys\Version1\SymmetricKey;
 use ParagonIE\Paseto\Protocol\Version1;
 use ParagonIE\Paseto\Protocol\Version2;
+use ParagonIE\Paseto\Protocol\Version3;
+use ParagonIE\Paseto\Protocol\Version4;
 use PHPUnit\Framework\TestCase;
 
 class Version1Test extends TestCase
@@ -30,6 +32,19 @@ public function testKeyGen()
 
         $this->assertSame(Version1::getSymmetricKeyByteLength(), Binary::safeStrlen($symmetric->raw()));
         $this->assertGreaterThanOrEqual(1670, Binary::safeStrlen($secret->raw())); // PEM encoded
+
+        $mapping = [
+            [new Version1, true],
+            [new Version2, false],
+            [new Version3, false],
+            [new Version4, false],
+        ];
+        foreach ($mapping as $row) {
+            [$version, $expected] = $row;
+            $this->assertSame($expected, $symmetric->isForVersion($version));
+            $this->assertSame($expected, $secret->isForVersion($version));
+            $this->assertSame($expected, $secret->getPublicKey()->isForVersion($version));
+        }
     }
 
     /**

diff --git a/tests/Version2Test.php b/tests/Version2Test.php
@@ -10,6 +10,8 @@
 use ParagonIE\Paseto\Keys\Version2\SymmetricKey;
 use ParagonIE\Paseto\Protocol\Version1;
 use ParagonIE\Paseto\Protocol\Version2;
+use ParagonIE\Paseto\Protocol\Version3;
+use ParagonIE\Paseto\Protocol\Version4;
 use PHPUnit\Framework\TestCase;
 
 class Version2Test extends TestCase
@@ -30,6 +32,19 @@ public function testKeyGen()
 
         $this->assertSame(Version2::getSymmetricKeyByteLength(), Binary::safeStrlen($symmetric->raw()));
         $this->assertSame(64, Binary::safeStrlen($secret->raw()));
+
+        $mapping = [
+            [new Version1, false],
+            [new Version2, true],
+            [new Version3, false],
+            [new Version4, false],
+        ];
+        foreach ($mapping as $row) {
+            [$version, $expected] = $row;
+            $this->assertSame($expected, $symmetric->isForVersion($version));
+            $this->assertSame($expected, $secret->isForVersion($version));
+            $this->assertSame($expected, $secret->getPublicKey()->isForVersion($version));
+        }
     }
 
     public function testPublicKeyEncode()

diff --git a/tests/Version3Test.php b/tests/Version3Test.php
@@ -9,8 +9,10 @@
 use ParagonIE\Paseto\Keys\Version3\AsymmetricSecretKey;
 use ParagonIE\Paseto\Keys\Version3\SymmetricKey;
 use ParagonIE\Paseto\Protocol\{
+    Version1,
     Version2,
-    Version3
+    Version3,
+    Version4
 };
 use PHPUnit\Framework\TestCase;
 
@@ -35,6 +37,19 @@ public function testKeyGen()
         $asymmetric2 = new AsymmetricSecretKey("\x7f" . random_bytes(47), new Version3);
         $pk = $asymmetric2->getPublicKey();
         $this->assertInstanceOf(BasePK::class, $pk);
+
+        $mapping = [
+            [new Version1, false],
+            [new Version2, false],
+            [new Version3, true],
+            [new Version4, false],
+        ];
+        foreach ($mapping as $row) {
+            [$version, $expected] = $row;
+            $this->assertSame($expected, $symmetric->isForVersion($version));
+            $this->assertSame($expected, $secret->isForVersion($version));
+            $this->assertSame($expected, $secret->getPublicKey()->isForVersion($version));
+        }
     }
 
     public function testPublicKeyEncode()

diff --git a/tests/Version4Test.php b/tests/Version4Test.php
@@ -9,6 +9,8 @@
 use ParagonIE\Paseto\Keys\Version4\AsymmetricSecretKey;
 use ParagonIE\Paseto\Keys\Version4\SymmetricKey;
 use ParagonIE\Paseto\Protocol\{
+    Version1,
+    Version2,
     Version3,
     Version4
 };
@@ -31,6 +33,19 @@ public function testKeyGen()
         $this->assertInstanceOf('ParagonIE\Paseto\Keys\AsymmetricSecretKey', $secret);
         $this->assertSame(Version4::getSymmetricKeyByteLength(), Binary::safeStrlen($symmetric->raw()));
         $this->assertGreaterThanOrEqual(48, Binary::safeStrlen($secret->raw())); // PEM encoded
+
+        $mapping = [
+            [new Version1, false],
+            [new Version2, false],
+            [new Version3, false],
+            [new Version4, true],
+        ];
+        foreach ($mapping as $row) {
+            [$version, $expected] = $row;
+            $this->assertSame($expected, $symmetric->isForVersion($version));
+            $this->assertSame($expected, $secret->isForVersion($version));
+            $this->assertSame($expected, $secret->getPublicKey()->isForVersion($version));
+        }
     }
 
     /**