derhansen/fe_change_pwd

Plugin to enable password change for frontend users. Contains configurable password rules and password change enforcement.

Fund package maintenance!
www.paypal.me/derhansen

Installs: 6 059

Dependents: 0

Suggesters: 0

Security: 0

Stars: 2

Watchers: 1

Forks: 6

Open Issues: 5

Type:typo3-cms-extension

2.0.1 2020-08-04 17:23 UTC

This package is auto-updated.

Last update: 2020-11-04 18:01:06 UTC


README

Build Status Scrutinizer Code Quality Project Status: Active – The project has reached a stable, usable state and is being actively developed.

Change password for frontend users

What does it do?

This TYPO3 extension contains a plugin to allow logged in frontend users to change their password. Additionally the extension allows to define password rules for frontend user passwords and can also check if the password was part of a data breach using the haveibeenpwned.com API.

Password changes for frontend users can be enforced and passwords can expire after a certain amount of days.

Features:

  • Change password plugin
  • Configurable password rules (upper case char, lower case char, digit, special char)
  • Force password change for frontend users
  • Redirect to configured page when password change is required (uses PSR-15 Middleware in TYPO3 v9)
  • Password expiration after a configurable amount of days
  • Optional check if password has been part of a data breach using the haveibeenpwned.com API and the k-Anonymity model
  • Optional require the current password in order to change it

Screenshot

The screenshot below shows the output of the "Change Frontend User Password" plugin after the user tried to submit
a weak password.

Screenshot of the plugin outpu

Installation

  1. Install the extension from the TYPO3 Extension Repository or using composer and add the Static Typoscript "Change password for frontend users" to your TypoScript template.

  2. Create a new page and make sure, that the page is only visible to logged in frontend users.

  3. Add the Plugin "Change Frontend User Password" to the page created in step 2

  4. Change TypoScript settings to your needs. Please note, that if you want to use the password change enforcement, you must set settings.changePasswordPid to the page uid of the page created in step 2

  5. Optionally change the path to the extension templates in TypoScript and modify the templates to your needs.

New fe_user fields

The extension adds two new fields to the fe_users table (see screenshot)

Screenshot of a fe_users

If the checkbox "User must change password at next login" is set and a valid changePasswordPid is configured, the user will be redirected to the configured page after login or whe accessing pages configured in the plugin.tx_fechangepwd.settings.redirect section.

The password expiry date defines the date, after a user must change the password.

Tip: If you quickly want all frontend users to change their passwords, you can use a simple SQL statement to set the field in the database like shown in this example UPDATE fe_users set must_change_password=1;

TypoScript configuration settings

The following TypoScript settings are available.

plugin.tx_fechangepwd.settings

  • changePasswordPid (integer) The pid to redirect to if a password change is required. This is usually the page with the Plugin of the extension

plugin.tx_fechangepwd.settings.passwordComplexity

  • minLength (integer) Minimum length for the password.
  • capitalCharCheck (bool) Is set to 1, the password must at least contain one capital character.
  • lowerCaseCharCheck (bool) Is set to 1, the password must at least contain one lower case character
  • digitCheck (bool) Is set to 1, the password must at least contain one digit
  • specialCharCheck (bool) Is set to 1, the password must at least contain one special character

plugin.tx_fechangepwd.settings.requireCurrentPassword

  • enabled (bool) If set to 1, the user must enter the current password in order to set a new password.

plugin.tx_fechangepwd.settings.pwnedpasswordsCheck

  • enabled (bool) If set to 1, the new password is checked using the haveibeenpwned.com API to verify, that the password has not been exposed in a data breach. Note, that the API uses a k-Anonymity model, so no passwords are submitted to the external service. Read more about it here

plugin.tx_fechangepwd.settings.oldPasswordCheck

  • enabled (bool) If set to 1, it is checked, if the new password equals the old password and if so, the user must choose a different password.

plugin.tx_fechangepwd.settings.passwordExpiration

  • enabled (bool) Is set to 1, new passwords will expire after the configured amount of days
  • validityInDays (integer) The amount of days, a new password is valid before it needs to be changed

plugin.tx_fechangepwd.settings.redirect

  • allAccessProtectedPages (bool) If set to 1, a redirect to the configured changePasswordPid will be forced for all access protected pages. Note, that if this option is set, the includePageUids is ignored!
  • includePageUids (string) A redirect to the configured changePasswordPid will be forced for the configured PIDs separated by a comma
  • includePageUidsRecursionLevel (integer) The recursion level for all pages configured in includePageUids. Use this option, if you e.g. want to force a redirect for a page and all subpages
  • excludePageUids (string) No redirect will be forced for the configured PIDs separated by a comma
  • excludePageUidsRecursionLevel (integer) The recursion level for all pages configured in excludePageUids. Use this option, if you e.g. want to exclude a page and all subpages for the redirect

plugin.tx_fechangepwd.settings.afterPasswordChangeAction

  • redirect (string) Redirects the user to the "update" action and adds a flash message, that the password has been updated.
  • view (string) Shows the view for the update action with a message, that the password has been updated

Styling

The extension output is completely unstyled. Feel free to override the fluid templates to your needs.

Possible Errors

No password hashing service

The extension will not save a users password, if it can not be securily be hashed. If this scenario occurs, the following exception is shown:

No secure password hashing service could be initialized. Please check your TYPO3 system configuration

Possible CSRF detected

When the extension detects a possible CSRF, the following message is shown:

Possible CSRF detected. Ensure a valid "changeHmac" is provided.

If you unexpectedly see this message, ensure you add the changeHmac property as described in "Breaking Changes" for version 1.5.0

For developers

Signal slots

The extension currently contains the following signal slots:

  • Derhansen\FeChangePwd\Controller\PasswordController
    • updateActionAfterUpdatePassword

Please refer to the class and function for signal arguments.

Breaking changes

Version 1.5.0

Added CSRF protection.

If you use an own template for "Edit.html", you must add the following code inside <f:form>...</f:form>.

<f:form.hidden property="changeHmac" />

Prior to version 1.5.0, the extension did contain a CSRF vulnerabilty, if settings.requireCurrentPassword was disabled (default). In order to mitigate the issue, the property changeHmac has been added to the DTO. This property contains a HMAC, which is unique for the current logged in user. When the provided changeHmac does not match the expected value, an exception is thrown when the form is submitted.

Version 2.0.0

Dropped TYPO3 8.7 compatibility.

Thanks for sponsoring

  • Thanks to Wikafi sprl for sponsoring the initial development of this extension and for supporting open source software.

  • Thanks to t3site.com for sponsoring the "Require current password" feature.

Additional thanks

Also a big thanks to Troy Hunt for his remarkable work and the haveibeenpwned.com service and API.