Update fingerprint generation interface.

With the introduction of UUIDs, we need to be able to generate fingerprints from raw bytes, not just strings. In addition, we need to be able to conditionally set the fingerprint version based on whether or not we're using UUIDs.

Reflects signalapp/libsignal-protocol-java@3662b6d

Also NumericFingerprintGeneratorTest.testVectors() passes now

Author: golf1052

libsignal-protocol-dotnet-tests/fingerprint/NumericFingerprintGeneratorTest.cs

@@ -1,135 +1,140 @@
-/** 
- * Copyright (C) 2017 langboost, golf1052
- * 
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- * 
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-
-using System;
-using Microsoft.VisualStudio.TestTools.UnitTesting;
-using libsignal.ecc;
-using libsignal;
-using libsignal.fingerprint;
-
-namespace org.whispersystems.libsignal.fingerprint
-{
-    [TestClass]
-    public class NumericFingerprintGeneratorTest
-    {
-        private static readonly byte[] ALICE_IDENTITY = { 0x05, 0x06, 0x86, 0x3b, 0xc6, 0x6d, 0x02, 0xb4, 0x0d, 0x27, 0xb8, 0xd4, 0x9c, 0xa7, 0xc0, 0x9e, 0x92, 0x39, 0x23, 0x6f, 0x9d, 0x7d, 0x25, 0xd6, 0xfc, 0xca, 0x5c, 0xe1, 0x3c, 0x70, 0x64, 0xd8, 0x68 };
-        private static readonly byte[] BOB_IDENTITY = { 0x05, 0xf7, 0x81, 0xb6, 0xfb, 0x32, 0xfe, 0xd9, 0xba, 0x1c, 0xf2, 0xde, 0x97, 0x8d, 0x4d, 0x5d, 0xa2, 0x8d, 0xc3, 0x40, 0x46, 0xae, 0x81, 0x44, 0x02, 0xb5, 0xc0, 0xdb, 0xd9, 0x6f, 0xda, 0x90, 0x7b };
-        private static readonly string DISPLAYABLE_FINGERPRINT     = "300354477692869396892869876765458257569162576843440918079131";
-        private static readonly byte[] ALICE_SCANNABLE_FINGERPRINT = new byte[] { 0x08, 0x01, 0x12, 0x22, 0x0a, 0x20, 0x1e, 0x30, 0x1a, 0x03, 0x53, 0xdc, 0xe3, 0xdb, 0xe7, 0x68, 0x4c, 0xb8, 0x33, 0x6e, 0x85, 0x13, 0x6c, 0xdc, 0x0e, 0xe9, 0x62, 0x19, 0x49, 0x4a, 0xda, 0x30, 0x5d, 0x62, 0xa7, 0xbd, 0x61, 0xdf, 0x1a, 0x22, 0x0a, 0x20, 0xd6, 0x2c, 0xbf, 0x73, 0xa1, 0x15, 0x92, 0x01, 0x5b, 0x6b, 0x9f, 0x16, 0x82, 0xac, 0x30, 0x6f, 0xea, 0x3a, 0xaf, 0x38, 0x85, 0xb8, 0x4d, 0x12, 0xbc, 0xa6, 0x31, 0xe9, 0xd4, 0xfb, 0x3a, 0x4d };
-        private static readonly byte[] BOB_SCANNABLE_FINGERPRINT = new byte[] { 0x08, 0x01, 0x12, 0x22, 0x0a, 0x20, 0xd6, 0x2c, 0xbf, 0x73, 0xa1, 0x15, 0x92, 0x01, 0x5b, 0x6b, 0x9f, 0x16, 0x82, 0xac, 0x30, 0x6f, 0xea, 0x3a, 0xaf, 0x38, 0x85, 0xb8, 0x4d, 0x12, 0xbc, 0xa6, 0x31, 0xe9, 0xd4, 0xfb, 0x3a, 0x4d, 0x1a, 0x22, 0x0a, 0x20, 0x1e, 0x30, 0x1a, 0x03, 0x53, 0xdc, 0xe3, 0xdb, 0xe7, 0x68, 0x4c, 0xb8, 0x33, 0x6e, 0x85, 0x13, 0x6c, 0xdc, 0x0e, 0xe9, 0x62, 0x19, 0x49, 0x4a, 0xda, 0x30, 0x5d, 0x62, 0xa7, 0xbd, 0x61, 0xdf };
-
-        [TestMethod]
-        public void testVectors()
+/** 
+ * Copyright (C) 2017 langboost, golf1052
+ * 
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+using System.Text;
+using libsignal;
+using libsignal.ecc;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+
+namespace org.whispersystems.libsignal.fingerprint
+{
+    [TestClass]
+    public class NumericFingerprintGeneratorTest
+    {
+        private const int VERSION = 1;
+        private static readonly byte[] ALICE_IDENTITY = { 0x05, 0x06, 0x86, 0x3b, 0xc6, 0x6d, 0x02, 0xb4, 0x0d, 0x27, 0xb8, 0xd4, 0x9c, 0xa7, 0xc0, 0x9e, 0x92, 0x39, 0x23, 0x6f, 0x9d, 0x7d, 0x25, 0xd6, 0xfc, 0xca, 0x5c, 0xe1, 0x3c, 0x70, 0x64, 0xd8, 0x68 };
+        private static readonly byte[] BOB_IDENTITY = { 0x05, 0xf7, 0x81, 0xb6, 0xfb, 0x32, 0xfe, 0xd9, 0xba, 0x1c, 0xf2, 0xde, 0x97, 0x8d, 0x4d, 0x5d, 0xa2, 0x8d, 0xc3, 0x40, 0x46, 0xae, 0x81, 0x44, 0x02, 0xb5, 0xc0, 0xdb, 0xd9, 0x6f, 0xda, 0x90, 0x7b };
+        private static readonly string DISPLAYABLE_FINGERPRINT     = "300354477692869396892869876765458257569162576843440918079131";
+        private static readonly byte[] ALICE_SCANNABLE_FINGERPRINT = new byte[] { 0x08, 0x01, 0x12, 0x22, 0x0a, 0x20, 0x1e, 0x30, 0x1a, 0x03, 0x53, 0xdc, 0xe3, 0xdb, 0xe7, 0x68, 0x4c, 0xb8, 0x33, 0x6e, 0x85, 0x13, 0x6c, 0xdc, 0x0e, 0xe9, 0x62, 0x19, 0x49, 0x4a, 0xda, 0x30, 0x5d, 0x62, 0xa7, 0xbd, 0x61, 0xdf, 0x1a, 0x22, 0x0a, 0x20, 0xd6, 0x2c, 0xbf, 0x73, 0xa1, 0x15, 0x92, 0x01, 0x5b, 0x6b, 0x9f, 0x16, 0x82, 0xac, 0x30, 0x6f, 0xea, 0x3a, 0xaf, 0x38, 0x85, 0xb8, 0x4d, 0x12, 0xbc, 0xa6, 0x31, 0xe9, 0xd4, 0xfb, 0x3a, 0x4d };
+        private static readonly byte[] BOB_SCANNABLE_FINGERPRINT = new byte[] { 0x08, 0x01, 0x12, 0x22, 0x0a, 0x20, 0xd6, 0x2c, 0xbf, 0x73, 0xa1, 0x15, 0x92, 0x01, 0x5b, 0x6b, 0x9f, 0x16, 0x82, 0xac, 0x30, 0x6f, 0xea, 0x3a, 0xaf, 0x38, 0x85, 0xb8, 0x4d, 0x12, 0xbc, 0xa6, 0x31, 0xe9, 0xd4, 0xfb, 0x3a, 0x4d, 0x1a, 0x22, 0x0a, 0x20, 0x1e, 0x30, 0x1a, 0x03, 0x53, 0xdc, 0xe3, 0xdb, 0xe7, 0x68, 0x4c, 0xb8, 0x33, 0x6e, 0x85, 0x13, 0x6c, 0xdc, 0x0e, 0xe9, 0x62, 0x19, 0x49, 0x4a, 0xda, 0x30, 0x5d, 0x62, 0xa7, 0xbd, 0x61, 0xdf };
+
+        [TestMethod]
+        public void testVectors()
         {
-            return; //disable for now
-            IdentityKey aliceIdentityKey = new IdentityKey(ALICE_IDENTITY, 0);
-            IdentityKey bobIdentityKey = new IdentityKey(BOB_IDENTITY, 0);
-
-            NumericFingerprintGenerator generator = new NumericFingerprintGenerator(5200);
-            Fingerprint aliceFingerprint = generator.createFor(
-                "+14152222222", aliceIdentityKey,
-                "+14153333333", bobIdentityKey);
-
-            Fingerprint bobFingerprint = generator.createFor(
-                "+14153333333", bobIdentityKey,
-                "+14152222222", aliceIdentityKey);
-
-            Assert.AreEqual(aliceFingerprint.getDisplayableFingerprint().getDisplayText(), DISPLAYABLE_FINGERPRINT);
-            Assert.AreEqual(bobFingerprint.getDisplayableFingerprint().getDisplayText(), DISPLAYABLE_FINGERPRINT);
-
-            CollectionAssert.AreEqual(aliceFingerprint.getScannableFingerprint().getSerialized(), ALICE_SCANNABLE_FINGERPRINT);
-            CollectionAssert.AreEqual(bobFingerprint.getScannableFingerprint().getSerialized(), BOB_SCANNABLE_FINGERPRINT);
-        }
-
-        [TestMethod]
-        public void testMatchingFingerprints()
-        {
-            ECKeyPair aliceKeyPair = Curve.generateKeyPair();
-            ECKeyPair bobKeyPair = Curve.generateKeyPair();
-
-            IdentityKey aliceIdentityKey = new IdentityKey(aliceKeyPair.getPublicKey());
-            IdentityKey bobIdentityKey = new IdentityKey(bobKeyPair.getPublicKey());
-
-            NumericFingerprintGenerator generator = new NumericFingerprintGenerator(1024);
-            Fingerprint aliceFingerprint = generator.createFor("+14152222222", aliceIdentityKey,
-                                                                               "+14153333333", bobIdentityKey);
-
-            Fingerprint bobFingerprint = generator.createFor("+14153333333", bobIdentityKey,
-                                                             "+14152222222", aliceIdentityKey);
-
-            Assert.AreEqual<string>(aliceFingerprint.getDisplayableFingerprint().getDisplayText(),
-                         bobFingerprint.getDisplayableFingerprint().getDisplayText());
-
-            Assert.IsTrue(
-                aliceFingerprint.getScannableFingerprint().compareTo(
-                    bobFingerprint.getScannableFingerprint().getSerialized()));
-            Assert.IsTrue(
-                bobFingerprint.getScannableFingerprint().compareTo(
-                    aliceFingerprint.getScannableFingerprint().getSerialized()));
-
-            Assert.AreEqual<int>(aliceFingerprint.getDisplayableFingerprint().getDisplayText().Length, 60);
-        }
-
-        [TestMethod]
-        public void testMismatchingFingerprints()
-        {
-            ECKeyPair aliceKeyPair = Curve.generateKeyPair();
-            ECKeyPair bobKeyPair = Curve.generateKeyPair();
-            ECKeyPair mitmKeyPair = Curve.generateKeyPair();
-
-            IdentityKey aliceIdentityKey = new IdentityKey(aliceKeyPair.getPublicKey());
-            IdentityKey bobIdentityKey = new IdentityKey(bobKeyPair.getPublicKey());
-            IdentityKey mitmIdentityKey = new IdentityKey(mitmKeyPair.getPublicKey());
-
-            NumericFingerprintGenerator generator = new NumericFingerprintGenerator(1024);
-            Fingerprint aliceFingerprint = generator.createFor("+14152222222", aliceIdentityKey,
-                                                                               "+14153333333", mitmIdentityKey);
-
-            Fingerprint bobFingerprint = generator.createFor("+14153333333", bobIdentityKey,
-                                                             "+14152222222", aliceIdentityKey);
-
-            Assert.AreNotEqual<string>(aliceFingerprint.getDisplayableFingerprint().getDisplayText(),
-                          bobFingerprint.getDisplayableFingerprint().getDisplayText());
-
-            Assert.IsFalse(aliceFingerprint.getScannableFingerprint().compareTo(bobFingerprint.getScannableFingerprint().getSerialized()));
-            Assert.IsFalse(bobFingerprint.getScannableFingerprint().compareTo(aliceFingerprint.getScannableFingerprint().getSerialized()));
-        }
-
-        [TestMethod]
-        public void testMismatchingIdentifiers()
-        {
-            ECKeyPair aliceKeyPair = Curve.generateKeyPair();
-            ECKeyPair bobKeyPair = Curve.generateKeyPair();
-
-            IdentityKey aliceIdentityKey = new IdentityKey(aliceKeyPair.getPublicKey());
-            IdentityKey bobIdentityKey = new IdentityKey(bobKeyPair.getPublicKey());
-
-            NumericFingerprintGenerator generator = new NumericFingerprintGenerator(1024);
-            Fingerprint aliceFingerprint = generator.createFor("+141512222222", aliceIdentityKey,
-                                                                               "+14153333333", bobIdentityKey);
-
-            Fingerprint bobFingerprint = generator.createFor("+14153333333", bobIdentityKey,
-                                                             "+14152222222", aliceIdentityKey);
-
-            Assert.AreNotEqual<string>(aliceFingerprint.getDisplayableFingerprint().getDisplayText(),
-                          bobFingerprint.getDisplayableFingerprint().getDisplayText());
-            Assert.IsFalse(aliceFingerprint.getScannableFingerprint().compareTo(bobFingerprint.getScannableFingerprint().getSerialized()));
-            Assert.IsFalse(bobFingerprint.getScannableFingerprint().compareTo(aliceFingerprint.getScannableFingerprint().getSerialized()));
-        }
-
-    }
-}
+            IdentityKey aliceIdentityKey = new IdentityKey(ALICE_IDENTITY, 0);
+            IdentityKey bobIdentityKey = new IdentityKey(BOB_IDENTITY, 0);
+
+            NumericFingerprintGenerator generator = new NumericFingerprintGenerator(5200);
+            Fingerprint aliceFingerprint = generator.createFor(VERSION,
+                Encoding.UTF8.GetBytes("+14152222222"), aliceIdentityKey,
+                Encoding.UTF8.GetBytes("+14153333333"), bobIdentityKey);
+
+            Fingerprint bobFingerprint = generator.createFor(VERSION,
+                Encoding.UTF8.GetBytes("+14153333333"), bobIdentityKey,
+                Encoding.UTF8.GetBytes("+14152222222"), aliceIdentityKey);
+
+            Assert.AreEqual(aliceFingerprint.getDisplayableFingerprint().getDisplayText(), DISPLAYABLE_FINGERPRINT);
+            Assert.AreEqual(bobFingerprint.getDisplayableFingerprint().getDisplayText(), DISPLAYABLE_FINGERPRINT);
+
+            CollectionAssert.AreEqual(aliceFingerprint.getScannableFingerprint().getSerialized(), ALICE_SCANNABLE_FINGERPRINT);
+            CollectionAssert.AreEqual(bobFingerprint.getScannableFingerprint().getSerialized(), BOB_SCANNABLE_FINGERPRINT);
+        }
+
+        [TestMethod]
+        public void testMatchingFingerprints()
+        {
+            ECKeyPair aliceKeyPair = Curve.generateKeyPair();
+            ECKeyPair bobKeyPair = Curve.generateKeyPair();
+
+            IdentityKey aliceIdentityKey = new IdentityKey(aliceKeyPair.getPublicKey());
+            IdentityKey bobIdentityKey = new IdentityKey(bobKeyPair.getPublicKey());
+
+            NumericFingerprintGenerator generator = new NumericFingerprintGenerator(1024);
+            Fingerprint aliceFingerprint = generator.createFor(VERSION,
+                Encoding.UTF8.GetBytes("+14152222222"), aliceIdentityKey,
+                Encoding.UTF8.GetBytes("+14153333333"), bobIdentityKey);
+
+            Fingerprint bobFingerprint = generator.createFor(VERSION,
+                Encoding.UTF8.GetBytes("+14153333333"), bobIdentityKey,
+                Encoding.UTF8.GetBytes("+14152222222"), aliceIdentityKey);
+
+            Assert.AreEqual<string>(aliceFingerprint.getDisplayableFingerprint().getDisplayText(),
+                         bobFingerprint.getDisplayableFingerprint().getDisplayText());
+
+            Assert.IsTrue(
+                aliceFingerprint.getScannableFingerprint().compareTo(
+                    bobFingerprint.getScannableFingerprint().getSerialized()));
+            Assert.IsTrue(
+                bobFingerprint.getScannableFingerprint().compareTo(
+                    aliceFingerprint.getScannableFingerprint().getSerialized()));
+
+            Assert.AreEqual<int>(aliceFingerprint.getDisplayableFingerprint().getDisplayText().Length, 60);
+        }
+
+        [TestMethod]
+        public void testMismatchingFingerprints()
+        {
+            ECKeyPair aliceKeyPair = Curve.generateKeyPair();
+            ECKeyPair bobKeyPair = Curve.generateKeyPair();
+            ECKeyPair mitmKeyPair = Curve.generateKeyPair();
+
+            IdentityKey aliceIdentityKey = new IdentityKey(aliceKeyPair.getPublicKey());
+            IdentityKey bobIdentityKey = new IdentityKey(bobKeyPair.getPublicKey());
+            IdentityKey mitmIdentityKey = new IdentityKey(mitmKeyPair.getPublicKey());
+
+            NumericFingerprintGenerator generator = new NumericFingerprintGenerator(1024);
+            Fingerprint aliceFingerprint = generator.createFor(VERSION,
+                Encoding.UTF8.GetBytes("+14152222222"), aliceIdentityKey,
+                Encoding.UTF8.GetBytes("+14153333333"), mitmIdentityKey);
+
+            Fingerprint bobFingerprint = generator.createFor(VERSION,
+                Encoding.UTF8.GetBytes("+14153333333"), bobIdentityKey,
+                Encoding.UTF8.GetBytes("+14152222222"), aliceIdentityKey);
+
+            Assert.AreNotEqual<string>(aliceFingerprint.getDisplayableFingerprint().getDisplayText(),
+                          bobFingerprint.getDisplayableFingerprint().getDisplayText());
+
+            Assert.IsFalse(aliceFingerprint.getScannableFingerprint().compareTo(bobFingerprint.getScannableFingerprint().getSerialized()));
+            Assert.IsFalse(bobFingerprint.getScannableFingerprint().compareTo(aliceFingerprint.getScannableFingerprint().getSerialized()));
+        }
+
+        [TestMethod]
+        public void testMismatchingIdentifiers()
+        {
+            ECKeyPair aliceKeyPair = Curve.generateKeyPair();
+            ECKeyPair bobKeyPair = Curve.generateKeyPair();
+
+            IdentityKey aliceIdentityKey = new IdentityKey(aliceKeyPair.getPublicKey());
+            IdentityKey bobIdentityKey = new IdentityKey(bobKeyPair.getPublicKey());
+
+            NumericFingerprintGenerator generator = new NumericFingerprintGenerator(1024);
+            Fingerprint aliceFingerprint = generator.createFor(VERSION,
+                Encoding.UTF8.GetBytes("+141512222222"), aliceIdentityKey,
+                Encoding.UTF8.GetBytes("+14153333333"), bobIdentityKey);
+
+            Fingerprint bobFingerprint = generator.createFor(VERSION,
+                Encoding.UTF8.GetBytes("+14153333333"), bobIdentityKey,
+                Encoding.UTF8.GetBytes("+14152222222"), aliceIdentityKey);
+
+            Assert.AreNotEqual<string>(aliceFingerprint.getDisplayableFingerprint().getDisplayText(),
+                          bobFingerprint.getDisplayableFingerprint().getDisplayText());
+            Assert.IsFalse(aliceFingerprint.getScannableFingerprint().compareTo(bobFingerprint.getScannableFingerprint().getSerialized()));
+            Assert.IsFalse(bobFingerprint.getScannableFingerprint().compareTo(aliceFingerprint.getScannableFingerprint().getSerialized()));
+        }
+
+    }
+}

libsignal-protocol-dotnet/fingerprint/FingerprintGenerator.cs

@@ -21,10 +21,16 @@
 namespace org.whispersystems.libsignal.fingerprint
 {
     public interface FingerprintGenerator {
-        Fingerprint createFor(string localStableIdentifier, IdentityKey localIdentityKey,
-                                     string remoteStableIdentifier, IdentityKey remoteIdentityKey);
+        Fingerprint createFor(int version,
+            byte[] localStableIdentifier,
+            IdentityKey localIdentityKey,
+            byte[] remoteStableIdentifier,
+            IdentityKey remoteIdentityKey);
 
-        Fingerprint createFor(string localStableIdentifier, List<IdentityKey> localIdentityKey,
-            string remoteStableIdentifier, List<IdentityKey> remoteIdentityKey);
+        Fingerprint createFor(int version,
+            byte[] localStableIdentifier,
+            List<IdentityKey> localIdentityKey,
+            byte[] remoteStableIdentifier,
+            List<IdentityKey> remoteIdentityKey);
     }
-}
+}