Skip to content

Commit 3a564c1

Browse files
gorhillgorhill
committed
Add ability to uncloak CNAME records
Related issue: - uBlockOrigin/uBlock-issues#780 New webext permission added: `dns`, which purpose is to allow an extension to fetch the DNS record of specific hostnames, reference documentation: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/dns The webext API `dns` is available in Firefox 60+ only. The new API will enable uBO to "uncloak" the actual hostname used in network requests. The ability is currently disabled by default for now -- this is only a first commit related to the above issue to allow advanced users to immediately use the new ability. Four advanced settings have been created to control the uncloaking of actual hostnames: cnameAliasList: a space-separated list of hostnames. Default value: unset => empty list. Special value: * => all hostnames. A space-separated list of hostnames => this tells uBO to "uncloak" the hostnames in the list will. cnameIgnoreList: a space-separated list of hostnames. Default value: unset => empty list. Special value: * => all hostnames. A space-separated list of hostnames => this tells uBO to NOT re-run the network request through uBO's filtering engine with the CNAME hostname. This is useful to exclude commonly used actual hostnames from being re-run through uBO's filtering engine, so as to avoid pointless overhead. cnameIgnore1stParty: boolean. Default value: true. Whether uBO should ignore to re-run a network request through the filtering engine when the CNAME hostname is 1st-party to the alias hostname. cnameMaxTTL: number of minutes. Default value: 120. This tells uBO to clear its CNAME cache after the specified time. For efficiency purpose, uBO will cache alias=>CNAME associations for reuse so as to reduce calls to `browser.dns.resolve`. All the associations will be cleared after the specified time to ensure the map does not grow too large and too ensure uBO uses up to date CNAME information.
1 parent 60816b6 commit 3a564c1

File tree

12 files changed

+226
-92
lines changed

12 files changed

+226
-92
lines changed

