passbolt-browser-extension 3.0.6 → 4.6.2

package/src/all/background_page/controller/mfaSetup/MfaSetupVerifyTotpCodeController.js

@@ -0,0 +1,56 @@
+/**
+ * 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         4.4.0
+ */
+
+import MfaSetupTotpEntity from "../../model/entity/mfa/mfaSetupTotpEntity";
+import MultiFactorAuthenticationModel from "../../model/multiFactorAuthentication/multiFactorAuthenticationModel";
+
+
+class MfaSetupVerifyTotpCodeController {
+  /**
+   * MfaSetupVerifyTotpCodeController constructor
+   * @param {Worker} worker
+   * @param {string} requestId uuid
+   */
+  constructor(worker, requestId, apiClientOptions) {
+    this.worker = worker;
+    this.requestId = requestId;
+    this.multiFactorAuthenticationModel = new MultiFactorAuthenticationModel(apiClientOptions);
+  }
+
+  /**
+   * Controller executor.
+   * @param   {Object} setupDto the totp object with uri and otp code
+   * @returns {Promise<bool>}
+   */
+  async _exec(setupDto) {
+    try {
+      await this.exec(setupDto);
+      this.worker.port.emit(this.requestId, "SUCCESS");
+    } catch (error) {
+      console.error(error);
+      this.worker.port.emit(this.requestId, 'ERROR', error);
+    }
+  }
+
+  /**
+   * Check and save the otp code
+   * @param   {Object} setupDto the totp object with uri and otp code
+   */
+  async exec(setupDto) {
+    const totpEntity = new MfaSetupTotpEntity(setupDto);
+    await this.multiFactorAuthenticationModel.setupTotp(totpEntity);
+  }
+}
+
+export default MfaSetupVerifyTotpCodeController;

package/src/all/background_page/controller/mfaSetup/MfaSetupVerifyTotpCodeController.test.js

@@ -0,0 +1,57 @@
+/**
+ * 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         4.4.0
+ */
+
+import {enableFetchMocks} from "jest-fetch-mock";
+import {defaultApiClientOptions} from "passbolt-styleguide/src/shared/lib/apiClient/apiClientOptions.test.data";
+import EntityValidationError from "passbolt-styleguide/src/shared/models/entity/abstract/entityValidationError";
+import MfaSetupVerifyTotpCodeController from "./MfaSetupVerifyTotpCodeController";
+import {mockApiResponse} from "../../../../../test/mocks/mockApiResponse";
+import {defaultSetupTotpData} from "../../model/entity/mfa/mfaSetupTotpEntity.test.data";
+import MfaSetupTotpEntity from "../../model/entity/mfa/mfaSetupTotpEntity";
+
+beforeEach(() => {
+  enableFetchMocks();
+});
+
+
+describe("MfaSetupVerifyTotpCodeController", () => {
+  let controller;
+
+  beforeEach(() => {
+    controller = new MfaSetupVerifyTotpCodeController(null, null, defaultApiClientOptions());
+  });
+
+  it("Should verify the otp code", async() => {
+    expect.assertions(1);
+    jest.spyOn(controller.multiFactorAuthenticationModel, "setupTotp");
+
+    fetch.doMock(() => mockApiResponse({}));
+
+    await controller.exec(defaultSetupTotpData());
+
+    expect(controller.multiFactorAuthenticationModel.setupTotp).toHaveBeenCalledWith(new MfaSetupTotpEntity(defaultSetupTotpData()));
+  });
+
+  it("Should validate the otp uri and code with entity", async() => {
+    expect.assertions(3);
+
+    try {
+      await controller.exec({});
+    } catch (error) {
+      expect(error).toBeInstanceOf(EntityValidationError);
+      expect(error.hasError('totp', 'required')).toBeTruthy();
+      expect(error.hasError('otpProvisioningUri', 'required')).toBeTruthy();
+    }
+  });
+});

