Support Multi-srp backups in SeedlessOnboardingController #5685

lwin-kyaw · 2025-04-22T06:45:22Z

Explanation

Support multiple SeedPhrases backup under one user account (social).

Added addNewSeedPhraseBackup in controller to create backup for new SeedPhrase.
Added EncryptionKey (which will be derived from the password) in the controller as non-persisted state, to unlock the Seedless Vault to retrieve the Encryption Key and Auth Key without entering the password. The reason for storing this is that when user imports new SeedPhrase in the wallet, the newly imported SeedPhrase can be backed up automatically without needing to type the password.
Added Controller Lock and sync with KeyringController:lock and KeyringController:unlock events

References

Changelog

`@metamask/seedless-onboarding-controller`

ADDED: added addNewSeedPhraseBackup method in the controller to use for import new SeedPhrase
UPDATED: updated Encryptor interface with the ExportableKeyEncryptor from KeyringController
ADDED: encryptionKey and encryptionSalt state as non-persisted state
ADDED: lock to sync with KeyringController's lock and unlock events
UPDATED: Order of restored SeedPhrases from the fetchAllSeedPhrases method to be the same order as KeyringsMetadata from KeyringController
ADDED: helper methods to check/assert Controller Lock state
UPDATED: mark encryptor as required property in SeedlessOnboardingControllerOptions

Checklist

I've updated the test suite for new or updated code as appropriate
I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
I've communicated my changes to consumers by updating changelogs for packages I've changed, highlighting breaking changes as necessary
I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes

himanshuchawla009 · 2025-04-29T04:32:37Z

packages/seedless-onboarding-controller/src/SeedlessOnboardingController.ts

+   * @param password - The password to verify.
+   * @throws {Error} If the password is invalid or the vault is not initialized.
+   */
+  async #verifyPassword(password: string) {


Suggested change

async #verifyPassword(password: string) {

async #verifyVaultPassword(password: string) {

himanshuchawla009 · 2025-04-29T04:34:27Z

packages/seedless-onboarding-controller/src/SeedlessOnboardingController.ts

@@ -94,6 +130,8 @@ export class SeedlessOnboardingController extends BaseController<

  readonly toprfClient: ToprfSecureBackup;

+  #password?: string;


why are we storing password here? Does keyring controller also does this?

himanshuchawla009 · 2025-04-29T04:35:06Z

packages/seedless-onboarding-controller/src/SeedlessOnboardingController.ts

+    }
+    await this.#vaultEncryptor.decrypt(password, this.state.vault);
+  }
+
  /**
   * Unlocks the encrypted vault using the provided password and returns the decrypted vault data.
   * This method ensures thread-safety by using a mutex lock when accessing the vault.


Function description needs to be updated since we don't provide password anymore as arg

himanshuchawla009 · 2025-04-29T04:36:15Z

packages/seedless-onboarding-controller/src/SeedlessOnboardingController.ts

@@ -423,25 +492,58 @@ export class SeedlessOnboardingController extends BaseController<
   * - The password is incorrect (from encryptor.decrypt)
   * - The decrypted vault data is malformed
   */
-  async #unlockVaultWithPassword(password: string): Promise<{
+  async #unlockVaultAndGetBackupEncKey(): Promise<{


it would be rather better to have password as optional param here, rather thn loading it from state inside the function

himanshuchawla009 · 2025-04-29T04:37:29Z

packages/seedless-onboarding-controller/src/SeedlessOnboardingController.ts

      });
+
+      this.#password = password;


since we are setting vaultEncryptionKey above, do we really need to set password as well in class variable, wht the case when vaultEncryptionKey might be missing but password would be required instead?

packages/seedless-onboarding-controller/src/constants.ts

himanshuchawla009 · 2025-04-29T04:39:33Z

packages/seedless-onboarding-controller/src/types.ts

