Annotation of loncom/interface/resetpw.pm, revision 1.26

1.1       raeburn     1: # The LearningOnline Network
                      2: # Allow access to password changing via a token sent to user's e-mail. 
                      3: #
1.26    ! raeburn     4: # $Id: resetpw.pm,v 1.25 2010/11/09 16:40:21 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');
                     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.26    ! raeburn    72:     my $handle = &Apache::lonnet::check_for_valid_session($r);
        !            73:     my $lonidsdir=$r->dir_config('lonIDsDir');
        !            74:     if ($handle ne '') {
        !            75:         if ($handle=~/^publicuser\_/) {
        !            76:             unlink($r->dir_config('lonIDsDir')."/$handle.id");
        !            77:         } else {
        !            78:             &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle);
        !            79:         }
        !            80:     }
1.1       raeburn    81:     &Apache::lonacc::get_posted_cgi($r);
                     82:     &Apache::lonlocal::get_language_handle($r);
                     83:     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['token']);
                     84:     
                     85:     my @emailtypes = ('permanentemail','critnotification','notification');
1.2       albertel   86:     my $uname = &unescape($env{'form.uname'});
1.1       raeburn    87:     my $udom = $env{'form.udom'};
                     88:     my $token = $env{'form.token'};
1.26    ! raeburn    89:     my $brcrum = [];
        !            90:     my $bread_crumbs_component = 'Forgotten Password';
        !            91:     if ($token) {
        !            92:         push (@{$brcrum},
        !            93:             {href => '/adm/resetpw',
        !            94:              text => 'Update Password'});
        !            95: 
        !            96:         $bread_crumbs_component = 'Reset Password'; 
        !            97:     } else {
        !            98:         push (@{$brcrum},
        !            99:             {href => '/adm/resetpw',
        !           100:              text => 'Account Information'});
        !           101:         if ($uname && $udom) {
        !           102:             push (@{$brcrum},
        !           103:                 {href => '/adm/resetpw',
        !           104:                  text => 'Result'});
        !           105:         }
        !           106:     }
        !           107:     my $args = {bread_crumbs => $brcrum,
        !           108:                 bread_crumbs_component => $bread_crumbs_component};
        !           109:     $r->print(&Apache::loncommon::start_page('Reset password','',$args));
