forked from EFForg/https-everywhere
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathHTTPSRules.js
More file actions
602 lines (537 loc) · 19.9 KB
/
HTTPSRules.js
File metadata and controls
602 lines (537 loc) · 19.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
function Rule(from, to) {
//this.from = from;
this.to = to;
this.from_c = new RegExp(from);
}
function Exclusion(pattern) {
//this.pattern = pattern;
this.pattern_c = new RegExp(pattern);
}
function CookieRule(host, cookiename) {
this.host = host
this.host_c = new RegExp(host);
this.name = cookiename;
this.name_c = new RegExp(cookiename);
}
ruleset_counter = 0;
function RuleSet(name, match_rule, default_off) {
this.id="httpseR" + ruleset_counter;
ruleset_counter += 1;
this.on_by_default = true;
this.name = name;
//this.ruleset_match = match_rule;
this.notes = "";
if (match_rule) this.ruleset_match_c = new RegExp(match_rule)
else this.ruleset_match_c = null;
if (default_off) {
// Perhaps problematically, this currently ignores the actual content of
// the default_off XML attribute. Ideally we'd like this attribute to be
// "valueless"
this.notes = default_off;
this.on_by_default = false;
}
this.rules = [];
this.exclusions = [];
this.cookierules = [];
this.prefs = HTTPSEverywhere.instance.prefs;
try {
// if this pref exists, use it
this.active = this.prefs.getBoolPref(name);
} catch (e) {
// if not, create it
this.log(DBUG, "Creating new pref " + name);
this.active = this.on_by_default;
this.prefs.setBoolPref(name, this.on_by_default);
}
}
var dom_parser = Cc["@mozilla.org/xmlextras/domparser;1"].createInstance(Ci.nsIDOMParser);
RuleSet.prototype = {
_apply: function(urispec) {
// return null if it does not apply
// and the new url if it does apply
var i;
var returl = null;
// If a rulset has a match_rule and it fails, go no further
if (this.ruleset_match_c && !this.ruleset_match_c.test(urispec)) {
this.log(VERB, "ruleset_match_c excluded " + urispec);
return null;
}
// Even so, if we're covered by an exclusion, go home
for (i = 0; i < this.exclusions.length; ++i) {
if (this.exclusions[i].pattern_c.test(urispec)) {
this.log(DBUG,"excluded uri " + urispec);
return null;
}
}
// Okay, now find the first rule that triggers
for (i = 0; i < this.rules.length; ++i) {
// This is just for displaying inactive rules
returl = urispec.replace(this.rules[i].from_c, this.rules[i].to);
if (returl != urispec) return returl;
}
return null;
},
log: function(level, msg) {
https_everywhereLog(level, msg);
},
wouldMatch: function(hypothetical_uri, alist) {
// return true if this ruleset would match the uri, assuming it were http
// used for judging moot / inactive rulesets
// if the ruleset is already somewhere in this applicable list, we don't
// care about hypothetical wouldMatch questios
if (this.name in alist.all) return false;
this.log(DBUG,"Would " +this.name + " match " +hypothetical_uri.spec +
"? serial " + alist.serial);
var uri = hypothetical_uri.clone();
if (uri.scheme == "https") uri.scheme = "http";
var urispec = uri.spec;
if (this.ruleset_match_c && !this.ruleset_match_c.test(urispec))
return false;
for (i = 0; i < this.exclusions.length; ++i)
if (this.exclusions[i].pattern_c.test(urispec)) return false;
for (i = 0; i < this.rules.length; ++i)
if (this.rules[i].from_c.test(urispec)) return true;
return false;
},
transformURI: function(uri) {
// If no rule applies, return null; if a rule would have applied but was
// inactive, return 0; otherwise, return a fresh uri instance
// for the target
var newurl = this._apply(uri.spec);
if (null == newurl)
return null;
if (0 == newurl)
return 0;
var newuri = Components.classes["@mozilla.org/network/standard-url;1"].
createInstance(CI.nsIStandardURL);
newuri.init(CI.nsIStandardURL.URLTYPE_STANDARD, 80,
newurl, uri.originCharset, null);
newuri = newuri.QueryInterface(CI.nsIURI);
return newuri;
},
enable: function() {
// Enable us.
this.prefs.setBoolPref(this.name, true);
this.active = true;
},
disable: function() {
// Disable us.
this.prefs.setBoolPref(this.name, false);
this.active = false;
},
toggle: function() {
this.active = !this.active;
this.prefs.setBoolPref(this.name, this.active);
}
};
const RuleWriter = {
getCustomRuleDir: function() {
var loc = "ProfD"; // profile directory
var file =
CC["@mozilla.org/file/directory_service;1"]
.getService(CI.nsIProperties)
.get(loc, CI.nsILocalFile)
.clone();
file.append("HTTPSEverywhereUserRules");
// Check for existence, if not, create.
if (!file.exists()) {
file.create(CI.nsIFile.DIRECTORY_TYPE, 0700);
}
if (!file.isDirectory()) {
// XXX: Arg, death!
}
return file;
},
chromeToPath: function (aPath) {
if (!aPath || !(/^chrome:/.test(aPath)))
return; //not a chrome url
var ios =
CC['@mozilla.org/network/io-service;1']
.getService(CI.nsIIOService);
var uri = ios.newURI(aPath, "UTF-8", null);
var cr =
CC['@mozilla.org/chrome/chrome-registry;1']
.getService(CI.nsIChromeRegistry);
var rv = cr.convertChromeURL(uri).spec;
if (/^file:/.test(rv))
rv = this.urlToPath(rv);
else
rv = this.urlToPath("file://"+rv);
return rv;
},
urlToPath: function (aPath) {
if (!aPath || !/^file:/.test(aPath))
return ;
var ph =
CC["@mozilla.org/network/protocol;1?name=file"]
.createInstance(CI.nsIFileProtocolHandler);
var rv = ph.getFileFromURLSpec(aPath).path;
return rv;
},
getRuleDir: function() {
loc = "chrome://https-everywhere/content/rules/";
var file =
CC["@mozilla.org/file/local;1"]
.createInstance(CI.nsILocalFile);
file.initWithPath(this.chromeToPath(loc));
if (!file.isDirectory()) {
// XXX: Arg, death!
this.log(WARN,"Catastrophic failure: extension directory is not a directory");
}
return file;
},
read: function(file, rule_store) {
if (!file.exists())
return null;
if ((rule_store.targets == null) && (rule_store.targets != {}))
this.log(WARN, "TARGETS IS NULL");
var data = "";
var fstream = CC["@mozilla.org/network/file-input-stream;1"]
.createInstance(CI.nsIFileInputStream);
var sstream = CC["@mozilla.org/scriptableinputstream;1"]
.createInstance(CI.nsIScriptableInputStream);
fstream.init(file, -1, 0, 0);
sstream.init(fstream);
var str = sstream.read(4096);
while (str.length > 0) {
data += str;
str = sstream.read(4096);
}
sstream.close();
fstream.close();
// XXX: With DOMParser, we probably do not need to throw away the XML
// declaration anymore nowadays.
data = data.replace(/<\?xml[^>]*\?>/, "");
try {
var xmlrulesets = dom_parser.parseFromString(data, "text/xml");
} catch(e) { // file has been corrupted; XXX: handle error differently
this.log(WARN,"Error in XML file: " + file.path + "\n" + e);
return null;
}
this.parseXmlRulesets(xmlrulesets, rule_store, file);
},
parseXmlRulesets: function(xmldom, rule_store, file) {
// XML input files can either be a <ruleset> in a file, or a
// <rulesetlibrary> with many <rulesets> inside it (the latter form exists
// because ZIP does a much better job of compressing it).
if (xmldom.documentElement.nodeName == "ruleset") {
// This is a single ruleset.
this.parseOneRuleset(xmldom.documentElement, rule_store, file);
} else {
// The root of the XML tree is assumed to look like a <rulesetlibrary>
var rulesets = xmldom.documentElement.getElementsByTagName("ruleset");
if (rulesets.length == 0 && (file.path.search("00README") == -1))
this.log(WARN, "Probable <rulesetlibrary> with no <rulesets> in "
+ file.path + "\n" + xmldom);
for (var j = 0; j < rulesets.length; j++)
this.parseOneRuleset(rulesets[j], rule_store, file);
}
},
parseOneRuleset: function(xmlruleset, rule_store, file) {
// Extract an xmlruleset into the rulestore
if (!xmlruleset.getAttribute("name")) {
this.log(WARN, "This blob: '" + xmlruleset + "' is not a ruleset\n");
return null;
}
this.log(DBUG, "Parsing " + xmlruleset.getAttribute("name") + " from " + file.path);
var match_rl = xmlruleset.getAttribute("match_rule");
var dflt_off = xmlruleset.getAttribute("default_off");
var rs = new RuleSet(xmlruleset.getAttribute("name"), match_rl, dflt_off);
var targets = xmlruleset.getElementsByTagName("target");
if (targets.length == 0) {
var msg = "Error: As of v0.3.0, XML rulesets require a target domain entry,";
msg = msg + "\nbut " + file.path + " is missing one.";
this.log(WARN, msg);
return null;
}
// see if this ruleset has the same name as an existing ruleset;
// if so, this ruleset is ignored; DON'T add or return it.
if (rs.name in rule_store.rulesetsByName) {
this.log(WARN, "Error: found duplicate rule name " + rs.name + " in file " + file.path);
return null;
}
// add this ruleset into HTTPSRules.targets with all of the applicable
// target host indexes
for (var i = 0; i < targets.length; i++) {
var host = targets[i].getAttribute("host");
if (!host) {
this.log(WARN, "<target> missing host in " + file.path);
return null;
}
if (! rule_store.targets[host])
rule_store.targets[host] = [];
rule_store.targets[host].push(rs);
}
var exclusions = xmlruleset.getElementsByTagName("exclusion");
for (var i = 0; i < exclusions.length; i++) {
var exclusion = new Exclusion(exclusions[i].getAttribute("pattern"));
rs.exclusions.push(exclusion);
}
var rules = xmlruleset.getElementsByTagName("rule");
for (var i = 0; i < rules.length; i++) {
var rule = new Rule(rules[i].getAttribute("from"),
rules[i].getAttribute("to"));
rs.rules.push(rule);
}
var securecookies = xmlruleset.getElementsByTagName("securecookie");
for (var i = 0; i < securecookies.length; i++) {
var c_rule = new CookieRule(securecookies[i].getAttribute("host"),
securecookies[i].getAttribute("name"));
rs.cookierules.push(c_rule);
this.log(DBUG,"Cookie rule "+ c_rule.host+ " " +c_rule.name);
}
rule_store.rulesets.push(rs);
rule_store.rulesetsByID[rs.id] = rs;
rule_store.rulesetsByName[rs.name] = rs;
},
enumerate: function(dir) {
// file is the given directory (nsIFile)
var entries = dir.directoryEntries;
var ret = [];
while(entries.hasMoreElements()) {
var entry = entries.getNext();
entry.QueryInterface(Components.interfaces.nsIFile);
ret.push(entry);
}
return ret;
},
};
const HTTPSRules = {
init: function() {
try {
this.rulesets = [];
this.targets = {}; // dict mapping target host patterns -> lists of
// applicable rules
this.rulesetsByID = {};
this.rulesetsByName = {};
var rulefiles = RuleWriter.enumerate(RuleWriter.getCustomRuleDir());
this.scanRulefiles(rulefiles);
rulefiles = RuleWriter.enumerate(RuleWriter.getRuleDir());
this.scanRulefiles(rulefiles);
this.checkForBuggyDefaults();
var t,i;
for (t in this.targets) {
for (i = 0 ; i < this.targets[t].length ; i++) {
this.log(INFO, t + " -> " + this.targets[t][i].name);
}
}
// for any rulesets with <target host="*">
// every URI needs to be checked against these rulesets
// (though currently we don't ship any)
this.global_rulesets = this.targets["*"] ? this.targets["*"] : [];
this.rulesets.sort(
function(r1,r2) {
if (r1.name.toLowerCase() < r2.name.toLowerCase()) return -1;
else return 1;
}
);
} catch(e) {
this.log(WARN,"Rules Failed: "+e);
}
this.log(DBUG,"Rules loaded");
return;
},
scanRulefiles: function(rulefiles) {
var i = 0;
var r = null;
for(i = 0; i < rulefiles.length; ++i) {
try {
this.log(DBUG,"Loading ruleset file: "+rulefiles[i].path);
RuleWriter.read(rulefiles[i], this);
} catch(e) {
this.log(WARN, "Error in ruleset file: " + e);
if (e.lineNumber)
this.log(WARN, "(line number: " + e.lineNumber + ")");
}
}
},
checkForBuggyDefaults: function() {
// The 2.2 release had a ruleset parsing bug which caused the match_rule
// attribute to be misinterpreted as the default_off attribute. That was
// a big problem iff 2.2 was the first version of HTTPS Everywhere
// installed in a particular browser profile. If enough buggy rulesets
// are on, conclude that this is such a profile, and reset to the correct
// defaults. More here:
//
// https://mail1.eff.org/pipermail/https-everywhere/2012-August/001511.html
//
this.log(DBUG, "Checking for buggy configurations from version 2.2");
// All of these were default_off in 2.2, and none of them had a
// match_rule:
var shouldBeOff = ["SchuelerVZ","Tcodevelopment.com","33Bits","BerliOS",
"BuisnessInsider (broken)","Daft.ie","DVDFab",
"YouMail (buggy)","StudiVZ (disabled)","Woot (broken)"];
var nonBuggy = 0;
for (var ruleindex in shouldBeOff) {
// Some of these shouldBeOff rules may be removed in the future, so
// tolerate their absence
var rulename = shouldBeOff[ruleindex];
if (rulename in this.rulesetsByName) {
if (!this.rulesetsByName[rulename].active)
nonBuggy += 1;
} else {
this.log("INFO", "Couldn't check state of ruleset " + rulename);
}
}
// Heuristic: a user starting with a buggy config might have disabled up
// to 2 of the 10 broken rulesets manually, but we will still conclude
// that their config is broken and reset it
if (nonBuggy <= 2) {
this.log(WARN, "Detected a buggy-looking configuration, probably from HTTPS Everywhere 2.2. Resetting ruleset states to defaults");
this.resetRulesetsToDefaults();
}
},
resetRulesetsToDefaults: function() {
// Callable from within the prefs UI and also for cleaning up buggy
// configurations...
for (var i in this.rulesets) {
if (this.rulesets[i].on_by_default) this.rulesets[i].enable();
else this.rulesets[i].disable();
}
},
rewrittenURI: function(alist, input_uri) {
// This function oversees the task of working out if a uri should be
// rewritten, what it should be rewritten to, and recordkeeping of which
// applicable rulesets are and aren't active. Previously this returned
// the new uri if there was a rewrite. Now it returns a JS object with a
// newuri attribute and an applied_ruleset attribute (or null if there's
// no rewrite).
var i = 0, userpass_present = false;
var uri = input_uri;
var blob = {};
blob.newuri = null;
if (!alist) this.log(DBUG, "No applicable list rewriting " + uri.spec);
// Rulesets shouldn't try to parse usernames and passwords. If we find
// those, apply the ruleset without them and then add them back.
// When .userPass is absent, sometimes it is false and sometimes trying
// to read it raises an exception (probably depending on the URI type).
try {
if (input_uri.userPass) {
uri = input_uri.clone();
userpass_present = true;
uri.userPass = null;
}
} catch(e) {}
// example.com. is equivalent to example.com
// example.com.. is invalid, but firefox would load it anyway
try {
if (uri.host)
try {
var h = uri.host;
if (h.charAt(h.length - 1) == ".") {
while (h.charAt(h.length - 1) == ".")
h = h.slice(0,-1);
uri = uri.clone();
uri.host = h;
}
} catch(e) {
this.log(WARN, "Failed to normalise domain: ");
try {this.log(WARN, input_uri.host);}
catch(e2) {this.log(WARN, "bang" + e + " & " + e2 + " & "+ input_uri);}
}
} catch(e3) {
this.log(WARN, "uri.host is explosive!");
try { this.log(WARN, "(" + uri.spec + ")"); }
catch(e4) { this.log(WARN, "(and unprintable)"); }
}
// Get the list of rulesets that target this host
try {
var rs = this.potentiallyApplicableRulesets(uri.host);
} catch(e) {
this.log(WARN, 'Could not check applicable rules for '+uri.spec);
return null;
}
// ponder each potentially applicable ruleset, working out if it applies
// and recording it as active/inactive/moot/breaking in the applicable list
for (i = 0; i < rs.length; ++i) {
if (!rs[i].active) {
if (alist && rs[i].wouldMatch(uri, alist))
alist.inactive_rule(rs[i]);
continue;
}
blob.newuri = rs[i].transformURI(uri);
if (blob.newuri) {
// we rewrote the uri
if (alist)
if (uri.spec in https_everywhere_blacklist)
alist.breaking_rule(rs[i])
else
alist.active_rule(rs[i]);
if (userpass_present) blob.newuri.userPass = input_uri.userPass;
blob.applied_ruleset = rs[i];
return blob;
}
if (uri.scheme == "https" && alist) {
// we didn't rewrite but the rule applies to this domain and the
// requests are going over https
if (rs[i].wouldMatch(uri, alist)) alist.moot_rule(rs[i]);
continue;
}
}
return null;
},
potentiallyApplicableRulesets: function(host) {
// Return a list of rulesets that declare targets matching this host
var i, tmp, t;
var results = this.global_rulesets;
try{
if (this.targets[host])
results = results.concat(this.targets[host]);
}
catch(e){
this.log(DBUG,"Couldn't check for ApplicableRulesets: " + e);
return [];
}
// replace each portion of the domain with a * in turn
var segmented = host.split(".");
for (i = 0; i < segmented.length; ++i) {
tmp = segmented[i];
segmented[i] = "*";
t = segmented.join(".");
segmented[i] = tmp;
if (this.targets[t])
results = results.concat(this.targets[t]);
}
// now eat away from the left, with *, so that for x.y.z.google.com we
// check *.z.google.com and *.google.com (we did *.y.z.google.com above)
for (i = 1; i < segmented.length - 2; ++i) {
t = "*." + segmented.slice(i,segmented.length).join(".");
if (this.targets[t])
results = results.concat(this.targets[t]);
}
this.log(DBUG,"Potentially applicable rules for " + host + ":");
for (i = 0; i < results.length; ++i)
this.log(DBUG, " " + results[i].name);
return results;
},
shouldSecureCookie: function(applicable_list, c) {
// Check to see if the Cookie object c meets any of our cookierule citeria
// for being marked as secure
//this.log(DBUG, "Testing cookie:");
//this.log(DBUG, " name: " + c.name);
//this.log(DBUG, " host: " + c.host);
//this.log(DBUG, " domain: " + c.domain);
//this.log(DBUG, " rawhost: " + c.rawHost);
var i,j;
var rs = this.potentiallyApplicableRulesets(c.host);
for (i = 0; i < rs.length; ++i) {
var ruleset = rs[i];
if (ruleset.active) {
for (j = 0; j < ruleset.cookierules.length; j++) {
var cr = ruleset.cookierules[j];
if (cr.host_c.test(c.host) && cr.name_c.test(c.name)) {
if (applicable_list) applicable_list.active_rule(ruleset);
this.log(INFO,"Active cookie rule " + ruleset.name);
return true;
}
}
if (ruleset.cookierules.length > 0)
if (applicable_list) applicable_list.moot_rule(ruleset);
} else if (ruleset.cookierules.length > 0) {
if (applicable_list) applicable_list.inactive_rule(ruleset);
this.log(INFO,"Inactive cookie rule " + ruleset.name);
}
}
return false;
}
};