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
355 lines (324 loc) · 10.5 KB
/
HTTPSRules.js
File metadata and controls
355 lines (324 loc) · 10.5 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
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);
}
function RuleSet(name, match_rule, default_off) {
this.on_by_default = true;
this.name = name;
this.ruleset_match = match_rule;
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.on_by_default = false;
}
this.rules = [];
this.exclusions = [];
this.cookierules = [];
var prefs = HTTPSEverywhere.instance.get_prefs();
try {
// if this pref exists, use it
this.active = prefs.getBoolPref(name);
} catch (e) {
// if not, create it
this.log(DBUG, "Creating new pref " + name);
this.active = true;
prefs.setBoolPref(name, this.on_by_default);
}
}
RuleSet.prototype = {
_apply: function(urispec) {
var i;
var returl = null;
if (!this.active) {
return 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) {
returl = urispec.replace(this.rules[i].from_c,
this.rules[i].to);
if (returl != urispec) {
return returl;
}
}
if (this.ruleset_match_c) {
// This is not an error, because we do not insist the matchrule
// precisely describes to target space of URLs ot redirected
this.log(DBUG,"Ruleset "+this.name
+" had an applicable match-rule but no matching rules");
}
return null;
},
log: function(level, msg) {
https_everywhereLog(level, msg);
},
transformURI: function(uri) {
// If no rule applies, return null; otherwise, return a fresh uri instance
// for the target
var newurl = this._apply(uri.spec);
if (null == newurl)
return null;
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;
},
};
const RuleWriter = {
addonDir: false,
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;
},
getRuleDir: function() {
if (!this.addonDir)
try {
// Firefox < 4
this.addonDir = CC["@mozilla.org/extensions/manager;1"].
getService(CI.nsIExtensionManager).
getInstallLocation("https-everywhere@eff.org").
getItemFile("https-everywhere@eff.org", "");
} catch(e) {
// Firefox >= 4 (this should not be reached)
}
var file = this.addonDir.clone();
file.append("chrome");
file.append("content");
file.append("rules");
if (!file.isDirectory()) {
// XXX: Arg, death!
}
return file;
},
read: function(file, targets) {
if (!file.exists())
return null;
if ((targets == null) && (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();
try {
var xmlrules = XML(data);
} catch(e) { // file has been corrupted; XXX: handle error differently
this.log(WARN,"Error in XML file: " + file + "\n" + e);
return null;
}
if (xmlrules.@name == xmlrules.@nonexistantthing) {
this.log(DBUG, "FILE " + file.path + "is not a rulefile\n");
return null;
}
var match_rl = null;
var dflt_off = null;
if (xmlrules.@match_rule.length() > 0) match_rl = xmlrules.@match_rule;
if (xmlrules.@default_off.length() > 0) dflt_off = xmlrules.@default_off;
var ret = new RuleSet(xmlrules.@name, match_rl, dflt_off);
if (xmlrules.target.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;
}
// add this ruleset into HTTPSRules.targets with all of the applicable
// target host indexes
for (var i = 0; i < xmlrules.target.length(); i++) {
var host = xmlrules.target[i].@host;
if (!host) {
this.log(WARN, "<target> missing host in " + file);
continue;
}
if (! targets[host])
targets[host] = [];
targets[host].push(ret);
}
for (var i = 0; i < xmlrules.exclusion.length(); i++) {
var exclusion = new Exclusion(xmlrules.exclusion[i].@pattern);
ret.exclusions.push(exclusion);
}
for (var i = 0; i < xmlrules.rule.length(); i++) {
var rule = new Rule(xmlrules.rule[i].@from,
xmlrules.rule[i].@to);
ret.rules.push(rule);
}
for (var i = 0; i < xmlrules.securecookie.length(); i++) {
var c_rule = new CookieRule(xmlrules.securecookie[i].@host,
xmlrules.securecookie[i].@name);
ret.cookierules.push(c_rule);
this.log(DBUG,"Cookie rule "+ c_rule.host+ " " +c_rule.name);
}
return ret;
},
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
var rulefiles = RuleWriter.enumerate(RuleWriter.getCustomRuleDir());
this.scanRulefiles(rulefiles, this.targets);
rulefiles = RuleWriter.enumerate(RuleWriter.getRuleDir());
this.scanRulefiles(rulefiles, this.targets);
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, targets) {
var i = 0;
var r = null;
for(i = 0; i < rulefiles.length; ++i) {
try {
this.log(DBUG,"Loading ruleset file: "+rulefiles[i].path);
r = RuleWriter.read(rulefiles[i], targets);
if (r != null)
this.rulesets.push(r);
} catch(e) {
this.log(WARN, "Error in ruleset file: " + e);
if (e.lineNumber)
this.log(WARN, "(line number: " + e.lineNumber + ")");
}
}
},
rewrittenURI: function(uri) {
var i = 0;
var newuri = null
var rs = this.applicableRulesets(uri.host);
for(i = 0; i < rs.length; ++i) {
if ((newuri = rs[i].transformURI(uri)))
return newuri;
}
return null;
},
applicableRulesets: function(host) {
// Return a list of rulesets that apply to this host
var i, tmp, t;
var results = this.global_rulesets;
if (this.targets[host])
results = results.concat(this.targets[host]);
// 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,"Applicable rules for " + host + ":");
for (i = 0; i < results.length; ++i)
this.log(DBUG, " " + results[i].name);
return results;
},
shouldSecureCookie: function(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.applicableRulesets(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))
return true;
}
}
return false;
}
};