Skip to content

Commit

Permalink
📝 Add user-setup instructions for TOTP apps
Browse files Browse the repository at this point in the history
  • Loading branch information
jemrobinson committed Aug 20, 2024
1 parent cf3bb99 commit bdefefb
Show file tree
Hide file tree
Showing 11 changed files with 95 additions and 71 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
166 changes: 95 additions & 71 deletions docs/source/roles/researcher/new_user_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -255,89 +255,117 @@ Please follow these steps carefully.
The next step in setting up your account is to authenticate your account from your phone.
This additional security verification is to make it harder for people to impersonate you and connect to the environment without permission.
This is known as multi-factor authentication (MFA).
The Data Safe Haven requires that you use a phone app for MFA - this can be **Microsoft Authenticator** or another authenticator app.

#### {{telephone_receiver}} Phone number registration
#### {{bento_box}} Microsoft Authenticator app

::::{admonition} 1. Enter your phone number
::::{admonition} 1. Download the Microsoft Authenticator app
:class: dropdown note

- In order to set up MFA you will need to enter your phone number
Search for **Microsoft Authenticator** in your phone's app store or follow the appropriate link for your phone here:

:::{image} images/account_setup_mfa_additional_security_verification.png
:alt: Additional security verification
:align: center
:width: 90%
- {{apple}} iOS: `https://bit.ly/iosauthenticator`
- {{robot}} Android: `https://bit.ly/androidauthenticator`
- {{bento_box}} Windows mobile: `https://bit.ly/windowsauthenticator`

:::{important}
You must give permission for the authenticator app to send you notifications for the app to work as an MFA method.
:::

::::

::::{admonition} 2. Answer a phone call
::::{admonition} 2. Add sign-in method
:class: dropdown note

- Once you click **{guilabel}`Next`** you will receive a phone call straight away.
- Click on **{guilabel}`+ Add sign-in method`** and select **Authenticator app**.

:::{image} images/account_setup_mfa_verifying_phone.png
:alt: Verifying phone number
:::{image} images/account_setup_mfa_add_authenticator_app.png
:alt: Add Authenticator app
:align: center
:width: 90%
:::

:::{tip}
The call might say _press the pound key_ or _press the hash key_. Both mean hit the `#` button.
- At the **Getting the app** click on **{guilabel}`Next`**.

:::{image} images/account_setup_mfa_choose_authenticator_app.png
:alt: Add Authenticator app
:align: center
:width: 90%
:::

- Open the Microsoft Authenticator app

::::

::::{admonition} 3. Register phone number
::::{admonition} 3. Register your app
:class: dropdown note

- After following the instructions you will see the following screen

:::{image} images/account_setup_mfa_verified_phone.png
:alt: Verified phone number
- From the Microsoft Authenticator app
- Select **Add an account**
- Select **Work or School account**
- From your browser, at the on-screen prompt click on **{guilabel}`Next`**.
:::{image} images/account_setup_mfa_allow_notifications.png
:alt: Allow Authenticator notifications
:align: center
:width: 90%
:::

- Click **{guilabel}`Next`** to register this phone number for MFA
- The next prompt will give you a QR code to scan, like the one shown below
- Scan the QR code on the screen then click **{guilabel}`Next`**

:::{image} images/account_setup_mfa_registered_phone.png
:alt: Registered phone number
:align: center
:width: 90%
:::
:::{image} images/account_setup_mfa_app_qrcode.png
:alt: Setup Authenticator app
:align: center
:width: 90%
:::

- Once this is completed, Microsoft will send you a test notification to respond to

- Click **{guilabel}`Done`**
:::{image} images/account_setup_mfa_microsoft_authenticator_app_test.png
:alt: Authenticator app test notification
:align: center
:width: 90%
:::

- When you click **{guilabel}`Approve`** on the phone notification, you will get the following message in your browser

:::{image} images/account_setup_mfa_microsoft_authenticator_app_approved.png
:alt: Authenticator app test approved
:align: center
:width: 90%
:::
::::

::::{admonition} 4. Check the Security Information dashboard
:class: dropdown note

- You should now see the Security Information dashboard that lists all your verified MFA methods
- You should now be returned to the Security Information dashboard that shows the **Microsoft Authenticator** method.

