Return to lonauth.pm CVS log

Up to [LON-CAPA] / loncom / auth

In process of removing remote control, remote navmap and different icon modes code
Also some minor refactoring.

    1: # The LearningOnline Network
    2: # User Authentication Module
    3: #
    4: # $Id: lonauth.pm,v 1.102 2010/03/10 21:25:29 droeschl Exp $
    5: #
    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: 
   29: package Apache::lonauth;
   30: 
   31: use strict;
   32: use LONCAPA;
   33: use Apache::Constants qw(:common);
   34: use CGI qw(:standard);
   35: use DynaLoader; # for Crypt::DES version
   36: use Crypt::DES;
   37: use Apache::loncommon();
   38: use Apache::lonnet;
   39: use Apache::lonmenu();
   40: use Apache::createaccount;
   41: use Fcntl qw(:flock);
   42: use Apache::lonlocal;
   43: use HTML::Entities;
   44:  
   45: # ------------------------------------------------------------ Successful login
   46: sub success {
   47:     my ($r, $username, $domain, $authhost, $lowerurl, $extra_env,
   48: 	$form) = @_;
   49: 
   50: # ------------------------------------------------------------ Get cookie ready
   51:     my $cookie =
   52: 	&Apache::loncommon::init_user_environment($r, $username, $domain,
   53: 						  $authhost, $form,
   54: 						  {'extra_env' => $extra_env,});
   55: 
   56:     my $public=($username eq 'public' && $domain eq 'public');
   57: 
   58:     if ($public or $lowerurl eq 'noredirect') { return $cookie; }
   59: 
   60: # -------------------------------------------------------------------- Log this
   61: 
   62:     &Apache::lonnet::log($domain,$username,$authhost,
   63:                          "Login $ENV{'REMOTE_ADDR'}");
   64: 
   65: # ------------------------------------------------- Check for critical messages
   66: 
   67:     my @what=&Apache::lonnet::dump('critical',$domain,$username);
   68:     if ($what[0]) {
   69: 	if (($what[0] ne 'con_lost') && ($what[0]!~/^error\:/)) {
   70: 	    $lowerurl='/adm/email?critical=display';
   71:         }
   72:     }
   73: 
   74: # ------------------------------------------------------------ Get cookie ready
   75:     $cookie="lonID=$cookie; path=/";
   76: # -------------------------------------------------------- Menu script and info
   77:     my $destination = $lowerurl;
   78: 
   79:     if (defined($form->{role})) {
   80:         my $envkey = 'user.role.'.$form->{role};
   81:         my $now=time;
   82:         my $then=$env{'user.login.time'};
   83:         my $refresh=$env{'user.refresh.time'};
   84:         if (exists($env{$envkey})) {
   85:             my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus);
   86:             &Apache::lonnet::role_status($envkey,$then,$refresh,$now,\$role,\$where,
   87:                                          \$trolecode,\$tstatus,\$tstart,\$tend);
   88:             if ($tstatus eq 'is') {
   89:                 $destination  .= ($destination =~ /\?/) ? '&' : '?';
   90:                 my $newrole = &HTML::Entities::encode($form->{role},'"<>&');
   91:                 $destination .= 'selectrole=1&'.$newrole.'=1';
   92:             }
   93:         }
   94:     }
   95:     if (defined($form->{symb})) {
   96:         my $destsymb = $form->{symb};
   97:         $destination  .= ($destination =~ /\?/) ? '&' : '?';
   98:         if ($destsymb =~ /___/) {
   99:             # FIXME Need to deal with encrypted symbs and urls as needed.
  100:             my ($map,$resid,$desturl)=split(/___/,$destsymb);
  101:             unless ($desturl=~/^(adm|uploaded|editupload|public)/) {
  102:                 $desturl = &Apache::lonnet::clutter($desturl);
  103:             }
  104:             $desturl = &HTML::Entities::encode($desturl,'"<>&');
  105:             $destsymb = &HTML::Entities::encode($destsymb,'"<>&');
  106:             $destination .= '&destinationurl='.$desturl.
  107:                             '&destsymb='.$destsymb;
  108:         } else {
  109:             $destsymb = &HTML::Entities::encode($destsymb,'"<>&');
  110:             $destination .= '&destinationurl='.$destsymb;
  111:         }
  112:     }
  113: 
  114:     my $windowinfo = Apache::lonhtmlcommon::scripttag('self.name="loncapaclient";');
  115:     my $header = '<meta HTTP-EQUIV="Refresh" CONTENT="0; url='.$destination.'" />';
  116:     my $brcrum = [{'href' => '',
  117:                    'text' => 'Successful Login'},];
  118:     my $start_page=&Apache::loncommon::start_page('Successful Login',
  119:                                                   $header,
  120:                                                   {'no_inline_link' => 1,
  121:                                                    'bread_crumbs' => $brcrum,});
  122:     my $end_page  =&Apache::loncommon::end_page();
  123: 
  124: 	my $continuelink='<a href="'.$destination.'">'.&mt('Continue').'</a>';
  125: # ------------------------------------------------- Output for successful login
  126: 
  127:     &Apache::loncommon::content_type($r,'text/html');
  128:     $r->header_out('Set-cookie' => $cookie);
  129:     $r->send_http_header;
  130: 
  131:     my %lt=&Apache::lonlocal::texthash(
  132: 				       'wel' => 'Welcome',
  133: 				       'mes' => 'Welcome to the Learning<i>Online</i> Network with CAPA. Please wait while your session is being set up.',
  134: 				       'pro' => 'Login problems?',
  135: 				       'log' => 'loginproblems.html',
  136: 				       );
  137:     $r->print(<<ENDSUCCESS);
  138: $start_page
  139: $windowinfo
  140: <h1>$lt{'wel'}</h1>
  141: $lt{'mes'}<p>
  142: <a href="/adm/$lt{'log'}">$lt{'pro'}</a></p>
  143: $continuelink
  144: $end_page
  145: ENDSUCCESS
  146: }
  147: 
  148: # --------------------------------------------------------------- Failed login!
  149: 
  150: sub failed {
  151:     my ($r,$message,$form) = @_;
  152:     my $start_page = &Apache::loncommon::start_page('Unsuccessful Login',undef,
  153: 						    {'no_inline_link' => 1,});
  154:     my $retry = '/adm/login?username='.$form->{'uname'}.
  155:                 '&domain='.$form->{'udom'};
  156:     if (exists($form->{role})) {
  157:         $retry .= '&role='.$form->{role};
  158:     }
  159:     if (exists($form->{symb})) {
  160:         $retry .= '&symb='.$form->{symb};
  161:     }
  162:     my $end_page   = &Apache::loncommon::end_page();
  163:     &Apache::loncommon::content_type($r,'text/html');
  164:     $r->send_http_header;
  165:     $r->print(
  166:        $start_page
  167:       .'<h1>'.&mt('Sorry ...').'</h1>'
  168:       .'<p class="LC_warning">'.&mt($message).'</p>'
  169:       .'<p>'.&mt('Please [_1]log in again[_2].','<a href="'.$retry.'">','</a>')
  170:       .'</p>'
  171:       .'<p><a href="/adm/loginproblems.html">'.&mt('Login problems?').'</a></p>'
  172:       .$end_page
  173:     );
  174:  }
  175: 
  176: # ------------------------------------------------------------------ Rerouting!
  177: 
  178: sub reroute {
  179:     my ($r) = @_;
  180:     &Apache::loncommon::content_type($r,'text/html');
  181:     $r->send_http_header;
  182:     my $msg='<h1>'.&mt('Sorry ...').'</h1>'
  183:            .&mt('Please [_1]log in again[_2].');
  184:     &Apache::loncommon::simple_error_page($r,'Rerouting',$msg);
  185: }
  186: 
  187: # ---------------------------------------------------------------- Main handler
  188: 
  189: sub handler {
  190:     my $r = shift;
  191:     my $form;
  192: # Are we re-routing?
  193:     if (-e '/home/httpd/html/lon-status/reroute.txt') {
  194: 	&reroute($r);
  195: 	return OK;
  196:     }
  197: 
  198:     &Apache::lonlocal::get_language_handle($r);
  199: 
  200: # -------------------------------- Prevent users from attempting to login twice
  201:     my $handle = &Apache::lonnet::check_for_valid_session($r);
  202:     if ($handle ne '') {
  203: # Indeed, a valid token is found
  204: 	&Apache::loncommon::content_type($r,'text/html');
  205: 	$r->send_http_header;
  206: 	my $start_page = 
  207: 	    &Apache::loncommon::start_page('Already logged in');
  208: 	my $end_page = 
  209: 	    &Apache::loncommon::end_page();
  210:         $r->print(
  211:            $start_page
  212:           .'<h1>'.&mt('You are already logged in!').'</h1>'
  213:           .'<p>'.&mt('Please either [_1]continue the current session[_2] or [_3]log out[_4].'
  214:                     ,'<a href="/adm/roles">','</a>','<a href="/adm/logout">','</a>')
  215:           .'</p>'
  216:           .'<p><a href="/adm/loginproblems.html">'.&mt('Login problems?').'</a></p>'
  217:           .$end_page
  218:         );
  219:         return OK;
  220:     }
  221: 
  222: # ---------------------------------------------------- No valid token, continue
  223: 
  224: 
  225:     my $buffer;
  226:     if ($r->header_in('Content-length') > 0) {
  227: 	$r->read($buffer,$r->header_in('Content-length'),0);
  228:     }
  229:     my %form;
  230:     foreach my $pair (split(/&/,$buffer)) {
  231:        my ($name,$value) = split(/=/,$pair);
  232:        $value =~ tr/+/ /;
  233:        $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
  234:        $form{$name}=$value;
  235:     } 
  236: 
  237:     if ((!$form{'uname'}) || (!$form{'upass0'}) || (!$form{'udom'})) {
  238: 	&failed($r,'Username, password and domain need to be specified.',
  239: 		\%form);
  240:         return OK;
  241:     }
  242: 
  243: # split user logging in and "su"-user
  244: 
  245:     ($form{'uname'},$form{'suname'})=split(/\:/,$form{'uname'});
  246:     $form{'uname'} = &LONCAPA::clean_username($form{'uname'});
  247:     $form{'suname'}= &LONCAPA::clean_username($form{'suname'});
  248:     $form{'udom'}  = &LONCAPA::clean_domain(  $form{'udom'});
  249: 
  250:     my $role   = $r->dir_config('lonRole');
  251:     my $domain = $r->dir_config('lonDefDomain');
  252:     my $prodir = $r->dir_config('lonUsersDir');
  253:     my $contact_name = &mt('LON-CAPA helpdesk');
  254: 
  255: # ---------------------------------------- Get the information from login token
  256: 
  257:     my $tmpinfo=Apache::lonnet::reply('tmpget:'.$form{'logtoken'},
  258:                                       $form{'serverid'});
  259: 
  260:     if (($tmpinfo=~/^error/) || ($tmpinfo eq 'con_lost')) {
  261: 	&failed($r,'Information needed to verify your login information is missing, inaccessible or expired.',\%form);
  262:         return OK;
  263:     } else {
  264: 	my $reply = &Apache::lonnet::reply('tmpdel:'.$form{'logtoken'},
  265: 					   $form{'serverid'});
  266:         if ( $reply ne 'ok' ) {
  267:             &failed($r,'Session could not be opened.',\%form);
  268: 	    &Apache::lonnet::logthis("ERROR got a reply of $reply when trying to contact ". $form{'serverid'}." to get login token");
  269: 	    return OK;
  270: 	}
  271:     }
  272: 
  273:     if (!&Apache::lonnet::domain($form{'udom'})) {
  274:         &failed($r,'The domain you provided is not a valid LON-CAPA domain.',\%form);
  275:         return OK;
  276:     }
  277: 
  278:     my ($key,$firsturl,$rolestr,$symbstr)=split(/&/,$tmpinfo);
  279:     if ($rolestr) {
  280:         $rolestr = &unescape($rolestr);
  281:     }
  282:     if ($symbstr) {
  283:         $symbstr= &unescape($symbstr);
  284:     }
  285:     if ($rolestr =~ /^role=/) {
  286:         (undef,$form{'role'}) = split('=',$rolestr);
  287:     }
  288:     if ($symbstr =~ /^symb=/) { 
  289:         (undef,$form{'symb'}) = split('=',$symbstr);
  290:     }
  291: 
  292:     my $keybin=pack("H16",$key);
  293: 
  294:     my $cipher;
  295:     if ($Crypt::DES::VERSION>=2.03) {
  296: 	$cipher=new Crypt::DES $keybin;
  297:     }
  298:     else {
  299: 	$cipher=new DES $keybin;
  300:     }
  301:     my $upass='';
  302:     for (my $i=0;$i<=2;$i++) {
  303: 	my $chunk=
  304: 	    $cipher->decrypt(unpack("a8",pack("H16",substr($form{'upass'.$i},0,16))));
  305: 
  306: 	$chunk.=
  307: 	    $cipher->decrypt(unpack("a8",pack("H16",substr($form{'upass'.$i},16,16))));
  308: 
  309: 	$chunk=substr($chunk,1,ord(substr($chunk,0,1)));
  310: 	$upass.=$chunk;
  311:     }
  312: 
  313: # ---------------------------------------------------------------- Authenticate
  314:     my @cancreate;
  315:     my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$form{'udom'});
  316:     if (ref($domconfig{'usercreation'}) eq 'HASH') {
  317:         if (ref($domconfig{'usercreation'}{'cancreate'}) eq 'HASH') {
  318:             if (ref($domconfig{'usercreation'}{'cancreate'}{'selfcreate'}) eq 'ARRAY') {
  319:                 @cancreate = @{$domconfig{'usercreation'}{'cancreate'}{'selfcreate'}};
  320:             } elsif (($domconfig{'usercreation'}{'cancreate'}{'selfcreate'} ne 'none') && 
  321:                      ($domconfig{'usercreation'}{'cancreate'}{'selfcreate'} ne '')) {
  322:                 @cancreate = ($domconfig{'usercreation'}{'cancreate'}{'selfcreate'});
  323:             }
  324:         }
  325:     }
  326:     my $defaultauth;
  327:     if (grep(/^login$/,@cancreate)) {
  328:         $defaultauth = 1;
  329:     }
  330:     my $authhost=Apache::lonnet::authenticate($form{'uname'},$upass,
  331:                                               $form{'udom'},$defaultauth);
  332:     
  333: # --------------------------------------------------------------------- Failed?
  334: 
  335:     if ($authhost eq 'no_host') {
  336: 	&failed($r,'Username and/or password could not be authenticated.',
  337: 		\%form);
  338:         return OK;
  339:     } elsif ($authhost eq 'no_account_on_host') {
  340:         my %domconfig = 
  341:             &Apache::lonnet::get_dom('configuration',['usercreation'],$form{'udom'});
  342:         if (grep(/^login$/,@cancreate)) {
  343:             my $start_page = 
  344:                 &Apache::loncommon::start_page('Create a user account in LON-CAPA',
  345:                                                '',{'no_inline_link'   => 1,});
  346:             my $domdesc = &Apache::lonnet::domain($form{'udom'},'description');
  347:             my $lonhost = $r->dir_config('lonHostID');
  348:             my $origmail = $Apache::lonnet::perlvar{'lonSupportEMail'};
  349:             my $contacts = 
  350:                 &Apache::loncommon::build_recipient_list(undef,'helpdeskmail',
  351:                                                         $form{'udom'},$origmail);
  352:             my ($contact_email) = split(',',$contacts); 
  353:             my $output = &Apache::createaccount::username_check($form{'uname'}, 
  354:                                                                 $form{'udom'},$domdesc,'',
  355:                                                                 $lonhost,$contact_email,$contact_name);
  356:             &Apache::loncommon::content_type($r,'text/html');
  357:             $r->send_http_header;
  358:             &Apache::createaccount::print_header($r,$start_page);
  359:             $r->print('<h3>'.&mt('Account creation').'</h3>'.
  360:                       &mt('Although your username and password were authenticated, you do not currently have a LON-CAPA account at this institution.').'<br />'.
  361:                       $output.&Apache::loncommon::end_page());
  362:             return OK;
  363:         } else {
  364:             &failed($r,'Although your username and password were authenticated, you do not currently have a LON-CAPA account in this domain, and you are not permitted to create one.',\%form);
  365:             return OK;
  366:         }
  367:     }
  368: 
  369:     if (($firsturl eq '') || 
  370: 	($firsturl=~/^\/adm\/(logout|remote)/)) {
  371: 	$firsturl='/adm/roles';
  372:     }
  373: # --------------------------------- Are we attempting to login as somebody else?
  374:     if ($form{'suname'}) {
  375: # ------------ see if the original user has enough privileges to pull this stunt
  376: 	if (&Apache::lonnet::privileged($form{'uname'},$form{'udom'})) {
  377: # ---------------------------------------------------- see if the su-user exists
  378: 	    unless (&Apache::lonnet::homeserver($form{'suname'},$form{'udom'})
  379: 		eq 'no_host') {
  380: 		&Apache::lonnet::logthis(&Apache::lonnet::homeserver($form{'suname'},$form{'udom'}));
  381: # ------------------------------ see if the su-user is not too highly privileged
  382: 		unless (&Apache::lonnet::privileged($form{'suname'},$form{'udom'})) {
  383: # -------------------------------------------------------- actually switch users
  384: 		    &Apache::lonnet::logperm('User '.$form{'uname'}.' at '.$form{'udom'}.
  385: 			' logging in as '.$form{'suname'});
  386: 		    $form{'uname'}=$form{'suname'};
  387: 		} else {
  388: 		    &Apache::lonnet::logthis('Attempted switch user to privileged user');
  389: 		}
  390: 	    }
  391: 	} else {
  392: 	    &Apache::lonnet::logthis('Non-privileged user attempting switch user');
  393: 	}
  394:     }
  395: 
  396:     if ($r->dir_config("lonBalancer") eq 'yes') {
  397: 	&success($r,$form{'uname'},$form{'udom'},$authhost,'noredirect',undef,
  398: 		 \%form);
  399: 	$r->internal_redirect('/adm/switchserver');
  400:     } else {
  401: 	&success($r,$form{'uname'},$form{'udom'},$authhost,$firsturl,undef,
  402: 		 \%form);
  403:     }
  404:     return OK;
  405: }
  406: 
  407: 1;
  408: __END__
  409: 
  410: