feat: add 2-factor authentication #18576

thiagobrez · 2023-05-08T12:29:04Z

Details

Implementation of the 2-factor authentication flow, according to the design doc.

Fixed Issues

$ #18080
PROPOSAL: GH_LINK_ISSUE(COMMENT)

Tests

Verify that no errors appear in the JS console
Go to profile
Go to Security tab
Go to Two-factor authentication tab

Enabling 2-FA flow:

Step 1: Recovery Codes

A list of recovery codes should appear. Next button should only be enabled if one of "Copy" or "Download" buttons was pressed before
Pressing "Copy" should copy the recovery codes to the clipboard
Pressing "Download" should download the file locally to the device. On iOS it should open the "Share" menu, enabling the user to save anywhere wanted. On Android, it should download directly to the Downloads folder

Step 2: Verify

A blue link in the top of the page should redirect to the expensify FAQ regarding setting up an authenticator app
A QRCode should appear and should be able to scan using an authenticator app. Once you scan, it should show in the authenticator app the "Expensify" name and the user primary login (usually email)
In case the user can't use the QRCode to set up the authenticator app, should be able to press the "Copy" button to input the secret manually in the authenticator app
Once the authenticator app is setup, user should be able to enter the generated code in the input at the bottom of the page. Entering the correct code should automatically move the user to the success page. Entering an incorrect code should show an error below the input

Step 3: Finished

A fireworks animation should appear. Pressing the next button should finish the flow and take the user to the main two-factor authentication page, where it will say that 2-fa is enabled

Disabling 2-FA flow:

Pressing the disable button should open a modal
Confirming the modal should take the user to the success page, indicating that 2-FA was disabled
Pressing "Got it" should take the user back to the Security settings page

Offline tests

All pages implement Offline Pattern D, so they should be blocked when offline

QA Steps

Verify that no errors appear in the JS console
Go to profile
Go to Security tab
Go to Two-factor authentication tab

Enabling 2-FA flow:

Step 1: Recovery Codes

A list of recovery codes should appear. Next button should only be enabled if one of "Copy" or "Download" buttons was pressed before
Pressing "Copy" should copy the recovery codes to the clipboard
Pressing "Download" should download the file locally to the device. On iOS it should open the "Share" menu, enabling the user to save anywhere wanted. On Android, it should download directly to the Downloads folder

Step 2: Verify

A blue link in the top of the page should redirect to the expensify FAQ regarding setting up an authenticator app
A QRCode should appear and should be able to scan using an authenticator app. Once you scan, it should show in the authenticator app the "Expensify" name and the user primary login (usually email)
In case the user can't use the QRCode to set up the authenticator app, should be able to press the "Copy" button to input the secret manually in the authenticator app
Once the authenticator app is setup, user should be able to enter the generated code in the input at the bottom of the page. Entering the correct code should automatically move the user to the success page. Entering an incorrect code should show an error below the input

Step 3: Finished

A fireworks animation should appear. Pressing the next button should finish the flow and take the user to the main two-factor authentication page, where it will say that 2-fa is enabled

Disabling 2-FA flow:

Pressing the disable button should open a modal
Confirming the modal should take the user to the success page, indicating that 2-FA was disabled
Pressing "Got it" should take the user back to the Security settings page

PR Author Checklist

Screenshots/Videos

Web

web.mov

safari.mov

Mobile Web - Chrome

android.web.mov

Mobile Web - Safari

ios.web.mp4

Desktop

desktop.mov

iOS

ios.mp4

Android

android.mov

thiagobrez · 2023-05-08T13:12:03Z

Important notes / open questions:

Design doc did not contain specific directions to downloading the codes on native (only web), so I decided to use the Share API on iOS, and saving to the Downloads folder on Android. See TextFileLink.ios.js and TextFileLink.android.js
Design doc did not contain desired spanish translations, so I did it manually and these should probably be reviewed with caution!
QRCode looks quite different from design using the proposed level of correction Q. Maybe we want to try different levels?

MonilBhavsar · 2023-05-08T13:20:55Z

Important notes / open questions:

Design doc did not contain specific directions to downloading the codes on native (only web), so I decided to use the Share API on iOS, and saving to the Downloads folder on Android. See TextFileLink.ios.js and TextFileLink.android.js

Yes, we missed it. That sounds good 👍

Design doc did not contain desired spanish translations, so I did it manually and these should probably be reviewed with caution!

I can get that for you!

QRCode looks quite different from design using the proposed level of correction Q. Maybe we want to try different levels?

I tried using different levels while writing the doc, but looks like 'Q' is closest to the proposed one. Do you think any other level is closest to the proposed one? If so, we can use that. 😄

thiagobrez · 2023-05-08T13:37:22Z

Awesome, thanks @MonilBhavsar !

Here is a quick comparison between all QRCode levels:

L

M

Q

H

Personally, I find the L level the closest to design, but not sure if being too low on detail can cause technical issues while scanning

MonilBhavsar · 2023-05-08T13:52:54Z

L looks good to me 👍
Not sure why Q seemed to be close to me at that time.
Also, we'll be refactoring this QR code design to meet our proposed design after this PR is merged

