Annotation of loncom/interface/resetpw.pm, revision 1.34
1.1 raeburn 1: # The LearningOnline Network
2: # Allow access to password changing via a token sent to user's e-mail.
3: #
1.34 ! bisitz 4: # $Id: resetpw.pm,v 1.33 2013/07/19 16:17:07 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: if ($token) {
95: push (@{$brcrum},
96: {href => '/adm/resetpw',
97: text => 'Update Password'});
98: } else {
99: push (@{$brcrum},
100: {href => '/adm/resetpw',
101: text => 'Account Information'});
102: if ($uname && $udom) {
103: push (@{$brcrum},
104: {href => '/adm/resetpw',
105: text => 'Result'});
106: }
107: }
1.33 bisitz 108: my $args = {bread_crumbs => $brcrum};
1.26 raeburn 109: $r->print(&Apache::loncommon::start_page('Reset password','',$args));
1.33 bisitz 110: $r->print('<h2>'.&mt('Reset forgotten LON-CAPA password').'</h2>');
1.1 raeburn 111: my $output;
112: if ($token) {
113: $output = &reset_passwd($r,$token,$contact_name,$contact_email);
114: } elsif ($uname && $udom) {
1.6 albertel 115: my $domdesc = &Apache::lonnet::domain($udom,'description');
1.1 raeburn 116: my $authtype = &Apache::lonnet::queryauthenticate($uname,$udom);
117: if ($authtype =~ /^internal/) {
1.3 raeburn 118: my $useremail = $env{'form.useremail'};
119: if ($useremail !~ /^[^\@]+\@[^\@]+\.[^\@\.]+$/) {
120: $output = &invalid_state('baduseremail',$domdesc,
121: $contact_name,$contact_email);
122: } else {
123: my %userinfo =
1.4 albertel 124: &Apache::lonnet::get('environment',\@emailtypes,
125: $udom,$uname);
1.18 raeburn 126: my @allemails;
1.3 raeburn 127: foreach my $type (@emailtypes) {
1.18 raeburn 128: my $email = $userinfo{$type};
129: my @items;
130: if ($email =~ /,/) {
131: @items = split(',',$userinfo{$type});
132: } else {
133: @items = ($email);
134: }
135: foreach my $item (@items) {
136: if ($item =~ /^[^\@]+\@[^\@]+\.[^\@\.]+$/) {
137: unless(grep(/^\Q$item\E$/,@allemails)) {
138: push(@allemails,$item);
139: }
140: }
1.3 raeburn 141: }
142: }
1.18 raeburn 143: if (@allemails > 0) {
144: if (grep(/^\Q$useremail\E$/,@allemails)) {
145: $output = &send_token($uname,$udom,$useremail,$server,
1.3 raeburn 146: $domdesc,$contact_name,
147: $contact_email);
148: } else {
149: $output = &invalid_state('mismatch',$domdesc,
150: $contact_name,
151: $contact_email);
152: }
153: } else {
154: $output = &invalid_state('missing',$domdesc,
155: $contact_name,$contact_email);
1.1 raeburn 156: }
157: }
158: } elsif ($authtype =~ /^(krb|unix|local)/) {
159: $output = &invalid_state('authentication',$domdesc,
160: $contact_name,$contact_email);
161: } else {
162: $output = &invalid_state('invalid',$domdesc,
163: $contact_name,$contact_email);
164: }
165: } else {
166: $output = &get_uname($defdom);
167: }
168: $r->print($output);
169: $r->print(&Apache::loncommon::end_page());
170: return OK;
171: }
172:
173: sub get_uname {
174: my ($defdom) = @_;
175: my %lt = &Apache::lonlocal::texthash(
1.32 bisitz 176: unam => 'LON-CAPA username',
177: udom => 'LON-CAPA domain',
1.12 schafran 178: uemail => 'E-mail address in LON-CAPA',
1.1 raeburn 179: proc => 'Proceed');
180:
1.23 bisitz 181: 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 182: $msg .= '<br /><br />'.&mt('Three conditions must be met:')
183: .'<ul><li>'.&mt('An e-mail address must have previously been associated with your LON-CAPA username.').'</li>'
184: .'<li>'.&mt('You must be able to access e-mail sent to that address.').'</li>'
185: .'<li>'.&mt('Your LON-CAPA account must be of a type for which LON-CAPA can reset a password.')
186: .'</ul>';
1.26 raeburn 187: $msg .= '<form name="forgotpw" method="post" action="/adm/resetpw">'.
188: &Apache::lonhtmlcommon::start_pick_box().
1.32 bisitz 189: &Apache::lonhtmlcommon::row_title($lt{'unam'}).
1.26 raeburn 190: '<input type="text" name="uname" size="20" />'.
191: &Apache::lonhtmlcommon::row_closure(1).
1.32 bisitz 192: &Apache::lonhtmlcommon::row_title($lt{'udom'}).
1.26 raeburn 193: &Apache::loncommon::select_dom_form($defdom,'udom').
194: &Apache::lonhtmlcommon::row_closure(1).
195: &Apache::lonhtmlcommon::row_title($lt{'uemail'}).
196: '<input type="text" name="useremail" size="30" />'.
197: &Apache::lonhtmlcommon::end_pick_box().
198: '<br /><br /><input type="submit" name="resetter" value="'.$lt{'proc'}.'" /></form>';
1.1 raeburn 199: return $msg;
200: }
201:
202: sub send_token {
203: my ($uname,$udom,$email,$server,$domdesc,$contact_name,
204: $contact_email) = @_;
1.29 bisitz 205: my $msg =
206: '<p class="LC_info">'
207: .&mt('Thank you for your request to reset the password for your LON-CAPA account.')
208: .'</p>';
1.1 raeburn 209:
210: my $now = time;
211: my $temppasswd = &create_passwd();
1.2 albertel 212: my %info = ('ip' => $ENV{'REMOTE_ADDR'},
213: 'time' => $now,
214: 'domain' => $udom,
215: 'username' => $uname,
216: 'email' => $email,
217: 'temppasswd' => $temppasswd);
1.1 raeburn 218:
1.3 raeburn 219: my $token = &Apache::lonnet::tmpput(\%info,$server,'resetpw');
220: if ($token !~ /^error/ && $token ne 'no_such_host') {
1.2 albertel 221: my $esc_token = &escape($token);
1.15 raeburn 222: my $showtime = &Apache::lonlocal::locallocaltime(time);
223: my $reseturl = &Apache::lonnet::absolute_url().'/adm/resetpw?token='.$esc_token;
1.26 raeburn 224: 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 225: my $result = &send_mail($domdesc,$email,$mailmsg,$contact_name,
226: $contact_email);
227: if ($result eq 'ok') {
1.34 ! bisitz 228: $msg .=
! 229: &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.')
! 230: .'<br /><br />'
! 231: .&mt('The link included in the message will be valid for the next [_1]two[_2] hours.','<b>','</b>');
1.1 raeburn 232: } else {
1.28 bisitz 233: $msg .=
1.29 bisitz 234: '<p class="LC_error">'
235: .&mt('An error occurred when sending a message to the e-mail address'
236: .' associated with your LON-CAPA account.')
237: .'</p>'
238: .&display_actions($contact_email,$domdesc);
239:
1.1 raeburn 240: }
241: } else {
1.28 bisitz 242: $msg .=
1.29 bisitz 243: '<p class="LC_error">'
244: .&mt('An error occurred creating a token required for the'
245: .' password reset process.')
246: .'</p>'
247: .&display_actions($contact_email,$domdesc);
1.1 raeburn 248: }
249: return $msg;
250: }
251:
252: sub send_mail {
253: my ($domdesc,$email,$mailmsg,$contact_name,$contact_email) = @_;
254: my $outcome;
255: my $requestmail = "To: $email\n".
256: "From: $contact_name <$contact_email>\n".
257: "Subject: ".&mt('Your LON-CAPA account')."\n".
1.25 bisitz 258: "Content-type: text/plain\;charset=UTF-8\n".
1.1 raeburn 259: "\n\n".$mailmsg."\n\n".
260: &mt('[_1] LON-CAPA support team',$domdesc)."\n".
261: "$contact_email\n";
262: if (open(MAIL, "|/usr/lib/sendmail -oi -t -odb")) {
263: print MAIL $requestmail;
264: close(MAIL);
265: $outcome = 'ok';
266: } else {
267: $outcome = 'fail';
268: }
269: return $outcome;
270: }
271:
272: sub invalid_state {
273: my ($error,$domdesc,$contact_name,$contact_email) = @_;
274: my $msg;
275: if ($error eq 'invalid') {
1.29 bisitz 276: $msg =
277: '<p class="LC_warning">'
278: .&mt('The username you provided was not verified as a valid username'
279: .' in the LON-CAPA system for the [_1] domain.','<i>'.$domdesc.'</i>')
280: .'</p>';
281: $msg .= &display_actions($contact_email,$domdesc);
1.1 raeburn 282: } else {
1.3 raeburn 283: if ($error eq 'baduseremail') {
284: $msg = &mt('The e-mail address you provided does not appear to be a valid address.');
285: } elsif ($error eq 'mismatch') {
286: $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.');
287: } elsif ($error eq 'missing') {
1.1 raeburn 288: $msg = &mt('A valid e-mail address was not located in the LON-CAPA system for the username and domain you provided.');
289: } elsif ($error eq 'authentication') {
290: $msg = &mt('The username you provided uses an authentication type which can not be reset directly via LON-CAPA.');
291: }
1.29 bisitz 292: $msg = '<p class="LC_warning">'.$msg.'</p>'
293: .&display_actions($contact_email,$domdesc);
1.1 raeburn 294: }
295: return $msg;
296: }
297:
298: sub reset_passwd {
299: my ($r,$token,$contact_name,$contact_email) = @_;
300: my $msg;
301: my %data = &Apache::lonnet::tmpget($token);
302: my $now = time;
303: if (keys(%data) == 0) {
1.17 bisitz 304: $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.'
305: ,'<a href="/adm/resetpw">','</a>');
1.1 raeburn 306: return $msg;
307: }
308: if (($data{'time'} =~ /^\d+$/) &&
309: ($data{'username'} ne '') &&
310: ($data{'domain'} ne '') &&
1.3 raeburn 311: ($data{'email'} =~ /^[^\@]+\@[^\@]+\.[^\@\.]+$/) &&
1.1 raeburn 312: ($data{'temppasswd'} =~/^\w+$/)) {
1.9 raeburn 313: my $reqtime = &Apache::lonlocal::locallocaltime($data{'time'});
1.1 raeburn 314: if ($now - $data{'time'} < 7200) {
315: if ($env{'form.action'} eq 'verify_and_change_pass') {
1.22 raeburn 316: unless (($env{'form.uname'} eq $data{'username'}) && ($env{'form.udom'} eq $data{'domain'}) && ($env{'form.email'} eq $data{'email'})) {
317: $msg = &generic_failure_msg($contact_name,$contact_email);
318: return $msg;
319: }
1.1 raeburn 320: my $change_failed =
1.2 albertel 321: &Apache::lonpreferences::verify_and_change_password($r,'reset_by_email',$token);
1.1 raeburn 322: if (!$change_failed) {
323: my $delete = &Apache::lonnet::tmpdel($token);
1.9 raeburn 324: my $now = &Apache::lonlocal::locallocaltime(time);
1.1 raeburn 325: my $domdesc =
1.6 albertel 326: &Apache::lonnet::domain($data{'domain'},'description');
1.1 raeburn 327: 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";
328: my $result = &send_mail($domdesc,$data{'email'},$mailmsg,
329: $contact_name,$contact_email);
1.33 bisitz 330: my $confirm_msg;
1.1 raeburn 331: if ($result eq 'ok') {
1.33 bisitz 332: $confirm_msg =
333: &Apache::lonhtmlcommon::confirm_success(
334: &mt('An e-mail confirming setting of the password'
335: .' for your LON-CAPA account has been sent to [_1].'
336: ,'<span class="LC_filename">'.$data{'email'}.'</span>'));
1.1 raeburn 337: } else {
1.33 bisitz 338: $confirm_msg =
339: &Apache::lonhtmlcommon::confirm_success(
340: &mt('An error occurred when sending e-mail to [_1]'
341: .' confirming setting of your new password.'
342: ,'<span class="LC_filename">'.$data{'email'}.'</span>'),1);
1.1 raeburn 343: }
1.33 bisitz 344: $msg .=
345: &Apache::loncommon::confirmwrapper($confirm_msg)
346: .&Apache::lonhtmlcommon::actionbox([
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.',
1.31 raeburn 441: '<i>'.$Apache::lonnet::perlvar{'AdmEMail'}.'</i>',
1.30 raeburn 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>