View source for Plugin PasswordRequirement

<languages /><translate>

== Overview == <!--T:1-->

<!--T:2-->
The '''PasswordRequirement''' plugin is a core security plugin for LimeSurvey that allows administrators to enforce strong password policies. It provides configurable password complexity requirements for two distinct areas:

<!--T:3-->
* '''Administration Login:''' Passwords used by LimeSurvey administrators
* '''Survey Save Feature:''' Passwords used in the "Save and return later" functionality for survey participants

== Features == <!--T:4-->

<!--T:5-->
The plugin enforces the following customizable password requirements:

<!--T:6-->
* '''Minimum Password Length''' - Define the minimum number of characters required
* '''Digit Requirement''' - Require at least one number (0-9)
* '''Uppercase Requirement''' - Require at least one uppercase letter (A-Z)
* '''Special Character Requirement''' - Require at least one special character (!@#$%&..., etc.)

<!--T:7-->
Each requirement can be independently enabled or disabled per password type (admin login vs. survey save).

== Configuration == <!--T:8-->

=== Accessing Plugin Settings === <!--T:9-->

<!--T:10-->
# Log in to LimeSurvey as a super administrator
# Navigate to '''Administration''' → '''Plugins'''
# Find '''PasswordRequirement''' in the list of core plugins
# Click the '''Settings''' button (gear icon) next to the plugin name

=== Administration Login Settings === <!--T:11-->

<!--T:12-->
This section controls password requirements for administrator accounts.

<!--T:13-->
; '''Require at least one digit''' (Default Yes)
: When enabled, administrator passwords must contain at least one number (0-9). Example: <code>MyPass123word</code>

<!--T:14-->
; '''Require at least one uppercase character''' (Default 'Yes')
: When enabled, administrator passwords must contain at least one uppercase letter (A-Z). Example: <code>MyPassword123</code>

<!--T:15-->
; '''Require at least one special character''' (Default 'No')
: When enabled, administrator passwords must contain at least one special character from the set: <code>-=!@#$%&*_+,.?;:</code> Example: <code>MyPassword@123</code>

<!--T:16-->
; '''Minimum password length''' (Default '12' characters)
: Specifies the minimum number of characters required for administrator passwords. If left blank, defaults to 12 characters. Example: Setting to 16 requires passwords of at least 16 characters.

=== Survey Save Feature Settings === <!--T:17-->

<!--T:18-->
This section controls password requirements for the "Save and return later" feature used by survey respondents.

<!--T:19-->
; '''Check password when saving survey''' (Default 'No')
: When disabled, no password requirements are enforced for survey save functionality. When enabled, all configured requirements below are checked.

<!--T:20-->
; '''Require at least one digit''' (Default 'No')
: When enabled (and survey save checking is active), survey save passwords must contain at least one number.

<!--T:21-->
; '''Require at least one uppercase character''' (Default 'No')
: When enabled (and survey save checking is active), survey save passwords must contain at least one uppercase letter.

<!--T:22-->
; '''Require at least one special character''' (Default 'No')
: When enabled (and survey save checking is active), survey save passwords must contain at least one special character.

<!--T:23-->
; '''Minimum password length''' (Default 8 characters)
: Specifies the minimum number of characters required for survey save passwords. If left blank, defaults to 8 characters.

== Default Settings == <!--T:24-->

<!--T:25-->
The plugin comes with the following default configuration:

<!--T:26-->
{| class="wikitable"
|-
! Setting !! Default Value
|-
| Admin: Require digit || Yes
|-
| Admin: Require uppercase || Yes
|-
| Admin: Require special character || No
|-
| Admin: Minimum length || 12 characters
|-
| Survey save: Check password || No
|-
| Survey save: Require digit || No
|-
| Survey save: Require uppercase || No
|-
| Survey save: Require special character || No
|-
| Survey save: Minimum length || 8 characters
|}

== User Experience == <!--T:27-->

=== Password Validation === <!--T:28-->

<!--T:29-->
When a user attempts to set a password that does not meet the configured requirements:

<!--T:30-->
* The system displays '''clear error messages''' describing which requirements are not met
* Users are provided with specific feedback about what is missing (e.g., "Password must contain at least one uppercase letter")
* The password is rejected and must be re-entered with corrections

== Security Recommendations == <!--T:31-->

<!--T:32-->
For enhanced security, LimeSurvey recommends:

<!--T:33-->
* '''For administrators:''' Enable all requirements (digits, uppercase, special characters) with a minimum length of 12-16 characters
* '''For survey participants:''' Enable at minimum length validation (8+ characters). Additional requirements may hinder survey completion

== Password Generation == <!--T:34-->

<!--T:35-->
When the plugin is active, the system may automatically generate passwords that comply with the configured requirements when:

<!--T:36-->
* Creating new administrator accounts
* Resetting administrator passwords

<!--T:37-->
Generated passwords will include all required character types and respect the minimum length setting.

== Compatibility == <!--T:38-->

<!--T:39-->
* '''LimeSurvey versions:''' 4.0+, 5.0+, 6.0+, 7.0+
* '''Plugin version:''' 1.1.0
* '''License:''' GNU General Public License version 2 or later
* '''Author:''' LimeSurvey GmbH

== FAQ == <!--T:40-->

<!--T:41-->
; What special characters are allowed?
: The following characters are considered special: <code>-=!@#$%&*_+,.?;:</code>

<!--T:42-->
; Can I set different requirements for different admin users?
: No, the requirements apply globally to all administrator accounts.

<!--T:43-->
; What happens if I disable the plugin?
: Password requirements will no longer be enforced. Existing passwords remain unchanged, but new passwords can be set without meeting the requirements.

<!--T:44-->
; Can I set the minimum length to 0?
: Yes, but it's not recommended for security reasons. The system will accept empty passwords if all other requirements are disabled.

<!--T:45-->
; Does the plugin enforce password changes for existing users?
: No, the requirements apply only to new passwords or password resets. Existing passwords are not affected.

<!--T:46-->
; How long can passwords be?
: There is no upper limit on password length enforced by this plugin.

== Related Documentation == <!--T:47-->

<!--T:48-->
* [[User Security|LimeSurvey Security Guide]]
* [[Admin Account Management|Managing Administrator Accounts]]
* [[Survey Participant Authentication|Authentication for Survey Participants]]
</translate>