package/src/all/background_page/controller/mfaSetup/MfaSetupVerifyYubikeyCodeController.js

@@ -0,0 +1,59 @@
+/**
+ * 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         4.4.0
+ */
+
+import MfaSetupYubikeyEntity from "../../model/entity/mfa/mfaSetupYubikeyEntity";
+import MultiFactorAuthenticationModel from "../../model/multiFactorAuthentication/multiFactorAuthenticationModel";
+
+
+class MfaSetupVerifyYubikeyCodeController {
+  /**
+   * MfaSetupVerifyYubikeyCodeController constructor
+   * @param {Worker} worker
+   * @param {string} requestId uuid
+   */
+  constructor(worker, requestId, apiClientOptions) {
+    this.worker = worker;
+    this.requestId = requestId;
+    this.multiFactorAuthenticationModel = new MultiFactorAuthenticationModel(apiClientOptions);
+  }
+
+  /**
+   * Controller executor.
+   * @param   {string} provider the provider
+   * @returns {Promise<bool>}
+   */
+  async _exec(providerDto) {
+    try {
+      const response = await this.exec(providerDto);
+      this.worker.port.emit(this.requestId, "SUCCESS", response);
+    } catch (error) {
+      console.error(error);
+      this.worker.port.emit(this.requestId, 'ERROR', error);
+    }
+  }
+
+  /**
+   * Check and save the yubikey otp code
+   * @param  {Object} yubikeyCode code
+   * @returns {Promise<MfaVerifyProviderEntity>}
+   * @throws {Error} if the provider is missing
+   * @throws {TypeError} if the provider is not part of the enum
+   */
+  async exec(yubikeyCode) {
+    const yubikeyEntity = new MfaSetupYubikeyEntity(yubikeyCode);
+    return await this.multiFactorAuthenticationModel.setupYubikey(yubikeyEntity);
+  }
+}
+
+export default MfaSetupVerifyYubikeyCodeController;

package/src/all/background_page/controller/mfaSetup/MfaSetupVerifyYubikeyCodeController.test.js

@@ -0,0 +1,56 @@
+/**
+ * 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         4.4.0
+ */
+
+import {enableFetchMocks} from "jest-fetch-mock";
+import {defaultApiClientOptions} from "passbolt-styleguide/src/shared/lib/apiClient/apiClientOptions.test.data";
+import EntityValidationError from "passbolt-styleguide/src/shared/models/entity/abstract/entityValidationError";
+import {mockApiResponse} from "../../../../../test/mocks/mockApiResponse";
+import MfaSetupVerifyYubikeyCodeController from "./MfaSetupVerifyYubikeyCodeController";
+import {defaultSetupYubikeyData} from "../../model/entity/mfa/mfaSetupYubikeyEntity.test.data";
+import MfaSetupYubikeyEntity from "../../model/entity/mfa/mfaSetupYubikeyEntity";
+
+beforeEach(() => {
+  enableFetchMocks();
+});
+
+
+describe("MfaSetupVerifyYubikeyCodeController", () => {
+  let controller;
+
+  beforeEach(() => {
+    controller = new MfaSetupVerifyYubikeyCodeController(null, null, defaultApiClientOptions());
+  });
+
+  it("Should verify the otp code", async() => {
+    expect.assertions(1);
+    jest.spyOn(controller.multiFactorAuthenticationModel, "setupYubikey");
+
+    fetch.doMock(() => mockApiResponse({}));
+
+    await controller.exec(defaultSetupYubikeyData());
+
+    expect(controller.multiFactorAuthenticationModel.setupYubikey).toHaveBeenCalledWith(new MfaSetupYubikeyEntity(defaultSetupYubikeyData()));
+  });
+
+  it("Should validate the hotp code with entity", async() => {
+    expect.assertions(2);
+
+    try {
+      await controller.exec({});
+    } catch (error) {
+      expect(error).toBeInstanceOf(EntityValidationError);
+      expect(error.hasError('hotp', 'required')).toBeTruthy();
+    }
+  });
+});

package/src/all/background_page/controller/move/moveController.js

@@ -11,9 +11,9 @@
  * @link          https://www.passbolt.com Passbolt(tm)
  * @since         2.13.0
  */
-const __ = require('../../sdk/l10n').get;
-const {MoveResourcesController} = require('./moveResourcesController');
-const {MoveFolderController} = require('./moveFolderController');
+import MoveResourcesController from "./moveResourcesController";
+import MoveFolderController from "./moveFolderController";
+
 
 class MoveController {
   /**
@@ -21,12 +21,14 @@ class MoveController {
    *
    * @param {Worker} worker
    * @param {string} requestId
-   * @param {ApiClientOptions} clientOptions
+   * @param {ApiClientOptions} apiClientOptions the api client options
+   * @param {AccountEntity} account the account associated to the worker
    */
-  constructor(worker, requestId, clientOptions) {
+  constructor(worker, requestId, apiClientOptions, account) {
     this.worker = worker;
     this.requestId = requestId;
-    this.clientOptions = clientOptions;
+    this.apiClientOptions = apiClientOptions;
+    this.account = account;
   }
 
   /**
@@ -39,33 +41,33 @@ class MoveController {
    */
   async main(moveDto) {
     if (!moveDto) {
-      throw new TypeError(__('Move controller parameters cannot be empty'));
+      throw new TypeError('Move controller parameters cannot be empty');
     }
 
-    let folderParentId = moveDto.folderParentId ? moveDto.folderParentId : null;
-    let foldersIds = moveDto.folders ? moveDto.folders : [];
-    let resourcesIds = moveDto.resources ? moveDto.resources : [];
+    const folderParentId = moveDto.folderParentId ? moveDto.folderParentId : null;
+    const foldersIds = moveDto.folders ? moveDto.folders : [];
+    const resourcesIds = moveDto.resources ? moveDto.resources : [];
 
     // TODO
     if (resourcesIds.length && foldersIds.length) {
-      throw new TypeError(__('Multi resource and folder move is not supported.'));
+      throw new TypeError('Multi resource and folder move is not supported.');
     }
     if (foldersIds.length > 1) {
-      throw new TypeError(__('Multi folder move is not supported.'));
+      throw new TypeError('Multi folder move is not supported.');
     }
 
     // Move multiple resources at once
     if (resourcesIds.length) {
-      let controller = new MoveResourcesController(this.worker, this.requestId, this.clientOptions);
+      const controller = new MoveResourcesController(this.worker, this.requestId, this.apiClientOptions, this.account);
       await controller.main(resourcesIds, folderParentId);
     }
 
     // Move one folder
     if (foldersIds.length) {
-      let controller = new MoveFolderController(this.worker, this.requestId, this.clientOptions);
+      const controller = new MoveFolderController(this.worker, this.requestId, this.apiClientOptions, this.account);
       await controller.main(foldersIds[0], folderParentId);
     }
   }
 }
 
-exports.MoveController = MoveController;
+export default MoveController;

package/src/all/background_page/controller/move/moveFolderController.js

@@ -11,20 +11,18 @@
  * @link          https://www.passbolt.com Passbolt(tm)
  * @since         2.13.0
  */
-const __ = require('../../sdk/l10n').get;
-const Worker = require('../../model/worker');
+import Keyring from "../../model/keyring";
+import ResourceModel from "../../model/resource/resourceModel";
+import GetPassphraseService from "../../service/passphrase/getPassphraseService";
+import GetDecryptedUserPrivateKeyService from "../../service/account/getDecryptedUserPrivateKeyService";
+import FolderModel from "../../model/folder/folderModel";
+import FolderEntity from "../../model/entity/folder/folderEntity";
+import FoldersCollection from "../../model/entity/folder/foldersCollection";
+import PermissionChangesCollection from "../../model/entity/permission/change/permissionChangesCollection";
+import i18n from "../../sdk/i18n";
+import ProgressService from "../../service/progress/progressService";
+import ShareModel from "../../model/share/shareModel";
 
-const {Crypto} = require('../../model/crypto');
-const {Keyring} = require('../../model/keyring');
-const {Share} = require('../../model/share');
-const {FolderEntity} = require('../../model/entity/folder/folderEntity');
-const {FoldersCollection} = require('../../model/entity/folder/foldersCollection');
-const {FolderModel} = require('../../model/folder/folderModel');
-const {ResourceModel} = require('../../model/resource/resourceModel');
-const {PermissionChangesCollection} = require('../../model/entity/permission/change/permissionChangesCollection');
-
-const passphraseController = require('../passphrase/passphraseController');
-const progressController = require('../progress/progressController');
 
 class MoveFolderController {
   /**
@@ -32,15 +30,16 @@ class MoveFolderController {
    *
    * @param {Worker} worker
    * @param {string} requestId
-   * @param {ApiClientOptions} clientOptions
+   * @param {ApiClientOptions} apiClientOptions the api client options
+   * @param {AccountEntity} account the account associated to the worker
    */
-  constructor(worker, requestId, clientOptions) {
+  constructor(worker, requestId, apiClientOptions, account) {
     this.worker = worker;
     this.requestId = requestId;
-    this.folderModel = new FolderModel(clientOptions);
-    this.resourceModel = new ResourceModel(clientOptions);
+    this.folderModel = new FolderModel(apiClientOptions);
+    this.resourceModel = new ResourceModel(apiClientOptions, account);
+    this.shareModel = new ShareModel(apiClientOptions);
     this.keyring = new Keyring();
-    this.crypto = new Crypto();
 
     // Work variables
     this.folderId = null;
@@ -58,6 +57,9 @@ class MoveFolderController {
 
     this.passphrase = null;
     this.privateKey = null;
+
+    this.progressService = new ProgressService(this.worker, i18n.t('Moving folder'));
+    this.getPassphraseService = new GetPassphraseService(account);
   }
 
   /**
@@ -70,23 +72,23 @@ class MoveFolderController {
 
     try {
       await this.getPassphrase();
-    } catch(error) {
+    } catch (error) {
       this.cleanup();
       throw error;
     }
     try {
-      await progressController.open(this.worker, __('Moving folder'), 1, __('Initializing...'));
       await this.findAllForShare();
-      await this.setGoals();
+      this.progressService.start(this.getGoals(), i18n.t('Initializing ...'));
+      await this.progressService.finishStep(i18n.t('Calculating changes...'), true);
       await this.calculateChanges();
       await this.share();
       await this.move();
-      await progressController.update(this.worker, this.goals, __('Done'));
-      await progressController.close(this.worker);
-      this.cleanup()
-    } catch(error) {
-      await progressController.close(this.worker);
-      this.cleanup()
+      await this.progressService.finishStep(i18n.t('Done'), true);
+      await this.progressService.close();
+      this.cleanup();
+    } catch (error) {
+      await this.progressService.close();
+      this.cleanup();
       throw error;
     }
   }
@@ -102,10 +104,10 @@ class MoveFolderController {
     if (folderId) {
       await this.folderModel.assertFolderExists(folderId);
     } else {
-      throw new Error(__('Could not move, expecting a folder to be provided.'));
+      throw new Error(i18n.t('Could not move, expecting a folder to be provided.'));
     }
     if (folderId === destinationFolderId) {
-      throw new Error(__('The folder cannot be moved inside itself.'));
+      throw new Error(i18n.t('The folder cannot be moved inside itself.'));
     }
     this.destinationFolderId = destinationFolderId;
     this.folderId = folderId;
@@ -116,10 +118,12 @@ class MoveFolderController {
    * @returns {Promise<void>}
    */
   async getPassphrase() {
-    // Get the passphrase if needed and decrypt secret key
-    // We do this to confirm the move even if there is nothing to decrypt/re-encrypt
-    const passphrase = await passphraseController.get(this.worker);
-    this.privateKey = await this.crypto.getAndDecryptPrivateKey(passphrase);
+    /*
+     * Get the passphrase if needed and decrypt secret key
+     * We do this to confirm the move even if there is nothing to decrypt/re-encrypt
+     */
+    const passphrase = await this.getPassphraseService.getPassphrase(this.worker);
+    this.privateKey = await GetDecryptedUserPrivateKeyService.getKey(passphrase);
   }
 
   /**
@@ -137,8 +141,10 @@ class MoveFolderController {
     }
     this.assertFolderCanBeMoved();
 
-    // Get all folders contained in this folder
-    // and get all the resources contain in this folder and subfolders
+    /*
+     * Get all folders contained in this folder
+     * and get all the resources contain in this folder and subfolders
+     */
     this.subFolders = await this.folderModel.getAllChildren([this.folder.id]);
     this.resources = await this.resourceModel.getAllByParentIds([this.folder.id, ...this.subFolders.ids]);
 
@@ -161,37 +167,38 @@ class MoveFolderController {
    */
   assertFolderCanBeMoved() {
     if (this.folder.folderParentId === this.destinationFolderId) {
-      throw new Error(`Folder ${this.folder.name} is already in folder ${this.destinationFolder.name}.`);
+      const message = i18n.t('Folder {{name}} is already in folder {{destination}}.', {name: this.folder.name, destination: this.destinationFolder.name});
+      throw new Error(message);
     }
     if (!FolderEntity.canFolderMove(this.folder, this.parentFolder, this.destinationFolder)) {
-      throw new Error(`Folder ${this.folder.name} can not be moved.`);
+      const message = i18n.t('Folder {{name}} can not be moved.', {name: this.folder.name});
+      throw new Error(message);
     }
   }
 
   /**
    * Set goals and init progress counter
-   * @returns {Promise<void>}
+   * @returns {number}
    */
-  async setGoals() {
-    // calculate changes for folder + subfolders + resources
-    // init + move + (folders to update * 2) + (resources to update * get secret, decrypt, encrypt, share) + sync keyring
-    this.goals = 3 + (this.subFolders.length * 2) + (this.resources.length * 4);
-    this.progress = 0;
-    await progressController.updateGoals(this.worker, this.goals);
-    await progressController.update(this.worker, this.progress++, __('Calculating changes...'));
+  getGoals() {
+    /*
+     * calculate changes for folder + subfolders + resources
+     * init + move + (folders to update * 2) + (resources to update * get secret, decrypt, encrypt, share) + sync keyring
+     */
+    return 3 + (this.subFolders.length * 2) + (this.resources.length * 4);
   }
 
   /**
    * Build changes to be used in bulk share
-   * @returns {Promise<void>}
    */
   async calculateChanges() {
-    await progressController.update(this.worker, this.progress++, `Calculating changes for ${this.folder.name}`);
-
-    // When a shared folder is moved, we do not change permissions when:
-    // - move is from the root to a personal folder
-    // - move is from a personal folder to a personal folder;
-    // - move is from a personal folder to the root.
+    await this.progressService.finishStep(i18n.t('Calculating changes for {{name}}', {name: this.folder.name}));
+    /*
+     * When a shared folder is moved, we do not change permissions when:
+     * - move is from the root to a personal folder
+     * - move is from a personal folder to a personal folder;
+     * - move is from a personal folder to the root.
+     */
     if (this.folder.isShared()
       && (this.destinationFolderId === null || this.destinationFolder.isPersonal())
       && (this.folder.folderParentId === null || this.parentFolder.isPersonal())) {
@@ -201,23 +208,23 @@ class MoveFolderController {
     // Calculate permission changes for current folder
     if (this.folder.permission.isOwner()) {
       this.foldersChanges.merge(
-        await this.folderModel.calculatePermissionsChangesForMove(
+        this.folderModel.calculatePermissionsChangesForMove(
           this.folder, this.parentFolder, this.destinationFolder
-      ));
+        ));
     }
     // Add the ones for the sub folders
-    for (let subfolder of this.subFolders) {
+    for (const subfolder of this.subFolders) {
       if (subfolder.permission.isOwner()) {
         this.foldersChanges.merge(
-          await this.folderModel.calculatePermissionsChangesForMove(
+          this.folderModel.calculatePermissionsChangesForMove(
             subfolder, this.parentFolder, this.destinationFolder
-        ));
+          ));
       }
     }
     // And for the resources
-    for (let resource of this.resources) {
+    for (const resource of this.resources) {
       if (resource.permission.isOwner()) {
-        this.resourcesChanges.merge(await this.resourceModel.calculatePermissionsChangesForMove(
+        this.resourcesChanges.merge(this.resourceModel.calculatePermissionsChangesForMove(
           resource, this.parentFolder, this.destinationFolder
         ));
       }
@@ -230,8 +237,10 @@ class MoveFolderController {
    */
   async share() {
     if (this.foldersChanges.length || this.resourcesChanges.length) {
-      // Some permission changes are possible, ask user what strategy to adopt
-      // This also serves as a confirmation prior to a typically sensitive operation
+      /*
+       * Some permission changes are possible, ask user what strategy to adopt
+       * This also serves as a confirmation prior to a typically sensitive operation
+       */
       const strategy = await this.worker.port.request('passbolt.folders.move-strategy.request', this.destinationFolderId, [this.folderId], []);
       if (strategy.moveOption === 'keep') {
         return;
@@ -240,21 +249,21 @@ class MoveFolderController {
 
     // Update folders permissions
     if (this.foldersChanges.length) {
-      let folders = new FoldersCollection([this.folder]);
+      const folders = new FoldersCollection([this.folder]);
       folders.merge(this.subFolders);
-      await Share.bulkShareFolders(folders, this.foldersChanges, this.folderModel,  async message => {
-        await progressController.update(this.worker, this.progress++, message);
+      await this.shareModel.bulkShareFolders(folders, this.foldersChanges,  async message => {
+        await this.progressService.finishStep(message);
       });
     }
 
     // Share resources
     if (this.resourcesChanges.length) {
-      let resourcesDto = this.resources.toDto({secrets:true});
-      let changesDto = this.resourcesChanges.toDto();
-      await progressController.update(this.worker, this.progress++, __('Synchronizing keys'));
+      const resourcesDto = this.resources.toDto({secrets: true});
+      const changesDto = this.resourcesChanges.toDto();
+      await this.progressService.finishStep(i18n.t('Synchronizing keys'), true);
       await this.keyring.sync();
-      await Share.bulkShareResources(resourcesDto, changesDto, this.privateKey, async message => {
-        await progressController.update(this.worker, this.progress++, message);
+      await this.shareModel.bulkShareResources(resourcesDto, changesDto, this.privateKey, async message => {
+        await this.progressService.finishStep(message);
       });
       await this.resourceModel.updateLocalStorage();
     }
@@ -265,7 +274,7 @@ class MoveFolderController {
    * @returns {Promise<void>}
    */
   async move() {
-    await progressController.update(this.worker, this.progress++, `Moving ${this.folder.name}`);
+    await this.progressService.finishStep(i18n.t('Moving {{name}}', {name: this.folder.name}));
     await this.folderModel.move(this.folder.id, this.destinationFolderId);
   }
 
@@ -278,4 +287,4 @@ class MoveFolderController {
   }
 }
 
-exports.MoveFolderController = MoveFolderController;
+export default MoveFolderController;