Annotation of loncom/interface/resetpw.pm, revision 1.30
1.1 raeburn 1: # The LearningOnline Network
2: # Allow access to password changing via a token sent to user's e-mail.
3: #
1.30 ! raeburn 4: # $Id: resetpw.pm,v 1.29 2013/02/01 17:39:22 bisitz 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');
1.27 raeburn 69: my $origmail = $r->dir_config('lonSupportEMail');
1.1 raeburn 70: my $server = $r->dir_config('lonHostID');
1.19 raeburn 71: my $defdom = &Apache::lonnet::default_login_domain();
1.27 raeburn 72: my $contacts =
73: &Apache::loncommon::build_recipient_list(undef,'helpdeskmail',
74: $defdom,$origmail);
75: my ($contact_email) = split(',',$contacts);
1.26 raeburn 76: my $handle = &Apache::lonnet::check_for_valid_session($r);
77: my $lonidsdir=$r->dir_config('lonIDsDir');
78: if ($handle ne '') {
79: if ($handle=~/^publicuser\_/) {
80: unlink($r->dir_config('lonIDsDir')."/$handle.id");
81: } else {
82: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle);
83: }
84: }
1.1 raeburn 85: &Apache::lonacc::get_posted_cgi($r);
86: &Apache::lonlocal::get_language_handle($r);
87: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['token']);
88:
89: my @emailtypes = ('permanentemail','critnotification','notification');
1.2 albertel 90: my $uname = &unescape($env{'form.uname'});
1.1 raeburn 91: my $udom = $env{'form.udom'};
92: my $token = $env{'form.token'};
1.26 raeburn 93: my $brcrum = [];
94: my $bread_crumbs_component = 'Forgotten Password';
95: if ($token) {
96: push (@{$brcrum},
97: {href => '/adm/resetpw',
98: text => 'Update Password'});
99:
100: $bread_crumbs_component = 'Reset Password';
101: } else {
102: push (@{$brcrum},
103: {href => '/adm/resetpw',
104: text => 'Account Information'});
105: if ($uname && $udom) {
106: push (@{$brcrum},
107: {href => '/adm/resetpw',
108: text => 'Result'});
109: }
110: }
111: my $args = {bread_crumbs => $brcrum,
112: bread_crumbs_component => $bread_crumbs_component};
113: $r->print(&Apache::loncommon::start_page('Reset password','',$args));
1.11 bisitz 114: $r->print('<h3>'.&mt('Reset forgotten LON-CAPA password').'</h3>');
1.1 raeburn 115: my $output;
116: if ($token) {
117: $output = &reset_passwd($r,$token,$contact_name,$contact_email);
118: } elsif ($uname && $udom) {
1.6 albertel 119: my $domdesc = &Apache::lonnet::domain($udom,'description');
1.1 raeburn 120: my $authtype = &Apache::lonnet::queryauthenticate($uname,$udom);
121: if ($authtype =~ /^internal/) {
1.3 raeburn 122: my $useremail = $env{'form.useremail'};
123: if ($useremail !~ /^[^\@]+\@[^\@]+\.[^\@\.]+$/) {
124: $output = &invalid_state('baduseremail',$domdesc,
125: $contact_name,$contact_email);
126: } else {
127: my %userinfo =
1.4 albertel 128: &Apache::lonnet::get('environment',\@emailtypes,
129: $udom,$uname);
1.18 raeburn 130: my @allemails;
1.3 raeburn 131: foreach my $type (@emailtypes) {
1.18 raeburn 132: my $email = $userinfo{$type};
133: my @items;
134: if ($email =~ /,/) {
135: @items = split(',',$userinfo{$type});
136: } else {
137: @items = ($email);
138: }
139: foreach my $item (@items) {
140: if ($item =~ /^[^\@]+\@[^\@]+\.[^\@\.]+$/) {
141: unless(grep(/^\Q$item\E$/,@allemails)) {
142: push(@allemails,$item);
143: }
144: }
1.3 raeburn 145: }
146: }
1.18 raeburn 147: if (@allemails > 0) {
148: if (grep(/^\Q$useremail\E$/,@allemails)) {
149: $output = &send_token($uname,$udom,$useremail,$server,
1.3 raeburn 150: $domdesc,$contact_name,
151: $contact_email);
152: } else {
153: $output = &invalid_state('mismatch',$domdesc,
154: $contact_name,
155: $contact_email);
156: }
157: } else {
158: $output = &invalid_state('missing',$domdesc,
159: $contact_name,$contact_email);
1.1 raeburn 160: }
161: }
162: } elsif ($authtype =~ /^(krb|unix|local)/) {
163: $output = &invalid_state('authentication',$domdesc,
164: $contact_name,$contact_email);
165: } else {
166: $output = &invalid_state('invalid',$domdesc,
167: $contact_name,$contact_email);
168: }
169: } else {
170: $output = &get_uname($defdom);
171: }
172: $r->print($output);
173: $r->print(&Apache::loncommon::end_page());
174: return OK;
175: }
176:
177: sub get_uname {
178: my ($defdom) = @_;
179: my %lt = &Apache::lonlocal::texthash(
180: unam => 'username',
181: udom => 'domain',
1.12 schafran 182: uemail => 'E-mail address in LON-CAPA',
1.1 raeburn 183: proc => 'Proceed');
184:
1.23 bisitz 185: 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 186: $msg .= '<br /><br />'.&mt('Three conditions must be met:')
187: .'<ul><li>'.&mt('An e-mail address must have previously been associated with your LON-CAPA username.').'</li>'
188: .'<li>'.&mt('You must be able to access e-mail sent to that address.').'</li>'
189: .'<li>'.&mt('Your LON-CAPA account must be of a type for which LON-CAPA can reset a password.')
190: .'</ul>';
1.26 raeburn 191: $msg .= '<form name="forgotpw" method="post" action="/adm/resetpw">'.
192: &Apache::lonhtmlcommon::start_pick_box().
193: &Apache::lonhtmlcommon::row_title('LON-CAPA '.$lt{'unam'}).
194: '<input type="text" name="uname" size="20" />'.
195: &Apache::lonhtmlcommon::row_closure(1).
196: &Apache::lonhtmlcommon::row_title('LON-CAPA '.$lt{'udom'}).
197: &Apache::loncommon::select_dom_form($defdom,'udom').
198: &Apache::lonhtmlcommon::row_closure(1).
199: &Apache::lonhtmlcommon::row_title($lt{'uemail'}).
200: '<input type="text" name="useremail" size="30" />'.
201: &Apache::lonhtmlcommon::end_pick_box().
202: '<br /><br /><input type="submit" name="resetter" value="'.$lt{'proc'}.'" /></form>';
1.1 raeburn 203: return $msg;
204: }
205:
206: sub send_token {
207: my ($uname,$udom,$email,$server,$domdesc,$contact_name,
208: $contact_email) = @_;
1.29 bisitz 209: my $msg =
210: '<p class="LC_info">'
211: .&mt('Thank you for your request to reset the password for your LON-CAPA account.')
212: .'</p>';
1.1 raeburn 213:
214: my $now = time;
215: my $temppasswd = &create_passwd();
1.2 albertel 216: my %info = ('ip' => $ENV{'REMOTE_ADDR'},
217: 'time' => $now,
218: 'domain' => $udom,
219: 'username' => $uname,
220: 'email' => $email,
221: 'temppasswd' => $temppasswd);
1.1 raeburn 222:
1.3 raeburn 223: my $token = &Apache::lonnet::tmpput(\%info,$server,'resetpw');
224: if ($token !~ /^error/ && $token ne 'no_such_host') {
1.2 albertel 225: my $esc_token = &escape($token);
1.15 raeburn 226: my $showtime = &Apache::lonlocal::locallocaltime(time);
227: my $reseturl = &Apache::lonnet::absolute_url().'/adm/resetpw?token='.$esc_token;
1.26 raeburn 228: my $mailmsg = &mt('A request was submitted on [_1] for reset of the password for your LON-CAPA account.',$showtime)." \n".&mt('To complete this process please open a web browser and enter the following URL in the address/location box: [_1]',"\n\n".$reseturl);
1.1 raeburn 229: my $result = &send_mail($domdesc,$email,$mailmsg,$contact_name,
230: $contact_email);
231: if ($result eq 'ok') {
1.13 schafran 232: $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 233: } else {
1.28 bisitz 234: $msg .=
1.29 bisitz 235: '<p class="LC_error">'
236: .&mt('An error occurred when sending a message to the e-mail address'
237: .' associated with your LON-CAPA account.')
238: .'</p>'
239: .&display_actions($contact_email,$domdesc);
240:
1.1 raeburn 241: }
242: } else {
1.28 bisitz 243: $msg .=
1.29 bisitz 244: '<p class="LC_error">'
245: .&mt('An error occurred creating a token required for the'
246: .' password reset process.')
247: .'</p>'
248: .&display_actions($contact_email,$domdesc);
1.1 raeburn 249: }
250: return $msg;
251: }
252:
253: sub send_mail {
254: my ($domdesc,$email,$mailmsg,$contact_name,$contact_email) = @_;
255: my $outcome;
256: my $requestmail = "To: $email\n".
257: "From: $contact_name <$contact_email>\n".
258: "Subject: ".&mt('Your LON-CAPA account')."\n".
1.25 bisitz 259: "Content-type: text/plain\;charset=UTF-8\n".
1.1 raeburn 260: "\n\n".$mailmsg."\n\n".
261: &mt('[_1] LON-CAPA support team',$domdesc)."\n".
262: "$contact_email\n";
263: if (open(MAIL, "|/usr/lib/sendmail -oi -t -odb")) {
264: print MAIL $requestmail;
265: close(MAIL);
266: $outcome = 'ok';
267: } else {
268: $outcome = 'fail';
269: }
270: return $outcome;
271: }
272:
273: sub invalid_state {
274: my ($error,$domdesc,$contact_name,$contact_email) = @_;
275: my $msg;
276: if ($error eq 'invalid') {
1.29 bisitz 277: $msg =
278: '<p class="LC_warning">'
279: .&mt('The username you provided was not verified as a valid username'
280: .' in the LON-CAPA system for the [_1] domain.','<i>'.$domdesc.'</i>')
281: .'</p>';
282: $msg .= &display_actions($contact_email,$domdesc);
1.1 raeburn 283: } else {
1.3 raeburn 284: if ($error eq 'baduseremail') {
285: $msg = &mt('The e-mail address you provided does not appear to be a valid address.');
286: } elsif ($error eq 'mismatch') {
287: $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.');
288: } elsif ($error eq 'missing') {
1.1 raeburn 289: $msg = &mt('A valid e-mail address was not located in the LON-CAPA system for the username and domain you provided.');
290: } elsif ($error eq 'authentication') {
291: $msg = &mt('The username you provided uses an authentication type which can not be reset directly via LON-CAPA.');
292: }
1.29 bisitz 293: $msg = '<p class="LC_warning">'.$msg.'</p>'
294: .&display_actions($contact_email,$domdesc);
1.1 raeburn 295: }
296: return $msg;
297: }
298:
299: sub reset_passwd {
300: my ($r,$token,$contact_name,$contact_email) = @_;
301: my $msg;
302: my %data = &Apache::lonnet::tmpget($token);
303: my $now = time;
304: if (keys(%data) == 0) {
1.17 bisitz 305: $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.'
306: ,'<a href="/adm/resetpw">','</a>');
1.1 raeburn 307: return $msg;
308: }
309: if (($data{'time'} =~ /^\d+$/) &&
310: ($data{'username'} ne '') &&
311: ($data{'domain'} ne '') &&
1.3 raeburn 312: ($data{'email'} =~ /^[^\@]+\@[^\@]+\.[^\@\.]+$/) &&
1.1 raeburn 313: ($data{'temppasswd'} =~/^\w+$/)) {
1.9 raeburn 314: my $reqtime = &Apache::lonlocal::locallocaltime($data{'time'});
1.1 raeburn 315: if ($now - $data{'time'} < 7200) {
316: if ($env{'form.action'} eq 'verify_and_change_pass') {
1.22 raeburn 317: unless (($env{'form.uname'} eq $data{'username'}) && ($env{'form.udom'} eq $data{'domain'}) && ($env{'form.email'} eq $data{'email'})) {
318: $msg = &generic_failure_msg($contact_name,$contact_email);
319: return $msg;
320: }
1.1 raeburn 321: my $change_failed =
1.2 albertel 322: &Apache::lonpreferences::verify_and_change_password($r,'reset_by_email',$token);
1.1 raeburn 323: if (!$change_failed) {
324: my $delete = &Apache::lonnet::tmpdel($token);
1.9 raeburn 325: my $now = &Apache::lonlocal::locallocaltime(time);
1.1 raeburn 326: my $domdesc =
1.6 albertel 327: &Apache::lonnet::domain($data{'domain'},'description');
1.1 raeburn 328: 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";
329: my $result = &send_mail($domdesc,$data{'email'},$mailmsg,
330: $contact_name,$contact_email);
331: if ($result eq 'ok') {
1.28 bisitz 332: $msg .=
333: '<p class="LC_success">'
334: .&mt('An e-mail confirming setting of the password'
335: .' for your LON-CAPA account has been sent to [_1].'
336: ,$data{'email'})
337: .'</p>';
1.1 raeburn 338: } else {
1.28 bisitz 339: $msg .=
340: '<p class="LC_error">'
341: .&mt('An error occurred when sending e-mail to [_1]'
342: .' confirming setting of your new password.'
343: ,$data{'email'})
344: .'</p>';
1.1 raeburn 345: }
1.28 bisitz 346: $msg .= '<br />'
1.17 bisitz 347: .'<a href="/adm/login">'.&mt('Go to the login page').'</a>.';
1.20 raeburn 348: } elsif ($change_failed eq 'invalid_client') {
349: my $homeserver = &Apache::lonnet::homeserver($data{'username'},$data{'domain'});
350: if ($homeserver eq 'no_host') {
351: $msg .= &generic_failure_msg($contact_name,$contact_email);
352: } else {
353: my $protocol = $Apache::lonnet::protocol{$homeserver};
354: $protocol = 'http' if ($protocol ne 'https');
355: my $url = $protocol.'://'.&Apache::lonnet::hostname($homeserver).
356: '/adm/resetpw';
357: my ($opentag,$closetag);
358: if ($url) {
359: $opentag = '<a href="'.$url.'">';
360: $closetag = '</a>';
361: }
1.28 bisitz 362: $msg .=
363: '<p class="LC_warning">'
364: .&mt('A problem occurred when attempting to reset'
365: .' the password for your account.'
366: .' Please try again from your [_1]home server[_2].'
367: ,$opentag,$closetag)
368: .'</p>';
1.20 raeburn 369: }
1.1 raeburn 370: } else {
1.20 raeburn 371: $msg .= &generic_failure_msg($contact_name,$contact_email);
1.1 raeburn 372: }
373: } else {
1.13 schafran 374: $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 375: $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 />');
376: &Apache::lonpreferences::passwordchanger($r,'','reset_by_email',$token);
377: }
378: } else {
1.28 bisitz 379: $msg =
380: '<p class="LC_warning">'
381: .&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.'
382: ,'<a href="/adm/resetpw">','</a>')
383: .'</p>';
1.1 raeburn 384: }
385: } else {
1.28 bisitz 386: $msg .=
387: '<p class="LC_warning">'
388: .&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.'
389: ,'<a href="/adm/resetpw">','</a>')
390: .'</p>';
1.1 raeburn 391: }
392: return $msg;
393: }
394:
1.20 raeburn 395: sub generic_failure_msg {
396: my ($contact_name,$contact_email) = @_;
1.28 bisitz 397: return
1.29 bisitz 398: '<p class="LC_error">'
399: .&mt('A problem occurred when attempting to reset the password for your account.')
400: .'<br />'
401: .&mt('Please contact the [_1] - ([_2]) for assistance.',
1.28 bisitz 402: $contact_name,'<a href="mailto:'.$contact_email.'">'.$contact_email.'</a>')
403: .'</p>';
1.20 raeburn 404: }
405:
1.1 raeburn 406: sub create_passwd {
407: my $passwd = '';
1.2 albertel 408: my @letts = ("a".."z");
1.1 raeburn 409: for (my $i=0; $i<8; $i++) {
1.2 albertel 410: my $lettnum = int(rand(2));
1.1 raeburn 411: my $item = '';
412: if ($lettnum) {
1.2 albertel 413: $item = $letts[int(rand(26))];
414: my $uppercase = int(rand(2));
1.1 raeburn 415: if ($uppercase) {
416: $item =~ tr/a-z/A-Z/;
417: }
418: } else {
1.2 albertel 419: $item = int(rand(10));
1.1 raeburn 420: }
421: $passwd .= $item;
422: }
423: return ($passwd);
424: }
425:
1.29 bisitz 426: sub display_actions {
427: my ($contact_email, $domdesc) = @_;
428: my @msg = (&mt('[_1]Go back[_2] and try again',
429: '<a href="javascript:history.go(-1)">','</a>'));
430: my $msg2 = '';
431: if ($contact_email ne '') {
1.30 ! raeburn 432: my $escuri = &HTML::Entities::encode('/adm/resetpw','&<>"');
! 433: push(@msg, &mt('Contact the [_1]LON-CAPA helpdesk[_2] for the institution: [_3]',
! 434: '<a href="/adm/helpdesk?origurl='.$escuri.'">',
! 435: '</a>','<i>'.$domdesc.'</i>'));
! 436: } else {
! 437: $msg2 =
! 438: '<p>'
! 439: .&mt('You may wish to send an e-mail to the'
! 440: .' server administrator: [_1] for the [_2] domain.',
! 441: '<i>'.$Apache::lonnet::perlvar{'AdminEmail'}.'</i>',
! 442: '<i>'.$domdesc.'</i>')
! 443: .'</p>';
! 444: }
1.29 bisitz 445:
446: return &Apache::lonhtmlcommon::actionbox(\@msg).$msg2;
447:
448: }
449:
1.1 raeburn 450: 1;
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>