+------------------------------------------------------------------------------+
| README for 'Password Changer' SquirrelMail Plugin                            |
| Ryan W. Maple <ryan@guardiandigital.com>                                     |
+------------------------------------------------------------------------------+

Introduction
------------
  This package provides a SquirrelMail plugin which enables users to change
  their system password.  It uses perl and requires the Authen::PAM module.

  It uses suidperl to change the system password via PAM.

  This README is $Revision: 1.1.1.1 $, last modified on $Date: 2003/01/09 00:59:43 $.

Installation
------------
  Installation is a bit tricky.  First unpack the tarball:

    $ cd /where/your/squirrelmail/is/plugins
    $ tar -zxvf /where/you/have/sm-changepass-1.0.tar.gz

  Now you must make the perl script (do_changepass.pl) suid root.

    $ sudo chown root.webd do_changepass.pl
    $ sudo chmod 4550 do_changepass.pl

  Change 'webd' to the user Apache runs as.  On Debian this is 'www-data'.

  Because the worker script is a perl, you must also enable CGI execution.  If
  your server has AllowOverride set then you don't have to anything; a simple
  .htaccess file is included which does this automagically.

  If AllowOverride is not set then see the .htaccess file for an example of
  how to enable CGI execution in your httpd.conf.

  Your installation is now done!  Enable the plugin in config/config.php (it's
  called 'changepass'), go into "Options", and then "Password Changer."

Important Notes
---------------
  * You are probably wondering why I chose to do this in perl then PHP.  First
    off I dislike PHP and find perl much easier.  Second off, I trust myself
    writing this in suidperl.

  * For the tightest security make do_changepass.pl only executable by the user
    Apache runs as.  If Apache runs as user 'webd' then it should look like
    this:

    -r-sr-x---   1 root     webd         3287 Jan  8 13:05 do_changepass.pl

  * This plugin requires the Authen::PAM perl module, available from:

      http://search.cpan.org/CPAN/authors/id/N/NI/NIKIP

  * This plugin was written with SquirrelMail 1.2.9 and Authen::PAM version
    0.10.  If it does not work on newer versions of these packages please let
    me know via e-mail.