1.11      bisitz    110:     $r->print('<h3>'.&mt('Reset forgotten LON-CAPA password').'</h3>');
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(
                    176:                                          unam => 'username',
                    177:                                          udom => '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(). 
        !           189:             &Apache::lonhtmlcommon::row_title('LON-CAPA '.$lt{'unam'}).
        !           190:             '<input type="text" name="uname" size="20" />'.
        !           191:             &Apache::lonhtmlcommon::row_closure(1).
        !           192:             &Apache::lonhtmlcommon::row_title('LON-CAPA '.$lt{'udom'}).
        !           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.11      bisitz    205:     my $msg = &mt('Thank you for your request to reset the password for your LON-CAPA account.').'<br /><br />';
1.1       raeburn   206: 
                    207:     my $now = time;
                    208:     my $temppasswd = &create_passwd();
1.2       albertel  209:     my %info = ('ip'         => $ENV{'REMOTE_ADDR'},
                    210: 		'time'       => $now,
                    211: 		'domain'     => $udom,
                    212: 		'username'   => $uname,
                    213: 		'email'      => $email,
                    214: 		'temppasswd' => $temppasswd);
1.1       raeburn   215: 
1.3       raeburn   216:     my $token = &Apache::lonnet::tmpput(\%info,$server,'resetpw');
                    217:     if ($token !~ /^error/ && $token ne 'no_such_host') {
1.2       albertel  218:         my $esc_token = &escape($token);
1.15      raeburn   219:         my $showtime = &Apache::lonlocal::locallocaltime(time);
                    220:         my $reseturl = &Apache::lonnet::absolute_url().'/adm/resetpw?token='.$esc_token;
1.26    ! raeburn   221:         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   222:         my $result = &send_mail($domdesc,$email,$mailmsg,$contact_name,
                    223:                                 $contact_email);
                    224:         if ($result eq 'ok') {
1.13      schafran  225:             $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   226:         } else {
1.7       albertel  227:             $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   228:         }
                    229:     } else {
1.4       albertel  230:         $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   231:     }
                    232:     return $msg;
                    233: }
                    234: 
                    235: sub send_mail {
                    236:     my ($domdesc,$email,$mailmsg,$contact_name,$contact_email) = @_;
                    237:     my $outcome;
                    238:     my $requestmail = "To: $email\n".
                    239:                       "From: $contact_name <$contact_email>\n".
                    240:                       "Subject: ".&mt('Your LON-CAPA account')."\n".
1.25      bisitz    241:                       "Content-type: text/plain\;charset=UTF-8\n".
1.1       raeburn   242:                       "\n\n".$mailmsg."\n\n".
                    243:                       &mt('[_1] LON-CAPA support team',$domdesc)."\n".
                    244:                       "$contact_email\n";
                    245:     if (open(MAIL, "|/usr/lib/sendmail -oi -t -odb")) {
                    246:         print MAIL $requestmail;
                    247:         close(MAIL);
                    248:         $outcome = 'ok';
                    249:     } else {
                    250:         $outcome = 'fail';
                    251:     }
                    252:     return $outcome;
                    253: }
                    254: 
                    255: sub invalid_state {
                    256:     my ($error,$domdesc,$contact_name,$contact_email) = @_;
                    257:     my $msg;
                    258:     if ($error eq 'invalid') {
1.26    ! raeburn   259:         $msg = '<p class="LC_warning">'.&mt('The username you provided was not verified as a valid username in the LON-CAPA system for the [_1] domain.',$domdesc)
        !           260:               .'</p>'.&mt('Please [_1]go back[_2] and try again.','<a href="javascript:history.go(-1)"><u>','</u></a>');
1.1       raeburn   261:     } else {
1.3       raeburn   262:         if ($error eq 'baduseremail') {
                    263:             $msg = &mt('The e-mail address you provided does not appear to be a valid address.');
                    264:         } elsif ($error eq 'mismatch') {
                    265:             $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.');  
                    266:         } elsif ($error eq 'missing') {
1.1       raeburn   267:             $msg = &mt('A valid e-mail address was not located in the LON-CAPA system for the username and domain you provided.');
                    268:         } elsif ($error eq 'authentication') {
                    269:             $msg = &mt('The username you provided uses an authentication type which can not be reset directly via LON-CAPA.');
                    270:         }
1.26    ! raeburn   271:         $msg = '<p class="LC_warning">'.$msg.'</p>';
1.1       raeburn   272:         if ($contact_email ne '') {
                    273:             my $escuri = &HTML::Entities::encode('/adm/resetpw','&<>"');
1.8       bisitz    274:             $msg .= '<br /> '.&mt('You may wish to contact the [_1]LON-CAPA helpdesk[_2] for the [_3] domain.'
                    275:                                  ,'<a href="/adm/helpdesk?origurl='.$escuri.'">','</a>',$domdesc);
1.1       raeburn   276:         } else {
1.8       bisitz    277:             $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   278:         }
                    279:     }
                    280:     return $msg;
                    281: }
                    282: 
                    283: sub reset_passwd {
                    284:     my ($r,$token,$contact_name,$contact_email) = @_;
                    285:     my $msg;
                    286:     my %data = &Apache::lonnet::tmpget($token);
                    287:     my $now = time;
                    288:     if (keys(%data) == 0) {
1.17      bisitz    289:         $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.'
                    290:                   ,'<a href="/adm/resetpw">','</a>');
1.1       raeburn   291:         return $msg;
                    292:     }
                    293:     if (($data{'time'} =~ /^\d+$/) && 
                    294:         ($data{'username'} ne '') && 
                    295:         ($data{'domain'} ne '') && 
1.3       raeburn   296:         ($data{'email'}  =~ /^[^\@]+\@[^\@]+\.[^\@\.]+$/) && 
1.1       raeburn   297:         ($data{'temppasswd'} =~/^\w+$/)) {
1.9       raeburn   298:         my $reqtime = &Apache::lonlocal::locallocaltime($data{'time'});
1.1       raeburn   299:         if ($now - $data{'time'} < 7200) {
                    300:             if ($env{'form.action'} eq 'verify_and_change_pass') {
1.22      raeburn   301:                 unless (($env{'form.uname'} eq $data{'username'}) && ($env{'form.udom'} eq $data{'domain'}) && ($env{'form.email'} eq $data{'email'})) {
                    302:                     $msg = &generic_failure_msg($contact_name,$contact_email);
                    303:                     return $msg;
                    304:                 }
1.1       raeburn   305:                 my $change_failed = 
1.2       albertel  306: 		    &Apache::lonpreferences::verify_and_change_password($r,'reset_by_email',$token);
1.1       raeburn   307:                 if (!$change_failed) {
                    308:                     my $delete = &Apache::lonnet::tmpdel($token);
1.9       raeburn   309:                     my $now = &Apache::lonlocal::locallocaltime(time);
1.1       raeburn   310:                     my $domdesc = 
1.6       albertel  311: 			&Apache::lonnet::domain($data{'domain'},'description');
1.1       raeburn   312:                     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";
                    313:                     my $result = &send_mail($domdesc,$data{'email'},$mailmsg,
                    314:                                             $contact_name,$contact_email);
                    315:                     if ($result eq 'ok') {
                    316:                         $msg .= &mt('An e-mail confirming setting of the password for your LON-CAPA account has been sent to [_1].',$data{'email'});
                    317:                     } else {
                    318:                         $msg .= &mt('An error occurred when sending e-mail to [_1] confirming setting of your new password.',$data{'email'});
                    319:                     }
1.17      bisitz    320:                     $msg .= '<br /><br />'
                    321:                            .'<a href="/adm/login">'.&mt('Go to the login page').'</a>.';
1.20      raeburn   322:                 } elsif ($change_failed eq 'invalid_client') {
                    323:                     my $homeserver = &Apache::lonnet::homeserver($data{'username'},$data{'domain'});
                    324:                     if ($homeserver eq 'no_host') {
                    325:                         $msg .= &generic_failure_msg($contact_name,$contact_email);
                    326:                     } else {
                    327:                         my $protocol = $Apache::lonnet::protocol{$homeserver};
                    328:                         $protocol = 'http' if ($protocol ne 'https');
                    329:                         my $url = $protocol.'://'.&Apache::lonnet::hostname($homeserver).
                    330:                                   '/adm/resetpw';
                    331:                         my ($opentag,$closetag);
                    332:                         if ($url) {
                    333:                            $opentag = '<a href="'.$url.'">';
                    334:                            $closetag = '</a>';
                    335:                         }
                    336:                         $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);
                    337:                     }
1.1       raeburn   338:                 } else {
1.20      raeburn   339:                     $msg .= &generic_failure_msg($contact_name,$contact_email);
1.1       raeburn   340:                 }
                    341:             } else {
1.13      schafran  342:                 $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   343:                 $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 />');
                    344:                 &Apache::lonpreferences::passwordchanger($r,'','reset_by_email',$token);
                    345:             }
                    346:         } else {
1.17      bisitz    347:             $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.'
                    348:                       ,'<a href="/adm/resetpw">','</a>');
