.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Apache2::AuthCASSimple 3pm"
.TH Apache2::AuthCASSimple 3pm "2022-06-06" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Apache2::AuthCASSimple \- Apache2 module to authentificate through a CAS server
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Apache2::AuthCASSimple is an authentication module for Apache2/mod_perl2. It allow you to authentificate users through a Yale \s-1CAS\s0 server. It means you don't need to give login/password if you've already be authentificate by the \s-1CAS\s0 server, only tickets are exchanged between Web client, Apache2 server and \s-1CAS\s0 server. If you not're authentificate yet, you'll be redirect on the \s-1CAS\s0 server login form.
.PP
This module allow the use of simple text files for sessions.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  PerlOptions +GlobalRequest
\&
\&  <Location /protected>
\&    AuthType Apache2::AuthCASSimple
\&    PerlAuthenHandler Apache2::AuthCASSimple
\&
\&    PerlSetVar CASServerName my.casserver.com
\&    PerlSetVar CASServerPath /
\&    # PerlSetVar CASServerPort 443
\&    # PerlSetVar CASServerNoSSL 1
\&    PerlSetVar CASSessionTimeout 3660
\&    PerlSetVar CASSessionDirectory /tmp
\&    # PerlSetVar CASFixDirectory /
\&    # PerlSetVar ModProxy 1
\&    # PerlSetVar HTTPSServer 1
\&
\&    require valid\-user
\&  </Location>
.Ve
.PP
or
.PP
.Vb 2
\&  order deny,allow
\&  deny from all
\&
\&  require user xxx yyyy
\&
\&  satisfy any
.Ve
.SH "CONFIGURATION"
.IX Header "CONFIGURATION"
.IP "CASServerName" 4
.IX Item "CASServerName"
Name of the \s-1CAS\s0 server. It can be a numeric \s-1IP\s0 address.
.IP "CASServerPort" 4
.IX Item "CASServerPort"
Port of the \s-1CAS\s0 server. Default is 443.
.IP "CASServerPath" 4
.IX Item "CASServerPath"
Path (\s-1URI\s0) of the \s-1CAS\s0 server. Default is \*(L"/cas\*(R".
.IP "CASServerNoSSL" 4
.IX Item "CASServerNoSSL"
Disable \s-1SSL\s0 transaction wih \s-1CAS\s0 server (\s-1HTTPS\s0). Default is off.
.IP "CASCaFile" 4
.IX Item "CASCaFile"
\&\s-1CAS\s0 server public key. This file is used to allow secure connection
between the webserver using Apache2::AuthCASSimple and the \s-1CAS\s0 server.
.Sp
\&\s-1DEPRECATED :\s0 Authen::CAS::Client use LWP::UserAgent to make https requests
.IP "CASSessionTimeout" 4
.IX Item "CASSessionTimeout"
Timeout (in second) for session create by Apache2::AuthCASSimple (to avoid \s-1CAS\s0 server overloading). Default is 60.
.Sp
\&\-1 means disable.
.Sp
0 mean infinite (until the user close browser).
.IP "CASSessionDirectory" 4
.IX Item "CASSessionDirectory"
Directory where session data are stored. Default is /tmp.
.IP "CASFixDirectory" 4
.IX Item "CASFixDirectory"
Force the path of the session cookie for same policy in all subdirectories else current directory is used.
.IP "ModProxy" 4
.IX Item "ModProxy"
Apache2 mod_perl2 don't be use with mod_proxy. Default is off.
.IP "HTTPSServer" 4
.IX Item "HTTPSServer"
If you want to keep a \s-1HTTPS\s0 server for all data. Default is 0.
.IP "\s-1OK AUTH_REQUIRED DECLINED REDIRECT SERVER_ERROR M_GET\s0" 4
.IX Item "OK AUTH_REQUIRED DECLINED REDIRECT SERVER_ERROR M_GET"
Apache constants to make pod coverage happy
.SH "METHOD"
.IX Header "METHOD"
.SS "handler"
.IX Subsection "handler"
call by apache2
.SH "VERSION"
.IX Header "VERSION"
This documentation describes Apache2::AuthCASSimple version 0.10
.SH "BUGS AND TROUBLESHOOTING"
.IX Header "BUGS AND TROUBLESHOOTING"
.IP "\(bu" 4
Old expired sessions files must be deleted with an example provided script : \f(CW\*(C`delete_session_data.pl\*(C'\fR
.IP "\(bu" 4
Apache::Session::Wrapper certainly need Apache2::Cookie
.IP "\(bu" 4
\&\f(CW$r\fR must be global for sessions with Apache::Session::Wrapper, add
.Sp
.Vb 1
\&  PerlOptions +GlobalRequest
.Ve
.Sp
in your virtualhost conf
.IP "\(bu" 4
Apreq module must be enable in debian
.Sp
.Vb 1
\&  a2enmod apreq
.Ve
.Sp
or add
.Sp
.Vb 1
\&  LoadModule apreq_module /usr/lib/apache2/modules/mod_apreq2.so
.Ve
.Sp
in your apache configuration file
.PP
Please submit any bug reports to agostini@univ\-metz.fr.
.SH "NOTES"
.IX Header "NOTES"
Requires \f(CW\*(C`mod_perl 2\*(C'\fR version 2.02 or later
Requires Authen::CAS::Client
Requires Apache::Session::Wrapper
.SH "AUTHOR"
.IX Header "AUTHOR"
.Vb 5
\&    Yves Agostini
\&    CPAN ID: YVESAGO
\&    Univ Metz
\&    agostini@univ\-metz.fr
\&    http://www.crium.univ\-metz.fr
.Ve
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2009 by Yves Agostini
.PP
This program is free software; you can redistribute
it and/or modify it under the same terms as Perl itself.
.PP
The full text of the license can be found in the
\&\s-1LICENSE\s0 file included with this module.