helpers/basic_auth/PAM/basic_pam_auth.8

   1 .TH basic_pam_auth 8 "5 Sep 2003" "Squid PAM Basic Auth"
   2 .
   3 .SH NAME
   4 pam_auth - Squid PAM Basic authentication helper
   5 .
   6 .SH SYNOPSIS
   7 basic_pam_auth [-n "service name"] [-t TTL] [-o] [-1]
   8 .
   9 .SH DESCRIPTION
  10 This helper allows Squid to connect to a mostly any available PAM
  11 database to validate the user name and password of Basic HTTP
  12 authentication.
  13 .
  14 .TP
  15 .BI "-s " "service-name"
  16 Specifies the PAM service name Squid uses, defaults to "squid"
  17 .
  18 .TP
  19 .BI "-t " TTL
  20 Enables persistent PAM connections where the connection to the PAM
  21 database is kept open and reused for new logins. The TTL specifies
  22 how long the connection will be kept open (in seconds).  Default is
  23 to not keep PAM connections open. Please note that the use of
  24 persistent PAM connections is slightly outside the PAM
  25 specification and may not work with all PAM configurations.
  26 .
  27 .TP
  28 .BI "-o"
  29 Do not perform the PAM account management group (account
  30 expiration etc)
  31
  32 .
  33 .SH CONFIGURATION
  34 .
  35 The program needs a PAM service to be configured in
  36 .B /etc/pam.conf
  37 or
  38 .B /etc/pam.d/<servicename>
  39 .P
  40 The default service name is "squid", and the program makes use
  41 of the
  42 .BR "" ' auth "' and '" account '
  43 management groups to verify the password and the accounts validity.
  44 .P
  45 For details on how to configure PAM services, see the PAM
  46 documentation for your system. This manual does not cover PAM
  47 configuration details.
  48 .
  49 .SH NOTES
  50 .
  51 When used for authenticating to local UNIX shadow password databases
  52 the program must be running as root or else it won't have sufficient
  53 permissions to access the user password database. Such use of this
  54 program is not recommended, but if you absolutely need to then make
  55 the program setuid root
  56 .RS
  57 .P
  58 .B chown root pam_auth
  59 .br
  60 .B chmod u+s pam_auth
  61 .RE
  62 .P
  63 Please note that in such configurations it is also strongly recommended
  64 that the program is moved into a directory where normal users cannot
  65 access it, as this mode of operation will allow any local user to
  66 brute-force other users passwords. Also note the program has not been
  67 fully audited and the author cannot be held responsible for any security
  68 issues due to such installations.
  69 .
  70 .SH AUTHOR
  71 Squid basic_pam_auth and this manual is written by
  72 .I Henrik Nordstrom <hno@squid-cache.org>
  73 .
  74 .SH COPYRIGHT
  75 Squid basic_pam_auth and this manual is Copyright 1999,2002,2003
  76 Henrik Nordstrom <hno@squid-cache.org>
  77 .
  78 .SH QUESTIONS
  79 Questions on the usage of this program can be sent to the
  80 .I Squid Users <squid-users@squid-cache.org>
  81 mailing list.
  82 .
  83 .SH REPORTING BUGS
  84 Report bugs or bug-fixes to
  85 .I Squid Bugs <squid-bugs@squid-cache.org>
  86 or ideas for new improvements to
  87 .I Squid Developers <squid-dev@squid-cache.org>
  88 .
  89 .SH "SEE ALSO"
  90 .BR pam (8), " PAM Systems Administrator Guide"