Mask tokens when exporting onyx state #47996

TMisiukiewicz · 2024-08-26T12:17:00Z

Details

For security reasons, authToken and encryptedAuthToken should be always masked, regardless of whether the "Mask fragile user data" option is enabled.

This is a follow up to a discussion here: https://expensify.slack.com/archives/C05LX9D6E07/p1724247139893599

Fixed Issues

$ #47995
PROPOSAL:

Tests

Go to Troubleshoot section
Make sure "Mask fragile user data while exporting Onyx state" option is off
Export Onyx state
Open the file and find authToken and encryptedAuthToken
Verify both properties have *** value

Verify that no errors appear in the JS console

Offline tests

QA Steps

Go to Troubleshoot section
Make sure "Mask fragile user data while exporting Onyx state" option is off
Export Onyx state
Open the file and find authToken and encryptedAuthToken
Verify both properties have *** value

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

android-web.mov

iOS: Native

ios.mp4

iOS: mWeb Safari

ios-web.mp4

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

melvin-bot · 2024-08-26T12:17:05Z

@hoangzinh Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

mountiny · 2024-08-26T12:31:23Z

Asked @TMisiukiewicz to add a unit test so we have another layer of protection in case anyone would remove this

TMisiukiewicz · 2024-08-26T13:32:29Z

@mountiny @hoangzinh done ✅

adhorodyski · 2024-08-26T14:41:05Z

src/libs/ExportOnyxState/common.ts

+        if (key !== 'authToken' && key !== 'encryptedAuthToken') {
+            return;
+        }
+        session[key] = '***';


what about extracting this pattern to a global constant?

hoangzinh · 2024-08-26T14:50:08Z

src/libs/ExportOnyxState/common.ts

+    onyxState = maskSessionDetails(data);
+    // Mask fragile data other than session details if the user has enabled the option
+    if (isMaskingFragileDataEnabled) {
+        onyxState = maskFragileData(data);


The function maskSessionDetails is also modifying the data input (we should avoid it). That's why it's weird here, I'm expecting that we should pass onyxState as input here.

…kens

src/libs/ExportOnyxState/common.ts

hoangzinh · 2024-08-27T13:38:29Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Screen.Recording.2024-08-31.at.11.04.52.android.mp4

Android: mWeb Chrome

iOS: Native

Screen.Recording.2024-08-31.at.14.16.10.ios.mov

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

hoangzinh · 2024-08-27T13:43:26Z

src/libs/ExportOnyxState/common.ts

 };
+
+export default maskOnyxState;


Suggested change

export default maskOnyxState;

export default {

maskOnyxState;

}

I think we should export objects here. So we can export other common utils later. What do you think?

good idea, done 👍

hoangzinh · 2024-08-28T10:02:31Z

@TMisiukiewicz don't forget to add screenshots/recordings according to PR checklist.

hoangzinh · 2024-08-28T11:20:40Z

@TMisiukiewicz I'm unable to export Onyx in native apps. It doesn't export any files. Can you check if you can? Thank you

…kens

TMisiukiewicz · 2024-08-28T12:21:31Z

@hoangzinh seems like a difference between exported file on native platforms and web, the Onyx State file is built in a different shape than on the web/desktop. Do you want to align it while working on this PR or should we address it in a separate PR? From my perspective it's safe to fix this here, as currently on main branch the state is exported in a readable format, it's just different than on the web, so it's just a matter of unifying it.

hoangzinh · 2024-08-29T02:15:59Z

the Onyx State file is built in a different shape than on the web/desktop

I think It's intentional. If it happens in main branch as well, I think we should leave it as it is. Btw, I watched your recording for ios/android. I found that it was exported to a text format. But in my case, it's "shm" & "wall" files

TMisiukiewicz · 2024-08-29T07:52:17Z

I think It's intentional. If it happens in main branch as well, I think we should leave it as it is.

Hmm I couldn't find any reasoning about it, I think it's was an oversight. Look at the keys from exported Onyx state on mobile:

Each key is a number, makes it superhard to extract any Onyx key in an efficient way. On web Onyx keys are assigned correctly:

Having in mind we will work on implementing the "import state" feature #47786, I think we should align the export across all platforms to make it work properly regardless of the platform the state was exported from.

Btw, I watched your recording for ios/android. I found that it was exported to a text format. But in my case, it's "shm" & "wall" files

I think those files are automatically generated when you make a dump of the database, however my videos are recorded with a fix mentioned above. In your case it creates a dump, but it cannot find the session key because of the invalid Onyx state structure, so the txt is not created

hoangzinh · 2024-08-29T09:43:40Z

Great. cc @mountiny what do you think about @TMisiukiewicz suggestion above? (Ref #47996 (comment))

mountiny · 2024-08-30T11:37:52Z

@hoangzinh seems like a difference between exported file on native platforms and web, the Onyx State file is built in a different shape than on the web/desktop. Do you want to align it while working on this PR or should we address it in a separate PR? From my perspective it's safe to fix this here, as currently on main branch the state is exported in a readable format, it's just different than on the web, so it's just a matter of unifying it.

@TMisiukiewicz lets unify it here, no rush on getting the current change out without unified format

TMisiukiewicz · 2024-08-30T12:39:56Z

@hoangzinh I unified the exported state and it should work properly on mobiles now, could you please check one more time?

hoangzinh · 2024-08-30T17:31:10Z

@TMisiukiewicz ~~can you export in android app? It shows share screen to me.~~ Nvm I found it

hoangzinh

LGTM

mountiny

Just small NABs that we can skip for now but lets try to leave space above the comments for better readability.

Thanks!

mountiny · 2024-09-02T09:34:33Z

src/libs/ExportOnyxState/common.ts

-    maskFragileData,
+const maskOnyxState = (data: Record<string, unknown>, isMaskingFragileDataEnabled?: boolean) => {
+    let onyxState = data;
+    // Mask session details by default


Suggested change

// Mask session details by default

// Mask session details by default

mountiny · 2024-09-02T09:34:38Z

src/libs/ExportOnyxState/common.ts

+    let onyxState = data;
+    // Mask session details by default
+    onyxState = maskSessionDetails(onyxState);
+    // Mask fragile data other than session details if the user has enabled the option


Suggested change

// Mask fragile data other than session details if the user has enabled the option

// Mask fragile data other than session details if the user has enabled the option

OSBotify · 2024-09-02T09:54:39Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2024-09-02T23:45:05Z

🚀 Deployed to staging by https://github.com/mountiny in version: 9.0.28-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2024-09-03T23:25:41Z

🚀 Deployed to production by https://github.com/roryabraham in version: 9.0.28-3 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

mask tokens when exporting onyx state

326c0da

TMisiukiewicz requested a review from a team as a code owner August 26, 2024 12:17

melvin-bot bot requested review from hoangzinh and removed request for a team August 26, 2024 12:17

mountiny assigned TMisiukiewicz Aug 26, 2024

TMisiukiewicz added 2 commits August 26, 2024 14:45

extract masking to separate function

ebc245e

add tests to maskOnyxState

c8c5b74

adhorodyski reviewed Aug 26, 2024

View reviewed changes

hoangzinh reviewed Aug 26, 2024

View reviewed changes

TMisiukiewicz added 2 commits August 27, 2024 08:20

Merge remote-tracking branch 'upstream/main' into feat/always-mask-to…

48917e3

…kens

code review updates

212197d

TMisiukiewicz requested review from hoangzinh and adhorodyski August 27, 2024 06:31

adhorodyski approved these changes Aug 27, 2024

View reviewed changes

hoangzinh reviewed Aug 27, 2024

View reviewed changes

src/libs/ExportOnyxState/common.ts Show resolved Hide resolved

do not modify original state passed to masking fn

982c21f

hoangzinh reviewed Aug 27, 2024

View reviewed changes

update exports

c6e483a

Merge remote-tracking branch 'upstream/main' into feat/always-mask-to…

5e47f13

…kens

TMisiukiewicz added 2 commits August 30, 2024 13:44

Merge branch 'main' into feat/always-mask-tokens

b046f3c

unify exported onyx state across all platforms

914814b

hoangzinh approved these changes Aug 31, 2024

View reviewed changes

melvin-bot bot requested a review from mountiny August 31, 2024 07:19

mountiny approved these changes Sep 2, 2024

View reviewed changes

mountiny merged commit 5cb6e40 into Expensify:main Sep 2, 2024
17 checks passed

adhorodyski deleted the feat/always-mask-tokens branch September 2, 2024 09:58

github-actions bot mentioned this pull request Sep 2, 2024

Deploy Checklist: New Expensify 2024-09-02 #48438

Closed

46 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Mask tokens when exporting onyx state #47996

Mask tokens when exporting onyx state #47996

TMisiukiewicz commented Aug 26, 2024 •

edited

Loading

melvin-bot bot commented Aug 26, 2024

mountiny commented Aug 26, 2024

TMisiukiewicz commented Aug 26, 2024

adhorodyski Aug 26, 2024

hoangzinh Aug 26, 2024

hoangzinh commented Aug 27, 2024 •

edited

Loading

hoangzinh Aug 27, 2024

TMisiukiewicz Aug 27, 2024

hoangzinh commented Aug 28, 2024

hoangzinh commented Aug 28, 2024 •

edited

Loading

TMisiukiewicz commented Aug 28, 2024

hoangzinh commented Aug 29, 2024

TMisiukiewicz commented Aug 29, 2024

hoangzinh commented Aug 29, 2024

mountiny commented Aug 30, 2024

TMisiukiewicz commented Aug 30, 2024

hoangzinh commented Aug 30, 2024 •

edited

Loading

hoangzinh left a comment

mountiny left a comment

mountiny Sep 2, 2024

mountiny Sep 2, 2024

OSBotify commented Sep 2, 2024

OSBotify commented Sep 2, 2024

OSBotify commented Sep 3, 2024

	// Mask session details by default

	// Mask session details by default

	// Mask fragile data other than session details if the user has enabled the option

	// Mask fragile data other than session details if the user has enabled the option

Mask tokens when exporting onyx state #47996

Mask tokens when exporting onyx state #47996

Conversation

TMisiukiewicz commented Aug 26, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 26, 2024

mountiny commented Aug 26, 2024

TMisiukiewicz commented Aug 26, 2024

adhorodyski Aug 26, 2024

Choose a reason for hiding this comment

hoangzinh Aug 26, 2024

Choose a reason for hiding this comment

hoangzinh commented Aug 27, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

hoangzinh Aug 27, 2024

Choose a reason for hiding this comment

TMisiukiewicz Aug 27, 2024

Choose a reason for hiding this comment

hoangzinh commented Aug 28, 2024

hoangzinh commented Aug 28, 2024 • edited Loading

TMisiukiewicz commented Aug 28, 2024

hoangzinh commented Aug 29, 2024

TMisiukiewicz commented Aug 29, 2024

hoangzinh commented Aug 29, 2024

mountiny commented Aug 30, 2024

TMisiukiewicz commented Aug 30, 2024

hoangzinh commented Aug 30, 2024 • edited Loading

hoangzinh left a comment

Choose a reason for hiding this comment

mountiny left a comment

Choose a reason for hiding this comment

mountiny Sep 2, 2024

Choose a reason for hiding this comment

mountiny Sep 2, 2024

Choose a reason for hiding this comment

OSBotify commented Sep 2, 2024

OSBotify commented Sep 2, 2024

OSBotify commented Sep 3, 2024

TMisiukiewicz commented Aug 26, 2024 •

edited

Loading

hoangzinh commented Aug 27, 2024 •

edited

Loading

hoangzinh commented Aug 28, 2024 •

edited

Loading

hoangzinh commented Aug 30, 2024 •

edited

Loading