Return to loncacc.pm CVS log

Up to [LON-CAPA] / loncom / auth

Added/Converted POD comments

    1: # The LearningOnline Network
    2: # Cookie Based Access Handler for Construction Area
    3: # (lonacc: 5/21/99,5/22,5/29,5/31 Gerd Kortemeyer)
    4: #
    5: # $Id: loncacc.pm,v 1.48 2008/11/19 17:38:21 jms Exp $
    6: #
    7: # Copyright Michigan State University Board of Trustees
    8: #
    9: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
   10: #
   11: # LON-CAPA is free software; you can redistribute it and/or modify
   12: # it under the terms of the GNU General Public License as published by
   13: # the Free Software Foundation; either version 2 of the License, or
   14: # (at your option) any later version.
   15: #
   16: # LON-CAPA is distributed in the hope that it will be useful,
   17: # but WITHOUT ANY WARRANTY; without even the implied warranty of
   18: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   19: # GNU General Public License for more details.
   20: #
   21: # You should have received a copy of the GNU General Public License
   22: # along with LON-CAPA; if not, write to the Free Software
   23: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   24: #
   25: # /home/httpd/html/adm/gpl.txt
   26: #
   27: # http://www.lon-capa.org/
   28: #
   29: 
   30: =pod
   31: 
   32: =head1 NAME
   33: 
   34: Apache::lonacc - Cookie Based Access Handler for Construction Area
   35: 
   36: =head1 SYNOPSIS
   37: 
   38: Invoked (for various locations) by /etc/httpd/conf/loncapa_apache.conf:
   39: 
   40:  PerlAccessHandler       Apache::loncacc
   41: 
   42: =head1 INTRODUCTION
   43: 
   44: This module enables cookie based authentication for construction area
   45: and is used to control access for three (essentially equivalent) URIs.
   46: 
   47:  <LocationMatch "^/priv.*">
   48:  <LocationMatch "^/\~.*">
   49:  <LocationMatch "^/\~.*/$">
   50: 
   51: Whenever the client sends the cookie back to the server, 
   52: if the cookie is missing or invalid, the user is re-challenged
   53: for login information.
   54: 
   55: This is part of the LearningOnline Network with CAPA project
   56: described at http://www.lon-capa.org.
   57: 
   58: =head1 HANDLER SUBROUTINE
   59: 
   60: This routine is called by Apache and mod_perl.
   61: 
   62: =over 4
   63: 
   64: =item *
   65: 
   66: load POST parameters
   67: 
   68: =item *
   69: 
   70: store where they wanted to go (first url entered)
   71: 
   72: =back
   73: 
   74: =head1 OTHERSUBROUTINES
   75: 
   76: =over
   77: 
   78: =item constructaccess($url,$ownerdomain)
   79: 
   80: See if the owner domain and name
   81: in the URL match those in the expected environment.  If so, return 
   82: two element list ($ownername,$ownerdomain).  Else, return null string.
   83: 
   84: =back
   85: 
   86: =cut
   87: 
   88: 
   89: package Apache::loncacc;
   90: 
   91: use strict;
   92: use Apache::Constants qw(:common :http :methods REDIRECT);
   93: use Fcntl qw(:flock);
   94: use Apache::lonlocal;
   95: use Apache::lonnet;
   96: use Apache::lonacc;
   97: use LONCAPA qw(:DEFAULT :match);
   98: 
   99: sub constructaccess {
  100:     my ($url,$ownerdomain)=@_;
  101:     my ($ownername)=($url=~/\/(?:\~|priv\/|home\/)($match_username)\//);
  102:     unless (($ownername) && ($ownerdomain)) { return ''; }
  103:     # We do not allow editing of previous versions of files.
  104:     if ($url=~/\.(\d+)\.(\w+)$/) { return ''; }
  105:     my @possibledomains = &Apache::lonnet::current_machine_domains();
  106:     if ($ownername eq $env{'user.name'}) {
  107: 	foreach my $domain (@possibledomains) {
  108: 	    if ($domain eq $env{'user.domain'}) {
  109: 		return ($ownername,$domain);
  110: 	    }
  111: 	}
  112:     }
  113:     
  114:     foreach my $domain (@possibledomains) {
  115: 	if (exists($env{'user.priv.ca./'.$domain.'/'.$ownername.'./'}) ||
  116: 	    exists($env{'user.priv.aa./'.$domain.'/'.$ownername.'./'}) ) {
  117: 	    return ($ownername,$domain);
  118: 	}
  119:     }
  120:     return '';
  121: }
  122: 
  123: sub handler {
  124:     my $r = shift;
  125:     my $requrl=$r->uri;
  126:     $env{'request.editurl'}=$requrl;
  127: 
  128:     my $handle =  &Apache::lonnet::check_for_valid_session($r);
  129:     if ($handle ne '') {
  130: 
  131: # ------------------------------------------------------ Initialize Environment
  132:         my $lonidsdir=$r->dir_config('lonIDsDir');
  133: 	&Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle);
  134: 
  135: # --------------------------------------------------------- Initialize Language
  136:  
  137: 	&Apache::lonlocal::get_language_handle($r);
  138: 
  139: # -------------------------------------------------------------- Resource State
  140: 
  141: 	$env{'request.state'}    = "construct";
  142: 	$env{'request.filename'} = $r->filename;
  143: 
  144: 	unless (&constructaccess($requrl,$r->dir_config('lonDefDomain'))) {
  145: 	    $r->log_reason("Unauthorized $requrl", $r->filename); 
  146: 	    return HTTP_NOT_ACCEPTABLE;
  147: 	}
  148: 
  149: # -------------------------------------------------------- Load POST parameters
  150: 
  151: 	&Apache::lonacc::get_posted_cgi($r);
  152: 
  153: 	return OK; 
  154:     } else { 
  155: 	$r->log_reason("Cookie $handle not valid", $r->filename) 
  156:     }
  157: 
  158: # ----------------------------------------------- Store where they wanted to go
  159: 
  160:     $env{'request.firsturl'}=$requrl;
  161:     return FORBIDDEN;
  162: }
  163: 
  164: 1;
  165: __END__
  166: 
  167: 
  168: 
  169: 
  170: 
  171: 
  172: 
  173: