/ 
CGI-Builder-Auth-0.06
River stage zero No dependents
/ CGI::Builder::Auth

NAME

CGI::Builder::Auth - Add user authentication to the CGI::Builder Framework

SYNOPSIS

# Recommended: Include CGI::Builder::Session BEFORE CGI::Builder::Auth
use CGI::Builder qw/ CGI::Builder::Session CGI::Builder::Auth /;

# 'protected' page available only to authenticated (logged in) users
sub SH_protected {
  my ($app) = @_;
  $app->auth->require_valid_user or return $app->switch_to('login');
}

# 'admin' page available only to members of 'administrators' group
sub SH_admin {
  my ($app) = @_;
  $app->auth->require_group('administrators') 
    or return $app->switch_to('forbidden');
}

# 'private' page available only to select users
sub SH_private {
  my ($app) = @_;
  $app->auth->require_user(qw/ bob carol ted alice /) 
    or return $app->switch_to('forbidden');
}

ABSTRACT

Adds user authentication and authorization to the CGI::Builder Framework.

DESCRIPTION

For those who prefer to read code rather than documentation, see the examples directory in the distribution. The example is well commented and exercises the API fully.

CGI::Builder::Auth adds an authentication system to the CBF. An object stored in the auth property keeps track of the current user, and provides methods for performing common tests to determine that user's status in the current context. It talks to the user database through the configured User_factory and Group_factory classes.

The module includes default User_factory and Group_factory classes which store their database in plain text files. The files should be compatible with Apache password files generated by the htpasswd utility, but this feature is untested as of release 0.06. The default classes also have preliminary support for storing user/group information in a SQL database. If you are interested in using this feature, please see the example file in the distribution examples/CBAuthDBI.pm. (Many thanks to Rusty Phillips for this code.)

A developer may provide custom User_factory and Group_factory classes so that the CBF can access a database of his own design. These classes must conform to the API for the User Class and Group Class respectively. The CBAuthCDBI.pm example shows one possible implementation of alternative User_factroy and Group_factory classes (implemented in the CDBI_*.pm files). Please look in the examples directory of this distribution and read "Custom User and Group Classes" below.

WARNING: The default User and Group factories provided with this module are not thread-safe. You may have issues using them on a multi-threaded web server such as the Windows version of Apache or any version of Apache2. (Apache 1.x on Linux should be fine). If you intend to deploy on a multi-threaded platform, you should design your own User and Group factories. Also, even on supported platforms you may run into file-locking issues under heavy loads, because only one web server process may have the database open at a time. Developers are encouraged to use a SQL database to avoid these issues.

This module can use CGI::Builder::Session to track the authentication context from one request to the next, so a user can login once and remain logged in until her session terminates. This happens automatically when the module detects that you are using sessions. You don't need to do anything special. The module will function without sessions, but only within the current request. Realistically, for any real web application you will want to use the session integration.

Any session keys set by this module will begin with 'CBA_'. Do not attempt to access these keys directly, they are intended for internal use only.

APPLICATION PROGRAMMING INTERFACE

This module adds the following methods to the CBF.

auth

The authentication context object. Its API is documented separately in CGI::Builder::Auth::Context.

auth_user_config

A group accessor (like the param property). Supported configuration options:

  • DB

    The complete path to your user database file. Default is ./.htpasswd. This file must be writable by your web server! Insufficient file permission is the most common support problem, so please check this before sending mail to the list for support.

  • Encrypt

    How to disguise the password in the database. One of 'crypt' or 'MD5'. For compatibility with Apache htpasswd files, you probably want 'crypt'. Default is 'crypt'.

    $app->auth_user_config(DB => './.htpasswd', Encrypt => 'crypt');

auth_group_config

A group accessor (like the param property). Supported configuration options:

  • DB

    The complete path to your group database file. Default is ./.htgroup. This file must be writable by your web server! Insufficient file permission is the most common support problem, so please check this before sending mail to the list for support.

    $app->auth_group_config(DB => './.htgroup'');

auth_config

A group accessor (like the param property). Supported configuration options:

  • magic_string

    The magic_string is used to verify the authentication token that is retrieved from the session. It should be set to something unique for your application. It must be set before the first use of the auth object, and must not be changed during the execution of your program.

  • User_factory (advanced)

    This configuration parameter is for advanced users who wish to supply their own custom class for user objects. See "Custom User and Group Classes" below.

  • Group_factory (advanced)

    This configuration parameter is for advanced users who wish to supply their own custom class for group objects. See "Custom User and Group Classes" below.

TROUBLESHOOTING

If make test works for you but your application does not work as you expect, please check the following things before sending email to the mailing list for support.

  • Set DB in OH_init

    Ensure you have set the DB configuration option for users and groups in your code before the first use of the auth property.

  • Set File Permissions!

    Ensure that the DB files are writable by your web server. On many systems the web server runs as a special user, which might be called 'apache', 'www', or 'nobody'. This user must be able to read and write your DB files. You may have to chmod 777 filename to get this to work. THIS IS THE MOST COMMON PROBLEM.

  • Set Directory Permissions

    Ensure that the DB files actually exist after running your program. Your web server will need write access to the directory in order to create them. If it cannot, you may have to create them manually using touch filename, and then set permissions appropriately.

  • Configure Session First

    Ensure that you have set the configuration options for CGI::Builder::Session in your code before the first use of the auth property.

Custom User and Group Classes

WARNING: This is an experimental feature.

It may happen that you have your user information stored in a relational database, and you would like to access additional columns in the user table, or perform special queries on related tables. This module can work together with custom classes that you create to implement this additional functionality.

Your custom user class must implement the interface described in CGI::Builder::Auth::User, and your custom group class must implement the interface described in CGI::Builder::Auth::Group. They may of course have many other properties and methods, but all the ones described in these resources must be supported.

However, your custom classes should not inherit from these default classes. The default classes are designed to work specifically with the text file format and do not contain any reusable methods for SQL databases.

Custom classes come as a matched set. If you use a custom user class, you must also use a custom group class.

To instruct the auth object to use your custom classes, set the User_factory and Group_factory auth_config parameters to the appropriate class names in your OH_init. The configurator will attempt to require these modules at the time you set the values. If they cannot be found, the auth_config method will croak.

$app->auth_config(
  User_factory  => 'My::Personal::User::Class',
  Group_factory => 'My::Personal::Group::Class',
); # croaks if these classes cannot be 'required'

TO DO

  • Test Integration

    Make the test suite actually test the CGI::Builder integration!

  • Test Error Conditions

    Make the test suite test for behavior under common error conditions such as unwritable database files. Behavior for most errors is currently undefined.

  • Document Support for SQL Databases

    Preliminary support for SQL databases needs to be documented in the POD.

  • Ongoing Refactor

    Refactor the backend to better support the Factory design pattern, and clean out some of the old User-Manage code that is no longer needed.

SEE ALSO

SUPPORT

Support for this module and all the modules of the CBF is via the mailing list. The list is used for general support on the use of the CBF, announcements, bug reports, patches, suggestions for improvements or new features. The API to the CBF is stable, but if you use the CBF in a production environment, it's probably a good idea to keep a watch on the list.

You can join the CBF mailing list at this url:

http://lists.sourceforge.net/lists/listinfo/cgi-builder-users

AUTHOR

Vincent Veselosky

CREDITS

Large portions of the code are borrowed from the HTTPD-User-Manage collection by Doug MacEachern and Lincoln Stein.

Rusty Phillips contributed many fixes to get DBI support working and provided the CBAuthDBI.pm example application.

COPYRIGHT AND LICENSE

Copyright 2004 by Vincent Veselosky

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.