passbolt-browser-extension 3.0.6 → 4.6.2

package/src/all/background_page/model/import/resourcesImportParser.js

@@ -10,10 +10,10 @@
  * @license       https://opensource.org/licenses/AGPL-3.0 AGPL License
  * @link          https://www.passbolt.com Passbolt(tm)
  */
-const {FileTypeError} = require("../../error/fileTypeError");
-const {ImportResourcesFileEntity} = require("../entity/import/importResourcesFileEntity");
-const {ResourcesKdbxImportParser} = require("./resources/resourcesKdbxImportParser");
-const {ResourcesCsvImportParser} = require("./resources/resourcesCsvImportParser");
+import ImportResourcesFileEntity from "../entity/import/importResourcesFileEntity";
+import ResourcesKdbxImportParser from "./resources/resourcesKdbxImportParser";
+import ResourcesCsvImportParser from "./resources/resourcesCsvImportParser";
+import FileTypeError from "../../error/fileTypeError";
 
 class ResourcesImportParser {
   /**
@@ -24,7 +24,7 @@ class ResourcesImportParser {
    */
   parseImport(importResourcesEntity, resourceTypesCollection) {
     const Parser = this.getParser(importResourcesEntity);
-    const parser = new Parser(importResourcesEntity, resourceTypesCollection)
+    const parser = new Parser(importResourcesEntity, resourceTypesCollection);
     return parser.parseImport();
   }
 
@@ -46,4 +46,4 @@ class ResourcesImportParser {
   }
 }
 
-exports.ResourcesImportParser = ResourcesImportParser;
+export default ResourcesImportParser;

package/src/all/background_page/model/import/resourcesImportParser.test.js

@@ -1,5 +1,5 @@
 /**
- * @jest-environment ./.jest.custom-kdbx-environment
+ * @jest-environment ./test/jest.custom-kdbx-environment
  */
 /**
  * Passbolt ~ Open source password manager for teams
@@ -14,23 +14,13 @@
  * @link          https://www.passbolt.com Passbolt(tm)
  */
 import fs from "fs";
-import Validator from "validator";
-import PapaParse from "papaparse";
-import kdbxweb from "kdbxweb/dist/kdbxweb";
-import {ResourcesImportParser} from "./resourcesImportParser";
-import {ImportResourcesFileEntity} from "../entity/import/importResourcesFileEntity";
-import {ResourcesCsvImportParser} from "./resources/resourcesCsvImportParser";
+import ResourcesImportParser from "./resourcesImportParser";
+import ImportResourcesFileEntity from "../entity/import/importResourcesFileEntity";
+import ResourcesCsvImportParser from "./resources/resourcesCsvImportParser";
 
