/* ***** BEGIN LICENSE BLOCK ***** * Version: MPL 1.1/GPL 2.0/LGPL 2.1 * * The contents of this file are subject to the Mozilla Public License Version * 1.1 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * http://www.mozilla.org/MPL/ * * Software distributed under the License is distributed on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License * for the specific language governing rights and limitations under the * License. * * The Original Code is Bookmarks Sync. * * The Initial Developer of the Original Code is Mozilla. * Portions created by the Initial Developer are Copyright (C) 2007 * the Initial Developer. All Rights Reserved. * * Contributor(s): * Dan Mills * Myk Melez * Anant Narayanan * * Alternatively, the contents of this file may be used under the terms of * either the GNU General Public License Version 2 or later (the "GPL"), or * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), * in which case the provisions of the GPL or the LGPL are applicable instead * of those above. If you wish to allow use of your version of this file only * under the terms of either the GPL or the LGPL, and not to allow others to * use your version of this file under the terms of the MPL, indicate your * decision by deleting the provisions above and replace them with the notice * and other provisions required by the GPL or the LGPL. If you do not delete * the provisions above, a recipient may use your version of this file under * the terms of any one of the MPL, the GPL or the LGPL. * * ***** END LICENSE BLOCK ***** */ const EXPORTED_SYMBOLS = ['Weave']; const Cc = Components.classes; const Ci = Components.interfaces; const Cr = Components.results; const Cu = Components.utils; // how long we should wait before actually syncing on idle const IDLE_TIME = 5; // xxxmpc: in seconds, should be preffable // How long before refreshing the cluster const CLUSTER_BACKOFF = 5 * 60 * 1000; // 5 minutes Cu.import("resource://gre/modules/XPCOMUtils.jsm"); Cu.import("resource://weave/ext/Sync.js"); Cu.import("resource://weave/log4moz.js"); Cu.import("resource://weave/constants.js"); Cu.import("resource://weave/util.js"); Cu.import("resource://weave/auth.js"); Cu.import("resource://weave/resource.js"); Cu.import("resource://weave/base_records/wbo.js"); Cu.import("resource://weave/base_records/crypto.js"); Cu.import("resource://weave/base_records/keys.js"); Cu.import("resource://weave/engines.js"); Cu.import("resource://weave/identity.js"); Cu.import("resource://weave/status.js"); Cu.import("resource://weave/engines/clients.js"); // for export let Weave = {}; Cu.import("resource://weave/constants.js", Weave); Cu.import("resource://weave/util.js", Weave); Cu.import("resource://weave/auth.js", Weave); Cu.import("resource://weave/resource.js", Weave); Cu.import("resource://weave/base_records/keys.js", Weave); Cu.import("resource://weave/notifications.js", Weave); Cu.import("resource://weave/identity.js", Weave); Cu.import("resource://weave/status.js", Weave); Cu.import("resource://weave/stores.js", Weave); Cu.import("resource://weave/engines.js", Weave); Cu.import("resource://weave/engines/bookmarks.js", Weave); Cu.import("resource://weave/engines/clients.js", Weave); Cu.import("resource://weave/engines/forms.js", Weave); Cu.import("resource://weave/engines/history.js", Weave); Cu.import("resource://weave/engines/prefs.js", Weave); Cu.import("resource://weave/engines/passwords.js", Weave); Cu.import("resource://weave/engines/tabs.js", Weave); Utils.lazy(Weave, 'Service', WeaveSvc); /* * Service singleton * Main entry point into Weave's sync framework */ function WeaveSvc() { this._notify = Utils.notify("weave:service:"); } WeaveSvc.prototype = { _lock: Utils.lock, _catch: Utils.catch, _locked: false, _loggedIn: false, keyGenEnabled: true, // object for caching public and private keys _keyPair: {}, get username() { return Svc.Prefs.get("username", "").toLowerCase(); }, set username(value) { if (value) { // Make sure all uses of this new username is lowercase value = value.toLowerCase(); // Tab characters are stripped from URIs, so make sure that the // username doesn't contain any tabs. value = value.replace("\t", "", "g"); Svc.Prefs.set("username", value); } else Svc.Prefs.reset("username"); // fixme - need to loop over all Identity objects - needs some rethinking... ID.get('WeaveID').username = value; ID.get('WeaveCryptoID').username = value; // FIXME: need to also call this whenever the username pref changes this._updateCachedURLs(); }, get password() ID.get("WeaveID").password, set password(value) ID.get("WeaveID").password = value, get passphrase() ID.get("WeaveCryptoID").password, set passphrase(value) ID.get("WeaveCryptoID").password = value, get serverURL() Svc.Prefs.get("serverURL"), set serverURL(value) { // Only do work if it's actually changing if (value == this.serverURL) return; // A new server most likely uses a different cluster, so clear that Svc.Prefs.set("serverURL", value); Svc.Prefs.reset("clusterURL"); }, get clusterURL() Svc.Prefs.get("clusterURL", ""), set clusterURL(value) { Svc.Prefs.set("clusterURL", value); this._updateCachedURLs(); }, get miscAPI() { // Append to the serverURL if it's a relative fragment let misc = Svc.Prefs.get("miscURL"); if (misc.indexOf(":") == -1) misc = this.serverURL + misc; return misc + "1.0/"; }, get userAPI() { // Append to the serverURL if it's a relative fragment let user = Svc.Prefs.get("userURL"); if (user.indexOf(":") == -1) user = this.serverURL + user; return user + "1.0/"; }, get pwResetURL() { return this.serverURL + "weave-password-reset"; }, get updatedURL() { return WEAVE_CHANNEL == "dev" ? UPDATED_DEV_URL : UPDATED_REL_URL; }, get syncID() { // Generate a random syncID id we don't have one let syncID = Svc.Prefs.get("client.syncID", ""); return syncID == "" ? this.syncID = Utils.makeGUID() : syncID; }, set syncID(value) { Svc.Prefs.set("client.syncID", value); }, get isLoggedIn() { return this._loggedIn; }, // nextSync and nextHeartbeat are in milliseconds, but prefs can't hold that much get nextSync() Svc.Prefs.get("nextSync", 0) * 1000, set nextSync(value) Svc.Prefs.set("nextSync", Math.floor(value / 1000)), get nextHeartbeat() Svc.Prefs.get("nextHeartbeat", 0) * 1000, set nextHeartbeat(value) Svc.Prefs.set("nextHeartbeat", Math.floor(value / 1000)), get syncInterval() { // If we have a partial download, sync sooner if we're not mobile if (Status.partial && Clients.clientType != "mobile") return PARTIAL_DATA_SYNC; return Svc.Prefs.get("syncInterval", MULTI_MOBILE_SYNC); }, set syncInterval(value) Svc.Prefs.set("syncInterval", value), get syncThreshold() Svc.Prefs.get("syncThreshold", SINGLE_USER_THRESHOLD), set syncThreshold(value) Svc.Prefs.set("syncThreshold", value), get globalScore() Svc.Prefs.get("globalScore", 0), set globalScore(value) Svc.Prefs.set("globalScore", value), get numClients() Svc.Prefs.get("numClients", 0), set numClients(value) Svc.Prefs.set("numClients", value), get locked() { return this._locked; }, lock: function Svc_lock() { if (this._locked) return false; this._locked = true; return true; }, unlock: function Svc_unlock() { this._locked = false; }, _updateCachedURLs: function _updateCachedURLs() { // Nothing to cache yet if we don't have the building blocks if (this.clusterURL == "" || this.username == "") return; let storageAPI = this.clusterURL + Svc.Prefs.get("storageAPI") + "/"; let userBase = storageAPI + this.username + "/"; this._log.debug("Caching URLs under storage user base: " + userBase); // Generate and cache various URLs under the storage API for this user this.infoURL = userBase + "info/collections"; this.storageURL = userBase + "storage/"; this.metaURL = this.storageURL + "meta/global"; PubKeys.defaultKeyUri = this.storageURL + "keys/pubkey"; PrivKeys.defaultKeyUri = this.storageURL + "keys/privkey"; }, _checkCrypto: function WeaveSvc__checkCrypto() { let ok = false; try { let iv = Svc.Crypto.generateRandomIV(); if (iv.length == 24) ok = true; } catch (e) { this._log.debug("Crypto check failed: " + e); } return ok; }, /** * Prepare to initialize the rest of Weave after waiting a little bit */ onStartup: function onStartup() { this._initLogs(); this._log.info("Loading Weave " + WEAVE_VERSION); this.enabled = true; this._registerEngines(); let ua = Cc["@mozilla.org/network/protocol;1?name=http"]. getService(Ci.nsIHttpProtocolHandler).userAgent; this._log.info(ua); if (!this._checkCrypto()) { this.enabled = false; this._log.error("Could not load the Weave crypto component. Disabling " + "Weave, since it will not work correctly."); } Svc.Obs.add("network:offline-status-changed", this); Svc.Obs.add("private-browsing", this); Svc.Obs.add("weave:service:sync:finish", this); Svc.Obs.add("weave:service:sync:error", this); Svc.Obs.add("weave:service:backoff:interval", this); Svc.Obs.add("weave:engine:score:updated", this); Svc.Obs.add("weave:resource:status:401", this); if (!this.enabled) this._log.info("Weave Sync disabled"); // Create Weave identities (for logging in, and for encryption) ID.set('WeaveID', new Identity('Mozilla Services Password', this.username)); Auth.defaultAuthenticator = new BasicAuthenticator(ID.get('WeaveID')); ID.set('WeaveCryptoID', new Identity('Mozilla Services Encryption Passphrase', this.username)); this._updateCachedURLs(); // Applications can specify this preference if they want autoconnect // to happen after a fixed delay. let delay = Svc.Prefs.get("autoconnectDelay"); if (delay) { this.delayedAutoConnect(delay); } // Send an event now that Weave service is ready. We don't do this // synchronously so that observers will definitely have access to the // 'Weave' namespace. Utils.delay(function() Svc.Obs.notify("weave:service:ready"), 0); }, _checkSetup: function WeaveSvc__checkSetup() { if (!this.username) { this._log.debug("checkSetup: no username set"); Status.login = LOGIN_FAILED_NO_USERNAME; } else if (!Utils.mpLocked() && !this.password) { this._log.debug("checkSetup: no password set"); Status.login = LOGIN_FAILED_NO_PASSWORD; } else if (!Utils.mpLocked() && !this.passphrase) { this._log.debug("checkSetup: no passphrase set"); Status.login = LOGIN_FAILED_NO_PASSPHRASE; } else Status.service = STATUS_OK; return Status.service; }, _initLogs: function WeaveSvc__initLogs() { this._log = Log4Moz.repository.getLogger("Service.Main"); this._log.level = Log4Moz.Level[Svc.Prefs.get("log.logger.service.main")]; let formatter = new Log4Moz.BasicFormatter(); let root = Log4Moz.repository.rootLogger; root.level = Log4Moz.Level[Svc.Prefs.get("log.rootLogger")]; let capp = new Log4Moz.ConsoleAppender(formatter); capp.level = Log4Moz.Level[Svc.Prefs.get("log.appender.console")]; root.addAppender(capp); let dapp = new Log4Moz.DumpAppender(formatter); dapp.level = Log4Moz.Level[Svc.Prefs.get("log.appender.dump")]; root.addAppender(dapp); let verbose = Svc.Directory.get("ProfD", Ci.nsIFile); verbose.QueryInterface(Ci.nsILocalFile); verbose.append("weave"); verbose.append("logs"); verbose.append("verbose-log.txt"); if (!verbose.exists()) verbose.create(verbose.NORMAL_FILE_TYPE, PERMS_FILE); let maxSize = 65536; // 64 * 1024 (64KB) this._debugApp = new Log4Moz.RotatingFileAppender(verbose, formatter, maxSize); this._debugApp.level = Log4Moz.Level[Svc.Prefs.get("log.appender.debugLog")]; root.addAppender(this._debugApp); }, clearLogs: function WeaveSvc_clearLogs() { this._debugApp.clear(); }, /** * Register the built-in engines for certain applications */ _registerEngines: function WeaveSvc__registerEngines() { let engines = []; // Applications can provide this preference (comma-separated list) // to specify which engines should be registered on startup. let pref = Svc.Prefs.get("registerEngines"); if (pref) { engines = pref.split(","); } else { // Fallback for the add-on case switch (Svc.AppInfo.ID) { case FENNEC_ID: engines = ["Tab", "Bookmarks", "Form", "History", "Password"]; break; case FIREFOX_ID: engines = ["Bookmarks", "Form", "History", "Password", "Prefs", "Tab"]; break; case SEAMONKEY_ID: engines = ["Form", "History", "Password", "Tab"]; break; } } // Grab the actual engine and register them Engines.register(engines.map(function(name) Weave[name + "Engine"])); }, QueryInterface: XPCOMUtils.generateQI([Ci.nsIObserver, Ci.nsISupportsWeakReference]), // nsIObserver observe: function WeaveSvc__observe(subject, topic, data) { switch (topic) { case "network:offline-status-changed": // Whether online or offline, we'll reschedule syncs this._log.trace("Network offline status change: " + data); this._checkSyncStatus(); break; case "private-browsing": // Entering or exiting private browsing? Reschedule syncs this._log.trace("Private browsing change: " + data); this._checkSyncStatus(); break; case "weave:service:sync:error": this._handleSyncError(); if (Status.sync == CREDENTIALS_CHANGED) { this.logout(); Utils.delay(function() this.login(), 0, this); } break; case "weave:service:sync:finish": this._scheduleNextSync(); this._syncErrors = 0; break; case "weave:service:backoff:interval": let interval = (data + Math.random() * data * 0.25) * 1000; // required backoff + up to 25% Status.backoffInterval = interval; Status.minimumNextSync = Date.now() + data; break; case "weave:engine:score:updated": this._handleScoreUpdate(); break; case "weave:resource:status:401": this._handleResource401(subject); break; case "idle": this._log.trace("Idle time hit, trying to sync"); Svc.Idle.removeIdleObserver(this, this._idleTime); this._idleTime = 0; Utils.delay(function() this.sync(false), 0, this); break; } }, _handleScoreUpdate: function WeaveSvc__handleScoreUpdate() { const SCORE_UPDATE_DELAY = 3000; Utils.delay(this._calculateScore, SCORE_UPDATE_DELAY, this, "_scoreTimer"); }, _calculateScore: function WeaveSvc_calculateScoreAndDoStuff() { var engines = Engines.getEnabled(); for (let i = 0;i < engines.length;i++) { this._log.trace(engines[i].name + ": score: " + engines[i].score); this.globalScore += engines[i].score; engines[i]._tracker.resetScore(); } this._log.trace("Global score updated: " + this.globalScore); this._checkSyncStatus(); }, _handleResource401: function _handleResource401(request) { // Only handle 401s that are hitting the current cluster let spec = request.resource.spec; let cluster = this.clusterURL; if (spec.indexOf(cluster) != 0) return; // Nothing to do if the cluster isn't changing if (!this._setCluster()) return; // Replace the old cluster with the new one to retry the request request.newUri = this.clusterURL + spec.slice(cluster.length); }, // gets cluster from central LDAP server and returns it, or null on error _findCluster: function _findCluster() { this._log.debug("Finding cluster for user " + this.username); let fail; let res = new Resource(this.userAPI + this.username + "/node/weave"); try { let node = res.get(); switch (node.status) { case 400: Status.login = LOGIN_FAILED_LOGIN_REJECTED; fail = "Find cluster denied: " + this._errorStr(node); break; case 404: this._log.debug("Using serverURL as data cluster (multi-cluster support disabled)"); return this.serverURL; case 0: case 200: if (node == "null") node = null; return node; default: this._log.debug("Unexpected response code: " + node.status); break; } } catch (e) { this._log.debug("Network error on findCluster"); Status.login = LOGIN_FAILED_NETWORK_ERROR; fail = e; } throw fail; }, // gets cluster from central LDAP server and sets this.clusterURL _setCluster: function _setCluster() { // Make sure we didn't get some unexpected response for the cluster let cluster = this._findCluster(); this._log.debug("cluster value = " + cluster); if (cluster == null) return false; // Don't update stuff if we already have the right cluster if (cluster == this.clusterURL) return false; this.clusterURL = cluster; return true; }, // update cluster if required. returns false if the update was not required _updateCluster: function _updateCluster() { let cTime = Date.now(); let lastUp = parseFloat(Svc.Prefs.get("lastClusterUpdate")); if (!lastUp || ((cTime - lastUp) >= CLUSTER_BACKOFF)) { if (this._setCluster()) { Svc.Prefs.set("lastClusterUpdate", cTime.toString()); return true; } } return false; }, _verifyLogin: function _verifyLogin() this._notify("verify-login", "", function() { // Make sure we have a cluster to verify against // this is a little weird, if we don't get a node we pretend // to succeed, since that probably means we just don't have storage if (this.clusterURL == "" && !this._setCluster()) { Status.sync = NO_SYNC_NODE_FOUND; Svc.Obs.notify("weave:service:sync:delayed"); return true; } try { let test = new Resource(this.infoURL).get(); switch (test.status) { case 200: // The user is authenticated, so check the passphrase now if (!this._verifyPassphrase()) { Status.login = LOGIN_FAILED_INVALID_PASSPHRASE; return false; } // Username/password and passphrase all verified Status.login = LOGIN_SUCCEEDED; return true; case 401: case 404: // Check that we're verifying with the correct cluster if (this._setCluster()) return this._verifyLogin(); // We must have the right cluster, but the server doesn't expect us Status.login = LOGIN_FAILED_LOGIN_REJECTED; return false; default: // Server didn't respond with something that we expected this._checkServerError(test); Status.login = LOGIN_FAILED_SERVER_ERROR; return false; } } catch (ex) { // Must have failed on some network issue this._log.debug("verifyLogin failed: " + Utils.exceptionStr(ex)); Status.login = LOGIN_FAILED_NETWORK_ERROR; return false; } })(), _verifyPassphrase: function _verifyPassphrase() this._catch(this._notify("verify-passphrase", "", function() { // Don't allow empty/missing passphrase if (!this.passphrase) return false; try { let pubkey = PubKeys.getDefaultKey(); let privkey = PrivKeys.get(pubkey.privateKeyUri); return Svc.Crypto.verifyPassphrase( privkey.payload.keyData, this.passphrase, privkey.payload.salt, privkey.payload.iv ); } catch (e) { // this means no keys are present (or there's a network error) return true; } }))(), changePassword: function WeaveSvc_changePassword(newpass) this._notify("changepwd", "", function() { let url = this.userAPI + this.username + "/password"; try { let resp = new Resource(url).post(newpass); if (resp.status != 200) { this._log.debug("Password change failed: " + resp); return false; } } catch(ex) { // Must have failed on some network issue this._log.debug("changePassword failed: " + Utils.exceptionStr(ex)); return false; } // Save the new password for requests and login manager this.password = newpass; this.persistLogin(); return true; })(), changePassphrase: function WeaveSvc_changePassphrase(newphrase) this._catch(this._notify("changepph", "", function() { /* Wipe */ this.wipeServer(); PubKeys.clearCache(); PrivKeys.clearCache(); this.logout(); /* Set this so UI is updated on next run */ this.passphrase = newphrase; this.persistLogin(); /* Login in sync: this also generates new keys */ this.login(); this.sync(true); return true; }))(), startOver: function() { // Set a username error so the status message shows "set up..." Status.login = LOGIN_FAILED_NO_USERNAME; this.logout(); // Reset all engines this.resetClient(); // Reset Weave prefs Svc.Prefs.resetBranch(""); // set lastversion pref Svc.Prefs.set("lastversion", WEAVE_VERSION); // Find weave logins and remove them. this.password = ""; this.passphrase = ""; Svc.Login.findLogins({}, PWDMGR_HOST, "", "").map(function(login) { Svc.Login.removeLogin(login); }); Svc.Obs.notify("weave:service:start-over"); }, delayedAutoConnect: function delayedAutoConnect(delay) { if (this._loggedIn) return; if (this._checkSetup() == STATUS_OK && Svc.Prefs.get("autoconnect")) { Utils.delay(this._autoConnect, delay * 1000, this, "_autoTimer"); } }, _autoConnect: let (attempts = 0) function _autoConnect() { let reason = Utils.mpLocked() ? "master password still locked" : this._checkSync([kSyncNotLoggedIn, kFirstSyncChoiceNotMade]); // Can't autoconnect if we're missing these values if (!reason) { if (!this.username || !this.password || !this.passphrase) return; // Nothing more to do on a successful login if (this.login()) return; } // Something failed, so try again some time later let interval = this._calculateBackoff(++attempts, 60 * 1000); this._log.debug("Autoconnect failed: " + (reason || Status.login) + "; retry in " + Math.ceil(interval / 1000) + " sec."); Utils.delay(function() this._autoConnect(), interval, this, "_autoTimer"); }, persistLogin: function persistLogin() { // Canceled master password prompt can prevent these from succeeding try { ID.get("WeaveID").persist(); ID.get("WeaveCryptoID").persist(); } catch(ex) {} }, login: function WeaveSvc_login(username, password, passphrase) this._catch(this._lock(this._notify("login", "", function() { this._loggedIn = false; if (Svc.IO.offline) throw "Application is offline, login should not be called"; if (username) this.username = username; if (password) this.password = password; if (passphrase) this.passphrase = passphrase; if (this._checkSetup() == CLIENT_NOT_CONFIGURED) throw "aborting login, client not configured"; this._log.info("Logging in user " + this.username); if (!this._verifyLogin()) { // verifyLogin sets the failure states here. throw "Login failed: " + Status.login; } // No need to try automatically connecting after a successful login if (this._autoTimer) this._autoTimer.clear(); this._loggedIn = true; // Try starting the sync timer now that we're logged in this._checkSyncStatus(); Svc.Prefs.set("autoconnect", true); return true; })))(), logout: function WeaveSvc_logout() { // No need to do anything if we're already logged out if (!this._loggedIn) return; this._log.info("Logging out"); this._loggedIn = false; this._keyPair = {}; // Cancel the sync timer now that we're logged out this._checkSyncStatus(); Svc.Prefs.set("autoconnect", false); Svc.Obs.notify("weave:service:logout:finish"); }, _errorStr: function WeaveSvc__errorStr(code) { switch (code.toString()) { case "1": return "illegal-method"; case "2": return "invalid-captcha"; case "3": return "invalid-username"; case "4": return "cannot-overwrite-resource"; case "5": return "userid-mismatch"; case "6": return "json-parse-failure"; case "7": return "invalid-password"; case "8": return "invalid-record"; case "9": return "weak-password"; default: return "generic-server-error"; } }, checkUsername: function WeaveSvc_checkUsername(username) { let url = this.userAPI + username; let res = new Resource(url); res.authenticator = new NoOpAuthenticator(); let data = ""; try { data = res.get(); if (data.status == 200) { if (data == "0") return "available"; else if (data == "1") return "notAvailable"; } } catch(ex) {} // Convert to the error string, or default to generic on exception return this._errorStr(data); }, createAccount: function WeaveSvc_createAccount(username, password, email, captchaChallenge, captchaResponse) { let payload = JSON.stringify({ "password": password, "email": email, "captcha-challenge": captchaChallenge, "captcha-response": captchaResponse }); let url = this.userAPI + username; let res = new Resource(url); res.authenticator = new Weave.NoOpAuthenticator(); if (Svc.Prefs.isSet("admin-secret")) res.setHeader("X-Weave-Secret", Svc.Prefs.get("admin-secret", "")); let error = "generic-server-error"; try { let register = res.put(payload); if (register.success) { this._log.info("Account created: " + register); return null; } // Must have failed, so figure out the reason if (register.status == 400) error = this._errorStr(register); } catch(ex) { this._log.warn("Failed to create account: " + ex); } return error; }, // stuff we need to to after login, before we can really do // anything (e.g. key setup) _remoteSetup: function WeaveSvc__remoteSetup() { let reset = false; this._log.trace("Fetching global metadata record"); let meta = Records.import(this.metaURL); let remoteVersion = (meta && meta.payload.storageVersion)? meta.payload.storageVersion : ""; this._log.debug(["Weave Version:", WEAVE_VERSION, "Local Storage:", STORAGE_VERSION, "Remote Storage:", remoteVersion].join(" ")); // Check for cases that require a fresh start. When comparing remoteVersion, // we need to convert it to a number as older clients used it as a string. if (!meta || !meta.payload.storageVersion || !meta.payload.syncID || STORAGE_VERSION > parseFloat(remoteVersion)) { // abort the server wipe if the GET status was anything other than 404 or 200 let status = Records.response.status; if (status != 200 && status != 404) { this._checkServerError(Records.response); Status.sync = METARECORD_DOWNLOAD_FAIL; this._log.warn("Unknown error while downloading metadata record. " + "Aborting sync."); return false; } if (!meta) this._log.info("No metadata record, server wipe needed"); if (meta && !meta.payload.syncID) this._log.warn("No sync id, server wipe needed"); if (!this.keyGenEnabled) { this._log.info("...and key generation is disabled. Not wiping. " + "Aborting sync."); Status.sync = DESKTOP_VERSION_OUT_OF_DATE; return false; } reset = true; this._log.info("Wiping server data"); this._freshStart(); if (status == 404) this._log.info("Metadata record not found, server wiped to ensure " + "consistency."); else // 200 this._log.info("Wiped server; incompatible metadata: " + remoteVersion); } else if (remoteVersion > STORAGE_VERSION) { Status.sync = VERSION_OUT_OF_DATE; this._log.warn("Upgrade required to access newer storage version."); return false; } else if (meta.payload.syncID != this.syncID) { this.resetClient(); this.syncID = meta.payload.syncID; this._log.debug("Clear cached values and take syncId: " + this.syncID); // XXX Bug 531005 Wait long enough to allow potentially another concurrent // sync to finish generating the keypair and uploading them Sync.sleep(15000); // bug 545725 - re-verify creds and fail sanely if (!this._verifyLogin()) { Status.sync = CREDENTIALS_CHANGED; this._log.info("Credentials have changed, aborting sync and forcing re-login."); return false; } } let needKeys = true; let pubkey = PubKeys.getDefaultKey(); if (!pubkey) this._log.debug("Could not get public key"); else if (pubkey.keyData == null) this._log.debug("Public key has no key data"); else { // make sure we have a matching privkey let privkey = PrivKeys.get(pubkey.privateKeyUri); if (!privkey) this._log.debug("Could not get private key"); else if (privkey.keyData == null) this._log.debug("Private key has no key data"); else return true; } if (needKeys) { if (PubKeys.response.status != 404 && PrivKeys.response.status != 404) { this._log.warn("Couldn't download keys from server, aborting sync"); this._log.debug("PubKey HTTP status: " + PubKeys.response.status); this._log.debug("PrivKey HTTP status: " + PrivKeys.response.status); this._checkServerError(PubKeys.response); this._checkServerError(PrivKeys.response); Status.sync = KEYS_DOWNLOAD_FAIL; return false; } if (!this.keyGenEnabled) { this._log.warn("Couldn't download keys from server, and key generation" + "is disabled. Aborting sync"); Status.sync = NO_KEYS_NO_KEYGEN; return false; } if (!reset) { this._log.warn("Calling freshStart from !reset case."); this._freshStart(); this._log.info("Server data wiped to ensure consistency due to missing keys"); } let passphrase = ID.get("WeaveCryptoID"); if (passphrase.password) { let keys = PubKeys.createKeypair(passphrase, PubKeys.defaultKeyUri, PrivKeys.defaultKeyUri); try { // Upload and cache the keypair PubKeys.uploadKeypair(keys); PubKeys.set(keys.pubkey.uri, keys.pubkey); PrivKeys.set(keys.privkey.uri, keys.privkey); return true; } catch (e) { Status.sync = KEYS_UPLOAD_FAIL; this._log.error("Could not upload keys: " + Utils.exceptionStr(e)); } } else { Status.sync = SETUP_FAILED_NO_PASSPHRASE; this._log.warn("Could not get encryption passphrase"); } } return false; }, /** * Determine if a sync should run. * * @param ignore [optional] * array of reasons to ignore when checking * * @return Reason for not syncing; not-truthy if sync should run */ _checkSync: function WeaveSvc__checkSync(ignore) { let reason = ""; if (!this.enabled) reason = kSyncWeaveDisabled; else if (Svc.IO.offline) reason = kSyncNetworkOffline; else if (Svc.Private && Svc.Private.privateBrowsingEnabled) // Svc.Private doesn't exist on Fennec -- don't assume it's there. reason = kSyncInPrivateBrowsing; else if (Status.minimumNextSync > Date.now()) reason = kSyncBackoffNotMet; else if (!this._loggedIn) reason = kSyncNotLoggedIn; else if (Svc.Prefs.get("firstSync") == "notReady") reason = kFirstSyncChoiceNotMade; if (ignore && ignore.indexOf(reason) != -1) return ""; return reason; }, /** * Remove any timers/observers that might trigger a sync */ _clearSyncTriggers: function _clearSyncTriggers() { // Clear out any scheduled syncs if (this._syncTimer) this._syncTimer.clear(); if (this._heartbeatTimer) this._heartbeatTimer.clear(); // Clear out a sync that's just waiting for idle if we happen to have one try { Svc.Idle.removeIdleObserver(this, this._idleTime); this._idleTime = 0; } catch(ex) {} }, /** * Check if we should be syncing and schedule the next sync, if it's not scheduled */ _checkSyncStatus: function WeaveSvc__checkSyncStatus() { // Should we be syncing now, if not, cancel any sync timers and return // if we're in backoff, we'll schedule the next sync if (this._checkSync([kSyncBackoffNotMet])) { this._clearSyncTriggers(); return; } // Only set the wait time to 0 if we need to sync right away let wait; if (this.globalScore > this.syncThreshold) { this._log.debug("Global Score threshold hit, triggering sync."); wait = 0; } this._scheduleNextSync(wait); }, /** * Call sync() on an idle timer * * delay is optional */ syncOnIdle: function WeaveSvc_syncOnIdle(delay) { // No need to add a duplicate idle observer if (this._idleTime) return; this._idleTime = delay || IDLE_TIME; this._log.debug("Idle timer created for sync, will sync after " + this._idleTime + " seconds of inactivity."); Svc.Idle.addIdleObserver(this, this._idleTime); }, /** * Set a timer for the next sync */ _scheduleNextSync: function WeaveSvc__scheduleNextSync(interval) { // Figure out when to sync next if not given a interval to wait if (interval == null) { // Check if we had a pending sync from last time if (this.nextSync != 0) interval = this.nextSync - Date.now(); // Use the bigger of default sync interval and backoff else interval = Math.max(this.syncInterval, Status.backoffInterval); } // Start the sync right away if we're already late if (interval <= 0) { this.syncOnIdle(); return; } this._log.trace("Next sync in " + Math.ceil(interval / 1000) + " sec."); Utils.delay(function() this.syncOnIdle(), interval, this, "_syncTimer"); // Save the next sync time in-case sync is disabled (logout/offline/etc.) this.nextSync = Date.now() + interval; // if we're a single client, set up a heartbeat to detect new clients sooner if (this.numClients == 1) this._scheduleHeartbeat(); }, /** * Hits info/collections on the server to see if there are new clients. * This is only called when the account has one active client, and if more * are found will trigger a sync to change client sync frequency and update data. */ _doHeartbeat: function WeaveSvc__doHeartbeat() { if (this._heartbeatTimer) this._heartbeatTimer.clear(); this.nextHeartbeat = 0; let info = null; try { info = new Resource(this.infoURL).get(); if (info && info.success) { // if clients.lastModified doesn't match what the server has, // we have another client in play this._log.trace("Remote timestamp:" + info.obj["clients"] + " Local timestamp: " + Clients.lastSync); if (info.obj["clients"] > Clients.lastSync) { this._log.debug("New clients detected, triggering a full sync"); this.syncOnIdle(); return; } } else { this._checkServerError(info); this._log.debug("Heartbeat failed. HTTP Error: " + info.status); } } catch(ex) { // if something throws unexpectedly, not a big deal this._log.debug("Heartbeat failed unexpectedly: " + ex); } // no joy, schedule the next heartbeat this._scheduleHeartbeat(); }, /** * Sets up a heartbeat ping to check for new clients. This is not a critical * behaviour for the client, so if we hit server/network issues, we'll just drop * this until the next sync. */ _scheduleHeartbeat: function WeaveSvc__scheduleNextHeartbeat() { if (this._heartbeatTimer) return; let now = Date.now(); if (this.nextHeartbeat && this.nextHeartbeat < now) { this._doHeartbeat(); return; } // if the next sync is in less than an hour, don't bother let interval = MULTI_DESKTOP_SYNC; if (this.nextSync < Date.now() + interval || Status.enforceBackoff) return; if (this.nextHeartbeat) interval = this.nextHeartbeat - now; else this.nextHeartbeat = now + interval; this._log.trace("Setting up heartbeat, next ping in " + Math.ceil(interval / 1000) + " sec."); Utils.delay(function() this._doHeartbeat(), interval, this, "_heartbeatTimer"); }, _syncErrors: 0, /** * Deal with sync errors appropriately */ _handleSyncError: function WeaveSvc__handleSyncError() { this._syncErrors++; // do nothing on the first couple of failures, if we're not in backoff due to 5xx errors if (!Status.enforceBackoff) { if (this._syncErrors < 3) { this._scheduleNextSync(); return; } Status.enforceBackoff = true; } const MINIMUM_BACKOFF_INTERVAL = 15 * 60 * 1000; // 15 minutes let interval = this._calculateBackoff(this._syncErrors, MINIMUM_BACKOFF_INTERVAL); this._scheduleNextSync(interval); let d = new Date(Date.now() + interval); this._log.config("Starting backoff, next sync at:" + d.toString()); }, /** * Sync up engines with the server. */ sync: function sync() this._catch(this._lock(this._notify("sync", "", function() { let syncStartTime = Date.now(); Status.resetSync(); // Make sure we should sync or record why we shouldn't let reason = this._checkSync(); if (reason) { // this is a purposeful abort rather than a failure, so don't set // any status bits reason = "Can't sync: " + reason; throw reason; } // if we don't have a node, get one. if that fails, retry in 10 minutes if (this.clusterURL == "" && !this._setCluster()) { this._scheduleNextSync(10 * 60 * 1000); return; } // Clear out any potentially pending syncs now that we're syncing this._clearSyncTriggers(); this.nextSync = 0; this.nextHeartbeat = 0; // reset backoff info, if the server tells us to continue backing off, // we'll handle that later Status.resetBackoff(); this.globalScore = 0; // Ping the server with a special info request once a day let infoURL = this.infoURL; let now = Math.floor(Date.now() / 1000); let lastPing = Svc.Prefs.get("lastPing", 0); if (now - lastPing > 86400) { // 60 * 60 * 24 infoURL += "?v=" + WEAVE_VERSION; Svc.Prefs.set("lastPing", now); } // Figure out what the last modified time is for each collection let info = new Resource(infoURL).get(); if (!info.success) throw "aborting sync, failed to get collections"; // Convert the response to an object and read out the modified times for each (let engine in [Clients].concat(Engines.getAll())) engine.lastModified = info.obj[engine.name] || 0; // If the modified time of crypto records ever changes, clear the cache if (info.obj.crypto != this.cryptoModified) { this._log.debug("Clearing cached crypto records"); CryptoMetas.clearCache(); this.cryptoModified = info.obj.crypto; } // If the modified time of keys records ever changes, clear the cache if (info.obj.keys != this.keysModified) { this._log.debug("Clearing cached keys records"); PubKeys.clearCache(); PrivKeys.clearCache(); this.keysModified = info.obj.keys; } if (!(this._remoteSetup())) throw "aborting sync, remote setup failed"; // Make sure we have an up-to-date list of clients before sending commands this._log.trace("Refreshing client list"); Clients.sync(); // Wipe data in the desired direction if necessary switch (Svc.Prefs.get("firstSync")) { case "resetClient": this.resetClient(Engines.getEnabled().map(function(e) e.name)); break; case "wipeClient": this.wipeClient(Engines.getEnabled().map(function(e) e.name)); break; case "wipeRemote": this.wipeRemote(Engines.getEnabled().map(function(e) e.name)); break; } // Process the incoming commands if we have any if (Clients.localCommands) { try { if (!(this.processCommands())) { Status.sync = ABORT_SYNC_COMMAND; throw "aborting sync, process commands said so"; } // Repeat remoteSetup in-case the commands forced us to reset if (!(this._remoteSetup())) throw "aborting sync, remote setup failed after processing commands"; } finally { // Always immediately push back the local client (now without commands) Clients.sync(); } } // Update the client mode now because it might change what we sync this._updateClientMode(); try { for each (let engine in Engines.getEnabled()) { // If there's any problems with syncing the engine, report the failure if (!(this._syncEngine(engine)) || Status.enforceBackoff) { this._log.info("Aborting sync"); break; } } // Upload meta/global if any engines changed anything let meta = Records.get(this.metaURL); if (meta.changed) new Resource(meta.uri).put(meta); if (this._syncError) throw "Some engines did not sync correctly"; else { Svc.Prefs.set("lastSync", new Date().toString()); Status.sync = SYNC_SUCCEEDED; let syncTime = ((Date.now() - syncStartTime) / 1000).toFixed(2); this._log.info("Sync completed successfully in " + syncTime + " secs."); } } finally { this._syncError = false; Svc.Prefs.reset("firstSync"); } })))(), /** * Process the locally stored clients list to figure out what mode to be in */ _updateClientMode: function _updateClientMode() { // Nothing to do if it's the same amount let {numClients, hasMobile} = Clients.stats; if (this.numClients == numClients) return; this._log.debug("Client count: " + this.numClients + " -> " + numClients); this.numClients = numClients; if (numClients == 1) { this.syncInterval = SINGLE_USER_SYNC; this.syncThreshold = SINGLE_USER_THRESHOLD; } else { this.syncInterval = hasMobile ? MULTI_MOBILE_SYNC : MULTI_DESKTOP_SYNC; this.syncThreshold = hasMobile ? MULTI_MOBILE_THRESHOLD : MULTI_DESKTOP_THRESHOLD; } }, // returns true if sync should proceed // false / no return value means sync should be aborted _syncEngine: function WeaveSvc__syncEngine(engine) { try { engine.sync(); return true; } catch(e) { // maybe a 401, cluster update needed? if (e.status == 401 && this._updateCluster()) return this._syncEngine(engine); this._checkServerError(e); Status.engines = [engine.name, e.failureCode || ENGINE_UNKNOWN_FAIL]; this._syncError = true; this._log.debug(Utils.exceptionStr(e)); return true; } finally { // If this engine has more to fetch, remember that globally if (engine.toFetch != null && engine.toFetch.length > 0) Status.partial = true; } }, _freshStart: function WeaveSvc__freshStart() { this.resetClient(); let meta = new WBORecord(this.metaURL); meta.payload.syncID = this.syncID; meta.payload.storageVersion = STORAGE_VERSION; this._log.debug("New metadata record: " + JSON.stringify(meta.payload)); let resp = new Resource(meta.uri).put(meta); if (!resp.success) throw resp; Records.set(meta.uri, meta); // Wipe everything we know about except meta because we just uploaded it let collections = [Clients].concat(Engines.getAll()).map(function(engine) { return engine.name; }); this.wipeServer(["crypto", "keys"].concat(collections)); }, /** * Check to see if this is a failure * */ _checkServerError: function WeaveSvc__checkServerError(resp) { if (Utils.checkStatus(resp.status, null, [500, [502, 504]])) { Status.enforceBackoff = true; if (resp.status == 503 && resp.headers["retry-after"]) Observers.notify("weave:service:backoff:interval", parseInt(resp.headers["retry-after"], 10)); } }, /** * Return a value for a backoff interval. Maximum is eight hours, unless * Status.backoffInterval is higher. * */ _calculateBackoff: function WeaveSvc__calculateBackoff(attempts, base_interval) { const MAXIMUM_BACKOFF_INTERVAL = 8 * 60 * 60 * 1000; // 8 hours let backoffInterval = attempts * (Math.floor(Math.random() * base_interval) + base_interval); return Math.max(Math.min(backoffInterval, MAXIMUM_BACKOFF_INTERVAL), Status.backoffInterval); }, /** * Wipe user data from the server. * * @param collections [optional] * Array of collections to wipe. If not given, all collections are wiped. */ wipeServer: function WeaveSvc_wipeServer(collections) this._catch(this._notify("wipe-server", "", function() { if (!collections) { collections = []; let info = new Resource(this.infoURL).get(); for (let name in info.obj) collections.push(name); } for each (let name in collections) { try { new Resource(this.storageURL + name).delete(); // Remove the crypto record from the server and local cache let crypto = this.storageURL + "crypto/" + name; new Resource(crypto).delete(); CryptoMetas.del(crypto); } catch(ex) { this._log.debug("Exception on wipe of '" + name + "': " + Utils.exceptionStr(ex)); } } }))(), /** * Wipe all local user data. * * @param engines [optional] * Array of engine names to wipe. If not given, all engines are used. */ wipeClient: function WeaveSvc_wipeClient(engines) this._catch(this._notify("wipe-client", "", function() { // If we don't have any engines, reset the service and wipe all engines if (!engines) { // Clear out any service data this.resetService(); engines = [Clients].concat(Engines.getAll()); } // Convert the array of names into engines else engines = Engines.get(engines); // Fully wipe each engine if it's able to decrypt data for each (let engine in engines) if (engine._testDecrypt()) engine.wipeClient(); // Save the password/passphrase just in-case they aren't restored by sync this.persistLogin(); }))(), /** * Wipe all remote user data by wiping the server then telling each remote * client to wipe itself. * * @param engines [optional] * Array of engine names to wipe. If not given, all engines are used. */ wipeRemote: function WeaveSvc_wipeRemote(engines) this._catch(this._notify("wipe-remote", "", function() { // Make sure stuff gets uploaded this.resetClient(engines); // Clear out any server data this.wipeServer(engines); // Only wipe the engines provided if (engines) engines.forEach(function(e) this.prepCommand("wipeEngine", [e]), this); // Tell the remote machines to wipe themselves else this.prepCommand("wipeAll", []); // Make sure the changed clients get updated Clients.sync(); }))(), /** * Reset local service information like logs, sync times, caches. */ resetService: function WeaveSvc_resetService() this._catch(this._notify("reset-service", "", function() { // First drop old logs to track client resetting behavior this.clearLogs(); this._log.info("Logs reinitialized for service reset"); // Pretend we've never synced to the server and drop cached data this.syncID = ""; Svc.Prefs.reset("lastSync"); for each (let cache in [PubKeys, PrivKeys, CryptoMetas, Records]) cache.clearCache(); }))(), /** * Reset the client by getting rid of any local server data and client data. * * @param engines [optional] * Array of engine names to reset. If not given, all engines are used. */ resetClient: function WeaveSvc_resetClient(engines) this._catch(this._notify("reset-client", "", function() { // If we don't have any engines, reset everything including the service if (!engines) { // Clear out any service data this.resetService(); engines = [Clients].concat(Engines.getAll()); } // Convert the array of names into engines else engines = Engines.get(engines); // Have each engine drop any temporary meta data for each (let engine in engines) engine.resetClient(); }))(), /** * A hash of valid commands that the client knows about. The key is a command * and the value is a hash containing information about the command such as * number of arguments and description. */ _commands: [ ["resetAll", 0, "Clear temporary local data for all engines"], ["resetEngine", 1, "Clear temporary local data for engine"], ["wipeAll", 0, "Delete all client data for all engines"], ["wipeEngine", 1, "Delete all client data for engine"], ["logout", 0, "Log out client"], ].reduce(function WeaveSvc__commands(commands, entry) { commands[entry[0]] = {}; for (let [i, attr] in Iterator(["args", "desc"])) commands[entry[0]][attr] = entry[i + 1]; return commands; }, {}), /** * Check if the local client has any remote commands and perform them. * * @return False to abort sync */ processCommands: function WeaveSvc_processCommands() this._notify("process-commands", "", function() { // Immediately clear out the commands as we've got them locally let commands = Clients.localCommands; Clients.clearCommands(); // Process each command in order for each ({command: command, args: args} in commands) { this._log.debug("Processing command: " + command + "(" + args + ")"); let engines = [args[0]]; switch (command) { case "resetAll": engines = null; // Fallthrough case "resetEngine": this.resetClient(engines); break; case "wipeAll": engines = null; // Fallthrough case "wipeEngine": this.wipeClient(engines); break; case "logout": this.logout(); return false; default: this._log.debug("Received an unknown command: " + command); break; } } return true; })(), /** * Prepare to send a command to each remote client. Calling this doesn't * actually sync the command data to the server. If the client already has * the command/args pair, it won't get a duplicate action. * * @param command * Command to invoke on remote clients * @param args * Array of arguments to give to the command */ prepCommand: function WeaveSvc_prepCommand(command, args) { let commandData = this._commands[command]; // Don't send commands that we don't know about if (commandData == null) { this._log.error("Unknown command to send: " + command); return; } // Don't send a command with the wrong number of arguments else if (args == null || args.length != commandData.args) { this._log.error("Expected " + commandData.args + " args for '" + command + "', but got " + args); return; } // Send the command to all remote clients this._log.debug("Sending clients: " + [command, args, commandData.desc]); Clients.sendCommand(command, args); }, }; // Load Weave on the first time this file is loaded Weave.Service.onStartup();