external/uBlock
1
0
Fork 0
mirror of https://github.com/gorhill/uBlock.git synced 2024-11-10 09:07:54 +01:00
Code Issues Projects Releases Packages Wiki Activity

#956/#1497: code review

Browse source
This commit is contained in:
gorhill 2016-04-21 12:26:08 -04:00
parent a6028083f3
commit e1f150f494
2 changed files with 284 additions and 107 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

238
platform/chromium/vapi-client.js
View file

@ -341,6 +341,7 @@ vAPI.shutdown.add(function() {
/******************************************************************************/
// https://bugs.chromium.org/p/chromium/issues/detail?id=129353
// https://github.com/gorhill/uBlock/issues/956
// https://github.com/gorhill/uBlock/issues/1497
// Trap calls to WebSocket constructor, and expose websocket-based network
// requests to uBO's filtering engine, logger, etc.
@ -367,116 +368,139 @@ vAPI.shutdown.add(function() {
// WebSocket reference: https://html.spec.whatwg.org/multipage/comms.html
// The script tag will remove itself from the DOM once it completes
// execution.
// For code review convenience, the stringified code below can be found at
// the following gist:
// - https://gist.github.com/gorhill/9cad94dfa438092e5fdabd7d0bdb23db
// Ideally, the `js/websocket.js` script would be declared as a
// `web_accessible_resources` in the manifest, but this unfortunately would
// open the door for web pages to identify *directly* that one is using
// uBlock Origin. Consequently, I have to inject the code as a literal
// string below :(
// For code review, the stringified code below is found in
// `js/websocket.js` (comments were stripped).
var script = doc.createElement('script');
script.id = 'ubofix-f41665f3028c7fd10eecf573336216d3';
script.textContent = [
'(function() {',
' var WS = window.WebSocket;',
'',
' var onClose = function(ev) {',
' this.readyState = this.wrapped.readyState;',
' if ( this.onclose !== null ) {',
' this.onclose(ev);',
' }',
' };',
'',
' var onError = function(ev) {',
' this.readyState = this.wrapped.readyState;',
' if ( this.onerror !== null ) {',
' this.onerror(ev);',
' }',
' };',
'',
' var onMessage = function(ev) {',
' if ( this.onmessage !== null ) {',
' this.onmessage(ev);',
' }',
' };',
'',
' var onOpen = function(ev) {',
' this.readyState = this.wrapped.readyState;',
' if ( this.onopen !== null ) {',
' this.onopen(ev);',
' }',
' };',
'',
' var onAllowed = function(ws, url, protocols) {',
' this.removeEventListener("load", onAllowed);',
' this.removeEventListener("error", onBlocked);',
' connect(ws, url, protocols);',
' };',
'',
' var onBlocked = function(ws) {',
' this.removeEventListener("load", onAllowed);',
' this.removeEventListener("error", onBlocked);',
' if ( ws.onerror !== null ) {',
' ws.onerror(new window.ErrorEvent("error"));',
' }',
' };',
'',
' var connect = function(ws, url, protocols) {',
' ws.wrapped = new WS(url, protocols);',
' ws.wrapped.onclose = onClose.bind(ws);',
' ws.wrapped.onerror = onError.bind(ws);',
' ws.wrapped.onmessage = onMessage.bind(ws);',
' ws.wrapped.onopen = onOpen.bind(ws);',
' };',
'',
' var wrapper = function(url, protocols) {',
' this.binaryType = "";',
' this.bufferedAmount = 0;',
' this.extensions = "";',
' this.onclose = null;',
' this.onerror = null;',
' this.onmessage = null;',
' this.onopen = null;',
' this.protocol = "";',
' this.readyState = this.CONNECTING;',
' this.url = url;',
'',
' this.wrapped = null;',
' if ( /^wss?:\\/\\//.test(url) === false ) {',
' connect(this, url, protocols);',
' return;',
' }',
'',
' var img = new Image();',
' img.src = ',
' window.location.origin',
' + "?url=" + encodeURIComponent(url)',
' + "&ubofix=f41665f3028c7fd10eecf573336216d3";',
' img.addEventListener("load", onAllowed.bind(img, this, url, protocols));',
' img.addEventListener("error", onBlocked.bind(img, this, url, protocols));',
' };',
'',
' wrapper.prototype.close = function(code, reason) {',
' if ( this.wrapped !== null ) {',
' this.wrapped.close(code, reason);',
' }',
' };',
'',
' wrapper.prototype.send = function(data) {',
' if ( this.wrapped !== null ) {',
' this.wrapped.send(data);',
' }',
' };',
'',
' wrapper.prototype.CONNECTING = 0;',
' wrapper.prototype.OPEN = 1;',
' wrapper.prototype.CLOSING = 2;',
' wrapper.prototype.CLOSED = 3;',
'',
' window.WebSocket = wrapper;',
'',
' var me = document.getElementById("ubofix-f41665f3028c7fd10eecf573336216d3");',
' if ( me !== null && me.parentNode !== null ) {',
' me.parentNode.removeChild(me);',
' }',
'})();',
].join('\n');
"(function() {",
" 'use strict';",
"",
" var WS = window.WebSocket;",
" var toWrapped = new WeakMap();",
"",
" var onClose = function(ev) {",
" var wrapped = toWrapped.get(this);",
" if ( !wrapped ) {",
" return;",
" }",
" this.readyState = wrapped.readyState;",
" if ( this.onclose !== null ) {",
" this.onclose(ev);",
" }",
" };",
"",
" var onError = function(ev) {",
" var wrapped = toWrapped.get(this);",
" if ( !wrapped ) {",
" return;",
" }",
" this.readyState = wrapped.readyState;",
" if ( this.onerror !== null ) {",
" this.onerror(ev);",
" }",
" };",
"",
" var onMessage = function(ev) {",
" if ( this.onmessage !== null ) {",
" this.onmessage(ev);",
" }",
" };",
"",
" var onOpen = function(ev) {",
" var wrapped = toWrapped.get(this);",
" if ( !wrapped ) {",
" return;",
" }",
" this.readyState = wrapped.readyState;",
" if ( this.onopen !== null ) {",
" this.onopen(ev);",
" }",
" };",
"",
" var onAllowed = function(ws, url, protocols) {",
" this.removeEventListener('load', onAllowed);",
" this.removeEventListener('error', onBlocked);",
" connect(ws, url, protocols);",
" };",
"",
" var onBlocked = function(ws) {",
" this.removeEventListener('load', onAllowed);",
" this.removeEventListener('error', onBlocked);",
" if ( ws.onerror !== null ) {",
" ws.onerror(new window.ErrorEvent('error'));",
" }",
" };",
"",
" var connect = function(wrapper, url, protocols) {",
" var wrapped = new WS(url, protocols);",
" toWrapped.set(wrapper, wrapped);",
" wrapped.onclose = onClose.bind(wrapper);",
" wrapped.onerror = onError.bind(wrapper);",
" wrapped.onmessage = onMessage.bind(wrapper);",
" wrapped.onopen = onOpen.bind(wrapper);",
" };",
"",
" var WebSocket = function(url, protocols) {",
" this.binaryType = '';",
" this.bufferedAmount = 0;",
" this.extensions = '';",
" this.onclose = null;",
" this.onerror = null;",
" this.onmessage = null;",
" this.onopen = null;",
" this.protocol = '';",
" this.readyState = this.CONNECTING;",
" this.url = url;",
"",
" if ( /^wss?:\\/\\//.test(url) === false ) {",
" connect(this, url, protocols);",
" return;",
" }",
"",
" var img = new Image();",
" img.src = ",
" window.location.origin",
" + '?url=' + encodeURIComponent(url)",
" + '&ubofix=f41665f3028c7fd10eecf573336216d3';",
" img.addEventListener('load', onAllowed.bind(img, this, url, protocols));",
" img.addEventListener('error', onBlocked.bind(img, this, url, protocols));",
" };",
"",
" WebSocket.prototype.close = function(code, reason) {",
" var wrapped = toWrapped.get(this);",
" if ( !wrapped ) {",
" return;",
" }",
" wrapped.close(code, reason);",
" };",
"",
" WebSocket.prototype.send = function(data) {",
" var wrapped = toWrapped.get(this);",
" if ( !wrapped ) {",
" return;",
" }",
" wrapped.send(data);",
" };",
"",
" WebSocket.prototype.CONNECTING = 0;",
" WebSocket.prototype.OPEN = 1;",
" WebSocket.prototype.CLOSING = 2;",
" WebSocket.prototype.CLOSED = 3;",
"",
" window.WebSocket = WebSocket;",
"",
" var me = document.getElementById('ubofix-f41665f3028c7fd10eecf573336216d3');",
" if ( me !== null && me.parentNode !== null ) {",
" me.parentNode.removeChild(me);",
" }",
"})();",
].join('\n');
try {
parent.appendChild(script);

153
platform/chromium/websocket.js Normal file
View file

@ -0,0 +1,153 @@
/*******************************************************************************
uBlock Origin - a browser extension to block requests.
Copyright (C) 2014-2106 The uBlock Origin authors
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see {http://www.gnu.org/licenses/}.
Home: https://github.com/gorhill/uBlock
*/
// Purpose of this script is to workaround Chromium issue 129353:
// https://bugs.chromium.org/p/chromium/issues/detail?id=129353
// https://github.com/gorhill/uBlock/issues/956
// https://github.com/gorhill/uBlock/issues/1497
// WebSocket reference: https://html.spec.whatwg.org/multipage/comms.html
// A WeakMap is used to hide the real WebSocket instance from caller's view, in
// order to ensure that the wrapper can't be bypassed.
// The script removes its own tag from the DOM.
(function() {
'use strict';
var WS = window.WebSocket;
var toWrapped = new WeakMap();
var onClose = function(ev) {
var wrapped = toWrapped.get(this);
if ( !wrapped ) {
return;
}
this.readyState = wrapped.readyState;
if ( this.onclose !== null ) {
this.onclose(ev);
}
};
var onError = function(ev) {
var wrapped = toWrapped.get(this);
if ( !wrapped ) {
return;
}
this.readyState = wrapped.readyState;
if ( this.onerror !== null ) {
this.onerror(ev);
}
};
var onMessage = function(ev) {
if ( this.onmessage !== null ) {
this.onmessage(ev);
}
};
var onOpen = function(ev) {
var wrapped = toWrapped.get(this);
if ( !wrapped ) {
return;
}
this.readyState = wrapped.readyState;
if ( this.onopen !== null ) {
this.onopen(ev);
}
};
var onAllowed = function(ws, url, protocols) {
this.removeEventListener('load', onAllowed);
this.removeEventListener('error', onBlocked);
connect(ws, url, protocols);
};
var onBlocked = function(ws) {
this.removeEventListener('load', onAllowed);
this.removeEventListener('error', onBlocked);
if ( ws.onerror !== null ) {
ws.onerror(new window.ErrorEvent('error'));
}
};
var connect = function(wrapper, url, protocols) {
var wrapped = new WS(url, protocols);
toWrapped.set(wrapper, wrapped);
wrapped.onclose = onClose.bind(wrapper);
wrapped.onerror = onError.bind(wrapper);
wrapped.onmessage = onMessage.bind(wrapper);
wrapped.onopen = onOpen.bind(wrapper);
};
var WebSocket = function(url, protocols) {
this.binaryType = '';
this.bufferedAmount = 0;
this.extensions = '';
this.onclose = null;
this.onerror = null;
this.onmessage = null;
this.onopen = null;
this.protocol = '';
this.readyState = this.CONNECTING;
this.url = url;
if ( /^wss?:\/\//.test(url) === false ) {
connect(this, url, protocols);
return;
}
var img = new Image();
img.src =
window.location.origin
+ '?url=' + encodeURIComponent(url)
+ '&ubofix=f41665f3028c7fd10eecf573336216d3';
img.addEventListener('load', onAllowed.bind(img, this, url, protocols));
img.addEventListener('error', onBlocked.bind(img, this, url, protocols));
};
WebSocket.prototype.close = function(code, reason) {
var wrapped = toWrapped.get(this);
if ( !wrapped ) {
return;
}
wrapped.close(code, reason);
};
WebSocket.prototype.send = function(data) {
var wrapped = toWrapped.get(this);
if ( !wrapped ) {
return;
}
wrapped.send(data);
};
WebSocket.prototype.CONNECTING = 0;
WebSocket.prototype.OPEN = 1;
WebSocket.prototype.CLOSING = 2;
WebSocket.prototype.CLOSED = 3;
window.WebSocket = WebSocket;
var me = document.getElementById('ubofix-f41665f3028c7fd10eecf573336216d3');
if ( me !== null && me.parentNode !== null ) {
me.parentNode.removeChild(me);
}
})();