• VERSION
• DESCRIPTION
• CONFIGURATION AND ENVIRONMENT
• DEPENDENCIES
• COPYRIGHT, LICENSE, AND DISCLAIMER OF WARRANTY

WTF::Apache::Authen - Apache2 AUTHEN phase handler

VERSION

This document describes WTF::Apache::Authen version 1.02

DESCRIPTION

This module contains a single function that acts as a handler for the Apache2 AUTHEN phase. It uses a fairly standard Basic HTTP Authentication mechanism to check for a username and password combination against the WTF database.

On successful login, the function will update the user's last login date/time in the database, set a simple boolean session cookie (``authen'') so that on subsequent requests the application won't update the user's last login in the database, and will set ``$r->pnotes'' with:

• user_id
  
The database row ID for the user.
• username
  
The user account name of the current user, typically (and assumed to be for the purposes of this application) an email address.
• user_name
  
The name of the current user. This will likely be the user's first and last name.
• is_admin
  
This key will be set to the value in the ``employee'' table under the ``admin'' column.

In addition, and to support the ``Login As...'' functionality, the handler will check the ``login_as'' cookie for a value. If there's a value, that value is a valid user ID number of a person who reports up to the current user, and the current user has the ``login_as'' authorization, the handler will make changes to ``$r->pnotes'' as follows:

• real_user_id
  
This value will be added, and it will contain the real user ID number for the current user. When the user desires to revert to his own account, this data will be used to allow the revertion.
• username
  
This value will change to the username (email address) of the user the current user wishes to become.

Additionally, the ``user_id'', ``user_name'', and ``is_admin'' records in pnotes will be set to the desired ``login_as'' user rather than the current user.

CONFIGURATION AND ENVIRONMENT

WTF::Apache::Authen requires Apache2 with mod_perl2. It also requires a valid Apache2 configuration to associate itself with the proper Apahce2 phase.

DEPENDENCIES

WTF::Apache::Authen depends on the following modules:

• Apache2::Const
  
• WTF::DBH
  
• WTF::SQL
  

COPYRIGHT, LICENSE, AND DISCLAIMER OF WARRANTY

Use of this module implies the reading and agreement with the license under which this software is release. That license can be found in the ``license.txt'' file included with this distribution.