Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: mask fields with sensitive data for Export #53559

Merged
merged 3 commits into from
Dec 12, 2024
Merged

fix: mask fields with sensitive data for Export #53559

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
70cef3c
create a fixed list of keys that explicitly need masking
TMisiukiewicz Dec 4, 2024
9daae65
add test
TMisiukiewicz Dec 4, 2024
b24b57c
Merge branch 'main' into fix/mask-missing-fields
TMisiukiewicz Dec 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 25 additions & 2 deletions src/libs/ExportOnyxState/common.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,23 @@ import ONYXKEYS from '@src/ONYXKEYS';
import type {Session} from '@src/types/onyx';

const MASKING_PATTERN = '***';
const keysToMask = [
'plaidLinkToken',
'plaidAccessToken',
'plaidAccountID',
'addressName',
'addressCity',
'addressStreet',
'addressZipCode',
'street',
'city',
'state',
'zip',
'edits',
'lastMessageHtml',
'lastMessageText',
];

const emailRegex = /[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}/;

const emailMap = new Map<string, string>();
Expand Down Expand Up @@ -94,12 +111,18 @@ const maskFragileData = (data: Record<string, unknown> | unknown[] | null, paren

const value = data[propertyName];

if (typeof value === 'string' && Str.isValidEmail(value)) {
if (keysToMask.includes(key)) {
if (Array.isArray(value)) {
maskedData[key] = value.map(() => MASKING_PATTERN);
} else {
maskedData[key] = MASKING_PATTERN;
}
} else if (typeof value === 'string' && Str.isValidEmail(value)) {
maskedData[propertyName] = maskEmail(value);
} else if (typeof value === 'string' && stringContainsEmail(value)) {
maskedData[propertyName] = replaceEmailInString(value, maskEmail(extractEmail(value) ?? ''));
} else if (parentKey && parentKey.includes(ONYXKEYS.COLLECTION.REPORT_ACTIONS) && (propertyName === 'text' || propertyName === 'html')) {
maskedData[propertyName] = MASKING_PATTERN;
maskedData[key] = MASKING_PATTERN;
} else if (typeof value === 'object') {
maskedData[propertyName] = maskFragileData(value as Record<string, unknown>, propertyName.includes(ONYXKEYS.COLLECTION.REPORT_ACTIONS) ? propertyName : parentKey);
} else {
Expand Down
14 changes: 14 additions & 0 deletions tests/unit/ExportOnyxStateTest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import type * as OnyxTypes from '@src/types/onyx';

type ExampleOnyxState = {
session: OnyxTypes.Session;
[key: string]: unknown;
};

describe('maskOnyxState', () => {
Expand Down Expand Up @@ -85,4 +86,17 @@ describe('maskOnyxState', () => {
const result = ExportOnyxState.maskOnyxState(input, true) as Record<string, string>;
expect(result.emailString).not.toContain('user@example.com');
});

it('should mask keys that are in the fixed list', () => {
const input = {
session: mockSession,
edits: ['hey', 'hi'],
lastMessageHtml: 'hey',
};

const result = ExportOnyxState.maskOnyxState(input, true) as ExampleOnyxState;

expect(result.edits).toEqual(['***', '***']);
expect(result.lastMessageHtml).toEqual('***');
});
});
Loading