The Tor Browser: services/sync/tests/unit/test_service_detect_upgrade.js@fc2d59ddac77 (annotated)

services/sync/tests/unit/test_service_detect_upgrade.js@fc2d59ddac77 (annotated)

services/sync/tests/unit/test_service_detect_upgrade.js

Wed, 31 Dec 2014 07:22:50 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Wed, 31 Dec 2014 07:22:50 +0100
branch: TOR_BUG_3246
changeset 4: fc2d59ddac77
permissions: -rw-r--r--

Correct previous dual key logic pending first delivery installment.

 /* Any copyright is dedicated to the Public Domain.
  * http://creativecommons.org/publicdomain/zero/1.0/ */
 Cu.import("resource://gre/modules/Log.jsm");
 Cu.import("resource://services-sync/constants.js");
 Cu.import("resource://services-sync/keys.js");
 Cu.import("resource://services-sync/engines/tabs.js");
 Cu.import("resource://services-sync/engines.js");
 Cu.import("resource://services-sync/record.js");
 Cu.import("resource://services-sync/service.js");
 Cu.import("resource://services-sync/util.js");
 Cu.import("resource://testing-common/services/sync/utils.js");
 Service.engineManager.register(TabEngine);
 add_test(function v4_upgrade() {
   let passphrase = "abcdeabcdeabcdeabcdeabcdea";
   let clients = new ServerCollection();
   let meta_global = new ServerWBO('global');
   // Tracking info/collections.
   let collectionsHelper = track_collections_helper();
   let upd = collectionsHelper.with_updated_collection;
   let collections = collectionsHelper.collections;
   let keysWBO = new ServerWBO("keys");
   let server = httpd_setup({
     // Special.
     "/1.1/johndoe/info/collections": collectionsHelper.handler,
     "/1.1/johndoe/storage/crypto/keys": upd("crypto", keysWBO.handler()),
     "/1.1/johndoe/storage/meta/global": upd("meta", meta_global.handler()),
     // Track modified times.
     "/1.1/johndoe/storage/clients": upd("clients", clients.handler()),
     "/1.1/johndoe/storage/tabs": upd("tabs", new ServerCollection().handler()),
     // Just so we don't get 404s in the logs.
     "/1.1/johndoe/storage/bookmarks": new ServerCollection().handler(),
     "/1.1/johndoe/storage/forms": new ServerCollection().handler(),
     "/1.1/johndoe/storage/history": new ServerCollection().handler(),
     "/1.1/johndoe/storage/passwords": new ServerCollection().handler(),
     "/1.1/johndoe/storage/prefs": new ServerCollection().handler()
   });
   ensureLegacyIdentityManager();
   try {
     _("Set up some tabs.");
     let myTabs =
       {windows: [{tabs: [{index: 1,
                           entries: [{
                             url: "http://foo.com/",
                             title: "Title"
                           }],
                           attributes: {
                             image: "image"
                           }
                           }]}]};
     delete Svc.Session;
     Svc.Session = {
       getBrowserState: function () JSON.stringify(myTabs)
     };
     Service.status.resetSync();
     _("Logging in.");
     Service.serverURL = server.baseURI;
     Service.login("johndoe", "ilovejane", passphrase);
     do_check_true(Service.isLoggedIn);
     Service.verifyAndFetchSymmetricKeys();
     do_check_true(Service._remoteSetup());
     function test_out_of_date() {
       _("Old meta/global: " + JSON.stringify(meta_global));
       meta_global.payload = JSON.stringify({"syncID": "foooooooooooooooooooooooooo",
                                             "storageVersion": STORAGE_VERSION + 1});
       collections.meta = Date.now() / 1000;
       _("New meta/global: " + JSON.stringify(meta_global));
       Service.recordManager.set(Service.metaURL, meta_global);
       try {
         Service.sync();
       }
       catch (ex) {
       }
       do_check_eq(Service.status.sync, VERSION_OUT_OF_DATE);
     }
     // See what happens when we bump the storage version.
     _("Syncing after server has been upgraded.");
     test_out_of_date();
     // Same should happen after a wipe.
     _("Syncing after server has been upgraded and wiped.");
     Service.wipeServer();
     test_out_of_date();
     // Now's a great time to test what happens when keys get replaced.
     _("Syncing afresh...");
     Service.logout();
     Service.collectionKeys.clear();
     Service.serverURL = server.baseURI;
     meta_global.payload = JSON.stringify({"syncID": "foooooooooooooobbbbbbbbbbbb",
                                           "storageVersion": STORAGE_VERSION});
     collections.meta = Date.now() / 1000;
     Service.recordManager.set(Service.metaURL, meta_global);
     Service.login("johndoe", "ilovejane", passphrase);
     do_check_true(Service.isLoggedIn);
     Service.sync();
     do_check_true(Service.isLoggedIn);
     let serverDecrypted;
     let serverKeys;
     let serverResp;
     function retrieve_server_default() {
       serverKeys = serverResp = serverDecrypted = null;
       serverKeys = new CryptoWrapper("crypto", "keys");
       serverResp = serverKeys.fetch(Service.resource(Service.cryptoKeysURL)).response;
       do_check_true(serverResp.success);
       serverDecrypted = serverKeys.decrypt(Service.identity.syncKeyBundle);
       _("Retrieved WBO:       " + JSON.stringify(serverDecrypted));
       _("serverKeys:          " + JSON.stringify(serverKeys));
       return serverDecrypted.default;
     }
     function retrieve_and_compare_default(should_succeed) {
       let serverDefault = retrieve_server_default();
       let localDefault = Service.collectionKeys.keyForCollection().keyPairB64;
       _("Retrieved keyBundle: " + JSON.stringify(serverDefault));
       _("Local keyBundle:     " + JSON.stringify(localDefault));
       if (should_succeed)
         do_check_eq(JSON.stringify(serverDefault), JSON.stringify(localDefault));
       else
         do_check_neq(JSON.stringify(serverDefault), JSON.stringify(localDefault));
     }
     // Uses the objects set above.
     function set_server_keys(pair) {
       serverDecrypted.default = pair;
       serverKeys.cleartext = serverDecrypted;
       serverKeys.encrypt(Service.identity.syncKeyBundle);
       serverKeys.upload(Service.resource(Service.cryptoKeysURL));
     }
     _("Checking we have the latest keys.");
     retrieve_and_compare_default(true);
     _("Update keys on server.");
     set_server_keys(["KaaaaaaaaaaaHAtfmuRY0XEJ7LXfFuqvF7opFdBD/MY=",
                      "aaaaaaaaaaaapxMO6TEWtLIOv9dj6kBAJdzhWDkkkis="]);
     _("Checking that we no longer have the latest keys.");
     retrieve_and_compare_default(false);
     _("Indeed, they're what we set them to...");
     do_check_eq("KaaaaaaaaaaaHAtfmuRY0XEJ7LXfFuqvF7opFdBD/MY=",
                 retrieve_server_default()[0]);
     _("Sync. Should download changed keys automatically.");
     let oldClientsModified = collections.clients;
     let oldTabsModified = collections.tabs;
     Service.login("johndoe", "ilovejane", passphrase);
     Service.sync();
     _("New key should have forced upload of data.");
     _("Tabs: " + oldTabsModified + " < " + collections.tabs);
     _("Clients: " + oldClientsModified + " < " + collections.clients);
     do_check_true(collections.clients > oldClientsModified);
     do_check_true(collections.tabs    > oldTabsModified);
     _("... and keys will now match.");
     retrieve_and_compare_default(true);
     // Clean up.
     Service.startOver();
   } finally {
     Svc.Prefs.resetBranch("");
     server.stop(run_next_test);
   }
 });
 add_test(function v5_upgrade() {
   let passphrase = "abcdeabcdeabcdeabcdeabcdea";
   // Tracking info/collections.
   let collectionsHelper = track_collections_helper();
   let upd = collectionsHelper.with_updated_collection;
   let collections = collectionsHelper.collections;
   let keysWBO = new ServerWBO("keys");
   let bulkWBO = new ServerWBO("bulk");
   let clients = new ServerCollection();
   let meta_global = new ServerWBO('global');
   let server = httpd_setup({
     // Special.
     "/1.1/johndoe/storage/meta/global": upd("meta", meta_global.handler()),
     "/1.1/johndoe/info/collections": collectionsHelper.handler,
     "/1.1/johndoe/storage/crypto/keys": upd("crypto", keysWBO.handler()),
     "/1.1/johndoe/storage/crypto/bulk": upd("crypto", bulkWBO.handler()),
     // Track modified times.
     "/1.1/johndoe/storage/clients": upd("clients", clients.handler()),
     "/1.1/johndoe/storage/tabs": upd("tabs", new ServerCollection().handler()),
   });
   try {
     _("Set up some tabs.");
     let myTabs =
       {windows: [{tabs: [{index: 1,
                           entries: [{
                             url: "http://foo.com/",
                             title: "Title"
                           }],
                           attributes: {
                             image: "image"
                           }
                           }]}]};
     delete Svc.Session;
     Svc.Session = {
       getBrowserState: function () JSON.stringify(myTabs)
     };
     Service.status.resetSync();
     setBasicCredentials("johndoe", "ilovejane", passphrase);
     Service.serverURL = server.baseURI + "/";
     Service.clusterURL = server.baseURI + "/";
     // Test an upgrade where the contents of the server would cause us to error
     // -- keys decrypted with a different sync key, for example.
     _("Testing v4 -> v5 (or similar) upgrade.");
     function update_server_keys(syncKeyBundle, wboName, collWBO) {
       generateNewKeys(Service.collectionKeys);
       serverKeys = Service.collectionKeys.asWBO("crypto", wboName);
       serverKeys.encrypt(syncKeyBundle);
       let res = Service.resource(Service.storageURL + collWBO);
       do_check_true(serverKeys.upload(res).success);
     }
     _("Bumping version.");
     // Bump version on the server.
     let m = new WBORecord("meta", "global");
     m.payload = {"syncID": "foooooooooooooooooooooooooo",
                  "storageVersion": STORAGE_VERSION + 1};
     m.upload(Service.resource(Service.metaURL));
     _("New meta/global: " + JSON.stringify(meta_global));
     // Fill the keys with bad data.
     let badKeys = new SyncKeyBundle("foobar", "aaaaaaaaaaaaaaaaaaaaaaaaaa");
     update_server_keys(badKeys, "keys", "crypto/keys");  // v4
     update_server_keys(badKeys, "bulk", "crypto/bulk");  // v5
     _("Generating new keys.");
     generateNewKeys(Service.collectionKeys);
     // Now sync and see what happens. It should be a version fail, not a crypto
     // fail.
     _("Logging in.");
     try {
       Service.login("johndoe", "ilovejane", passphrase);
     }
     catch (e) {
       _("Exception: " + e);
     }
     _("Status: " + Service.status);
     do_check_false(Service.isLoggedIn);
     do_check_eq(VERSION_OUT_OF_DATE, Service.status.sync);
     // Clean up.
     Service.startOver();
   } finally {
     Svc.Prefs.resetBranch("");
     server.stop(run_next_test);
   }
 });
 function run_test() {
   let logger = Log.repository.rootLogger;
   Log.repository.rootLogger.addAppender(new Log.DumpAppender());
   run_next_test();
 }