passbolt-browser-extension 5.12.1 → 5.13.0

package/src/all/background_page/event/keyringEvents.js

@@ -11,6 +11,7 @@ import GetKeyInfoController from "../controller/crypto/getKeyInfoController";
 import DownloadUserPublicKeyController from "../controller/crypto/downloadUserPublicKeyController";
 import DownloadUserPrivateKeyController from "../controller/crypto/downloadUserPrivateKeyController";
 import GetUserPrivateKeyController from "../controller/crypto/getUserPrivateKeyController";
+import SynchroniseKeyringController from "../controller/keyring/synchroniseKeyringController";
 
 const listen = function (worker, _, account) {
   /*
@@ -61,6 +62,17 @@ const listen = function (worker, _, account) {
     await controller._exec(passphrase);
   });
 
+  /*
+   * Synchronise the keyring with the API.
+   *
+   * @listens passbolt.keyring.sync
+   * @param requestId {uuid} The request identifier
+   */
+  worker.port.on("passbolt.keyring.sync", async (requestId) => {
+    const controller = new SynchroniseKeyringController(worker, requestId);
+    await controller._exec();
+  });
+
   /*
    * ==================================================================================
    *  Backups key events

package/src/all/background_page/event/shareEvents.js

@@ -12,10 +12,10 @@
  * @since         1.0.0
  */
 
-import FolderModel from "../model/folder/folderModel";
 import ShareResourcesController from "../controller/share/shareResourcesController";
 import ShareOneFolderController from "../controller/share/shareOneFolderController";
 import SearchUsersAndGroupsController from "../controller/share/searchUsersAndGroupsController";
+import FindFoldersForShareController from "../controller/share/findFoldersForShareController";
 
 /**
  * Listens the share events
@@ -30,14 +30,8 @@ const listen = function (worker, apiClientOptions, account) {
    * @param {array} foldersIds The ids of the folders to retrieve.
    */
   worker.port.on("passbolt.share.get-folders", async (requestId, foldersIds) => {
-    try {
-      const folderModel = new FolderModel(apiClientOptions, account);
-      const foldersCollection = await folderModel.findAllForShare(foldersIds);
-      worker.port.emit(requestId, "SUCCESS", foldersCollection);
-    } catch (error) {
-      console.error(error);
-      worker.port.emit(requestId, "ERROR", error);
-    }
+    const controller = new FindFoldersForShareController(worker, requestId, apiClientOptions);
+    await controller._exec(foldersIds);
   });
 
   /*

package/src/all/background_page/event/userEvents.js

@@ -14,6 +14,7 @@ import SecurityTokenEntity from "../model/entity/securityToken/securityTokenEnti
 import AvatarUpdateEntity from "../model/entity/avatar/update/avatarUpdateEntity";
 import UpdateUserLocalStorageController from "../controller/user/updateUserLocalStorageController";
 import GetOrFindLoggedInUserController from "../controller/user/getOrFindLoggedInUserController";
+import GetOrFindUsersController from "../controller/user/getOrFindUsersController";
 import UpdateUserController from "../controller/user/updateUserController";
 import DeleteDryRunUserController from "../controller/user/deleteDryRunUserController";
 import DeleteUserController from "../controller/user/deleteUserController";
@@ -46,6 +47,18 @@ const listen = function (worker, apiClientOptions, account) {
     }
   });
 
+  /*
+   * Find users by their ids.
+   *
+   * @listens passbolt.users.get-by-ids
+   * @param {uuid} requestId The request identifier
+   * @param {Array<uuid>} userIds The ids of the users to retrieve
+   */
+  worker.port.on("passbolt.users.get-by-ids", async (requestId, userIds) => {
+    const controller = new GetOrFindUsersController(worker, requestId, apiClientOptions, account);
+    controller._exec(userIds);
+  });
+
   /*
    * ==================================================================================
    *  CRUD

package/src/all/background_page/model/config.js

@@ -1,14 +1,24 @@
 /**
  * Config model.
  *
+ * Build-time keys (debug, log.*) are injected by webpack's EnvironmentPlugin
+ * (see webpack/passboltEnvPlugin.js). Other keys (user.*) are runtime-only and
+ * persisted in local storage.
+ *
  * @copyright (c) 2017 Passbolt SARL
  * @licence GNU Affero General Public License http://www.gnu.org/licenses/agpl-3.0.en.html
  */
+import storage from "../sdk/storage";
 
-import _config from "../config/config.json";
+const _config = {
+  debug: process.env.PASSBOLT_DEBUG === "true",
+  log: {
+    level: Number.parseInt(process.env.PASSBOLT_LOG_LEVEL, 10) || 0,
+    console: process.env.PASSBOLT_LOG_CONSOLE === "true",
+  },
+};
 
 const defaultConfig = { ..._config };
-import storage from "../sdk/storage";
 
 /**
  * Init the configuration.

package/src/all/background_page/model/entity/folder/folderEntity.js

@@ -13,8 +13,8 @@
  */
 import EntitySchema from "passbolt-styleguide/src/shared/models/entity/abstract/entitySchema";
 import EntityValidationError from "passbolt-styleguide/src/shared/models/entity/abstract/entityValidationError";
-import PermissionEntity from "../permission/permissionEntity";
-import PermissionsCollection from "../permission/permissionsCollection";
+import PermissionEntity from "passbolt-styleguide/src/shared/models/entity/permission/permissionEntity";
+import PermissionsCollection from "passbolt-styleguide/src/shared/models/entity/permission/permissionsCollection";
 import EntityV2 from "passbolt-styleguide/src/shared/models/entity/abstract/entityV2";
 import UserEntity from "../user/userEntity";
 

package/src/all/background_page/model/entity/folder/folderEntity.test.js

@@ -14,7 +14,7 @@
 import FolderEntity from "./folderEntity";
 import EntityValidationError from "passbolt-styleguide/src/shared/models/entity/abstract/entityValidationError";
 import EntitySchema from "passbolt-styleguide/src/shared/models/entity/abstract/entitySchema";
-import PermissionEntity from "../permission/permissionEntity";
+import PermissionEntity from "passbolt-styleguide/src/shared/models/entity/permission/permissionEntity";
 import {
   defaultFolderDto,
   folderWithReadPermissionDto,
@@ -22,7 +22,7 @@ import {
   minimalFolderDto,
 } from "passbolt-styleguide/src/shared/models/entity/folder/folderEntity.test.data";
 import { ownerPermissionDto } from "passbolt-styleguide/src/shared/models/entity/permission/permissionEntity.test.data";
-import PermissionsCollection from "../permission/permissionsCollection";
+import PermissionsCollection from "passbolt-styleguide/src/shared/models/entity/permission/permissionsCollection";
 import * as assertEntityProperty from "passbolt-styleguide/test/assert/assertEntityProperty";
 import UserEntity from "../user/userEntity";
 

package/src/all/background_page/model/entity/folder/foldersCollection.test.js

@@ -21,7 +21,7 @@ import {
   updatePermissionDto,
 } from "passbolt-styleguide/src/shared/models/entity/permission/permissionEntity.test.data";
 import { v4 as uuidv4 } from "uuid";
-import PermissionEntity from "../permission/permissionEntity";
+import PermissionEntity from "passbolt-styleguide/src/shared/models/entity/permission/permissionEntity";
 
 describe("Folders collection entity", () => {
   it("schema must validate", () => {

package/src/all/background_page/model/entity/group/update/groupUpdateEntity.js

@@ -10,7 +10,7 @@
  * @license       https://opensource.org/licenses/AGPL-3.0 AGPL License
  * @link          https://www.passbolt.com Passbolt(tm)
  */
-import GroupEntity from "../groupEntity";
+import GroupEntity from "passbolt-styleguide/src/shared/models/entity/group/groupEntity";
 import Entity from "passbolt-styleguide/src/shared/models/entity/abstract/entity";
 import GroupUpdateSecretsCollection from "../../secret/groupUpdate/groupUpdateSecretsCollection";
 import GroupUserChangesCollection from "../../groupUser/change/groupUserChangesCollection";

package/src/all/background_page/model/entity/group/update/groupUpdateEntity.test.js

@@ -12,7 +12,7 @@
  */
 import EntityValidationError from "passbolt-styleguide/src/shared/models/entity/abstract/entityValidationError";
 import GroupUpdateEntity from "./groupUpdateEntity";
-import GroupEntity from "../groupEntity";
+import GroupEntity from "passbolt-styleguide/src/shared/models/entity/group/groupEntity";
 import EntitySchema from "passbolt-styleguide/src/shared/models/entity/abstract/entitySchema";
 
 describe("Group update entity", () => {

package/src/all/background_page/model/entity/permission/actionLog/updatedPermissionEntity.js

@@ -10,8 +10,8 @@
  * @license       https://opensource.org/licenses/AGPL-3.0 AGPL License
  * @link          https://www.passbolt.com Passbolt(tm)
  */
-import GroupEntity from "../../group/groupEntity";
-import PermissionEntity from "../permissionEntity";
+import GroupEntity from "passbolt-styleguide/src/shared/models/entity/group/groupEntity";
+import PermissionEntity from "passbolt-styleguide/src/shared/models/entity/permission/permissionEntity";
 import Entity from "passbolt-styleguide/src/shared/models/entity/abstract/entity";
 import LoggedUserEntity from "../../user/actionLog/loggedUserEntity";
 import EntitySchema from "passbolt-styleguide/src/shared/models/entity/abstract/entitySchema";

package/src/all/background_page/model/entity/permission/actionLog/updatedPermissionEntity.test.data.js

@@ -12,7 +12,7 @@
  * @since         5.4.0
  */
 import { defaultUserDto } from "passbolt-styleguide/src/shared/models/entity/user/userEntity.test.data";
-import PermissionEntity from "../permissionEntity";
+import PermissionEntity from "passbolt-styleguide/src/shared/models/entity/permission/permissionEntity";
 import { v4 as uuidv4 } from "uuid";
 
 export const defaultUpdatePermissionDto = (data) => ({

package/src/all/background_page/model/entity/permission/change/permissionChangeEntity.js

@@ -11,7 +11,7 @@
  * @link          https://www.passbolt.com Passbolt(tm)
  * @since         2.13.0
  */
-import PermissionEntity from "../permissionEntity";
+import PermissionEntity from "passbolt-styleguide/src/shared/models/entity/permission/permissionEntity";
 import Entity from "passbolt-styleguide/src/shared/models/entity/abstract/entity";
 import EntitySchema from "passbolt-styleguide/src/shared/models/entity/abstract/entitySchema";
 

package/src/all/background_page/model/entity/permission/change/permissionChangesCollection.js

@@ -11,8 +11,8 @@
  * @link          https://www.passbolt.com Passbolt(tm)
  * @since         2.13.0
  */
-import PermissionEntity from "../permissionEntity";
-import PermissionsCollection from "../permissionsCollection";
+import PermissionEntity from "passbolt-styleguide/src/shared/models/entity/permission/permissionEntity";
+import PermissionsCollection from "passbolt-styleguide/src/shared/models/entity/permission/permissionsCollection";
 import PermissionChangeEntity from "./permissionChangeEntity";
 import EntityCollection from "passbolt-styleguide/src/shared/models/entity/abstract/entityCollection";
 import EntitySchema from "passbolt-styleguide/src/shared/models/entity/abstract/entitySchema";

package/src/all/background_page/model/entity/permission/change/permissionChangesCollection.test.js

@@ -13,8 +13,8 @@
  */
 import PermissionChangesCollection from "./permissionChangesCollection";
 import EntitySchema from "passbolt-styleguide/src/shared/models/entity/abstract/entitySchema";
-import PermissionEntity from "../permissionEntity";
-import PermissionsCollection from "../permissionsCollection";
+import PermissionEntity from "passbolt-styleguide/src/shared/models/entity/permission/permissionEntity";
+import PermissionsCollection from "passbolt-styleguide/src/shared/models/entity/permission/permissionsCollection";
 
 describe("PermissionChangesCollection", () => {
   it("schema must validate", () => {

package/src/all/background_page/model/entity/resource/resourceEntity.js

@@ -11,8 +11,8 @@
  * @link          https://www.passbolt.com Passbolt(tm)
  * @since         2.13.0
  */
-import PermissionEntity from "../permission/permissionEntity";
-import PermissionsCollection from "../permission/permissionsCollection";
+import PermissionEntity from "passbolt-styleguide/src/shared/models/entity/permission/permissionEntity";
+import PermissionsCollection from "passbolt-styleguide/src/shared/models/entity/permission/permissionsCollection";
 import FavoriteEntity from "../favorite/favoriteEntity";
 import ResourceTypeEntity from "passbolt-styleguide/src/shared/models/entity/resourceType/resourceTypeEntity";
 import TagsCollection from "../tag/tagsCollection";

package/src/all/background_page/model/entity/resource/resourceEntity.test.js

@@ -24,7 +24,7 @@ import { defaultResourceMetadataDto } from "passbolt-styleguide/src/shared/model
 import ResourceMetadataEntity from "passbolt-styleguide/src/shared/models/entity/resource/metadata/resourceMetadataEntity";
 import { v4 as uuidv4 } from "uuid";
 import { metadata } from "passbolt-styleguide/test/fixture/encryptedMetadata/metadata";
-import PermissionEntity from "../permission/permissionEntity";
+import PermissionEntity from "passbolt-styleguide/src/shared/models/entity/permission/permissionEntity";
 
 describe("Resource entity", () => {
   describe("ResourceEntity::getSchema", () => {

package/src/all/background_page/model/entity/user/userEntity.js

@@ -11,389 +11,28 @@
  * @link          https://www.passbolt.com Passbolt(tm)
  * @since         2.13.0
  */
-import EntityV2 from "passbolt-styleguide/src/shared/models/entity/abstract/entityV2";
-import RoleEntity from "passbolt-styleguide/src/shared/models/entity/role/roleEntity";
-import PendingAccountRecoveryRequestEntity from "passbolt-styleguide/src/shared/models/entity/accountRecovery/pendingAccountRecoveryRequestEntity";
-import GpgkeyEntity from "passbolt-styleguide/src/shared/models/entity/gpgkey/gpgkeyEntity";
-import ProfileEntity from "passbolt-styleguide/src/shared/models/entity/profile/profileEntity";
-import GroupsUsersCollection from "passbolt-styleguide/src/shared/models/entity/groupUser/groupsUsersCollection";
-import AccountRecoveryUserSettingEntity from "passbolt-styleguide/src/shared/models/entity/accountRecovery/accountRecoveryUserSettingEntity";
+import UserEntity from "passbolt-styleguide/src/shared/models/entity/user/userEntity";
 import AppEmailValidatorService from "../../../service/validator/appEmailValidatorService";
 
-const ENTITY_NAME = "User";
-
-class UserEntity extends EntityV2 {
-  /**
-   * @inheritDoc
-   */
-  constructor(dto, options = {}) {
-    super(dto, options);
-
-    // Associations
-    if (this._props.profile) {
-      this._profile = new ProfileEntity(this._props.profile, { ...options, clone: false });
-      delete this._props.profile;
-    }
-    if (this._props.role) {
-      this._role = new RoleEntity(this._props.role, { ...options, clone: false });
-      delete this._props.role;
-    }
-    if (this._props.gpgkey) {
-      this._gpgkey = new GpgkeyEntity(this._props.gpgkey, { ...options, clone: false });
-      delete this._props.gpgkey;
-    }
-    if (this._props.groups_users) {
-      this._groups_users = new GroupsUsersCollection(this._props.groups_users, { ...options, clone: false });
-      delete this._props.groups_users;
-    }
-    if (this._props.account_recovery_user_setting) {
-      this._account_recovery_user_setting = new AccountRecoveryUserSettingEntity(
-        this._props.account_recovery_user_setting,
-        { ...options, clone: false },
-      );
-      delete this._props.account_recovery_user_setting;
-    }
-    if (this._props.pending_account_recovery_request) {
-      this._pending_account_recovery_request = new PendingAccountRecoveryRequestEntity(
-        this._props.pending_account_recovery_request,
-        { ...options, clone: false },
-      );
-      delete this._props.pending_account_recovery_request;
-    }
-  }
-
+/**
+ * Browser-extension flavour of UserEntity.
+ *
+ * Injects the application email validator on the `username` schema property. The validator
+ * depends on OrganizationSettingsModel, a bext-only static cache that cannot be hosted in
+ * the styleguide. All other behaviour (associations, marshalling, serialization, getters)
+ * is inherited from the styleguide source of truth.
+ */
+class BextUserEntity extends UserEntity {
   /**
    * @inheritDoc
-   * Marshall the last_logged_in to null if empty string given
-   */
-  marshall() {
-    if (this._props.last_logged_in === "") {
-      this._props.last_logged_in = null;
-    }
-    super.marshall();
-  }
-
-  /**
-   * Get user entity schema
-   * @returns {Object} schema
+   * Override the schema to attach the custom email validator on `username`.
+   * `super.getSchema()` returns a fresh object literal each call, so mutating is safe.
    */
   static getSchema() {
-    return {
-      type: "object",
-      required: [
-        "username",
-        // "role_id",
-      ],
-      properties: {
-        id: {
-          type: "string",
-          format: "uuid",
-        },
-        role_id: {
-          type: "string",
-          format: "uuid",
-        },
-        username: {
-          type: "string",
-          custom: AppEmailValidatorService.validate,
-        },
-        active: {
-          type: "boolean",
-        },
-        deleted: {
-          type: "boolean",
-        },
-        disabled: {
-          type: "string",
-          format: "date-time",
-          nullable: true,
-        },
-        missing_metadata_key_ids: {
-          type: "array",
-          items: {
-            type: "string",
-            format: "uuid",
-          },
-        },
-        created: {
-          type: "string",
-          format: "date-time",
-        },
-        modified: {
-          type: "string",
-          format: "date-time",
-        },
-        last_logged_in: {
-          type: "string",
-          format: "date-time",
-          nullable: true,
-        },
-        is_mfa_enabled: {
-          type: "boolean",
-          nullable: true,
-        },
-        locale: {
-          type: "string",
-          pattern: /^[a-z]{2}-[A-Z]{2}$/,
-          nullable: true,
-        },
-        // Associated models
-        role: RoleEntity.getSchema(),
-        profile: ProfileEntity.getSchema(),
-        gpgkey: GpgkeyEntity.getSchema(),
-        groups_users: GroupsUsersCollection.getSchema(),
-        account_recovery_user_setting: AccountRecoveryUserSettingEntity.getSchema(),
-        pending_account_recovery_request: PendingAccountRecoveryRequestEntity.getSchema(),
-      },
-    };
-  }
-
-  /*
-   * ==================================================
-   * Serialization
-   * ==================================================
-   */
-  /**
-   * Return a DTO ready to be sent to API
-   * @param {object} [contain] optional for example {profile: {avatar:true}}
-   * @returns {*}
-   */
-  toDto(contain) {
-    const result = Object.assign({}, this._props);
-    if (!contain) {
-      return result;
-    }
-    if (this.role && contain.role) {
-      result.role = this.role.toDto();
-    }
-    if (this.profile && contain.profile) {
-      if (contain.profile === true) {
-        result.profile = this.profile.toDto();
-      } else {
-        result.profile = this.profile.toDto(contain.profile);
-      }
-    }
-    if (this.gpgkey && contain.gpgkey) {
-      result.gpgkey = this.gpgkey.toDto();
-    }
-    if (this.groupsUsers && contain.groups_users) {
-      result.groups_users = this.groupsUsers.toDto();
-    }
-    if (this.accountRecoveryUserSetting && contain.account_recovery_user_setting) {
-      result.account_recovery_user_setting = this.accountRecoveryUserSetting.toDto();
-    }
-    if (this.pendingAccountRecoveryUserRequest && contain.pending_account_recovery_request) {
-      result.pending_account_recovery_request = this.pendingAccountRecoveryUserRequest.toDto();
-    }
-    return result;
-  }
-
-  /**
-   * Customizes JSON stringification behavior
-   * @returns {*}
-   */
-  toJSON() {
-    return this.toDto(UserEntity.ALL_CONTAIN_OPTIONS);
-  }
-
-  /*
-   * ==================================================
-   * Dynamic properties getters
-   * ==================================================
-   */
-  /**
-   * Get user id
-   * @returns {(string|null)} uuid
-   */
-  get id() {
-    return this._props.id || null;
-  }
-
-  /**
-   * Get user role id
-   * @returns {(string|null)} uuid
-   */
-  get roleId() {
-    return this._props.role_id || null;
-  }
-
-  /**
-   * Get user username
-   * @returns {string} email
-   */
-  get username() {
-    return this._props.username;
-  }
-
-  /**
-   * Get user activation status
-   * @returns {(boolean|null)} true if user completed the setup
-   */
-  get isActive() {
-    if (typeof this._props.active === "undefined") {
-      return null;
-    }
-    return this._props.active;
-  }
-
-  /**
-   * Get user deleted status
-   * @returns {(boolean|null)} true if user is deleted
-   */
-  get isDeleted() {
-    if (typeof this._props.deleted === "undefined") {
-      return null;
-    }
-    return this._props.deleted;
-  }
-
-  /**
-   * Get missing metadata keys ids for a user
-   * @returns {(array)} the list of missing metadata keys
-   */
-  get missingMetadataKeysIds() {
-    return this._props.missing_metadata_key_ids || [];
-  }
-
-  /**
-   * Get user creation date
-   * @returns {(string|null)} date
-   */
-  get created() {
-    return this._props.created || null;
-  }
-
-  /**
-   * Get user modification date
-   * @returns {(string|null)} date
-   */
-  get modified() {
-    return this._props.modified || null;
-  }
-
-  /**
-   * Get user last login date
-   * @returns {(string|null)} date
-   */
-  get lastLoggedIn() {
-    return this._props.last_logged_in || null;
-  }
-
-  /**
-   * Get mfa enabled flag
-   * @returns {(boolean|null)} true if mfa is enabled
-   */
-  get isMfaEnabled() {
-    if (typeof this._props.is_mfa_enabled === "undefined") {
-      return null;
-    }
-    return this._props.is_mfa_enabled;
-  }
-
-  /**
-   * Get the user locale.
-   * @returns {(string|null)}
-   */
-  get locale() {
-    return this._props.locale || null;
-  }
-
-  /**
-   * Set the user locale
-   * @params {string} locale The locale to set
-   */
-  set locale(locale) {
-    this._props.locale = locale;
-  }
-
-  /**
-   * Set the user missing metadata keys ids
-   * @params {array} the missing metadata keys ids
-   */
-  set missingMetadataKeysIds(missingMetadataKeysIds) {
-    this._props.missing_metadata_key_ids = missingMetadataKeysIds;
-  }
-
-  /**
-   * UserEntity.ALL_CONTAIN_OPTIONS
-   * @returns {object} all contain options that can be used in toDto()
-   */
-  static get ALL_CONTAIN_OPTIONS() {
-    return {
-      profile: ProfileEntity.ALL_CONTAIN_OPTIONS,
-      role: true,
-      gpgkey: true,
-      groups_users: true,
-      account_recovery_user_setting: true,
-      pending_account_recovery_request: true,
-    };
-  }
-
-  /*
-   * ==================================================
-   * Static properties getters
-   * ==================================================
-   */
-  /**
-   * ProfileEntity.ENTITY_NAME
-   * @returns {string}
-   */
-  static get ENTITY_NAME() {
-    return ENTITY_NAME;
-  }
-
-  /*
-   * ==================================================
-   * Associated properties getters
-   * ==================================================
-   */
-  /**
-   * Get user profile
-   * @returns {(ProfileEntity|null)} profile
-   */
-  get profile() {
-    return this._profile || null;
-  }
-
-  /**
-   * Get user role
-   * @returns {(RoleEntity|null)} role
-   */
-  get role() {
-    return this._role || null;
-  }
-
-  /**
-   * Get user gpgkey
-   * @returns {(GpgkeyEntity|null)} key
-   */
-  get gpgkey() {
-    return this._gpgkey || null;
-  }
-
-  /**
-   * Get user groups
-   * @returns {(GroupsUsersCollection|null)} users groups
-   */
-  get groupsUsers() {
-    return this._groups_users || null;
-  }
-
-  /**
-   * Get user account recover setting
-   * @returns {(AccountRecoveryUserSettingEntity|null)} account recover setting
-   */
-  get accountRecoveryUserSetting() {
-    return this._account_recovery_user_setting || null;
-  }
-
-  /**
-   * Get the pending account recovery request
-   * @returns {AccountRecoveryRequestEntity|null} pending account recovery request
-   */
-  get pendingAccountRecoveryUserRequest() {
-    return this._pending_account_recovery_request || null;
+    const schema = super.getSchema();
+    schema.properties.username.custom = AppEmailValidatorService.validate;
+    return schema;
   }
 }
 
-export default UserEntity;
+export default BextUserEntity;