1.1       raeburn   349:         }
                    350:     } else {
1.17      bisitz    351:         $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.'
                    352:                    ,'<a href="/adm/resetpw">','</a>');
1.1       raeburn   353:     }
                    354:     return $msg;
                    355: }
                    356: 
1.20      raeburn   357: sub generic_failure_msg {
                    358:     my ($contact_name,$contact_email) = @_;
                    359:     return &mt('A problem occurred when attempting to reset the password for your account. Please contact the [_1] - ([_2]) for assistance.',
                    360:               $contact_name,'<a href="mailto:'.$contact_email.'">'.$contact_email.'</a>');
                    361: }
                    362: 
1.1       raeburn   363: sub create_passwd {
                    364:     my $passwd = '';
1.2       albertel  365:     my @letts = ("a".."z");
1.1       raeburn   366:     for (my $i=0; $i<8; $i++) {
1.2       albertel  367:         my $lettnum = int(rand(2));
1.1       raeburn   368:         my $item = '';
                    369:         if ($lettnum) {
1.2       albertel  370:             $item = $letts[int(rand(26))];
                    371:             my $uppercase = int(rand(2));
1.1       raeburn   372:             if ($uppercase) {
                    373:                 $item =~ tr/a-z/A-Z/;
                    374:             }
                    375:         } else {
1.2       albertel  376:             $item = int(rand(10));
1.1       raeburn   377:         }
                    378:         $passwd .= $item;
                    379:     }
                    380:     return ($passwd);
                    381: }
                    382: 
                    383: 1;

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>