lemonldap-ng/doc/pages/documentation/1.9/resetpassword.html
2015-12-18 09:46:34 +00:00

201 lines
8.8 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
lang="en" dir="ltr">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title></title>
<!-- metadata -->
<meta name="generator" content="Offline" />
<meta name="version" content="Offline 0.1" />
<!-- style sheet links -->
<link rel="stylesheet" media="all" type="text/css" href="../../../css/all.css" />
<link rel="stylesheet" media="screen" type="text/css" href="../../../css/screen.css" />
<link rel="stylesheet" media="print" type="text/css" href="../../../css/print.css" />
</head>
<body>
<div class="dokuwiki export">
<h1 class="sectionedit1" id="reset_password_by_mail">Reset password by mail</h1>
<div class="level1">
</div>
<!-- EDIT1 SECTION "Reset password by mail" [1-38] -->
<h2 class="sectionedit2" id="presentation">Presentation</h2>
<div class="level2">
<p>
<abbr title="LemonLDAP::NG">LL::NG</abbr> can propose a password reset form, for users who loose their password (this kind of application is also called a self service password interface).
</p>
<p>
Kinematics:
</p>
<ul>
<li class="level1"><div class="li"> User clicks on the link <code>Reset my password</code></div>
</li>
</ul>
<p>
<a href="/_detail/screenshots/1.1/mailreset/mailreset_step1.png?id=documentation%3A1.9%3Aresetpassword" class="media" title="screenshots:1.1:mailreset:mailreset_step1.png"><img src="../../../media/screenshots/1.1/mailreset/mailreset_step1.png" class="mediacenter" alt="" width="600" /></a>
</p>
<ul>
<li class="level1"><div class="li"> User enters his email (or another information) in the password reset form</div>
</li>
<li class="level1"><div class="li"> <abbr title="LemonLDAP::NG">LL::NG</abbr> try to find the user in users database with the given information</div>
</li>
</ul>
<p>
<a href="/_detail/screenshots/1.1/mailreset/mailreset_step2.png?id=documentation%3A1.9%3Aresetpassword" class="media" title="screenshots:1.1:mailreset:mailreset_step2.png"><img src="../../../media/screenshots/1.1/mailreset/mailreset_step2.png" class="mediacenter" alt="" width="600" /></a>
</p>
<ul>
<li class="level1"><div class="li"> A mail with a token is sent to user</div>
</li>
</ul>
<p>
<a href="/_detail/screenshots/1.1/mailreset/mailreset_step3.png?id=documentation%3A1.9%3Aresetpassword" class="media" title="screenshots:1.1:mailreset:mailreset_step3.png"><img src="../../../media/screenshots/1.1/mailreset/mailreset_step3.png" class="mediacenter" alt="" width="600" /></a>
</p>
<ul>
<li class="level1"><div class="li"> The user click on the link in the mail</div>
</li>
</ul>
<p>
<a href="/_detail/screenshots/1.1/mailreset/mailreset_step4.png?id=documentation%3A1.9%3Aresetpassword" class="media" title="screenshots:1.1:mailreset:mailreset_step4.png"><img src="../../../media/screenshots/1.1/mailreset/mailreset_step4.png" class="mediacenter" alt="" width="600" /></a>
</p>
<ul>
<li class="level1"><div class="li"> <abbr title="LemonLDAP::NG">LL::NG</abbr> validate the token and propose a password change form</div>
</li>
<li class="level1"><div class="li"> The user can choose a new password or ask to generate one</div>
</li>
</ul>
<p>
<a href="/_detail/screenshots/1.1/mailreset/mailreset_step2.png?id=documentation%3A1.9%3Aresetpassword" class="media" title="screenshots:1.1:mailreset:mailreset_step2.png"><img src="../../../media/screenshots/1.1/mailreset/mailreset_step2.png" class="mediacenter" alt="" width="600" /></a>
</p>
<ul>
<li class="level1"><div class="li"> The new password is sent to user</div>
</li>
</ul>
<p>
<a href="/_detail/screenshots/1.1/mailreset/mailreset_step5.png?id=documentation%3A1.9%3Aresetpassword" class="media" title="screenshots:1.1:mailreset:mailreset_step5.png"><img src="../../../media/screenshots/1.1/mailreset/mailreset_step5.png" class="mediacenter" alt="" width="600" /></a>
</p>
<p>
<p><div class="notetip">If <a href="../../documentation/1.9/authldap.html" class="wikilink1" title="documentation:1.9:authldap">LDAP backend</a> is used, and LDAP password policy is enabled, the &#039;password reset flag is set to true when password is generated, so that the user is forced to change his password on next connection. This feature can be disabled in <a href="../../documentation/1.9/authldap.html" class="wikilink1" title="documentation:1.9:authldap">LDAP configuration</a>.
</div></p>
</p>
<p>
<p><div class="notetip">If the user do a new password reset request but there is already a request pending, the user can ask the confirmation mail to be resent. The request validity time is a configuration parameter.
</div></p>
</p>
</div>
<!-- EDIT2 SECTION "Presentation" [39-1551] -->
<h2 class="sectionedit3" id="configuration">Configuration</h2>
<div class="level2">
<p>
The reset password link must be activated, see <a href="../../documentation/1.9/portalcustom.html#other_parameters" class="wikilink1" title="documentation:1.9:portalcustom">portal customization</a>.
</p>
<p>
Then go in Manager, <code>General Parameters</code> » <code>Advanced Parameters</code> » <code>Password management</code>:
</p>
<ul>
<li class="level1"><div class="li"> <strong>SMTP</strong>:</div>
<ul>
<li class="level2"><div class="li"> <strong>SMTP Server</strong>: <abbr title="Internet Protocol">IP</abbr> or hostname of the SMTP server</div>
</li>
<li class="level2"><div class="li"> <strong>SMTP User</strong>: SMTP user if authentication is required</div>
</li>
<li class="level2"><div class="li"> <strong>SMTP Password</strong>: SMTP password if authentication is required</div>
</li>
</ul>
</li>
</ul>
<p>
<p><div class="notetip">
</p>
<ul>
<li class="level1"><div class="li"> If no SMTP server is configured, the mail will be sent via the local sendmail program. Else, Net::SMTP module is required to use the SMTP server</div>
</li>
<li class="level1"><div class="li"> The SMTP server value can hold the port, for example: <code>mail.example.com:25</code></div>
</li>
<li class="level1"><div class="li"> If authentication is configured, Authen::SASL and MIME::Base64 modules are required</div>
</li>
</ul>
<p>
</div></p>
</p>
<ul>
<li class="level1"><div class="li"> <strong>Mail headers</strong>: </div>
<ul>
<li class="level2"><div class="li"> <strong>Mail sender</strong>: address seen in the “From” field (default: noreply@[DOMAIN])</div>
</li>
<li class="level2"><div class="li"> <strong>Reply address</strong>: address seen in the “Reply-To” field</div>
</li>
<li class="level2"><div class="li"> <strong>Mail charset</strong>: Charset used for the body of the mail (default: utf-8)</div>
</li>
</ul>
</li>
</ul>
<ul>
<li class="level1"><div class="li"> <strong>Mail content</strong>:</div>
<ul>
<li class="level2"><div class="li"> <strong>Success mail subject</strong>: Subject of mail sent when password is changed (default: [LemonLDAP::NG] Your new password)</div>
</li>
<li class="level2"><div class="li"> <strong>Success mail content</strong> (optional): Content of mail sent when password is changed</div>
</li>
<li class="level2"><div class="li"> <strong>Confirmation mail subject</strong>: Subject of mail sent when password change is asked (default: [LemonLDAP::NG] Password reset confirmation)</div>
</li>
<li class="level2"><div class="li"> <strong>Confirmation mail content</strong> (optional): Content of mail sent when password change is asked</div>
</li>
</ul>
</li>
</ul>
<p>
<p><div class="noteimportant">
By default, mail content are empty in order to use <abbr title="HyperText Markup Language">HTML</abbr> templates:
</p>
<ul>
<li class="level1"><div class="li"> portal/skins/common/mail_confirm.tpl</div>
</li>
<li class="level1"><div class="li"> portal/skins/common/mail_password.tpl</div>
</li>
</ul>
<p>
If you define mail contents in Manager, <abbr title="HyperText Markup Language">HTML</abbr> templates will not be used.
</div></p>
</p>
<ul>
<li class="level1"><div class="li"> <strong>Other</strong>:</div>
<ul>
<li class="level2"><div class="li"> <strong>Page <abbr title="Uniform Resource Locator">URL</abbr></strong>: <abbr title="Uniform Resource Locator">URL</abbr> of password reset page (default: [PORTAL]/mail.pl)</div>
</li>
<li class="level2"><div class="li"> <strong>Regexp for password generation</strong>: Regular expression used to generate the password (default: [A-Z]{3}[a-z]{5}.\d{2})</div>
</li>
<li class="level2"><div class="li"> <strong>Validity time of a password reset request</strong>: number of seconds for password reset request validity. During this period, user can ask the confirmation mail to be resent (default: session timeout value)</div>
</li>
<li class="level2"><div class="li"> <strong>Session key containing mail address</strong>: name of the session key containing email address. This value will be used to know to which recipient the has to be sent (default: mail).</div>
</li>
</ul>
</li>
</ul>
</div>
</div><!-- closes <div class="dokuwiki export">-->