Difference between revisions of "Two-Factor Authentication"
(→Within the Admin Area) |
|||
| Line 1: | Line 1: | ||
==Introduction== | ==Introduction== | ||
| − | |||
Two-Factor Authentication adds a layer of security by adding a second step to the login process. It takes something you know (for example, your password) and adds a second factor, typically something you have (such as your phone). Since you require both to log in, this decreases the threat of a leaked password. | Two-Factor Authentication adds a layer of security by adding a second step to the login process. It takes something you know (for example, your password) and adds a second factor, typically something you have (such as your phone). Since you require both to log in, this decreases the threat of a leaked password. | ||
| − | + | ||
WHMCS includes three Two-Factor Authentication services. | WHMCS includes three Two-Factor Authentication services. | ||
| − | + | ||
===Time Based Tokens=== | ===Time Based Tokens=== | ||
| − | + | ||
| − | One of the most common and simplest forms of Two-Factor Authentication is Time Based Tokens. With Time Based Tokens | + | One of the most common and simplest forms of Two-Factor Authentication is Time Based Tokens. With Time Based Tokens, you enter a 6-digit code that regenerates every 30 seconds in addition to your regular username and password. Only your token device (typically a mobile smartphone app) will have your secret key and be able to generate valid one-time passwords for your account. We recommend enabling Time Based Tokens, and WHMCS enables this by default. |
| − | + | ||
===DuoSecurity=== | ===DuoSecurity=== | ||
| − | + | ||
| − | With DuoSecurity, the system will prompt you for a phone number | + | With DuoSecurity, the system will prompt you for a phone number. It will then present an option to receive a text or phone call or, on some devices, a push notification or touch ID verification. After you receive the text or phone call, input the authentication code to proceed. A second optional page at initial login will prompt to download the DuoSecurity mobile application. This application performs push notifications, allowing you to restrict or allow access under your user from your phone. |
| − | + | ||
For more information, see [http://docs.whmcs.com/Duo_Security Duo Security]. | For more information, see [http://docs.whmcs.com/Duo_Security Duo Security]. | ||
| − | + | ||
===YubiKey=== | ===YubiKey=== | ||
| − | + | ||
| − | YubiKey creates a one time password in a USB drive that acts as a keyboard to your computer. These are physical devices that you must purchase from Yubico directly | + | YubiKey creates a one-time password in a USB drive that acts as a keyboard to your computer. These are physical devices that you must purchase [https://www.yubico.com/ from Yubico directly]. |
| − | + | ||
==Enabling Two-Factor Authentication== | ==Enabling Two-Factor Authentication== | ||
| − | + | ||
[[File:2FA_006.png|thumb|Time Based Tokens Configuration]] | [[File:2FA_006.png|thumb|Time Based Tokens Configuration]] | ||
| − | + | ||
| − | To enable Two-Factor Authentication | + | To enable Two-Factor Authentication, follow the steps below: |
| − | + | ||
| − | # From the Admin Area, | + | # From the Admin Area, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Admin Users > Two Factor Authentication''' or, prior to WHMCS 8.0, '''Setup > Staff Management > Two-Factor Authentication'''. |
| − | # Click | + | # Click '''Activate''' under the service that you would like to enable. |
| − | # Select one or both of | + | # Select one or both of '''Enable for use by Clients''' and '''Enable for use by Administrative Users'''. |
| − | # If applicable, | + | # If applicable, configure any additional '''Configuration Settings'''. |
| − | # Click | + | # Click '''Save'''. |
| − | + | ||
You can repeat these steps for each service that you would like to enable. | You can repeat these steps for each service that you would like to enable. | ||
| − | + | ||
[[File:2FA_001.png|border|800px]] | [[File:2FA_001.png|border|800px]] | ||
| − | + | ||
===Global Two-Factor Authentication Settings=== | ===Global Two-Factor Authentication Settings=== | ||
| − | + | ||
| − | The ''Global Two-Factor Authentication Settings'' options allow you to forcibly enable Two-Factor Authentication for | + | The '''Global Two-Factor Authentication Settings''' options allow you to forcibly enable Two-Factor Authentication for Accounts, Users, and Admins on their next login. |
| − | + | ||
| − | To use this feature, select your options and click | + | To use this feature, select your options and click '''Save Changes'''. If a user has not yet configured Two-Factor Authentication, the system will force them to the next time they sign in to WHMCS. |
| − | + | ||
[[File:2FA_002.png|border|800px]] | [[File:2FA_002.png|border|800px]] | ||
| − | + | ||
==Using Two-Factor Authentication== | ==Using Two-Factor Authentication== | ||
| − | + | ||
| − | + | Accounts, Users, and Admins can begin to use Two-Factor Authentication after you have activated one or more services and configured the installation. | |
| − | + | ||
===Within the Client Area=== | ===Within the Client Area=== | ||
| − | + | ||
[[File:2FA_005.png|thumb|Configuring Time Based Tokens in Client Area]] | [[File:2FA_005.png|thumb|Configuring Time Based Tokens in Client Area]] | ||
| − | + | ||
| − | + | To set up Two-Factor Authentication using '''Time Based Tokens''': | |
| − | + | ||
| − | # From the Client Area, navigate to ''Hello, Name! > Security Settings''. | + | # From the Client Area, navigate to '''Hello, Name! > Security Settings'''. |
| − | # Click | + | # Click '''Click here to Enable'''. |
| − | # Select | + | # Select '''Time Based Tokens'''. |
| − | # Click | + | # Click '''Get Started'''. |
| − | # Scan the QR code with an authenticator app | + | # Scan the QR code with an authenticator app like Google Authenticator or Duo Mobile. |
| − | # Enter | + | # Enter the 6-digit code that the authenticator app generates. |
| − | # Click | + | # Click '''Submit'''. |
| − | # Record the ''Backup Code'' in a safe place. | + | # Record the '''Backup Code''' in a safe place. |
| − | # Click | + | # Click '''Close'''. |
| − | + | ||
[[File:2FA_003.png|border|800px]] | [[File:2FA_003.png|border|800px]] | ||
| − | + | ||
| + | <div class="docs-alert-info"> | ||
| + | <span class="title">Disable Two-Factor Authentication for Users</span><br /> | ||
| + | In WHMCS 8.0 and later, Admins can disable (but not enable) Two-Factor Authentication for users at '''Clients > [[Manage_Users]]'''. | ||
| + | </div> | ||
| + | |||
===Within the Admin Area=== | ===Within the Admin Area=== | ||
| − | + | ||
[[File:2FA_005.png|thumb|Configuring Time Based Tokens in Admin Area]] | [[File:2FA_005.png|thumb|Configuring Time Based Tokens in Admin Area]] | ||
| − | + | ||
| − | + | Admins can perform the following actions to set up Two-Factor Authentication on their accounts using the '''Time Based Tokens''' service: | |
| − | + | ||
| − | # From the Admin Area, navigate to | + | # From the Admin Area, navigate to '''Account > My Account''' or, prior to WHMCS 8.0, '''My Account'''. |
| − | # Toggle | + | # Toggle '''Two-Factor Authentication''' to '''On'''. |
| − | # Select | + | # Select '''Time Based Tokens'''. |
| − | # Click | + | # Click '''Get Started'''. |
| − | # Scan the QR code with an authenticator app | + | # Scan the QR code with an authenticator app like Google Authenticator or Duo Mobile. |
# Enter in the 6-digit code that the authenticator app generates. | # Enter in the 6-digit code that the authenticator app generates. | ||
| − | # Click | + | # Click '''Submit'''. |
# Record the '''Backup Code''' in a safe place. | # Record the '''Backup Code''' in a safe place. | ||
| − | # Click | + | # Click '''Close'''. |
| − | + | ||
[[File:2FA_004.png|border|800px]] | [[File:2FA_004.png|border|800px]] | ||
| − | + | ||
==Troubleshooting== | ==Troubleshooting== | ||
| − | + | ||
| − | + | ====The code you entered did not match what was expected. Please try again.==== | |
| + | |||
Seeing this error when using the time based tokens method means that the 6 characters your device generated do not match the 6 numbers WHMCS expected. Usually, this indicates that the time on your device (for example, your phone or tablet) and on the WHMCS server are different. | Seeing this error when using the time based tokens method means that the 6 characters your device generated do not match the 6 numbers WHMCS expected. Usually, this indicates that the time on your device (for example, your phone or tablet) and on the WHMCS server are different. | ||
| − | + | ||
You can see the time in the top-right corner of your WHMCS Admin Area. It's taken directly from your server's PHP configuration. You must ensure the server time is correct, and the time on your device matches the server time. For example, if the server time is 00:01 and the time on your device is 00:00, you will see this error. In that scenario, you must change the time on your device to 00:01 so that they both match. | You can see the time in the top-right corner of your WHMCS Admin Area. It's taken directly from your server's PHP configuration. You must ensure the server time is correct, and the time on your device matches the server time. For example, if the server time is 00:01 and the time on your device is 00:00, you will see this error. In that scenario, you must change the time on your device to 00:01 so that they both match. | ||
| − | + | ||
Syncing the server with [http://en.wikipedia.org/wiki/Network_Time_Protocol NTP] to ensure the time is exactly right may also help to resolve this. Most servers will revert to the internal hardware clock on boot or reboot, so you will need to sync any changes from NTP to the hardware clock. | Syncing the server with [http://en.wikipedia.org/wiki/Network_Time_Protocol NTP] to ensure the time is exactly right may also help to resolve this. Most servers will revert to the internal hardware clock on boot or reboot, so you will need to sync any changes from NTP to the hardware clock. | ||
| − | + | ||
This provides support for time zone differences, so they are unlikely to cause problems. | This provides support for time zone differences, so they are unlikely to cause problems. | ||
| − | + | ||
| − | + | ====The second factor you supplied was incorrect. Please try again.==== | |
Seeing this error when activating the DuoSecurity method for the first time means that the entered code does not match what DuoSecurity expects. This indicates that the time on your server does not match DuoSecurity's clocks. | Seeing this error when activating the DuoSecurity method for the first time means that the entered code does not match what DuoSecurity expects. This indicates that the time on your server does not match DuoSecurity's clocks. | ||
| − | + | ||
You can see the time in the top-right corner of your WHMCS admin area. It's taken directly from your server's PHP configuration. You must make sure to sync the server time exactly with UTC. For example, if the server time is 00:01 and the time at DuoSecurity is 00:00, you will see this error. | You can see the time in the top-right corner of your WHMCS admin area. It's taken directly from your server's PHP configuration. You must make sure to sync the server time exactly with UTC. For example, if the server time is 00:01 and the time at DuoSecurity is 00:00, you will see this error. | ||
| − | + | ||
Syncing the server with [http://en.wikipedia.org/wiki/Network_Time_Protocol NTP] to ensure the time is exactly right will resolve this. Most servers will revert to the internal hardware clock when they boot or reboot, so you will need to sync any changes from NTP to the hardware clock. | Syncing the server with [http://en.wikipedia.org/wiki/Network_Time_Protocol NTP] to ensure the time is exactly right will resolve this. Most servers will revert to the internal hardware clock when they boot or reboot, so you will need to sync any changes from NTP to the hardware clock. | ||
| − | + | ||
This provides support for time zone differences, so they are unlikely to cause problems. | This provides support for time zone differences, so they are unlikely to cause problems. | ||
Revision as of 17:38, 27 August 2020
Contents
Introduction
Two-Factor Authentication adds a layer of security by adding a second step to the login process. It takes something you know (for example, your password) and adds a second factor, typically something you have (such as your phone). Since you require both to log in, this decreases the threat of a leaked password.
WHMCS includes three Two-Factor Authentication services.
Time Based Tokens
One of the most common and simplest forms of Two-Factor Authentication is Time Based Tokens. With Time Based Tokens, you enter a 6-digit code that regenerates every 30 seconds in addition to your regular username and password. Only your token device (typically a mobile smartphone app) will have your secret key and be able to generate valid one-time passwords for your account. We recommend enabling Time Based Tokens, and WHMCS enables this by default.
DuoSecurity
With DuoSecurity, the system will prompt you for a phone number. It will then present an option to receive a text or phone call or, on some devices, a push notification or touch ID verification. After you receive the text or phone call, input the authentication code to proceed. A second optional page at initial login will prompt to download the DuoSecurity mobile application. This application performs push notifications, allowing you to restrict or allow access under your user from your phone.
For more information, see Duo Security.
YubiKey
YubiKey creates a one-time password in a USB drive that acts as a keyboard to your computer. These are physical devices that you must purchase from Yubico directly.
Enabling Two-Factor Authentication
To enable Two-Factor Authentication, follow the steps below:
- From the Admin Area, go to Configuration () > Admin Users > Two Factor Authentication or, prior to WHMCS 8.0, Setup > Staff Management > Two-Factor Authentication.
- Click Activate under the service that you would like to enable.
- Select one or both of Enable for use by Clients and Enable for use by Administrative Users.
- If applicable, configure any additional Configuration Settings.
- Click Save.
You can repeat these steps for each service that you would like to enable.
Global Two-Factor Authentication Settings
The Global Two-Factor Authentication Settings options allow you to forcibly enable Two-Factor Authentication for Accounts, Users, and Admins on their next login.
To use this feature, select your options and click Save Changes. If a user has not yet configured Two-Factor Authentication, the system will force them to the next time they sign in to WHMCS.
Using Two-Factor Authentication
Accounts, Users, and Admins can begin to use Two-Factor Authentication after you have activated one or more services and configured the installation.
Within the Client Area
To set up Two-Factor Authentication using Time Based Tokens:
- From the Client Area, navigate to Hello, Name! > Security Settings.
- Click Click here to Enable.
- Select Time Based Tokens.
- Click Get Started.
- Scan the QR code with an authenticator app like Google Authenticator or Duo Mobile.
- Enter the 6-digit code that the authenticator app generates.
- Click Submit.
- Record the Backup Code in a safe place.
- Click Close.
Disable Two-Factor Authentication for Users
In WHMCS 8.0 and later, Admins can disable (but not enable) Two-Factor Authentication for users at Clients > Manage_Users.
Within the Admin Area
Admins can perform the following actions to set up Two-Factor Authentication on their accounts using the Time Based Tokens service:
- From the Admin Area, navigate to Account > My Account or, prior to WHMCS 8.0, My Account.
- Toggle Two-Factor Authentication to On.
- Select Time Based Tokens.
- Click Get Started.
- Scan the QR code with an authenticator app like Google Authenticator or Duo Mobile.
- Enter in the 6-digit code that the authenticator app generates.
- Click Submit.
- Record the Backup Code in a safe place.
- Click Close.
Troubleshooting
The code you entered did not match what was expected. Please try again.
Seeing this error when using the time based tokens method means that the 6 characters your device generated do not match the 6 numbers WHMCS expected. Usually, this indicates that the time on your device (for example, your phone or tablet) and on the WHMCS server are different.
You can see the time in the top-right corner of your WHMCS Admin Area. It's taken directly from your server's PHP configuration. You must ensure the server time is correct, and the time on your device matches the server time. For example, if the server time is 00:01 and the time on your device is 00:00, you will see this error. In that scenario, you must change the time on your device to 00:01 so that they both match.
Syncing the server with NTP to ensure the time is exactly right may also help to resolve this. Most servers will revert to the internal hardware clock on boot or reboot, so you will need to sync any changes from NTP to the hardware clock.
This provides support for time zone differences, so they are unlikely to cause problems.
The second factor you supplied was incorrect. Please try again.
Seeing this error when activating the DuoSecurity method for the first time means that the entered code does not match what DuoSecurity expects. This indicates that the time on your server does not match DuoSecurity's clocks.
You can see the time in the top-right corner of your WHMCS admin area. It's taken directly from your server's PHP configuration. You must make sure to sync the server time exactly with UTC. For example, if the server time is 00:01 and the time at DuoSecurity is 00:00, you will see this error.
Syncing the server with NTP to ensure the time is exactly right will resolve this. Most servers will revert to the internal hardware clock when they boot or reboot, so you will need to sync any changes from NTP to the hardware clock.
This provides support for time zone differences, so they are unlikely to cause problems.