Skip to content

fix: confusing error message when using wrong password#5627

Merged
mikesposito merged 7 commits into
mainfrom
mikesposito/fix/wrong-password-error
Apr 15, 2025
Merged

fix: confusing error message when using wrong password#5627
mikesposito merged 7 commits into
mainfrom
mikesposito/fix/wrong-password-error

Conversation

@mikesposito

@mikesposito mikesposito commented Apr 10, 2025

Copy link
Copy Markdown
Member

Explanation

When calling submitPassword with the wrong password, a confusing error is shown instead of Incorrect password. This is due to the recently added metadata length check in #restoreSerializedKeyrings, which doesn't match the correct behavior when isUnlocked = true.

We can move the metadata length check to #unlockKeyrings, so that it will be skipped everytime the controller is locked

References

Changelog

Changelog updated in the PR

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

@mikesposito

Copy link
Copy Markdown
Member Author

@metamaskbot publish-preview

@github-actions

Copy link
Copy Markdown
Contributor

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions.
{
  "@metamask-previews/accounts-controller": "27.0.0-preview-a906644",
  "@metamask-previews/address-book-controller": "6.0.3-preview-a906644",
  "@metamask-previews/announcement-controller": "7.0.3-preview-a906644",
  "@metamask-previews/app-metadata-controller": "1.0.0-preview-a906644",
  "@metamask-previews/approval-controller": "7.1.3-preview-a906644",
  "@metamask-previews/assets-controllers": "56.0.0-preview-a906644",
  "@metamask-previews/base-controller": "8.0.0-preview-a906644",
  "@metamask-previews/bridge-controller": "13.0.0-preview-a906644",
  "@metamask-previews/bridge-status-controller": "12.0.0-preview-a906644",
  "@metamask-previews/build-utils": "3.0.3-preview-a906644",
  "@metamask-previews/chain-agnostic-permission": "0.3.0-preview-a906644",
  "@metamask-previews/composable-controller": "11.0.0-preview-a906644",
  "@metamask-previews/controller-utils": "11.7.0-preview-a906644",
  "@metamask-previews/earn-controller": "0.11.0-preview-a906644",
  "@metamask-previews/eip1193-permission-middleware": "0.1.0-preview-a906644",
  "@metamask-previews/ens-controller": "16.0.0-preview-a906644",
  "@metamask-previews/eth-json-rpc-provider": "4.1.8-preview-a906644",
  "@metamask-previews/gas-fee-controller": "23.0.0-preview-a906644",
  "@metamask-previews/json-rpc-engine": "10.0.3-preview-a906644",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.7-preview-a906644",
  "@metamask-previews/keyring-controller": "21.0.2-preview-a906644",
  "@metamask-previews/logging-controller": "6.0.4-preview-a906644",
  "@metamask-previews/message-manager": "12.0.1-preview-a906644",
  "@metamask-previews/multichain": "4.0.0-preview-a906644",
  "@metamask-previews/multichain-api-middleware": "0.1.1-preview-a906644",
  "@metamask-previews/multichain-network-controller": "0.3.0-preview-a906644",
  "@metamask-previews/multichain-transactions-controller": "0.9.0-preview-a906644",
  "@metamask-previews/name-controller": "8.0.3-preview-a906644",
  "@metamask-previews/network-controller": "23.2.0-preview-a906644",
  "@metamask-previews/notification-services-controller": "5.0.1-preview-a906644",
  "@metamask-previews/permission-controller": "11.0.6-preview-a906644",
  "@metamask-previews/permission-log-controller": "3.0.3-preview-a906644",
  "@metamask-previews/phishing-controller": "12.4.1-preview-a906644",
  "@metamask-previews/polling-controller": "13.0.0-preview-a906644",
  "@metamask-previews/preferences-controller": "17.0.0-preview-a906644",
  "@metamask-previews/profile-sync-controller": "11.0.1-preview-a906644",
  "@metamask-previews/queued-request-controller": "10.0.0-preview-a906644",
  "@metamask-previews/rate-limit-controller": "6.0.3-preview-a906644",
  "@metamask-previews/remote-feature-flag-controller": "1.6.0-preview-a906644",
  "@metamask-previews/sample-controllers": "0.1.0-preview-a906644",
  "@metamask-previews/selected-network-controller": "22.0.0-preview-a906644",
  "@metamask-previews/signature-controller": "27.1.0-preview-a906644",
  "@metamask-previews/token-search-discovery-controller": "2.1.0-preview-a906644",
  "@metamask-previews/transaction-controller": "54.0.0-preview-a906644",
  "@metamask-previews/user-operation-controller": "33.0.0-preview-a906644"
}

Comment thread packages/keyring-controller/CHANGELOG.md Outdated
@mikesposito mikesposito marked this pull request as ready for review April 14, 2025 10:21
@mikesposito mikesposito requested review from a team as code owners April 14, 2025 10:21
cryptodev-2s
cryptodev-2s previously approved these changes Apr 14, 2025

@cryptodev-2s cryptodev-2s left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Gudahtt
Gudahtt previously approved these changes Apr 14, 2025

@Gudahtt Gudahtt left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@mikesposito mikesposito dismissed stale reviews from Gudahtt and cryptodev-2s via 9f75c13 April 15, 2025 10:15

@cryptodev-2s cryptodev-2s left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@mikesposito mikesposito merged commit 5dab9ca into main Apr 15, 2025
@mikesposito mikesposito deleted the mikesposito/fix/wrong-password-error branch April 15, 2025 15:29
NicolasMassart added a commit to MetaMask/metamask-mobile that referenced this pull request Apr 24, 2025
github-merge-queue Bot pushed a commit to MetaMask/metamask-mobile that referenced this pull request Apr 25, 2025
…4702)

<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

<!--
Write a short description of the changes included in this pull request,
also include relevant motivation and context. Have in mind the following
questions:
1. What is the reason for the change?
2. What is the improvement/solution?
-->

Updating `@metamask/keyring-controller` to `^21.0.4`

```markdown
## [21.0.4]

### Fixed

- Ensure no duplicate accounts are persisted ([#5710](MetaMask/core#5710))

## [21.0.3]

### Changed

- `ExportableKeyEncryptor` is now a generic type with a type parameter `EncryptionKey` ([#5395](MetaMask/core#5395))
  - The type parameter defaults to `unknown`

### Fixed

- Fixed wrong error message thrown when using the wrong password ([#5627](MetaMask/core#5627))

## [21.0.2]

### Changed

- Bump `@metamask/keyring-api` from `^17.2.0` to `^17.4.0` ([#5565](MetaMask/core#5565))
- Bump `@metamask/keyring-internal-api` from `^6.0.0` to `^6.0.1` ([#5565](MetaMask/core#5565))

### Fixed

- Ignore cached encryption key when the vault needs to upgrade its encryption parameters ([#5601](MetaMask/core#5601))


```

## **Related issues**

Fixes: #14228 

## **Manual testing steps**

1. Go to this page...
2.
3.

## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**

<!-- [screenshots/recordings] -->

### **After**

<!-- [screenshots/recordings] -->

## **Pre-merge author checklist**

- [ ] I’ve followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Mobile
Coding
Standards](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/CODING_GUIDELINES.md).
- [ ] 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](https://jsdoc.app/) format
if applicable
- [ ] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/LABELING_GUIDELINES.md)).
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.

---------

Co-authored-by: Nico MASSART <NicolasMassart@users.noreply.github.com>
runway-github Bot pushed a commit to MetaMask/metamask-mobile that referenced this pull request Apr 30, 2025
…ontroller` to `^21.0.4` (#14702)

<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

<!--
Write a short description of the changes included in this pull request,
also include relevant motivation and context. Have in mind the following
questions:
1. What is the reason for the change?
2. What is the improvement/solution?
-->

Updating `@metamask/keyring-controller` to `^21.0.4`

```markdown
## [21.0.4]

### Fixed

- Ensure no duplicate accounts are persisted ([#5710](MetaMask/core#5710))

## [21.0.3]

### Changed

- `ExportableKeyEncryptor` is now a generic type with a type parameter `EncryptionKey` ([#5395](MetaMask/core#5395))
  - The type parameter defaults to `unknown`

### Fixed

- Fixed wrong error message thrown when using the wrong password ([#5627](MetaMask/core#5627))

## [21.0.2]

### Changed

- Bump `@metamask/keyring-api` from `^17.2.0` to `^17.4.0` ([#5565](MetaMask/core#5565))
- Bump `@metamask/keyring-internal-api` from `^6.0.0` to `^6.0.1` ([#5565](MetaMask/core#5565))

### Fixed

- Ignore cached encryption key when the vault needs to upgrade its encryption parameters ([#5601](MetaMask/core#5601))


```

## **Related issues**

Fixes: #14228 

## **Manual testing steps**

1. Go to this page...
2.
3.

## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**

<!-- [screenshots/recordings] -->

### **After**

<!-- [screenshots/recordings] -->

## **Pre-merge author checklist**

- [ ] I’ve followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Mobile
Coding
Standards](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/CODING_GUIDELINES.md).
- [ ] 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](https://jsdoc.app/) format
if applicable
- [ ] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/LABELING_GUIDELINES.md)).
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.

---------

Co-authored-by: Nico MASSART <NicolasMassart@users.noreply.github.com>
EtherWizard33 pushed a commit to MetaMask/metamask-mobile that referenced this pull request May 2, 2025
…4702)

<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

<!--
Write a short description of the changes included in this pull request,
also include relevant motivation and context. Have in mind the following
questions:
1. What is the reason for the change?
2. What is the improvement/solution?
-->

Updating `@metamask/keyring-controller` to `^21.0.4`

```markdown
## [21.0.4]

### Fixed

- Ensure no duplicate accounts are persisted ([#5710](MetaMask/core#5710))

## [21.0.3]

### Changed

- `ExportableKeyEncryptor` is now a generic type with a type parameter `EncryptionKey` ([#5395](MetaMask/core#5395))
  - The type parameter defaults to `unknown`

### Fixed

- Fixed wrong error message thrown when using the wrong password ([#5627](MetaMask/core#5627))

## [21.0.2]

### Changed

- Bump `@metamask/keyring-api` from `^17.2.0` to `^17.4.0` ([#5565](MetaMask/core#5565))
- Bump `@metamask/keyring-internal-api` from `^6.0.0` to `^6.0.1` ([#5565](MetaMask/core#5565))

### Fixed

- Ignore cached encryption key when the vault needs to upgrade its encryption parameters ([#5601](MetaMask/core#5601))


```

## **Related issues**

Fixes: #14228 

## **Manual testing steps**

1. Go to this page...
2.
3.

## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**

<!-- [screenshots/recordings] -->

### **After**

<!-- [screenshots/recordings] -->

## **Pre-merge author checklist**

- [ ] I’ve followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Mobile
Coding
Standards](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/CODING_GUIDELINES.md).
- [ ] 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](https://jsdoc.app/) format
if applicable
- [ ] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/LABELING_GUIDELINES.md)).
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.

---------

Co-authored-by: Nico MASSART <NicolasMassart@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Sentry] Error: KeyringController - keyring metadata length mismatch

4 participants