src/auth/basic/SASL/basic_sasl_auth.8

   1 .if !'po4a'hide' .TH basic_sasl_auth 8
   2 .
   3 .SH NAME
   4 basic_sasl_auth \- Basic Authentication using SASL (specifically the cyrus-sasl authentication method)
   5 .PP
   6 Version 1.0
   7 .
   8 .SH SYNOPSIS
   9 .if !'po4a'hide' .B basic_sasl_auth
  10 .
  11 .SH DESCRIPTION
  12 .B basic_sasl_auth
  13 is an installed binary helper for Squid. SASL is configurable (somewhat like PAM).
  14 Each service authenticating against SASL identifies itself with an application name.
  15 Each application can be configured independently by the SASL administrator.
  16 .
  17 .SH CONFIGURATION
  18 To configure the authentication method used the file
  19 .B basic_sasl_auth.conf
  20 can be placed in the appropriate location, usually
  21 .B /usr/lib/sasl.
  22 .PP
  23 The authentication database is defined by the
  24 .B pwcheck_method
  25 parameter.
  26 Only the
  27 .B PLAIN
  28 authentication mechanism is used.
  29 .PP
  30 Examples:
  31 .
  32 .if !'po4a'hide' .B pwcheck_method:sasldb
  33 use sasldb - the default if no conf file is installed.
  34 .if !'po4a'hide' .B pwcheck_method:pam
  35  - use PAM authentication database
  36 .if !'po4a'hide' .B pwcheck_method:passwd
  37  - use traditional
  38 .B /etc/passwd
  39 .if !'po4a'hide' .B pwcheck_method:shadow
  40  - use slightly less traditional /etc/shadow
  41 .PP
  42 Others methods may be supported by your cyrus-sasl implementation -
  43 consult your cyrus-sasl documentation for information.
  44 .PP
  45 Typically the authentication database (
  46 .B /etc/sasldb
  47 ,
  48 .B /etc/shadow
  49 ,
  50 .B PAM
  51 )
  52 can not be accessed by a normal user. You should use setuid/setgid
  53 and an appropriate user/group on the executable to allow the
  54 authenticator to access the appropriate password database. If the
  55 access to the database is not permitted then the authenticator
  56 will typically fail with "-1, generic error".
  57 .PP
  58 .if !'po4a'hide' .RS
  59 .if !'po4a'hide' .P
  60 .if !'po4a'hide' .B chown root.mail basic_sasl_auth
  61 .if !'po4a'hide' .br
  62 .if !'po4a'hide' .B chmod ug+s basic_sasl_auth
  63 .if !'po4a'hide' .RE
  64 .PP
  65 If the application name
  66 .B basic_sasl_auth
  67 will also be used for the PAM service name if
  68 .B pwcheck_method:pam
  69 is chosen. And example PAM configuration file
  70 .B basic_sasl_auth.pam
  71 is also included.
  72 .
  73 .SH AUTHOR
  74 This program was written by
  75 .if !'po4a'hide' .I Ian Castle <ian.castle@coldcomfortfarm.net>
  76 .PP
  77 This manual was written by
  78 .if !'po4a'hide' .I Ian Castle <ian.castle@coldcomfortfarm.net>
  79 .if !'po4a'hide' .I Amos Jeffries <amosjeffries@squid-cache.org>
  80 .
  81 .SH COPYRIGHT
  82 .PP
  83  * Copyright (C) 1996-2021 The Squid Software Foundation and contributors
  84  *
  85  * Squid software is distributed under GPLv2+ license and includes
  86  * contributions from numerous individuals and organizations.
  87  * Please see the COPYING and CONTRIBUTORS files for details.
  88 .PP
  89 This program and documentation is copyright to the authors named above.
  90 .PP
  91 Distributed under the GNU General Public License (GNU GPL) version 2 or later (GPLv2+).
  92 .
  93 .SH QUESTIONS
  94 Questions on the usage of this program can be sent to the
  95 .I Squid Users mailing list
  96 .if !'po4a'hide' <squid-users@lists.squid-cache.org>
  97 .
  98 .SH REPORTING BUGS
  99 Bug reports need to be made in English.
 100 See http://wiki.squid-cache.org/SquidFaq/BugReporting for details of what you need to include with your bug report.
 101 .PP
 102 Report bugs or bug fixes using http://bugs.squid-cache.org/
 103 .PP
 104 Report serious security bugs to
 105 .I Squid Bugs <squid-bugs@lists.squid-cache.org>
 106 .PP
 107 Report ideas for new improvements to the
 108 .I Squid Developers mailing list
 109 .if !'po4a'hide' <squid-dev@lists.squid-cache.org>
 110 .
 111 .SH SEE ALSO
 112 .if !'po4a'hide' .BR squid "(8), "
 113 .if !'po4a'hide' .BR SASL "(3), "
 114 .if !'po4a'hide' .BR PAM "(7), "
 115 .if !'po4a'hide' .BR passwd "(1), "
 116 .if !'po4a'hide' .BR shadow "(5), "
 117 .if !'po4a'hide' .BR chown "(1), "
 118 .if !'po4a'hide' .BR chmod "(1), "
 119 .if !'po4a'hide' .BR GPL "(7), "
 120 .br
 121 The Squid FAQ wiki
 122 .if !'po4a'hide' http://wiki.squid-cache.org/SquidFaq
 123 .br
 124 The Squid Configuration Manual
 125 .if !'po4a'hide' http://www.squid-cache.org/Doc/config/