feat: Add new metadata properties to accounts controllers #6470
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
Gudahtt
force-pushed
the
add-new-metadata-to-account-controllers
branch
from
752701c to
efe9a17
Compare
Gudahtt
force-pushed
the
add-new-metadata-to-account-controllers
branch
from
cdd9334 to
44f6941
Compare
ccharly
reviewed
Sep 10, 2025
...ages/profile-sync-controller/src/controllers/authentication/AuthenticationController.test.ts
Show resolved
Hide resolved
ccharly
approved these changes
Sep 10, 2025
There was a problem hiding this comment.
LGTM (I know @gantunesr wanted to have a look too), we might also need approval from @mathieuartu for the identity part.
mathieuartu
approved these changes
Sep 10, 2025
The new metadata properties `includeInStateLogs` and `usedInUi` have been added to all controllers maintained by the accounts team. Related to #6443
Gudahtt
force-pushed
the
add-new-metadata-to-account-controllers
branch
from
44f6941 to
deea146
Compare
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
| includeInStateLogs: true, | ||
| persist: true, | ||
| anonymous: false, | ||
| usedInUi: true, |
There was a problem hiding this comment.
Bug: Sensitive Data Exposed in Logs and UI
The srpSessionData metadata now sets includeInStateLogs: true and usedInUi: true. This field contains sensitive authentication data, such as access tokens and profile identifiers. This change could expose these credentials in state logs and to UI consumers, creating a security vulnerability.
There was a problem hiding this comment.
Hmm. The usedInUi part can be ignored, we don't treat the UI as a security boundary for things like this today.
It does seem like a mistake to include this in the state logs though. I'll propose a fix in a follow up PR.
Gudahtt
added a commit
that referenced
this pull request
Sep 10, 2025
The metadata property was recently added to the `AuthenticationController` in #6470, but we forgot to strip out the `accessToken`. This is currently being stripped from state logs in both clients. The metadata was updated to strip out this token. Additionally, some improvements were added to the metadata snapshot tests to ensure that all properties are represented in the fixture state. The `@metamask/utils` package was added as a dependency because the new metadata state deriver uses `Json` in its signature, so that type is now used in the exported types for this package.
4 tasks
Gudahtt
added a commit
that referenced
this pull request
Sep 10, 2025
The metadata property was recently added to the `AuthenticationController` in #6470, but we forgot to strip out the `accessToken`. This is currently being stripped from state logs in both clients. The metadata was updated to strip out this token. Additionally, some improvements were added to the metadata snapshot tests to ensure that all properties are represented in the fixture state. The `@metamask/utils` package was added as a dependency because the new metadata state deriver uses `Json` in its signature, so that type is now used in the exported types for this package.
Gudahtt
added a commit
that referenced
this pull request
Sep 11, 2025
The metadata property was recently added to the `AuthenticationController` in #6470, but we forgot to strip out the `accessToken`. This is currently being stripped from state logs in both clients. The metadata was updated to strip out this token. Additionally, some improvements were added to the metadata snapshot tests to ensure that all properties are represented in the fixture state. The `@metamask/utils` package was added as a dependency because the new metadata state deriver uses `Json` in its signature, so that type is now used in the exported types for this package.
Gudahtt
added a commit
that referenced
this pull request
Sep 11, 2025
The metadata property was recently added to the `AuthenticationController` in #6470, but we forgot to strip out the `accessToken`. This is currently being stripped from state logs in both clients. The metadata was updated to strip out this token. Additionally, some improvements were added to the metadata snapshot tests to ensure that all properties are represented in the fixture state. The `@metamask/utils` package was added as a dependency because the new metadata state deriver uses `Json` in its signature, so that type is now used in the exported types for this package.
Gudahtt
added a commit
that referenced
this pull request
Sep 12, 2025
The metadata property was recently added to the `AuthenticationController` in #6470, but we forgot to strip out the `accessToken`. This is currently being stripped from state logs in both clients. The metadata was updated to strip out this token. Additionally, some improvements were added to the metadata snapshot tests to ensure that all properties are represented in the fixture state. The `@metamask/utils` package was added as a dependency because the new metadata state deriver uses `Json` in its signature, so that type is now used in the exported types for this package.
Gudahtt
added a commit
that referenced
this pull request
Sep 12, 2025
…6553) ## Explanation The metadata property was recently added to the `AuthenticationController` in #6470, but we forgot to strip out the `accessToken`. This is currently being stripped from state logs in both clients. The metadata was updated to strip out this token. Additionally, some improvements were added to the metadata snapshot tests to ensure that all properties are represented in the fixture state. The `@metamask/utils` package was added as a dependency because the new metadata state deriver uses `Json` in its signature, so that type is now used in the exported types for this package. ## References This is an amendment to #6470 ## 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
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
The new metadata properties
includeInStateLogsandusedInUihave been added to all controllers maintained by the accounts team.References
Related to #6443
Checklist