components/cyrus-sasl/Solaris/sasl_appname.conf.4
author Rich Burridge <rich.burridge@oracle.com>
Fri, 31 Mar 2017 07:26:17 -0700
changeset 7820 a2b9a7de9e1a
parent 5055 9daf220c1a9a
permissions -rw-r--r--
25795430 Adjust Userland man pages to "5.11" (from "5.12") where needed

'\" te
.\" Copyright (C) 1998-2003, Carnegie Mellon Univeristy.  All Rights Reserved.
.\" Portions Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
.TH sasl_appname.conf 4 "14 Oct 2003" "SunOS 5.11" "File Formats"
.SH NAME
sasl_appname.conf \- SASL options and configuration file
.SH SYNOPSIS
.LP
.nf
/etc/sasl/\fIappname\fR\fB\&.conf\fR
.fi

.SH DESCRIPTION
.sp
.LP
The \fB/etc/sasl/\fIappname\fR.conf\fR file is a user-supplied configuration file that supports user set options for server applications.
.sp
.LP
You can modify the behavior of \fBlibsasl\fR and its plug-ins for server applications by specifying option values in \fB/etc/sasl/\fIappname\fR.conf\fR file, where \fIappname\fR is the application defined name of the application. For \fBsendmail\fR, the file would be \fB/etc/sasl/Sendmail.conf\fR. See your application documentation for information on the application name.
.sp
.LP
Options that you set in a \fB\fIappname\fR.conf\fR file do not override SASL options specified by the application itself.
.sp
.LP
The format for each option setting is:
.sp
.in +2
.nf
option_name:value. 
.fi
.in -2

.sp
.LP
You can comment lines in the file by using a leading #.
.sp
.LP
The SASL library supports the following options for server applications: 
.sp
.ne 2
.mk
.na
\fB\fBauto_transition\fR\fR
.ad
.RS 25n
.rt  
When set to \fByes\fR, plain users and login plug-ins are automatically transitioned to other mechanisms when they do a successful plaintext authentication. The default value for \fBauto_transition\fR is \fBno\fR.
.RE

.sp
.ne 2
.mk
.na
\fB\fBauxprop_plugin\fR\fR
.ad
.RS 25n
.rt  
A space-separated list of names of auxiliary property plug-ins to use. By default, SASL will use or query all available auxiliary property plug-ins.
.RE

.sp
.ne 2
.mk
.na
\fB\fBcanon_user_plugin\fR\fR
.ad
.RS 25n
.rt  
The name of the canonical user plug-in to use. By default, the value of \fBcanon_user_plugin\fR is \fBINTERNAL\fR, to indicated the use of built-in plug-ins.. 
.RE

.sp
.ne 2
.mk
.na
\fB\fBlog_level\fR\fR
.ad
.RS 25n
.rt  
An integer value for the desired level of logging for a server, as defined in <\fBsasl.h\fR>. This sets the \fBlog_level\fR in the \fBsasl_server_params_t struct\fR in \fB/usr/include/sasl/saslplug.h\fR. The default value for \fBlog_level\fR is \fB1\fR to indicate \fBSASL_LOG_ERR\fR. 
.RE

.sp
.ne 2
.mk
.na
\fB\fBmech_list\fR\fR
.ad
.RS 25n
.rt  
Whitespace separated list of SASL mechanisms to allow, for example, \fBDIGEST-MD5 GSSAPI\fR. The \fBmech_list\fR option is used to restrict the mechanisms to a subset of the installed plug-ins. By default, SASL will use all available mechanisms. 
.RE

.sp
.ne 2
.mk
.na
\fB\fBpw_check\fR\fR
.ad
.RS 25n
.rt  
Whitespace separated list of mechanisms used to verify passwords that are used by \fBsasl_checkpass\fR(3SASL). The default value for \fBpw_check\fR is \fBauxprop\fR.
.RE

.sp
.ne 2
.mk
.na
\fB\fBreauth_timeout\fR\fR
.ad
.RS 25n
.rt  
This SASL option is used by the server DIGEST-MD5 plug-in. The value of \fBreauth_timeout\fR is the length in time (in minutes) that authentication information will be cached for a fast reauthorization. A value of 0 will disable reauthorization. The default value of \fBreauth_timeout\fR is 1440 (24 hours). 
.RE

.sp
.ne 2
.mk
.na
\fB\fBserver_load_mech_list\fR\fR
.ad
.RS 25n
.rt  
A space separated list of mechanisms to load. If in the process of loading server plug-ns no desired mechanisms are included in the plug-in, the plug-in will be unloaded. By default, SASL loads all server plug-ins.
.RE

.sp
.ne 2
.mk
.na
\fB\fBuser_authid\fR\fR
.ad
.RS 25n
.rt  
If the value of \fBuser_authid\fR is \fByes\fR, then the GSSAPI will acquire the client credentials rather than use the default credentials when it creates the GSS client security context. The default value of \fBuser_authid\fR is \fBno\fR, whereby SASL uses the default client Kerberos identity. 
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
.TE

.SH SEE ALSO
.sp
.LP
\fBattributes\fR(5)