1.if !'po4a'hide' .TH basic_ncsa_auth 8 "May 16, 2006"
2.
3.SH NAME
4basic_ncsa_auth \- NCSA httpd-style password file authentication helper for Squid
5.
6.SH SYNOPSIS
7.if !'po4a'hide' .B basic_ncsa_auth
8passwd file
9.
10.SH DESCRIPTION
11.B basic_ncsa_auth
12allows Squid to read and authenticate user and password information from an NCSA/Apache
13httpd\-style password file when using basic HTTP authentication.
14.PP
15This password file can be manipulated using
16.B htpasswd.
17.
18.PP
19This authenticator accepts:
20.BR
21 * Blowfish \- for passwords 72 characters or less in length.
22.BR
23 * SHA256 \- with salting and magic strings.
24.BR
25 * SHA512 \- with salting and magic strings.
26.BR
27 * MD5 \- with optional salt and magic strings.
28.BR
29 * DES \- for passwords 8 characters or less in length.
30.
31NOTE: Blowfish and SHA algorithms require system-specific support.
32.
33.SH OPTIONS
34The only parameter is the password file.
35It must have permissions to be read by the user that Squid is running as.
36.
37.SH CONFIGURATION
38.if !'po4a'hide' .RS
39.if !'po4a'hide' .B basic_ncsa_auth /etc/squid/squid.pass
40.if !'po4a'hide' .RE
41.PP
42.B basic_ncsa_auth
43must have access to the password file to be executed.
44.
45.SH KNOWN ISSUES
46.PP
47DES functionality (used by htpasswd by default) silently truncates passwords to 8 characters.
48Allowing login with password values shorter than the one desired.
49This authenticator will reject login with long passwords when using DES.
50.
51.SH AUTHOR
52This manual was written by
53.if !'po4a'hide' .I Amos Jeffries <amosjeffries@squid-cache.org>
54.PP
55Based on original documentation by
56.if !'po4a'hide' .I Rodrigo Rubira Branco <rrbranco@br.ibm.com>
57.
58.SH COPYRIGHT
59.PP
60 * Copyright (C) 1996-2021 The Squid Software Foundation and contributors
61 *
62 * Squid software is distributed under GPLv2+ license and includes
63 * contributions from numerous individuals and organizations.
64 * Please see the COPYING and CONTRIBUTORS files for details.
65.PP
66This file is distributed in the hope that it will be useful,
67but WITHOUT ANY WARRANTY; without even the implied warranty of
68MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
69the GNU General Public License for more details.
70.
71.PP
72You should have received a copy of the GNU General Public License
73along with this file; if not, write to the Free Software
74Foundation, Inc., 59 Temple Place, Suite 330, Boston,
75MA 02111\-1307 USA
76.
77.SH QUESTIONS
78Questions on the usage of this program can be sent to the
79.I Squid Users mailing list
80.if !'po4a'hide' <squid-users@lists.squid-cache.org>
81.
82.SH REPORTING BUGS
83Bug reports need to be made in English.
84See http://wiki.squid-cache.org/SquidFaq/BugReporting for details of what you need to include with your bug report.
85.PP
86Report bugs or bug fixes using http://bugs.squid-cache.org/
87.PP
88Report serious security bugs to
89.I Squid Bugs <squid-bugs@lists.squid-cache.org>
90.PP
91Report ideas for new improvements to the
92.I Squid Developers mailing list
93.if !'po4a'hide' <squid-dev@lists.squid-cache.org>
94.
95.SH SEE ALSO
96.if !'po4a'hide' .BR squid "(8), "
97.if !'po4a'hide' .BR htpasswd "(1), "
98.if !'po4a'hide' .BR GPL "(7), "
99.br
100The Squid FAQ wiki
101.if !'po4a'hide' http://wiki.squid-cache.org/SquidFaq
102.br
103The Squid Configuration Manual
104.if !'po4a'hide' http://www.squid-cache.org/Doc/config/
105
106