--- loncom/auth/loncacc.pm 2007/10/02 01:09:59 1.46 +++ loncom/auth/loncacc.pm 2008/11/12 20:01:09 1.47 @@ -2,7 +2,7 @@ # Cookie Based Access Handler for Construction Area # (lonacc: 5/21/99,5/22,5/29,5/31 Gerd Kortemeyer) # -# $Id: loncacc.pm,v 1.46 2007/10/02 01:09:59 albertel Exp $ +# $Id: loncacc.pm,v 1.47 2008/11/12 20:01:09 jms Exp $ # # Copyright Michigan State University Board of Trustees # @@ -27,6 +27,65 @@ # http://www.lon-capa.org/ # +=pod + +=head1 NAME + +Apache::lonacc - Cookie Based Access Handler for Construction Area + +=head1 SYNOPSIS + +Invoked (for various locations) by /etc/httpd/conf/loncapa_apache.conf: + + PerlAccessHandler Apache::loncacc + +=head1 INTRODUCTION + +This module enables cookie based authentication for construction area +and is used to control access for three (essentially equivalent) URIs. + + + + + +Whenever the client sends the cookie back to the server, +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 * + +load POST parameters + +=item * + +store where they wanted to go (first url entered) + +=back + +=head1 OTHERSUBROUTINES + +=over 4 + +=item * + +constructaccess($url,$ownerdomain) : See if the owner domain and name +in the URL match those in the expected environment. If so, return +two element list ($ownername,$ownerdomain). Else, return null string. + +=back + +=cut + + package Apache::loncacc; use strict; @@ -105,61 +164,6 @@ sub handler { 1; __END__ -=head1 NAME - -Apache::lonacc - Cookie Based Access Handler for Construction Area - -=head1 SYNOPSIS - -Invoked (for various locations) by /etc/httpd/conf/loncapa_apache.conf: - - PerlAccessHandler Apache::loncacc - -=head1 INTRODUCTION - -This module enables cookie based authentication for construction area -and is used to control access for three (essentially equivalent) URIs. - - - - - -Whenever the client sends the cookie back to the server, -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 * - -load POST parameters - -=item * - -store where they wanted to go (first url entered) - -=back - -=head1 OTHERSUBROUTINES - -=over 4 - -=item * - -constructaccess($url,$ownerdomain) : See if the owner domain and name -in the URL match those in the expected environment. If so, return -two element list ($ownername,$ownerdomain). Else, return null string. - -=back - -=cut