doc.rustdesk.com/content/self-host/rustdesk-server-pro/2fa/_index.en.md

99 lines
3.9 KiB
Markdown
Raw Normal View History

---
title: 2FA
weight: 16
---
When logging in to your account, turning on Two-Factor Authentication (2FA) verification can improve account security.
Our web console currently supports two kinds of 2FA:
2024-02-09 21:42:11 +01:00
1. Email verification
2. TOTP. A third-party authentication app is required to generate the verification code, such as [Authy](https://authy.com), [Microsoft Authenticator](https://www.microsoft.com/en-us/security/mobile-authenticator-app/) and [Google Authenticator](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2) authentication app.
You first need to go to the account settings page.
2024-03-22 08:02:41 +01:00
![](/docs/en/self-host/rustdesk-server-pro/2fa/images/1-settings-account.png)
### Email verification
To enable email verification for login, you need:
1. Set email.
2024-02-09 21:42:11 +01:00
2. Enable the `Enable email login verification` option.
3. Click on `Submit`.
2024-03-22 08:02:41 +01:00
![](/docs/en/self-host/rustdesk-server-pro/2fa/images/2-2fa-email-1.png)
When we log in next time, RustDesk will send us a verification code email, and the web page will also jump to the verification page.
2024-03-22 08:02:41 +01:00
![](/docs/en/self-host/rustdesk-server-pro/2fa/images/2-2fa-email-2.png)
### TOTP
TOTP is a widely used 2FA method, so in the web console of RustDesk Server Pro, 2FA refers to TOTP verification.
#### Prepare authentication app
First, you need to prepare an authentication app.
2024-02-09 21:42:11 +01:00
You can choose from these types [Authy](https://authy.com), [Microsoft Authenticator](https://www.microsoft.com/en-us/security/mobile-authenticator-app/) and [Google Authenticator](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2) authentication app.
#### Enable 2FA
2024-02-09 21:42:11 +01:00
When the `Enable 2FA` button is displayed on the settings page, it means that 2FA is not currently enabled.
2024-03-22 08:02:41 +01:00
![](/docs/en/self-host/rustdesk-server-pro/2fa/images/3-2fa-enable-1.png)
Click the button and a form will pop up to enable 2FA.
2024-03-22 08:02:41 +01:00
![](/docs/en/self-host/rustdesk-server-pro/2fa/images/3-2fa-enable-2.png)
Open the authenticator app, add an account by scanning the QR code.
If you are inconvenient to scan the QR code, you can also enter the code here directly.
2024-03-22 08:02:41 +01:00
![](/docs/en/self-host/rustdesk-server-pro/2fa/images/3-2fa-enable-3.png)
After adding the account in the authenticator app, enter the verification code in the authenticator app to turn on 2FA.
2024-02-09 21:42:11 +01:00
After 2FA is successfully turned on, RustDesk Server Pro will also be bound to 6 **backup codes**. So that you can use these **backup codes** to pass the verification even if you are unable to use the authenticator app.
2024-03-22 08:02:41 +01:00
![](/docs/en/self-host/rustdesk-server-pro/2fa/images/3-2fa-enable-4.png)
2024-02-09 21:42:11 +01:00
{{% notice note %}}
1. These backup codes can only be used once.
2024-02-09 21:42:11 +01:00
2. Please keep the backup codes in a safe place.
2024-02-09 21:42:11 +01:00
{{% /notice %}}
#### Login verification
When 2FA is enabled, email login verification is no longer used. We will be using 2FA login verification instead.
2024-03-22 08:02:41 +01:00
![](/docs/en/self-host/rustdesk-server-pro/2fa/images/3-2fa-enable-login-5.png)
When logging in, you will be redirected to the verification page.
2024-03-22 08:02:41 +01:00
![](/docs/en/self-host/rustdesk-server-pro/2fa/images/3-2fa-enable-login-6.png)
#### Modify settings
When 2FA is enabled, modifying account settings requires additional 2FA verification.
2024-03-22 08:02:41 +01:00
![](/docs/en/self-host/rustdesk-server-pro/2fa/images/3-2fa-settings-1.png)
2024-03-22 08:02:41 +01:00
![](/docs/en/self-host/rustdesk-server-pro/2fa/images/3-2fa-settings-2.png)
#### 2FA state
2FA has a total of 3 states: not enabled, enabled and expired.
2024-03-22 08:02:41 +01:00
![](/docs/en/self-host/rustdesk-server-pro/2fa/images/3-2fa-state-not-enabled.png)
2024-03-22 08:02:41 +01:00
![](/docs/en/self-host/rustdesk-server-pro/2fa/images/3-2fa-state-enabled.png)
2024-03-22 08:02:41 +01:00
![](/docs/en/self-host/rustdesk-server-pro/2fa/images/3-2fa-state-expired.png)
2024-02-09 21:42:11 +01:00
{{% notice note %}}
2FA can still be used normally after it expires. It just means that the 2FA settings haven't been changed for a long time (default 180 days). For security reasons, we recommend re-enabling 2FA, so the secret data can been updated.
{{% /notice %}}