Return to lonauth.pm CVS log

Up to [LON-CAPA] / loncom / auth

Move duplicate code in lonauth.pm and createaccount.pm which handles result from createaccount::username_check() into username_check() for both log-in ID and SSO cases.
- additional args ($contact_name $sso_logout) passed to &username_check for SSO case.
- Page for user information data table customized based on availability of data fields, and whther data can be entered (according to $rowcount and $editable args returned from &loncreateuser::personal_data_display().
 - If no values are available or editable don't display table.
 - If only non-editable values are available - display table with appropriate message.
 - If one or more editable values - display table with appropriate message.
If username check reports errors (e.g., 'username' not in institutional database, or 'authtoken' - authtoken could not be set) - display appropriate error reports.

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