Secp256k1: allow string signature as well #9

Author: kornrunner

README.md

@@ -50,9 +50,13 @@ use kornrunner\Secp256k1;
 
 $secp256k1 = new Secp256k1();
 
-// signature was created by sign method
+// signature can be a SignatureInterface object created by sign method
 // hash and publicKey are hex strings
 $isVerified = $secp256k1->verify($hash, $signature, $publicKey);
+
+// or signature can be a hex string directly
+$signatureString = 'f67118680df5993e8efca4d3ecc4172ca4ac5e3e007ea774293e37386480970347427f3633371c1a30abbb2b717dbd78ef63d5b19b5a951f9d681cccdd520320';
+$isVerified = $secp256k1->verify($hash, $signatureString, $publicKey);
 ```
 
 ## License

src/Secp256k1.php

@@ -4,6 +4,7 @@
 
 use InvalidArgumentException;
 use kornrunner\Serializer\HexPrivateKeySerializer;
+use kornrunner\Serializer\HexSignatureSerializer;
 use kornrunner\Signature\Signer;
 use Mdanter\Ecc\Crypto\Signature\SignatureInterface;
 use Mdanter\Ecc\Curves\CurveFactory;
@@ -24,11 +25,14 @@ class Secp256k1
 
     protected $algorithm;
 
+    protected $signatureSerializer;
+
     public function __construct(string $hashAlgorithm='sha256') {
         $this->adapter = new ConstantTimeMath();
         $this->generator = CurveFactory::getGeneratorByName(SecgCurve::NAME_SECP_256K1);
         $this->curve = $this->generator->getCurve();
         $this->deserializer = new HexPrivateKeySerializer($this->generator);
+        $this->signatureSerializer = new HexSignatureSerializer();
         $this->algorithm = $hashAlgorithm;
     }
 
@@ -49,8 +53,12 @@ public function sign(string $hash, string $privateKey, array $options=[]): Signa
         return $signer->sign($key, $hex_hash, $randomK);
     }
 
-    public function verify(string $hash, SignatureInterface $signature, string $publicKey): bool
+    public function verify(string $hash, SignatureInterface|string $signature, string $publicKey): bool
     {
+        if (is_string($signature)) {
+            $signature = $this->signatureSerializer->parse($signature);
+        }
+
         $gmpKey = $this->decodePoint($publicKey);
         $key = $this->generator->getPublickeyFrom($gmpKey->getX(), $gmpKey->getY());
         $hex_hash = gmp_init($hash, 16);

test/unit/Secp256k1Test.php

@@ -68,4 +68,28 @@ public static function verify (): array {
         ];
     }
 
+    /**
+     * @dataProvider verifyWithStringSignature
+     */
+    public function testVerifyWithStringSignature(string $message, string $signatureString, string $publicKey) {
+        $this->assertTrue($this->secp256k1->verify($message, $signatureString, $publicKey));
+    }
+
+    public static function verifyWithStringSignature(): array {
+        return [
+            ['98d22cdb65bbf8a392180cd2ee892b0a971c47e7d29daf31a3286d006b9db4dc', 'f67118680df5993e8efca4d3ecc4172ca4ac5e3e007ea774293e37386480970347427f3633371c1a30abbb2b717dbd78ef63d5b19b5a951f9d681cccdd520320', '04cf60398ae73fd947ffe120fba68947ec741fe696438d68a2e52caca139613ff94f220cd0d3e886f95aa226f2ad2b86be1dd5cda2813fd505d1f6a8f552904864'],
+            ['710aee292b0f1749aaa0cfef67111e2f716afbdb475e7f250bdb80c6655b0a66', '8d8bfd01c48454b5b3fed2361cbd0e8c3282d5bd2e26762e4c9dfbe1ef35f3256d6a5dc397934b5544835f34ff24263cbc00bdd516b6f0df3f29cdf6c779ccfb', '04cf60398ae73fd947ffe120fba68947ec741fe696438d68a2e52caca139613ff94f220cd0d3e886f95aa226f2ad2b86be1dd5cda2813fd505d1f6a8f552904864'],
+            // Test with 0x prefix
+            ['98d22cdb65bbf8a392180cd2ee892b0a971c47e7d29daf31a3286d006b9db4dc', '0xf67118680df5993e8efca4d3ecc4172ca4ac5e3e007ea774293e37386480970347427f3633371c1a30abbb2b717dbd78ef63d5b19b5a951f9d681cccdd520320', '04cf60398ae73fd947ffe120fba68947ec741fe696438d68a2e52caca139613ff94f220cd0d3e886f95aa226f2ad2b86be1dd5cda2813fd505d1f6a8f552904864'],
+        ];
+    }
+
+    public function testVerifyWithInvalidStringSignature() {
+        $message = '98d22cdb65bbf8a392180cd2ee892b0a971c47e7d29daf31a3286d006b9db4dc';
+        $invalidSignature = 'aaaa18680df5993e8efca4d3ecc4172ca4ac5e3e007ea774293e37386480970347427f3633371c1a30abbb2b717dbd78ef63d5b19b5a951f9d681cccdd520320';
+        $publicKey = '04cf60398ae73fd947ffe120fba68947ec741fe696438d68a2e52caca139613ff94f220cd0d3e886f95aa226f2ad2b86be1dd5cda2813fd505d1f6a8f552904864';
+
+        $this->assertFalse($this->secp256k1->verify($message, $invalidSignature, $publicKey));
+    }
+
 }