passbolt-browser-extension 3.0.6 → 4.6.2

package/src/all/background_page/model/entity/sso/ssoLoginUrlEntity.js

@@ -0,0 +1,127 @@
+/**
+ * Passbolt ~ Open source password manager for teams
+ * Copyright (c) 2022 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) 2022 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.9.0
+ */
+import Entity from "passbolt-styleguide/src/shared/models/entity/abstract/entity";
+import EntitySchema from "passbolt-styleguide/src/shared/models/entity/abstract/entitySchema";
+import AdfsSsoSettingsEntity from "passbolt-styleguide/src/shared/models/entity/ssoSettings/AdfsSsoSettingsEntity";
+import AzureSsoSettingsEntity from "passbolt-styleguide/src/shared/models/entity/ssoSettings/AzureSsoSettingsEntity";
+import GoogleSsoSettingsEntity from "passbolt-styleguide/src/shared/models/entity/ssoSettings/GoogleSsoSettingsEntity";
+import OAuth2SsoSettingsEntity from "passbolt-styleguide/src/shared/models/entity/ssoSettings/OAuth2SsoSettingsEntity";
+
+const ENTITY_NAME = "SsoLoginUrl";
+const SSO_LOGIN_SUPPORTED_URLS = {
+  [AzureSsoSettingsEntity.PROVIDER_ID]: AzureSsoSettingsEntity.SUPPORTED_URLS,
+  [GoogleSsoSettingsEntity.PROVIDER_ID]: GoogleSsoSettingsEntity.SUPPORTED_URLS
+};
+
+/**
+ * Entity related to the SSO Login URL
+ */
+class SsoLoginUrlEntity extends Entity {
+  /**
+   * Setup entity constructor
+   *
+   * @param {Object} ssoLoginUrlDto SSO Login URL DTO
+   * @throws EntityValidationError if the dto cannot be converted into an entity
+   */
+  constructor(ssoLoginUrlDto, ssoProvider) {
+    super(EntitySchema.validate(
+      SsoLoginUrlEntity.ENTITY_NAME,
+      ssoLoginUrlDto,
+      SsoLoginUrlEntity.getSchema(ssoProvider)
+    ));
+  }
+
+  /**
+   * Get entity schema
+   * @param {string} ssoProvider the sso provider the URL should match for
+   * @returns {Object} schema
+   */
+  static getSchema(ssoProvider) {
+    return {
+      "type": "object",
+      "required": ["url"],
+      "properties": {
+        "url": {
+          "type": "x-custom",
+          "validationCallback": url => SsoLoginUrlEntity.validateUrl(url, ssoProvider)
+        },
+      }
+    };
+  }
+
+  /*
+   * ==================================================
+   * Custom validators
+   * ==================================================
+   */
+
+  static validateUrl(value, ssoProvider) {
+    if (typeof value !== "string") {
+      throw new TypeError("The url should be a string.");
+    }
+
+    let url;
+
+    try {
+      url = new URL(value);
+    } catch (error) {
+      throw new Error('The url should be a valid url.');
+    }
+
+    if (ssoProvider === OAuth2SsoSettingsEntity.PROVIDER_ID || ssoProvider === AdfsSsoSettingsEntity.PROVIDER_ID) {
+      if (url.protocol !== "https:") {
+        throw new Error('The url protocol should be HTTPS.');
+      }
+      return;
+    }
+
+    if (!SSO_LOGIN_SUPPORTED_URLS[ssoProvider]) {
+      throw new Error('The url should be part of the list of supported single sign-on urls.');
+    }
+
+    const isSupportedUrl = SSO_LOGIN_SUPPORTED_URLS[ssoProvider].some(supportedUrl => url.origin === supportedUrl);
+    if (!isSupportedUrl) {
+      throw new Error('The url should be part of the list of supported single sign-on urls.');
+    }
+  }
+
+  /*
+   * ==================================================
+   * Dynamic properties getters
+   * ==================================================
+   */
+
+  /**
+   * Get the SSO Login URL
+   * @returns {string}
+   */
+  get url() {
+    return this._props.url;
+  }
+
+  /*
+   * ==================================================
+   * Static properties getters
+   * ==================================================
+   */
+  /**
+   * SsoConfigurationEntity.ENTITY_NAME
+   * @returns {string}
+   */
+  static get ENTITY_NAME() {
+    return ENTITY_NAME;
+  }
+}
+
+export default SsoLoginUrlEntity;

