src/auth/basic/PAM/basic_pam_auth.8

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