‎platform/chromium/vapi-background.js‎

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1164,16 +1164,17 @@ vAPI.Net = class {
11641164
browser.webRequest.onBeforeRequest.addListener(
11651165
details => {
11661166
this.normalizeDetails(details);
1167-
if ( this.suspendDepth === 0 || details.tabId < 0 ) {
1168-
if ( this.suspendableListener === undefined ) { return; }
1169-
return this.suspendableListener(details);
1167+
if ( this.suspendDepth !== 0 && details.tabId >= 0 ) {
1168+
return this.suspendOneRequest(details);
11701169
}
1171-
return this.suspendOneRequest(details);
1170+
return this.onBeforeSuspendableRequest(details);
11721171
},
11731172
this.denormalizeFilters({ urls: [ 'http://*/*', 'https://*/*' ] }),
11741173
[ 'blocking' ]
11751174
);
11761175
}
1176+
setOptions(/* options */) {
1177+
}
11771178
normalizeDetails(/* details */) {
11781179
}
11791180
denormalizeFilters(filters) {
@@ -1208,6 +1209,10 @@ vAPI.Net = class {
12081209
options
12091210
);
12101211
}
1212+
onBeforeSuspendableRequest(details) {
1213+
if ( this.suspendableListener === undefined ) { return; }
1214+
return this.suspendableListener(details);
1215+
}
12111216
setSuspendableListener(listener) {
12121217
this.suspendableListener = listener;
12131218
}
@@ -1242,7 +1247,7 @@ vAPI.Net = class {
12421247
this.suspendDepth -= 1;
12431248
}
12441249
if ( this.suspendDepth !== 0 ) { return; }
1245-
this.unsuspendAllRequests(this.suspendableListener);
1250+
this.unsuspendAllRequests();
12461251
}
12471252
canSuspend() {
12481253
return false;

‎platform/chromium/vapi-common.js‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,51 @@ vAPI.webextFlavor = {
116116

117117
/******************************************************************************/
118118

119+
{
120+
const punycode = self.punycode;
121+
const reCommonHostnameFromURL = /^https?:\/\/([0-9a-z_][0-9a-z._-]*[0-9a-z])\//;
122+
const reAuthorityFromURI = /^(?:[^:\/?#]+:)?(\/\/[^\/?#]+)/;
123+
const reHostFromNakedAuthority = /^[0-9a-z._-]+[0-9a-z]$/i;
124+
const reHostFromAuthority = /^(?:[^@]*@)?([^:]+)(?::\d*)?$/;
125+
const reIPv6FromAuthority = /^(?:[^@]*@)?(\[[0-9a-f:]+\])(?::\d*)?$/i;
126+
const reMustNormalizeHostname = /[^0-9a-z._-]/;
127+
128+
vAPI.hostnameFromURI = function(uri) {
129+
let matches = reCommonHostnameFromURL.exec(uri);
130+
if ( matches !== null ) { return matches[1]; }
131+
matches = reAuthorityFromURI.exec(uri);
132+
if ( matches === null ) { return ''; }
133+
const authority = matches[1].slice(2);
134+
if ( reHostFromNakedAuthority.test(authority) ) {
135+
return authority.toLowerCase();
136+
}
137+
matches = reHostFromAuthority.exec(authority);
138+
if ( matches === null ) {
139+
matches = reIPv6FromAuthority.exec(authority);
140+
if ( matches === null ) { return ''; }
141+
}
142+
let hostname = matches[1];
143+
while ( hostname.endsWith('.') ) {
144+
hostname = hostname.slice(0, -1);
145+
}
146+
if ( reMustNormalizeHostname.test(hostname) ) {
147+
hostname = punycode.toASCII(hostname.toLowerCase());
148+
}
149+
return hostname;
150+
};
151+
152+
const psl = self.publicSuffixList;
153+
const reIPAddressNaive = /^\d+\.\d+\.\d+\.\d+$|^\[[\da-zA-Z:]+\]$/;
154+
155+
vAPI.domainFromHostname = function(hostname) {
156+
return reIPAddressNaive.test(hostname)
157+
? hostname
158+
: psl.getDomain(hostname);
159+
};
160+
}
161+
162+
/******************************************************************************/
163+
119164
vAPI.download = function(details) {
120165
if ( !details.url ) { return; }
121166
const a = document.createElement('a');

‎platform/firefox/manifest.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@
7575
"open_in_tab": true
7676
},
7777
"permissions": [
78+
"dns",
7879
"menus",
7980
"privacy",
8081
"storage",

‎platform/firefox/vapi-webrequest.js‎

Lines changed: 97 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,20 @@
6060
constructor() {
6161
super();
6262
this.pendingRequests = [];
63+
this.cnames = new Map();
64+
this.cnameAliasList = null;
65+
this.cnameIgnoreList = null;
66+
this.url = new URL(vAPI.getURL('/'));
67+
this.cnameMaxTTL = 60;
68+
this.cnameTimer = undefined;
69+
}
70+
setOptions(options) {
71+
super.setOptions(options);
72+
this.cnameAliasList = this.regexFromStrList(options.cnameAliasList);
73+
this.cnameIgnoreList = this.regexFromStrList(options.cnameIgnoreList);
74+
this.cnameIgnore1stParty = options.cnameIgnore1stParty === true;
75+
this.cnameMaxTTL = options.cnameMaxTTL || 120;
76+
this.cnames.clear();
6377
}
6478
normalizeDetails(details) {
6579
if ( mustPunycode && !reAsciiHostname.test(details.url) ) {
@@ -109,6 +123,87 @@
109123
}
110124
return Array.from(out);
111125
}
126+
processCanonicalName(cname, details) {
127+
this.url.href = details.url;
128+
details.cnameOf = this.url.hostname;
129+
this.url.hostname = cname;
130+
details.url = this.url.href;
131+
return super.onBeforeSuspendableRequest(details);
132+
}
133+
recordCanonicalName(hn, record) {
134+
let cname =
135+
typeof record.canonicalName === 'string' &&
136+
record.canonicalName !== hn
137+
? record.canonicalName
138+
: '';
139+
if (
140+
cname !== '' &&
141+
this.cnameIgnore1stParty &&
142+
vAPI.domainFromHostname(cname) === vAPI.domainFromHostname(hn)
143+
) {
144+
cname = '';
145+
}
146+
if (
147+
cname !== '' &&
148+
this.cnameIgnoreList !== null &&
149+
this.cnameIgnoreList.test(cname)
150+
) {
151+
152+
cname = '';
153+
}
154+
this.cnames.set(hn, cname);
155+
if ( this.cnameTimer === undefined ) {
156+
this.cnameTimer = self.setTimeout(
157+
( ) => {
158+
this.cnameTimer = undefined;
159+
this.cnames.clear();
160+
},
161+
this.cnameMaxTTL * 60000
162+
);
163+
}
164+
return cname;
165+
}
166+
regexFromStrList(list) {
167+
if (
168+
typeof list !== 'string' ||
169+
list.length === 0 ||
170+
list === 'unset'
171+
) {
172+
return null;
173+
}
174+
if ( list === '*' ) {
175+
return /^./;
176+
}
177+
return new RegExp(
178+
'(?:^|\.)(?:' +
179+
list.trim()
180+
.split(/\s+/)
181+
.map(a => a.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'))
182+
.join('|') +
183+
')$'
184+
);
185+
}
186+
onBeforeSuspendableRequest(details) {
187+
let r = super.onBeforeSuspendableRequest(details);
188+
if ( r !== undefined ) { return r; }
189+
if ( this.cnameAliasList === null ) { return; }
190+
const hn = vAPI.hostnameFromURI(details.url);
191+
let cname = this.cnames.get(hn);
192+
if ( cname === '' ) { return; }
193+
if ( cname !== undefined ) {
194+
return this.processCanonicalName(cname, details);
195+
}
196+
if ( this.cnameAliasList.test(hn) === false ) {
197+
this.cnames.set(hn, '');
198+
return;
199+
}
200+
return browser.dns.resolve(hn, [ 'canonical_name' ]).then(rec => {
201+
const cname = this.recordCanonicalName(hn, rec);
202+
if ( cname === '' ) { return; }
203+
return this.processCanonicalName(cname, details);
204+
205+
});
206+
}
112207
suspendOneRequest(details) {
113208
const pending = {
114209
details: Object.assign({}, details),
@@ -121,11 +216,11 @@
121216
this.pendingRequests.push(pending);
122217
return pending.promise;
123218
}
124-
unsuspendAllRequests(resolver) {
219+
unsuspendAllRequests() {
125220
const pendingRequests = this.pendingRequests;
126221
this.pendingRequests = [];
127222
for ( const entry of pendingRequests ) {
128-
entry.resolve(resolver(entry.details));
223+
entry.resolve(this.onBeforeSuspendableRequest(entry.details));
129224
}
130225
}
131226
canSuspend() {

‎src/css/logger-ui.css‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -268,6 +268,9 @@ body.colorBlind #vwRenderer .logEntry > div.cosmeticRealm,
268268
body.colorBlind #vwRenderer .logEntry > div.redirect {
269269
background-color: rgba(0, 19, 110, 0.1);
270270
}
271+
#vwRenderer .logEntry > div[data-cnameof] {
272+
color: mediumblue;
273+
}
271274
#vwRenderer .logEntry > div[data-type="tabLoad"] {
272275
background-color: #666;
273276
color: white;

‎src/js/background.js‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,10 @@ const µBlock = (( ) => { // jshint ignore:line
4646
cacheStorageAPI: 'unset',
4747
cacheStorageCompression: true,
4848
cacheControlForFirefox1376932: 'no-cache, no-store, must-revalidate',
49+
cnameAliasList: 'unset',
50+
cnameIgnoreList: 'unset',
51+
cnameIgnore1stParty: true,
52+
cnameMaxTTL: 120,
4953
consoleLogLevel: 'unset',
5054
debugScriptlets: false,
5155
debugScriptletInjector: false,

‎src/js/filtering-context.js‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
this.tstamp = 0;
3131
this.realm = '';
3232
this.type = undefined;
33+
this.cnameOf = undefined;
3334
this.url = undefined;
3435
this.hostname = undefined;
3536
this.domain = undefined;
@@ -65,6 +66,7 @@
6566
this.realm = '';
6667
this.type = details.type;
6768
this.setURL(details.url);
69+
this.cnameOf = details.cnameOf !== undefined ? details.cnameOf : '';
6870
this.docId = details.type !== 'sub_frame'
6971
? details.frameId
7072
: details.parentFrameId;

0 commit comments

Comments
 (0)