passbolt-browser-extension 3.0.6 → 4.6.2

package/src/all/background_page/sdk/page-mod.js

@@ -1,337 +0,0 @@
-/**
- * Passbolt ~ Open source password manager for teams
- * Copyright (c) Passbolt SA (https://www.passbolt.com)
- *
- * Licensed under GNU Affero General Public License version 3 of the or any later version.
- * For full copyright and license information, please see the LICENSE.txt
- * Redistributions of files must retain the above copyright notice.
- *
- * @copyright     Copyright (c) Passbolt SA (https://www.passbolt.com)
- * @license       https://opensource.org/licenses/AGPL-3.0 AGPL License
- * @link          https://www.passbolt.com Passbolt(tm)
- * @since         2.0.0
- */
-const {ScriptExecution} = require('../sdk/scriptExecution');
-const {Worker} = require('../sdk/worker');
-const Uuid = require('../utils/uuid');
-const Workers = require('../model/worker');
-const {Log} = require('../model/log');
-
-/**
- * PageMod Class
- *
- * This class controls the insertions of content scripts in a page as well as a port name
- * When a content script is inserted it will establish a connection using the port name to the background page
- * Once the connection is establish the pagemod will create a Worker, and attach events to it. This
- * way the content script can request the background page for info and/or run sensitive logic.
- *
- * For Webextension Data Iframe the system is similar, it open ports data script can connect to and
- * create the associated worker, bind the events, etc. The only difference is the pagemod does not insert the
- * scripts, the html of the data page does.
- *
- * Format is weird because it was acting historically as a wrapper for chrome
- * to match the old Firefox SDK.
- */
-class PageMod {
-
-  /**
-   * Constructor
-   * @param {object} args
-   */
-  constructor (args) {
-    if (typeof args === 'undefined') {
-      throw new TypeError('Invalid pagemod. No argument provided');
-    }
-    this.args = args;
-    this._ports = {}; // Object{tabid:port, ...} for which the pagemod has a port available
-    this._listeners = []; // list of listeners initialized by this pagemod
-    this.__init();
-  }
-
-  /**
-   * PageMod Destroy
-   */
-  destroy () {
-    // Stops the page-mod from making any more modifications.
-    // Once destroyed the page-mod can no longer be used.
-    // Modifications already made to open documents by content scripts will not be undone
-    // Unsuported: stylesheets added by contentStyle or contentStyleFile, will be unregistered immediately.
-    if(typeof this._listeners['chrome.tabs.onRemoved'] !== 'undefined') {
-      chrome.tabs.onRemoved.removeListener(this._listeners['chrome.tabs.onRemoved']);
-      chrome.tabs.onReplaced.removeListener(this._listeners['chrome.tabs.onReplaced']);
-      chrome.tabs.onUpdated.removeListener(this._listeners['chrome.tabs.onUpdated']);
-    }
-
-    if(typeof this._listeners['chrome.runtime.onConnect'] !== 'undefined') {
-      chrome.runtime.onConnect.removeListener(this._listeners['chrome.runtime.onConnect']);
-    }
-    // clear the tab and listeners
-    this._ports = {};
-    this._listeners = [];
-  }
-
-  // =====================================================================
-  // Private functions
-  // Not to be called directly
-  // =====================================================================
-  /**
-   * PageMod Init
-   */
-  __init () {
-    // The url to use for the pageMod include is not a regex
-    if(!(this.args.include instanceof RegExp)) {
-      if (this.args.include.startsWith('about:blank')) {
-        // For URL patterns like 'about:blank?passbolt=passbolt-iframe*'
-        // Contrarily to Firefox we do not inject scripts in the page
-        // They are loaded via chrome-extension://[pluginid]/js/iframe.html templates
-        // We wait for the page mod to initiate the connection
-        this.__onIframeConnectInit();
-        return;
-      } else if (this.args.include.startsWith(chrome.runtime.getURL(''))) {
-        // And similarly for any chrome-extension:// urls
-        this.__onContentConnectInit();
-        return;
-      } else {
-        this.args.include = new RegExp(this.args.include);
-      }
-    }
-
-    // When a tab is updated we try to insert content code if it matches
-    // the include and contentScriptWhen pageMod parameters
-    this._listeners['chrome.tabs.onUpdated'] = (tabId, changeInfo, tab) => {
-        this.__onTabUpdated(tabId, changeInfo, tab);
-    };
-    chrome.tabs.onUpdated.addListener(this._listeners['chrome.tabs.onUpdated']);
-
-    // Sometimes the page is loaded from the cache and the 'onUpdate' listener is
-    // not fired. To make sure we cover that case we listen to 'onReplaced' events
-    // fired when a tab is replaced with another tab due to prerendering or instant.
-    // see. https://bugs.chromium.org/p/chromium/issues/detail?id=109557
-    this._listeners['chrome.tabs.onReplaced'] = (addedTabId, removedTabId) => {
-      chrome.tabs.get(addedTabId, (tab) => {
-        chrome.tabs.get(removedTabId, (oldTab) => {
-          Log.write({level: 'debug', message: 'sdk/pageMod::__init ' + this.args.name + ' processing chrome.tabs.onReplaced ' + addedTabId + ' ' + removedTabId + ' ' + tab.url + ' ' + oldTab.url });
-        });
-        this.__onTabUpdated(tab.id, {status:'complete'}, tab);
-      });
-    };
-    chrome.tabs.onReplaced.addListener(this._listeners['chrome.tabs.onReplaced']);
-
-    // Using attachto a pagemod can be launched to an already opened tab
-    // Useful after an install or a reinstall
-    // see. attachTo: ["existing", "top"]
-    // Existing = attach to already opened tab (default not)
-    // Top = attach to only top document and not iframes (we can't attach to iframe in chrome anyway)
-    if(typeof this.args.attachTo !== 'undefined') {
-      chrome.tabs.query({}, (tabs) => {
-        tabs.forEach((tab) => {
-          this.__onAttachExistingTab(tab, this.args.attachTo.reload);
-        });
-      });
-    }
-
-    // When a tab is closed cleanup
-    this._listeners['chrome.tabs.onRemoved'] = (tabId) => {
-      Log.write({level: 'debug', message: 'sdk/pagemod::__init::onRemovedListener tab:' + tabId });
-      if (tabId in this._ports) {
-        delete this._ports[tabId];
-      }
-    };
-    chrome.tabs.onRemoved.addListener(this._listeners['chrome.tabs.onRemoved']);
-  }
-
-  /**
-   * Manage runtime.onConnect listeners
-   *
-   * @param {string} portName
-   * @param {int|undefined} tabId
-   * @param {string|undefined} iframe
-   * @private
-   */
-  __initConnectListener (portName, tabId, iframe) {
-    if (typeof iframe === 'undefined') {
-      iframe = false;
-    }
-    this._listeners['chrome.runtime.onConnect'] =  (port) => {
-      // check if the portname match
-      if(port.name === portName) {
-
-        // if there is a connection on the port for a pagemod that
-        // was previously matching on that tab but not anymore
-        if(!iframe && !this.__checkUrl(port.sender.tab.url)) {
-            // detach any existing worker
-            if(Workers.exists(this.args.name, port.sender.tab.id)) {
-              Workers.get(this.args.name, port.sender.tab.id).destroy('destroying worker because url changed');
-            }
-            return;
-        }
-
-        // add the sender tab id to the list of active tab for that worker
-        if (typeof tabId === 'undefined' || tabId === port.sender.tab.id) {
-          this._ports[port.sender.tab.id] = port;
-          const worker = new Worker(port, port.sender.tab, iframe, this);
-          this.args.onAttach(worker);
-        }
-      }
-    };
-    chrome.runtime.onConnect.addListener(this._listeners['chrome.runtime.onConnect']);
-  }
-
-  /**
-   * iFrame port init
-   * @private
-   */
-  __onIframeConnectInit() {
-    // We use the passbolt part of the location for ifrrame portname
-    // e.g. about:blank?passbolt=iframeId
-    let iframeId = this.args.include.split('passbolt=')[1];
-    iframeId = iframeId.replace('*', '');
-    this.portname = iframeId;
-    Log.write({level: 'debug', message: 'sdk/pageMod::__onIframeConnectInit ' + this.args.name + ' iframe opening port on ' + this.portname});
-    this.__initConnectListener(this.portname, undefined, true);
-  }
-
-  /**
-   * Content code port init
-   * @private
-   */
-  __onContentConnectInit() {
-    // We use the content file name as portname
-    let portname = this.args.include;
-    const replaceStr = chrome.runtime.getURL('/data/');
-    portname = portname.replace(replaceStr, '').replace('.html','');
-    this.portname = portname;
-    Log.write({level: 'debug', message:  'sdk/pageMod::__onContentConnectInit ' + this.args.name + ' content opening port on ' + this.portname});
-    this.__initConnectListener(this.portname);
-  }
-
-  /**
-   * When a pagemod is requested on an already opened tab
-   *
-   * Refresh the page so that it can trigger a proper onTabUpdate
-   * so that we have a clean state. Note that we can't just proceed with a onTabUpdate as
-   * here might be some scripts already included in the page and we can't remove them
-   *
-   * @param {Tab} tab
-   * @param {boolean} reload (optional) default true
-   * @private
-   */
-  __onAttachExistingTab(tab, reload) {
-    // We can't insert scripts if the url is not https or http
-    // as this is not allowed, instead we insert the scripts manually in the background page if needed
-    if (!(tab.url.startsWith('http://') || tab.url.startsWith('https://'))) {
-      return;
-    }
-    if (typeof reload === 'undefined') {
-      reload = true;
-    }
-
-    // if the url match the pagemod requested pattern
-    if (this.__checkUrl(tab.url)) {
-      if (reload) {
-        Log.write({level: 'debug', message: 'Attaching pagemod on an existing tab, reload the tab @ tab:' + tab.id + ', pagemod: ' + this.args.name + ', url:' + tab.url + ', function: PageMod.__onAttachExistingTab()'});
-        chrome.tabs.reload(tab.id);
-      } else {
-        Log.write({level: 'debug', message: 'Attaching pagemod on an existing tab, reinsert the CS @ tab:' + tab.id + ', pagemod: ' + this.args.name + ', url:' + tab.url + ', function: PageMod.__onAttachExistingTab()'});
-        this.__onTabUpdated(tab.id, {status:'complete'}, tab);
-      }
-    }
-  }
-
-  /**
-   * When a tab is updated
-   *
-   * @param {string} tabId
-   * @param {object} changeInfo
-   * @param {Tab} tab
-   * @private
-   */
-  __onTabUpdated (tabId, changeInfo, tab) {
-    // firefox sometimes fires changes with undefined status
-    // ignore that garbage
-    if (changeInfo.status === undefined) {
-      return;
-    }
-    // ignore loading requests
-    if (changeInfo.status !== 'complete') {
-      return;
-    }
-
-    // ignore requests that have changeInfo.url set.
-    // they are only triggered by firefox in case of tab restore and proved buggy
-    if (changeInfo.url !== undefined) {
-      return;
-    }
-    // ignore about:blank urls they can not be interacted with anyway
-    if (tab.url === 'about:blank') {
-      return;
-    }
-    // We can't insert scripts if the url is not https or http
-    // as this is not allowed, instead we insert the scripts manually in the background page if needed
-    if (!(tab.url.startsWith('http://') || tab.url.startsWith('https://'))) {
-      return;
-    }
-    // Check if pagemod url pattern match tab url
-    if (!this.__checkUrl(tab.url)) {
-      return;
-    }
-
-    Log.write({level: 'debug', message: 'sdk/pageMod::__onTabUpdated ' + this.args.name + ' processing chrome.tabs.onUpdated ' + tabId + ' ' + changeInfo.status + ' ' + changeInfo.url + ' ' + tab.url });
-
-    // if there is not already a worker in that tab
-    // generate a portname based on the tab it and listen to connect event
-    // otherwise reuse the already an active worker in that tab to accept incoming connection
-    this.portname = 'port-' + Uuid.get(tabId.toString());
-    //if (this._ports.indexOf(tabId) === -1) {
-    if (!(tabId in this._ports)) {
-      this.__initConnectListener(this.portname, tabId);
-    } else {
-      try {
-        // try to post a message in that port
-        // If the port is disconnected, an error is thrown.
-        this._ports[tabId].postMessage('passbolt.port.check');
-        // If there is not error it means there is already a content script running
-        // and we do not need to include it a second time
-        return;
-      } catch(error) {
-        // If the port is not open / does not exist, we proceed to include scripts
-      }
-    }
-
-    // a helper to handle insertion of scripts, variables and css in target page
-    const scriptExecution = new ScriptExecution(tabId);
-
-    // set portname in content code as global variable to be used by data/js/port.js
-    scriptExecution.setGlobals({portname: this.portname});
-
-    // Set JS global variables if needed
-    if (typeof this.args.contentScriptOptions !== 'undefined' && Object.keys(this.args.contentScriptOptions).length) {
-      scriptExecution.setGlobals(this.args.contentScriptOptions);
-    }
-
-    // Inject JS files if needed
-    const scripts = this.args.contentScriptFile.slice();
-    scriptExecution.injectScripts(scripts);
-
-    // Inject CSS files if needed
-    if(typeof this.args.contentStyleFile !== 'undefined') {
-      const styles = this.args.contentStyleFile.slice();
-      if (styles.length > 0) {
-        scriptExecution.injectCss(styles);
-      }
-    }
-  }
-
-  /**
-   * Check if a given URL match the pattern provided in the args
-   *
-   * @param url
-   * @returns {boolean}
-   * @private
-   */
-  __checkUrl(url) {
-    return (url.match(this.args.include));
-  }
-}
-
-exports.PageMod = PageMod;

package/src/all/background_page/sdk/random.js

@@ -1,11 +0,0 @@
-/**
- * Get Random Bytes
- *
- * @copyright (c) 2017 Passbolt SARL
- * @licence GNU Affero General Public License http://www.gnu.org/licenses/agpl-3.0.en.html
- */
-exports.randomBytes = function(size) {
-  var buf = new Uint8Array(size);
-  window.crypto.getRandomValues(buf);
-  return buf;
-};

package/src/all/background_page/sdk/self.js

@@ -1,10 +0,0 @@
-/**
- * Self chrome wrapper
- */
-var data =  {
-   url : function(url) {
-    if(typeof url === 'undefined') url = '';
-    return 'chrome-extension://' + chrome.runtime.id + '/data/' + url;
-  }
-};
-exports.data = data;

package/src/all/background_page/sdk/tab.js

@@ -1,77 +0,0 @@
-/**
- * Browser tab wrapper
- *
- * @param port
- * @constructor
- */
-var Tab = function(tab) {
-  this._tab = tab;
-  this.id = tab.id;
-  this.url = tab.url;
-  this.callbacks = {};
-
-  var _this = this;
-
-  // setup on ready event
-  this._onTabUpdated = function (tabId, changeInfo, tab) {
-    // if tab is the same than the current worker tab
-    // and is fully loaded
-    if(_this.id == tabId && changeInfo.status == 'complete') {
-      _this.triggerEvent('ready', tab);
-    }
-  };
-  chrome.tabs.onUpdated.addListener(this._onTabUpdated);
-
-  // setup on removed event
-  this._onTabRemoved = function (tabId) {
-    if(_this.id == tabId) {
-      // if (chrome.tabs.onRemoved.hasListener(_this.onTabRemoved)) {
-      //   chrome.tabs.onRemoved.removeListener(_this.onTabRemoved);
-      // }
-      _this.triggerEvent('removed', tab);
-    }
-  };
-  chrome.tabs.onRemoved.addListener(this._onTabRemoved);
-};
-
-/**
- * Destroy the tab listeners
- * Called when the worker is destroyed
- */
-Tab.prototype.destroy = function() {
-  chrome.tabs.onUpdated.removeListener(this._onTabUpdated);
-  chrome.tabs.onRemoved.removeListener(this._onTabRemoved);
-};
-
-/**
- * Add an event listener
- *
- * @param eventName
- * @param callback
- */
-Tab.prototype.on = function(eventName, callback) {
-  this.callbacks[eventName] = callback;
-};
-
-/**
- * Remove an event listener
- *
- * @param eventName
- */
-Tab.prototype.removeListener = function(eventName) {
-  delete this.callbacks[eventName];
-};
-
-/**
- * Trigger an event
- *
- * @param eventName
- */
-Tab.prototype.triggerEvent = function (eventName) {
-  if (typeof this.callbacks[eventName] !== 'undefined') {
-    var args = Array.prototype.slice.call(arguments, 1);
-    this.callbacks[eventName].apply(this, args);
-  }
-};
-
-exports.Tab = Tab;