package/src/all/background_page/model/entity/sso/ssoLoginUrlEntity.test.js

@@ -0,0 +1,89 @@
+/**
+ * Passbolt ~ Open source password manager for teams
+ * Copyright (c) 2022 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) 2022 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.9.0
+ */
+import EntityValidationError from "passbolt-styleguide/src/shared/models/entity/abstract/entityValidationError";
+import EntitySchema from "passbolt-styleguide/src/shared/models/entity/abstract/entitySchema";
+import SsoLoginUrlEntity from "./ssoLoginUrlEntity";
+import each from "jest-each";
+
+describe("Sso Login URL Entity", () => {
+  it("schema must validate", () => {
+    EntitySchema.validateSchema(SsoLoginUrlEntity.ENTITY_NAME, SsoLoginUrlEntity.getSchema());
+  });
+
+  it("constructor works if a valid DTO is provided", () => {
+    const availableUrl = [
+      {providerId: "azure", url: 'https://login.microsoftonline.com'},
+      {providerId: "azure", url: 'https://login.microsoftonline.us'},
+      {providerId: "azure", url: 'https://login.partner.microsoftonline.cn'},
+      {providerId: "google", url: 'https://accounts.google.com'},
+      {providerId: "oauth2", url: 'https://oauth2.generic.provider.com'},
+      {providerId: "adfs", url: 'https://adfs.partner.microsoft.com'},
+    ];
+
+    expect.assertions(availableUrl.length);
+
+    for (let i = 0; i < availableUrl.length; i++) {
+      const dto = {
+        url: availableUrl[i].url
+      };
+      const entity = new SsoLoginUrlEntity(dto, availableUrl[i].providerId);
+      expect(entity.toDto()).toEqual(dto);
+    }
+  });
+
+  each([
+    {scenario: 'Global microsoft online url', url: 'https://login.microsoftonline.com', providerId: "azure"},
+    {scenario: 'US microsoft online url', url: 'https://login.microsoftonline.us', providerId: "azure"},
+    {scenario: 'China microsoft online url', url: 'https://login.partner.microsoftonline.cn', providerId: "azure"},
+    {scenario: 'Google url', url: 'https://accounts.google.com', providerId: "google"}
+  ]).describe("Should accept supported url", test => {
+    it(`Should accept supported url: ${test.scenario}`, async() => {
+      const dto = {
+        url: test.url
+      };
+      const entity = new SsoLoginUrlEntity(dto, test.providerId);
+      expect(entity.toDto()).toEqual(dto);
+    });
+  });
+
+  each([
+    {scenario: 'Authorize domain with insecure protocol', url: 'http://login.microsoftonline.com'},
+    {scenario: 'Authorize domain with wrong protocol', url: 'ftp://login.microsoftonline.us'},
+    {scenario: 'Authorize domain with no protocol', url: 'login.microsoftonline.us'},
+    {scenario: 'Not a supported domain', url: 'https://login.microsoft.com'},
+    {scenario: 'Authorized domain and protocol but wrong port', url: 'https://login.microsoftonline.com:4443'},
+    {scenario: 'Xss attack', url: 'javascript:alert("hey, here is an XSS")'},
+    {scenario: 'Subdomain attack', url: 'https://attacker.login.microsoftonline.com'},
+    {scenario: 'Regex wild mark attack', url: 'https://loginxmicrosoftonline.com'},
+    {scenario: 'Query parameter attack', url: 'https://attacker.com?domain=https://login.microsoftonline.com'},
+    {scenario: 'Hash attack', url: 'https://attacker.com#https://login.microsoftonline.com'},
+    {scenario: 'Mixing provider URL attack', url: 'https://login.microsoftonline.com', providerId: "google"},
+    {scenario: 'Not using HTTPS', url: 'http://not.secure.com', providerId: "oauth2"},
+  ]).describe("Should not accept unsupported or attacker url", test => {
+    it(`Should not accept unsupported or attacker url: ${test.scenario}`, async() => {
+      const dto = {
+        url: test.url
+      };
+
+      const providerId = test.providerId || "azure";
+
+      try {
+        new SsoLoginUrlEntity(dto, providerId);
+        expect(true).toBeFalsy();
+      } catch (e) {
+        expect(e).toBeInstanceOf(EntityValidationError);
+      }
+    });
+  });
+});

package/src/all/background_page/model/entity/subscription/subscriptionEntity.js

@@ -0,0 +1,113 @@
+/**
+ * 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)
+ */
+import Entity from "passbolt-styleguide/src/shared/models/entity/abstract/entity";
+import EntitySchema from "passbolt-styleguide/src/shared/models/entity/abstract/entitySchema";
+
+const ENTITY_NAME = "Subscription";
+
+class SubscriptionEntity extends Entity {
+  /**
+   * @inheritDoc
+   */
+  constructor(subscriptionDto, options = {}) {
+    super(EntitySchema.validate(
+      SubscriptionEntity.ENTITY_NAME,
+      subscriptionDto,
+      SubscriptionEntity.getSchema()
+    ), options);
+  }
+
+  /**
+   * Get entity schema
+   * @returns {Object} schema
+   */
+  static getSchema() {
+    return {
+      "type": "object",
+      "required": [
+        "subscription_id",
+        "users",
+        "expiry",
+        "created",
+        "data",
+      ],
+      "properties": {
+        "customer_id": {
+          "type": "string"
+        },
+        "subscription_id": {
+          "type": "string"
+        },
+        "users": {
+          "type": "integer"
+        },
+        "email": {
+          "type": "string",
+          "format": "email"
+        },
+        "created": {
+          "type": "string"
+        },
+        "expiry": {
+          "type": "string"
+        },
+        "data": {
+          "type": "string"
+        }
+      }
+    };
+  }
+
+  /*
+   * ==================================================
+   * Serialization
+   * ==================================================
+   */
+  /**
+   * Return a DTO ready to be sent to API or content code
+   * @returns {object}
+   */
+  toDto() {
+    const result = Object.assign({}, this._props);
+    return result;
+  }
+
+  /**
+   * Customizes JSON stringification behavior
+   * @returns {*}
+   */
+  toJSON() {
+    return this.toDto();
+  }
+
+  /*
+   * ==================================================
+   * Dynamic properties getters
+   * ==================================================
+   */
+
+  /*
+   * ==================================================
+   * Static properties getters
+   * ==================================================
+   */
+  /**
+   * SubscriptionEntity.ENTITY_NAME
+   * @returns {string}
+   */
+  static get ENTITY_NAME() {
+    return ENTITY_NAME;
+  }
+}
+
+export default SubscriptionEntity;

package/src/all/background_page/model/entity/subscription/subscriptionEntity.test.js

@@ -0,0 +1,75 @@
+/**
+ * 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.13.0
+ */
+import SubscriptionEntity from "./subscriptionEntity";
+import EntitySchema from "passbolt-styleguide/src/shared/models/entity/abstract/entitySchema";
+import EntityValidationError from "passbolt-styleguide/src/shared/models/entity/abstract/entityValidationError";
+
+describe("Subscription entity", () => {
+  it("schema must validate", () => {
+    EntitySchema.validateSchema(SubscriptionEntity.ENTITY_NAME, SubscriptionEntity.getSchema());
+  });
+
+  it("constructor works if valid minimal DTO is provided", () => {
+    const dto = {
+      "subscription_id": "test",
+      "users": 10,
+      "created": "2021-03-12",
+      "expiry": "2022-03-12",
+      "data": "key"
+    };
+    const entity = new SubscriptionEntity(dto);
+    expect(entity.toDto()).toEqual(dto);
+  });
+
+  it("constructor returns validation error if dto required fields are missing", () => {
+    try {
+      new SubscriptionEntity({});
+    } catch (error) {
+      expect(error instanceof EntityValidationError).toBe(true);
+      expect(error.details).toEqual({
+        subscription_id: {required: 'The subscription_id is required.'},
+        users: {required: 'The users is required.'},
+        created: {required: 'The created is required.'},
+        expiry: {required: 'The expiry is required.'},
+        data: {required: 'The data is required.'}
+      });
+    }
+  });
+
+  it("constructor returns validation error if dto required fields are invalid", () => {
+    try {
+      new SubscriptionEntity({
+        "customer_id": [],
+        "subscription_id": [],
+        "users": [],
+        "email": "test",
+        "created": [],
+        "expiry": [],
+        "data": []
+      });
+    } catch (error) {
+      expect(error instanceof EntityValidationError).toBe(true);
+      expect(error.details).toEqual({
+        customer_id: {type: 'The customer_id is not a valid string.'},
+        subscription_id: {type: 'The subscription_id is not a valid string.'},
+        users: {type: 'The users is not a valid integer.'},
+        email: {format: 'The email is not a valid email.'},
+        created: {type: 'The created is not a valid string.'},
+        expiry: {type: 'The expiry is not a valid string.'},
+        data: {type: 'The data is not a valid string.'},
+      });
+    }
+  });
+});
+

package/src/all/background_page/model/entity/subscription/update/updateSubscriptionEntity.js

@@ -0,0 +1,108 @@
+/**
+ * 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)
+ */
+import Entity from "passbolt-styleguide/src/shared/models/entity/abstract/entity";
+import EntitySchema from "passbolt-styleguide/src/shared/models/entity/abstract/entitySchema";
+
+
+const ENTITY_NAME = "UpdateSubscription";
+
+class UpdateSubscriptionEntity extends Entity {
+  /**
+   * @inheritDoc
+   */
+  constructor(subscriptionDto, options = {}) {
+    super(EntitySchema.validate(
+      UpdateSubscriptionEntity.ENTITY_NAME,
+      subscriptionDto,
+      UpdateSubscriptionEntity.getSchema()
+    ), options);
+  }
+
+  /**
+   * Get entity schema
+   * @returns {Object} schema
+   */
+  static getSchema() {
+    return {
+      "type": "object",
+      "required": [
+        "data"
+      ],
+      "properties": {
+        "data": {
+          "type": "string"
+        }
+      }
+    };
+  }
+
+  /*
+   * ==================================================
+   * Serialization
+   * ==================================================
+   */
+  /**
+   * Return a DTO ready to be sent to API or content code
+   * @returns {object}
+   */
+  toDto() {
+    const result = Object.assign({}, this._props);
+    return result;
+  }
+
+  /**
+   * Customizes JSON stringification behavior
+   * @returns {*}
+   */
+  toJSON() {
+    return this.toDto();
+  }
+
+  /*
+   * ==================================================
+   * Dynamic properties getters
+   * ==================================================
+   */
+  /**
+   * Get the created
+   * @returns {string}
+   */
+  get data() {
+    return this._props.data;
+  }
+
+  /**
+   * Set the data
+   * @param {string} data The data
+   * @throws EntityValidationError The parameter doesn't match the constraint of the property
+   */
+  set data(data) {
+    EntitySchema.validateProp("data", data, UpdateSubscriptionEntity.getSchema().properties.data);
+    this._props.data = data;
+  }
+
+  /*
+   * ==================================================
+   * Static properties getters
+   * ==================================================
+   */
+  /**
+   * UpdateSubscriptionEntity.ENTITY_NAME
+   * @returns {string}
+   */
+  static get ENTITY_NAME() {
+    return ENTITY_NAME;
+  }
+}
+
+export default UpdateSubscriptionEntity;

package/src/all/background_page/model/entity/subscription/update/updateSubscriptionEntity.test.js