-// Reset the modules before each test.
-beforeEach(() => {
-  global.Validator = Validator;
-  global.PapaParse = PapaParse;
-  global.kdbxweb = kdbxweb;
-  jest.resetModules();
-});
 
 describe("ResourcesImportParser", () => {
-  it("should be able to parse CSV file", async () => {
+  it("should be able to parse CSV file", async() => {
     const file = "VGl0bGUsVXNlcm5hbWUsVVJMLFBhc3N3b3JkLE5vdGVzLEdyb3VwClBhc3N3b3JkIDEsdXNlcm5hbWUxLGh0dHBzOi8vdXJsMS5jb20sU2VjcmV0IDEsRGVzY3JpcHRpb24gMSxGb2xkZXIgMS9Gb2xkZXIgMgpQYXNzd29yZCAyLHVzZXJuYW1lMixodHRwczovL3VybDIuY29tLFNlY3JldCAyLERlc2NyaXB0aW9uIDIsRm9sZGVyIDEKUGFzc3dvcmQgMyx1c2VybmFtZTMsaHR0cHM6Ly91cmwzLmNvbSxTZWNyZXQgMyxEZXNjcmlwdGlvbiAzLEZvbGRlciAzL0ZvbGRlciA0ClBhc3N3b3JkIDQsdXNlcm5hbWU0LGh0dHBzOi8vdXJsNC5jb20sU2VjcmV0IDQsRGVzY3JpcHRpb24gNCxGb2xkZXIgMi9Gb2xkZXIgMQ==";
     const importDto = {
       "ref": "import-ref",
@@ -44,7 +34,7 @@ describe("ResourcesImportParser", () => {
     expect(selectedParser).toEqual(ResourcesCsvImportParser);
   });
 
-  it("should be able to parse KDBX file", async () => {
+  it("should be able to parse KDBX file", async() => {
     const file = fs.readFileSync("./src/all/background_page/model/import/resources/kdbx/kdbx-not-protected.kdbx", {encoding: 'base64'});
     const importDto = {
       "ref": "import-ref",

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

@@ -11,14 +11,13 @@
  * @link          https://www.passbolt.com Passbolt(tm)
  * @since         2.0.0
  */
-const __ = require('../sdk/l10n').get;
-const Uuid = require('../utils/uuid');
-
-const {InvalidMasterPasswordError} = require('../error/invalidMasterPasswordError');
-const {UserSettings} = require('./userSettings/userSettings');
-const {Key} = require('./key');
-
-const {goog} = require('../utils/format/emailaddress');
+import {OpenpgpAssertion} from "../utils/openpgp/openpgpAssertions";
+import {Uuid} from "../utils/uuid";
+import UserSettings from "./userSettings/userSettings";
+import ExternalGpgKeyEntity from "./entity/gpgkey/external/externalGpgKeyEntity";
+import GetGpgKeyInfoService from "../service/crypto/getGpgKeyInfoService";
+import storage from "../sdk/storage";
+import Validator from "validator";
 
 /**
  * Constants
@@ -38,40 +37,45 @@ const STORAGE_KEY_PRIVATE = 'passbolt-private-gpgkeys';
  * The class that deals with Passbolt Keyring.
  */
 class Keyring {
-  // ==================================================
-  // FINDERS
-  // ==================================================
+  /*
+   * ==================================================
+   * FINDERS
+   * ==================================================
+   */
   /**
    * Get a public key by its fingerprint.
    *
    * @param {string} userId uuid
-   * @returns {Key|undefined}
+   * @returns {ExternalGpgKeyEntity | undefined}
    */
   findPublic(userId) {
-    let i, publicKeys = this.getPublicKeysFromStorage();
+    let i;
+    const publicKeys = this.getPublicKeysFromStorage();
     for (i in publicKeys) {
-      if (publicKeys.hasOwnProperty(i) && publicKeys[i].user_id === userId) {
-        return publicKeys[i];
+      if (Object.prototype.hasOwnProperty.call(publicKeys, i) && publicKeys[i].user_id === userId) {
+        return new ExternalGpgKeyEntity(publicKeys[i]);
       }
     }
     return undefined;
-  };
+  }
 
   /**
    * Get a private key by its fingerprint.
    * We currently only support one private key per person
    *
-   * @returns {Key}
+   * @returns {ExternalGpgKeyEntity | undefined}
    */
   findPrivate() {
     const userId = Keyring.MY_KEY_ID;
     const privateKeys = this.getPrivateKeysFromStorage();
-    return privateKeys[userId];
-  };
+    return privateKeys[userId] ? new ExternalGpgKeyEntity(privateKeys[userId]) : undefined;
+  }
 
-  // ==================================================
-  // IMPORT
-  // ==================================================
+  /*
+   * ==================================================
+   * IMPORT
+   * ==================================================
+   */
   /**
    * Import a public armored key.
    *
@@ -86,33 +90,26 @@ class Keyring {
   async importPublic(armoredPublicKey, userId) {
     // Check user id
     if (typeof userId === 'undefined') {
-      throw new Error(__('The user id is undefined'));
+      throw new Error('The user id is undefined');
     }
     if (!Validator.isUUID(userId)) {
-      throw new Error(__('The user id is not valid'));
+      throw new Error('The user id is not valid');
     }
 
-    // Parse the keys. If standard format given with a text containing
-    // public/private. It will extract only the public.
+    /*
+     * Parse the keys. If standard format given with a text containing
+     * public/private. It will extract only the public.
+     */
     armoredPublicKey = this.findArmoredKeyInText(armoredPublicKey, Keyring.PUBLIC);
-
     // Is the given key a valid pgp key ?
-    const publicKey = await openpgp.key.readArmored(armoredPublicKey);
-    if (publicKey.err) {
-      throw new Error(publicKey.err[0].message);
-    }
-
-    // If the key is not public, return an error.
-    const primaryPublicKey = publicKey.keys[0];
-    if (!primaryPublicKey.isPublic()) {
-      throw new Error(__('Expected a public key but got a private key instead'));
-    }
+    const primaryPublicKey = await OpenpgpAssertion.readKeyOrFail(armoredPublicKey);
+    OpenpgpAssertion.assertPublicKey(primaryPublicKey);
 
     // Get the keyInfo.
-    let keyInfo = await this.keyInfo(armoredPublicKey);
+    const keyInfo = (await GetGpgKeyInfoService.getKeyInfo(primaryPublicKey)).toDto();
 
     // Add the key in the keyring.
-    let publicKeys = this.getPublicKeysFromStorage();
+    const publicKeys = this.getPublicKeysFromStorage();
     publicKeys[userId] = keyInfo;
     publicKeys[userId].user_id = userId;
     this.store(Keyring.PUBLIC, publicKeys);
@@ -133,33 +130,25 @@ class Keyring {
     // Flush any existing private key.
     this.flush(Keyring.PRIVATE);
 
-    // Parse the keys. If standard format given with a text containing
-    // public/private. It will extract only the private.
+    /*
+     * Parse the keys. If standard format given with a text containing
+     * public/private. It will extract only the private.
+     */
     armoredKey = this.findArmoredKeyInText(armoredKey, Keyring.PRIVATE);
 
-    // Is the given key a valid pgp key ?
-    let privateKey = await openpgp.key.readArmored(armoredKey);
-    if (privateKey.err) {
-      throw new Error(privateKey.err[0].message);
-    }
-
-    // If the key is not private, return an error.
-    privateKey = privateKey.keys[0];
-    if (!privateKey.isPrivate()) {
-      throw new Error(__('Expected a private key but got a public key instead'));
-    }
-
+    const privateKey = await OpenpgpAssertion.readKeyOrFail(armoredKey);
+    OpenpgpAssertion.assertPrivateKey(privateKey);
     // Get the keyInfo.
-    let keyInfo = await this.keyInfo(armoredKey);
+    const keyInfo = (await GetGpgKeyInfoService.getKeyInfo(privateKey)).toDto();
 
     // Add the key in the keyring
-    let privateKeys = this.getPrivateKeysFromStorage();
+    const privateKeys = this.getPrivateKeysFromStorage();
     privateKeys[Keyring.MY_KEY_ID] = keyInfo;
     privateKeys[Keyring.MY_KEY_ID].user_id = Keyring.MY_KEY_ID;
     this.store(Keyring.PRIVATE, privateKeys);
 
     return true;
-  };
+  }
 
   /**
    * Import the server public armored key.
@@ -175,9 +164,11 @@ class Keyring {
     return true;
   }
 
-  // ==================================================
-  // PARSING AND KEY INFO
-  // ==================================================
+  /*
+   * ==================================================
+   * PARSING AND KEY INFO
+   * ==================================================
+   */
   /**
    * Parse a text block with one or more keys and extract the Public or Private armoredkey.
    *
@@ -210,156 +201,34 @@ class Keyring {
     }
 
     return armoredKey;
-  };
-
-  /**
-   * Get the key info.
-   *
-   * @param {string} armoredKey The key to examine
-   * @return {array}
-   * @throw Error if the key cannot be read by openpgp
-   */
-  async keyInfo (armoredKey) {
-    // Attempt to read armored key.
-    let key = await openpgp.key.readArmored(armoredKey);
-    if (key.err) {
-      throw new Error(key.err[0].message);
-    }
-    key = key.keys[0];
-
-    // Check the userIds
-    let userIds = key.getUserIds(),
-      userIdsSplited = [];
-    if(userIds.length === 0) {
-      throw new Error('No key user ID found');
-    }
-
-    for (let i in userIds) {
-      if (userIds.hasOwnProperty(i)) {
-        const result = goog.format.EmailAddress.parse(userIds[i]);
-        userIdsSplited.push({
-          name: result.name_,
-          email: result.address_
-        });
-      }
-    }
-
-    // seems like opengpg keys id can be longer than 8 bytes (16 default?)
-    let keyid = key.primaryKey.getKeyId().toHex();
-    if (keyid.length > 8) {
-      keyid = keyid.substr(keyid.length - 8);
-    }
-
-    // Format expiration time
-    let expirationTime, created;
-    try {
-      expirationTime = await key.getExpirationTime();
-      expirationTime = expirationTime.toString();
-      if (expirationTime === 'Infinity') {
-        expirationTime = __('Never');
-      }
-      created = key.primaryKey.created.toString();
-    } catch(error) {
-      expirationTime = null;
-    }
-
-    return {
-      key: key.armor(),
-      keyId: keyid,
-      userIds: userIdsSplited,
-      fingerprint: key.primaryKey.getFingerprint(),
-      created: created,
-      expires: expirationTime,
-      algorithm: key.primaryKey.getAlgorithmInfo().algorithm,
-      length: key.primaryKey.getAlgorithmInfo().bits,
-      curve: key.primaryKey.getAlgorithmInfo().curve,
-      private: key.isPrivate()
-    };
   }
 
-  /**
-   * Extract a public armored key from a private armored key.
-   *
-   * @param {string} privateArmoredKey The private key armored
-   * @returns {string}
+  /*
+   * ==================================================
+   * SERVER SYNC
+   * @TODO move to a dedicated service
+   * ==================================================
    */
-  async extractPublicKey(privateArmoredKey) {
-    const key = await openpgp.key.readArmored(privateArmoredKey);
-    return key.keys[0].toPublic().armor();
-  };
-
-  /**
-   * Check if a key is expired.
-   * @param {string} armoredKey The key to check
-   * @returns {Promise<boolean>}
-   */
-  async keyIsExpired(armoredKey) {
-    let key = await openpgp.key.readArmored(armoredKey);
-    if (key.err) {
-      throw new Error(key.err[0].message);
-    }
-
-    key = key.keys[0];
-    let expirationTime;
-    try {
-      expirationTime = await key.getExpirationTime();
-    } catch(error) {
-      return false;
-    }
-
-    if (expirationTime === Infinity) {
-      return false;
-    }
-
-    const expirationDate = new Date(expirationTime.toString());
-    const now = Date.now();
-
-    return expirationDate < now;
-  }
-
-  /**
-   * Check if the passphrase is valid for the user private key.
-   *
-   * @param {string} passphrase The key passphrase
-   * @returns {Promise}
-   * @todo move to Crypto
-   */
-  async checkPassphrase (passphrase) {
-    const privateKey = this.findPrivate();
-    const privKeyObj = (await openpgp.key.readArmored(privateKey.key)).keys[0];
-    if (!privKeyObj.isDecrypted()) {
-      try {
-        await privKeyObj.decrypt(passphrase);
-      } catch (error) {
-        throw new InvalidMasterPasswordError();
-      }
-    }
-  }
-
-  // ==================================================
-  // SERVER SYNC
-  // @TODO move to a dedicated service
-  // ==================================================
   /**
    * Sync the local keyring with the passbolt API.
    * Retrieve the latest updated Public Keys.
    *
    * @returns {Promise<int>} number of updated keys
    */
-  async sync () {
-    let latestSync = storage.getItem('latestSync');
+  async sync() {
+    const latestSync = storage.getItem('latestSync');
 
     // Get the latest keys changes from the backend.
-    let userSettings = new UserSettings();
-    let url = userSettings.getDomain() + '/gpgkeys.json' + '?api-version=v2';
+    const userSettings = new UserSettings();
+    let url = `${userSettings.getDomain()}/gpgkeys.json` + `?api-version=v2`;
 
     // If a sync has already been performed.
     if (latestSync !== null) {
-      url += '&modified_after=' + latestSync;
+      url += `&modified_after=${latestSync}`;
     }
 
     // Get the updated public keys from passbolt.
-    let response = await fetch(url, {
+    const response = await fetch(url, {
       method: 'GET',
       credentials: 'include',
       headers: {
@@ -367,29 +236,30 @@ class Keyring {
         'Content-Type': 'application/json'
       }
     });
-    let json = await response.json();
+    const json = await response.json();
 
     // Check response status
     if (!response.ok) {
-      let msg = __('Could not synchronize the keyring. The server responded with an error.');
+      let msg = 'Could not synchronize the keyring. The server responded with an error.';
       if (json.header.msg) {
-        msg += ' ' + json.header.msg;
+        msg += ` ${json.header.msg}`;
       }
-      msg += '(' + response.status + ')';
+      msg += `(${response.status})`;
       throw new Error(msg);
     }
     // Update the latest synced time.
     if (!json.header) {
-      throw new Error(__('Could not synchronize the keyring. The server response header is missing.'));
+      throw new Error('Could not synchronize the keyring. The server response header is missing.');
     }
     if (!json.body) {
-      throw new Error(__('Could not synchronize the keyring. The server response body is missing.'));
+      throw new Error('Could not synchronize the keyring. The server response body is missing.');
     }
 
     // Store all the new keys in the keyring.
-    let meta, armoredKey, i, imports = [];
+    let meta, i;
+    const imports = [];
     for (i in json.body) {
-      if (json.body.hasOwnProperty(i)) {
+      if (Object.prototype.hasOwnProperty.call(json.body, i)) {
         meta = json.body[i];
         imports.push(this.importPublic(meta.armored_key, meta.user_id));
       }
@@ -401,10 +271,12 @@ class Keyring {
     return (json.body.length);
   }
 
-  // ==================================================
-  // STORAGE
-  // @TODO move to a dedicated service
-  // ==================================================
+  /*
+   * ==================================================
+   * STORAGE
+   * @TODO move to a dedicated service
+   * ==================================================
+   */
   /**
    * Store keys in the local storage.
    *
@@ -414,9 +286,9 @@ class Keyring {
    */
   store(type, keys) {
     if (type !== Keyring.PUBLIC && type !== Keyring.PRIVATE) {
-      throw new Error(__('Key type is incorrect'));
+      throw new Error('Key type is incorrect');
     }
-    let key = (type === Keyring.PRIVATE) ? Keyring.STORAGE_KEY_PRIVATE : Keyring.STORAGE_KEY_PUBLIC;
+    const key = (type === Keyring.PRIVATE) ? Keyring.STORAGE_KEY_PRIVATE : Keyring.STORAGE_KEY_PUBLIC;
     storage.setItem(key, JSON.stringify(keys));
   }
 
@@ -439,7 +311,7 @@ class Keyring {
    *
    * @returns {Object} a collection of key as in {userUuid: Key, ...}
    */
-  getPublicKeysFromStorage () {
+  getPublicKeysFromStorage() {
     // Get the public keys from the local storage.
     const pubSerialized = storage.getItem(Keyring.STORAGE_KEY_PUBLIC);
     if (pubSerialized) {
@@ -454,7 +326,7 @@ class Keyring {
    * @param type {string} The type of keys to flush : Keyring.PRIVATE or Keyring.PUBLIC.
    *  Default Keyring.PUBLIC.
    */
-  flush (type) {
+  flush(type) {
     if (typeof type === 'undefined') {
       type = Keyring.PUBLIC;
     }
@@ -465,14 +337,18 @@ class Keyring {
       this.store(Keyring.PRIVATE, {});
     }
 
-    // Removed latestSync variable.
-    // We consider that the keyring has never been synced.
+    /*
+     * Removed latestSync variable.
+     * We consider that the keyring has never been synced.
+     */
     storage.removeItem('latestSync');
   }
 
-  // ==================================================
-  // CONSTANT GETTERS
-  // ==================================================
+  /*
+   * ==================================================
+   * CONSTANT GETTERS
+   * ==================================================
+   */
   /**
    * Keyring.MY_KEY_ID
    * @returns {string}
@@ -548,4 +424,4 @@ class Keyring {
   }
 }
 
-exports.Keyring = Keyring;
+export default Keyring;

package/src/all/background_page/model/locale/localeModel.js

@@ -0,0 +1,137 @@
+/**
+ * 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         3.2.0
+ */
+import OrganizationSettingsModel from "../organizationSettings/organizationSettingsModel";
+import AccountSettingsService from "../../service/api/accountSettings/accountSettingsService";
+import {Config} from "../config";
+import i18n from "../../sdk/i18n";
+import LocaleEntity from "../entity/locale/localeEntity";
+import LocalesCollection from "../entity/locale/localesCollection";
+
+
+class LocaleModel {
+  /**
+   * LocaleModel.default
+   * @returns {LocaleEntity}
+   */
+  static get DEFAULT_LOCALE() {
+    return new LocaleEntity({
+      locale: 'en-UK',
+      label: 'English'
+    });
+  }
+
+  /**
+   * LocaleModel.default
+   * @returns {LocalesCollection}
+   */
+  static get DEFAULT_SUPPORTED_LOCALES() {
+    return new LocalesCollection([LocaleModel.DEFAULT_LOCALE]);
+  }
+
+  /**
+   * Constructor
+   *
+   * @param {ApiClientOptions} apiClientOptions
+   * @public
+   */
+  constructor(apiClientOptions) {
+    this.accountSettingsService = new AccountSettingsService(apiClientOptions);
+    this.organizationSettingsModel = new OrganizationSettingsModel(apiClientOptions);
+  }
+
+  /**
+   * Initialize the library i18next
+   * @param {LocaleEntity} localeEntity The locale to use
+   * @returns {Promise<void>}
+   */
+  async initializeI18next(localeEntity) {
+    const supportedLocales = await this.getSupportedOrganizationLocales();
+    const supportedLocalesId = supportedLocales.locales.map(supportedLocale => supportedLocale.locale);
+    i18n.init(localeEntity.locale, supportedLocalesId);
+  }
+
+  /*
+   * ==============================================================
+   *  Finders / remote calls
+   * ==============================================================
+   */
+
+  /**
+   * Get the organization locale.
+   * @returns {Promise<LocaleEntity>}
+   */
+  async getOrganizationLocale() {
+    const organizationSettings = await this.organizationSettingsModel.getOrFind();
+    return this.getSupportedLocale(organizationSettings.locale);
+  }
+
+  /**
+   * Get supported organization locales
+   * @returns {Promise<LocalesCollection>}
+   */
+  async getSupportedOrganizationLocales() {
+    const organizationSettings = await this.organizationSettingsModel.getOrFind();
+    const localePluginEnabled = organizationSettings.isPluginEnabled("locale");
+
+    if (localePluginEnabled) {
+      const localePluginSettings = organizationSettings.getPluginSettings("locale");
+      return new LocalesCollection(localePluginSettings.options || []);
+    }
+
+    return LocaleModel.DEFAULT_SUPPORTED_LOCALES;
+  }
+
+  /**
+   * Retrieve a supported locale by locale identifier.
+   * @param {string} locale The locale to check. i.e. en-US
+   * @returns {Promise<LocaleEntity>}
+   */
+  async getSupportedLocale(locale) {
+    const supportedLocales = await this.getSupportedOrganizationLocales();
+    return supportedLocales.locales.find(supportedLocale => supportedLocale.locale === locale);
+  }
+
+  /**
+   * Find the first similar language.
+   * i.e. with supported locales: ["en-UK", "fr-FR"], "en-UK" will be returned as similar locale of "en-US".
+   * @param {string} locale The locale to find a similar one for
+   * @returns {string}
+   */
+  async getLocaleWithSimilarLanguage(locale) {
+    const localeNonExplicitLanguage = locale.split('-')[0];
+    const supportedLocales = await this.getSupportedOrganizationLocales();
+    return supportedLocales.locales.find(supportedLocale => localeNonExplicitLanguage === supportedLocale.locale.split('-')[0]);
+  }
+
+  /*
+   * ==============================================================
+   *  CRUDs
+   * ==============================================================
+   */
+
+  /**
+   * Update the current user locale language
+   *
+   * @param {LocaleEntity} localeEntity The locale update entity
+   * @returns {Promise<void>} response body
+   * @throws {Error} if options are invalid or API error
+   * @public
+   */
+  async updateUserLocale(localeEntity) {
+    await this.accountSettingsService.updateLocale(localeEntity.locale);
+    Config.write('user.settings.locale', localeEntity.locale);
+  }
+}
+
+export default LocaleModel;