saslauthd.mdoc   [plain text]

.\" $Id: saslauthd.mdoc,v 1.9 2006/01/24 00:16:04 snsimon Exp $
.\" Copyright 1997-2001 Messaging Direct Ltd. All rights reserved.
.\" This manpage uses the BSD mdoc manpage macros. Please don't
.\" downgrade it to -man. The -mdoc macros are included with
.\" GNU roff, and, of course, with the BSD distributions.
.\" To make life easier for sites that don't support -mdoc,
.\" please generate (and commit!) an updated pre-formatted
.\" manpage in saslauthd.8 whenever you change this source
.\" version. Only the pre-formatted manpage is installed.
.Dd 10 24 2002
.Nm saslauthd
.Nd sasl authentication server
.Fl a
.Ar authmech
.Op Fl \&Tvdchlr
.Op Fl O Ar option
.Op Fl m Ar mux_path
.Op Fl n Ar threads
.Op Fl s Ar size
.Op Fl t Ar timeout
is a daemon process that handles plaintext authentication requests
on behalf of the SASL library.
The server fulfills two roles: it isolates all code requiring superuser
privileges into a single process, and it can be used to provide
.Em proxy
authentication services to clients that do not understand
SASL based authentication.
should be
started from the system boot scripts when going to
multi-user mode. When running against a protected authentication
database (e.g. the
.Li shadow
it must be run as the superuser.
.Ss Options
Options named by lower\-case letters configure the server itself.
Upper\-case options control the behavior of specific authentication
mechanisms; their applicability to a particular authentication
mechanism is described in the
.Bl -tag -width indent
.It Fl a Ar authmech
.Ar authmech
as the authentication mechanism. (See the
section below.) This parameter is mandatory.
.It Fl O Ar option
A mechanism specific option (e.g. rimap hostname or config file path)
.It Fl H Ar hostname
The remote host to be contacted by the
.Li rimap
authentication mechanism. (Depricated, use -O instead)
.It Fl m Ar path
.Ar path
as the pathname to the named socket to listen on for
connection requests. This must be an absolute pathname, and MUST NOT
include the trailing "/mux".  Note that the default for this value
is "/var/state/saslauthd" (or what was specified at compile time)
and that this directory must exist for saslauthd to function.
.It Fl n Ar threads
.Ar threads
processes for responding to authentication queries. (default: 5)  A
value of zero will indicate that saslauthd should fork an individual
process for each connection.  This can solve leaks that occur in some
.It Fl s Ar size
.Ar size
as the table size of the hash table (in kilobytes)
.It Fl t Ar timeout
.Ar timeout
as the expiration time of the authentication cache (in seconds)
.It Fl T
Honour time-of-day login restrictions.
.It Fl h
Show usage information
.It Fl c
Enable cacheing of authentication credentials
.It Fl l
Disable the use of a lock file for controlling access to accept().
.It Fl r
Combine the realm with the login (with an '@' sign in between).  e.g.
login: "foo" realm: "bar" will get passed as login: "foo@bar".  Note that
the realm will still be passed, which may lead to unexpected behavior.
.It Fl v
Print the version number and available authentication
mechanisms on standard error, then exit.
.It Fl d
Debugging mode.
.Ss Logging
logs it's activities via
.Nm syslogd
using the
supports one or more
.Qq authentication mechanisms ,
dependent upon the facilities provided by the underlying operating system.
The mechanism is selected by the
.Fl aho
flag from the following list of choices:
.Bl -tag -width "kerberos4"
.It Li dce
.Em (AIX)
Authenticate using the DCE authentication environment.
.It Li getpwent
.Em (All platforms)
Authenticate using the
.Fn getpwent
library function. Typically this authenticates against the
local password file. See your systems
.Xr getpwent 3
man page for details.
.It Li kerberos4
.Em (All platforms)
Authenticate against the local Kerberos 4 realm. (See the
section for caveats about this driver.)
.It Li kerberos5
.Em (All platforms)
Authenticate against the local Kerberos 5 realm.
.It Li pam
.Em (Linux, Solaris)
Authenticate using Pluggable Authentication Modules (PAM).
.It Li rimap
.Em (All platforms)
Forward authentication requests to a remote IMAP server. This driver
connects to a remote IMAP server, specified using the -O flag,
and attempts to login (via an IMAP
command) using the credentials 
supplied to the local
server. If the remote authentication succeeds the local connection
is also considered to be authenticated. The remote connection is closed
as soon as the tagged response from the
command is received from the remote
.Ar option
parameter to the
.Fl O
flag describes the remote server to forward
authentication requests to.
.Ar hostname
can be a hostname ( or a dotted\-quad IP address
( The latter is useful if the remote server is
multi\-homed and has network interfaces that are unreachable from
the local IMAP server. The remote host is contacted on the
.Ql imap
service port. A non\-default port can be specified by appending
a slash and the port name or number
to the
.Ar hostname
.Fl O
flag and argument are mandatory when using the
.Li rimap
.It Li shadow
.Em (AIX, Irix, Linux, Solaris)
Authenticate against the local
.Qq shadow password file .
The exact mechanism is system dependent.
currently understands the
.Fn getspnam
.Fn getuserpw
library routines. Some systems
honour the
.Fl T
.It Li sasldb
.Em (All platforms)
Authenticate against the
SASL authentication database.  Note that this is probabally not what you
want to be using, and is even disabled at compile-time by default.
If you want to use sasldb with the SASL library, you probably want to
use the pwcheck_method of "auxprop" along with the sasldb auxprop plugin
.It Li ldap
.Em (All platforms that support OpenLDAP 2.0 or higher)
Authenticate against an ldap server.  The ldap configuration parameters are
read from /usr/local/etc/saslauthd.conf.  The location of this file can be
changed with the -O parameter. See the LDAP_SASLAUTHD file included with the
distribution for the list of available parameters.
.It Li sia
.Em (Digital UNIX)
Authenticate using the Digital
Security Integration Architecture
.Qq enhanced security ) .
.Li kerberos4
authentication driver consumes considerable resources. To perform an
authentication it must obtain a ticket granting ticket
from the TGT server
.Sy on every authentication request.
The Kerberos library routines that obtain the TGT also create a
local ticket file, on the reasonable assumption that you will want
to save the TGT for use by other Kerberos applications. These ticket
files are unusable by
.Nm No ,
however there is no way not to create them. The overhead of creating
and removing
these ticket files can cause serious performance degradation on busy
servers. (Kerberos
was never intended to be used in this manner, anyway.)
.Bl -tag -width "/var/run/saslauthd/mux"
.It Pa /var/run/saslauthd/mux
The default communications socket.
.It Pa /usr/local/etc/saslauthd.conf
The default configuration file for ldap support.
.Xr passwd 1 ,
.Xr getpwent 3 ,
.Xr getspnam 3 ,
.Xr getuserpw 3 ,
.Xr sasl_checkpass 3
.Xr sia_authenticate_user 3 ,