README file for squid_nufw_helper, an external helper for the 
Squid external acl scheme. Provides SSO based on the NuFW firewall suite.
See http://www.nufw.fr/ for details
Latest version of this software available from http://www.inl.fr/

-------------------------
SQUID CONFIG
-------------------------
The squid configuration for the external ACL should be:

external_acl_type nufw_sso %SRC %SRCPORT /path/to/squid_nufw_helper -f /path/to/config.file

This will let you define a squid ACL with something like :
acl nufw_auth external nufw_sso

which in turn you can use with a syntax like :
http_access allow nufw_auth


---------------------------------------
squid_nufw_helper config and internals
---------------------------------------
If the program finds a matching username/ip in the configuration file, 
it returns `OK', or `ERR' otherwise.

The usage for the program is:

squid_nufw_helper -f <configuration_file> -u -c 1000

-f points to the config file
-u means squid_nufw_helper should return the found user ID
-c <number> tells squid_nufw_helper to process that many connexions before dying 
(and having squid spawn a new helper process).


The configuration file format is as follows:

keywork value

where keyword is one of these : db_host, db_port, db_database, db_user,
db_pass, db_table

The SQL parameters should point to the NUFW connection tracking database. Only
SQL read access is necessary. It is highly recomended you don't use a user with
write access to the database!



When calling the "./configure" script, specify either :
- ./configure --with-mysql for MySQL database support.
- ./configure for PostGreSQL support.

Any bug to be reported to authors, so that we improve quality of this software!
And, we are waiting for patches, too!