basic_sasl_auth(8)

NAME
basic_sasl_auth - Basic Authentication using SASL (specifically the cyrus-sasl authentication method)

Version 1.0

SYNOPSIS
basic_sasl_auth

DESCRIPTION
basic_sasl_auth is an installed binary helper for Squid. SASL is configurable (somewhat like PAM). Each service authenticating against SASL identifies itself with an application name. Each application can be configured independently by the SASL administrator.

CONFIGURATION
To configure the authentication method used the file basic_sasl_auth.conf can be placed in the appropriate location, usually /usr/lib/sasl.

The authentication database is defined by the pwcheck_method parameter. Only the PLAIN authentication mechanism is used.

Examples: pwcheck_method:sasldb use sasldb - the default if no conf file is installed. pwcheck_method:pam
 - use PAM authentication database pwcheck_method:passwd
 - use traditional /etc/passwd pwcheck_method:shadow
 - use slightly less traditional /etc/shadow

Others methods may be supported by your cyrus-sasl implementation - consult your cyrus-sasl documentation for information.

Typically the authentication database ( /etc/sasldb , /etc/shadow , PAM ) can not be accessed by a normal user. You should use setuid/setgid and an appropriate user/group on the executable to allow the authenticator to access the appropriate password database. If the access to the database is not permitted then the authenticator will typically fail with "-1, generic error".

    chown root.mail basic_sasl_auth
    chmod ug+s basic_sasl_auth

If the application name basic_sasl_auth will also be used for the PAM service name if pwcheck_method:pam is chosen. And example PAM configuration file basic_sasl_auth.pam is also included.

AUTHOR
This program was written by Ian Castle <ian.castle@coldcomfortfarm.net>

This manual was written by Ian Castle <ian.castle@coldcomfortfarm.net> Amos Jeffries <amosjeffries@squid-cache.org>

COPYRIGHT

 * Copyright (C) 1996-2024 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.

This program and documentation is copyright to the authors named above.

Distributed under the GNU General Public License (GNU GPL) version 2 or later (GPLv2+).

QUESTIONS
Questions on the usage of this program can be sent to the Squid Users mailing list <squid-users@lists.squid-cache.org>

REPORTING BUGS
Bug reports need to be made in English. See https://wiki.squid-cache.org/SquidFaq/BugReporting for details of what you need to include with your bug report.

Report bugs or bug fixes using https://bugs.squid-cache.org/

Report serious security bugs to Squid Bugs <squid-bugs@lists.squid-cache.org>

Report ideas for new improvements to the Squid Developers mailing list <squid-dev@lists.squid-cache.org>

SEE ALSO
squid(8), SASL(3), PAM(7), passwd(1), shadow(5), chown(1), chmod(1), GPL(7),
The Squid FAQ wiki https://wiki.squid-cache.org/SquidFaq
The Squid Configuration Manual http://www.squid-cache.org/Doc/config/