+    encryptedString: EncryptionResult,
+  ) => Promise<unknown>;
+  /**
+   * Generates an encryption key from exported key string.


Suggested change

* Generates an encryption key from exported key string.

* Generates an encryption key from imported key string.

himanshuchawla009 · 2025-04-29T04:39:49Z

packages/seedless-onboarding-controller/src/types.ts

+  /**
+   * Generates an encryption key from exported key string.
+   *
+   * @param key - The exported key string.


Suggested change

* @param key - The exported key string.

* @param key - The imported key string.

## Explanation  When the user vault is decrypted and there is an attempt to restore an unsupported/deprecated/faulty keyring there's no mechanism to remove related metadata, which leads to a situation where no further action can be made on the controller, because checks for keyrings and metadata length will fail. We could remove the related metadata object when the keyring restore fails, but then we would lose the original ID generated for the keyring. We can, instead, change the place where the metadata is stored from a state property to the encrypted vault: by placing the metadata along with its serialised keyring in the vault we can guarantee a 1:1 link between them while being able to keep metadata for unsupported keyrings. Given that we don't need to use the KeyringController state to persist metadata anymore (as it is persisted along with the vault), we can also remove `keyringsMetadata` completely, and add a `metadata` attribute to each keyring in `state.keyrings` instead - which won't be persisted, as it will be recreated at runtime every time the vault is decrypted and the keyrings are deserialised. ## References  * Fixes #5701 ## Changelog  ## Checklist - [ ] I've updated the test suite for new or updated code as appropriate - [ ] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate - [ ] I've communicated my changes to consumers by [updating changelogs for packages I've changed](https://github.com/MetaMask/core/tree/main/docs/contributing.md#updating-changelogs), highlighting breaking changes as necessary - [ ] I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes --------- Co-authored-by: Mark Stacey <[email protected]>

#5788) ## Explanation This PR moves a changelog entry from **13.0.0** to **Unreleased** for `@metamask/profile-sync-controller`. This entry was mistakenly placed in an already released version's changelog. ## References  ## Changelog  ## Checklist - [x] I've updated the test suite for new or updated code as appropriate - [x] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate - [x] I've communicated my changes to consumers by [updating changelogs for packages I've changed](https://github.com/MetaMask/core/tree/main/docs/contributing.md#updating-changelogs), highlighting breaking changes as necessary - [x] I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes

## Explanation This is a RC for v393.0.0. See changelog for more details - `@metamask/[email protected]` ## References Instructions for client migration are in these test drive PRs: - ✅ Extension test drive PR: MetaMask/metamask-extension#32572 - ✅ Mobile test drive PR: MetaMask/metamask-mobile#15211 ## Changelog ```ms ### Changed - Bump `@metamask/profile-sync-controller` from `^13.0.0` to `^14.0.0` ([#5789](#5789)) ``` ## Checklist - [x] I've updated the test suite for new or updated code as appropriate - [x] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate - [x] I've communicated my changes to consumers by [updating changelogs for packages I've changed](https://github.com/MetaMask/core/tree/main/docs/contributing.md#updating-changelogs), highlighting breaking changes as necessary - [x] I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes

socket-security · 2025-05-13T12:56:45Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	@metamask/profile-sync-controller@13.0.0 ⏵ 14.0.0	⁺¹			⁺¹

View full report

socket-security · 2025-05-13T12:56:46Z

Caution

Review the following alerts detected in dependencies.

According to your organization's Security Policy, you must resolve all "Block" alerts before proceeding. Learn more about Socket for GitHub.

Action	Severity	Alert (click for details)
Block		`@metamask/[email protected]` has Network access. Module: globalThis["fetch"] Location: Package overview From: packages/notification-services-controller/package.json → `npm/@metamask/[email protected]` ℹ Read more on: This package \| This alert \| What is network access? Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at `[email protected]`. Suggestion: Packages should remove all network access that is functionally unnecessary. Consumers should audit network access to ensure legitimate use. Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment `@SocketSecurity ignore npm/@metamask/[email protected]`. You can also ignore all packages with `@SocketSecurity ignore-all`. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.

View full report

himanshuchawla009 requested changes Apr 29, 2025

View reviewed changes

mikesposito and others added 3 commits May 13, 2025 11:09

lwin-kyaw force-pushed the feat/seedless-multi-srp branch from 8578a48 to 2136c32 Compare May 13, 2025 12:55

lwin-kyaw closed this May 13, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Support Multi-srp backups in SeedlessOnboardingController #5685

Support Multi-srp backups in SeedlessOnboardingController #5685

Uh oh!

lwin-kyaw commented Apr 22, 2025 •

edited

Loading

Uh oh!

himanshuchawla009 Apr 29, 2025

Uh oh!

himanshuchawla009 Apr 29, 2025

Uh oh!

himanshuchawla009 Apr 29, 2025

Uh oh!

himanshuchawla009 Apr 29, 2025

Uh oh!

himanshuchawla009 Apr 29, 2025

Uh oh!

Uh oh!

himanshuchawla009 Apr 29, 2025

Uh oh!

himanshuchawla009 Apr 29, 2025

Uh oh!

socket-security bot commented May 13, 2025

Uh oh!

socket-security bot commented May 13, 2025

Uh oh!

Uh oh!

	async #verifyPassword(password: string) {
	async #verifyVaultPassword(password: string) {

		@@ -94,6 +130,8 @@ export class SeedlessOnboardingController extends BaseController<

		readonly toprfClient: ToprfSecureBackup;

		#password?: string;

	* Generates an encryption key from exported key string.
	* Generates an encryption key from imported key string.

	* @param key - The exported key string.
	* @param key - The imported key string.

Uh oh!

Support Multi-srp backups in SeedlessOnboardingController #5685

Support Multi-srp backups in SeedlessOnboardingController #5685

Uh oh!

Conversation

lwin-kyaw commented Apr 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation

References

Changelog

@metamask/seedless-onboarding-controller

Checklist

Uh oh!

himanshuchawla009 Apr 29, 2025

Choose a reason for hiding this comment

Uh oh!

himanshuchawla009 Apr 29, 2025

Choose a reason for hiding this comment

Uh oh!

himanshuchawla009 Apr 29, 2025

Choose a reason for hiding this comment

Uh oh!

himanshuchawla009 Apr 29, 2025

Choose a reason for hiding this comment

Uh oh!

himanshuchawla009 Apr 29, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

himanshuchawla009 Apr 29, 2025

Choose a reason for hiding this comment

Uh oh!

himanshuchawla009 Apr 29, 2025

Choose a reason for hiding this comment

Uh oh!

socket-security bot commented May 13, 2025

Uh oh!

socket-security bot commented May 13, 2025

Uh oh!

Uh oh!

lwin-kyaw commented Apr 22, 2025 •

edited

Loading

`@metamask/seedless-onboarding-controller`