Skip to content

Commit

Permalink
feat: update MFA docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dgpalmieri committed Feb 8, 2024
1 parent 2ac9b43 commit b99f468
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions docs/user-guides/mfa.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,37 @@
[Return to Table of Contents](../user.md)

# Configuring Multi-Factor Authentication (MFA)
# Configuring Multi-Factor Authentication

[Watch: Log In and Set Up MFA](mfa.md#watch-log-in-and-set-up-mfa)

[Before You Begin](mfa.md#before-you-begin)

[Walkthrough](mfa.md#walkthrough)
[Setup Steps](mfa.md#setup-steps)

[Troubleshooting](mfa.md#troubleshooting)

Multi-Factor Authentication (MFA) is required to access OpenScienceLab resources.
Currently, we support TOTP-based authentication, with plans to add hardware
key (ex. Yubikey) authentication in future updates.

## Watch: Log In and Set Up MFA

<iframe width="560" height="315" src="https://www.youtube.com/embed/2c1X9qRnsSM?si=XKHtBBzrSDgnBJNQ" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>

## Before You Begin

A TOTP-enabled application is required to use OpenScienceLab resources.
A TOTP-enabled MFA application is required to use OpenScienceLab resources.
While the most widely utilized approach is through a smartphone application,
there are also several desktop clients that provide this functionality.

| Application | Desktop Support | Android Support | iOS Support |
| -------------------- | --------------- | --------------- | ----------- |
| KeePassXc ||||
| Enpass ||||
| Cisco Duo ||||
| Authenticator.cc* ||||
| Bitwarden** ||||
| FreeOTP ||||
| Google Authenticator ||||
| Microsoft Authenticator ||||
| Aegis Authenticator ||||
Expand All @@ -34,7 +40,7 @@ there are also several desktop clients that provide this functionality.

\*\* TOTP supported in paid version only

## Walkthrough
## Setup Steps

1. Log into OpenScienceLab normally. Leave the "MFA" field on the login page blank.
1. Click "Configure New MFA Device" in the Navigation Bar at
Expand All @@ -50,15 +56,16 @@ application's "Scan QR Code" feature.
1. If the check is successfull, navigate back to the home page by clicking "Home"
in the Navigation Bar at the top of the page and continue using OpenScienceLab
as normal.
1. If the check is not successfull, there are two potential issues:

## Troubleshooting

1. If the MFA Verification check is not successfull, there are two potential issues:
1. One of the codes was mis-typed.
1. The secret was not properly put into the MFA application.
1. Test again with another two *consecutive* codes, and if the verification step fails
again, check that the OTP Secret on the page matches the secret in your application.
1. If all else fails, refresh the page. This will generate a new code, which you
can then use to follow the same steps above.

## Troubleshooting

For additional issues and further troubleshooting, please email
[[email protected]](mailto:[email protected])

0 comments on commit b99f468

Please sign in to comment.