LISTSERV Maestro Admin Tech Doc 21 User Name and Password Recovery October 2, 2014 L-Soft Sweden AB lsoft.com
This document is a LISTSERV Maestro Admin Tech Doc. Each admin tech doc documents a certain facet of the LISTERV Maestro administration on a technical level. This document is number 21 of the collection of admin tech docs and explains the topic User Name and Password Recovery. Last updated for LISTSERV Maestro 6.0-1 on October 2, 2014. The information in this document also applies to later LISTSERV Maestro versions, unless a newer version of the document supersedes it. Information in this document is subject to change without notice. Companies, names, and data used in examples herein are fictitious unless otherwise noted. L-Soft Sweden AB does not endorse or approve the use of any of the product names or trademarks appearing in this document. Permission is granted to copy this document, at no charge and in its entirety, provided that the copies are not used for commercial advantage, that the source is cited, and that the present copyright notice is included in all copies so that the recipients of such copies are equally bound to abide by the present conditions. Prior written permission is required for any commercial use of this document, in whole or in part, and for any partial reproduction of the contents of this document exceeding 50 lines of up to 80 characters, or equivalent. The title page, table of contents and index, if any, are not considered part of the document for the purposes of this copyright notice, and can be freely removed if present. Copyright 2003-2014, L-Soft Sweden AB All Rights Reserved Worldwide. LISTSERV is a registered trademark licensed to L-Soft international, Inc. L-SOFT and LMail are trademarks of L-Soft international, Inc. CataList and EASE are service marks of L-Soft international, Inc. All other trademarks, both marked and not marked, are the property of their respective owners. Some portions licensed from IBM are available at http://oss.software.ibm.com/icu4j/ This product includes code licensed from RSA Security, Inc. This product includes software developed by the Apache Software Foundation (http://www.apache.org/). All of L-Soft's manuals for LISTSERV are available in ASCII-text format via LISTSERV and in popular word-processing formats via ftp.lsoft.com. They are also available on the World Wide Web at the following URL: URL: http://www.lsoft.com/manuals.html L-Soft invites comment on its manuals. Please feel free to send your comments by e-mail to: MANUALS@LSOFT.COM
Table of Contents 1 Introduction... 1 2 Enabling the Recovery Feature... 1 3 Defining the Email Templates... 2 3.1 The usernamemail.txt Template... 2 3.2 The passwordconfirmmail.txt Template... 2 3.3 HTML Email Templates... 2 3.4 Subject Line and From-Address... 3 4 Template Examples... 4 4.1 Example for usernamemail.txt... 4 4.2 Example for usernamemail.html... 4 4.3 Example for passwordconfirmmail.txt... 5 4.4 Example for passwordconfirmmail.html... 5 iii
1 Introduction LISTSERV Maestro s login page can be augmented with a feature that allows users to recover their user names and passwords, if they have forgotten them. This feature only makes sense if the user accounts, as defined in the HUB, have account addresses configured. So before you enable this recovery feature, make sure that this is the case for the user accounts in your LISTSERV Maestro instance: For each account, click its name on the Accounts and Identities page, then select User Account Edit from the menu. Specify the Account Address in the Contact Email Addresses section. If enabled, the recovery feature appears on the login page as an additional line of text below the login box: Forgot your user name or password? Depending on their needs, users can then click either the user name or the password link to recover their forgotten information. 2 Enabling the Recovery Feature To enable the recovery feature, add the following entry to the lui.ini: UserInfoNotificationMailFolder=PATH_TO_FOLDER where you replace PATH_TO_FOLDER with the absolute path name of the folder where the email templates are stored (see the following section for details). Remember to use forward slashes / in the path (or double backslashes \\ instead of single backslashes). The folder should be located outside of the LISTSERV Maestro installation folder, so that it will not be impacted by future upgrades. In addition to configuring the folder name in the lui.ini, you also need to put the necessary template files for the notification emails into this folder. As the absolute minimum, you need the following two files: usernamemail.txt passwordconfirmmail.txt The recovery feature is enabled if the lui.ini entry described above points to a folder that contains (at least) these two files. LISTSERV Maestro Admin Tech Doc 21 1 User Name and Password Recovery
3 Defining the Email Templates The two files described in the previous section will be used as templates for the respective emails. The first file will be used to recover a forgotten user name, the second file will be used to recover a forgotten password. The respective emails will be sent in plain text format. In these templates, you can use the following placeholders: 3.1 The usernamemail.txt Template If the user forgets his user name, he is asked to input his email address. The system then checks if there are any accounts that have this address configured as the "Account Address" (in the HUB, only the "Account Address" field counts for this, the "Additional notification addresses" are ignored). If at least one such account is found (can also be several), then the email with this template is sent, using the following placeholders: {0} : will be replaced with a comma separated list of all account names that have the specified email address as the "Account Address". This placeholder is mandatory, because this information is the whole point of the email. {1} : will be replaced with the specified email address (i.e. the "Account Address" to which this email is sent). This placeholder is optional. 3.2 The passwordconfirmmail.txt Template If the user forgets his password, he is asked to enter his account name (and group, if applicable) and a new password. If the specified account is found, then the email with this template is sent to the account's "Account Address", to confirm the password change, using the following placeholders: {0} : will be replaced with the account name. This placeholder is optional. {1} : will be replaced with the account's "Account Address" (i.e. the address to which this email is sent). This placeholder is optional. {2} : will be replaced with the confirmation URL on which the user must click to confirm the password change. This placeholder is mandatory, because this confirm URL is the whole point of the email. 3.3 HTML Email Templates If you want HTML emails instead of plain text emails, then in addition to the two files above, you can also put a file called usernamemail.html and/or a file called passwordconfirmmail.html into the same folder as the *.txt templates. If present, each of these files must contain a template for the corresponding email in HTML format (using the same template placeholders as described above). If the additional HTML template file is present, then the email in question will be sent out as a HTML email, with the plain text version (from the matching *.txt file) as the alternative text. The HTML email can even reference images: Either with absolute http:// URLs (if the images are hosted on a web server somewhere) or with relative URLs. A relative image URL in the HTML code is interpreted as relative to the location of the HTML file. If such a relatively referenced image is found, then the image is loaded together with the HTML file and is included in the email as an inline image (as a special inline attachment). LISTSERV Maestro Admin Tech Doc 21 2 User Name and Password Recovery
3.4 Subject Line and From-Address The default subject line for the usernamemail is: LISTSERV Maestro Account Information If you want to override this with your own subject line, then you can do this in the lui.ini, with the following entry: UserInfoNotificationMailSubject=YOUR_SUBJECT_LINE The default subject line for the passwordconfirmmail is: LISTSERV Maestro Account {0} Password Change - Request For Confirmation If you want to override this with your own subject line, then you can do this in the lui.ini, with the following entry: PasswordConfirmNotificationMailSubject=YOUR_SUBJECT_LINE In both subject lines, you can use the same placeholders as in the email body (in each subject line the respective placeholders for the matching email). The default From: address for both notification mails is: noreply@hostname_of_lui_instance If you want to override this with your own From: address, then you can do this in the lui.ini, with the following entry (applies to both emails): UserNotificationMailFromAddress=YOUR_FROM_ADDRESS LISTSERV Maestro Admin Tech Doc 21 3 User Name and Password Recovery
4 Template Examples 4.1 Example for usernamemail.txt Dear LISTSERV Maestro User! ----------------------------------------------------- Account Information The following user accounts are registered in LISTSERV Maestro for your address {1}: {0} If someone else supplied the address {1} on our "forgot my username" page without your knowledge, then simply ignore this message. Your account information has not been shown anywhere else other than in this message. LISTSERV Maestro Login: <http://todo_your_hostname_here/lui> ----------------------------------------------------- (Note: This email has been generated automatically. Do not reply!) 4.2 Example for usernamemail.html <html> <body style="margin:20px; font-family:verdana, Arial, Helvetica, sans-serif; background-color:#fff;"> <div style="padding:10px; width:700px; margin:auto; background:#3366cc; color:#fff; font-weight:bold; font-size:12pt; text-align:center;"> Dear LISTSERV Maestro User! <div style="padding:20px; width:700px; margin:auto; color:#000; font-size:9pt;"> <div style="font-weight:bold; font-size:12pt;"> Account Information <div style="padding-top:20px;"> The following user accounts are registered in LISTSERV Maestro for your address <span style="font-weight:bold;">{1}</span>: <div style="padding-top:10px; font-weight:bold;">{0} <div style="padding-top:10px;"> If someone else supplied the address {1} on our "forgot my username" page without your knowledge, then simply ignore this message. Your account information has not been shown anywhere else other than in this message. <div style="padding-top:40px;"> <span style="font-size:8pt;">(note: This email has been generated automatically. Do not reply!)</span> <a href="http://todo_your_hostname_here/lui" style="float:right; color:#3366cc;">listserv Maestro Login</a> </body> </html> LISTSERV Maestro Admin Tech Doc 21 4 User Name and Password Recovery
4.3 Example for passwordconfirmmail.txt Dear LISTSERV Maestro User! ----------------------------------------------------- Password Confirmation We have received a request to change the LISTSERV Maestro login password of the account "{0}". If you have submitted this request, please confirm it by clicking on the link below: <{2}> (Or copy & paste this URL into the address field of your browser.) If you have not submitted this request, or do not wish to change your LISTSERV Maestro password, simply do nothing. Your password will not be changed unless you click the link above. ----------------------------------------------------- (Note: This email has been generated automatically. Do not reply!) 4.4 Example for passwordconfirmmail.html <html> <body style="margin:20px; font-family:verdana, Arial, Helvetica, sans-serif; background-color:#fff;"> <div style="padding:10px; width:700px; margin:auto; background:#3366cc; color:#fff; font-weight:bold; font-size:12pt; text-align:center;"> Dear LISTSERV Maestro User! <div style="padding:20px; width:700px; margin:auto; color:#000; font-size:9pt;"> <div style="font-weight:bold; font-size:12pt;"> Password Confirmation <div style="padding-top:20px; font-weight:bold;"> We have received a request to change the LISTSERV Maestro login password of the account "{0}". <div style="padding-top:10px;"> If you have submitted this request, please confirm it by clicking on the link below: <div style="padding-top:10px; font-weight:bold; text-align:center;"> <a href="{2}" style="color: #3366CC;">{2}</a> <div style="padding-top:10px;"> If you have not submitted this request, or do not wish to change your LISTSERV Maestro password, simply do nothing. Your password will not be changed unless you click the link above. <div style="padding-top:40px; font-size:8pt;"> (Note: This email has been generated automatically. Do not reply!) </body> </html> LISTSERV Maestro Admin Tech Doc 21 5 User Name and Password Recovery