helpers/basic_auth/PAM/basic_pam_auth.8

   1 .if !'po4a'hide' .TH basic_pam_auth 8 "5 Sep 2003"
   2 .
   3 .SH NAME
   4 .if !'po4a'hide' .B basic_pam_auth
   5 .if !'po4a'hide' \-
   6 Squid PAM Basic authentication helper
   7 .
   8 .SH SYNOPSIS
   9 .if !'po4a'hide' .B "basic_pam_auth [\-n \""
  10 service name
  11 .if !'po4a'hide' .B "\"] [\-t "
  12 TTL
  13 .if !'po4a'hide' .B "] [\-o] [\-1]"
  14 .
  15 .SH DESCRIPTION
  16 .B basic_pam_auth
  17 allows Squid to connect to a mostly any available PAM
  18 database to validate the user name and password of Basic HTTP
  19 authentication.
  20 .
  21 .SH OPTIONS
  22 .if !'po4a'hide' .TP 12
  23 .if !'po4a'hide' .B "\-s " "service\-name"
  24 Specifies the PAM service name Squid uses, defaults to
  25 .B squid
  26 .
  27 .if !'po4a'hide' .TP
  28 .if !'po4a'hide' .B "\-t " TTL
  29 Enables persistent PAM connections where the connection to the PAM
  30 database is kept open and reused for new logins. The TTL specifies
  31 how long the connection will be kept open (in seconds).  Default is
  32 to not keep PAM connections open. Please note that the use of
  33 persistent PAM connections is slightly outside the PAM
  34 specification and may not work with all PAM configurations.
  35 .
  36 .if !'po4a'hide' .TP
  37 .if !'po4a'hide' .B \-o
  38 Do not perform the PAM account management group (account
  39 expiration etc)
  40 .
  41 .SH CONFIGURATION
  42 The program needs a PAM service to be configured in
  43 .BR /etc/pam.conf
  44 or
  45 .BR /etc/pam.d/squid
  46 .PP
  47 The default service name is
  48 .B squid
  49 , and the program makes use of the
  50 .B auth
  51 and
  52 .B account
  53 management groups to verify the password and the accounts validity.
  54 .PP
  55 For details on how to configure PAM services, see the PAM
  56 documentation for your system. This manual does not cover PAM
  57 configuration details.
  58 .
  59 .SH NOTES
  60 .
  61 When used for authenticating to local UNIX shadow password databases
  62 the program must be running as root or else it won't have sufficient
  63 permissions to access the user password database. Such use of this
  64 program is not recommended, but if you absolutely need to then make
  65 the program setuid root
  66 .if !'po4a'hide' .RS
  67 .if !'po4a'hide' .P
  68 .if !'po4a'hide' .B chown root basic_pam_auth
  69 .if !'po4a'hide' .br
  70 .if !'po4a'hide' .B chmod u+s basic_pam_auth
  71 .if !'po4a'hide' .RE
  72 .PP
  73 Please note that in such configurations it is also strongly recommended
  74 that the program is moved into a directory where normal users cannot
  75 access it, as this mode of operation will allow any local user to
  76 brute-force other users passwords. Also note the program has not been
  77 fully audited and the author cannot be held responsible for any security
  78 issues due to such installations.
  79 .
  80 .SH AUTHOR
  81 This program and documentation was written by
  82 .if !'po4a'hide' .I Henrik Nordstrom <hno@squid-cache.org>
  83 .
  84 .SH COPYRIGHT
  85 .PP
  86  * Copyright (C) 1996-2014 The Squid Software Foundation and contributors
  87  *
  88  * Squid software is distributed under GPLv2+ license and includes
  89  * contributions from numerous individuals and organizations.
  90  * Please see the COPYING and CONTRIBUTORS files for details.
  91 .PP
  92 Squid
  93 .B basic_pam_auth
  94 and this manual is Copyright 1999,2002,2003
  95 .if !'po4a'hide' .I Henrik Nordstrom <hno@squid-cache.org>
  96 .
  97 Distributed under the GNU General Public License (GNU GPL) version 2 or later (GPLv2+).
  98 .
  99 .SH QUESTIONS
 100 Questions on the usage of this program can be sent to the
 101 .I Squid Users mailing list
 102 .if !'po4a'hide' <squid-users@squid-cache.org>
 103 .
 104 .SH REPORTING BUGS
 105 Bug reports need to be made in English.
 106 See http://wiki.squid-cache.org/SquidFaq/BugReporting for details of what you need to include with your bug report.
 107 .PP
 108 Report bugs or bug fixes using http://bugs.squid-cache.org/
 109 .PP
 110 Report serious security bugs to
 111 .I Squid Bugs <squid-bugs@squid-cache.org>
 112 .PP
 113 Report ideas for new improvements to the
 114 .I Squid Developers mailing list
 115 .if !'po4a'hide' <squid-dev@squid-cache.org>
 116 .
 117 .SH SEE ALSO
 118 .if !'po4a'hide' .BR squid "(8), "
 119 .if !'po4a'hide' .BR pam "(3), "
 120 .if !'po4a'hide' .BR pam.conf "(5), "
 121 .if !'po4a'hide' .BR chown "(1), "
 122 .if !'po4a'hide' .BR chmod "(1), "
 123 .if !'po4a'hide' .BR GPL "(7), "
 124 .br
 125 PAM Systems Administrator Guide
 126 .br
 127 The Squid FAQ wiki
 128 .if !'po4a'hide' http://wiki.squid-cache.org/SquidFaq
 129 .br
 130 The Squid Configuration Manual
 131 .if !'po4a'hide' http://www.squid-cache.org/Doc/config/
 132