browser/components/safebrowsing/content/malware-warden.js

   1 # ***** BEGIN LICENSE BLOCK *****
   2 # Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3 #
   4 # The contents of this file are subject to the Mozilla Public License Version
   5 # 1.1 (the "License"); you may not use this file except in compliance with
   6 # the License. You may obtain a copy of the License at
   7 # http://www.mozilla.org/MPL/
   8 #
   9 # Software distributed under the License is distributed on an "AS IS" basis,
  10 # WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11 # for the specific language governing rights and limitations under the
  12 # License.
  13 #
  14 # The Original Code is Google Safe Browsing.
  15 #
  16 # The Initial Developer of the Original Code is Google Inc.
  17 # Portions created by the Initial Developer are Copyright (C) 2006
  18 # the Initial Developer. All Rights Reserved.
  19 #
  20 # Contributor(s):
  21 #   Dave Camp <dcamp@mozilla.com>
  22 #   Fritz Schneider <fritz@google.com> (original phishing-warden.js author)
  23 #
  24 # Alternatively, the contents of this file may be used under the terms of
  25 # either the GNU General Public License Version 2 or later (the "GPL"), or
  26 # the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27 # in which case the provisions of the GPL or the LGPL are applicable instead
  28 # of those above. If you wish to allow use of your version of this file only
  29 # under the terms of either the GPL or the LGPL, and not to allow others to
  30 # use your version of this file under the terms of the MPL, indicate your
  31 # decision by deleting the provisions above and replace them with the notice
  32 # and other provisions required by the GPL or the LGPL. If you do not delete
  33 # the provisions above, a recipient may use your version of this file under
  34 # the terms of any one of the MPL, the GPL or the LGPL.
  35 #
  36 # ***** END LICENSE BLOCK *****
  37
  38 // This warden manages updates to the malware list
  39
  40 const kMalwareWardenEnabledPref = "browser.safebrowsing.malware.enabled";
  41
  42 function PROT_MalwareWarden() {
  43   PROT_ListWarden.call(this);
  44
  45   this.debugZone = "malwarewarden";
  46
  47   // Use this to query preferences
  48   this.prefs_ = new G_Preferences();
  49
  50   // Global preference to enable the malware warden
  51   this.malwareWardenEnabled_ =
  52     this.prefs_.getPref(kMalwareWardenEnabledPref, null);
  53
  54   // Get notifications when the malware warden enabled pref changes
  55   var malwareWardenPrefObserver =
  56     BindToObject(this.onMalwareWardenEnabledPrefChanged, this);
  57   this.prefs_.addObserver(kMalwareWardenEnabledPref, malwareWardenPrefObserver);
  58
  59   // Add a test chunk to the database
  60   var testData = "mozilla.com/firefox/its-an-attack.html";
  61
  62   var testUpdate =
  63     "n:1000\ni:test-malware-simple\nad:1\n" +
  64     "a:1:32:" + testData.length + "\n" +
  65     testData;
  66
  67   testData = "mozilla.com/firefox/its-a-trap.html";
  68   testUpdate +=
  69     "n:1000\ni:test-phish-simple\nad:1\n" +
  70     "a:1:32:" + testData.length + "\n" +
  71     testData;
  72
  73   var dbService_ = Cc["@mozilla.org/url-classifier/dbservice;1"]
  74                    .getService(Ci.nsIUrlClassifierDBService);
  75
  76   var listener = {
  77     QueryInterface: function(iid)
  78     {
  79       if (iid.equals(Ci.nsISupports) ||
  80           iid.equals(Ci.nsIUrlClassifierUpdateObserver))
  81         return this;
  82       throw Cr.NS_ERROR_NO_INTERFACE;
  83     },
  84
  85     updateUrlRequested: function(url) { },
  86     streamFinished: function(status) { },
  87     updateError: function(errorCode) { },
  88     updateSuccess: function(requestedTimeout) { }
  89   };
  90
  91   try {
  92     dbService_.beginUpdate(listener,
  93                            "test-malware-simple,test-phish-simple", "");
  94     dbService_.beginStream("", "");
  95     dbService_.updateStream(testUpdate);
  96     dbService_.finishStream();
  97     dbService_.finishUpdate();
  98   } catch(ex) {
  99     // beginUpdate will throw harmlessly if there's an existing update
 100     // in progress, ignore failures.
 101   }
 102   G_Debug(this, "malwareWarden initialized");
 103 }
 104
 105 PROT_MalwareWarden.inherits(PROT_ListWarden);
 106
 107 /**
 108  * Cleanup on shutdown.
 109  */
 110 PROT_MalwareWarden.prototype.shutdown = function() {
 111   this.prefs_.removeAllObservers();
 112
 113   this.listManager_ = null;
 114 }
 115
 116 /**
 117  * When a preference changes, we might have to start or stop asking for
 118  * updates.
 119  */
 120 PROT_MalwareWarden.prototype.maybeToggleUpdateChecking = function() {
 121   var malwareWardenEnabled = this.prefs_.getPref(kMalwareWardenEnabledPref,
 122                                                  null);
 123
 124   G_Debug(this, "Maybe toggling update checking. " +
 125           "Warden enabled? " + malwareWardenEnabled);
 126
 127   // Do nothing unless thre pref is set
 128   if (malwareWardenEnabled === null)
 129     return;
 130
 131   // We update and save to disk all tables
 132   if (malwareWardenEnabled === true) {
 133     this.enableBlacklistTableUpdates();
 134   } else {
 135     // Anti-malware is off, disable table updates
 136     this.disableBlacklistTableUpdates();
 137   }
 138 }
 139
 140 /**
 141  * Deal with a user changing the pref that says whether we should
 142  * enable the malware warden.
 143  *
 144  * @param prefName Name of the pref holding the value indicating whether
 145  *                 we should enable the malware warden
 146  */
 147 PROT_MalwareWarden.prototype.onMalwareWardenEnabledPrefChanged = function(
 148                                                                     prefName) {
 149   // Just to be safe, ignore changes to sub prefs.
 150   if (prefName != kMalwareWardenEnabledPref)
 151     return;
 152
 153   this.malwareWardenEnabled_ =
 154     this.prefs_.getPref(prefName, this.malwareWardenEnabled_);
 155   this.maybeToggleUpdateChecking();
 156 }