[da4aff6] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[ff769b8c] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
|
---|
[da4aff6] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY cyrus-sasl-download-http "http://ftp.andrew.cmu.edu/pub/cyrus-mail/cyrus-sasl-&cyrus-sasl-version;.tar.gz ">
|
---|
| 8 | <!ENTITY cyrus-sasl-download-ftp "ftp://ftp.andrew.cmu.edu/pub/cyrus-mail/cyrus-sasl-&cyrus-sasl-version;.tar.gz">
|
---|
[90e2fb4e] | 9 | <!ENTITY cyrus-sasl-md5sum "268ead27f4ac39bcfe17d9e38e0f2977">
|
---|
[ca0666f4] | 10 | <!ENTITY cyrus-sasl-size "1.7 MB">
|
---|
| 11 | <!ENTITY cyrus-sasl-buildsize "17 MB">
|
---|
[114e5f0b] | 12 | <!ENTITY cyrus-sasl-time "0.28 SBU">
|
---|
[da4aff6] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="cyrus-sasl" xreflabel="Cyrus SASL-&cyrus-sasl-version;">
|
---|
[1cc0752] | 16 | <?dbhtml filename="cyrus-sasl.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>Cyrus SASL-&cyrus-sasl-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="cyrus-sasl">
|
---|
| 26 | <primary sortas="a-Cyrus-SASL">Cyrus SASL</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to Cyrus SASL</title>
|
---|
| 31 |
|
---|
| 32 | <para>The <application>Cyrus SASL</application> package contains a Simple
|
---|
| 33 | Authentication and Security Layer, a method for adding authentication
|
---|
| 34 | support to connection-based protocols. To use SASL, a protocol includes a
|
---|
| 35 | command for identifying and authenticating a user to a server and for
|
---|
| 36 | optionally negotiating protection of subsequent protocol interactions. If
|
---|
| 37 | its use is negotiated, a security layer is inserted between the protocol
|
---|
| 38 | and the connection.</para>
|
---|
| 39 |
|
---|
| 40 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 41 | <itemizedlist spacing="compact">
|
---|
| 42 | <listitem>
|
---|
| 43 | <para>Download (HTTP): <ulink url="&cyrus-sasl-download-http;"/></para>
|
---|
| 44 | </listitem>
|
---|
| 45 | <listitem>
|
---|
| 46 | <para>Download (FTP): <ulink url="&cyrus-sasl-download-ftp;"/></para>
|
---|
| 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
| 49 | <para>Download MD5 sum: &cyrus-sasl-md5sum;</para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>Download size: &cyrus-sasl-size;</para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>Estimated disk space required: &cyrus-sasl-buildsize;</para>
|
---|
| 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
| 58 | <para>Estimated build time: &cyrus-sasl-time;</para>
|
---|
| 59 | </listitem>
|
---|
| 60 | </itemizedlist>
|
---|
| 61 |
|
---|
| 62 | <bridgehead renderas="sect3">Cyrus SASL Dependencies</bridgehead>
|
---|
| 63 |
|
---|
| 64 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 65 | <para><xref linkend="openssl"/></para>
|
---|
| 66 |
|
---|
| 67 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 68 | <para><xref linkend="Linux_PAM"/>,
|
---|
| 69 | <xref linkend="openldap"/>,
|
---|
| 70 | <xref linkend="heimdal"/> or <xref linkend="mitkrb"/>,
|
---|
| 71 | <xref linkend="jdk"/>,
|
---|
| 72 | <xref linkend="mysql"/>,
|
---|
| 73 | <xref linkend="postgresql"/>,
|
---|
| 74 | <xref linkend="db"/>,
|
---|
| 75 | <xref linkend="gdbm"/>,
|
---|
| 76 | <xref linkend="courier"/>,
|
---|
| 77 | <ulink url="http://www.pdc.kth.se/kth-krb/">krb4</ulink>,
|
---|
| 78 | <ulink url="http://sqlite.org/">SQLite</ulink> and
|
---|
| 79 | <ulink url="http://dmalloc.com/">Dmalloc</ulink></para>
|
---|
| 80 |
|
---|
| 81 | </sect2>
|
---|
| 82 |
|
---|
| 83 | <sect2 role="installation">
|
---|
| 84 | <title>Installation of Cyrus SASL</title>
|
---|
| 85 |
|
---|
| 86 | <para>Install <application>Cyrus SASL</application> by
|
---|
| 87 | running the following commands:</para>
|
---|
| 88 |
|
---|
| 89 | <screen><userinput>./configure --prefix=/usr --sysconfdir=/etc \
|
---|
[a8c9494] | 90 | --with-dbpath=/var/lib/sasl/sasldb2 \
|
---|
| 91 | --with-saslauthd=/var/run &&
|
---|
[1cc0752] | 92 | make</userinput></screen>
|
---|
[305e60de] | 93 |
|
---|
[1cc0752] | 94 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
[305e60de] | 95 |
|
---|
[1cc0752] | 96 | <screen role="root"><userinput>make install &&
|
---|
[dfdbccd] | 97 | install -v -m644 saslauthd/saslauthd.mdoc \
|
---|
[a8c9494] | 98 | /usr/share/man/man8/saslauthd.8 &&
|
---|
[72e3bf7] | 99 | install -v -d -m755 /usr/share/doc/cyrus-sasl-&cyrus-sasl-version; &&
|
---|
[dfdbccd] | 100 | install -v -m644 doc/{*.{html,txt,fig},ONEWS,TODO} \
|
---|
[72e3bf7] | 101 | saslauthd/LDAP_SASLAUTHD /usr/share/doc/cyrus-sasl-&cyrus-sasl-version; &&
|
---|
[1cc0752] | 102 | install -v -d -m700 /var/lib/sasl</userinput></screen>
|
---|
[da4aff6] | 103 |
|
---|
[1cc0752] | 104 | </sect2>
|
---|
| 105 |
|
---|
| 106 | <sect2 role="commands">
|
---|
| 107 | <title>Command Explanations</title>
|
---|
| 108 |
|
---|
| 109 | <para><parameter>--with-dbpath=/var/lib/sasl/sasldb2</parameter>: This
|
---|
| 110 | parameter forces the <command>saslauthd</command> database to be created
|
---|
| 111 | in <filename class='directory'>/var/lib/sasl</filename> instead of
|
---|
| 112 | <filename class='directory'>/etc</filename>.</para>
|
---|
[da4aff6] | 113 |
|
---|
[1cc0752] | 114 | <para><parameter>--with-saslauthd=/var/run</parameter>: This parameter
|
---|
| 115 | forces <command>saslauthd</command> to use the FHS compliant
|
---|
| 116 | directory <filename class='directory'>/var/run</filename> for variable
|
---|
| 117 | run-time data.</para>
|
---|
| 118 |
|
---|
| 119 | <para><option>--with-ldap</option>: This parameter enables use
|
---|
| 120 | with <application>OpenLDAP</application>.</para>
|
---|
| 121 |
|
---|
| 122 | <para><command>install -v -m644 ...</command>: These commands
|
---|
| 123 | install documentation which is not installed by the
|
---|
| 124 | <command>make install</command> command.</para>
|
---|
| 125 |
|
---|
| 126 | <para><command>install -v -d -m700 /var/lib/sasl</command>: This directory
|
---|
| 127 | must exist when starting <command>saslauthd</command>. If you're not going
|
---|
| 128 | to be running the daemon, you may omit the creation of this directory.</para>
|
---|
| 129 |
|
---|
| 130 | </sect2>
|
---|
| 131 |
|
---|
| 132 | <sect2 role="configuration">
|
---|
| 133 | <title>Configuring Cyrus SASL</title>
|
---|
| 134 |
|
---|
| 135 | <sect3 id="cyrus-sasl-config">
|
---|
| 136 | <title>Config Files</title>
|
---|
| 137 |
|
---|
| 138 | <para><filename>/etc/saslauthd.conf</filename> (for LDAP configuration)
|
---|
| 139 | and <filename>/usr/lib/sasl2/Appname.conf</filename> (where "Appname"
|
---|
| 140 | is the application defined name of the application)</para>
|
---|
| 141 |
|
---|
| 142 | <indexterm zone="cyrus-sasl cyrus-sasl-config">
|
---|
| 143 | <primary sortas="e-etc-saslauthd.conf">/etc/saslauthd.conf</primary>
|
---|
| 144 | </indexterm>
|
---|
| 145 |
|
---|
| 146 | </sect3>
|
---|
| 147 |
|
---|
| 148 | <sect3>
|
---|
| 149 | <title>Configuration Information</title>
|
---|
| 150 |
|
---|
| 151 | <para>See <ulink
|
---|
| 152 | url="file:///usr/share/doc/cyrus-sasl-&cyrus-sasl-version;/sysadmin.html"/>
|
---|
| 153 | for information on what to include in the application configuration files.
|
---|
| 154 | See <ulink
|
---|
| 155 | url="file:///usr/share/doc/cyrus-sasl-&cyrus-sasl-version;/LDAP_SASLAUTHD"/>
|
---|
| 156 | for configuring <command>saslauthd</command> with LDAP.</para>
|
---|
| 157 |
|
---|
| 158 | </sect3>
|
---|
| 159 |
|
---|
| 160 | <sect3 id="cyrus-sasl-init">
|
---|
| 161 | <title>Init Script</title>
|
---|
| 162 |
|
---|
| 163 | <para>If you need to run the <command>saslauthd</command> daemon at system
|
---|
| 164 | startup, install the <filename>/etc/rc.d/init.d/cyrus-sasl</filename>
|
---|
| 165 | init script included in the <xref linkend="intro-important-bootscripts"/>
|
---|
| 166 | package.</para>
|
---|
| 167 |
|
---|
| 168 | <indexterm zone="cyrus-sasl cyrus-sasl-init">
|
---|
| 169 | <primary sortas="f-cyrus-sasl-init">cyrus-sasl</primary>
|
---|
| 170 | </indexterm>
|
---|
| 171 |
|
---|
| 172 | <screen role="root"><userinput>make install-cyrus-sasl</userinput></screen>
|
---|
| 173 |
|
---|
| 174 | <note>
|
---|
| 175 | <para>You'll need to modify the init script and replace the
|
---|
| 176 | <option><replaceable>[authmech]</replaceable></option> parameter
|
---|
| 177 | to the <option>-a</option> switch with your desired authentication
|
---|
| 178 | mechanism.</para>
|
---|
| 179 | </note>
|
---|
| 180 |
|
---|
| 181 | </sect3>
|
---|
| 182 |
|
---|
| 183 | </sect2>
|
---|
| 184 |
|
---|
| 185 | <sect2 role="content">
|
---|
| 186 | <title>Contents</title>
|
---|
| 187 |
|
---|
| 188 | <segmentedlist>
|
---|
| 189 | <segtitle>Installed Programs</segtitle>
|
---|
| 190 | <segtitle>Installed Libraries</segtitle>
|
---|
| 191 | <segtitle>Installed Directories</segtitle>
|
---|
| 192 |
|
---|
| 193 | <seglistitem>
|
---|
| 194 | <seg>saslauthd, sasldblistusers2, and saslpasswd2</seg>
|
---|
| 195 | <seg>libjavasasl.so, libsasl2.so, and SASL plugins/Java
|
---|
| 196 | classes</seg>
|
---|
| 197 | <seg>/usr/include/sasl, /usr/lib/java, /usr/lib/sasl2,
|
---|
| 198 | /usr/share/doc/cyrus-sasl-&cyrus-sasl-version;, and /var/lib/sasl</seg>
|
---|
| 199 | </seglistitem>
|
---|
| 200 | </segmentedlist>
|
---|
| 201 |
|
---|
| 202 | <variablelist>
|
---|
| 203 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 204 | <?dbfo list-presentation="list"?>
|
---|
| 205 | <?dbhtml list-presentation="table"?>
|
---|
| 206 |
|
---|
| 207 | <varlistentry id="saslauthd">
|
---|
| 208 | <term><command>saslauthd</command></term>
|
---|
| 209 | <listitem>
|
---|
| 210 | <para>is the SASL authentication server.</para>
|
---|
| 211 | <indexterm zone="cyrus-sasl saslauthd">
|
---|
| 212 | <primary sortas="b-saslauthd">saslauthd</primary>
|
---|
| 213 | </indexterm>
|
---|
| 214 | </listitem>
|
---|
| 215 | </varlistentry>
|
---|
| 216 |
|
---|
| 217 | <varlistentry id="sasldblistusers2">
|
---|
| 218 | <term><command>sasldblistusers2</command></term>
|
---|
| 219 | <listitem>
|
---|
| 220 | <para>is used to list the users in the SASL password database.</para>
|
---|
| 221 | <indexterm zone="cyrus-sasl sasldblistusers2">
|
---|
| 222 | <primary sortas="b-sasldblistusers2">sasldblistusers2</primary>
|
---|
| 223 | </indexterm>
|
---|
| 224 | </listitem>
|
---|
| 225 | </varlistentry>
|
---|
| 226 |
|
---|
| 227 | <varlistentry id="saslpasswd2">
|
---|
| 228 | <term><command>saslpasswd2</command></term>
|
---|
| 229 | <listitem>
|
---|
| 230 | <para>is used to set and delete a user's SASL password and
|
---|
| 231 | mechanism specific secrets in the SASL password database.</para>
|
---|
| 232 | <indexterm zone="cyrus-sasl saslpasswd2">
|
---|
| 233 | <primary sortas="b-saslpasswd2">saslpasswd2</primary>
|
---|
| 234 | </indexterm>
|
---|
| 235 | </listitem>
|
---|
| 236 | </varlistentry>
|
---|
| 237 |
|
---|
| 238 | <varlistentry id="libsasl2">
|
---|
| 239 | <term><filename class='libraryfile'>libsasl2.so</filename></term>
|
---|
| 240 | <listitem>
|
---|
| 241 | <para>is a general purpose authentication library for server and
|
---|
| 242 | client applications.</para>
|
---|
| 243 | <indexterm zone="cyrus-sasl libsasl2">
|
---|
| 244 | <primary sortas="c-libsasl2">libsasl2.so</primary>
|
---|
| 245 | </indexterm>
|
---|
| 246 | </listitem>
|
---|
| 247 | </varlistentry>
|
---|
| 248 |
|
---|
| 249 | </variablelist>
|
---|
| 250 |
|
---|
| 251 | </sect2>
|
---|
| 252 |
|
---|
| 253 | </sect1>
|
---|