NAME

Apache::lonacc - Cookie Based Access Handler


SYNOPSIS

Invoked (for various locations) by /etc/httpd/conf/srm.conf:

 PerlAccessHandler       Apache::lonacc


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.


HANDLER SUBROUTINE

This routine is called by Apache and mod_perl.


NOTABLE SUBROUTINES

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.
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 $query = $r->args;
    my %form;
    if ($query) {
        my @items = ('role','symb');
        &Apache::loncommon::get_unprocessed_cgi($query,\@items);
        foreach my $item (@items) {
            if (defined($env{'form.'.$item})) {
                $form{$item} = $env{'form.'.$item};
            }
        }
    }
    my $domain = $r->dir_config('lonSSOUserDomain');
    if ($domain eq '') {
        $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 immediately 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
                      );
            foreach my $item ('role','symb') {
                if (exists($form{$item})) {
                    $info{$item} = $form{$item};
                }
            }
            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; if (&Apache::lonnet::is_domainimage($requrl)) { return OK; }

    if ($requrl =~ m{^/res/adm/pages/[^/]+\.(gif|png)$}) {
        return OK;
    }
    my $handle = &Apache::lonnet::check_for_valid_session($r);
    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);
    }

# -------------------------------------------------- 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 =~ m{^/adm/wrapper/ext/}) {
            my $query = $r->args;
            if ($query) {
                my $preserved;
                foreach my $pair (split(/&/,$query)) {
                    my ($name, $value) = split(/=/,$pair);
                    unless ($name eq 'symb') {
                        $preserved .= $pair.'&';
                    }
                }
                $preserved =~ s/\&$//;
                if ($preserved) {
                    $env{'request.external.querystring'} = $preserved;
                }
            }
        }
# -------------------------------------------------------- Load POST parameters
        &Apache::lonacc::get_posted_cgi($r);

# ---------------------------------------------------------------- Check access 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 (($access ne '2') && ($access ne 'F')) { if ($requrl =~ m{^/res/}) { $access = &Apache::lonnet::allowed('bro',$requrl); if ($access ne 'F') { if ($requrl eq '/res/lib/templates/simpleproblem.problem/smpedit') { $access = &Apache::lonnet::allowed('bre','/res/lib/templates/simpleproblem.problem'); if ($access ne 'F') { $env{'user.error.msg'}=``$requrl:bre:1:1:Access Denied''; return HTTP_NOT_ACCEPTABLE; } } else { $env{'user.error.msg'}=``$requrl:bre:1:1:Access Denied''; return HTTP_NOT_ACCEPTABLE; } } } else { $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/blockingstatus/.*$} && $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'}) { &Apache::lonnet::countacc($requrl); $requrl=~/\.(\w+)$/; my $query=$r->args; if ((&Apache::loncommon::fileembstyle($1) eq 'ssi') || ($requrl=~/^\/adm\/.*\/(aboutme|smppg|bulletinboard)(\?|$ )/x) || ($requrl=~/^\/adm\/wrapper\//) || ($requrl=~m|^/adm/coursedocs/showdoc/|) || ($requrl=~m|\.problem/smpedit$|) || ($requrl=~/^\/public\/.*\/syllabus$/) || ($requrl=~/^\/adm\/(viewclasslist|navmaps)$/) || ($requrl=~/^\/adm\/.*\/aboutme\/portfolio(\?|$)/)) { # ------------------------------------- This is serious stuff, get symb and log 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/| || $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)) || (($requrl=~m|(.*)/smpedit$|) && &Apache::lonnet::symbverify($symb,$1)) || (($requrl=~m|(.*/aboutme)/portfolio$|) && &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]); } else { $r->log_reason('Invalid symb for '.$requrl.': '. $symb); $env{'user.error.msg'}= ``$requrl:bre:1:1:Invalid Access''; return HTTP_NOT_ACCEPTABLE; } } else { if ($requrl=~m{^(/adm/.*/aboutme)/portfolio$}) { $requrl = $1; } $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; } if ($symb) { my ($map,$mid,$murl)= &Apache::lonnet::decode_symb($symb); &Apache::lonnet::symblist($map,$murl =>[$murl,$mid], 'last_known' =>[$murl,$mid]); } } $env{'request.symb'}=$symb; &Apache::lonnet::courseacclog($symb); } else { # ------------------------------------------------------- This is other content &Apache::lonnet::courseacclog($requrl); } my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};; my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};; if ($requrl =~ m{^/+uploaded/\Q$cdom\E/\Q$cnum\E/docs/.+\.html?$}) { if (&Apache::lonnet::allowed('mdc',$env{'request.course.id'})) { if ($query) { &Apache::loncommon::get_unprocessed_cgi($query,['forceedit']); if ($env{'form.forceedit'}) { $env{'request.state'} = 'edit'; } } } } } return OK; } # -------------------------------------------- See if this is a public resource 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; return FORBIDDEN; # } else { # --------------------------------------------------------------------- Goodbye # return HTTP_BAD_REQUEST; # } }

1; __END__