gecko/services/sync/modules/engines/passwords.js

/* ***** 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) 2008
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *  Justin Dolske <dolske@mozilla.com>
 *
 * 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 = ['PasswordEngine'];

const Cu = Components.utils;

Cu.import("resource://weave/util.js");
Cu.import("resource://weave/async.js");
Cu.import("resource://weave/engines.js");
Cu.import("resource://weave/syncCores.js");
Cu.import("resource://weave/stores.js");
Cu.import("resource://weave/trackers.js");

Function.prototype.async = Async.sugar;

function PasswordEngine() {
  this._init();
}
PasswordEngine.prototype = {
  __proto__: new SyncEngine(),

  get name() { return "passwords"; },
  get displayName() { return "Saved Passwords"; },
  get logName() { return "PasswordEngine"; },
  get serverPrefix() { return "user-data/passwords/"; },

  __store: null,
  get _store() {
    if (!this.__store)
      this.__store = new PasswordStore();
    return this.__store;
  },

  __core: null,
  get _core() {
    if (!this.__core)
      this.__core = new PasswordSyncCore(this._store);
    return this.__core;
  }
};

function PasswordSyncCore(store) {
  this._store = store;
  this._init();
}
PasswordSyncCore.prototype = {
  _logName: "PasswordSync",
  _store: null,

  _commandLike: function PSC_commandLike(a, b) {
    // Not used.
    return false;
  }
};
PasswordSyncCore.prototype.__proto__ = new SyncCore();

function PasswordStore() {
  this._init();
}
PasswordStore.prototype = {
  _logName: "PasswordStore",
  _lookup: null,

  __loginManager: null,
  get _loginManager() {
    if (!this.__loginManager)
      this.__loginManager = Utils.getLoginManager();
    return this.__loginManager;
  },

  __nsLoginInfo: null,
  get _nsLoginInfo() {
    if (!this.__nsLoginInfo)
      this.__nsLoginInfo = Utils.makeNewLoginInfo();
    return this.__nsLoginInfo;
  },

  /*
   * _hashLoginInfo
   *
   * nsILoginInfo objects don't have a unique GUID, so we need to generate one
   * on the fly. This is done by taking a hash of every field in the object.
   * Note that the resulting GUID could potentiually reveal passwords via
   * dictionary attacks or brute force. But GUIDs shouldn't be obtainable by
   * anyone, so this should generally be safe.
   */
   _hashLoginInfo: function PasswordStore__hashLoginInfo(aLogin) {
    var loginKey = aLogin.hostname      + ":" +
                   aLogin.formSubmitURL + ":" +
                   aLogin.httpRealm     + ":" +
                   aLogin.username      + ":" +
                   aLogin.password      + ":" +
                   aLogin.usernameField + ":" +
                   aLogin.passwordField;

    return Utils.sha1(loginKey);
  },

  _createCommand: function PasswordStore__createCommand(command) {
    this._log.info("PasswordStore got createCommand: " + command );

    var login = new this._nsLoginInfo(command.data.hostname,
                                      command.data.formSubmitURL,
                                      command.data.httpRealm,
                                      command.data.username,
                                      command.data.password,
                                      command.data.usernameField,
                                      command.data.passwordField);

    this._loginManager.addLogin(login);
  },

  _removeCommand: function PasswordStore__removeCommand(command) {
    this._log.info("PasswordStore got removeCommand: " + command );

    if (command.GUID in this._lookup) {
      var data  = this._lookup[command.GUID];
      var login = new this._nsLoginInfo(data.hostname,
                                        data.formSubmitURL,
                                        data.httpRealm,
                                        data.username,
                                        data.password,
                                        data.usernameField,
                                        data.passwordField);
      this._loginManager.removeLogin(login);
    } else {
      this._log.warn("Invalid GUID for remove, ignoring request!");
    }
  },

  _editCommand: function PasswordStore__editCommand(command) {
    this._log.info("PasswordStore got editCommand: " + command );
    throw "Password syncs are expected to only be create/remove!";
  },

  wrap: function PasswordStore_wrap() {
    /* Return contents of this store, as JSON. */
    var items = {};
    var logins = this._loginManager.getAllLogins({});

    for (var i = 0; i < logins.length; i++) {
      var login = logins[i];

      var key = this._hashLoginInfo(login);

      items[key] = { hostname      : login.hostname,
                     formSubmitURL : login.formSubmitURL,
                     httpRealm     : login.httpRealm,
                     username      : login.username,
                     password      : login.password,
                     usernameField : login.usernameField,
                     passwordField : login.passwordField };
    }

    this._lookup = items;
    return items;
  },

  wipe: function PasswordStore_wipe() {
    this._loginManager.removeAllLogins();
  },

  _resetGUIDs: function PasswordStore__resetGUIDs() {
    let self = yield;
    // Not needed.
  }
};
PasswordStore.prototype.__proto__ = new Store();

function PasswordTracker() {
  this._init();
}
PasswordTracker.prototype = {
  _logName: "PasswordTracker",

  __loginManager : null,
  get _loginManager() {
    if (!this.__loginManager)
      this.__loginManager = Cc["@mozilla.org/login-manager;1"].
                            getService(Ci.nsILoginManager);
    return this.__loginManager;
  },

  /* We use nsILoginManager's countLogins() method, as it is
   * the only method that doesn't require the user to enter
   * a master password, but still gives us an idea of how much
   * info has changed.
   *
   * FIXME: This does not track edits of passwords, so we
   * artificially add 30 to every score. We should move to
   * using the LoginManager shim at some point.
   *
   * Each addition/removal is worth 15 points.
   */
  _loginCount: 0,
  get score() {
    var count = this._loginManager.countLogins("", "", "");
    var score = (Math.abs(this._loginCount - count) * 15) + 30;

    if (score >= 100)
      return 100;
    else
      return score;
  },

  resetScore: function PasswordTracker_resetScore() {
    this._loginCount = this._loginManager.countLogins("", "", "");
  },

  _init: function PasswordTracker__init() {
    this._log = Log4Moz.Service.getLogger("Service."  + this._logName);
    this._loginCount = this._loginManager.countLogins("", "", "");
  }
};
PasswordTracker.prototype.__proto__ = new Tracker();