maxsum-corin / rt-authen-externalauth Goto Github PK

RT-Authen-ExternalAuth

This module provides the ability to authenticate RT users
against one or more external data sources at once. It will
also allow information about that user to be loaded from
the same, or any other available, source as well as allowing
multple redundant servers for each method.

The extension currently supports authentication and 
information from LDAP via the Net::LDAP module, and from
any data source that an installed DBI driver is available
for. 

It is also possible to use cookies set by an alternate
application for Single Sign-On (SSO) with that application.
For example, you may integrate RT with your own website login
system so that once users log in to your website, they will be
automagically logged in to RT when they access it.

It was originally designed and tested against: 

MySQL v4.1.21-standard
MySQL v5.0.22
Windows Active Directory v2003

But it has been designed so that it should work with ANY
LDAP service and ANY DBI-drivable database, based upon the
configuration given in your $RTHOME/etc/RT_SiteConfig.pm

As of v0.08 ExternalAuth also allows you to pull a browser
cookie value and test it against a DBI data source allowing
the use of cookies for Single Sign-On (SSO) authentication
with another application or website login system. This is
due to the merging of RT::Authen::ExternalAuth and
RT::Authen::CookieAuth. For example, you may integrate RT
with your own website login system so that once users log in
to your website, they will be automagically logged in to RT 
when they access it.


INSTALLATION

To install this module, run the following commands:

    perl Makefile.PL
    make
    make install

I recommend:
RT::Authen::ExternalAuth v0.05 for RT-3.6.x
RT::Authen::ExternalAuth v0.08+ for RT-3.8.x

If you are using RT 3.8.x, you need to enable this
module by adding RT::Authen::ExternalAuth to your
@Plugins configuration:

Set( @Plugins, qw(RT::Authen::ExternalAuth) );

Once installed, you should view the file:
    
3.4/3.6    $RTHOME/local/etc/ExternalAuth/RT_SiteConfig.pm
3.8        $RTHOME/local/plugins/RT-Auth-ExternalAuth/etc/RT_SiteConfig.pm

Then use the examples provided to prepare your own custom 
configuration which should be added to your site configuration in
$RTHOME/etc/RT_SiteConfig.pm

Alternatively, you may alter the provided examples directly
and then include the extra directives by 'requiring' the
example file's path at the end of your RT_SiteConfig.pm


UPGRADING

If you are upgrading from 0.05 you may have some leftover
parts of the module in 

$RTHOME/local/lib/RT/User_Vendor.pm 
$RTHOME/local/lib/RT/Authen/External_Auth.pm

that will conflict with the new install and these should be removed

AUTHOR
        Mike Peachey
        Jennic Ltd.
        [email protected]

COPYRIGHT AND LICENCE

Copyright (C) 2008, Jennic Ltd.

This software is released under version 2 of the GNU 
General Public License. The license is distributed with
this package in the LICENSE file found in the directory 
root.