[da4aff6] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[da4aff6] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[627a4af] | 7 | <!ENTITY cyrus-sasl-download-http "http://ftp.andrew.cmu.edu/pub/cyrus-mail/cyrus-sasl-&cyrus-sasl-version;.tar.gz">
|
---|
[da4aff6] | 8 | <!ENTITY cyrus-sasl-download-ftp "ftp://ftp.andrew.cmu.edu/pub/cyrus-mail/cyrus-sasl-&cyrus-sasl-version;.tar.gz">
|
---|
[1a87b97e] | 9 | <!ENTITY cyrus-sasl-md5sum "2eb0e48106f0e9cd8001e654f267ecbc">
|
---|
| 10 | <!ENTITY cyrus-sasl-size "1.6 MB">
|
---|
| 11 | <!ENTITY cyrus-sasl-buildsize "17 MB">
|
---|
| 12 | <!ENTITY cyrus-sasl-time "0.3 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 |
|
---|
[0afcfa88] | 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
|
---|
[1cc0752] | 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>
|
---|
[e19ad480] | 65 | <para role="required"><xref linkend="openssl"/></para>
|
---|
[1cc0752] | 66 |
|
---|
| 67 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[e19ad480] | 68 | <para role="optional"><xref linkend="linux-pam"/>,
|
---|
[0afcfa88] | 69 | <xref linkend="openldap"/>,
|
---|
| 70 | <xref linkend="heimdal"/> or <xref linkend="mitkrb"/>,
|
---|
[b66ece35] | 71 | <xref linkend="icedtea6"/> or <xref linkend="jdk"/>,
|
---|
[0afcfa88] | 72 | <xref linkend="mysql"/>,
|
---|
| 73 | <xref linkend="postgresql"/>,
|
---|
[de7f20e] | 74 | <xref linkend="db"/>,
|
---|
[8f9c757e] | 75 | <xref linkend="sqlite"/>,
|
---|
[de7f20e] | 76 | <!-- <xref linkend="gdbm"/>,
|
---|
[7bff1b2] | 77 | <xref linkend="courier"/>, -->
|
---|
[e2a0e91] | 78 | <ulink url="http://www.pdc.kth.se/kth-krb/">krb4</ulink>, and
|
---|
[1cc0752] | 79 | <ulink url="http://dmalloc.com/">Dmalloc</ulink></para>
|
---|
| 80 |
|
---|
[3597eb6] | 81 | <para condition="html" role="usernotes">User Notes:
|
---|
| 82 | <ulink url="&blfs-wiki;/cyrus-sasl"/></para>
|
---|
| 83 |
|
---|
[1cc0752] | 84 | </sect2>
|
---|
| 85 |
|
---|
| 86 | <sect2 role="installation">
|
---|
| 87 | <title>Installation of Cyrus SASL</title>
|
---|
| 88 |
|
---|
[0afcfa88] | 89 | <para>Install <application>Cyrus SASL</application> by
|
---|
[1cc0752] | 90 | running the following commands:</para>
|
---|
| 91 |
|
---|
[1a87b97e] | 92 | <screen><userinput>sed -i.bak 's/#elif WITH_DES/#elif defined(WITH_DES)/' \
|
---|
| 93 | plugins/digestmd5.c &&
|
---|
[6bfd4e2] | 94 | sed -i 's#DB_VERSION_MAJOR == 4.*#(&) || DB_VERSION_MAJOR == 5#' \
|
---|
| 95 | {sasldb/db_berkeley.c,utils/dbconverter-2.c} &&
|
---|
[1a87b97e] | 96 | ./configure --prefix=/usr \
|
---|
| 97 | --sysconfdir=/etc \
|
---|
[a8c9494] | 98 | --with-dbpath=/var/lib/sasl/sasldb2 \
|
---|
[a273763] | 99 | --with-saslauthd=/var/run/saslauthd &&
|
---|
[1cc0752] | 100 | make</userinput></screen>
|
---|
[305e60de] | 101 |
|
---|
[1f01e700] | 102 | <para>This package does not come with a test suite. If you are planning
|
---|
| 103 | on using the GSSAPI authentication mechanism, it is recommended to test
|
---|
| 104 | it after installing the package using the sample server and client programs
|
---|
| 105 | which were built in the preceding step. Instructions for performing the
|
---|
| 106 | tests can be found at <ulink
|
---|
[01bf7b38] | 107 | url="&hints-root;/downloads/files/cyrus-sasl.txt"/>.</para>
|
---|
[1f01e700] | 108 |
|
---|
[1cc0752] | 109 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
[305e60de] | 110 |
|
---|
[1cc0752] | 111 | <screen role="root"><userinput>make install &&
|
---|
[1f01e700] | 112 | install -v -m755 -d /usr/share/doc/cyrus-sasl-&cyrus-sasl-version; &&
|
---|
[dfdbccd] | 113 | install -v -m644 doc/{*.{html,txt,fig},ONEWS,TODO} \
|
---|
[72e3bf7] | 114 | saslauthd/LDAP_SASLAUTHD /usr/share/doc/cyrus-sasl-&cyrus-sasl-version; &&
|
---|
[254a24c] | 115 | install -v -m700 -d /var/lib/sasl &&
|
---|
| 116 | install -v -m711 -d /var/run/saslauthd</userinput></screen>
|
---|
[da4aff6] | 117 |
|
---|
[1cc0752] | 118 | </sect2>
|
---|
| 119 |
|
---|
| 120 | <sect2 role="commands">
|
---|
| 121 | <title>Command Explanations</title>
|
---|
| 122 |
|
---|
[1a87b97e] | 123 | <para><command>sed -i.bak ... plugins/digestmd5.c</command>: This fixes
|
---|
| 124 | a build problem caused by using newer compilers.</para>
|
---|
| 125 |
|
---|
[6bfd4e2] | 126 | <para><command>sed -i 's#DB_VERSION_MAJOR ...</command>: This fixes
|
---|
| 127 | compiling against version 5 of <xref linkend="db"/>.</para>
|
---|
| 128 |
|
---|
[0afcfa88] | 129 | <para><parameter>--with-dbpath=/var/lib/sasl/sasldb2</parameter>: This
|
---|
[a273763] | 130 | parameter forces the <command>sasldb</command> database to be created
|
---|
[0afcfa88] | 131 | in <filename class='directory'>/var/lib/sasl</filename> instead of
|
---|
[1cc0752] | 132 | <filename class='directory'>/etc</filename>.</para>
|
---|
[da4aff6] | 133 |
|
---|
[a273763] | 134 | <para><parameter>--with-saslauthd=/var/run/saslauthd</parameter>: This
|
---|
| 135 | parameter forces <command>saslauthd</command> to use the FHS compliant
|
---|
| 136 | directory <filename class='directory'>/var/run/saslauthd</filename> for
|
---|
| 137 | variable run-time data.</para>
|
---|
| 138 |
|
---|
| 139 | <para><parameter>--with-dblib=gdbm</parameter>: This parameter forces
|
---|
| 140 | <application>GDBM</application> to be used instead of
|
---|
| 141 | <application>Berkeley DB</application>.</para>
|
---|
[1cc0752] | 142 |
|
---|
| 143 | <para><option>--with-ldap</option>: This parameter enables use
|
---|
| 144 | with <application>OpenLDAP</application>.</para>
|
---|
| 145 |
|
---|
[1f01e700] | 146 | <para><option>--enable-ldapdb</option>: This parameter enables the
|
---|
| 147 | LDAPDB authentication backend. There is a circular dependency with this
|
---|
[4891ef3] | 148 | parameter. See <ulink url="&blfs-wiki;/cyrus-sasl"/> for a solution to
|
---|
| 149 | this problem.</para>
|
---|
[1f01e700] | 150 |
|
---|
[0afcfa88] | 151 | <para><command>install -v -m644 ...</command>: These commands
|
---|
| 152 | install documentation which is not installed by the
|
---|
[1cc0752] | 153 | <command>make install</command> command.</para>
|
---|
| 154 |
|
---|
[6bfd4e2] | 155 | <para><command>install -v -m700 -d /var/lib/sasl ...
|
---|
| 156 | -m711 /var/run/saslauthd</command>:
|
---|
[a273763] | 157 | These directories must exist when starting <command>saslauthd</command> or
|
---|
| 158 | using the sasldb plugin. If you're not going to be running the daemon or
|
---|
| 159 | using the plugins, you may omit the creation of this directory.</para>
|
---|
[1cc0752] | 160 |
|
---|
| 161 | </sect2>
|
---|
| 162 |
|
---|
| 163 | <sect2 role="configuration">
|
---|
| 164 | <title>Configuring Cyrus SASL</title>
|
---|
| 165 |
|
---|
| 166 | <sect3 id="cyrus-sasl-config">
|
---|
| 167 | <title>Config Files</title>
|
---|
| 168 |
|
---|
[4891ef3] | 169 | <para><filename>/etc/saslauthd.conf</filename> (for
|
---|
| 170 | <command>saslauthd</command> LDAP configuration)
|
---|
[a273763] | 171 | and <filename>/etc/sasl2/Appname.conf</filename> (where "Appname"
|
---|
[1cc0752] | 172 | is the application defined name of the application)</para>
|
---|
| 173 |
|
---|
| 174 | <indexterm zone="cyrus-sasl cyrus-sasl-config">
|
---|
| 175 | <primary sortas="e-etc-saslauthd.conf">/etc/saslauthd.conf</primary>
|
---|
| 176 | </indexterm>
|
---|
| 177 |
|
---|
| 178 | </sect3>
|
---|
| 179 |
|
---|
| 180 | <sect3>
|
---|
| 181 | <title>Configuration Information</title>
|
---|
| 182 |
|
---|
[0afcfa88] | 183 | <para>See <ulink
|
---|
[d612b9f] | 184 | url="file:///usr/share/doc/cyrus-sasl-&cyrus-sasl-version;/sysadmin.html"/>
|
---|
[0afcfa88] | 185 | for information on what to include in the application configuration files.
|
---|
| 186 | See <ulink
|
---|
[d612b9f] | 187 | url="file:///usr/share/doc/cyrus-sasl-&cyrus-sasl-version;/LDAP_SASLAUTHD"/>
|
---|
[1f01e700] | 188 | for configuring <command>saslauthd</command> with
|
---|
| 189 | <application>OpenLDAP</application>.</para>
|
---|
[1cc0752] | 190 |
|
---|
| 191 | </sect3>
|
---|
| 192 |
|
---|
| 193 | <sect3 id="cyrus-sasl-init">
|
---|
| 194 | <title>Init Script</title>
|
---|
| 195 |
|
---|
[0afcfa88] | 196 | <para>If you need to run the <command>saslauthd</command> daemon at system
|
---|
[1cc0752] | 197 | startup, install the <filename>/etc/rc.d/init.d/cyrus-sasl</filename>
|
---|
[5254d12] | 198 | init script included in the <xref linkend="bootscripts"/>
|
---|
[1cc0752] | 199 | package.</para>
|
---|
| 200 |
|
---|
| 201 | <indexterm zone="cyrus-sasl cyrus-sasl-init">
|
---|
| 202 | <primary sortas="f-cyrus-sasl-init">cyrus-sasl</primary>
|
---|
| 203 | </indexterm>
|
---|
| 204 |
|
---|
| 205 | <screen role="root"><userinput>make install-cyrus-sasl</userinput></screen>
|
---|
| 206 |
|
---|
| 207 | <note>
|
---|
[0afcfa88] | 208 | <para>You'll need to modify the init script and replace the
|
---|
[3597eb6] | 209 | <option><replaceable><authmech></replaceable></option> parameter
|
---|
[0afcfa88] | 210 | to the <option>-a</option> switch with your desired authentication
|
---|
[1cc0752] | 211 | mechanism.</para>
|
---|
| 212 | </note>
|
---|
| 213 |
|
---|
| 214 | </sect3>
|
---|
| 215 |
|
---|
| 216 | </sect2>
|
---|
| 217 |
|
---|
| 218 | <sect2 role="content">
|
---|
| 219 | <title>Contents</title>
|
---|
| 220 |
|
---|
| 221 | <segmentedlist>
|
---|
| 222 | <segtitle>Installed Programs</segtitle>
|
---|
| 223 | <segtitle>Installed Libraries</segtitle>
|
---|
| 224 | <segtitle>Installed Directories</segtitle>
|
---|
| 225 |
|
---|
| 226 | <seglistitem>
|
---|
| 227 | <seg>saslauthd, sasldblistusers2, and saslpasswd2</seg>
|
---|
[1f01e700] | 228 | <seg>libjavasasl.so, libsasl2.so, and numerous SASL plugins and
|
---|
| 229 | Java classes</seg>
|
---|
| 230 | <seg>/usr/include/sasl, /usr/lib/java/classes/sasl, /usr/lib/sasl2,
|
---|
[1cc0752] | 231 | /usr/share/doc/cyrus-sasl-&cyrus-sasl-version;, and /var/lib/sasl</seg>
|
---|
| 232 | </seglistitem>
|
---|
| 233 | </segmentedlist>
|
---|
| 234 |
|
---|
| 235 | <variablelist>
|
---|
| 236 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 237 | <?dbfo list-presentation="list"?>
|
---|
| 238 | <?dbhtml list-presentation="table"?>
|
---|
| 239 |
|
---|
| 240 | <varlistentry id="saslauthd">
|
---|
| 241 | <term><command>saslauthd</command></term>
|
---|
| 242 | <listitem>
|
---|
| 243 | <para>is the SASL authentication server.</para>
|
---|
| 244 | <indexterm zone="cyrus-sasl saslauthd">
|
---|
| 245 | <primary sortas="b-saslauthd">saslauthd</primary>
|
---|
| 246 | </indexterm>
|
---|
| 247 | </listitem>
|
---|
| 248 | </varlistentry>
|
---|
| 249 |
|
---|
| 250 | <varlistentry id="sasldblistusers2">
|
---|
| 251 | <term><command>sasldblistusers2</command></term>
|
---|
| 252 | <listitem>
|
---|
[4891ef3] | 253 | <para>is used to list the users in the SASL password database
|
---|
| 254 | <filename>sasldb2</filename>.</para>
|
---|
[1cc0752] | 255 | <indexterm zone="cyrus-sasl sasldblistusers2">
|
---|
| 256 | <primary sortas="b-sasldblistusers2">sasldblistusers2</primary>
|
---|
| 257 | </indexterm>
|
---|
| 258 | </listitem>
|
---|
| 259 | </varlistentry>
|
---|
| 260 |
|
---|
| 261 | <varlistentry id="saslpasswd2">
|
---|
| 262 | <term><command>saslpasswd2</command></term>
|
---|
| 263 | <listitem>
|
---|
[0afcfa88] | 264 | <para>is used to set and delete a user's SASL password and
|
---|
[4891ef3] | 265 | mechanism specific secrets in the SASL password database
|
---|
| 266 | <filename>sasldb2</filename>.</para>
|
---|
[1cc0752] | 267 | <indexterm zone="cyrus-sasl saslpasswd2">
|
---|
| 268 | <primary sortas="b-saslpasswd2">saslpasswd2</primary>
|
---|
| 269 | </indexterm>
|
---|
| 270 | </listitem>
|
---|
| 271 | </varlistentry>
|
---|
| 272 |
|
---|
| 273 | <varlistentry id="libsasl2">
|
---|
| 274 | <term><filename class='libraryfile'>libsasl2.so</filename></term>
|
---|
| 275 | <listitem>
|
---|
[0afcfa88] | 276 | <para>is a general purpose authentication library for server and
|
---|
[1cc0752] | 277 | client applications.</para>
|
---|
| 278 | <indexterm zone="cyrus-sasl libsasl2">
|
---|
| 279 | <primary sortas="c-libsasl2">libsasl2.so</primary>
|
---|
| 280 | </indexterm>
|
---|
| 281 | </listitem>
|
---|
| 282 | </varlistentry>
|
---|
| 283 |
|
---|
| 284 | </variablelist>
|
---|
| 285 |
|
---|
| 286 | </sect2>
|
---|
| 287 |
|
---|
| 288 | </sect1>
|
---|