TwoFactorAdminLogin - Revision history

C schmitz: Marked this version for translation

2025-04-14T19:06:34Z

Marked this version for translation

← Older revision		Revision as of 21:06, 14 April 2025
Line 15:		Line 15:
	The plugin supports both TOTP (Time-based One-Time Password) and Yubikey authentication methods.		The plugin supports both TOTP (Time-based One-Time Password) and Yubikey authentication methods.

			<!--T:60-->
	When TOTP is enabled, a 6 digits code (default value) has to be introduced when you log in to your LimeSurvey instance. If Yubikey is configured, when logging in, the Yubikey will create the code.		When TOTP is enabled, a 6 digits code (default value) has to be introduced when you log in to your LimeSurvey instance. If Yubikey is configured, when logging in, the Yubikey will create the code.

Line 53:		Line 54:
	'''TOTP Settings:'''		'''TOTP Settings:'''

			<!--T:61-->
	*''Issuer:'' The text typed in this box will be displayed in the app as issuer name.		*''Issuer:'' The text typed in this box will be displayed in the app as issuer name.
	*''Digits:'' The number of digits the resulting codes will be. Please leave it at 6 for Google Authenticator.		*''Digits:'' The number of digits the resulting codes will be. Please leave it at 6 for Google Authenticator.
