Merge branch 'feat/encryption' into develop

Author: jarrodek

app.js

@@ -22,7 +22,7 @@ class ArcInit {
     /* global ipc, ArcContextMenu, ArcElectronDrive, OAuth2Handler,
     ThemeManager, ArcPreferencesProxy, CookieBridge, WorkspaceManager,
     FilesystemProxy, ElectronAmfService, versionInfo, WindowSearchService,
-    UpgradeHelper, ImportFilePrePprocessor */
+    UpgradeHelper, ImportFilePrePprocessor, EncryptionService */
     this.created = false;
     this.contextActions = new ArcContextMenu();
     this.driveBridge = new ArcElectronDrive();
@@ -33,6 +33,7 @@ class ArcInit {
     this.fs = new FilesystemProxy();
     this.amfService = new ElectronAmfService();
     this.search = new WindowSearchService();
+    this.encryption = new EncryptionService();
   }
   /**
    * @return {ImportFilePrePprocessor} Instance of import processor class.
@@ -66,6 +67,7 @@ class ArcInit {
     this.fs.listen();
     this.amfService.listen();
     this.search.listen();
+    this.encryption.listen();
 
     ipc.on('checking-for-update', () => {
       this.updateEventHandler('checking-for-update');

package-lock.json

@@ -78,7 +78,9 @@
     "amf-client-js": "^3.5.1",
     "camelcase": "^4.1.0",
     "codemirror": "^5.49.0",
+    "crypto-js": "^3.1.9-1",
     "electron-log": "^3.0.8",
+    "electron-prompt": "^1.3.1",
     "electron-updater": "4.1.2",
     "form-data": "^2.5.1",
     "fs-extra": "^8.1.0",

package.json

@@ -0,0 +1,80 @@
+const AES = require('crypto-js/aes.js');
+const CryptoJS = require('crypto-js/crypto-js.js');
+const prompt = require('electron-prompt');
+/**
+ * A class that handles `encryption-*` web events in the renderer process
+ * and performs data encryption/decryption.
+ *
+ * TODO: consider spawning another process for data encryption / decryption.
+ * Compare gain/loss on running encryption/decryption in separate process
+ * and check whether data passing from process to another process is more costly.
+ */
+class EncryptionService {
+  constructor() {
+    this._decodeHandler = this._decodeHandler.bind(this);
+    this._encodeHandler = this._encodeHandler.bind(this);
+  }
+
+  listen() {
+    window.addEventListener('encryption-decode', this._decodeHandler);
+    window.addEventListener('encryption-encode', this._encodeHandler);
+  }
+
+  unlisten() {
+    window.removeEventListener('encryption-decode', this._decodeHandler);
+    window.removeEventListener('encryption-encode', this._encodeHandler);
+  }
+
+  _decodeHandler(e) {
+    const { method } = e.detail;
+    e.preventDefault();
+    e.detail.result = this.decode(method, e.detail);
+  }
+
+  _encodeHandler(e) {
+    const { method } = e.detail;
+    e.preventDefault();
+    e.detail.result = this.encode(method, e.detail);
+  }
+
+  async encode(method, opts) {
+    switch (method) {
+      case 'aes': return await this.encodeAes(opts.data, opts.passphrase);
+      default: throw new Error(`Unknown encryption method`);
+    }
+  }
+
+  async encodeAes(data, passphrase) {
+    // Todo: this looks really dangerous to run file encryption in the main
+    // thread (of the renderer process). Consider other options.
+    const encrypted = AES.encrypt(data, passphrase);
+    return encrypted.toString();
+  }
+
+  async decode(method, opts) {
+    switch (method) {
+      case 'aes': return await this.decodeAes(opts.data, opts.passphrase);
+      default: throw new Error(`Unknown decryption method`);
+    }
+  }
+
+  async decodeAes(data, passphrase) {
+    if (passphrase === undefined) {
+      const win = require('electron').remote.getCurrentWindow();
+      passphrase = await prompt({
+        title: 'File password',
+        label: 'Enter password to open the file',
+      }, win);
+      if (passphrase === null) {
+        throw new Error('Password is required to open the file.');
+      }
+    }
+    try {
+      const bytes = AES.decrypt(data, passphrase);
+      return bytes.toString(CryptoJS.enc.Utf8);
+    } catch (_) {
+      throw new Error('Invalid password.');
+    }
+  }
+}
+exports.EncryptionService = EncryptionService;

scripts/packages/encryption/renderer/encryption.js

@@ -0,0 +1 @@
+exports.EncryptionService = require('./encryption').EncryptionService;

scripts/packages/encryption/renderer/index.js

@@ -0,0 +1,62 @@
+const { assert } = require('chai');
+const { EncryptionService } = require('../renderer');
+
+describe('EncryptionService', function() {
+  describe('Encrypting content', () => {
+    let instance;
+    before(() => {
+      instance = new EncryptionService();
+      instance.listen();
+    });
+
+    after(() => {
+      instance.unlisten();
+    });
+
+    it('encodes a content using AES.encrypt', async () => {
+      const e = new CustomEvent('encryption-encode', {
+        bubbles: true,
+        cancelable: true,
+        detail: {
+          method: 'aes',
+          data: 'test-data',
+          passphrase: 'test'
+        }
+      });
+      document.body.dispatchEvent(e);
+      const result = await e.detail.result;
+      assert.typeOf(result, 'string');
+      assert.notEqual(result, 'test-data');
+    });
+  });
+
+
+  describe('Decrypting content', () => {
+    const encoded = 'U2FsdGVkX19MRBu8liXK/sbNBOQWG1mewbjEBb8cTAw=';
+    let instance;
+    before(() => {
+      instance = new EncryptionService();
+      instance.listen();
+    });
+
+    after(() => {
+      instance.unlisten();
+    });
+
+    it('decodes a content using AES.decrypt and provided password', async () => {
+      const e = new CustomEvent('encryption-decode', {
+        bubbles: true,
+        cancelable: true,
+        detail: {
+          method: 'aes',
+          data: encoded,
+          passphrase: 'test'
+        }
+      });
+      document.body.dispatchEvent(e);
+      const result = await e.detail.result;
+      assert.typeOf(result, 'string');
+      assert.equal(result, 'test-data');
+    });
+  });
+});

scripts/packages/encryption/spec/encryption.renderer.spec.js

@@ -14,6 +14,7 @@ const { ArcContextMenu } = require('../packages/context-actions/renderer');
 const { FilesystemProxy } = require('./filesystem-proxy');
 const { ElectronAmfService } = require('@advanced-rest-client/electron-amf-service');
 const { WindowSearchService } = require('../packages/search-service/renderer');
+const { EncryptionService } = require('../packages/encryption/renderer/encryption.js');
 const { UpgradeHelper } = require('./upgrade-helper');
 const { ImportFilePrePprocessor } = require('./import-file-preprocessor');
 const setImmediateFn = setImmediate;
@@ -49,6 +50,7 @@ process.once('loaded', () => {
   global.Jexl = Jexl;
   global.UpgradeHelper = UpgradeHelper;
   global.ImportFilePrePprocessor = ImportFilePrePprocessor;
+  global.EncryptionService = EncryptionService;
   global.versionInfo = {
     chrome: versions.chrome,
     appVersion: app.getVersion()

scripts/renderer/preload.js

@@ -57,6 +57,7 @@ class ArcElectron extends ArcAppMixin(LitElement) {
     /* global log */
     this.log = log;
     this.sysVars = process.env;
+    this.withEncrypt = true;
   }
 
   connectedCallback() {