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.

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

Clarify TOTP setup instructions #486

Open
iandunn opened this issue Oct 25, 2022 · 5 comments
Open

Clarify TOTP setup instructions #486

iandunn opened this issue Oct 25, 2022 · 5 comments

Comments

@iandunn
Copy link
Member

iandunn commented Oct 25, 2022

I think the current instructions will confuse many folks who are new to TOTP or 2FA in general.

Screen Shot 2022-10-25 at 7 36 10 AM

They assume that folks have setup TOTP before, so they several steps of the process. The introduction feels like a run-on sentence, which could overwhelm folks who need to go slower. The secret isn't labeled, so it could also be confusing to folks who haven't seen one before.

Breaking it into steps could help a lot. Here's a very rough sketch of what that could look like:

Screen Shot 2022-10-25 at 7 34 45 AM

That still needs a lot of visual formatting and refinement, but hopefully it conveys the general idea.

@jeffpaul jeffpaul added this to the Future Release milestone Oct 25, 2022
@pbiron
Copy link

pbiron commented Oct 25, 2022

In general, I think the direction of the "rough sketch" is great.

One minor quibble: authenticator apps do not have to be on a phone. For example, Authy has a desktop version (which can sync accounts to their mobile version)...that's what I use.

So, I'd suggest something like:

Step 1: Install an authenticator app on your desktop/laptop and/or phone....

@iandunn
Copy link
Member Author

iandunn commented Oct 25, 2022

Yeah, that's a fair point 👍🏻

@r-a-y
Copy link
Contributor

r-a-y commented Oct 25, 2022

Yeah, I agree with this.

On our two-factor install, we modified the first line to:

Please scan the QR code or manually enter the key into your authenticator app. Next, enter the authentication code from your app to complete set up.

We also prefixed the key with <strong>Key: </strong> and changed the "Submit" button text to "Complete Set Up".

@dd32
Copy link
Member

dd32 commented Nov 9, 2022

It's worth noting that step 2 of "Install a QR code scanner app" in the rough sketch above isn't normally a separate step, it's built in to most (all?) of the authenticator apps.

With the addition of #487 it might be also worth noting that Mobile users (and I guess desktop app users..) can click the QR to load their app usually.

@dd32
Copy link
Member

dd32 commented Nov 9, 2022

For comparison of what users may be accustomed to already, I'm including some Screenshots of other platforms where TOTP is implemented.

Notably

  • They all seem to preference mobile devices - I think this is two-fold, while you can use a desktop app, none of them really want you to use a desktop app, as compromised desktops are a thing more than phones, and mobile devices are more likely to travel with the person allowing them access to the account elsewhere
  • They don't show the TOTP key unless needed, behind a "can't scan" link, I suspect possibly to remove any notions a scary alphanumeric string will convey, where as since you can't read a QR it's a little more "magic"
  • The GitHub and Microsoft implementations use a shorter key
  • The capitalisation and spacing of the key displays below were retained, even though I changed the contents.
WordPress.com GitHub Microsoft Google Amazon
Screen Shot 2022-11-09 at 12 40 47 pm Screen Shot 2022-11-09 at 12 36 29 pm Screen Shot 2022-11-09 at 12 49 43 pm Screen Shot 2022-11-09 at 1 08 52 pm Screen Shot 2022-11-09 at 1 14 38 pm
Screen Shot 2022-11-09 at 1 00 13 pm Screen Shot 2022-11-09 at 12 59 12 pm Screen Shot 2022-11-09 at 12 58 07 pm Screen Shot 2022-11-09 at 1 09 29 pm Screen Shot 2022-11-09 at 1 15 26 pm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants