Net::Squid::Auth::Plugin::UserList - A User List-Based Credentials Validation Plugin for Net::Squid::Auth::Engine
Version 0.02
If you're a system administrator trying to use Net::Squid::Auth::Engine to validate your user's credentials using a user:password list as credentials repository, do as described here:
On $Config{InstallScript}/squid-auth-engine's configuration file:
$Config{InstallScript}/squid-auth-engine
plugin = UserList <UserList> users = <<EOF joe_average:secret john_manager:terces EOF </UserList>
On your Squid HTTP Cache configuration:
auth_param basic /usr/bin/squid-auth-engine /etc/squid-auth-engine.conf
And you're ready to use this module.
If you're a developer, you might be interested in reading through the source code of this module, in order to learn about it's internals and how it works. It may give you ideas about how to implement other plugin modules for Net::Squid::Auth::Engine.
Constructor. Expects a hash reference with all the configuration under the section <UserList> in the $Config{InstallScript}/squid-auth-engine as parameter. Returns a plugin instance.
Initialization function. Gets a user list from the 'users' parameter in the configuration hash passed in to new() and parses it using "\n" as user record split and ":" as user / password separator inside of every record. Returns nothing, as specified by the plugin interface.
new()
This is the credential validation interface. It expects a username and password as parameters and returns a boolean indicating if the credentials are valid (i.e., are listed in the configuration file) or not.
A simple LDAP-based credentials validation plugin for Net::Squid::Auth::Engine.
Luis Motta Campos, <lmc at cpan.org>
<lmc at cpan.org>
Please report any bugs or feature requests to bug-net-squid-auth-plugin-userlist at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Net-Squid-Auth-Plugin-UserList. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
bug-net-squid-auth-plugin-userlist at rt.cpan.org
You can find documentation for this module with the perldoc command.
perldoc Net::Squid::Auth::Plugin::UserList
You can also look for information at:
RT: CPAN's request tracker
http://rt.cpan.org/NoAuth/Bugs.html?Dist=Net-Squid-Auth-Plugin-UserList
AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/Net-Squid-Auth-Plugin-UserList
CPAN Ratings
http://cpanratings.perl.org/d/Net-Squid-Auth-Plugin-UserList
Search CPAN
http://search.cpan.org/dist/Net-Squid-Auth-Plugin-UserList
Copyright 2008 Luis Motta Campos, all rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
To install Net::Squid::Auth::Plugin::UserList, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Net::Squid::Auth::Plugin::UserList
CPAN shell
perl -MCPAN -e shell install Net::Squid::Auth::Plugin::UserList
For more information on module installation, please visit the detailed CPAN module installation guide.