package/src/all/background_page/sdk/worker.js

@@ -1,84 +0,0 @@
-var Port = require('../sdk/port').Port;
-var Tab = require('../sdk/tab').Tab;
-var Log = require('../model/log').Log;
-
-/**
- * PageMod Worker Chrome Wrapper
- *
- * @param port
- * @constructor
- */
-const Worker = function(port, tab, iframe, pageMod) {
-  this.port = new Port(port);
-  this.callbacks = {};
-  this.iframe = iframe;
-  this.pageMod = pageMod;
-
-  // make sure the worker self destroy
-  // when the tab its running in is closed
-  var _this = this;
-  if (tab) {
-    this.tab = new Tab(tab);
-    this.tab.on('removed', function () {
-      _this.destroy('tab was closed');
-    });
-  }
-
-  // make sure the worker self destroy
-  // when it's an iframe worker and the iframe is unloaded
-  if(iframe) {
-    this.onPortDisconnect = function() {
-      _this.port._port.onDisconnect.removeListener(_this.onPortDisconnect);
-      _this.destroy('iframe got unloaded');
-    };
-    _this.port._port.onDisconnect.addListener(_this.onPortDisconnect);
-  }
-};
-
-/**
- * Add event listener
- * @param eventName
- * @param callback
- */
-Worker.prototype.on = function (eventName, callback) {
-  this.callbacks[eventName] = callback;
-};
-
-/**
- * Trigger an event listener
- * @param eventName
- */
-Worker.prototype.triggerEvent = function (eventName) {
-  // Log.write({level: 'debug', message: 'sdk/worker::triggerEvent ' + eventName + ' tab:' + this.tab.id});
-  if (typeof this.callbacks[eventName] !== 'undefined') {
-    this.callbacks[eventName].apply();
-  }
-};
-
-/**
- * Destroy the worker
- */
-Worker.prototype.destroy = function (reason) {
-  Log.write({level: 'debug', message: `sdk/worker::destroy ${this.tab && this.tab.id ? `(tab: ${this.tab.id})` : ""} : ${reason}`});
-
-  // console.debut('Destroying worker because ' + reason);
-  // A detach event is fired just before removal.
-  this.triggerEvent('detach');
-
-  // remove the content script from the page
-  // Not possible...
-
-  // remove all registered listeners
-  if(this.iframe) {
-    this.port._port.onDisconnect.removeListener(this.onPortDisconnect);
-  }
-  if (this.tab) {
-    this.tab.destroy();
-  }
-
-  //delete this.callbacks;
-  delete this.port;
-  delete this.tab;
-};
-
-exports.Worker = Worker;