--- loncom/auth/lonacc.pm 2005/03/01 00:22:57 1.63 +++ loncom/auth/lonacc.pm 2008/11/29 10:34:30 1.122 @@ -1,7 +1,7 @@ # The LearningOnline Network # Cookie Based Access Handler # -# $Id: lonacc.pm,v 1.63 2005/03/01 00:22:57 albertel Exp $ +# $Id: lonacc.pm,v 1.122 2008/11/29 10:34:30 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -25,18 +25,75 @@ # # http://www.lon-capa.org/ # -# YEAR=1999 -# 5/21/99,5/22,5/29,5/31,6/15,16/11,22/11, -# YEAR=2000 -# 01/06,01/13,05/31,06/01,09/06,09/25,09/28,10/30,11/6, -# 12/25,12/26, -# YEAR=2001 -# 01/06/01,05/28,8/11,9/26,11/29 Gerd Kortemeyer -# YEAR=2002 -# 1/4,2/25 Gerd Kortemeyer -# ### +=head1 NAME + +Apache::lonacc - Cookie Based Access Handler + +=head1 SYNOPSIS + +Invoked (for various locations) by /etc/httpd/conf/srm.conf: + + PerlAccessHandler Apache::lonacc + +=head1 INTRODUCTION + +This module enables cookie based authentication and is used +to control access for many different LON-CAPA URIs. + +Whenever the client sends the cookie back to the server, +this cookie is handled by either lonacc.pm or loncacc.pm +(see srm.conf for what is invoked when). If +the cookie is missing or invalid, the user is re-challenged +for login information. + +This is part of the LearningOnline Network with CAPA project +described at http://www.lon-capa.org. + +=head1 HANDLER SUBROUTINE + +This routine is called by Apache and mod_perl. + +=over 4 + +=item * + +transfer profile into environment + +=item * + +load POST parameters + +=item * + +check access + +=item * + +if allowed, get symb, log, generate course statistics if applicable + +=item * + +otherwise return error + +=item * + +see if public resource + +=item * + +store attempted access + +=back + +=head1 NOTABLE SUBROUTINES + +=over + +=cut + + package Apache::lonacc; use strict; @@ -45,154 +102,431 @@ use Apache::File; use Apache::lonnet; use Apache::loncommon(); use Apache::lonlocal; -use CGI::Cookie(); +use Apache::restrictedaccess(); +use Apache::blockedaccess(); use Fcntl qw(:flock); +use LONCAPA; + +sub cleanup { + my ($r)=@_; + if (! $r->is_initial_req()) { return DECLINED; } + &Apache::lonnet::save_cache(); + &Apache::lontexconvert::jsMath_reset(); + return OK; +} + +sub goodbye { + my ($r)=@_; + &Apache::lonnet::goodbye(); + return DONE; +} + +############################################### + +sub get_posted_cgi { + my ($r,$fields) = @_; + + my $buffer; + if ($r->header_in('Content-length')) { + $r->read($buffer,$r->header_in('Content-length'),0); + } + my $content_type = $r->header_in('Content-type'); + if ($content_type !~ m{^multipart/form-data}) { + my @pairs=split(/&/,$buffer); + my $pair; + foreach $pair (@pairs) { + my ($name,$value) = split(/=/,$pair); + $value =~ tr/+/ /; + $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg; + $name =~ tr/+/ /; + $name =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg; + if (ref($fields) eq 'ARRAY') { + next if (!grep(/^\Q$name\E$/,@{$fields})); + } + &Apache::loncommon::add_to_env("form.$name",$value); + } + } else { + my ($contentsep) = ($content_type =~ /boundary=\"?([^\";,]+)\"?/); + my @lines = split (/\n/,$buffer); + my $name=''; + my $value=''; + my $fname=''; + my $fmime=''; + my $i; + for ($i=0;$i<=$#lines;$i++) { + if ($lines[$i]=~/^--\Q$contentsep\E/) { + if ($name) { + chomp($value); + if (ref($fields) eq 'ARRAY') { + next if (!grep(/^\Q$name\E$/,@{$fields})); + } + if ($fname) { + if ($env{'form.symb'} ne '') { + my $size = (length($value))/(1024.0 * 1024.0); + if (&upload_size_allowed($name,$size,$fname) eq 'ok') { + $env{"form.$name.filename"}=$fname; + $env{"form.$name.mimetype"}=$fmime; + &Apache::loncommon::add_to_env("form.$name",$value); + } + } else { + $env{"form.$name.filename"}=$fname; + $env{"form.$name.mimetype"}=$fmime; + &Apache::loncommon::add_to_env("form.$name",$value); + } + } else { + $value=~s/\s+$//s; + &Apache::loncommon::add_to_env("form.$name",$value); + } + } + if ($i<$#lines) { + $i++; + $lines[$i]=~ + /Content\-Disposition\:\s*form\-data\;\s*name\=\"([^\"]+)\"/i; + $name=$1; + $value=''; + if ($lines[$i]=~/filename\=\"([^\"]+)\"/i) { + $fname=$1; + if + ($lines[$i+1]=~/Content\-Type\:\s*([\w\-\/]+)/i) { + $fmime=$1; + $i++; + } else { + $fmime=''; + } + } else { + $fname=''; + $fmime=''; + } + $i++; + } + } else { + $value.=$lines[$i]."\n"; + } + } + } +# +# Digested POSTed values +# +# Remember the way this was originally done (GET or POST) +# + $env{'request.method'}=$ENV{'REQUEST_METHOD'}; +# +# There may also be stuff in the query string +# Tell subsequent handlers that this was GET, not POST, so they can access query string. +# Also, unset POSTed content length to cover all tracks. +# + + $r->method_number(M_GET); + + $r->method('GET'); + $r->headers_in->unset('Content-length'); +} + +=pod + +=item upload_size_allowed() + + Perform size checks for file uploads to essayresponse items in course context. + + Add form.HWFILESIZE.$part_$id to %env with file size (MB) + If file exceeds maximum allowed size, add form.HWFILETOOBIG.$part_$id to %env. + +=cut + +sub upload_size_allowed { + my ($name,$size,$fname) = @_; + if ($name =~ /^HWFILE(\w+)$/) { + my $ident = $1; + my $item = 'HWFILESIZE'.$ident; + my $savesize = sprintf("%.6f",$size); + &Apache::loncommon::add_to_env("form.$item",$savesize); + my $maxsize= &Apache::lonnet::EXT("resource.$ident.maxfilesize"); + if (!$maxsize) { + $maxsize = 100.0; + } + if ($size > $maxsize) { + my $warn = 'HWFILETOOBIG'.$ident; + &Apache::loncommon::add_to_env("form.$warn",$fname); + return; + } + } + return 'ok'; +} + +=pod + +=item sso_login() + + handle the case of the single sign on user, at this point $r->user + will be set and valid now need to find the loncapa user info and possibly + balance them + returns OK if it was a SSO and user was handled + undef if not SSO or no means to hanle the user + +=cut + +sub sso_login { + my ($r,$handle) = @_; + + my $lonidsdir=$r->dir_config('lonIDsDir'); + if (!($r->user + && (!defined($env{'user.name'}) && !defined($env{'user.domain'})) + && ($handle eq ''))) { + # not an SSO case or already logged in + return undef; + } + + my ($user) = ($r->user =~ m/([a-zA-Z0-9_\-@.]*)/); + + my $domain = $r->dir_config('lonDefDomain'); + my $home=&Apache::lonnet::homeserver($user,$domain); + if ($home !~ /(con_lost|no_host|no_such_host)/) { + &Apache::lonnet::logthis(" SSO authorized user $user "); + if ($r->dir_config("lonBalancer") eq 'yes') { + # login but immeaditly go to switch server to find us a new + # machine + &Apache::lonauth::success($r,$user,$domain,$home,'noredirect'); + $env{'request.sso.login'} = 1; + if (defined($r->dir_config("lonSSOReloginServer"))) { + $env{'request.sso.reloginserver'} = + $r->dir_config('lonSSOReloginServer'); + } + $r->internal_redirect('/adm/switchserver'); + $r->set_handlers('PerlHandler'=> undef); + } else { + # need to login them in, so generate the need data that + # migrate expects to do login + my %info=('ip' => $r->connection->remote_ip(), + 'domain' => $domain, + 'username' => $user, + 'server' => $r->dir_config('lonHostID'), + 'sso.login' => 1 + ); + if ($r->dir_config("ssodirecturl") == 1) { + $info{'origurl'} = $r->uri; + } + if (defined($r->dir_config("lonSSOReloginServer"))) { + $info{'sso.reloginserver'} = + $r->dir_config('lonSSOReloginServer'); + } + my $token = + &Apache::lonnet::tmpput(\%info, + $r->dir_config('lonHostID')); + $env{'form.token'} = $token; + $r->internal_redirect('/adm/migrateuser'); + $r->set_handlers('PerlHandler'=> undef); + } + return OK; + } elsif (defined($r->dir_config('lonSSOUserUnknownRedirect'))) { + &Apache::lonnet::logthis(" SSO authorized unknown user $user "); + $r->subprocess_env->set('SSOUserUnknown' => $user); + $r->subprocess_env->set('SSOUserDomain' => $domain); + my @cancreate; + my %domconfig = + &Apache::lonnet::get_dom('configuration',['usercreation'],$domain); + if (ref($domconfig{'usercreation'}) eq 'HASH') { + if (ref($domconfig{'usercreation'}{'cancreate'}) eq 'HASH') { + if (ref($domconfig{'usercreation'}{'cancreate'}{'selfcreate'}) eq 'ARRAY') { + @cancreate = @{$domconfig{'usercreation'}{'cancreate'}{'selfcreate'}}; + } elsif (($domconfig{'usercreation'}{'cancreate'}{'selfcreate'} ne 'none') && + ($domconfig{'usercreation'}{'cancreate'}{'selfcreate'} ne '')) { + @cancreate = ($domconfig{'usercreation'}{'cancreate'}{'selfcreate'}); + } + } + } + if (grep(/^sso$/,@cancreate)) { + $r->internal_redirect('/adm/createaccount'); + } else { + $r->internal_redirect($r->dir_config('lonSSOUserUnknownRedirect')); + } + $r->set_handlers('PerlHandler'=> undef); + return OK; + } + return undef; +} sub handler { my $r = shift; my $requrl=$r->uri; - my %cookies=CGI::Cookie->parse($r->header_in('Cookie')); - my $lonid=$cookies{'lonID'}; - my $cookie; - if ($lonid) { - my $handle=$lonid->value; - $handle=~s/\W//g; - my $lonidsdir=$r->dir_config('lonIDsDir'); - if ((-e "$lonidsdir/$handle.id") && ($handle ne '')) { + if (&Apache::lonnet::is_domainimage($requrl)) { + return OK; + } -# ------------------------------------------------------ Initialize Environment + my $handle = &Apache::lonnet::check_for_valid_session($r); - &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle); + my $result = &sso_login($r,$handle); + if (defined($result)) { + return $result; + } + + + if ($r->dir_config("lonBalancer") eq 'yes') { + $r->set_handlers('PerlResponseHandler'=> + [\&Apache::switchserver::handler]); + } + + if ($handle eq '') { + $r->log_reason("Cookie $handle not valid", $r->filename); + } elsif ($handle ne '') { + +# ------------------------------------------------------ Initialize Environment + my $lonidsdir=$r->dir_config('lonIDsDir'); + &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle); # --------------------------------------------------------- Initialize Language - &Apache::lonlocal::get_language_handle($r); + &Apache::lonlocal::get_language_handle($r); + + } +# -------------------------------------------------- Should be a valid user now + if ($env{'user.name'} ne '' && $env{'user.domain'} ne '') { # -------------------------------------------------------------- Resource State - if ($requrl=~/^\/+(res|uploaded)\//) { - $ENV{'request.state'} = "published"; - } else { - $ENV{'request.state'} = 'unknown'; - } - $ENV{'request.filename'} = $r->filename; - $ENV{'request.noversionuri'} = &Apache::lonnet::deversion($requrl); + if ($requrl=~/^\/+(res|uploaded)\//) { + $env{'request.state'} = "published"; + } else { + $env{'request.state'} = 'unknown'; + } + $env{'request.filename'} = $r->filename; + $env{'request.noversionuri'} = &Apache::lonnet::deversion($requrl); # -------------------------------------------------------- Load POST parameters - &Apache::loncommon::get_posted_cgi($r); + &Apache::lonacc::get_posted_cgi($r); # ---------------------------------------------------------------- Check access - - if ($requrl!~/^\/adm|public|prtspool\//) { - my $access=&Apache::lonnet::allowed('bre',$requrl); - if ($access eq '1') { - $ENV{'user.error.msg'}="$requrl:bre:0:0:Choose Course"; - return HTTP_NOT_ACCEPTABLE; - } - if (($access ne '2') && ($access ne 'F')) { - $ENV{'user.error.msg'}="$requrl:bre:1:1:Access Denied"; - return HTTP_NOT_ACCEPTABLE; - } + my $now = time; + if ($requrl !~ m{^/(?:adm|public|prtspool)/} + || $requrl =~ /^\/adm\/.*\/(smppg|bulletinboard)(\?|$ )/x) { + my $access=&Apache::lonnet::allowed('bre',$requrl); + if ($access eq '1') { + $env{'user.error.msg'}="$requrl:bre:0:0:Choose Course"; + return HTTP_NOT_ACCEPTABLE; + } + if ($access eq 'A') { + &Apache::restrictedaccess::setup_handler($r); + return OK; + } + if ($access eq 'B') { + &Apache::blockedaccess::setup_handler($r); + return OK; } - if ($requrl =~ m|^/prtspool/|) { - my $start='/prtspool/'.$ENV{'user.name'}.'_'. - $ENV{'user.domain'}; - if ($requrl !~ /^\Q$start\E/) { - $ENV{'user.error.msg'}="$requrl:bre:1:1:Access Denied"; - return HTTP_NOT_ACCEPTABLE; - } + if (($access ne '2') && ($access ne 'F')) { + $env{'user.error.msg'}="$requrl:bre:1:1:Access Denied"; + return HTTP_NOT_ACCEPTABLE; + } + } + if ($requrl =~ m|^/prtspool/|) { + my $start='/prtspool/'.$env{'user.name'}.'_'. + $env{'user.domain'}; + if ($requrl !~ /^\Q$start\E/) { + $env{'user.error.msg'}="$requrl:bre:1:1:Access Denied"; + return HTTP_NOT_ACCEPTABLE; + } + } + if ($requrl =~ m|^/zipspool/|) { + my $start='/zipspool/zipout/'.$env{'user.name'}.":". + $env{'user.domain'}; + if ($requrl !~ /^\Q$start\E/) { + $env{'user.error.msg'}="$requrl:bre:1:1:Access Denied"; + return HTTP_NOT_ACCEPTABLE; } + } + if ($env{'user.name'} eq 'public' && + $env{'user.domain'} eq 'public' && + $requrl !~ m{^/+(res|public|uploaded)/} && + $requrl !~ m{^/adm/[^/]+/[^/]+/aboutme/portfolio$ }x && + $requrl !~ m{^/+adm/(help|logout|restrictedaccess|randomlabel\.png)}) { + $env{'request.querystring'}=$r->args; + $env{'request.firsturl'}=$requrl; + return FORBIDDEN; + } # ------------------------------------------------------------- This is allowed - if ($ENV{'request.course.id'}) { + if ($env{'request.course.id'}) { &Apache::lonnet::countacc($requrl); - $requrl=~/\.(\w+)$/; - if ((&Apache::loncommon::fileembstyle($1) eq 'ssi') || - ($requrl=~/^\/adm\/.*\/(aboutme|navmaps|smppg|bulletinboard)(\?|$)/) || - ($requrl=~/^\/adm\/wrapper\//) || - ($requrl=~m|\.problem/smpedit$|) || - ($requrl=~/^\/public\/.*\/syllabus$/)) { + $requrl=~/\.(\w+)$/; + if ((&Apache::loncommon::fileembstyle($1) eq 'ssi') || + ($requrl=~/^\/adm\/.*\/(aboutme|navmaps|smppg|bulletinboard)(\?|$ )/x) || + ($requrl=~/^\/adm\/wrapper\//) || + ($requrl=~m|^/adm/coursedocs/showdoc/|) || + ($requrl=~m|\.problem/smpedit$|) || + ($requrl=~/^\/public\/.*\/syllabus$/)) { # ------------------------------------- This is serious stuff, get symb and log my $query=$r->args; - my $symb; - if ($query) { + my $symb; + if ($query) { &Apache::loncommon::get_unprocessed_cgi($query,['symb']); - } - if ($ENV{'form.symb'}) { - $symb=&Apache::lonnet::symbclean($ENV{'form.symb'}); - if ($requrl =~ m|^/adm/wrapper/|) { - my ($map,$mid,$murl)=&Apache::lonnet::decode_symb($symb); - &Apache::lonnet::symblist($map,$murl => [$murl,$mid], + } + if ($env{'form.symb'}) { + $symb=&Apache::lonnet::symbclean($env{'form.symb'}); + if ($requrl =~ m|^/adm/wrapper/| + || $requrl =~ m|^/adm/coursedocs/showdoc/|) { + my ($map,$mid,$murl)=&Apache::lonnet::decode_symb($symb); + &Apache::lonnet::symblist($map,$murl => [$murl,$mid], 'last_known' =>[$murl,$mid]); - } elsif ((&Apache::lonnet::symbverify($symb,$requrl)) || + } elsif ((&Apache::lonnet::symbverify($symb,$requrl)) || (($requrl=~m|(.*)/smpedit$|) && &Apache::lonnet::symbverify($symb,$1))) { - my ($map,$mid,$murl)=&Apache::lonnet::decode_symb($symb); - &Apache::lonnet::symblist($map,$murl => [$murl,$mid], - 'last_known' =>[$murl,$mid]); + my ($map,$mid,$murl)=&Apache::lonnet::decode_symb($symb); + &Apache::lonnet::symblist($map,$murl => [$murl,$mid], + 'last_known' =>[$murl,$mid]); } else { $r->log_reason('Invalid symb for '.$requrl.': '. - $symb); - $ENV{'user.error.msg'}= - "$requrl:bre:1:1:Invalid Access"; - return HTTP_NOT_ACCEPTABLE; - } - } else { - $symb=&Apache::lonnet::symbread($requrl); + $symb); + $env{'user.error.msg'}= + "$requrl:bre:1:1:Invalid Access"; + return HTTP_NOT_ACCEPTABLE; + } + } else { + $symb=&Apache::lonnet::symbread($requrl); if (&Apache::lonnet::is_on_map($requrl) && $symb && !&Apache::lonnet::symbverify($symb,$requrl)) { $r->log_reason('Invalid symb for '.$requrl.': '.$symb); - $ENV{'user.error.msg'}= - "$requrl:bre:1:1:Invalid Access"; - return HTTP_NOT_ACCEPTABLE; + $env{'user.error.msg'}= + "$requrl:bre:1:1:Invalid Access"; + return HTTP_NOT_ACCEPTABLE; } if ($symb) { - my ($map,$mid,$murl)=split(/\_\_\_/,$symb); + my ($map,$mid,$murl)= + &Apache::lonnet::decode_symb($symb); &Apache::lonnet::symblist($map,$murl =>[$murl,$mid], - 'last_known' =>[$murl,$mid]); + 'last_known' =>[$murl,$mid]); } - } - $ENV{'request.symb'}=$symb; - &Apache::lonnet::courseacclog($symb); - } else { + } + $env{'request.symb'}=$symb; + &Apache::lonnet::courseacclog($symb); + } else { # ------------------------------------------------------- This is other content - &Apache::lonnet::courseacclog($requrl); - } - } - return OK; - } else { - $r->log_reason("Cookie $handle not valid", $r->filename) - }; + &Apache::lonnet::courseacclog($requrl); + } + } + return OK; } - # -------------------------------------------- See if this is a public resource - if ($requrl=~m|^/public/| - || (&Apache::lonnet::metadata($requrl,'copyright') eq 'public')) { - &Apache::lonnet::logthis('Granting public access: '.$requrl); - &Apache::loncommon::get_posted_cgi($r); - $ENV{'user.name'}='public'; - $ENV{'user.domain'}='public'; - $ENV{'request.state'} = "published"; - $ENV{'request.publicaccess'} = 1; - $ENV{'request.filename'} = $r->filename; - my ($httpbrowser, $clientbrowser, $clientversion, - $clientmathml, $clientunicode, $clientos) = - &Apache::loncommon::decode_user_agent($r); - $ENV{'browser.type'}=$clientbrowser; - $ENV{'browser.version'}=$clientversion; - $ENV{'browser.mathml'}=$clientmathml; - $ENV{'browser.unicode'}=$clientunicode; - $ENV{'browser.os'}=$clientos; - - return OK; + if ($requrl=~m|^/+adm/+help/+|) { + return OK; + } +# ------------------------------------ See if this is a viewable portfolio file + if (&Apache::lonnet::is_portfolio_url($requrl)) { + my $access=&Apache::lonnet::allowed('bre',$requrl); + if ($access eq 'A') { + &Apache::restrictedaccess::setup_handler($r); + return OK; + } + if (($access ne '2') && ($access ne 'F')) { + $env{'user.error.msg'}="$requrl:bre:1:1:Access Denied"; + return HTTP_NOT_ACCEPTABLE; + } } + # -------------------------------------------------------------- Not authorized $requrl=~/\.(\w+)$/; # if ((&Apache::loncommon::fileembstyle($1) eq 'ssi') || # ($requrl=~/^\/adm\/(roles|logout|email|menu|remote)/) || # ($requrl=~m|^/prtspool/|)) { # -------------------------- Store where they wanted to go and get login screen - $ENV{'request.querystring'}=$r->args; - $ENV{'request.firsturl'}=$requrl; + $env{'request.querystring'}=$r->args; + $env{'request.firsturl'}=$requrl; return FORBIDDEN; # } else { # --------------------------------------------------------------------- Goodbye @@ -203,64 +537,9 @@ sub handler { 1; __END__ -=head1 NAME - -Apache::lonacc - Cookie Based Access Handler - -=head1 SYNOPSIS - -Invoked (for various locations) by /etc/httpd/conf/srm.conf: - - PerlAccessHandler Apache::lonacc - -=head1 INTRODUCTION - -This module enables cookie based authentication and is used -to control access for many different LON-CAPA URIs. - -Whenever the client sends the cookie back to the server, -this cookie is handled by either lonacc.pm or loncacc.pm -(see srm.conf for what is invoked when). If -the cookie is missing or invalid, the user is re-challenged -for login information. - -This is part of the LearningOnline Network with CAPA project -described at http://www.lon-capa.org. - -=head1 HANDLER SUBROUTINE - -This routine is called by Apache and mod_perl. - -=over 4 - -=item * - -transfer profile into environment - -=item * - -load POST parameters - -=item * - -check access - -=item * - -if allowed, get symb, log, generate course statistics if applicable - -=item * - -otherwise return error - -=item * - -see if public resource - -=item * - -store attempted access +=pod =back =cut +