[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">
|
---|
[fae66a0] | 9 | <!ENTITY cyrus-sasl-md5sum "341cffe829a4d71f2a6503d669d5a946">
|
---|
| 10 | <!ENTITY cyrus-sasl-size "5.0 MB">
|
---|
| 11 | <!ENTITY cyrus-sasl-buildsize "20 MB">
|
---|
| 12 | <!ENTITY cyrus-sasl-time "0.5 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 |
|
---|
[60ecc5bb] | 40 | &lfs72_checked;
|
---|
[fae66a0] | 41 |
|
---|
[1cc0752] | 42 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 43 | <itemizedlist spacing="compact">
|
---|
| 44 | <listitem>
|
---|
| 45 | <para>Download (HTTP): <ulink url="&cyrus-sasl-download-http;"/></para>
|
---|
| 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
| 48 | <para>Download (FTP): <ulink url="&cyrus-sasl-download-ftp;"/></para>
|
---|
| 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
| 51 | <para>Download MD5 sum: &cyrus-sasl-md5sum;</para>
|
---|
| 52 | </listitem>
|
---|
| 53 | <listitem>
|
---|
| 54 | <para>Download size: &cyrus-sasl-size;</para>
|
---|
| 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>Estimated disk space required: &cyrus-sasl-buildsize;</para>
|
---|
| 58 | </listitem>
|
---|
| 59 | <listitem>
|
---|
| 60 | <para>Estimated build time: &cyrus-sasl-time;</para>
|
---|
| 61 | </listitem>
|
---|
| 62 | </itemizedlist>
|
---|
| 63 |
|
---|
[fae66a0] | 64 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
| 65 | <itemizedlist spacing="compact">
|
---|
| 66 | <listitem>
|
---|
| 67 | <para>Required patch: <ulink
|
---|
[7e48143] | 68 | url="&patch-root;/cyrus-sasl-&cyrus-sasl-version;-fixes-1.patch"/></para>
|
---|
[fae66a0] | 69 | </listitem>
|
---|
| 70 | </itemizedlist>
|
---|
| 71 |
|
---|
[1cc0752] | 72 | <bridgehead renderas="sect3">Cyrus SASL Dependencies</bridgehead>
|
---|
| 73 |
|
---|
| 74 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[e19ad480] | 75 | <para role="required"><xref linkend="openssl"/></para>
|
---|
[1cc0752] | 76 |
|
---|
[fae66a0] | 77 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 78 | <para role="recommended"><xref linkend="db"/></para>
|
---|
| 79 |
|
---|
[1cc0752] | 80 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[e19ad480] | 81 | <para role="optional"><xref linkend="linux-pam"/>,
|
---|
[0afcfa88] | 82 | <xref linkend="openldap"/>,
|
---|
[fae66a0] | 83 | <xref linkend="mitkrb"/>,
|
---|
[49b50d4] | 84 | <xref linkend="openjdk"/><!-- or <xref linkend="jdk"/>-->,
|
---|
[0afcfa88] | 85 | <xref linkend="mysql"/>,
|
---|
| 86 | <xref linkend="postgresql"/>,
|
---|
[8f9c757e] | 87 | <xref linkend="sqlite"/>,
|
---|
[e2a0e91] | 88 | <ulink url="http://www.pdc.kth.se/kth-krb/">krb4</ulink>, and
|
---|
[1cc0752] | 89 | <ulink url="http://dmalloc.com/">Dmalloc</ulink></para>
|
---|
| 90 |
|
---|
[3597eb6] | 91 | <para condition="html" role="usernotes">User Notes:
|
---|
| 92 | <ulink url="&blfs-wiki;/cyrus-sasl"/></para>
|
---|
| 93 |
|
---|
[1cc0752] | 94 | </sect2>
|
---|
| 95 |
|
---|
| 96 | <sect2 role="installation">
|
---|
| 97 | <title>Installation of Cyrus SASL</title>
|
---|
| 98 |
|
---|
[0afcfa88] | 99 | <para>Install <application>Cyrus SASL</application> by
|
---|
[1cc0752] | 100 | running the following commands:</para>
|
---|
| 101 |
|
---|
[7e48143] | 102 | <screen><userinput>patch -Np1 -i ../cyrus-sasl-&cyrus-sasl-version;-fixes-1.patch &&
|
---|
[1a87b97e] | 103 | ./configure --prefix=/usr \
|
---|
| 104 | --sysconfdir=/etc \
|
---|
[a8c9494] | 105 | --with-dbpath=/var/lib/sasl/sasldb2 \
|
---|
[a273763] | 106 | --with-saslauthd=/var/run/saslauthd &&
|
---|
[1cc0752] | 107 | make</userinput></screen>
|
---|
[305e60de] | 108 |
|
---|
[1f01e700] | 109 | <para>This package does not come with a test suite. If you are planning
|
---|
| 110 | on using the GSSAPI authentication mechanism, it is recommended to test
|
---|
| 111 | it after installing the package using the sample server and client programs
|
---|
| 112 | which were built in the preceding step. Instructions for performing the
|
---|
| 113 | tests can be found at <ulink
|
---|
[01bf7b38] | 114 | url="&hints-root;/downloads/files/cyrus-sasl.txt"/>.</para>
|
---|
[1f01e700] | 115 |
|
---|
[1cc0752] | 116 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
[305e60de] | 117 |
|
---|
[1cc0752] | 118 | <screen role="root"><userinput>make install &&
|
---|
[1f01e700] | 119 | install -v -m755 -d /usr/share/doc/cyrus-sasl-&cyrus-sasl-version; &&
|
---|
[dfdbccd] | 120 | install -v -m644 doc/{*.{html,txt,fig},ONEWS,TODO} \
|
---|
[72e3bf7] | 121 | saslauthd/LDAP_SASLAUTHD /usr/share/doc/cyrus-sasl-&cyrus-sasl-version; &&
|
---|
[fae66a0] | 122 | install -v -m700 -d /var/lib/sasl</userinput></screen>
|
---|
[da4aff6] | 123 |
|
---|
[1cc0752] | 124 | </sect2>
|
---|
| 125 |
|
---|
| 126 | <sect2 role="commands">
|
---|
| 127 | <title>Command Explanations</title>
|
---|
| 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 |
|
---|
[fae66a0] | 151 | <para><option>--enable-java</option>: This option enables compiling of
|
---|
| 152 | <application>Java</application> support libraries</para>
|
---|
| 153 |
|
---|
| 154 | <para><option>--enable-login</option>: This option enables unsupported
|
---|
| 155 | LOGIN authentication</para>
|
---|
| 156 |
|
---|
| 157 | <para><option>--enable-ntlm</option>: This option enables unsupported
|
---|
| 158 | NTLM authentication</para>
|
---|
| 159 |
|
---|
[0afcfa88] | 160 | <para><command>install -v -m644 ...</command>: These commands
|
---|
| 161 | install documentation which is not installed by the
|
---|
[1cc0752] | 162 | <command>make install</command> command.</para>
|
---|
| 163 |
|
---|
[fae66a0] | 164 | <para><command>install -v -m700 -d /var/lib/sasl</command>:
|
---|
[a649c92c] | 165 | This directory must exist when starting <command>saslauthd</command> or
|
---|
[a273763] | 166 | using the sasldb plugin. If you're not going to be running the daemon or
|
---|
| 167 | using the plugins, you may omit the creation of this directory.</para>
|
---|
[1cc0752] | 168 |
|
---|
| 169 | </sect2>
|
---|
| 170 |
|
---|
| 171 | <sect2 role="configuration">
|
---|
| 172 | <title>Configuring Cyrus SASL</title>
|
---|
| 173 |
|
---|
| 174 | <sect3 id="cyrus-sasl-config">
|
---|
| 175 | <title>Config Files</title>
|
---|
| 176 |
|
---|
[4891ef3] | 177 | <para><filename>/etc/saslauthd.conf</filename> (for
|
---|
| 178 | <command>saslauthd</command> LDAP configuration)
|
---|
[a273763] | 179 | and <filename>/etc/sasl2/Appname.conf</filename> (where "Appname"
|
---|
[1cc0752] | 180 | is the application defined name of the application)</para>
|
---|
| 181 |
|
---|
| 182 | <indexterm zone="cyrus-sasl cyrus-sasl-config">
|
---|
| 183 | <primary sortas="e-etc-saslauthd.conf">/etc/saslauthd.conf</primary>
|
---|
| 184 | </indexterm>
|
---|
| 185 |
|
---|
| 186 | </sect3>
|
---|
| 187 |
|
---|
| 188 | <sect3>
|
---|
| 189 | <title>Configuration Information</title>
|
---|
| 190 |
|
---|
[0afcfa88] | 191 | <para>See <ulink
|
---|
[d612b9f] | 192 | url="file:///usr/share/doc/cyrus-sasl-&cyrus-sasl-version;/sysadmin.html"/>
|
---|
[0afcfa88] | 193 | for information on what to include in the application configuration files.
|
---|
[fae66a0] | 194 | </para><para>
|
---|
[0afcfa88] | 195 | See <ulink
|
---|
[d612b9f] | 196 | url="file:///usr/share/doc/cyrus-sasl-&cyrus-sasl-version;/LDAP_SASLAUTHD"/>
|
---|
[1f01e700] | 197 | for configuring <command>saslauthd</command> with
|
---|
[fae66a0] | 198 | <application>OpenLDAP</application>.</para><para>
|
---|
| 199 | See <ulink
|
---|
| 200 | url="file:///usr/share/doc/cyrus-sasl-&cyrus-sasl-version;/gssapi.html"/>
|
---|
| 201 | for configuring <command>saslauthd</command> with
|
---|
| 202 | <application>Kerberos</application>.
|
---|
| 203 | </para>
|
---|
[1cc0752] | 204 |
|
---|
| 205 | </sect3>
|
---|
| 206 |
|
---|
| 207 | <sect3 id="cyrus-sasl-init">
|
---|
| 208 | <title>Init Script</title>
|
---|
| 209 |
|
---|
[0afcfa88] | 210 | <para>If you need to run the <command>saslauthd</command> daemon at system
|
---|
[d9d26317] | 211 | startup, install the <filename>/etc/rc.d/init.d/saslauthd</filename>
|
---|
[5254d12] | 212 | init script included in the <xref linkend="bootscripts"/>
|
---|
[d9d26317] | 213 | package using the following command:</para>
|
---|
[1cc0752] | 214 |
|
---|
| 215 | <indexterm zone="cyrus-sasl cyrus-sasl-init">
|
---|
[d9d26317] | 216 | <primary sortas="f-saslauthd">saslauthd</primary>
|
---|
[1cc0752] | 217 | </indexterm>
|
---|
| 218 |
|
---|
[d9d26317] | 219 | <screen role="root"><userinput>make install-saslauthd</userinput></screen>
|
---|
[1cc0752] | 220 |
|
---|
| 221 | <note>
|
---|
[d9d26317] | 222 | <para>You'll need to modify /etc/sysconfig/saslauthd and replace the
|
---|
[fae66a0] | 223 | <option><replaceable>AUTHMECH</replaceable></option> parameter
|
---|
| 224 | with your desired authentication mechanism.</para>
|
---|
[1cc0752] | 225 | </note>
|
---|
| 226 |
|
---|
| 227 | </sect3>
|
---|
| 228 |
|
---|
| 229 | </sect2>
|
---|
| 230 |
|
---|
| 231 | <sect2 role="content">
|
---|
| 232 | <title>Contents</title>
|
---|
| 233 |
|
---|
| 234 | <segmentedlist>
|
---|
| 235 | <segtitle>Installed Programs</segtitle>
|
---|
| 236 | <segtitle>Installed Libraries</segtitle>
|
---|
| 237 | <segtitle>Installed Directories</segtitle>
|
---|
| 238 |
|
---|
| 239 | <seglistitem>
|
---|
[fae66a0] | 240 | <seg>pluginviewer, saslauthd, sasldblistusers2, saslpasswd2 and testsaslauthd</seg>
|
---|
| 241 | <seg>libsasl2.so, and numerous SASL plugins</seg>
|
---|
| 242 | <seg>/usr/include/sasl, /usr/lib/sasl2,
|
---|
[1cc0752] | 243 | /usr/share/doc/cyrus-sasl-&cyrus-sasl-version;, and /var/lib/sasl</seg>
|
---|
| 244 | </seglistitem>
|
---|
| 245 | </segmentedlist>
|
---|
| 246 |
|
---|
| 247 | <variablelist>
|
---|
| 248 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 249 | <?dbfo list-presentation="list"?>
|
---|
| 250 | <?dbhtml list-presentation="table"?>
|
---|
| 251 |
|
---|
[fae66a0] | 252 | <varlistentry id="pluginviewer">
|
---|
| 253 | <term><command>pluginviewer</command></term>
|
---|
| 254 | <listitem>
|
---|
| 255 | <para>is used to list loadable SASL plugins and their properties.</para>
|
---|
| 256 | <indexterm zone="cyrus-sasl pluginviewer">
|
---|
| 257 | <primary sortas="b-pluginviewer">pluginviewer</primary>
|
---|
| 258 | </indexterm>
|
---|
| 259 | </listitem>
|
---|
| 260 | </varlistentry>
|
---|
| 261 |
|
---|
[1cc0752] | 262 | <varlistentry id="saslauthd">
|
---|
| 263 | <term><command>saslauthd</command></term>
|
---|
| 264 | <listitem>
|
---|
| 265 | <para>is the SASL authentication server.</para>
|
---|
| 266 | <indexterm zone="cyrus-sasl saslauthd">
|
---|
| 267 | <primary sortas="b-saslauthd">saslauthd</primary>
|
---|
| 268 | </indexterm>
|
---|
| 269 | </listitem>
|
---|
| 270 | </varlistentry>
|
---|
| 271 |
|
---|
| 272 | <varlistentry id="sasldblistusers2">
|
---|
| 273 | <term><command>sasldblistusers2</command></term>
|
---|
| 274 | <listitem>
|
---|
[4891ef3] | 275 | <para>is used to list the users in the SASL password database
|
---|
| 276 | <filename>sasldb2</filename>.</para>
|
---|
[1cc0752] | 277 | <indexterm zone="cyrus-sasl sasldblistusers2">
|
---|
| 278 | <primary sortas="b-sasldblistusers2">sasldblistusers2</primary>
|
---|
| 279 | </indexterm>
|
---|
| 280 | </listitem>
|
---|
| 281 | </varlistentry>
|
---|
| 282 |
|
---|
| 283 | <varlistentry id="saslpasswd2">
|
---|
| 284 | <term><command>saslpasswd2</command></term>
|
---|
| 285 | <listitem>
|
---|
[0afcfa88] | 286 | <para>is used to set and delete a user's SASL password and
|
---|
[4891ef3] | 287 | mechanism specific secrets in the SASL password database
|
---|
| 288 | <filename>sasldb2</filename>.</para>
|
---|
[1cc0752] | 289 | <indexterm zone="cyrus-sasl saslpasswd2">
|
---|
| 290 | <primary sortas="b-saslpasswd2">saslpasswd2</primary>
|
---|
| 291 | </indexterm>
|
---|
| 292 | </listitem>
|
---|
| 293 | </varlistentry>
|
---|
| 294 |
|
---|
[fae66a0] | 295 | <varlistentry id="testsaslauthd">
|
---|
| 296 | <term><command>testsaslauthd</command></term>
|
---|
| 297 | <listitem>
|
---|
| 298 | <para>is a test utility for the SASL authentication server.</para>
|
---|
| 299 | <indexterm zone="cyrus-sasl testsaslauthd">
|
---|
| 300 | <primary sortas="b-testsaslauthd">testsaslauthd</primary>
|
---|
| 301 | </indexterm>
|
---|
| 302 | </listitem>
|
---|
| 303 | </varlistentry>
|
---|
| 304 |
|
---|
[1cc0752] | 305 | <varlistentry id="libsasl2">
|
---|
| 306 | <term><filename class='libraryfile'>libsasl2.so</filename></term>
|
---|
| 307 | <listitem>
|
---|
[0afcfa88] | 308 | <para>is a general purpose authentication library for server and
|
---|
[1cc0752] | 309 | client applications.</para>
|
---|
| 310 | <indexterm zone="cyrus-sasl libsasl2">
|
---|
| 311 | <primary sortas="c-libsasl2">libsasl2.so</primary>
|
---|
| 312 | </indexterm>
|
---|
| 313 | </listitem>
|
---|
| 314 | </varlistentry>
|
---|
| 315 |
|
---|
| 316 | </variablelist>
|
---|
| 317 |
|
---|
| 318 | </sect2>
|
---|
| 319 |
|
---|
| 320 | </sect1>
|
---|