Differences

This shows you the differences between two versions of the page.

--- tutorial:adm:modules_pwdreset [2019/09/03 07:44] – [Configuration] update configuration properties with password generate kopro
+++ tutorial:adm:modules_pwdreset [2024/08/12 11:29] (current) – cem
@@ Line 1: / Line 1: @@
 ====== Modules - pwd-reset: How to reset forgotten password? ======
-The module provides functionality of password reset or, in other words, recovery of forgotten password.
+This module provides the functionality of password reset or, in other words, the recovery of a forgotten password.
+=====   =====
+==== How to allow password reset in CAS? ====
+For CAS docker set env variables:
+<code>
+- CAS_CUSTOM_FRONTEND_PASSWORDRESET_DISPLAY=true
+- CAS_CUSTOM_FRONTEND_PASSWORDRESET_LINK=<idm url>/\#/password-reset     # IMPORTANT: don't forget to escape characters like #
+</code>
+=====   =====
 ===== How does it work? =====
-{{ :devel:adm:modules:pwd_reset_activity_diagam.png?800 |}}
+{{  :devel:adm:modules:pwd_reset_activity_diagam.png?800  }}
 ===== Process of restoring your forgotten password =====
-Users can restore their forgotten password via password rest module. User can start the process on CzechIdM´s login page by clicking on "Forgotten password" link. In next step user is required to enter account identifier.
-{{ :tutorial:adm:reset_form_eng.png | }}
+Users can restore their forgotten password via the password reset module. User can start the process on CzechIdM´s login page by clicking on "Forgotten password" link. In next step user it is required to enter an account identifier.
-For now, identity email or login are supported and admin can use configuration property to select which of these (or both) can be used. User then confirms password reset request by clicking on submit button. CzechIdM then generates validation token and stores it in password reset request along with time of creation. Validation token is then being sent to user via notification. Administrator can edit the notification using standard CzechIdM notification functionality. Notification is sent to topic "passwordResetRequestCreated" with SUCCESS level.
+{{  .:reset_form_eng.png  }}
-{{ :tutorial:adm:email_pwd_eng.png | }}
+For now, the identity's email or login are supported and admin can use a configuration property to select which of these (or both) can be used. User then confirms password reset request by clicking on submit button. CzechIdM then generates validation token and stores it in the password reset request along with the time of creation. Validation token is then being sent to user via notification. Administrator can edit the notification using standard CzechIdM notification functionality. Notification is sent to topic "passwordResetRequestCreated" with SUCCESS level.
-After clicking on link, which contains verification token in GET parameters, user is asked to fill in new password. If password change succeeds (password validation is OK and user can change their own password), then user can log in to CzechIdM with new password.
+{{  .:email_pwd_eng.png  }}
-{{ :tutorial:adm:set_pwd_eng.png | }}
+After clicking on the link, which contains verification token in GET parameters, user is asked to fill in new password. If the password change succeeds (password validation is OK and user can change their own password), then the user can log in to CzechIdM with a new password.
-===== Password generate =====
-Password reset module has process for generating new password by default password policy for IdM. Form for password generate is part of password change component. For generate password to end system is necessary enabled event type ''PASSWORD_GENERATE'' for processor in acc (processor.identity-password-provisioning-processor).
+{{  .:set_pwd_eng.png  }}
+===== Password generating =====
+Password reset module has a process for generating new password by default based on a password policy for IdM. The form for password generating is a part of the password change component. To generate password to an end system it is necessary to enable the event type ''PASSWORD_GENERATE'' for processor in acc (processor.identity-password-provisioning-processor).
+Password generating is available by permission ''IDENTITY PASSWORDRESET'' (and also APP_ADMIN).
+<note important> By default, the "Password generate" form displays all end system accounts, but the password **will not** be provisioned to the end system accounts. So remember to add the event type ''PASSWORD\_GENERATE'' to the configuration property ''idm.sec.acc.processor.identity-password-provisioning-processor.eventTypes'' (as written above) to avoid confusion. </note>
+<note important>From versions 3.0.8 and 4.0.1, there is a new processor ''pwdreset-generate-stop-failed-processor'', which moves unsuccessful pasword generate provisionings directly to archive. The reason is in case there's password generate for multiple accounts, some of them are successful and some not, notification with new password is sent to user with list of accounts change was successful. In case failed attempt would be successful in future after retry, password for that account would be changed but user wouldn't receive notification about it.</note>
+Password Policy Handling with password criticality
+System Policy Defaults:
+Each system has a default password policy for generating passwords.
+Role-Based Policy Override:
+If the system allows lowering password criticality by role, new access rules apply:
+Different Criticalities:
+  * If two systems are selected, with one having Admin criticality and the other Technical account, the stronger policy (Admin) is used.
+  * emSame Policies, Different Sources: If two systems have identical policies but one was created later, the password follows the older policy.
+IdM Accounts:
+  * When generating passwords for IdM accounts, role criticalities on contracts are considered.
+Combining Systems and IdM: If both systems and IdM are selected, the higher criticality policy prevails; if policies are the same, the older policy is used.
+<note important>For role-based password policy functionality, ensure you are using pwd reset version 3.0.9 and IdM version 13.0.21 or higher.</note>
-Password generate is available by permission ''IDENTITY PASSWORDRESET'' (and also APP_ADMIN).
-<note important>
-By default, the "Password generate" form displays all end system accounts, but password **will not** be provisioned to the end system accounts. So remember to add the event type ''PASSWORD\_GENERATE'' to the configuration property ''idm.sec.acc.processor.identity-password-provisioning-processor.eventTypes'' (as written above) to avoid confusion.
-</note>
 ===== Reset password in user´s system accounts =====
-Password reset module changes users passwords only in CzechIdM account. To reset passwords in end system accounts you need to have acc module enabled and do a little bit of configuration. Actually the only thing you need to configure is to set IdentityPasswordProvisioningProcessor and PasswordValidateProcessor to respond to PASSWORD_RESET event type. You can do it by setting
+Password reset module changes user's passwords only to their CzechIdM account. To reset passwords to end system accounts you need to have the acc module enabled and do a little bit of configuration. You need to set IdentityPasswordProvisioningProcessor and PasswordValidateProcessor to respond to PASSWORD_RESET event type. You can do it by setting
 <code>
 idm.sec.acc.processor.identity-password-provisioning-processor.eventTypes=PASSWORD,PASSWORD_RESET,PASSWORD_GENERATE
 idm.sec.acc.processor.identity-password-validate-processor.eventTypes=PASSWORD,PASSWORD_RESET
 </code>
-After password reset, notification is sent to user with system names and accounts, where password has been changed. This processor have to be enabled with setting
+After the password reset, notification is sent to user with system names and accounts, where password has been changed. This processor has to be enabled with setting
 <code>
 idm.sec.core.processor.identity-password-change-notification.eventTypes=PASSWORD,PASSWORD_RESET
 </code>
@@ Line 46: / Line 82: @@
 ===== Installation =====
 Download the module distribution package. The package contains a backend folder. Your IdM Tomcat installation we call IDM in the following example.
-  - Copy content of the backend folder into your tomcat IdM installation - [IDM]/WEB-INF/lib
+  - Copy the content of the backend folder into your tomcat IdM installation - [IDM]/WEB-INF/lib
   - Set correct access rights to the files if needed (''chown tomcat:tomcat [IDM]/WEB-INF/lib/*'')
   - Restart the IdM application server (''service tomcat restart'')
-  - Log in to CzechIdM as an privileged user and go to Settings -> Modules and enable the pwd-reset module.
+  - Log in to CzechIdM as a privileged user and go to Settings → Modules and enable the pwd-reset module.
   - Go to the configuration and configure required properties (see below).
-  - Add the event types ''PASSWORD\_RESET'' and ''PASSWORD\_GENERATE'' for processors as [[tutorial:adm:modules_pwdreset#reset_password_in_user_s_system_accounts|described above]], if you want to reset and provision generated passwords for end system accounts (typically, you do).
+  - Add the event types ''PASSWORD\_RESET''  and ''PASSWORD\_GENERATE''  for processors as [[.:modules_pwdreset#reset_password_in_user_s_system_accounts|described above]], if you want to reset and provision generated passwords for end system accounts (typically, you do).
 ===== Configuration =====
 The module provides following configuration properties:
-^ Property                                                    ^ Description                                                                                                                                                                                        ^
-| idm.pub.pwdreset.allowed.attrs                              | REQUIRED. List of identity attributes (separated by comma) which can be used by user to identify their account when reseting password (username, email and personal number are available for now)  |
+^Property  ^Description  |
-| idm.sec.pwdreset.token.ttl                                  | How many minutes is verification token valid (default is 60 minutes)                                                                                                                               |
+|idm.pub.pwdreset.allowed.attrs  |REQUIRED. List of identity attributes (separated by comma) which can be used by user to identify their account when reseting password (username, email and personal number are available for now)  |
-| idm.pub.pwdreset.identity.passwordReset.public.idm.enabled  | Boolean value to enable/disable password reset and password generate for CzechIdM system. Default value is true (password reset and password generate is enabled).                                                                             |
+|idm.sec.pwdreset.token.ttl  |How many minutes is verification token valid (default is 60 minutes)  |
-| idm.sec.pwdreset.debug                                      | Debug password reset, if value is true token will be visible in notification in IdM.                                                                                                              |
+|idm.pub.pwdreset.identity.passwordReset.public.idm.enabled  |Boolean value to enable/disable password reset and password generate for CzechIdM system. Default value is true (password reset and password generate is enabled).  |
+|idm.sec.pwdreset.debug  |Debug password reset, if value is true token will be visible in notification in IdM.  |
+|idm.sec.pwdreset.token.length  |Length of generated verification tokens - Default is 25  |
 ===== Video Guide =====
 [[https://www.youtube.com/watch?v=bxhVHXo-A-k&index=2&list=PLBeAQt3pe3EcdVE8QpCDEJcDsi_jtNQUb|How to reset password]] - czech language
+===== FAQ =====