loncom/auth/lonauth.pm - view

File: [LON-CAPA] / loncom / auth / lonauth.pm
Revision 1.110: download - view: text, annotated - select for diffs
Thu Sep 23 23:47:33 2010 UTC (13 years, 8 months ago) by raeburn
Branches: MAIN
CVS tags: HEAD

- Coding style for readability.
  - Move return OK to main handler.
  - Need return OK after $r->internal_redirect in main handler.
  - &check_can_host() returns 0 or 1 (1 if canhost).

1: # The LearningOnline Network 2: # User Authentication Module 3: # 4: # $Id: lonauth.pm,v 1.110 2010/09/23 23:47:33 raeburn 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 Apache::File (); 44: use HTML::Entities; 45: 46: # ------------------------------------------------------------ Successful login 47: sub success { 48: my ($r, $username, $domain, $authhost, $lowerurl, $extra_env, 49: $form) = @_; 50: 51: # ------------------------------------------------------------ Get cookie ready 52: my $cookie = 53: &Apache::loncommon::init_user_environment($r, $username, $domain, 54: $authhost, $form, 55: {'extra_env' => $extra_env,}); 56: 57: my $public=($username eq 'public' && $domain eq 'public'); 58: 59: if ($public or $lowerurl eq 'noredirect') { return $cookie; } 60: 61: # -------------------------------------------------------------------- Log this 62: 63: &Apache::lonnet::log($domain,$username,$authhost, 64: "Login $ENV{'REMOTE_ADDR'}"); 65: 66: # ------------------------------------------------- Check for critical messages 67: 68: my @what=&Apache::lonnet::dump('critical',$domain,$username); 69: if ($what[0]) { 70: if (($what[0] ne 'con_lost') && ($what[0]!~/^error\:/)) { 71: $lowerurl='/adm/email?critical=display'; 72: } 73: } 74: 75: # ------------------------------------------------------------ Get cookie ready 76: $cookie="lonID=$cookie; path=/"; 77: # -------------------------------------------------------- Menu script and info 78: my $destination = $lowerurl; 79: 80: if (defined($form->{role})) { 81: my $envkey = 'user.role.'.$form->{role}; 82: my $now=time; 83: my $then=$env{'user.login.time'}; 84: my $refresh=$env{'user.refresh.time'}; 85: if (exists($env{$envkey})) { 86: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus); 87: &Apache::lonnet::role_status($envkey,$then,$refresh,$now,\$role,\$where, 88: \$trolecode,\$tstatus,\$tstart,\$tend); 89: if ($tstatus eq 'is') { 90: $destination .= ($destination =~ /\?/) ? '&' : '?'; 91: my $newrole = &HTML::Entities::encode($form->{role},'"<>&'); 92: $destination .= 'selectrole=1&'.$newrole.'=1'; 93: } 94: } 95: } 96: if (defined($form->{symb})) { 97: my $destsymb = $form->{symb}; 98: $destination .= ($destination =~ /\?/) ? '&' : '?'; 99: if ($destsymb =~ /___/) { 100: # FIXME Need to deal with encrypted symbs and urls as needed. 101: my ($map,$resid,$desturl)=split(/___/,$destsymb); 102: unless ($desturl=~/^(adm|uploaded|editupload|public)/) { 103: $desturl = &Apache::lonnet::clutter($desturl); 104: } 105: $desturl = &HTML::Entities::encode($desturl,'"<>&'); 106: $destsymb = &HTML::Entities::encode($destsymb,'"<>&'); 107: $destination .= '&destinationurl='.$desturl. 108: '&destsymb='.$destsymb; 109: } else { 110: $destsymb = &HTML::Entities::encode($destsymb,'"<>&'); 111: $destination .= '&destinationurl='.$destsymb; 112: } 113: } 114: 115: my $windowinfo = Apache::lonhtmlcommon::scripttag('self.name="loncapaclient";'); 116: my $header = '<meta HTTP-EQUIV="Refresh" CONTENT="0; url='.$destination.'" />'; 117: my $brcrum = [{'href' => '', 118: 'text' => 'Successful Login'},]; 119: my $start_page=&Apache::loncommon::start_page('Successful Login', 120: $header, 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: my $retry = '/adm/login?username='.$form->{'uname'}. 154: '&domain='.$form->{'udom'}; 155: if (exists($form->{role})) { 156: $retry .= '&role='.$form->{role}; 157: } 158: if (exists($form->{symb})) { 159: $retry .= '&symb='.$form->{symb}; 160: } 161: my $end_page = &Apache::loncommon::end_page(); 162: &Apache::loncommon::content_type($r,'text/html'); 163: $r->send_http_header; 164: $r->print( 165: $start_page 166: .'<h1>'.&mt('Sorry ...').'</h1>' 167: .'<p class="LC_warning">'.&mt($message).'</p>' 168: .'<p>'.&mt('Please [_1]log in again[_2].','<a href="'.$retry.'">','</a>') 169: .'</p>' 170: .'<p><a href="/adm/loginproblems.html">'.&mt('Login problems?').'</a></p>' 171: .$end_page 172: ); 173: } 174: 175: # ------------------------------------------------------------------ Rerouting! 176: 177: sub reroute { 178: my ($r) = @_; 179: &Apache::loncommon::content_type($r,'text/html'); 180: $r->send_http_header; 181: my $msg='<h1>'.&mt('Sorry ...').'</h1>' 182: .&mt('Please [_1]log in again[_2].'); 183: &Apache::loncommon::simple_error_page($r,'Rerouting',$msg); 184: } 185: 186: # ---------------------------------------------------------------- Main handler 187: 188: sub handler { 189: my $r = shift; 190: my $form; 191: # Are we re-routing? 192: if (-e '/home/httpd/html/lon-status/reroute.txt') { 193: &reroute($r); 194: return OK; 195: } 196: 197: &Apache::lonlocal::get_language_handle($r); 198: 199: # -------------------------------- Prevent users from attempting to login twice 200: my $handle = &Apache::lonnet::check_for_valid_session($r); 201: if ($handle ne '') { 202: my $lonidsdir=$r->dir_config('lonIDsDir'); 203: if ($handle=~/^publicuser\_/) { 204: # For "public user" - remove it, we apparently really want to login 205: unlink($r->dir_config('lonIDsDir')."/$handle.id"); 206: } else { 207: # Indeed, a valid token is found 208: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle); 209: &Apache::loncommon::content_type($r,'text/html'); 210: $r->send_http_header; 211: my $start_page = 212: &Apache::loncommon::start_page('Already logged in'); 213: my $end_page = 214: &Apache::loncommon::end_page(); 215: my $dest = '/adm/roles'; 216: if ($env{'form.firsturl'} ne '') { 217: $dest = $env{'form.firsturl'}; 218: } 219: $r->print( 220: $start_page 221: .'<h1>'.&mt('You are already logged in!').'</h1>' 222: .'<p>'.&mt('Please either [_1]continue the current session[_2] or [_3]log out[_4].' 223: ,'<a href="'.$dest.'">','</a>','<a href="/adm/logout">','</a>') 224: .'</p>' 225: .$end_page 226: ); 227: return OK; 228: } 229: } 230: 231: # ---------------------------------------------------- No valid token, continue 232: 233: 234: my $buffer; 235: if ($r->header_in('Content-length') > 0) { 236: $r->read($buffer,$r->header_in('Content-length'),0); 237: } 238: my %form; 239: foreach my $pair (split(/&/,$buffer)) { 240: my ($name,$value) = split(/=/,$pair); 241: $value =~ tr/+/ /; 242: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg; 243: $form{$name}=$value; 244: } 245: 246: if ((!$form{'uname'}) || (!$form{'upass0'}) || (!$form{'udom'})) { 247: &failed($r,'Username, password and domain need to be specified.', 248: \%form); 249: return OK; 250: } 251: 252: # split user logging in and "su"-user 253: 254: ($form{'uname'},$form{'suname'})=split(/\:/,$form{'uname'}); 255: $form{'uname'} = &LONCAPA::clean_username($form{'uname'}); 256: $form{'suname'}= &LONCAPA::clean_username($form{'suname'}); 257: $form{'udom'} = &LONCAPA::clean_domain( $form{'udom'}); 258: 259: my $role = $r->dir_config('lonRole'); 260: my $domain = $r->dir_config('lonDefDomain'); 261: my $prodir = $r->dir_config('lonUsersDir'); 262: my $contact_name = &mt('LON-CAPA helpdesk'); 263: 264: # ---------------------------------------- Get the information from login token 265: 266: my $tmpinfo=Apache::lonnet::reply('tmpget:'.$form{'logtoken'}, 267: $form{'serverid'}); 268: 269: if (($tmpinfo=~/^error/) || ($tmpinfo eq 'con_lost')) { 270: &failed($r,'Information needed to verify your login information is missing, inaccessible or expired.',\%form); 271: return OK; 272: } else { 273: my $reply = &Apache::lonnet::reply('tmpdel:'.$form{'logtoken'}, 274: $form{'serverid'}); 275: if ( $reply ne 'ok' ) { 276: &failed($r,'Session could not be opened.',\%form); 277: &Apache::lonnet::logthis("ERROR got a reply of $reply when trying to contact ". $form{'serverid'}." to get login token"); 278: return OK; 279: } 280: } 281: 282: if (!&Apache::lonnet::domain($form{'udom'})) { 283: &failed($r,'The domain you provided is not a valid LON-CAPA domain.',\%form); 284: return OK; 285: } 286: 287: my ($key,$firsturl,$rolestr,$symbstr)=split(/&/,$tmpinfo); 288: if ($rolestr) { 289: $rolestr = &unescape($rolestr); 290: } 291: if ($symbstr) { 292: $symbstr= &unescape($symbstr); 293: } 294: if ($rolestr =~ /^role=/) { 295: (undef,$form{'role'}) = split('=',$rolestr); 296: } 297: if ($symbstr =~ /^symb=/) { 298: (undef,$form{'symb'}) = split('=',$symbstr); 299: } 300: 301: my $keybin=pack("H16",$key); 302: 303: my $cipher; 304: if ($Crypt::DES::VERSION>=2.03) { 305: $cipher=new Crypt::DES $keybin; 306: } 307: else { 308: $cipher=new DES $keybin; 309: } 310: my $upass=''; 311: for (my $i=0;$i<=2;$i++) { 312: my $chunk= 313: $cipher->decrypt(unpack("a8",pack("H16",substr($form{'upass'.$i},0,16)))); 314: 315: $chunk.= 316: $cipher->decrypt(unpack("a8",pack("H16",substr($form{'upass'.$i},16,16)))); 317: 318: $chunk=substr($chunk,1,ord(substr($chunk,0,1))); 319: $upass.=$chunk; 320: } 321: 322: # ---------------------------------------------------------------- Authenticate 323: my @cancreate; 324: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$form{'udom'}); 325: if (ref($domconfig{'usercreation'}) eq 'HASH') { 326: if (ref($domconfig{'usercreation'}{'cancreate'}) eq 'HASH') { 327: if (ref($domconfig{'usercreation'}{'cancreate'}{'selfcreate'}) eq 'ARRAY') { 328: @cancreate = @{$domconfig{'usercreation'}{'cancreate'}{'selfcreate'}}; 329: } elsif (($domconfig{'usercreation'}{'cancreate'}{'selfcreate'} ne 'none') && 330: ($domconfig{'usercreation'}{'cancreate'}{'selfcreate'} ne '')) { 331: @cancreate = ($domconfig{'usercreation'}{'cancreate'}{'selfcreate'}); 332: } 333: } 334: } 335: my $defaultauth; 336: if (grep(/^login$/,@cancreate)) { 337: $defaultauth = 1; 338: } 339: my $clientcancheckhost = 1; 340: my $authhost=Apache::lonnet::authenticate($form{'uname'},$upass, 341: $form{'udom'},$defaultauth, 342: $clientcancheckhost); 343: 344: # --------------------------------------------------------------------- Failed? 345: 346: if ($authhost eq 'no_host') { 347: &failed($r,'Username and/or password could not be authenticated.', 348: \%form); 349: return OK; 350: } elsif ($authhost eq 'no_account_on_host') { 351: my %domconfig = 352: &Apache::lonnet::get_dom('configuration',['usercreation'],$form{'udom'}); 353: if (grep(/^login$/,@cancreate)) { 354: my $domdesc = &Apache::lonnet::domain($form{'udom'},'description'); 355: unless (&check_can_host($r,\%form,'no_account_on_host',$domdesc)) { 356: return OK; 357: } 358: my $start_page = 359: &Apache::loncommon::start_page('Create a user account in LON-CAPA'); 360: my $lonhost = $r->dir_config('lonHostID'); 361: my $origmail = $Apache::lonnet::perlvar{'lonSupportEMail'}; 362: my $contacts = 363: &Apache::loncommon::build_recipient_list(undef,'helpdeskmail', 364: $form{'udom'},$origmail); 365: my ($contact_email) = split(',',$contacts); 366: my $output = &Apache::createaccount::username_check($form{'uname'}, 367: $form{'udom'},$domdesc,'', 368: $lonhost,$contact_email,$contact_name); 369: &Apache::loncommon::content_type($r,'text/html'); 370: $r->send_http_header; 371: &Apache::createaccount::print_header($r,$start_page); 372: $r->print('<h3>'.&mt('Account creation').'</h3>'. 373: &mt('Although your username and password were authenticated, you do not currently have a LON-CAPA account at this institution.').'<br />'. 374: $output.&Apache::loncommon::end_page()); 375: return OK; 376: } else { 377: &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); 378: return OK; 379: } 380: } 381: 382: if (($firsturl eq '') || 383: ($firsturl=~/^\/adm\/(logout|remote)/)) { 384: $firsturl='/adm/roles'; 385: } 386: # --------------------------------- Are we attempting to login as somebody else? 387: if ($form{'suname'}) { 388: # ------------ see if the original user has enough privileges to pull this stunt 389: if (&Apache::lonnet::privileged($form{'uname'},$form{'udom'})) { 390: # ---------------------------------------------------- see if the su-user exists 391: unless (&Apache::lonnet::homeserver($form{'suname'},$form{'udom'}) 392: eq 'no_host') { 393: &Apache::lonnet::logthis(&Apache::lonnet::homeserver($form{'suname'},$form{'udom'})); 394: # ------------------------------ see if the su-user is not too highly privileged 395: unless (&Apache::lonnet::privileged($form{'suname'},$form{'udom'})) { 396: # -------------------------------------------------------- actually switch users 397: &Apache::lonnet::logperm('User '.$form{'uname'}.' at '.$form{'udom'}. 398: ' logging in as '.$form{'suname'}); 399: $form{'uname'}=$form{'suname'}; 400: } else { 401: &Apache::lonnet::logthis('Attempted switch user to privileged user'); 402: } 403: } 404: } else { 405: &Apache::lonnet::logthis('Non-privileged user attempting switch user'); 406: } 407: } 408: 409: unless (&check_can_host($r,\%form,$authhost)) { 410: return OK; 411: } 412: 413: if ($r->dir_config("lonBalancer") eq 'yes') { 414: &success($r,$form{'uname'},$form{'udom'},$authhost,'noredirect',undef, 415: \%form); 416: my ($otherserver) = &Apache::lonnet::choose_server($form{'udom'}); 417: $r->internal_redirect('/adm/switchserver?otherserver='.$otherserver.'&origurl='.$firsturl); 418: return OK; 419: } else { 420: # ------------------------------------------------------- Do the load balancing 421: 422: # ---------------------------------------------------------- Determine own load 423: my $loadlim = $r->dir_config('lonLoadLim'); 424: my $loadavg; 425: { 426: my $loadfile=Apache::File->new('/proc/loadavg'); 427: $loadavg=<$loadfile>; 428: } 429: $loadavg =~ s/\s.*//g; 430: my $loadpercent=sprintf("%.1f",100*$loadavg/$loadlim); 431: my $userloadpercent=&Apache::lonnet::userload(); 432: 433: # ---------------------------------------------------------- Are we overloaded? 434: if ((($userloadpercent>100.0)||($loadpercent>100.0))) { 435: my $unloaded=Apache::lonnet::spareserver($loadpercent,$userloadpercent,1,$form{'udom'}); 436: if ($unloaded) { 437: &success($r,$form{'uname'},$form{'udom'},$authhost,'noredirect', 438: undef,\%form); 439: $r->internal_redirect('/adm/switchserver?otherserver='.$unloaded.'&origurl='.$firsturl); 440: return OK; 441: } 442: } 443: &success($r,$form{'uname'},$form{'udom'},$authhost,$firsturl,undef, 444: \%form); 445: return OK; 446: } 447: } 448: 449: sub check_can_host { 450: my ($r,$form,$authhost,$domdesc) = @_; 451: return unless (ref($form) eq 'HASH'); 452: my $canhost = 1; 453: my $lonhost = $r->dir_config('lonHostID'); 454: my $udom = $form->{'udom'}; 455: my @intdoms; 456: my $internet_names = &Apache::lonnet::get_internet_names($lonhost); 457: if (ref($internet_names) eq 'ARRAY') { 458: @intdoms = @{$internet_names}; 459: } 460: my $uprimary_id = &Apache::lonnet::domain($udom,'primary'); 461: my $uint_dom = &Apache::lonnet::internet_dom($uprimary_id); 462: unless ($uint_dom ne '' && grep(/^\Q$uint_dom\E$/,@intdoms)) { 463: my $machine_dom = &Apache::lonnet::host_domain($lonhost); 464: my $hostname = &Apache::lonnet::hostname($lonhost); 465: my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname); 466: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID); 467: my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom); 468: my %udomdefaults = &Apache::lonnet::get_domain_defaults($udom); 469: my $loncaparev; 470: if ($authhost eq 'no_account_on_host') { 471: $loncaparev = &Apache::lonnet::get_server_loncaparev($machine_dom); 472: } else { 473: $loncaparev = &Apache::lonnet::get_server_loncaparev($machine_dom,$lonhost); 474: } 475: $canhost = &Apache::lonnet::can_host_session($udom,$lonhost,$loncaparev, 476: $udomdefaults{'remotesessions'}, 477: $defdomdefaults{'hostedsessions'}); 478: } 479: unless ($canhost) { 480: if ($authhost eq 'no_account_on_host') { 481: my ($login_host,$hostname) = &Apache::lonnet::choose_server($udom); 482: &Apache::loncommon::content_type($r,'text/html'); 483: $r->send_http_header; 484: if ($login_host ne '') { 485: my $protocol = $Apache::lonnet::protocol{$login_host}; 486: $protocol = 'http' if ($protocol ne 'https'); 487: my $newurl = $protocol.'://'.$hostname.'/adm/createaccount'; 488: $r->print(&Apache::loncommon::start_page('Create a user account in LON-CAPA'). 489: '<h3>'.&mt('Account creation').'</h3>'. 490: &mt('You do not currently have a LON-CAPA account at this institution.').'<br />'. 491: '<p>'.&mt('You will be able to create one by logging into a LON-CAPA server within the [_1] domain.',$domdesc).'</p>'. 492: '<p>'.&mt('[_1]Log in[_2]','<a href="'.$newurl.'">','</a>'). 493: &Apache::loncommon::end_page()); 494: } else { 495: $r->print(&Apache::loncommon::start_page('Access to LON-CAPA unavailable'). 496: '<h3>'.&mt('Account creation unavailable').'</h3>'. 497: &mt('You do not currently have a LON-CAPA account at this institution.').'<br />'. 498: '<p>'.&mt('Currently a LON-CAPA server is not available within the [_1] domain for you to log-in to, to create an account.',$domdesc).'</p>'. 499: &Apache::loncommon::end_page()); 500: } 501: } else { 502: &success($r,$form->{'uname'},$udom,$authhost,'noredirect',undef, 503: $form); 504: my ($otherserver) = &Apache::lonnet::choose_server($udom); 505: $r->internal_redirect('/adm/switchserver?otherserver='.$otherserver); 506: } 507: } 508: return $canhost; 509: } 510: 511: 1; 512: __END__ 513: 514: