File:  [LON-CAPA] / loncom / auth / switchserver.pm
Revision 1.54: download - view: text, annotated - select for diffs
Mon May 3 15:27:43 2021 UTC (3 years ago) by raeburn
Branches: MAIN
CVS tags: HEAD
- Bug 6914
 - Check whether WAF proxy alias should be used when using switchserver.
 - Requests for /adm/dns/hosts and /adm/dns/domain from other nodes in the
   network do not require redirecting to an alias (if in use).

    1: # The LearningOnline Network
    2: # Switch Servers Handler
    3: #
    4: # $Id: switchserver.pm,v 1.54 2021/05/03 15:27:43 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::switchserver;
   30: 
   31: use strict;
   32: use Apache::Constants qw(:common);
   33: use Apache::lonnet;
   34: use Digest::MD5 qw(md5_hex);
   35: use CGI::Cookie();
   36: use Apache::lonlocal;
   37: use LONCAPA qw(:DEFAULT :match);
   38: 
   39: sub init_env {
   40:     my ($r) = @_;
   41:     
   42:     if (-e $env{'user.environment'}) {
   43: 	return  $env{'user.environment'};
   44:     }
   45:     my $requrl=$r->uri;
   46:     my $handle= &Apache::lonnet::check_for_valid_session($r);
   47:     if ($handle ne '') {
   48: 	return undef;
   49:     }
   50:     my $lonidsdir=$r->dir_config('lonIDsDir');
   51:     &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle);
   52: 
   53:     return $r->dir_config('lonIDsDir')."/$handle.id";
   54: }
   55: 
   56: sub do_redirect {
   57:     my ($r,$url,$only_body,$extra_text) = @_;
   58:     $r->send_http_header;
   59:     my $delay = 0.5;
   60:     if ($only_body) {
   61:         $delay = 0;
   62:     }
   63:     my $start_page = 
   64: 	&Apache::loncommon::start_page('Switching Server ...',undef,
   65: 				       {'redirect'       => [$delay,$url],
   66: 					'only_body'      => $only_body,});
   67:     my $end_page   = &Apache::loncommon::end_page();
   68:     $r->print($start_page.$extra_text.$end_page);
   69:     unless ($env{'user.name'} eq 'public' && ($env{'user.domain'} eq 'public')) {
   70:         $r->register_cleanup(\&flush_course_logs);
   71:     }
   72:     return OK;
   73: }
   74: 
   75: sub balancer_cookieid {
   76:     my ($r,$desthost,$uname,$udom) = @_;
   77:     my @hosts = &Apache::lonnet::current_machine_ids();
   78:     my $newcookieid;
   79:     unless (grep(/^\Q$desthost\E$/,@hosts)) {
   80:         my $balancedir=$r->dir_config('lonBalanceDir');
   81:         $newcookieid = &md5_hex(&md5_hex(time.{}.rand().$$));
   82:         my $cookie = $udom.'_'.$uname.'_'.$newcookieid;
   83:         my $balcookie = "balanceID=$cookie; path=/; HttpOnly;";
   84:         if (open(my $fh,'>',"$balancedir/$cookie.id")) {
   85:             print $fh $desthost;
   86:             close($fh);
   87:             $r->headers_out->add('Set-cookie' => $balcookie);
   88:         }
   89:     }
   90:     return $newcookieid;
   91: }
   92: 
   93: sub flush_course_logs {
   94:     &Apache::lonnet::flushcourselogs();
   95:     return OK;
   96: }
   97: 
   98: sub handler {
   99:     my ($r) = @_;
  100:     
  101:     my $handle=&init_env($r);
  102:     if (!defined($handle)) { return FORBIDDEN; }
  103: 
  104:     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
  105: 				['otherserver','role','origurl','symb']);
  106: 
  107:     my $switch_to=&Apache::lonnet::hostname($env{'form.otherserver'});
  108:     if (! $env{'form.otherserver'}) {
  109: 	$env{'form.otherserver'} =	
  110: 	    &Apache::lonnet::find_existing_session($env{'user.domain'},
  111: 						   $env{'user.name'});
  112: 	if (! $env{'form.otherserver'}) {
  113: 	    $env{'form.otherserver'} = 
  114: 		&Apache::lonnet::spareserver(30000,undef,1);
  115: 	}
  116: 	$switch_to=&Apache::lonnet::hostname($env{'form.otherserver'});
  117:     }
  118: 
  119:     if (!defined($switch_to)) { return FORBIDDEN; }
  120: 
  121:     my $protocol = 'http';
  122:     if ($env{'form.otherserver'}) {
  123:         if ($Apache::lonnet::protocol{$env{'form.otherserver'}} eq 'https') {
  124:             $protocol = $Apache::lonnet::protocol{$env{'form.otherserver'}};
  125:         }
  126:         unless ($env{'form.otherserver'} eq $r->dir_config('lonHostID')) {
  127:             my $alias = &Apache::lonnet::use_proxy_alias($r,$env{'form.otherserver'});
  128:             $switch_to = $alias if ($alias ne '');
  129:         }
  130:     }
  131: 
  132:     if ($env{'user.name'} eq 'public'
  133: 	&& $env{'user.domain'} eq 'public') {
  134: 	my $url = $protocol.'://'.$switch_to.$r->uri;
  135:         unlink($handle);
  136:         #expire the cookie
  137:         my $c = new CGI::Cookie(-name    => 'lonPubID',
  138:                                 -value   => '',
  139:                                 -expires => '-10y',);
  140:         $r->header_out('Set-cookie' => $c);
  141: 	return &do_redirect($r,$url,1)
  142:     }
  143: 
  144:     my $skip_canhost_check = '';
  145:     my $now = time;
  146:     if ($env{'form.role'}) {
  147:         if (!exists($env{'user.role.'.$env{'form.role'}})) {
  148:             delete($env{'form.role'});
  149:         } else {
  150:             my ($start,$end) = split(/\./,$env{'user.role.'.$env{'form.role'}});
  151:             if (($start && $start > $now) || ($end && $end < $now)) {
  152:                 delete($env{'form.role'});
  153:             } elsif ($env{'form.role'} eq 'au./'.$env{'user.domain'}.'/') {
  154:                 if (&Apache::lonnet::homeserver($env{'user.name'},$env{'user.domain'}) eq $env{'form.otherserver'}) {
  155:                     $skip_canhost_check = 1;
  156:                 }
  157:             } elsif ($env{'form.role'} =~ m{^[ac]a\./($match_domain)/($match_username)$}) {
  158:                 my ($audom,$auname) = ($1,$2);
  159:                 if (&Apache::lonnet::homeserver($auname,$audom) eq $env{'form.otherserver'}) {
  160:                     if ((&Apache::lonnet::will_trust('othcoau',$env{'user.domain'},$audom)) &&
  161:                         (&Apache::lonnet::will_trust('coaurem',$audom,$env{'user.domain'}))) {                             
  162:                         $skip_canhost_check = 1;
  163:                     }
  164:                 }
  165:             }
  166:         }
  167:     }
  168: 
  169:     unless ($skip_canhost_check) {
  170:         my $canhost = 1;
  171:         my $uprimary_id = &Apache::lonnet::domain($env{'user.domain'},'primary');
  172:         my $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
  173:         my @intdoms;
  174:         my $internet_names = &Apache::lonnet::get_internet_names($env{'form.otherserver'});
  175:         if (ref($internet_names) eq 'ARRAY') {
  176:             @intdoms = @{$internet_names};
  177:         }
  178:         unless ($uint_dom ne '' && grep(/^\Q$uint_dom\E$/,@intdoms)) {
  179:             my $serverhomeID = &Apache::lonnet::get_server_homeID($switch_to);
  180:             my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
  181:             my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
  182:             my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
  183:             my $remoterev = &Apache::lonnet::get_server_loncaparev($env{'user.domain'},$env{'form.otherserver'});
  184:             $canhost = 
  185:                 &Apache::lonnet::can_host_session($env{'user.domain'},
  186:                                                   $env{'form.otherserver'},
  187:                                                   $remoterev,
  188:                                                   $udomdefaults{'remotesessions'},
  189:                                                   $defdomdefaults{'hostedsessions'});
  190:         }
  191:         unless ($canhost) { return FORBIDDEN; }
  192:     }
  193: 
  194:     #remove session env, and log event
  195:     if (unlink($handle)) {
  196:         if ($env{'user.linkedenv'} ne '') {
  197:             my $lonidsdir=$r->dir_config('lonIDsDir');
  198:             if (($env{'user.linkedenv'} =~ /^[a-f0-9]+_linked$/) &&
  199:                 (-l "$lonidsdir/$env{'user.linkedenv'}.id") &&
  200:                 (readlink("$lonidsdir/$env{'user.linkedenv'}.id") eq $handle)) {
  201:                 unlink("$lonidsdir/$env{'user.linkedenv'}.id");
  202:             }
  203:         }
  204:     }
  205:     my %temp=('switchserver' => $now.':'.$env{'form.otherserver'},
  206: 	      $env{'form.role'});
  207:     &Apache::lonnet::put('email_status',\%temp);
  208:     my $logmsg = "Switch Server to $env{'form.otherserver'}";
  209:     if ($env{'form.role'}) {
  210:         $logmsg .= " with role: $env{'form.role'}";
  211:     } elsif (($env{'form.lti.reqcrs'}) && ($env{'form.lti.reqrole'} eq 'cc')) {
  212:         $logmsg .= " to create new LTI course";
  213:     } elsif ($env{'form.lti.selfenrollrole'}) {
  214:         $logmsg .= " to selfenroll with role: $env{'form.lti.selfenrollrole'}";
  215:     } else {
  216:         $logmsg .= " (no role)";
  217:     }
  218:     my $ip = &Apache::lonnet::get_requestor_ip();
  219:     $logmsg .= ' '.$ip;
  220:     &Apache::lonnet::log($env{'user.domain'},$env{'user.name'},
  221: 			 $env{'user.home'},$logmsg);
  222: 
  223:     &Apache::loncommon::content_type($r,'text/html');
  224: 
  225:     #expire the cookies
  226:     my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
  227:     foreach my $name (keys(%cookies)) {
  228:         next unless ($name =~ /^lon(|S|Link|Pub)ID$/);
  229:         my $c = new CGI::Cookie(-name    => $name,
  230:                                 -value   => '',
  231:                                 -expires => '-10y',);
  232:         $r->headers_out->add('Set-cookie' => $c);
  233:     }
  234:     if ($r->header_only) {
  235: 	$r->send_http_header;
  236: 	return OK;
  237:     }
  238: # -------------------------------------------------------- Menu script and info
  239: 
  240: # ---------------------------------------------------------------- Get handover
  241: 
  242:     my ($is_balancer,$setcookie,$newcookieid,$otherbalcookie,$offloadto,$dom_balancers);
  243:     my $only_body = 0;
  244:     ($is_balancer,undef,$setcookie,$offloadto,$dom_balancers) =
  245:         &Apache::lonnet::check_loadbalancing($env{'user.name'},$env{'user.domain'},'switchserver');
  246:     if ($is_balancer && $setcookie && $env{'form.otherserver'}) {
  247: 
  248:         # Set a balancer cookie unless browser already sent LON-CAPA load balancer
  249:         # cookie which points at the target server
  250:         my ($found_server,$balancer_cookie) = &Apache::lonnet::check_for_balancer_cookie($r,1);
  251: 
  252:         if (($found_server eq $env{'form.otherserver'}) &&
  253:             ($balancer_cookie =~ /^\Q$env{'user.domain'}\E_\Q$env{'user.name'}\E_/)) {
  254:             $only_body = 1;
  255:         } else {
  256:             $newcookieid = &balancer_cookieid($r,$env{'form.otherserver'},
  257:                                               $env{'user.name'},$env{'user.domain'});
  258:         }
  259:     }
  260:     if ((!$is_balancer) && ($env{'request.balancercookie'})) {
  261:         $otherbalcookie = $env{'request.balancercookie'};
  262:     }
  263: 
  264:     my %info=('ip'            => $ip,
  265:               'domain'        => $env{'user.domain'},
  266:               'username'      => $env{'user.name'},
  267:               'home'          => $env{'user.home'},
  268:               'role'          => $env{'form.role'},
  269:               'server'        => $r->dir_config('lonHostID'),
  270:               'balancer'      => $is_balancer,
  271:               'dom_balancers' => $dom_balancers,
  272:               'offloadto'     => '');
  273:     if (ref($offloadto) eq 'HASH') {
  274:         foreach my $key (keys(%{$offloadto})) {
  275:             if (ref($offloadto->{$key}) eq 'ARRAY') {
  276:                 $info{'offloadto'} .= $key.'='.join(',',@{$offloadto->{$key}}).'&';
  277:             }
  278:         }
  279:         $info{'offloadto'} =~ s/\&$//;
  280:     } elsif (ref($offloadto) eq 'ARRAY') {
  281:         $info{'offloadto'} = join(',',@{$offloadto});
  282:     }
  283:     if ($newcookieid) {
  284:         $info{'balcookie'} = $newcookieid;
  285:     } elsif ($otherbalcookie) {
  286:         $info{'otherbalcookie'} = $otherbalcookie;
  287:     }
  288:     if ($env{'form.origurl'}) {
  289:         $info{'origurl'} = $env{'form.origurl'};
  290:     }
  291:     if ($env{'form.symb'}) {
  292:         $info{'symb'} = $env{'form.symb'};
  293:     }
  294:     if ($env{'request.sso.login'}) {
  295: 	$info{'sso.login'} = $env{'request.sso.login'};
  296:     }
  297:     if ($env{'request.sso.reloginserver'}) {
  298:         $info{'sso.reloginserver'} = $env{'request.sso.reloginserver'};
  299:     }
  300:     if ($env{'request.linkprot'}) {
  301:         $info{'linkprot'} = $env{'request.linkprot'};
  302:     }
  303:     if ($env{'request.deeplink.login'}) {
  304:         $info{'deeplink.login'} = $env{'request.deeplink.login'};
  305:         if ($env{'request.linkkey'}) {
  306:             $info{'linkkey'} = $env{'request.linkkey'};
  307:         }
  308:     }
  309:     if ($env{'request.lti.login'}) {
  310:         $info{'lti.login'} = $env{'request.lti.login'};
  311:     }
  312:     if ($env{'request.lti.uri'}) {
  313:         $info{'lti.uri'} = $env{'request.lti.uri'};
  314:     }
  315:     if ($env{'request.lti.reqcrs'}) {
  316:         $info{'lti.reqcrs'} = $env{'request.lti.reqcrs'};
  317:     }
  318:     if ($env{'request.lti.reqrole'}) {
  319:         $info{'lti.reqrole'} = $env{'request.lti.reqrole'};
  320:     }
  321:     if ($env{'request.lti.selfenrollrole'}) {
  322:         $info{'lti.selfenrollrole'} = $env{'request.lti.selfenrollrole'};
  323:     }
  324:     if ($env{'request.lti.sourcecrs'}) {
  325:         $info{'lti.sourcecrs'} = $env{'request.lti.sourcecrs'};
  326:     }
  327:     if ($env{'request.lti.passbackid'}) {
  328:         $info{'lti.passbackid'} = $env{'request.lti.passbackid'};
  329:     }
  330:     if ($env{'request.lti.passbackurl'}) {
  331:         $info{'lti.passbackurl'} = $env{'request.lti.passbackurl'};
  332:     }
  333:     if ($env{'request.lti.rosterid'}) {
  334:         $info{'lti.rosterid'} = $env{'request.lti.rosterid'};
  335:     }
  336:     if ($env{'request.lti.rosterurl'}) {
  337:         $info{'lti.rosterurl'} = $env{'request.lti.rosterurl'};
  338:     }
  339:     if ($env{'request.lti.target'}) {
  340:         $info{'lti.target'} = $env{'request.lti.target'};
  341:     }
  342:     my $token = &Apache::lonnet::tmpput(\%info,$env{'form.otherserver'});
  343:     my $url =$protocol.'://'.$switch_to.'/adm/login?'.
  344: 	'domain='.$env{'user.domain'}.
  345: 	'&amp;username='.$env{'user.name'}.
  346: 	'&amp;token='.$token;
  347: # --------------------------------------------------------------- Screen Output
  348:     return &do_redirect($r, $url, $only_body);
  349: }
  350: 
  351: 1;
  352: __END__
  353: 
  354: 
  355: 
  356: 
  357: 
  358: 
  359: 
  360: 

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