NAME

Apache::AuthCookieLDAP - An AuthCookie module backed by a LDAP database.

VERSION

        $Revision: 0.02 $

SYNOPSIS

Not correct!!!

        # In httpd.conf or .htaccess
        PerlModule Apache::AuthCookieLDAP
        PerlSetVar WhatEverPath /
        PerlSetVar WhatEverLoginScript /login.pl

        # Optional, to share tickets between servers.
        PerlSetVar WhatEverDomain .domain.com
        
        # These must be set
        PerlSetVar WhatEverLDAP_DN "o=foo.com"
        PerlSetVar WhatEverLDAP_SecretKeyFile /etc/httpd/acme.com.key
        PerlSetVar WhatEverLDAP_User uid


        # These are optional, the module sets sensible defaults.

        PerlSetVar WhatEverLDAP_filter F=on
        PerlSetVar WhatEverDBI_GroupsTable "groups"
        PerlSetVar WhatEverDBI_GroupField "grp"
        PerlSetVar WhatEverDBI_GroupUserField "user"

        PerlSetVar WhatEverLDAP_host ldap.bank.com
        PerlSetVar WhatEverLDAP_EncryptionType "none"
        PerlSetVar WhatEverLDAP_SessionLifetime 00-24-00-00

        # Protected by AuthCookieLDAP.
        <Directory /www/domain.com/authcookieldap>
                AuthType Apache::AuthCookieLDAP
                AuthName WhatEver
                PerlAuthenHandler Apache::AuthCookieLDAP->authenticate
                PerlAuthzHandler Apache::AuthCookieLDAP->authorize
                require valid-user
                # or you can require users:
                require user jacob

                # You can optionally require groups.
                require group system
        </Directory>

        # Login location.  *** DEBUG *** I still think this is screwy
        <Files LOGIN>
                AuthType Apache::AuthCookieLDAP
                AuthName WhatEver
                SetHandler perl-script
                PerlHandler Apache::AuthCookieLDAP->login
        </Files>

DESCRIPTION

This module is an authentication handler that uses the basic mechanism provided by Apache::AuthCookie with a LDAP database for ticket-based protection. It is based on two tokens being provided, a username and password, which can be any strings (there are no illegal characters for either). The username is used to set the remote user as if Basic Authentication was used.

On an attempt to access a protected location without a valid cookie being provided, the module prints an HTML login form (produced by a CGI or any other handler; this can be a static file if you want to always send people to the same entry page when they log in). This login form has fields for username and password. On submitting it, the username and password are looked up in the LDAP database. If this succeeds, the user is issued a ticket. This ticket contains the username, an issue time, an expire time, and an MD5 checksum of those and a secret key for the server. It can optionally be encrypted before returning it to the client in the cookie; encryption is only useful for preventing the client from seeing the expire time. If you wish to protect passwords in transport, use an SSL-encrypted connection. The ticket is given in a cookie that the browser stores.

After a login the user is redirected to the location they originally wished to view (or to a fixed page if the login "script" was really a static file).

On this access and any subsequent attempt to access a protected document, the browser returns the ticket to the server. The server unencrypts it if encrypted tickets are enabled, then extracts the username, issue time, expire time and checksum. A new checksum is calculated of the username, issue time, expire time and the secret key again; if it agrees with the checksum that the client supplied, we know that the data has not been tampered with. We next check that the expire time has not passed. If not, the ticket is still good, so we set the username.

Authorization checks then check that any "require valid-user" or "require user jacob" settings are passed. If all these checks pass, the document requested is displayed.

If a ticket has expired or is otherwise invalid it is cleared in the browser and the login form is shown again.

APACHE CONFIGURATION DIRECTIVES

All configuration directives for this module are passed in PerlSetVars. These PerlSetVars must begin with the AuthName that you are describing, so if your AuthName is PrivateBankingSystem they will look like:

        PerlSetVar PrivateBankingSystemLDAP_DN "o=bank.com"

See also Apache::Authcookie for the directives required for any kind of Apache::AuthCookie-based authentication system.

In the following descriptions, replace "WhatEver" with your particular AuthName. The available configuration directives are as follows:

WhatEverLDAP_DN

Specifies the BaseDN for LDAP for the database you wish to connect to retrieve user information. This is required and has no default value.

WhatEverLDAP_user

Specifies the user id in the database you wish to connect to retrieve user information. This is required and has no default value.

WhatEverLDAP_host The host to connect to. This is not required and defaults to localhost.

WhatEverLDAP_filter An extra filter for the search for the user. Is not required

WhatEverLDAP_SecretKeyFile

The file that contains the secret key (on the first line of the file). This is required and has no default value. This key should be owned and only readable by root. It is read at server startup time. The key should be long and fairly random. If you want, you can change it and restart the server, (maybe daily), which will invalidate all prior-issued tickets.

WhatEverLDAP_EncryptionType

What kind of encryption to use to prevent the user from looking at the fields in the ticket we give them. This is almost completely useless, so don't switch it on unless you really know you need it. It does not provide any protection of the password in transport; use SSL for that. It can be 'none', 'des', 'idea', 'blowfish', or 'blowfish_pp'.

This is not required and defaults to 'none'.

WhatEverLDAP_SessionLifetime

How long tickets are good for after being issued. Note that presently Apache::AuthCookie does not set a client-side expire time, which means that most clients will only keep the cookie until the user quits the browser. However, if you wish to force people to log in again sooner than that, set this value. This can be 'forever' or a life time specified as:

        DD-hh-mm-ss -- Days, hours, minute and seconds to live.

This is not required and defaults to '00-24-00-00' or 24 hours.

WhatEverDBI_DSN

Specifies the DSN for DBI for the database you wish to connect to retrieve user information. This is required and has no default value.

WhatEverDBI_User

The user to log into the database as. This is not required and defaults to undef.

WhatEverDBI_Password

The password to use to access the database. This is not required and defaults to undef.

WhatEverDBI_GroupsTable

The table that has the user / group information. This is not required and defaults to 'groups'.

WhatEverDBI_GroupField

The field in the above table that has the group name. This is not required and defaults to 'grp' (to prevent conflicts with the SQL reserved word 'group').

WhatEverDBI_GroupUserField

The field in the above table that has the user name. This is not required and defaults to 'user'.

LICENSE

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

AUTHOR

Bjorn Ardo

        <f98ba@efd.lth.se>

SEE ALSO

Apache::AuthCookie(1)