helpers/basic_auth/NCSA/basic_ncsa_auth.8

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