michael@0: /* Any copyright is dedicated to the Public Domain.
michael@0:  * http://creativecommons.org/publicdomain/zero/1.0/ */
michael@0: 
michael@0: Cu.import("resource://services-sync/constants.js");
michael@0: Cu.import("resource://services-sync/identity.js");
michael@0: Cu.import("resource://services-sync/keys.js");
michael@0: Cu.import("resource://services-sync/record.js");
michael@0: Cu.import("resource://services-sync/util.js");
michael@0: 
michael@0: let collectionKeys = new CollectionKeyManager();
michael@0: 
michael@0: function sha256HMAC(message, key) {
michael@0:   let h = Utils.makeHMACHasher(Ci.nsICryptoHMAC.SHA256, key);
michael@0:   return Utils.digestBytes(message, h);
michael@0: }
michael@0: 
michael@0: function do_check_array_eq(a1, a2) {
michael@0:   do_check_eq(a1.length, a2.length);
michael@0:   for (let i = 0; i < a1.length; ++i) {
michael@0:     do_check_eq(a1[i], a2[i]);
michael@0:   }
michael@0: }
michael@0: 
michael@0: function do_check_keypair_eq(a, b) {
michael@0:   do_check_eq(2, a.length);
michael@0:   do_check_eq(2, b.length);
michael@0:   do_check_eq(a[0], b[0]);
michael@0:   do_check_eq(a[1], b[1]);
michael@0: }
michael@0: 
michael@0: function test_time_keyFromString(iterations) {
michael@0:   let k;
michael@0:   let o;
michael@0:   let b = new BulkKeyBundle("dummy");
michael@0:   let d = Utils.decodeKeyBase32("ababcdefabcdefabcdefabcdef");
michael@0:   b.generateRandom();
michael@0: 
michael@0:   _("Running " + iterations + " iterations of hmacKeyObject + sha256HMAC.");
michael@0:   for (let i = 0; i < iterations; ++i) {
michael@0:     let k = b.hmacKeyObject;
michael@0:     o = sha256HMAC(d, k);
michael@0:   }
michael@0:   do_check_true(!!o);
michael@0:   _("Done.");
michael@0: }
michael@0: 
michael@0: add_test(function test_set_invalid_values() {
michael@0:   _("Ensure that setting invalid encryption and HMAC key values is caught.");
michael@0: 
michael@0:   let bundle = new BulkKeyBundle("foo");
michael@0: 
michael@0:   let thrown = false;
michael@0:   try {
michael@0:     bundle.encryptionKey = null;
michael@0:   } catch (ex) {
michael@0:     thrown = true;
michael@0:     do_check_eq(ex.message.indexOf("Encryption key can only be set to"), 0);
michael@0:   } finally {
michael@0:     do_check_true(thrown);
michael@0:     thrown = false;
michael@0:   }
michael@0: 
michael@0:   try {
michael@0:     bundle.encryptionKey = ["trollololol"];
michael@0:   } catch (ex) {
michael@0:     thrown = true;
michael@0:     do_check_eq(ex.message.indexOf("Encryption key can only be set to"), 0);
michael@0:   } finally {
michael@0:     do_check_true(thrown);
michael@0:     thrown = false;
michael@0:   }
michael@0: 
michael@0:   try {
michael@0:     bundle.hmacKey = Utils.generateRandomBytes(15);
michael@0:   } catch (ex) {
michael@0:     thrown = true;
michael@0:     do_check_eq(ex.message.indexOf("HMAC key must be at least 128"), 0);
michael@0:   } finally {
michael@0:     do_check_true(thrown);
michael@0:     thrown = false;
michael@0:   }
michael@0: 
michael@0:   try {
michael@0:     bundle.hmacKey = null;
michael@0:   } catch (ex) {
michael@0:     thrown = true;
michael@0:     do_check_eq(ex.message.indexOf("HMAC key can only be set to string"), 0);
michael@0:   } finally {
michael@0:     do_check_true(thrown);
michael@0:     thrown = false;
michael@0:   }
michael@0: 
michael@0:   try {
michael@0:     bundle.hmacKey = ["trollolol"];
michael@0:   } catch (ex) {
michael@0:     thrown = true;
michael@0:     do_check_eq(ex.message.indexOf("HMAC key can only be set to"), 0);
michael@0:   } finally {
michael@0:     do_check_true(thrown);
michael@0:     thrown = false;
michael@0:   }
michael@0: 
michael@0:   try {
michael@0:     bundle.hmacKey = Utils.generateRandomBytes(15);
michael@0:   } catch (ex) {
michael@0:     thrown = true;
michael@0:     do_check_eq(ex.message.indexOf("HMAC key must be at least 128"), 0);
michael@0:   } finally {
michael@0:     do_check_true(thrown);
michael@0:     thrown = false;
michael@0:   }
michael@0: 
michael@0:   run_next_test();
michael@0: });
michael@0: 
michael@0: add_test(function test_repeated_hmac() {
michael@0:   let testKey = "ababcdefabcdefabcdefabcdef";
michael@0:   let k = Utils.makeHMACKey("foo");
michael@0:   let one = sha256HMAC(Utils.decodeKeyBase32(testKey), k);
michael@0:   let two = sha256HMAC(Utils.decodeKeyBase32(testKey), k);
michael@0:   do_check_eq(one, two);
michael@0: 
michael@0:   run_next_test();
michael@0: });
michael@0: 
michael@0: add_test(function test_sync_key_bundle_derivation() {
michael@0:   _("Ensure derivation from known values works.");
michael@0: 
michael@0:   // The known values in this test were originally verified against Firefox
michael@0:   // Home.
michael@0:   let bundle = new SyncKeyBundle("st3fan", "q7ynpwq7vsc9m34hankbyi3s3i");
michael@0: 
michael@0:   // These should be compared to the results from Home, as they once were.
michael@0:   let e = "14b8c09fa84e92729ee695160af6e0385f8f6215a25d14906e1747bdaa2de426";
michael@0:   let h = "370e3566245d79fe602a3adb5137e42439cd2a571235197e0469d7d541b07875";
michael@0: 
michael@0:   let realE = Utils.bytesAsHex(bundle.encryptionKey);
michael@0:   let realH = Utils.bytesAsHex(bundle.hmacKey);
michael@0: 
michael@0:   _("Real E: " + realE);
michael@0:   _("Real H: " + realH);
michael@0:   do_check_eq(realH, h);
michael@0:   do_check_eq(realE, e);
michael@0: 
michael@0:   run_next_test();
michael@0: });
michael@0: 
michael@0: add_test(function test_keymanager() {
michael@0:   let testKey = "ababcdefabcdefabcdefabcdef";
michael@0:   let username = "john@example.com";
michael@0: 
michael@0:   // Decode the key here to mirror what generateEntry will do,
michael@0:   // but pass it encoded into the KeyBundle call below.
michael@0: 
michael@0:   let sha256inputE = "" + HMAC_INPUT + username + "\x01";
michael@0:   let key = Utils.makeHMACKey(Utils.decodeKeyBase32(testKey));
michael@0:   let encryptKey = sha256HMAC(sha256inputE, key);
michael@0: 
michael@0:   let sha256inputH = encryptKey + HMAC_INPUT + username + "\x02";
michael@0:   let hmacKey = sha256HMAC(sha256inputH, key);
michael@0: 
michael@0:   // Encryption key is stored in base64 for WeaveCrypto convenience.
michael@0:   do_check_eq(encryptKey, new SyncKeyBundle(username, testKey).encryptionKey);
michael@0:   do_check_eq(hmacKey,    new SyncKeyBundle(username, testKey).hmacKey);
michael@0: 
michael@0:   // Test with the same KeyBundle for both.
michael@0:   let obj = new SyncKeyBundle(username, testKey);
michael@0:   do_check_eq(hmacKey, obj.hmacKey);
michael@0:   do_check_eq(encryptKey, obj.encryptionKey);
michael@0: 
michael@0:   run_next_test();
michael@0: });
michael@0: 
michael@0: add_test(function test_collections_manager() {
michael@0:   let log = Log.repository.getLogger("Test");
michael@0:   Log.repository.rootLogger.addAppender(new Log.DumpAppender());
michael@0: 
michael@0:   let identity = new IdentityManager();
michael@0: 
michael@0:   identity.account = "john@example.com";
michael@0:   identity.syncKey = "a-bbbbb-ccccc-ddddd-eeeee-fffff";
michael@0: 
michael@0:   let keyBundle = identity.syncKeyBundle;
michael@0: 
michael@0:   /*
michael@0:    * Build a test version of storage/crypto/keys.
michael@0:    * Encrypt it with the sync key.
michael@0:    * Pass it into the CollectionKeyManager.
michael@0:    */
michael@0: 
michael@0:   log.info("Building storage keys...");
michael@0:   let storage_keys = new CryptoWrapper("crypto", "keys");
michael@0:   let default_key64 = Svc.Crypto.generateRandomKey();
michael@0:   let default_hmac64 = Svc.Crypto.generateRandomKey();
michael@0:   let bookmarks_key64 = Svc.Crypto.generateRandomKey();
michael@0:   let bookmarks_hmac64 = Svc.Crypto.generateRandomKey();
michael@0: 
michael@0:   storage_keys.cleartext = {
michael@0:     "default": [default_key64, default_hmac64],
michael@0:     "collections": {"bookmarks": [bookmarks_key64, bookmarks_hmac64]},
michael@0:   };
michael@0:   storage_keys.modified = Date.now()/1000;
michael@0:   storage_keys.id = "keys";
michael@0: 
michael@0:   log.info("Encrypting storage keys...");
michael@0: 
michael@0:   // Use passphrase (sync key) itself to encrypt the key bundle.
michael@0:   storage_keys.encrypt(keyBundle);
michael@0: 
michael@0:   // Sanity checking.
michael@0:   do_check_true(null == storage_keys.cleartext);
michael@0:   do_check_true(null != storage_keys.ciphertext);
michael@0: 
michael@0:   log.info("Updating collection keys.");
michael@0: 
michael@0:   // updateContents decrypts the object, releasing the payload for us to use.
michael@0:   // Returns true, because the default key has changed.
michael@0:   do_check_true(collectionKeys.updateContents(keyBundle, storage_keys));
michael@0:   let payload = storage_keys.cleartext;
michael@0: 
michael@0:   _("CK: " + JSON.stringify(collectionKeys._collections));
michael@0: 
michael@0:   // Test that the CollectionKeyManager returns a similar WBO.
michael@0:   let wbo = collectionKeys.asWBO("crypto", "keys");
michael@0: 
michael@0:   _("WBO: " + JSON.stringify(wbo));
michael@0:   _("WBO cleartext: " + JSON.stringify(wbo.cleartext));
michael@0: 
michael@0:   // Check the individual contents.
michael@0:   do_check_eq(wbo.collection, "crypto");
michael@0:   do_check_eq(wbo.id, "keys");
michael@0:   do_check_eq(undefined, wbo.modified);
michael@0:   do_check_eq(collectionKeys.lastModified, storage_keys.modified);
michael@0:   do_check_true(!!wbo.cleartext.default);
michael@0:   do_check_keypair_eq(payload.default, wbo.cleartext.default);
michael@0:   do_check_keypair_eq(payload.collections.bookmarks, wbo.cleartext.collections.bookmarks);
michael@0: 
michael@0:   do_check_true('bookmarks' in collectionKeys._collections);
michael@0:   do_check_false('tabs' in collectionKeys._collections);
michael@0: 
michael@0:   _("Updating contents twice with the same data doesn't proceed.");
michael@0:   storage_keys.encrypt(keyBundle);
michael@0:   do_check_false(collectionKeys.updateContents(keyBundle, storage_keys));
michael@0: 
michael@0:   /*
michael@0:    * Test that we get the right keys out when we ask for
michael@0:    * a collection's tokens.
michael@0:    */
michael@0:   let b1 = new BulkKeyBundle("bookmarks");
michael@0:   b1.keyPairB64 = [bookmarks_key64, bookmarks_hmac64];
michael@0:   let b2 = collectionKeys.keyForCollection("bookmarks");
michael@0:   do_check_keypair_eq(b1.keyPair, b2.keyPair);
michael@0: 
michael@0:   // Check key equality.
michael@0:   do_check_true(b1.equals(b2));
michael@0:   do_check_true(b2.equals(b1));
michael@0: 
michael@0:   b1 = new BulkKeyBundle("[default]");
michael@0:   b1.keyPairB64 = [default_key64, default_hmac64];
michael@0: 
michael@0:   do_check_false(b1.equals(b2));
michael@0:   do_check_false(b2.equals(b1));
michael@0: 
michael@0:   b2 = collectionKeys.keyForCollection(null);
michael@0:   do_check_keypair_eq(b1.keyPair, b2.keyPair);
michael@0: 
michael@0:   /*
michael@0:    * Checking for update times.
michael@0:    */
michael@0:   let info_collections = {};
michael@0:   do_check_true(collectionKeys.updateNeeded(info_collections));
michael@0:   info_collections["crypto"] = 5000;
michael@0:   do_check_false(collectionKeys.updateNeeded(info_collections));
michael@0:   info_collections["crypto"] = 1 + (Date.now()/1000);              // Add one in case computers are fast!
michael@0:   do_check_true(collectionKeys.updateNeeded(info_collections));
michael@0: 
michael@0:   collectionKeys.lastModified = null;
michael@0:   do_check_true(collectionKeys.updateNeeded({}));
michael@0: 
michael@0:   /*
michael@0:    * Check _compareKeyBundleCollections.
michael@0:    */
michael@0:   function newBundle(name) {
michael@0:     let r = new BulkKeyBundle(name);
michael@0:     r.generateRandom();
michael@0:     return r;
michael@0:   }
michael@0:   let k1 = newBundle("k1");
michael@0:   let k2 = newBundle("k2");
michael@0:   let k3 = newBundle("k3");
michael@0:   let k4 = newBundle("k4");
michael@0:   let k5 = newBundle("k5");
michael@0:   let coll1 = {"foo": k1, "bar": k2};
michael@0:   let coll2 = {"foo": k1, "bar": k2};
michael@0:   let coll3 = {"foo": k1, "bar": k3};
michael@0:   let coll4 = {"foo": k4};
michael@0:   let coll5 = {"baz": k5, "bar": k2};
michael@0:   let coll6 = {};
michael@0: 
michael@0:   let d1 = collectionKeys._compareKeyBundleCollections(coll1, coll2); // []
michael@0:   let d2 = collectionKeys._compareKeyBundleCollections(coll1, coll3); // ["bar"]
michael@0:   let d3 = collectionKeys._compareKeyBundleCollections(coll3, coll2); // ["bar"]
michael@0:   let d4 = collectionKeys._compareKeyBundleCollections(coll1, coll4); // ["bar", "foo"]
michael@0:   let d5 = collectionKeys._compareKeyBundleCollections(coll5, coll2); // ["baz", "foo"]
michael@0:   let d6 = collectionKeys._compareKeyBundleCollections(coll6, coll1); // ["bar", "foo"]
michael@0:   let d7 = collectionKeys._compareKeyBundleCollections(coll5, coll5); // []
michael@0:   let d8 = collectionKeys._compareKeyBundleCollections(coll6, coll6); // []
michael@0: 
michael@0:   do_check_true(d1.same);
michael@0:   do_check_false(d2.same);
michael@0:   do_check_false(d3.same);
michael@0:   do_check_false(d4.same);
michael@0:   do_check_false(d5.same);
michael@0:   do_check_false(d6.same);
michael@0:   do_check_true(d7.same);
michael@0:   do_check_true(d8.same);
michael@0: 
michael@0:   do_check_array_eq(d1.changed, []);
michael@0:   do_check_array_eq(d2.changed, ["bar"]);
michael@0:   do_check_array_eq(d3.changed, ["bar"]);
michael@0:   do_check_array_eq(d4.changed, ["bar", "foo"]);
michael@0:   do_check_array_eq(d5.changed, ["baz", "foo"]);
michael@0:   do_check_array_eq(d6.changed, ["bar", "foo"]);
michael@0: 
michael@0:   run_next_test();
michael@0: });
michael@0: 
michael@0: function run_test() {
michael@0:   // Only do 1,000 to avoid a 5-second pause in test runs.
michael@0:   test_time_keyFromString(1000);
michael@0: 
michael@0:   run_next_test();
michael@0: }