:::{image} images/account_setup_mfa_dashboard_phone_only.png
:alt: Registered phone number
:align: center
:width: 90%
:::
:::{image} images/account_setup_mfa_dashboard_microsoft_authenticator.png
:alt: Registered MFA methods
:align: center
:width: 90%
:::

- Choose whichever you prefer to be your **Default sign-in method**.

::::

#### {{iphone}} Authenticator app registration
#### {{iphone}} Alternate authenticator app

::::{admonition} 1. Download the Microsoft Authenticator app
::::{admonition} 1. Download an authenticator app
:class: dropdown note

Search for **Microsoft Authenticator** in your phone's app store or follow the appropriate link for your phone here:
- Choose an authenticator app that supports **time-based one-time password (TOTP)**.
- One example is **Google Authenticator**.

- {{apple}} iOS: `https://bit.ly/iosauthenticator`
- {{robot}} Android: `https://bit.ly/androidauthenticator`
- {{bento_box}} Windows mobile: `https://bit.ly/windowsauthenticator`
:::{important}
You must give permission for the authenticator app to send you notifications for the app to work as an MFA method.
:::

::::

::::{admonition} 2. Open authenticator app
::::{admonition} 2. Add sign-in method
:class: dropdown note

- Click on **{guilabel}`+ Add sign-in method`** and select **Authenticator app**.
Expand All @@ -348,71 +376,67 @@ Search for **Microsoft Authenticator** in your phone's app store or follow the a
:width: 90%
:::

- At the **Getting the app** click on **{guilabel}`Next`**.
- At the **Getting the app** click on **I want to use a different authenticator app**.

:::{image} images/account_setup_mfa_download_authenticator_app.png
:::{image} images/account_setup_mfa_choose_authenticator_app.png
:alt: Add Authenticator app
:align: center
:width: 90%
:::

- Open the app
- Open your authenticator app

::::

::::{admonition} 3. Register your app
:class: dropdown note

- From the app
- Select **Add an account**
- Select **Work or School account**
- Follow the steps in your authenticator app to add a new account
- At the on-screen prompt click on **{guilabel}`Next`**.

:::{image} images/account_setup_mfa_allow_notifications.png
:alt: Allow Authenticator notifications
:::{image} images/account_setup_mfa_totp_allow_notifications.png
:alt: Allow authenticator notifications
:align: center
:width: 90%
:::

:::{important}
You must give permission for the authenticator app to send you notifications for the app to work as an MFA method.
:::

- The next prompt will give you a QR code to scan, like the one shown below
- Scan the QR code on the screen then click **{guilabel}`Next`**

:::{image} images/account_setup_mfa_app_qrcode.png
:alt: Setup Authenticator app
:align: center
:width: 90%
:::
:::{image} images/account_setup_mfa_totp_app_qrcode.png
:alt: Setup Authenticator app
:align: center
:width: 90%
:::

- Once this is completed, Microsoft will send you a test notification to respond to

:::{image} images/account_setup_mfa_authenticator_app_test.png
:alt: Authenticator app test notification
:align: center
:width: 90%
:::
:::{image} images/account_setup_mfa_totp_authenticator_app_test.png
:alt: Authenticator app test notification
:align: center
:width: 90%
:::

- When you click **{guilabel}`Approve`** on the phone notification, you will get the following message in your browser

:::{image} images/account_setup_mfa_authenticator_app_approved.png
:alt: Authenticator app test approved
:align: center
:width: 90%
:::
:::{image} images/account_setup_mfa_totp_authenticator_app_approved.png
:alt: Authenticator app test approved
:align: center
:width: 90%
:::

::::

::::{admonition} 4. Check the Security Information dashboard
:class: dropdown note

- You should now be returned to the Security Information dashboard that lists two verified MFA methods
- You should now be returned to the Security Information dashboard that shows the **Authenticator app** method.

:::{image} images/account_setup_mfa_dashboard_two_methods.png
:alt: Registered MFA methods
:align: center
:width: 90%
:::
:::{image} images/account_setup_mfa_dashboard_totp_authenticator.png
:alt: Registered MFA methods
:align: center
:width: 90%
:::

- Choose whichever you prefer to be your **Default sign-in method**.

Expand Down

0 comments on commit bdefefb

Please sign in to comment.