Skip to content
Navigation Menu
{{ message }}
forked from EFForg/https-everywhere
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathrules.js
More file actions
493 lines (441 loc) · 14.4 KB
/
Copy pathrules.js
File metadata and controls
493 lines (441 loc) · 14.4 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
"use strict";
// Stubs so this runs under nodejs. They get overwritten later by util.js
var VERB=1;
var DBUG=2;
var INFO=3;
var NOTE=4;
var WARN=5;
function log(){}
// To reduce memory usage for the numerous rules/cookies with trivial rules
const trivial_rule_to = "https:";
const trivial_rule_from_c = new RegExp("^http:");
const trivial_cookie_name_c = new RegExp(".*");
const trivial_cookie_host_c = new RegExp(".*");
/**
* A single rule
* @param from
* @param to
* @constructor
*/
function Rule(from, to) {
if (from === "^http:" && to === "https:") {
// This is a trivial rule, rewriting http->https with no complex RegExp.
this.to = trivial_rule_to;
this.from_c = trivial_rule_from_c;
} else {
// This is a non-trivial rule.
this.to = to;
this.from_c = new RegExp(from);
}
}
/**
* Regex-Compile a pattern
* @param pattern The pattern to compile
* @constructor
*/
function Exclusion(pattern) {
this.pattern_c = new RegExp(pattern);
}
/**
* Generates a CookieRule
* @param host The host regex to compile
* @param cookiename The cookie name Regex to compile
* @constructor
*/
function CookieRule(host, cookiename) {
if (host === ".*" || host === ".+" || host === ".") {
// Some cookie rules trivially match any host.
this.host_c = trivial_cookie_host_c;
} else {
this.host_c = new RegExp(host);
}
if (cookiename === ".*" || cookiename === ".+" || cookiename === ".") {
// About 50% of cookie rules trivially match any name.
this.name_c = trivial_cookie_name_c;
} else {
this.name_c = new RegExp(cookiename);
}
}
/**
*A collection of rules
* @param set_name The name of this set
* @param default_state activity state
* @param note Note will be displayed in popup
* @constructor
*/
function RuleSet(set_name, default_state, note) {
this.name = set_name;
this.rules = [];
this.exclusions = null;
this.cookierules = null;
this.active = default_state;
this.default_state = default_state;
this.note = note;
}
RuleSet.prototype = {
/**
* Check if a URI can be rewritten and rewrite it
* @param urispec The uri to rewrite
* @returns {*} null or the rewritten uri
*/
apply: function(urispec) {
var returl = null;
// If we're covered by an exclusion, go home
if (this.exclusions !== null) {
for (var i = 0; i < this.exclusions.length; ++i) {
if (this.exclusions[i].pattern_c.test(urispec)) {
log(DBUG, "excluded uri " + urispec);
return null;
}
}
}
// Okay, now find the first rule that triggers
for(var i = 0; i < this.rules.length; ++i) {
returl = urispec.replace(this.rules[i].from_c,
this.rules[i].to);
if (returl != urispec) {
return returl;
}
}
return null;
},
/**
* Deep equivalence comparison
* @param ruleset The ruleset to compare with
* @returns true or false, depending on whether it's deeply equivalent
*/
isEquivalentTo: function(ruleset) {
if(this.name != ruleset.name ||
this.note != ruleset.note ||
this.state != ruleset.state ||
this.default_state != ruleset.default_state) {
return false;
}
try {
var this_exclusions_length = this.exclusions.length;
} catch(e) {
var this_exclusions_length = 0;
}
try {
var ruleset_exclusions_length = ruleset.exclusions.length;
} catch(e) {
var ruleset_exclusions_length = 0;
}
try {
var this_rules_length = this.rules.length;
} catch(e) {
var this_rules_length = 0;
}
try {
var ruleset_rules_length = ruleset.rules.length;
} catch(e) {
var ruleset_rules_length = 0;
}
if(this_exclusions_length != ruleset_exclusions_length ||
this_rules_length != ruleset_rules_length) {
return false;
}
if(this_exclusions_length > 0) {
for(let x = 0; x < this.exclusions.length; x++){
if(this.exclusions[x].pattern_c != ruleset.exclusions[x].pattern_c) {
return false;
}
}
}
if(this_rules_length > 0) {
for(let x = 0; x < this.rules.length; x++){
if(this.rules[x].to != ruleset.rules[x].to) {
return false;
}
}
}
return true;
}
};
/**
* Initialize Rule Sets
* @param ruleActiveStates default state for rules
* @constructor
*/
function RuleSets(ruleActiveStates) {
// Load rules into structure
this.targets = {};
// A cache for potentiallyApplicableRulesets
this.ruleCache = new Map();
// A cache for cookie hostnames.
this.cookieHostCache = new Map();
// A hash of rule name -> active status (true/false).
this.ruleActiveStates = ruleActiveStates;
}
RuleSets.prototype = {
/**
* Iterate through data XML and load rulesets
*/
addFromXml: function(ruleXml) {
var sets = ruleXml.getElementsByTagName("ruleset");
for (var i = 0; i < sets.length; ++i) {
try {
this.parseOneRuleset(sets[i]);
} catch (e) {
log(WARN, 'Error processing ruleset:' + e);
}
}
},
/**
* Load a user rule
* @param params
* @returns {boolean}
*/
addUserRule : function(params) {
log(INFO, 'adding new user rule for ' + JSON.stringify(params));
var new_rule_set = new RuleSet(params.host, true, "user rule");
var new_rule = new Rule(params.urlMatcher, params.redirectTo);
new_rule_set.rules.push(new_rule);
if (!(params.host in this.targets)) {
this.targets[params.host] = [];
}
this.ruleCache.delete(params.host);
// TODO: maybe promote this rule?
this.targets[params.host].push(new_rule_set);
if (new_rule_set.name in this.ruleActiveStates) {
new_rule_set.active = (this.ruleActiveStates[new_rule_set.name] == "true");
}
log(INFO, 'done adding rule');
return true;
},
/**
* Remove a user rule
* @param params
* @returns {boolean}
*/
removeUserRule: function(ruleset) {
log(INFO, 'removing user rule for ' + JSON.stringify(ruleset));
this.ruleCache.delete(ruleset.name);
for(let x = 0; x < this.targets[ruleset.name].length; x++) {
if(this.targets[ruleset.name][x].isEquivalentTo(ruleset)) {
this.targets[ruleset.name].splice(x, 1);
}
}
if (this.targets[ruleset.name].length == 0) {
delete this.targets[ruleset.name];
}
log(INFO, 'done removing rule');
return true;
},
/**
* Does the loading of a ruleset.
* @param ruletag The whole <ruleset> tag to parse
*/
parseOneRuleset: function(ruletag) {
var default_state = true;
var note = "";
var default_off = ruletag.getAttribute("default_off");
if (default_off) {
default_state = false;
note += default_off + "\n";
}
// If a ruleset declares a platform, and we don't match it, treat it as
// off-by-default. In practice, this excludes "mixedcontent" & "cacert" rules.
var platform = ruletag.getAttribute("platform");
if (platform) {
default_state = false;
if (platform == "mixedcontent" && enableMixedRulesets) {
default_state = true;
}
note += "Platform(s): " + platform + "\n";
}
var rule_set = new RuleSet(ruletag.getAttribute("name"),
default_state,
note.trim());
// Read user prefs
if (rule_set.name in this.ruleActiveStates) {
rule_set.active = (this.ruleActiveStates[rule_set.name] == "true");
}
var rules = ruletag.getElementsByTagName("rule");
for(var j = 0; j < rules.length; j++) {
rule_set.rules.push(new Rule(rules[j].getAttribute("from"),
rules[j].getAttribute("to")));
}
var exclusions = ruletag.getElementsByTagName("exclusion");
if (exclusions.length > 0) {
rule_set.exclusions = [];
for (var j = 0; j < exclusions.length; j++) {
rule_set.exclusions.push(
new Exclusion(exclusions[j].getAttribute("pattern")));
}
}
var cookierules = ruletag.getElementsByTagName("securecookie");
if (cookierules.length > 0) {
rule_set.cookierules = [];
for(var j = 0; j < cookierules.length; j++) {
rule_set.cookierules.push(
new CookieRule(cookierules[j].getAttribute("host"),
cookierules[j].getAttribute("name")));
}
}
var targets = ruletag.getElementsByTagName("target");
for(var j = 0; j < targets.length; j++) {
var host = targets[j].getAttribute("host");
if (!(host in this.targets)) {
this.targets[host] = [];
}
this.targets[host].push(rule_set);
}
},
/**
* Return a list of rulesets that apply to this host
* @param host The host to check
* @returns {*} (empty) list
*/
potentiallyApplicableRulesets: function(host) {
// Have we cached this result? If so, return it!
var cached_item = this.ruleCache.get(host);
if (cached_item !== undefined) {
log(DBUG, "Ruleset cache hit for " + host + " items:" + cached_item.length);
return cached_item;
}
log(DBUG, "Ruleset cache miss for " + host);
var tmp;
var results = [];
if (this.targets[host]) {
// Copy the host targets so we don't modify them.
results = results.concat(this.targets[host]);
}
// Ensure host is well-formed (RFC 1035)
if (host.indexOf("..") != -1 || host.length > 255) {
log(WARN,"Malformed host passed to potentiallyApplicableRulesets: " + host);
return null;
}
// Replace each portion of the domain with a * in turn
var segmented = host.split(".");
for (var i = 0; i < segmented.length; ++i) {
tmp = segmented[i];
segmented[i] = "*";
results = results.concat(this.targets[segmented.join(".")]);
segmented[i] = tmp;
}
// 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 (var i = 2; i <= segmented.length - 2; ++i) {
var t = "*." + segmented.slice(i,segmented.length).join(".");
results = results.concat(this.targets[t]);
}
// Clean the results list, which may contain duplicates or undefined entries
var resultSet = new Set(results);
resultSet.delete(undefined);
log(DBUG,"Applicable rules for " + host + ":");
if (resultSet.size == 0) {
log(DBUG, " None");
} else {
for (let target of resultSet.values()) {
log(DBUG, " " + target.name);
}
}
// Insert results into the ruleset cache
this.ruleCache.set(host, resultSet);
// Cap the size of the cache. (Limit chosen somewhat arbitrarily)
if (this.ruleCache.size > 1000) {
// Map.prototype.keys() returns keys in insertion order, so this is a FIFO.
this.ruleCache.delete(this.ruleCache.keys().next().value);
}
return resultSet;
},
/**
* Check to see if the Cookie object c meets any of our cookierule criteria for being marked as secure.
* @param cookie The cookie to test
* @returns {*} ruleset or null
*/
shouldSecureCookie: function(cookie) {
var hostname = cookie.domain;
// cookie domain scopes can start with .
while (hostname.charAt(0) == ".") {
hostname = hostname.slice(1);
}
if (!this.safeToSecureCookie(hostname)) {
return null;
}
var potentiallyApplicable = this.potentiallyApplicableRulesets(hostname);
for (let ruleset of potentiallyApplicable) {
if (ruleset.cookierules !== null && ruleset.active) {
for (var j = 0; j < ruleset.cookierules.length; j++) {
var cr = ruleset.cookierules[j];
if (cr.host_c.test(cookie.domain) && cr.name_c.test(cookie.name)) {
return ruleset;
}
}
}
}
return null;
},
/**
* Check if it is secure to secure the cookie (=patch the secure flag in).
* @param domain The domain of the cookie
* @returns {*} true or false
*/
safeToSecureCookie: function(domain) {
// Check if the domain might be being served over HTTP. If so, it isn't
// safe to secure a cookie! We can't always know this for sure because
// observing cookie-changed doesn't give us enough context to know the
// full origin URI.
// First, if there are any redirect loops on this domain, don't secure
// cookies. XXX This is not a very satisfactory heuristic. Sometimes we
// would want to secure the cookie anyway, because the URLs that loop are
// not authenticated or not important. Also by the time the loop has been
// observed and the domain blacklisted, a cookie might already have been
// flagged as secure.
if (domainBlacklist.has(domain)) {
log(INFO, "cookies for " + domain + "blacklisted");
return false;
}
var cached_item = this.cookieHostCache.get(domain);
if (cached_item !== undefined) {
log(DBUG, "Cookie host cache hit for " + domain);
return cached_item;
}
log(DBUG, "Cookie host cache miss for " + domain);
// If we passed that test, make up a random URL on the domain, and see if
// we would HTTPSify that.
var nonce_path = "/" + Math.random().toString();
var test_uri = "http://" + domain + nonce_path + nonce_path;
// Cap the size of the cookie cache (limit chosen somewhat arbitrarily)
if (this.cookieHostCache.size > 250) {
// Map.prototype.keys() returns keys in insertion order, so this is a FIFO.
this.cookieHostCache.delete(this.cookieHostCache.keys().next().value);
}
log(INFO, "Testing securecookie applicability with " + test_uri);
var potentiallyApplicable = this.potentiallyApplicableRulesets(domain);
for (let ruleset of potentiallyApplicable) {
if (!ruleset.active) {
continue;
}
if (ruleset.apply(test_uri)) {
log(INFO, "Cookie domain could be secured.");
this.cookieHostCache.set(domain, true);
return true;
}
}
log(INFO, "Cookie domain could NOT be secured.");
this.cookieHostCache.set(domain, false);
return false;
},
/**
* Rewrite an URI
* @param urispec The uri to rewrite
* @param host The host of this uri
* @returns {*} the new uri or null
*/
rewriteURI: function(urispec, host) {
var newuri = null;
var potentiallyApplicable = this.potentiallyApplicableRulesets(host);
for (let ruleset of potentiallyApplicable) {
if (ruleset.active && (newuri = ruleset.apply(urispec))) {
return newuri;
}
}
return null;
}
};
// Export for HTTPS Rewriter if applicable.
if (typeof exports != 'undefined') {
exports.RuleSets = RuleSets;
}
You can’t perform that action at this time.