src/ROUTES.js

src/components/TextFileLink/index.android.js

src/pages/settings/Security/TwoFactorAuth/VerifyPage.js

src/pages/settings/Security/TwoFactorAuth/SuccessPage.js

src/pages/settings/Security/TwoFactorAuth/CodesPage.js

src/pages/settings/Security/TwoFactorAuth/IsEnabledPage.js

src/pages/settings/Security/TwoFactorAuth/TwoFactorAuthForm/BaseTwoFactorAuthForm.js

src/pages/settings/Security/TwoFactorAuth/VerifyPage.js

src/languages/es.js

src/libs/actions/Session/index.js

src/pages/settings/Security/SecuritySettingsPage.js

src/pages/settings/Security/TwoFactorAuth/CodesPage.js

src/pages/settings/Security/TwoFactorAuth/DisablePage.js

src/pages/settings/Security/TwoFactorAuth/IsEnabledPage.js

thiagobrez · 2023-05-16T15:40:05Z

@MonilBhavsar All new comments resolved, good catches! 👍🏻

Regarding clearing the Onyx data, since that page is now a functional component (following the effort to migrate away from Class Components) I disabled the arrow-body-style eslint rule (and left a comment) for that unmount effect because I thought it made the code block unreadable:

Before	After

And here's the shield icon result:

MonilBhavsar · 2023-05-17T09:40:07Z

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 / Chrome
- iOS / native
- iOS / 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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(themeColors.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 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

Web

Screen.Recording.2023-05-17.at.3.28.05.PM.mov

Mobile Web - Chrome

Screen.Recording.2023-05-17.at.3.57.16.PM.mov

Mobile Web - Safari

Screen.Recording.2023-05-17.at.5.19.22.PM.mov

Desktop

Screen.Recording.2023-05-17.at.3.30.55.PM.mov

iOS

Android

Screen.Recording.2023-05-17.at.4.05.27.PM.mov

MonilBhavsar

Great work @thiagobrez 👏

OSBotify · 2023-05-17T15:36:55Z

✋ 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 · 2023-05-18T07:38:42Z

🚀 Deployed to staging by https://github.com/MonilBhavsar in version: 1.3.16-0 🚀

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

OSBotify · 2023-05-22T23:40:09Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.16-7 🚀

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

OSBotify · 2023-05-23T00:16:04Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.16-7 🚀

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

OSBotify · 2023-05-23T19:53:58Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.16-7 🚀

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

OSBotify · 2023-05-23T21:52:42Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.16-7 🚀

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

abdulrahuman5196 · 2023-06-05T18:13:01Z

A minor regression caused due to height styles having less value - #19571

abdulrahuman5196 · 2023-06-30T14:00:18Z

Just updating on another issue caused by this PR as part BZ checklist.
The components introduced in this PR was not wrapped inside of scrollView which is one of the checklist items in reviewers checklist. Causing this issue - #21057

thiagobrez · 2023-06-30T15:59:27Z

Thanks for pointing out @abdulrahuman5196 . Will take more care next time 🚀

s77rt · 2023-07-05T19:13:32Z

src/styles/styles.js

+    twoFactorAuthCodesButton: {
+        minWidth: 100,
+    },


The min width here was not enough and caused the copy button's width to change on click resulting in buttons jump behaviour #21566

mollfpr · 2023-07-18T05:18:07Z

src/pages/settings/Security/TwoFactorAuth/VerifyPage.js

+                    <Button
+                        success
+                        text={props.translate('common.next')}
+                        isDisabled


✋ Coming from #20848

We want the button to be pressed like what we have for the sign-in page and maintain consistency between a similar flow.

0xmiros · 2023-10-10T20:13:37Z

src/pages/settings/Security/TwoFactorAuth/VerifyPage.js

+     * @returns {string}
+     */
+    function buildAuthenticatorUrl() {
+        return `otpauth://totp/Expensify:${props.account.primaryLogin}?secret=${props.account.twoFactorAuthSecretKey}&issuer=Expensify`;


Coming from #19366:
props.account.primaryLogin is not 100% value.
When user create new account, this value doesn't exist.
Instead, we replaced this with session.email which is stable value.

thiagobrez added 8 commits May 8, 2023 13:12

chore: add IsEnabledPage and DisablePage

05bccf0

chore: add CodesPage and VerifyPage

cb53f86

chore: finish VerifyPage and SuccessPage design

8174644

chore: finish all UI and connected to API

6a40c87

chore: fix codes download on Android

cf8c297

chore: test fireworks animation on SuccessPage

fc68b8f

chore: cleanup

ac00e92

chore: add spanish translations

a450dfb

chore: replace fireworks svg for animation

4c59021

thiagobrez added 4 commits May 8, 2023 17:06

chore: replace TextInput with MagicCodeInput

c6bdb52

chore: UX improvements

9eaba25

chore: fix keyboard on top of input

a2c5cc5

chore: fix BaseTwoFactorAuthForm component name

0cd1361

ArekChr suggested changes May 10, 2023

View reviewed changes

ArekChr reviewed May 10, 2023

View reviewed changes