SourceFormat Enforcement

[thirdparty/squid.git] / src / auth / basic / getpwnam / basic_getpwnam_auth.8

.if !'po4a'hide' .TH basic_getpwnam_auth 8
.
.SH NAME
basic_getpwnam_auth \- Local Users auth helper for Squid
.
.SH SYNOPSIS
.if !'po4a'hide' .B basic_getpwnam_auth
.
.SH DESCRIPTION
.B basic_getpwnam_auth
allows Squid to authenticate any local user accounts
to validate the user name and password of Basic HTTP authentication.
.PP
It uses
.B getpwnam()
and
.B getspnam()
routines for authentication.
.PP
This has the following advantages over the NCSA module:
.if !'po4a'hide' .TP 5
\- Allows authentication of all known local users
.
.if !'po4a'hide' .TP
\- Allows authentication through nsswitch.conf
.
.if !'po4a'hide' .TP
\- Can handle NIS(+) requests
.
.if !'po4a'hide' .TP
\- Can handle LDAP requests
.
.if !'po4a'hide' .TP
\- Can handle PAM requests
.
.SH CONFIGURATION
.if !'po4a'hide' .RS
.if !'po4a'hide' .B auth_param basic program /path/to/basic_getpwnam_auth
.if !'po4a'hide' .br
.if !'po4a'hide' .B auth_param basic children concurrency=1
.if !'po4a'hide' .RE
.PP
When used for authenticating to local UNIX shadow password databases
the program must be running as root or else it won't have sufficient
permissions to access the user password database. Such use of this
program is not recommended, but if you absolutely need to then make
the program
.B setuid
.B root
.if !'po4a'hide' .RS
.if !'po4a'hide' .B chown root basic_getpwnam_auth
.if !'po4a'hide' .br
.if !'po4a'hide' .B chmod u+s basic_getpwnam_auth
.if !'po4a'hide' .RE
.PP
Please note that in such configurations it is also strongly recommended
that the program is moved into a directory where normal users cannot
access it, as this mode of operation will allow any local user to
brute-force other users passwords. Also note the program has not been
fully audited and the author cannot be held responsible for any security
issues due to such installations.
.
.SH AUTHOR
This program was written by
.if !'po4a'hide' .I Erik Hofman <erik.hofman@a1.nl>
.if !'po4a'hide' .I Robin Elfrink <robin@a1.nl>
.if !'po4a'hide' .I Giancarlo Razzolini <linux-fan@onda.com.br>
.PP
Based on original code by
.if !'po4a'hide' .I Jon Thackray <jrmt@uk.gdscorp.com>.
.PP
This manual was written by
.if !'po4a'hide' .I Amos Jeffries <amosjeffries@squid-cache.org>
.
.SH COPYRIGHT
.PP
 * Copyright (C) 1996-2017 The Squid Software Foundation and contributors
 *
 * Squid software is distributed under GPLv2+ license and includes
 * contributions from numerous individuals and organizations.
 * Please see the COPYING and CONTRIBUTORS files for details.
.PP
This program and documentation is copyright to the authors named above.
.PP
Distributed under the GNU General Public License (GNU GPL) version 2 or later (GPLv2+).
.
.SH QUESTIONS
Questions on the usage of this program can be sent to the
.I Squid Users mailing list
.if !'po4a'hide' <squid-users@squid-cache.org>
.
.SH REPORTING BUGS
Bug reports need to be made in English.
See http://wiki.squid-cache.org/SquidFaq/BugReporting for details of what you need to include with your bug report.
.PP
Report bugs or bug fixes using http://bugs.squid-cache.org/
.PP
Report serious security bugs to
.I Squid Bugs <squid-bugs@squid-cache.org>
.PP
Report ideas for new improvements to the
.I Squid Developers mailing list
.if !'po4a'hide' <squid-dev@squid-cache.org>
.
.SH SEE ALSO
.if !'po4a'hide' .BR squid "(8), "
.if !'po4a'hide' .BR basic_pam_auth "(8), "
.if !'po4a'hide' .BR basic_ncsa_auth "(8), "
.if !'po4a'hide' .BR basic_ldap_auth "(8), "
.if !'po4a'hide' .BR basic_nis_auth "(8), "
.if !'po4a'hide' .BR chown "(1), "
.if !'po4a'hide' .BR chmod "(1), "
.if !'po4a'hide' .BR nsswitch.conf "(5), "
.if !'po4a'hide' .BR getpwnam "(3), "
.if !'po4a'hide' .BR getspnam "(3), "
.if !'po4a'hide' .BR GPL "(7), "
.br
The Squid FAQ wiki
.if !'po4a'hide' http://wiki.squid-cache.org/SquidFaq
.br
The Squid Configuration Manual
.if !'po4a'hide' http://www.squid-cache.org/Doc/config/