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
|
/* -*- Mode: indent-tabs-mode: nil; js-indent-level: 2 -*- */
/* vim: set sts=2 sw=2 et tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
* You can obtain one at http://mozilla.org/MPL/2.0/. */
"use strict";
ChromeUtils.defineESModuleGetters(this, {
ExtensionDNR: "resource://gre/modules/ExtensionDNR.sys.mjs",
});
var { ExtensionError } = ExtensionUtils;
const PREF_DNR_FEEDBACK = "extensions.dnr.feedback";
XPCOMUtils.defineLazyPreferenceGetter(
this,
"dnrFeedbackEnabled",
PREF_DNR_FEEDBACK,
false
);
function ensureDNRFeedbackEnabled(apiName) {
if (!dnrFeedbackEnabled) {
throw new ExtensionError(
`${apiName} is only available when the "${PREF_DNR_FEEDBACK}" preference is set to true.`
);
}
}
this.declarativeNetRequest = class extends ExtensionAPI {
onManifestEntry(entryName) {
if (entryName === "declarative_net_request") {
ExtensionDNR.validateManifestEntry(this.extension);
}
}
onShutdown() {
ExtensionDNR.clearRuleManager(this.extension);
}
getAPI() {
const { extension } = this;
return {
declarativeNetRequest: {
updateDynamicRules({ removeRuleIds, addRules }) {
return ExtensionDNR.updateDynamicRules(extension, {
removeRuleIds,
addRules,
});
},
updateSessionRules({ removeRuleIds, addRules }) {
const ruleManager = ExtensionDNR.getRuleManager(extension);
let ruleValidator = new ExtensionDNR.RuleValidator(
ruleManager.getSessionRules(),
{ isSessionRuleset: true }
);
if (removeRuleIds) {
ruleValidator.removeRuleIds(removeRuleIds);
}
if (addRules) {
ruleValidator.addRules(addRules);
}
let failures = ruleValidator.getFailures();
if (failures.length) {
throw new ExtensionError(failures[0].message);
}
let validatedRules = ruleValidator.getValidatedRules();
let ruleQuotaCounter = new ExtensionDNR.RuleQuotaCounter();
ruleQuotaCounter.tryAddRules("_session", validatedRules);
ruleManager.setSessionRules(validatedRules);
},
async getEnabledRulesets() {
await ExtensionDNR.ensureInitialized(extension);
const ruleManager = ExtensionDNR.getRuleManager(extension);
return ruleManager.enabledStaticRulesetIds;
},
async getAvailableStaticRuleCount() {
await ExtensionDNR.ensureInitialized(extension);
const ruleManager = ExtensionDNR.getRuleManager(extension);
return ruleManager.availableStaticRuleCount;
},
updateEnabledRulesets({ disableRulesetIds, enableRulesetIds }) {
return ExtensionDNR.updateEnabledStaticRulesets(extension, {
disableRulesetIds,
enableRulesetIds,
});
},
async getDynamicRules() {
await ExtensionDNR.ensureInitialized(extension);
return ExtensionDNR.getRuleManager(extension).getDynamicRules();
},
getSessionRules() {
// ruleManager.getSessionRules() returns an array of Rule instances.
// When these are structurally cloned (to send them to the child),
// the enumerable public fields of the class instances are copied to
// plain objects, as desired.
return ExtensionDNR.getRuleManager(extension).getSessionRules();
},
isRegexSupported(regexOptions) {
const {
regex: regexFilter,
isCaseSensitive: isUrlFilterCaseSensitive,
// requireCapturing: is ignored, as it does not affect validation.
} = regexOptions;
let ruleValidator = new ExtensionDNR.RuleValidator([]);
ruleValidator.addRules([
{
id: 1,
condition: { regexFilter, isUrlFilterCaseSensitive },
action: { type: "allow" },
},
]);
let failures = ruleValidator.getFailures();
if (failures.length) {
// While the UnsupportedRegexReason enum has more entries than just
// "syntaxError" (e.g. also "memoryLimitExceeded"), our validation
// is currently very permissive, and therefore the only
// distinguishable error is "syntaxError".
return { isSupported: false, reason: "syntaxError" };
}
return { isSupported: true };
},
async testMatchOutcome(request, options) {
ensureDNRFeedbackEnabled("declarativeNetRequest.testMatchOutcome");
let { url, initiator, ...req } = request;
req.requestURI = Services.io.newURI(url);
if (initiator) {
req.initiatorURI = Services.io.newURI(initiator);
if (req.initiatorURI.schemeIs("data")) {
// data:-URIs are always opaque, i.e. a null principal. We should
// therefore ignore them here.
// ExtensionDNR's NetworkIntegration.startDNREvaluation does not
// encounter data:-URIs because opaque principals are mapped to a
// null initiatorURI. For consistency, we do the same here.
req.initiatorURI = null;
}
}
const matchedRules = ExtensionDNR.getMatchedRulesForRequest(
req,
options?.includeOtherExtensions ? null : extension
).map(matchedRule => {
// Converts an internal MatchedRule instance to an object described
// by the "MatchedRule" type in declarative_net_request.json.
const result = {
ruleId: matchedRule.rule.id,
rulesetId: matchedRule.ruleset.id,
};
if (matchedRule.ruleManager.extension !== extension) {
result.extensionId = matchedRule.ruleManager.extension.id;
}
return result;
});
return { matchedRules };
},
},
};
}
};
|
