Annotation of loncom/interface/resetpw.pm, revision 1.25
1.1 raeburn 1: # The LearningOnline Network
2: # Allow access to password changing via a token sent to user's e-mail.
3: #
1.25 ! bisitz 4: # $Id: resetpw.pm,v 1.24 2010/03/22 20:11:22 droeschl Exp $
1.14 bisitz 5: #
1.1 raeburn 6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
28: #
1.21 raeburn 29:
30: =pod
31:
32: =head1 NAME
33:
1.22 raeburn 34: Apache::resetpw: reset user password.
1.21 raeburn 35:
36: =head1 SYNOPSIS
37:
38: Handles resetting of forgotten passwords.
39:
40: This is part of the LearningOnline Network with CAPA project
41: described at http://www.lon-capa.org.
42:
43: =head1 OVERVIEW
44:
45: A user with an e-mail address associated with his/her LON-CAPA username
1.22 raeburn 46: can reset a forgotten password, using a link sent to the e-mail address
1.21 raeburn 47: if the authentication type for the account is "internal".
48:
49: =cut
50:
1.1 raeburn 51: package Apache::resetpw;
52:
53: use strict;
54: use Apache::Constants qw(:common);
55: use Apache::lonacc;
56: use Apache::lonnet;
57: use Apache::loncommon;
58: use Apache::lonlocal;
59: use LONCAPA;
60:
61: sub handler {
62: my $r = shift;
63: &Apache::loncommon::content_type($r,'text/html');
64: $r->send_http_header;
65: if ($r->header_only) {
66: return OK;
67: }
68: my $contact_name = &mt('LON-CAPA helpdesk');
69: my $contact_email = $r->dir_config('lonSupportEMail');
70: my $server = $r->dir_config('lonHostID');
1.19 raeburn 71: my $defdom = &Apache::lonnet::default_login_domain();
1.1 raeburn 72: &Apache::lonacc::get_posted_cgi($r);
73: &Apache::lonlocal::get_language_handle($r);
74: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['token']);
75:
76: my @emailtypes = ('permanentemail','critnotification','notification');
1.2 albertel 77: my $uname = &unescape($env{'form.uname'});
1.1 raeburn 78: my $udom = $env{'form.udom'};
79: my $token = $env{'form.token'};
1.10 raeburn 80: my $start_page =
1.24 droeschl 81: &Apache::loncommon::start_page('Reset password');
1.10 raeburn 82: $r->print($start_page);
1.11 bisitz 83: $r->print('<h3>'.&mt('Reset forgotten LON-CAPA password').'</h3>');
1.1 raeburn 84: my $output;
85: if ($token) {
86: $output = &reset_passwd($r,$token,$contact_name,$contact_email);
87: } elsif ($uname && $udom) {
1.6 albertel 88: my $domdesc = &Apache::lonnet::domain($udom,'description');
1.1 raeburn 89: my $authtype = &Apache::lonnet::queryauthenticate($uname,$udom);
90: if ($authtype =~ /^internal/) {
1.3 raeburn 91: my $useremail = $env{'form.useremail'};
92: if ($useremail !~ /^[^\@]+\@[^\@]+\.[^\@\.]+$/) {
93: $output = &invalid_state('baduseremail',$domdesc,
94: $contact_name,$contact_email);
95: } else {
96: my %userinfo =
1.4 albertel 97: &Apache::lonnet::get('environment',\@emailtypes,
98: $udom,$uname);
1.18 raeburn 99: my @allemails;
1.3 raeburn 100: foreach my $type (@emailtypes) {
1.18 raeburn 101: my $email = $userinfo{$type};
102: my @items;
103: if ($email =~ /,/) {
104: @items = split(',',$userinfo{$type});
105: } else {
106: @items = ($email);
107: }
108: foreach my $item (@items) {
109: if ($item =~ /^[^\@]+\@[^\@]+\.[^\@\.]+$/) {
110: unless(grep(/^\Q$item\E$/,@allemails)) {
111: push(@allemails,$item);
112: }
113: }
1.3 raeburn 114: }
115: }
1.18 raeburn 116: if (@allemails > 0) {
117: if (grep(/^\Q$useremail\E$/,@allemails)) {
118: $output = &send_token($uname,$udom,$useremail,$server,
1.3 raeburn 119: $domdesc,$contact_name,
120: $contact_email);
121: } else {
122: $output = &invalid_state('mismatch',$domdesc,
123: $contact_name,
124: $contact_email);
125: }
126: } else {
127: $output = &invalid_state('missing',$domdesc,
128: $contact_name,$contact_email);
1.1 raeburn 129: }
130: }
131: } elsif ($authtype =~ /^(krb|unix|local)/) {
132: $output = &invalid_state('authentication',$domdesc,
133: $contact_name,$contact_email);
134: } else {
135: $output = &invalid_state('invalid',$domdesc,
136: $contact_name,$contact_email);
137: }
138: } else {
139: $output = &get_uname($defdom);
140: }
141: $r->print($output);
142: $r->print(&Apache::loncommon::end_page());
143: return OK;
144: }
145:
146: sub get_uname {
147: my ($defdom) = @_;
148: my %lt = &Apache::lonlocal::texthash(
149: unam => 'username',
150: udom => 'domain',
1.12 schafran 151: uemail => 'E-mail address in LON-CAPA',
1.1 raeburn 152: proc => 'Proceed');
153:
1.23 bisitz 154: my $msg = &mt('If you use the same account for other campus services besides LON-CAPA, (e.g., e-mail, course registration, etc.), a separate centrally managed mechanism likely exists to reset a password. However, if your account is used for just LON-CAPA access you will probably be able to reset a password from this page.');
1.8 bisitz 155: $msg .= '<br /><br />'.&mt('Three conditions must be met:')
156: .'<ul><li>'.&mt('An e-mail address must have previously been associated with your LON-CAPA username.').'</li>'
157: .'<li>'.&mt('You must be able to access e-mail sent to that address.').'</li>'
158: .'<li>'.&mt('Your LON-CAPA account must be of a type for which LON-CAPA can reset a password.')
159: .'</ul>';
1.1 raeburn 160: $msg .= qq|
161: <form name="forgotpw" method="post">
162: <table>
163: <tr><td>
164: <tr><td align="left">LON-CAPA $lt{'unam'}: </td>
1.16 bisitz 165: <td><input type="text" name="uname" size="15" /></td></tr>
1.1 raeburn 166: <tr><td align="left">LON-CAPA $lt{'udom'}: </td>
167: <td>|;
168: $msg .= &Apache::loncommon::select_dom_form($defdom,'udom');
169: $msg .= qq|</td></tr>
1.3 raeburn 170: <tr><td align="left">$lt{'uemail'}: </td>
1.16 bisitz 171: <td><input type="text" name="useremail" size="30" /></td></tr>
1.1 raeburn 172: <tr><td colspan="2" align="left"><br />
1.16 bisitz 173: <input type="submit" value="$lt{'proc'}" /></td></tr>
1.1 raeburn 174: </table>
1.2 albertel 175: </form>
1.1 raeburn 176: |;
177: return $msg;
178: }
179:
180: sub send_token {
181: my ($uname,$udom,$email,$server,$domdesc,$contact_name,
182: $contact_email) = @_;
1.11 bisitz 183: my $msg = &mt('Thank you for your request to reset the password for your LON-CAPA account.').'<br /><br />';
1.1 raeburn 184:
185: my $now = time;
186: my $temppasswd = &create_passwd();
1.2 albertel 187: my %info = ('ip' => $ENV{'REMOTE_ADDR'},
188: 'time' => $now,
189: 'domain' => $udom,
190: 'username' => $uname,
191: 'email' => $email,
192: 'temppasswd' => $temppasswd);
1.1 raeburn 193:
1.3 raeburn 194: my $token = &Apache::lonnet::tmpput(\%info,$server,'resetpw');
195: if ($token !~ /^error/ && $token ne 'no_such_host') {
1.2 albertel 196: my $esc_token = &escape($token);
1.15 raeburn 197: my $showtime = &Apache::lonlocal::locallocaltime(time);
198: my $reseturl = &Apache::lonnet::absolute_url().'/adm/resetpw?token='.$esc_token;
199: my $mailmsg = &mt('A request was submitted on [_1] for reset of the password for your LON-CAPA account.',$showtime).' '.&mt('To complete this process please open a web browser and enter the following URL in the address/location box: [_1]',$reseturl);
1.1 raeburn 200: my $result = &send_mail($domdesc,$email,$mailmsg,$contact_name,
201: $contact_email);
202: if ($result eq 'ok') {
1.13 schafran 203: $msg .= &mt("An e-mail sent to the e-mail address associated with your LON-CAPA account includes the web address for the link you should use to complete the reset process.<br /><br />The link included in the message will be valid for the next <b>two</b> hours.");
1.1 raeburn 204: } else {
1.7 albertel 205: $msg .= &mt("An error occurred when sending a message to the e-mail address associated with your LON-CAPA account. Please contact the [_1] ([_2]) for assistance.",$contact_name,$contact_email);
1.1 raeburn 206: }
207: } else {
1.4 albertel 208: $msg .= &mt("An error occurred creating a token required for the password reset process. Please contact the [_1] ([_2]) for assistance.",$contact_name,$contact_email);
1.1 raeburn 209: }
210: return $msg;
211: }
212:
213: sub send_mail {
214: my ($domdesc,$email,$mailmsg,$contact_name,$contact_email) = @_;
215: my $outcome;
216: my $requestmail = "To: $email\n".
217: "From: $contact_name <$contact_email>\n".
218: "Subject: ".&mt('Your LON-CAPA account')."\n".
1.25 ! bisitz 219: "Content-type: text/plain\;charset=UTF-8\n".
1.1 raeburn 220: "\n\n".$mailmsg."\n\n".
221: &mt('[_1] LON-CAPA support team',$domdesc)."\n".
222: "$contact_email\n";
223: if (open(MAIL, "|/usr/lib/sendmail -oi -t -odb")) {
224: print MAIL $requestmail;
225: close(MAIL);
226: $outcome = 'ok';
227: } else {
228: $outcome = 'fail';
229: }
230: return $outcome;
231: }
232:
233: sub invalid_state {
234: my ($error,$domdesc,$contact_name,$contact_email) = @_;
235: my $msg;
236: if ($error eq 'invalid') {
1.8 bisitz 237: $msg = &mt('The username you provided was not verified as a valid username in the LON-CAPA system for the [_1] domain.',$domdesc)
238: .' '.&mt('Please [_1]go back[_2] and try again.','<a href="javascript:history.go(-1)"><u>','</u></a>');
1.1 raeburn 239: } else {
1.3 raeburn 240: if ($error eq 'baduseremail') {
241: $msg = &mt('The e-mail address you provided does not appear to be a valid address.');
242: } elsif ($error eq 'mismatch') {
243: $msg = &mt('The e-mail address you provided does not match the address recorded in the LON-CAPA system for the username and domain you provided.');
244: } elsif ($error eq 'missing') {
1.1 raeburn 245: $msg = &mt('A valid e-mail address was not located in the LON-CAPA system for the username and domain you provided.');
246: } elsif ($error eq 'authentication') {
247: $msg = &mt('The username you provided uses an authentication type which can not be reset directly via LON-CAPA.');
248: }
249: if ($contact_email ne '') {
250: my $escuri = &HTML::Entities::encode('/adm/resetpw','&<>"');
1.8 bisitz 251: $msg .= '<br /> '.&mt('You may wish to contact the [_1]LON-CAPA helpdesk[_2] for the [_3] domain.'
252: ,'<a href="/adm/helpdesk?origurl='.$escuri.'">','</a>',$domdesc);
1.1 raeburn 253: } else {
1.8 bisitz 254: $msg .= '<br /> '.&mt('You may wish to send an e-mail to the server administrator: [_1] for the [_2] domain.',$Apache::lonnet::perlvar{'AdminEmail'},$domdesc);
1.1 raeburn 255: }
256: }
257: return $msg;
258: }
259:
260: sub reset_passwd {
261: my ($r,$token,$contact_name,$contact_email) = @_;
262: my $msg;
263: my %data = &Apache::lonnet::tmpget($token);
264: my $now = time;
265: if (keys(%data) == 0) {
1.17 bisitz 266: $msg = &mt('Sorry, the URL you provided to complete the reset of your password was invalid. Either the token included in the URL has been deleted or the URL you provided was invalid. Please submit a [_1]new request[_2] for a password reset, and follow the link to the new URL included in the e-mail that will be sent to you, to allow you to enter a new password.'
267: ,'<a href="/adm/resetpw">','</a>');
1.1 raeburn 268: return $msg;
269: }
270: if (($data{'time'} =~ /^\d+$/) &&
271: ($data{'username'} ne '') &&
272: ($data{'domain'} ne '') &&
1.3 raeburn 273: ($data{'email'} =~ /^[^\@]+\@[^\@]+\.[^\@\.]+$/) &&
1.1 raeburn 274: ($data{'temppasswd'} =~/^\w+$/)) {
1.9 raeburn 275: my $reqtime = &Apache::lonlocal::locallocaltime($data{'time'});
1.1 raeburn 276: if ($now - $data{'time'} < 7200) {
277: if ($env{'form.action'} eq 'verify_and_change_pass') {
1.22 raeburn 278: unless (($env{'form.uname'} eq $data{'username'}) && ($env{'form.udom'} eq $data{'domain'}) && ($env{'form.email'} eq $data{'email'})) {
279: $msg = &generic_failure_msg($contact_name,$contact_email);
280: return $msg;
281: }
1.1 raeburn 282: my $change_failed =
1.2 albertel 283: &Apache::lonpreferences::verify_and_change_password($r,'reset_by_email',$token);
1.1 raeburn 284: if (!$change_failed) {
285: my $delete = &Apache::lonnet::tmpdel($token);
1.9 raeburn 286: my $now = &Apache::lonlocal::locallocaltime(time);
1.1 raeburn 287: my $domdesc =
1.6 albertel 288: &Apache::lonnet::domain($data{'domain'},'description');
1.1 raeburn 289: my $mailmsg = &mt('The password for your LON-CAPA account in the [_1] domain was changed [_2] from IP address: [_3]. If you did not perform this change or authorize it, please contact the [_4] ([_5]).',$domdesc,$now,$ENV{'REMOTE_ADDR'},$contact_name,$contact_email)."\n";
290: my $result = &send_mail($domdesc,$data{'email'},$mailmsg,
291: $contact_name,$contact_email);
292: if ($result eq 'ok') {
293: $msg .= &mt('An e-mail confirming setting of the password for your LON-CAPA account has been sent to [_1].',$data{'email'});
294: } else {
295: $msg .= &mt('An error occurred when sending e-mail to [_1] confirming setting of your new password.',$data{'email'});
296: }
1.17 bisitz 297: $msg .= '<br /><br />'
298: .'<a href="/adm/login">'.&mt('Go to the login page').'</a>.';
1.20 raeburn 299: } elsif ($change_failed eq 'invalid_client') {
300: my $homeserver = &Apache::lonnet::homeserver($data{'username'},$data{'domain'});
301: if ($homeserver eq 'no_host') {
302: $msg .= &generic_failure_msg($contact_name,$contact_email);
303: } else {
304: my $protocol = $Apache::lonnet::protocol{$homeserver};
305: $protocol = 'http' if ($protocol ne 'https');
306: my $url = $protocol.'://'.&Apache::lonnet::hostname($homeserver).
307: '/adm/resetpw';
308: my ($opentag,$closetag);
309: if ($url) {
310: $opentag = '<a href="'.$url.'">';
311: $closetag = '</a>';
312: }
313: $msg .= &mt('A problem occurred when attempting to reset the password for your account. Please try again from your [_1]home server[_2].',$opentag,$closetag);
314: }
1.1 raeburn 315: } else {
1.20 raeburn 316: $msg .= &generic_failure_msg($contact_name,$contact_email);
1.1 raeburn 317: }
318: } else {
1.13 schafran 319: $r->print(&mt('The token included in an e-mail sent to you [_1] has been verified, so you may now proceed to reset the password for your LON-CAPA account.',$reqtime).'<br /><br />');
1.1 raeburn 320: $r->print(&mt('Please enter the username and domain of the LON-CAPA account, and the associated e-mail address, for which you are setting a password. The new password must contain at least 7 characters.').' '.&mt('Your new password will be sent to the LON-CAPA server in an encrypted form.').'<br />');
321: &Apache::lonpreferences::passwordchanger($r,'','reset_by_email',$token);
322: }
323: } else {
1.17 bisitz 324: $msg = &mt('Sorry, the token generated when you requested a password reset has expired. Please submit a [_1]new request[_2], and follow the link to the web page included in the new e-mail that will be sent to you, to allow you to enter a new password.'
325: ,'<a href="/adm/resetpw">','</a>');
1.1 raeburn 326: }
327: } else {
1.17 bisitz 328: $msg .= &mt('Sorry, the URL generated when you requested reset of your password contained incomplete information. Please submit a [_1]new request[_2] for a password reset, and use the new URL that will be sent to your e-mail account to complete the process.'
329: ,'<a href="/adm/resetpw">','</a>');
1.1 raeburn 330: }
331: return $msg;
332: }
333:
1.20 raeburn 334: sub generic_failure_msg {
335: my ($contact_name,$contact_email) = @_;
336: return &mt('A problem occurred when attempting to reset the password for your account. Please contact the [_1] - ([_2]) for assistance.',
337: $contact_name,'<a href="mailto:'.$contact_email.'">'.$contact_email.'</a>');
338: }
339:
1.1 raeburn 340: sub create_passwd {
341: my $passwd = '';
1.2 albertel 342: my @letts = ("a".."z");
1.1 raeburn 343: for (my $i=0; $i<8; $i++) {
1.2 albertel 344: my $lettnum = int(rand(2));
1.1 raeburn 345: my $item = '';
346: if ($lettnum) {
1.2 albertel 347: $item = $letts[int(rand(26))];
348: my $uppercase = int(rand(2));
1.1 raeburn 349: if ($uppercase) {
350: $item =~ tr/a-z/A-Z/;
351: }
352: } else {
1.2 albertel 353: $item = int(rand(10));
1.1 raeburn 354: }
355: $passwd .= $item;
356: }
357: return ($passwd);
358: }
359:
360: 1;
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>