DuoSecurity - Revision history

SarahK at 15:30, 18 March 2024

2024-03-18T15:30:33Z

John: Updated Alert box

2024-03-14T15:02:35Z

Updated Alert box

John: /* Configuring Duo Security */

2024-03-13T22:17:15Z

‎Configuring Duo Security

SarahK at 17:06, 7 February 2024

2024-02-07T17:06:54Z

James.white at 07:33, 3 May 2023

2023-05-03T07:33:34Z

SarahK at 19:43, 21 April 2022

2022-04-21T19:43:35Z

AlexN: /* Using Existing Duo Accounts With WHMCS */

2022-02-28T11:57:04Z

‎Using Existing Duo Accounts With WHMCS

AlexN at 11:56, 28 February 2022

2022-02-28T11:56:28Z

John: /* Troubleshooting */

2021-09-14T10:17:23Z

‎Troubleshooting

SarahK at 13:53, 10 September 2021

2021-09-10T13:53:06Z

@@ Line 8: / Line 8: @@
 In WHMCS 8.9 and later, our Duo Security integration uses [https://guide.duo.com/universal-prompt Duo Universal Prompt], which uses Duo Push by default. This pushes login or transaction details to your phone, allowing for immediate one-tap approval. If you already used Duo Security with the previous integration, you '''must''' log in to the Duo portal and upgrade your API credentials to use Duo Universal Prompt.
-* Duo has announced that support for the previous iframe-based Duo Prompt will [https://duo.com/docs/universal-prompt-update-guide end on March 30, 2024]. Duo's support teams will no longer be able to troubleshoot issues with the previous Duo Prompt after this date.
+* Duo has announced that support for the previous iframe-based Duo Prompt will [https://duo.com/docs/universal-prompt-update-guide end on March 30, 2024]. Duo's support team cannot troubleshoot issues with iframe-based Duo Prompt after this date.
 * After you upgrade to WHMCS 8.9 or later, we '''strongly''' recommend activating [https://guide.duo.com/universal-prompt Duo Universal Prompt] in your Duo customer portal to ensure continued functionality. If you do not do this, your customers may experience problems.
 * You will require a Duo Security account with an account level of '''Duo MFA''' or higher in order to access the Duo API. [https://go.whmcs.com/918/duo-security-signup Click here to sign up].
@@ Line 22: / Line 22: @@
 # Click '''Applications''' in the left sidebar.
 # Click '''Protect an Application'''.
-#* For WHMCS 8.9 and later, under '''Web SDK''', click '''Protect this Application'''.
+# Perform the appropriate step for your WHMCS version:
-#* For WHMCS 8.8 and earlier, under '''Auth API''', click '''Protect this Application'''.<div class="docs-alert-info">If you don't see this option, contact Duo support.</div>
+#* For WHMCS 8.9 and later, click '''Protect this Application''' under '''Web SDK'''.
 # Retrieve the following values:  [[File:duo-configuration.png|thumb|Duo Universal Prompt credentials (WHMCS 8.9 and later)]]
 #* For WHMCS 8.9 and later, retrieve the '''Client ID''', '''Client Secret''', and '''API hostname''' values.

@@ Line 8: / Line 8: @@
 In WHMCS 8.9 and later, our Duo Security integration uses [https://guide.duo.com/universal-prompt Duo Universal Prompt], which uses Duo Push by default. This pushes login or transaction details to your phone, allowing for immediate one-tap approval. If you already used Duo Security with the previous integration, you '''must''' log in to the Duo portal and upgrade your API credentials to use Duo Universal Prompt.
-* Duo has announced that support for the previous iframe-based Duo Prompt will [https://duo.com/docs/universal-prompt-update-guide end on March 30, 2024]. Duo Security will '''not''' function in WHMCS 8.8 and earlier after this date.
+* Duo has announced that support for the previous iframe-based Duo Prompt will [https://duo.com/docs/universal-prompt-update-guide end on March 30, 2024]. Duo's support teams will no longer be able to troubleshoot issues with the previous Duo Prompt after this date.
 * After you upgrade to WHMCS 8.9 or later, we '''strongly''' recommend activating [https://guide.duo.com/universal-prompt Duo Universal Prompt] in your Duo customer portal to ensure continued functionality. If you do not do this, your customers may experience problems.
 * You will require a Duo Security account with an account level of '''Duo MFA''' or higher in order to access the Duo API. [https://go.whmcs.com/918/duo-security-signup Click here to sign up].

@@ Line 22: / Line 22: @@
 # Click '''Applications''' in the left sidebar.
 # Click '''Protect an Application'''.
-# Under '''Auth API''', click '''Protect this Application'''. <div class="docs-alert-info">If you don't see this option, contact Duo support.</div>
+#* For WHMCS 8.9 and later, under '''Web SDK''', click '''Protect this Application'''.
 # Retrieve the following values:  [[File:duo-configuration.png|thumb|Duo Universal Prompt credentials (WHMCS 8.9 and later)]]
 #* For WHMCS 8.9 and later, retrieve the '''Client ID''', '''Client Secret''', and '''API hostname''' values.

@@ Line 1: / Line 1: @@
 [http://docs.whmcs.com/Two-Factor_Authentication < Back to Two-Factor Authentication]
-== What is Duo Security ==
+Duo® Security increases security with [[Two Factor Authentication]] (2FA). 2FA using Duo Security combines traditional account credentials (like a username and password) with a code or other verification from a device like a smart phone. Requiring both to log in decreases the threat of a leaked password.
-Duo Security increases security by adding a second identity verification to logins.  By requiring both a password and a unique one-time code, it protects your WHMCS installation and accounts against unauthorized access.
+Use of Duo Security is free for up to 10 accounts, and the Duo® Mobile app is available on all major smartphone platforms.
-== Why Duo Security? ==
+<div class="docs-alert-info">
-Duo Security is free up to 10 users, which makes it a perfect solution for securing administrator logins.
+* Duo has announced that support for the previous iframe-based Duo Prompt will [https://duo.com/docs/universal-prompt-update-guide end on March 30, 2024]. Duo Security will '''not''' function in WHMCS 8.8 and earlier after this date.
+* After you upgrade to WHMCS 8.9 or later, we '''strongly''' recommend activating [https://guide.duo.com/universal-prompt Duo Universal Prompt] in your Duo customer portal to ensure continued functionality. If you do not do this, your customers may experience problems.
-The Duo Mobile app is free and available on all major smartphone platforms, and lets users easily generate passcodes without the cost and hassle of hardware tokens.
+* You will require a Duo Security account with an account level of '''Duo MFA''' or higher in order to access the Duo API. [https://go.whmcs.com/918/duo-security-signup Click here to sign up].
 </div>
 == Configuring Duo Security ==
-[[File:Duo1.png|thumb|Protect an Application]][[File:Duo2.png|thumb|Protect Auth API]]
+Before you can configure Duo Security globally in WHMCS, you must perform additional steps to retrieve your Duo credentials.
-To configure Duo Security in WHMCS, follow the steps below:
+To configure Duo Security in WHMCS:
-# Log in to your account at [https://admin.duosecurity.com/ Duo Security].
+# Log in to [https://admin.duosecurity.com/ your Duo Security account].
 # Click '''Applications''' in the left sidebar.
 # Click '''Protect an Application'''.
-# Under '''Auth API''', click '''Protect this Application'''. If you don't see this option, contact Duo support.
+# Under '''Auth API''', click '''Protect this Application'''. <div class="docs-alert-info">If you don't see this option, contact Duo support.</div>
-# Retrieve the following values:
+# Retrieve the following values:  [[File:duo-configuration.png|thumb|Duo Universal Prompt credentials (WHMCS 8.9 and later)]]
-#* Integration Key
+#* For WHMCS 8.9 and later, retrieve the '''Client ID''', '''Client Secret''', and '''API hostname''' values.
-#* Secret Key
+#* For WHMCS 8.8 and earlier, retrieve the '''Integration Key''', '''Secret Key''', and '''API hostname''' values.
-#* API hostname
+# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Two Factor Authentication]]''' or, prior to WHMCS 8.0, '''Setup > Staff Management > Two-Factor Authentication'''.
-# Log in to the WHMCS Admin Area as an admin with Full Administrator privileges. [[File:Duo3.png|thumb|Complete configuration in WHMCS]]
+# Click '''Activate''' for '''Duo Security'''.
 # To enable Duo Security as a two-factor option for staff, check '''Enable for Staff'''.
 # To enable Duo Security for customers, check '''Enable for Clients'''.
-# Enter the Integration Key, Secret Key, and API Hostname you retrieved.
+# Enter the credentials and hostname that you retrieved from your Duo Security account.
 # Click '''Save Changes'''.

← Older revision		Revision as of 07:33, 3 May 2023
Line 68:		Line 68:

	You can use existing Duo accounts or users to complete two-factor authentication into the Admin Area. To do this, use the alias function in Duo to create an alias for the admin. For more information, see Duo's [https://help.duo.com/s/article/aliases-guide?language=en_US Aliases Guide ] documentation.		You can use existing Duo accounts or users to complete two-factor authentication into the Admin Area. To do this, use the alias function in Duo to create an alias for the admin. For more information, see Duo's [https://help.duo.com/s/article/aliases-guide?language=en_US Aliases Guide ] documentation.
		+
		+	== Reactivating a user ==
		+
		+	When a user replaces or loses a two-factor device, they will need to reauthenticate DuoSecurity in order to enable the prompt. To achieve this, an admin will need to delete and restore the users from within the Duo dashboard.
		+
		+	For more information, see [https://duo.com/docs/administration-users#activating-duo-mobile Duo's documentation].

	== Troubleshooting ==		== Troubleshooting ==

@@ Line 32: / Line 32: @@
 #* API hostname
 # Log in to the WHMCS Admin Area as an admin with Full Administrator privileges. [[File:Duo3.png|thumb|Complete configuration in WHMCS]]
-# Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Two Factor Authentication''' or, prior to WHMCS 8.0, '''Setup > Staff Management > Two-Factor Authentication'''.
+# Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Two Factor Authentication]]''' or, prior to WHMCS 8.0, '''Setup > Staff Management > Two-Factor Authentication'''.
 # Click '''Activate''' next to Duo Security.
 # To enable Duo Security as a two-factor option for staff, check '''Enable for Staff'''.

@@ Line 67: / Line 67: @@
 </div>
-You can use existing Duo accounts or users to complete two-factor authentication into the Admin Area. To do this, use the alias function in Duo to create an alias for the admin. For more information, see Duo's Aliases Guide [https://help.duo.com/s/article/aliases-guide?language=en_US Aliases Guide ] documentation.
+You can use existing Duo accounts or users to complete two-factor authentication into the Admin Area. To do this, use the alias function in Duo to create an alias for the admin. For more information, see Duo's [https://help.duo.com/s/article/aliases-guide?language=en_US Aliases Guide ] documentation.
 == Troubleshooting ==

← Older revision		Revision as of 11:56, 28 February 2022
Line 58:		Line 58:

	On all future login attempts, the client will be asked to complete the Two-Factor Authentication process.		On all future login attempts, the client will be asked to complete the Two-Factor Authentication process.
		+
		+	==Using Existing Duo Accounts With WHMCS==
		+
		+	The WHMCS Duo integration uses the following format for admins that it transmits to Duo:
		+
		+	<div class="source-cli">
		+	adminemailaddress:adminemailaddress:whmcslicensekey
		+	</div>
		+
		+	You can use existing Duo accounts or users to complete two-factor authentication into the Admin Area. To do this, use the alias function in Duo to create an alias for the admin. For more information, see Duo's Aliases Guide [https://help.duo.com/s/article/aliases-guide?language=en_US Aliases Guide ] documentation.

	== Troubleshooting ==		== Troubleshooting ==

← Older revision		Revision as of 10:17, 14 September 2021
Line 68:		Line 68:

	Different timezones are taken into account, ensuring that these differences won't cause a problem.		Different timezones are taken into account, ensuring that these differences won't cause a problem.
		+
		+	=== Invalid Integration ===
		+	An Invalid Integration error is displayed on the Duo authentication screen when the keys/hostname used in Duo module configuration are incorrect. Please reconfigure the module settings by [[#Configuring_Duo_Security\|following the steps above]].