Line 64:		Line 66:
	**MD5		**MD5

			<!--T:62-->
	'''Yubikey Settings:'''		'''Yubikey Settings:'''

			<!--T:63-->
	*''YubiCloud Client ID'': Your YubiCloud Client ID for validating Yubikey authentication attempts. This is required to use Yubikey as an authentication method.		*''YubiCloud Client ID'': Your YubiCloud Client ID for validating Yubikey authentication attempts. This is required to use Yubikey as an authentication method.
	*''YubiCloud Secret Key'': Optional but recommended. When set, the YubiCloud responses' authenticity will be verified, providing an additional layer of security.		*''YubiCloud Secret Key'': Optional but recommended. When set, the YubiCloud responses' authenticity will be verified, providing an additional layer of security.

			<!--T:64-->
	To obtain these credentials, you can sign up for a Yubico API key at the [https://upgrade.yubico.com/getapikey/ Yubico API key signup page].		To obtain these credentials, you can sign up for a Yubico API key at the [https://upgrade.yubico.com/getapikey/ Yubico API key signup page].

Line 74:		Line 79:
	'''General Settings:'''		'''General Settings:'''

			<!--T:65-->
	*''Force 2FA:''		*''Force 2FA:''
	** Only prompt, no enforcement Users without 2FA token are redirected to 2FA creation after login		** Only prompt, no enforcement Users without 2FA token are redirected to 2FA creation after login
Line 120:		Line 126:
	* Yubikey		* Yubikey

			<!--T:66-->
	When selecting a TOTP 2FA method:		When selecting a TOTP 2FA method:
	* Scan the QR-code with your mobile phone. For a list of application recommendations, check this [https://en.wikipedia.org/wiki/Help:Two-factor_authentication#Enabling_2FA_on_smartphones_and_tablet_computers article].		* Scan the QR-code with your mobile phone. For a list of application recommendations, check this [https://en.wikipedia.org/wiki/Help:Two-factor_authentication#Enabling_2FA_on_smartphones_and_tablet_computers article].
	* Enter the confirmation key displayed in your 2FA application.		* Enter the confirmation key displayed in your 2FA application.

			<!--T:67-->
	When selecting Yubikey:		When selecting Yubikey:
	* Generate a code with your Yubikey in the confirmation key.		* Generate a code with your Yubikey in the confirmation key.
Line 138:		Line 146:
	<hr width="50%" style="margin:auto">		<hr width="50%" style="margin:auto">

	== Personal 2FA Settings ==		== Personal 2FA Settings == <!--T:68-->

			<!--T:69-->
	Once done, the following two options will be displayed in your personal 2FA settings:		Once done, the following two options will be displayed in your personal 2FA settings:

C schmitz: Removed obsolete paragraph

2025-04-14T19:06:22Z

Removed obsolete paragraph

← Older revision		Revision as of 21:06, 14 April 2025
Line 189:		Line 189:
	<!--T:54-->		<!--T:54-->
	Enable "Force 2FA" from the plugin configuration menu.		Enable "Force 2FA" from the plugin configuration menu.


	~~==From where can I download the plugin?== <!--T:55-->~~


	~~<!--T:56-->~~
	Please access [https://www.limesurvey.org/limestore LimeStore] and [https://www.limesurvey.org/limestore?view=extensiondetails&id=49 download the plugin from download it from here]. To be able to download it, you need to hold a Premium package

Gabrieljenik: New Feature: Yubikey

2025-04-14T17:45:11Z

New Feature: Yubikey

← Older revision		Revision as of 19:45, 14 April 2025
Line 15:		Line 15:
	The plugin supports both TOTP (Time-based One-Time Password) and Yubikey authentication methods.		The plugin supports both TOTP (Time-based One-Time Password) and Yubikey authentication methods.

	When TOTP is enabled, a 6 digits code (default value) has to be introduced when you log in to your LimeSurvey instance. If Yubikey is configured, when logging in, the Yubikey will ~~creating~~ the code.		When TOTP is enabled, a 6 digits code (default value) has to be introduced when you log in to your LimeSurvey instance. If Yubikey is configured, when logging in, the Yubikey will create the code.

Gabrieljenik: New Feature: Yubikey

2025-04-14T17:44:33Z

New Feature: Yubikey

← Older revision		Revision as of 19:44, 14 April 2025
Line 112:		Line 112:

	<!--T:35-->		<!--T:35-->
	If you decide to create a 2FA-token, click on "Register 2FA now". You will be prompted ~~by the following~~ message box:		If you decide to create a 2FA-token, click on "Register 2FA now".
			You will be prompted with a message box:

	~~<!--T:36-->~~
	~~<center>[[File:2fa_user_settings.png]]</center>~~


	<!--T:37-->		<!--T:37-->
	Select the 2FA authentication method. ~~By default, five different 2FA types are provided~~: Google Authenticator ~~(default)~~, Authy, Yubikey~~, Authenticator Plus, Duo, and HDE OTP.~~		Select the 2FA authentication method.
			* TOTP: Using Google Authenticator, Authy, ...
			* Yubikey

			When selecting a TOTP 2FA method:
	When selecting a TOTP 2FA method ~~(Ex Google Authenticator, Authy, Duo, ...)~~:
	* Scan the QR-code with your mobile phone. For a list of application recommendations, check this [https://en.wikipedia.org/wiki/Help:Two-factor_authentication#Enabling_2FA_on_smartphones_and_tablet_computers article].		* Scan the QR-code with your mobile phone. For a list of application recommendations, check this [https://en.wikipedia.org/wiki/Help:Two-factor_authentication#Enabling_2FA_on_smartphones_and_tablet_computers article].
	* Enter the confirmation key displayed in your 2FA application.		* Enter the confirmation key displayed in your 2FA application.
Line 139:		Line 136:

	<!--T:40-->		<!--T:40-->
	<hr width="50%" style="margin:auto">		<hr width="50%" style="margin:auto">


	~~<!--T:41-->~~
	== Personal 2FA Settings ==		== Personal 2FA Settings ==

Gabrieljenik: New Feature: Yubikey

2025-04-14T15:38:39Z

New Feature: Yubikey

← Older revision		Revision as of 17:38, 14 April 2025
Line 120:		Line 120:

	<!--T:37-->		<!--T:37-->
	~~To enable 2FA:~~		Select the 2FA authentication method. By default, five different 2FA types are provided: Google Authenticator (default), Authy, Yubikey, Authenticator Plus, Duo, and HDE OTP.
	#Select the 2FA authentication method. By default, five different 2FA types are provided: Google Authenticator (default), Authy, ~~YubiKey~~, Authenticator Plus, Duo, and HDE OTP.
	#Scan the QR-code with your mobile phone. For a list of application recommendations, check this [https://en.wikipedia.org/wiki/Help:Two-factor_authentication#Enabling_2FA_on_smartphones_and_tablet_computers article].
	#Enter the confirmation key displayed in your 2FA application.		When selecting a TOTP 2FA method (Ex Google Authenticator, Authy, Duo, ...):
			* Scan the QR-code with your mobile phone. For a list of application recommendations, check this [https://en.wikipedia.org/wiki/Help:Two-factor_authentication#Enabling_2FA_on_smartphones_and_tablet_computers article].
			* Enter the confirmation key displayed in your 2FA application.

			When selecting Yubikey:
			* Generate a code with your Yubikey in the confirmation key.


	<!--T:38-->		<!--T:38-->
Line 129:		Line 135:

	<!--T:39-->		<!--T:39-->
	To confirm the creation of your 2FA-token, click on "Create 2FA binding".		To confirm the creation of your 2FA-token, click on "'''Create 2FA binding'''".


Line 137:		Line 143:

	<!--T:41-->		<!--T:41-->
			== Personal 2FA Settings ==

	Once done, the following two options will be displayed in your personal 2FA settings:		Once done, the following two options will be displayed in your personal 2FA settings:

Line 145:		Line 153:

	<!--T:43-->		<!--T:43-->
	* '''Unset 2FA:''' Confirm your action to delete the 2FA-token associated to your account.		* ''Unset 2FA:'' Confirm your action to delete the 2FA-token associated to your account.


	<!--T:44-->		<!--T:44-->
	{{Note\|Please note that you will need to re-authenticate again if "Force 2FA" is enabled from the plugin settings.}}		{{Note\|Please note that you will need to re-authenticate again if "Force 2FA" is enabled from the plugin settings.}}


	<!--T:45-->		<!--T:45-->
	* '''Reset 2FA:''' If this option is selected, you will be asked to scan the new QR-code and introduce the new confirmation Key.		* ''Reset 2FA:'' If this option is selected, you will be asked to scan the new QR-code and introduce the new confirmation Key.


	==2FA-Administration== <!--T:46-->		==2FA-Administration== <!--T:46-->

Gabrieljenik: New Feature: Yubikey

2025-04-14T15:19:02Z

New Feature: Yubikey

← Older revision		Revision as of 17:19, 14 April 2025
Line 50:		Line 50:
	The configuration page contains the following settings:		The configuration page contains the following settings:

			<!--T:23-->
			'''TOTP Settings:'''

	<!--T:22-->		*''Issuer:'' The text typed in this box will be displayed in the app as issuer name.
	~~<center>[[File~~:~~2FA plugin configuration.png]]</center>~~		*''Digits:'' The number of digits the resulting codes will be. Please leave it at 6 for Google Authenticator.
			*''TimePeriod:'' The number of seconds a code will be valid. If you use Google Authenticator, please leave it to 30.
			*''Discrepancy:'' The amount of discrepancy is allowed for the client after the TimePeriod expires (seconds)

			<!--T:24-->
			*''Algorithm:'' The algorithm used to generate a hash:
			**SHA1 (Default)
			**SHA256
			**MD5

			'''Yubikey Settings:'''

	~~<!--T:23-->~~		*''YubiCloud Client ID'': Your YubiCloud Client ID for validating Yubikey authentication attempts. This is required to use Yubikey as an authentication method.
	*'''~~Issuer~~:~~''' The text typed in this box will be displayed in the app~~ as ~~issuer name~~.		*''YubiCloud Secret Key'': Optional but recommended. When set, the YubiCloud responses' authenticity will be verified, providing an additional layer of security.
	*'''~~Digits~~:~~''' The number of digits~~ the ~~resulting codes will be. Please leave it at 6 for Google Authenticator.~~
	*'''~~TimePeriod:''' The number of seconds a code~~ will be ~~valid. If you use Google Authenticator~~, ~~please leave it to 30~~.
	*'''Discrepancy:''' The amount of discrepancy is allowed for the client after the TimePeriod expires (seconds)

	~~<!--T:24-->~~		To obtain these credentials, you can sign up for a Yubico API key at the [https://upgrade.yubico.com/getapikey/ Yubico API key signup page].
	*'''Algorithm:''' The algorithm used to generate a ~~hash~~:
	**''SHA1 (Default)''
	**''SHA256''
	**''MD5''

	<!--T:25-->		<!--T:25-->
	*'''Force 2FA:'''		'''General Settings:'''
	** ''Only prompt, no enforcement'' Users without 2FA token are redirected to 2FA creation after login
	** ''Always enforce 2FA activation'' Users without 2FA token are redirected to 2FA creation after login, and no other action are available, except remote control.		*''Force 2FA:''
			** Only prompt, no enforcement Users without 2FA token are redirected to 2FA creation after login
			** Always enforce 2FA activation Users without 2FA token are redirected to 2FA creation after login, and no other action are available, except remote control.

	<!--T:26-->		<!--T:26-->
	Don't forget to click on "Save" after updating your 2FA configuration.		'''Important''': Don't forget to click on "Save" after updating your 2FA configuration.

	=2-Factor-Settings= <!--T:27-->		=2-Factor-Settings= <!--T:27-->

Gabrieljenik: New Feature: Yubikey

2025-04-14T15:06:01Z

New Feature: Yubikey

← Older revision		Revision as of 17:06, 14 April 2025
Line 13:		Line 13:

	<!--T:4-->		<!--T:4-->
	If enabled, a 6 digits code (default value) has to be introduced when you log in to your LimeSurvey instance:		The plugin supports both TOTP (Time-based One-Time Password) and Yubikey authentication methods.

			When TOTP is enabled, a 6 digits code (default value) has to be introduced when you log in to your LimeSurvey instance. If Yubikey is configured, when logging in, the Yubikey will creating the code.

Denischenu: Force 2FA : enforce

2025-03-19T16:49:24Z

Force 2FA : enforce

← Older revision		Revision as of 18:49, 19 March 2025
Line 66:		Line 66:

	<!--T:25-->		<!--T:25-->
	*'''Force 2FA:''' ~~If you enable it~~, ~~all instance users have~~ to ~~create a~~ 2FA token after ~~they log in again into the LimeSurvey instance~~.		*'''Force 2FA:'''
			** ''Only prompt, no enforcement'' Users without 2FA token are redirected to 2FA creation after login
			** ''Always enforce 2FA activation'' Users without 2FA token are redirected to 2FA creation after login, and no other action are available, except remote control.

	<!--T:26-->		<!--T:26-->

Han: Marked this version for translation

2025-03-14T18:13:31Z

Marked this version for translation

← Older revision		Revision as of 20:13, 14 March 2025
Line 25:		Line 25:
	=How to install the 2FA plugin= <!--T:7-->		=How to install the 2FA plugin= <!--T:7-->

			<!--T:59-->
	Since version 6.x the plugin is a core plugin. So just visit the [[Plugin manager\|Plugin Manager]] page and enable it from there (see below for more details).		Since version 6.x the plugin is a core plugin. So just visit the [[Plugin manager\|Plugin Manager]] page and enable it from there (see below for more details).

Mazi: Removed details about how to download plugin

2024-06-18T08:34:23Z

Removed details about how to download plugin

@@ Line 22: / Line 22: @@
 <!--T:6-->
 To learn more about this functionality, please continue reading below.
 =How to install the 2FA plugin= <!--T:7-->
-==LimeSurvey Cloud== <!--T:8-->
+Since version 6.x the plugin is a core plugin. So just visit the [[Plugin manager|Plugin Manager]] page and enable it from there (see below for more details).
 =Activate the 2FA plugin= <!--T:16-->
 <!--T:17-->