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 upgrades the keyring controller to version 17.1.1 which fixes this bug by clearing the encryption key/salt when the user locks the wallet as well as when they submit their password. This ensures that the encryption key is always in sync with the latest password.
• The keyring controller pr for this fix can be found here
• This change involved a major version bump for the keyring controller from 16 to 17. Here is the changelog for this bump.

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
• You should be able to log in with your new password

Screenshots/Recordings

Before

Reset.wallet.Chrome.mov

After

Screen.Recording.2024-07-16.at.5.55.05.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.

[owencraston]

@metamaskbot update-policies

[socket-security]

Removed dependencies detected. Learn more about Socket for GitHub ↗︎

View full report↗︎

[metamaskbot]

Policies updated

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.76%. Comparing base (20f54db) to head (eb7514b).

Additional details and impacted files

@@           Coverage Diff            @@
##           develop   #25847   +/-   ##
========================================
  Coverage    69.76%   69.76%           
========================================
  Files         1398     1398           
  Lines        49171    49171           
  Branches     13574    13574           
========================================
  Hits         34303    34303           
  Misses       14868    14868           

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

[metamaskbot]

Builds ready [eb7514b]

• 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, 10, 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 (152 ± 179 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	79	133	100	14	7
		domContentLoaded	11	57	26	9	4
		load	45	1776	152	373	179
		domInteractive	11	57	26	9	4

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

• background: 53.27 KiB (1.62%)
• ui: 0 Bytes (0.00%)
• common: 299.75 KiB (4.61%)

[owencraston]

@metamaskbot update-policies

[metamaskbot]

No policy changes

[owencraston]

@metamaskbot update-policies

[metamaskbot]

Policies updated

[sonarcloud]

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

[metamaskbot]

Builds ready [047402c]

• 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, 10, 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 (164 ± 157 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	76	380	135	77	37
		domContentLoaded	10	93	38	21	10
		load	42	1575	164	327	157
		domInteractive	10	93	38	21	10

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

• background: 11.47 KiB (0.34%)
• ui: 0 Bytes (0.00%)
• common: 38.08 KiB (0.56%)

[gantunesr]

lgtm

[mikesposito]

Looks good!

[mikesposito]

Unfortunately, I didn't notice that this bump breaks a peer dependency rule for @metamask/signature-controller. I opened another PR to bump @metamask/signature-controller and @metamask/user-operation-controller