passbolt-browser-extension 5.3.0 → 5.3.2

package/CHANGELOG.md

@@ -4,6 +4,33 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [5.3.2] - 2025-07-17
+### Added
+- PB-25265 Flush clipboard strategy
+- PB-43095 Display the metadata issue in the HealthCheck served by the UI
+- PB-43403 Search resources should take into account available custom fields information in the web application
+
+### Improved
+- PB-43474 As LU I should be able to clear the search field with a button
+
+### Fixed
+- PB-43916 Fix hitting the key enter on the search fields
+- PB-43996 Users should access encrypted metadata section of the administration guide on the help site when clicking on the documentation CTA from the sidebar
+
+### Maintenance
+- PB-43491 The resource activities should use a service worker service to request the service worker
+- PB-43496 The user should be notified if an error occurs while displaying additional resource activities
+- PB-43501 Cover ActionLogService API service and rename class as per naming convention
+- PB-43502 Move logic of ActionLogModel into FindActionLogService
+- PB-43506 Move logic of event passbolt.actionlogs.find-all-for into its dedicated Controller
+- PB-43738 Create DeleteUserService to call the userService deleteDryRun
+- PB-43739 Create DeleteDryRunUserController to call the DeleteUserService
+- PB-43750 An unexpected error should be displayed on delete user
+- PB-43904 Add a service to request or send data CommentsServiceWorkerService
+- PB-43907 Add tests for commentService API service and rename the service class as per naming convention
+- PB-43938 Create a GetOrFindMetadataKeysSettingsController to retrieve the metadata keys settings
+- PB-43940 Create a MetadataKeysSettingsLocalStorageContextProvider to retrieve the metadata keys settings
+
 ## [5.3.0] - 2025-06-09
 
 ### Added
@@ -2278,7 +2305,9 @@ self registration settings option in the left-side bar
 - AP: User with plugin installed
 - LU: Logged in user
 
-[Unreleased]: https://github.com/passbolt/passbolt_browser_extension/compare/v5.2.0...HEAD
+[Unreleased]: https://github.com/passbolt/passbolt_browser_extension/compare/v5.3.2...HEAD
+[5.3.2]: https://github.com/passbolt/passbolt_browser_extension/compare/v5.3.0...v5.3.2
+[5.3.0]: https://github.com/passbolt/passbolt_browser_extension/compare/v5.2.0...v5.3.0
 [5.2.0]: https://github.com/passbolt/passbolt_browser_extension/compare/v5.1.1...v5.2.0
 [5.1.1]: https://github.com/passbolt/passbolt_browser_extension/compare/v5.1.0...v5.1.1
 [5.1.0]: https://github.com/passbolt/passbolt_browser_extension/compare/v5.0.1...v5.1.0

package/Gruntfile.js

