| 1 |
Installation |
| 2 |
============ |
| 3 |
|
| 4 |
Requires: an apache with DSO support, either 1.3.x, 2.0.x, or 2.2.x. |
| 5 |
|
| 6 |
$ ./configure --apxs=/path/to/apxs |
| 7 |
$ make |
| 8 |
$ make test # (can take a while due to timeout tests) |
| 9 |
# make install |
| 10 |
|
| 11 |
(Or install from the RPMs for RHEL/CentOS 4/5). |
| 12 |
|
| 13 |
|
| 14 |
|
| 15 |
Basic Configuration |
| 16 |
------------------- |
| 17 |
|
| 18 |
1. Copy conf/02_auth_tkt.conf to an apache conf include directory like |
| 19 |
/etc/httpd/conf.d (or include explicitly from your httpd.conf), |
| 20 |
and edit, UPDATING THE SHARED SECRET BEFORE YOU USE. |
| 21 |
|
| 22 |
|
| 23 |
2. If you want to use the standard mod_auth_tkt CGI scripts, copy the |
| 24 |
conf/auth_tkt_cgi.conf config to your apache conf include directory |
| 25 |
as well (e.g. /etc/httpd/conf.d), and edit. You must uncomment one |
| 26 |
of the three /var/www/auth sections there, depending on whether you |
| 27 |
want to use mod_perl 2, mod_perl 1, or vanilla CGI. The mod_perl 2 |
| 28 |
version is recommended if you have it. |
| 29 |
|
| 30 |
|
| 31 |
3. Set up your login pages. If you want to use the supplied CGI scripts, |
| 32 |
copy the files in the 'cgi' directory somewhere useful e.g. |
| 33 |
|
| 34 |
cp -rp cgi /var/www/auth |
| 35 |
|
| 36 |
CGI scripts are available in /usr/share/doc/mod_auth_tkt-<version>/cgi |
| 37 |
when using the RPM, to copy somewhere manually, or you can install the |
| 38 |
mod_auth_tkt-cgi package: |
| 39 |
|
| 40 |
# Installs to /var/www/auth by default |
| 41 |
rpm -Uvh mod_auth_tkt-cgi |
| 42 |
# Install somewhere else |
| 43 |
rpm -Uvh --prefix=/var/www/cgi-bin mod_auth_tkt-cgi |
| 44 |
|
| 45 |
The scripts requires perl and the CGI perl module. You will need to |
| 46 |
edit the /var/www/auth/AuthTktConfig.pm config file to define a |
| 47 |
username/password authentication function against your repository of |
| 48 |
choice (the example one uses a standard apache htpasswd file). You |
| 49 |
can also tweak a few other customisable settings there. |
| 50 |
|
| 51 |
You should also confirm you've uncommented one of the cgi sections in |
| 52 |
the 02_auth_tkt.conf config you installed in (1). |
| 53 |
|
| 54 |
|
| 55 |
3. If you're using mod_auth_tkt on the open internet (rather than on |
| 56 |
a private network) you should probably set 'TKTAuthIgnoreIP on', at |
| 57 |
least initially. This avoids a whole class of weird problems that |
| 58 |
aren't necessarily obvious (ISP transparent proxies, for instance). |
| 59 |
If you have a very constrained set of users you may be able turn it |
| 60 |
off later after you've got everything working. |
| 61 |
|
| 62 |
|
| 63 |
|
| 64 |
Advanced Configuration Options |
| 65 |
------------------------------ |
| 66 |
|
| 67 |
1. Multi-domain logins: although cookies are domain-specific, |
| 68 |
mod_auth_tkt now supports multi-domain logins and logouts by |
| 69 |
passing the authentication ticket via the URL to a new domain. |
| 70 |
To setup multi-domain logins, one of your domains should be |
| 71 |
designated the primary domain, and your login and logout scripts |
| 72 |
should be configured as normal for that domain - test your primary |
| 73 |
domain is working as desired. Then, if you are using the supplied |
| 74 |
CGI scripts, you should use 'autologin' mode for the secondary |
| 75 |
domains, which basically just looks for an existing ticket (on the |
| 76 |
primary domain) and passes it via a URL parameter back to your |
| 77 |
secondary domain. Autologin mode is configured by creating a |
| 78 |
symbolic link to 'login.cgi' called 'autologin.cgi' and using the |
| 79 |
autologin.cgi version in your TKTAuthLoginURL. Something like the |
| 80 |
following should then work for all your domains: |
| 81 |
|
| 82 |
AuthType None |
| 83 |
require valid-user |
| 84 |
TKTAuthCookieName auth_tkt |
| 85 |
TKTAuthLoginURL https://www.mydomain.com/auth/autologin.cgi |
| 86 |
TKTAuthTimeoutMin 60 |
| 87 |
|
| 88 |
(Note that no TKTAuthDomain is set, because this fragment is being |
| 89 |
used for multiple domains. TKTAuthDomain defaults to the parent |
| 90 |
domain when undefined - .mydomain.com in this case - which is |
| 91 |
usually what you want.) |
| 92 |
|
| 93 |
|
| 94 |
|