@@ -0,0 +1,55 @@
+/**
+ * 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.13.0
+ */
+import UpdateSubscriptionEntity from "./updateSubscriptionEntity";
+import EntitySchema from "passbolt-styleguide/src/shared/models/entity/abstract/entitySchema";
+import EntityValidationError from "passbolt-styleguide/src/shared/models/entity/abstract/entityValidationError";
+
+describe("Update subscription entity", () => {
+  it("schema must validate", () => {
+    EntitySchema.validateSchema(UpdateSubscriptionEntity.ENTITY_NAME, UpdateSubscriptionEntity.getSchema());
+  });
+
+  it("constructor works if valid minimal DTO is provided", () => {
+    const dto = {
+      "data": "key"
+    };
+    const entity = new UpdateSubscriptionEntity(dto);
+    expect(entity.toDto()).toEqual(dto);
+  });
+
+  it("constructor returns validation error if dto required fields are missing", () => {
+    try {
+      new UpdateSubscriptionEntity({});
+    } catch (error) {
+      expect(error instanceof EntityValidationError).toBe(true);
+      expect(error.details).toEqual({
+        data: {required: 'The data is required.'}
+      });
+    }
+  });
+
+  it("constructor returns validation error if dto required fields are invalid", () => {
+    try {
+      new UpdateSubscriptionEntity({
+        "data": []
+      });
+    } catch (error) {
+      expect(error instanceof EntityValidationError).toBe(true);
+      expect(error.details).toEqual({
+        data: {type: 'The data is not a valid string.'},
+      });
+    }
+  });
+});
+

package/src/all/background_page/model/entity/tag/tagEntity.js

@@ -11,25 +11,24 @@
  * @link          https://www.passbolt.com Passbolt(tm)
  * @since         2.13.0
  */
-const {Entity} = require('../abstract/entity');
-const {EntitySchema} = require('../abstract/entitySchema');
-const {EntityValidationError} = require('../abstract/entityValidationError');
+import Entity from "passbolt-styleguide/src/shared/models/entity/abstract/entity";
+import EntityValidationError from "passbolt-styleguide/src/shared/models/entity/abstract/entityValidationError";
+import EntitySchema from "passbolt-styleguide/src/shared/models/entity/abstract/entitySchema";
 
 const ENTITY_NAME = 'Tag';
 
 class TagEntity extends Entity {
   /**
-   * Tag entity constructor
-   *
-   * @param {Object} tagDto tag DTO
-   * @throws EntityValidationError if the dto cannot be converted into an entity
+   * @inheritDoc
+   * Note: Sanitize, if not provided, the DTO is shared should be set to true if the DTO slug starts with #.
+   * @throws {EntityValidationError} Build Rule: Verify that if the slug starts with # the tag is marked as shared.
    */
-  constructor(tagDto) {
+  constructor(tagDto, options = {}) {
     super(EntitySchema.validate(
       TagEntity.ENTITY_NAME,
       tagDto,
       TagEntity.getSchema()
-    ));
+    ), options);
 
     // Additional build rules
     if (typeof this._props.is_shared === 'undefined') {
@@ -65,12 +64,14 @@ class TagEntity extends Entity {
           "type": "boolean"
         }
       }
-    }
+    };
   }
 
-  // ==================================================
-  // Dynamic properties getters
-  // ==================================================
+  /*
+   * ==================================================
+   * Dynamic properties getters
+   * ==================================================
+   */
   /**
    * Get tag id
    * @returns {(string|null)} uuid
@@ -95,9 +96,11 @@ class TagEntity extends Entity {
     return this._props.is_shared;
   }
 
-  // ==================================================
-  // Static properties getters
-  // ==================================================
+  /*
+   * ==================================================
+   * Static properties getters
+   * ==================================================
+   */
   /**
    * TagEntity.ENTITY_NAME
    * @returns {string}
@@ -107,4 +110,4 @@ class TagEntity extends Entity {
   }
 }
 
-exports.TagEntity = TagEntity;
+export default TagEntity;

package/src/all/background_page/model/entity/tag/tagEntity.test.data.js

@@ -0,0 +1,31 @@
+/**
+ * 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.6.0
+ */
+import {v4 as uuidv4} from "uuid";
+
+export const defaultTagDto = (data = {}) => {
+  const id = data?.id || uuidv4();
+
+  return {
+    id: id,
+    slug: "personal-tag",
+    is_shared: false,
+    ...data
+  };
+};
+
+export const sharedTagDto = (data = {}) => sharedTagDto({
+  slug: "#shared-tag",
+  is_shared: true,
+  ...data
+});