@@ -119,7 +119,7 @@ module.exports = function (grunt) {
       service_worker: {
         files: [
           { expand: true, cwd: path.src_chrome_mv3, src: 'serviceWorker.js', dest: path.build + 'serviceWorker' },
-          { expand: true, cwd: `${path.src_chrome_mv3}/offscreens`, src: 'fetch.html', dest: `${path.build}/offscreens` }
+          { expand: true, cwd: `${path.src_chrome_mv3}/offscreens`, src: 'offscreen.html', dest: `${path.build}/offscreens` },
         ]
       },
       web_accessible_resources: {

package/RELEASE_NOTES.md

@@ -1,56 +1,37 @@
-Release song: https://www.youtube.com/watch?v=ubWL8VAPoYw
+Release song: https://www.youtube.com/watch?v=-GxmblM_jss
 
-Passbolt 5.3 adds custom fields, one of the five most‑requested features from the community. Built on top of encrypted‑metadata introduced earlier this year, custom fields let users attach additional key‑value pairs to a resource or as a standalone one. Typical use‑cases include centralising CI/CD job variables and storing environment‑specific configuration values that need more structure than a general note.
+Passbolt v5.3.2 is a security release designed to strengthen the security posture of your organization. It introduces a clipboard flushing feature, adds safeguards around SSO settings, and addresses issues related to encrypted metadata.
 
-Custom fields rely on encrypted metadata, therefore the feature is still in beta and is not yet available on Passbolt Cloud. A step‑by‑step guide on how to enable the encrypted metadata  on a self‑hosted instance will be available in a blog post that will be published soon. The encrypted‑metadata feature is scheduled to be marked as stable in Passbolt 5.4, planned for August 2025.
+The new clipboard flush timer lets you copy secrets just long enough to use them; clipboard data is automatically cleared when the countdown (30s) expires, significantly reducing the risk of accidental exposure or leaks from forgotten clipboard content.
 
-As part of our continuous performance work, this release concentrates on folder browsing. Loading folders and their resources is now faster and reduces the load on API and client, improving day-to-day usability for organizations having thousands of credentials under management.
+Additionally, SSO admin-settings edit endpoints of self-hosted instances can now be locked, reducing potential exposure to scans if an administrator account is compromised. You can verify if this protection is active, and get instructions on how to set it up, by running the health check via the server command line.
 
-Several bugs reported by the community have also been fixed. As always, thank you to everyone who took the time to file issues, test patches and suggest improvements. For a complete list of changes, consult the changelog.
+This update also resolves several encrypted metadata issues, moving the feature closer to general availability. Organizations can now enable encrypted metadata even if users have imported their own more complex keys (e.g. keys that were set to expire at some point), streamlining adoption for advanced users. Admin changes are smoother too: if the original metadata-enabling administrator leaves, newly invited users will still receive the metadata key automatically, removing the need for manual distribution. Lastly, users who owned shared resources using the new encrypted metadata format can now be deleted without issue, as ownership transfer is now handled correctly during the deletion process.
+
+A big thank you to all testers who helped refine these features. If you’re new to any of them, we welcome your feedback on the community forum or through your usual support channels!
 
 ### Added
-- PB-43269 Create the entity CustomFieldEntity
-- PB-43271 Create the entity collection CustomFieldsCollection
-- PB-43273 Create the entity SecretDataV5StandaloneCustomFieldsCollection
-- PB-43275 Update the resource types schema definitions
-- PB-43277 Update the ResourceMetadataEntity
-- PB-43278 Update the ResourceFormEntity
-- PB-43279 Update the Secret Entities
-- PB-43283 Display a new entry the create/edit dialog to set custom fields on the left sidebar and the menu
-- PB-43284 Create the CustomFieldForm for the create/edit dialog
-- PB-43285 Handle the CustomFieldForm warnings and limitation
-- PB-43286 Update create/edit resource to select secret custom fields for a standalone custom fields
-- PB-43287 Display the Custom Fields section on the right sidebar
-- PB-43289 Display standalone custom fields in the component DisplayResourceCreationMenu
-- PB-43290 Display standalone custom fields in the component DisplayResourcesWorkspaceMainMenu
-- PB-43291 Display the URIs section in the right sidebar
-- PB-43374 Add validation on keys and values of each elements of custom fields for the resource form entity
-- PB-43377 Add set collection into entity v2
-- PB-43145 Find a list of resources based on IDs and that are suitable for local storage from the API
-- PB-43146 Find a list of resources based on a parent folder id and that are suitable for the local storage from the API
-- PB-43133 Display padding below tags in resource workspace left sidebar
-- PB-42185 The folder caret that expands or collapses folders in the tree should have a larger clickable area to make it easier to use
-- PB-43222 Improve the group dialog to match the new share dimensions
-- PB-43147 Find and update resources based on parent folder id for the local storage
-- PB-43148 Create a connector for finding resources based on a parent id for the styleguide to call it later
-- PB-43149 Create a ResourcesServiceWorkerService to call the service worker for resource related operations
-- PB-43150 Implement the optimised call in the Styleguide when filtering by a folder
-- PB-43151 Optimise the data retrieved from the API such that updates are not done if unnecessary
-- PB-43156 Clarify implications for backups and other devices before changing the passphrase in the user settings workspace
-- PB-43489 Display unexpected error if there is any issue during the secret decryption
+- PB-25265 Flush clipboard strategy
+- PB-43095 Display the metadata issue in the HealthCheck served by the UI
+- PB-43403 Search resources should take into account available custom fields information in the web application
+
+### Improved
+- PB-43474 As LU I should be able to clear the search field with a button
 
 ### Fixed
-- PB-43109 Fix: from the sidebar when upgrade from v4 to v5 goes wrong the error message in the notification
-- PB-43118 Hide the "Share metadata keys" button in the users workspace action bar for the current signed-in user
-- PB-43215 Fix account recovery creator name
-- PB-43063 Fix group edit dialog double warning message has broken UI
-- PB-43117 Hide the "Share metadata keys" button in the users workspace action bar after sharing missing metadata keys with a user
-- PB-43064 Fix group edit dialog can show a mix of error and warning messages
-- PB-43150: fix folder not being reloaded
-- PB-43424 Clicking on the "open in a new tab” call to action  in the quick application should open the resource url in a new tab
-- PB-43108 Display attention required icon on "metadata keys" label in the user details sidebar if the user is not having access to some metadata keys
-- PB-43217 The default icon stroke width is too thick in the grid and doesn't match the custom icons
-- PB-43220 Copy URL field action button lacks padding and is broken in the SSO settings
-- PB-43168 Align vertically resources workspace select check-boxes
-- PB-43211 The feedback message notifying the administrator when a metadata key has been shared with a user contains a typo
-- PB-43471 Center vertically the icon on the create and edit dialog
+- PB-43916 Fix hitting the key enter on the search fields
+- PB-43996 Users should access encrypted metadata section of the administration guide on the help site when clicking on the documentation CTA from the sidebar
+
+### Maintenance
+- PB-43491 The resource activities should use a service worker service to request the service worker
+- PB-43496 The user should be notified if an error occurs while displaying additional resource activities
+- PB-43501 Cover ActionLogService API service and rename class as per naming convention
+- PB-43502 Move logic of ActionLogModel into FindActionLogService
+- PB-43506 Move logic of event passbolt.actionlogs.find-all-for into its dedicated Controller
+- PB-43738 Create DeleteUserService to call the userService deleteDryRun
+- PB-43739 Create DeleteDryRunUserController to call the DeleteUserService
+- PB-43750 An unexpected error should be displayed on delete user
+- PB-43904 Add a service to request or send data CommentsServiceWorkerService
+- PB-43907 Add tests for commentService API service and rename the service class as per naming convention
+- PB-43938 Create a GetOrFindMetadataKeysSettingsController to retrieve the metadata keys settings
+- PB-43940 Create a MetadataKeysSettingsLocalStorageContextProvider to retrieve the metadata keys settings

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "passbolt-browser-extension",
-  "version": "5.3.0",
+  "version": "5.3.2",
   "license": "AGPL-3.0",
   "copyright": "Copyright 2025 Passbolt SA",
   "description": "Passbolt web extension for the open source password manager for teams",
@@ -22,7 +22,7 @@
     "locutus": "~2.0.9",
     "openpgp": "^6.1.1",
     "papaparse": "^5.5.2",
-    "passbolt-styleguide": "^5.3.1",
+    "passbolt-styleguide": "^5.3.2",
     "react": "17.0.2",
     "react-dom": "17.0.2",
     "secrets-passbolt": "github:passbolt/secrets.js#v2.0.1",
@@ -80,7 +80,7 @@
   "scripts": {
     "build": "npx grunt build",
     "build:background-page": "webpack --config webpack.background-page.config.js",
-    "build:service-worker": "webpack --config webpack.service-worker.config.js; webpack --config webpack-offscreens.fetch.config.js",
+    "build:service-worker": "webpack --config webpack.service-worker.config.js; webpack --config webpack-offscreens.config.js",
     "build:content-scripts": "npm run build:content-scripts:app; npm run build:content-scripts:browser-integration; npm run build:content-scripts:public-website",
     "build:content-scripts:app": "webpack --config webpack-content-scripts.config.js",
     "build:content-scripts:browser-integration": "webpack --config webpack-content-scripts.browser-integration.config.js",
@@ -89,7 +89,7 @@
     "build:web-accessible-resources:app": "webpack --config webpack-data.config.js; webpack --config webpack-data.download.config.js",
     "build:web-accessible-resources:browser-integration": "webpack --config webpack-data.in-form-call-to-action.config.js; webpack --config webpack-data.in-form-menu.config.js",
     "dev:build:background-page": "webpack --env debug=true --config webpack.background-page.config.js",
-    "dev:build:service-worker": "webpack --env debug=true --config webpack.service-worker.config.js; webpack --env debug=true --config webpack-offscreens.fetch.config.js",
+    "dev:build:service-worker": "webpack --env debug=true --config webpack.service-worker.config.js; webpack --env debug=true --config webpack-offscreens.config.js",
     "dev:build:content-scripts": "npm run dev:build:content-scripts:app; npm run dev:build:content-scripts:browser-integration; npm run dev:build:content-scripts:public-website",
     "dev:build:content-scripts:app": "webpack --env debug=true --config webpack-content-scripts.config.js",
     "dev:build:content-scripts:browser-integration": "webpack --env debug=true --config webpack-content-scripts.browser-integration.config.js",
@@ -112,7 +112,7 @@
     "lint:eslint-fix": "eslint -c .eslintrc.json --ext js --ext jsx --fix src",
     "i18n:externalize": "i18next -c ./i18next-parser.config.js",
     "test": "npm run test:unit",
-    "test:unit": "jest --no-cache ./src/all/ ./src/chrome-mv3/",
+    "test:unit": "jest --no-cache ./src/all/ ./src/chrome-mv3/ ./src/chrome/",
     "test:coverage": "jest --no-cache ./src/all/ ./src/chrome-mv3/ --coverage",
     "test:ci:coverage": "npm run test:coverage -- --runInBand"
   }

package/src/all/background_page/controller/clipboard/cancelClipboardContentFlushController.js

@@ -0,0 +1,51 @@
+/**
+ * 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         5.3.2
+ */
+
+import CopyToClipboardService from "../../service/clipboard/copyToClipboardService";
+
+export default class CancelClipboardContentFlushController {
+  /**
+   * CancelClipboardContentFlushController constructor
+   * @param {Worker} worker
+   * @param {string} requestId uuid
+   */
+  constructor(worker, requestId) {
+    this.worker = worker;
+    this.requestId = requestId;
+    this.copyToClipboardService = new CopyToClipboardService();
+  }
+
+  /**
+   * Wrapper of exec function to run it with worker.
+   * @return {Promise<void>}
+   */
+  async _exec() {
+    try {
+      await this.exec();
+      this.worker.port.emit(this.requestId, "SUCCESS");
+    } catch (error) {
+      console.error(error);
+      this.worker.port.emit(this.requestId, "ERROR", error);
+    }
+  }
+
+  /**
+   * Cancel flushing of the clipboard content
+   *
+   * @return {Promise<void>}
+   */
+  async exec() {
+    await this.copyToClipboardService.clearAlarm();
+  }
+}

package/src/all/background_page/controller/clipboard/cancelClipboardContentFlushController.test.js

@@ -0,0 +1,46 @@
+/**
+ * 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         5.3.2
+ */
+
+import {v4 as uuidv4} from 'uuid';
+import CancelClipboardContentFlushController from './cancelClipboardContentFlushController';
+
+describe('CancelClipboardContentFlushController', () => {
+  describe('constructor', () => {
+    it('should set the worker and requestId properties', () => {
+      expect.assertions(2);
+
+      const worker = {port: {}};
+      const requestId = uuidv4();
+      const controller = new CancelClipboardContentFlushController(worker, requestId);
+
+      expect(controller.worker).toBe(worker);
+      expect(controller.requestId).toBe(requestId);
+    });
+  });
+
+  describe('exec', () => {
+    it('should call copyTemporarily of the right service', async() => {
+      expect.assertions(1);
+
+      const toCopy = "text";
+      const controller = new CancelClipboardContentFlushController();
+
+      jest.spyOn(controller.copyToClipboardService, "clearAlarm").mockImplementation(() => {});
+
+      await controller.exec(toCopy);
+
+      expect(controller.copyToClipboardService.clearAlarm).toHaveBeenCalledTimes(1);
+    });
+  });
+});

package/src/all/background_page/controller/clipboard/copyTemporarilyToClipboardController.js

@@ -0,0 +1,53 @@
+/**
+ * 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         5.3.2
+ */
+
+import CopyToClipboardService from "../../service/clipboard/copyToClipboardService";
+
+export default class CopyTemporarilyToClipboardController {
+  /**
+   * CopyTemporarilyToClipboardController constructor
+   * @param {Worker} worker
+   * @param {string} requestId uuid
+   */
+  constructor(worker, requestId) {
+    this.worker = worker;
+    this.requestId = requestId;
+    this.copyToClipboardService = new CopyToClipboardService();
+  }
+
+  /**
+   * Wrapper of exec function to run it with worker.
+   * @param text {string} The text to copy
+   * @return {Promise<void>}
+   */
+  async _exec(text) {
+    try {
+      await this.exec(text);
+      this.worker.port.emit(this.requestId, "SUCCESS");
+    } catch (error) {
+      console.error(error);
+      this.worker.port.emit(this.requestId, "ERROR", error);
+    }
+  }
+
+  /**
+   * Temporarily copy text to clipboard
+   *
+   * @param text {string} The text to copy
+   * @return {Promise<void>}
+   */
+  async exec(text) {
+    await this.copyToClipboardService.copyTemporarily(text);
+  }
+}

package/src/all/background_page/controller/clipboard/copyTemporarilyToClipboardController.test.js

@@ -0,0 +1,47 @@
+/**
+ * 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         5.3.2
+ */
+
+import {v4 as uuidv4} from 'uuid';
+import CopyTemporarilyToClipboardController from './copyTemporarilyToClipboardController';
+
+describe('CopyTemporarilyToClipboardController', () => {
+  describe('constructor', () => {
+    it('should set the worker and requestId properties', () => {
+      expect.assertions(2);
+
+      const worker = {port: {}};
+      const requestId = uuidv4();
+      const controller = new CopyTemporarilyToClipboardController(worker, requestId);
+
+      expect(controller.worker).toBe(worker);
+      expect(controller.requestId).toBe(requestId);
+    });
+  });
+
+  describe('exec', () => {
+    it('should call copyTemporarily of the right service', async() => {
+      expect.assertions(2);
+
+      const toCopy = "text";
+      const controller = new CopyTemporarilyToClipboardController();
+
+      jest.spyOn(controller.copyToClipboardService, "copyTemporarily").mockImplementation(() => {});
+
+      await controller.exec(toCopy);
+
+      expect(controller.copyToClipboardService.copyTemporarily).toHaveBeenCalledTimes(1);
+      expect(controller.copyToClipboardService.copyTemporarily).toHaveBeenCalledWith(toCopy);
+    });
+  });
+});

package/src/all/background_page/controller/clipboard/{clipboardController.js → copyToClipboardController.js}

@@ -12,21 +12,23 @@
  * @since         3.9.0
  */
 
+import CopyToClipboardService from "../../service/clipboard/copyToClipboardService";
 
-class ClipboardController {
+export default class CopyToClipboardController {
   /**
-   * ClipboardController constructor
+   * CopyToClipboardController constructor
    * @param {Worker} worker
    * @param {string} requestId uuid
    */
   constructor(worker, requestId) {
     this.worker = worker;
     this.requestId = requestId;
+    this.copyToClipboardService = new CopyToClipboardService();
   }
 
   /**
    * Wrapper of exec function to run it with worker.
-   * @param text {object} The text to copy
+   * @param text {string} The text to copy
    * @return {Promise<void>}
    */
   async _exec(text) {
@@ -42,12 +44,10 @@ class ClipboardController {
   /**
    * Copy text to clipboard
    *
-   * @param text {object} The text to copy
-   * @return {Void}
+   * @param text {string} The text to copy
+   * @return {Promise<void>}
    */
   async exec(text) {
-    await navigator.clipboard.writeText(text);
+    await this.copyToClipboardService.copy(text);
   }
 }
-
-export default ClipboardController;

package/src/all/background_page/controller/clipboard/copyToClipboardController.test.js

@@ -0,0 +1,47 @@
+/**
+ * Passbolt ~ Open source password manager for teams
+ * Copyright (c) 2023 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) 2023 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 {v4 as uuidv4} from 'uuid';
+import CopyToClipboardController from './copyToClipboardController';
+
+describe('CopyToClipboardController', () => {
+  describe('constructor', () => {
+    it('should set the worker and requestId properties', () => {
+      expect.assertions(2);
+
+      const worker = {port: {}};
+      const requestId = uuidv4();
+      const controller = new CopyToClipboardController(worker, requestId);
+
+      expect(controller.worker).toBe(worker);
+      expect(controller.requestId).toBe(requestId);
+    });
+  });
+
+  describe('exec', () => {
+    it('should call copy on the right service', async() => {
+      expect.assertions(2);
+
+      const toCopy = "text";
+      const controller = new CopyToClipboardController();
+
+      jest.spyOn(controller.copyToClipboardService, "copy").mockImplementation(() => {});
+
+      await controller.exec(toCopy);
+
+      expect(controller.copyToClipboardService.copy).toHaveBeenCalledTimes(1);
+      expect(controller.copyToClipboardService.copy).toHaveBeenCalledWith(toCopy);
+    });
+  });
+});

package/src/all/background_page/controller/extension/getExtensionVersionController.test.js

@@ -22,7 +22,7 @@ describe("GetExtensionVersionController", () => {
       const version = await controller.exec();
 
       expect.assertions(1);
-      await expect(version).toEqual("v3.6.0");
+      expect(version).toEqual("5.3.0");
     });
   });
 });

package/src/all/background_page/controller/metadata/getOrFindMetadataKeysSettingsController.js

@@ -0,0 +1,53 @@
+/**
+ * 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         5.4.0
+ */
+import GetOrFindMetadataSettingsService from "../../service/metadata/getOrFindMetadataSettingsService";
+
+class GetOrFindMetadataKeysController {
+  /**
+   * @constructor
+   * @param {Worker} worker
+   * @param {string} requestId
+   * @param {ApiClientOptions} apiClientOptions the api client options
+   * @param {AccountEntity} account the user account
+   */
+  constructor(worker, requestId, apiClientOptions, account) {
+    this.worker = worker;
+    this.requestId = requestId;
+    this.getOrFindMetadaSettingsService = new GetOrFindMetadataSettingsService(account, apiClientOptions);
+  }
+
+  /**
+   * Controller executor.
+   * @returns {Promise<void>}
+   */
+  async _exec() {
+    try {
+      const result = await this.exec();
+      this.worker.port.emit(this.requestId, 'SUCCESS', result);
+    } catch (error) {
+      console.error(error);
+      this.worker.port.emit(this.requestId, 'ERROR', error);
+    }
+  }
+
+  /**
+   * Get or find the metadata keys settings entity.
+   * @returns {Promise<MetadataKeysSettingsEntity>}
+   */
+  async exec() {
+    return this.getOrFindMetadaSettingsService.getOrFindKeysSettings();
+  }
+}
+
+export default GetOrFindMetadataKeysController;