fix: password reset

[owencraston]

Description

1. What is the reason for the change?

• This fix addresses a user facing bug in production
• When a user locks the wallet and goes through the forget password flow, the wallet is not accessible with the new password. Instead the user must use the old password to unlock the wallet.
• This is a bug in the keyring controller because the encryptionKey gets generated with the old password and is not reset when the user locks the wallet and generates a new password.

2. What is the improvement/solution?

• This fix patches the keyring controller such that when the user locks the wallet the encryption key gets cleared
• We also clear the encryption key in the#createNewVaultWithKeyring to ensure a new encryption key is generated with the new password when the user logs in again and submitPassword is called.
• This patch will be removed once this PR ships in the keyring controller library

Related issues

Fixes: #25696

Manual testing steps

• Open the extension
• Proceed to Forget password flow
• Paste your secret recovery phrase
• Set a new different password
• Proceed to Restore your Wallet
• After entering the account, lock it and try to login with the new password
• It will throw an Invalid password error

Screenshots/Recordings

Before

346117392-0de00905-ee01-4241-a90e-da60c5eb0976.mov

After

Screen.Recording.2024-07-10.at.2.51.03.PM.mov

Pre-merge author checklist

• I've followed MetaMask Contributor Docs and MetaMask Extension Coding Standards.
• I've completed the PR template to the best of my ability
• I’ve included tests if applicable
• I’ve documented my code using JSDoc format if applicable
• I’ve applied the right labels on the PR (see labeling guidelines). Not required for external contributors.

Pre-merge reviewer checklist

• I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed).
• I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

[github-actions]

CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes.

[metamaskbot]

Builds ready [bdd78df]

• builds: chrome, firefox
• builds (beta): chrome
• builds (flask): chrome, firefox
• builds (MMI): chrome, firefox
• builds (test): chrome, firefox
• builds (test-flask): chrome, firefox
• build viz: Build System
• mv3: Background Module Init Stats
• mv3: UI Init Stats
• mv3: Module Load Stats
• mv3: Bundle Size Stats
• mv2: E2e Actions Stats
• code coverage: Report
• storybook: Storybook
• typescript migration: Dashboard
• all artifacts
• bundle viz:

  • background: 0, 1, 2, 3, 4, 5
  • common: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9
  • content-script: 0
  • offscreen: 0
  • ui: 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (177 ± 235 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	73	470	115	83	40
		domContentLoaded	9	90	31	18	9
		load	45	2306	177	489	235
		domInteractive	9	90	31	18	9

Bundle size diffs [🚨 Warning! Bundle size has increased!]

• background: 0 Bytes (0.00%)
• ui: 0 Bytes (0.00%)
• common: 114 Bytes (0.00%)

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.77%. Comparing base (5ee57a6) to head (bdd78df).
Report is 23 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop   #25753      +/-   ##
===========================================
- Coverage    69.77%   69.77%   -0.00%     
===========================================
  Files         1376     1378       +2     
  Lines        48403    48539     +136     
  Branches     13348    13387      +39     
===========================================
+ Hits         33773    33866      +93     
- Misses       14630    14673      +43     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud