refactor: cache vault data while unlock #6205
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
|
@metamaskbot publish-preview |
lwin-kyaw
changed the title
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
lwin-kyaw
force-pushed
the
feat/seedless-state-update
branch
from
08fa4b0 to
848c8e7
Compare
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
packages/seedless-onboarding-controller/src/SeedlessOnboardingController.ts
Outdated
Show resolved
Hide resolved
packages/seedless-onboarding-controller/src/SeedlessOnboardingController.ts
Outdated
Show resolved
Hide resolved
packages/seedless-onboarding-controller/src/SeedlessOnboardingController.ts
Outdated
Show resolved
Hide resolved
packages/seedless-onboarding-controller/src/SeedlessOnboardingController.ts
Show resolved
Hide resolved
packages/seedless-onboarding-controller/src/SeedlessOnboardingController.ts
Outdated
Show resolved
Hide resolved
lwin-kyaw
force-pushed
the
feat/seedless-state-update
branch
from
becffc2 to
d084fe8
Compare
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
mcmire
reviewed
Aug 13, 2025
|
I notice that you've applied the |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
matthiasgeihs
requested changes
Aug 19, 2025
packages/seedless-onboarding-controller/src/SeedlessOnboardingController.ts
Outdated
Show resolved
Hide resolved
lwin-kyaw
force-pushed
the
feat/seedless-state-update
branch
from
d37d238 to
4efa65b
Compare
lwin-kyaw
changed the title
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
lwin-kyaw
commented
Aug 27, 2025
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
Hi @mcmire, Yes, this is a refactor PR and some optimization (caching) for internal vault logics |
matthiasgeihs
previously approved these changes
Aug 27, 2025
| revokeToken, | ||
| accessToken, | ||
| }; | ||
| const deserializedVaultData = deserializeVaultData(vaultData); |
There was a problem hiding this comment.
Hm, I don't understand why you separate parsing and deserialization? Why don't you merge deserialization into #decryptAndParseVaultData?
| await expect( | ||
| controller.submitPassword(MOCK_PASSWORD), | ||
| ).rejects.toThrow( | ||
| SeedlessOnboardingControllerErrorMessage.InvalidVaultData, |
There was a problem hiding this comment.
Are you throwing a different error here than before? If so, this can be considered a breaking change (depending on your definition of breaking change).
Comment on lines
+192
to
+196
| /** | ||
| * The TTL of the password outdated cache in milliseconds. | ||
| */ | ||
| readonly #passwordOutdatedCacheTTL: number; | ||
|
|
There was a problem hiding this comment.
Why did you move that up?
TransactionController is maintaining an alphabetical ordering on properties and I kind of like it.
There was a problem hiding this comment.
I just wanna group the readonly variables in one block. That's why I moved that up.
| ); | ||
| decryptedVaultData = result.vault; | ||
| vaultEncryptionKey = result.exportedKeyString; | ||
| vaultEncryptionSalt = result.salt; |
There was a problem hiding this comment.
It's not supposed to validate the password, if the key is given, right?
Comment on lines
-1638
to
+1619
| SeedlessOnboardingControllerErrorMessage.InvalidVaultData, | ||
| ); | ||
| throw new Error(SeedlessOnboardingControllerErrorMessage.VaultDataError); | ||
| } | ||
|
|
||
| let parsedVaultData: unknown; | ||
| try { | ||
| parsedVaultData = JSON.parse(data); | ||
| } catch { | ||
| throw new Error( | ||
| SeedlessOnboardingControllerErrorMessage.InvalidVaultData, | ||
| ); | ||
| throw new Error(SeedlessOnboardingControllerErrorMessage.VaultDataError); |
There was a problem hiding this comment.
Changing the error type can be considered a breaking change.
Why did you change it?
There was a problem hiding this comment.
Previously, it throws Invalid vault data error.
But I think the error should be The decrypted vault has an unexpected shape. since this is the parse error.
There was a problem hiding this comment.
I see. I think the previous error message was fine, but the new one is more differentiated. I think the error variable names are not expressive enough to reflect that meaning, so this can lead to them not being used correctly.
mcmire
reviewed
Aug 27, 2025
Comment on lines
123
to
124
| | SeedlessOnboardingControllerEvents | ||
| | ExtractAvailableEvent<SeedlessOnboardingControllerMessenger> |
There was a problem hiding this comment.
Nit: SeedlessOnboardingControllerEvents is already included in ExtractAvailableEvent<SeedlessOnboardingControllerMessenger>, so you should be able to simplify this:
Suggested change
| | SeedlessOnboardingControllerEvents | |
| | ExtractAvailableEvent<SeedlessOnboardingControllerMessenger> | |
| ExtractAvailableEvent<SeedlessOnboardingControllerMessenger> |
There was a problem hiding this comment.
Thanks for the review. I've addressed it in this commit, d7be4d5
Comment on lines
21
to
22
| | SeedlessOnboardingControllerEvents | ||
| | ExtractAvailableEvent<SeedlessOnboardingControllerMessenger> |
There was a problem hiding this comment.
Nit: SeedlessOnboardingControllerEvents is already included in ExtractAvailableEvent<SeedlessOnboardingControllerMessenger>, so you should be able to simplify this:
Suggested change
| | SeedlessOnboardingControllerEvents | |
| | ExtractAvailableEvent<SeedlessOnboardingControllerMessenger> | |
| ExtractAvailableEvent<SeedlessOnboardingControllerMessenger> |
There was a problem hiding this comment.
Addressed here, d7be4d5
lwin-kyaw
force-pushed
the
feat/seedless-state-update
branch
from
d7be4d5 to
5c673a8
Compare
| await this.#decryptAndParseVaultData(password, encryptionKey); | ||
| if (this.#cachedDecryptedVaultData) { | ||
| return this.#cachedDecryptedVaultData; | ||
| } |
There was a problem hiding this comment.
Bug: Premature Cache Return Bypasses Security Checks
The caching in #unlockVaultAndGetVaultData returns cached vault data prematurely. This bypasses all validation checks, including password, encryption key, and salt verification, which could lead to incorrect credentials appearing valid or the use of stale/compromised data.
matthiasgeihs
approved these changes
Aug 28, 2025
|
Another worthwhile optimization would be to use the cached encryption key for encryption as well. (Currently it's only used for decryption.) And we may want to rotate the key after each controller unlock, like the KeyringController does it. |
Yes definitely. I will address this in the new PR, coz that includes breaking change to the encryptor interface. |
lwin-kyaw
force-pushed
the
feat/seedless-state-update
branch
from
5c673a8 to
2fccc63
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Explanation
This PR includes some refactors and optimizations of vault operations (lock/unlock) in the SeedlessOnboarding controller.
References
Changelog
Checklist