[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 |
|
---|
[faf325d] | 7 | <!ENTITY cyrus-sasl-download-http " ">
|
---|
| 8 | <!ENTITY cyrus-sasl-download-ftp "ftp://ftp.cyrusimap.org/cyrus-sasl/cyrus-sasl-&cyrus-sasl-version;.tar.gz">
|
---|
| 9 | <!ENTITY cyrus-sasl-md5sum "a7f4e5e559a0e37b3ffc438c9456e425">
|
---|
[fae66a0] | 10 | <!ENTITY cyrus-sasl-size "5.0 MB">
|
---|
[faf325d] | 11 | <!ENTITY cyrus-sasl-buildsize "30 MB">
|
---|
[fae66a0] | 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 |
|
---|
[faf325d] | 32 | <para>
|
---|
| 33 | The <application>Cyrus SASL</application> package contains a Simple
|
---|
| 34 | Authentication and Security Layer, a method for adding authentication
|
---|
| 35 | support to connection-based protocols. To use SASL, a protocol includes
|
---|
| 36 | a command for identifying and authenticating a user to a server and for
|
---|
| 37 | optionally negotiating protection of subsequent protocol interactions.
|
---|
| 38 | If its use is negotiated, a security layer is inserted between the
|
---|
| 39 | protocol and the connection.
|
---|
| 40 | </para>
|
---|
[1cc0752] | 41 |
|
---|
[f7412376] | 42 | &lfs77_checked; &gcc5_built;
|
---|
[fae66a0] | 43 |
|
---|
[1cc0752] | 44 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 45 | <itemizedlist spacing="compact">
|
---|
| 46 | <listitem>
|
---|
[faf325d] | 47 | <para>
|
---|
| 48 | Download (HTTP): <ulink url="&cyrus-sasl-download-http;"/>
|
---|
| 49 | </para>
|
---|
[1cc0752] | 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
[faf325d] | 52 | <para>
|
---|
| 53 | Download (FTP): <ulink url="&cyrus-sasl-download-ftp;"/>
|
---|
| 54 | </para>
|
---|
[1cc0752] | 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
[faf325d] | 57 | <para>
|
---|
| 58 | Download MD5 sum: &cyrus-sasl-md5sum;
|
---|
| 59 | </para>
|
---|
[1cc0752] | 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
[faf325d] | 62 | <para>
|
---|
| 63 | Download size: &cyrus-sasl-size;
|
---|
| 64 | </para>
|
---|
[1cc0752] | 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
[faf325d] | 67 | <para>
|
---|
| 68 | Estimated disk space required: &cyrus-sasl-buildsize;
|
---|
| 69 | </para>
|
---|
[1cc0752] | 70 | </listitem>
|
---|
| 71 | <listitem>
|
---|
[faf325d] | 72 | <para>
|
---|
| 73 | Estimated build time: &cyrus-sasl-time;
|
---|
| 74 | </para>
|
---|
[1cc0752] | 75 | </listitem>
|
---|
| 76 | </itemizedlist>
|
---|
| 77 |
|
---|
[fae66a0] | 78 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
| 79 | <itemizedlist spacing="compact">
|
---|
| 80 | <listitem>
|
---|
[faf325d] | 81 | <para>
|
---|
| 82 | Required patch:
|
---|
[643ea8d7] | 83 | <ulink url="&patch-root;/cyrus-sasl-&cyrus-sasl-version;-fixes-3.patch"/>
|
---|
[faf325d] | 84 | </para>
|
---|
[fae66a0] | 85 | </listitem>
|
---|
| 86 | </itemizedlist>
|
---|
| 87 |
|
---|
[1cc0752] | 88 | <bridgehead renderas="sect3">Cyrus SASL Dependencies</bridgehead>
|
---|
| 89 |
|
---|
| 90 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[faf325d] | 91 | <para role="required">
|
---|
| 92 | <xref linkend="openssl"/>
|
---|
| 93 | </para>
|
---|
[1cc0752] | 94 |
|
---|
[fae66a0] | 95 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
[faf325d] | 96 | <para role="recommended">
|
---|
| 97 | <xref linkend="db"/>
|
---|
| 98 | </para>
|
---|
[fae66a0] | 99 |
|
---|
[1cc0752] | 100 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[faf325d] | 101 | <para role="optional">
|
---|
| 102 | <xref linkend="linux-pam"/>,
|
---|
| 103 | <xref linkend="mitkrb"/>,
|
---|
[5e0662d] | 104 | <xref linkend="mariadb"/> or <ulink url="http://www.mysql.com/">MySQL</ulink>,
|
---|
[faf325d] | 105 | <xref linkend="openjdk"/>,
|
---|
| 106 | <xref linkend="openldap"/>,
|
---|
| 107 | <xref linkend="postgresql"/>,
|
---|
| 108 | <xref linkend="sqlite"/>,
|
---|
[31d6e38] | 109 | <ulink url="ftp://ftp.pdc.kth.se/pub/krb/src/">krb4</ulink> and
|
---|
[faf325d] | 110 | <ulink url="http://dmalloc.com/">Dmalloc</ulink>
|
---|
| 111 | </para>
|
---|
[1cc0752] | 112 |
|
---|
[3597eb6] | 113 | <para condition="html" role="usernotes">User Notes:
|
---|
[faf325d] | 114 | <ulink url="&blfs-wiki;/cyrus-sasl"/>
|
---|
| 115 | </para>
|
---|
[1cc0752] | 116 | </sect2>
|
---|
| 117 |
|
---|
| 118 | <sect2 role="installation">
|
---|
| 119 | <title>Installation of Cyrus SASL</title>
|
---|
| 120 |
|
---|
[faf325d] | 121 | <para>
|
---|
| 122 | Install <application>Cyrus SASL</application> by
|
---|
| 123 | running the following commands:
|
---|
| 124 | </para>
|
---|
[1cc0752] | 125 |
|
---|
[643ea8d7] | 126 | <screen><userinput>patch -Np1 -i ../cyrus-sasl-&cyrus-sasl-version;-fixes-3.patch &&
|
---|
[faf325d] | 127 | autoreconf -fi &&
|
---|
[aed3e6ec] | 128 |
|
---|
[15fc6d6] | 129 | ./configure --prefix=/usr \
|
---|
| 130 | --sysconfdir=/etc \
|
---|
| 131 | --enable-auth-sasldb \
|
---|
[a8c9494] | 132 | --with-dbpath=/var/lib/sasl/sasldb2 \
|
---|
[643ea8d7] | 133 | --with-saslauthd=/var/run/saslauthd &&
|
---|
[aed3e6ec] | 134 | make -j1</userinput></screen>
|
---|
[305e60de] | 135 |
|
---|
[faf325d] | 136 | <para>
|
---|
| 137 | This package does not come with a test suite. If you are planning
|
---|
| 138 | on using the GSSAPI authentication mechanism, it is recommended to test
|
---|
| 139 | it after installing the package using the sample server and client
|
---|
| 140 | programs which were built in the preceding step. Instructions for
|
---|
| 141 | performing the tests can be found at
|
---|
| 142 | <ulink url="&hints-root;/downloads/files/cyrus-sasl.txt"/>.
|
---|
| 143 | </para>
|
---|
[1f01e700] | 144 |
|
---|
[faf325d] | 145 | <para>
|
---|
| 146 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 147 | </para>
|
---|
[305e60de] | 148 |
|
---|
[1cc0752] | 149 | <screen role="root"><userinput>make install &&
|
---|
[faf325d] | 150 | install -v -dm755 /usr/share/doc/cyrus-sasl-&cyrus-sasl-version; &&
|
---|
| 151 | install -v -m644 doc/{*.{html,txt,fig},ONEWS,TODO} \
|
---|
[72e3bf7] | 152 | saslauthd/LDAP_SASLAUTHD /usr/share/doc/cyrus-sasl-&cyrus-sasl-version; &&
|
---|
[faf325d] | 153 | install -v -dm700 /var/lib/sasl</userinput></screen>
|
---|
[da4aff6] | 154 |
|
---|
[1cc0752] | 155 | </sect2>
|
---|
| 156 |
|
---|
| 157 | <sect2 role="commands">
|
---|
| 158 | <title>Command Explanations</title>
|
---|
| 159 |
|
---|
[faf325d] | 160 | <para>
|
---|
| 161 | <parameter>--with-dbpath=/var/lib/sasl/sasldb2</parameter>: This
|
---|
| 162 | switch forces the <command>sasldb</command> database to be created
|
---|
| 163 | in <filename class="directory">/var/lib/sasl</filename> instead of
|
---|
| 164 | <filename class="directory">/etc</filename>.
|
---|
| 165 | </para>
|
---|
| 166 |
|
---|
| 167 | <para>
|
---|
| 168 | <parameter>--with-saslauthd=/var/run/saslauthd</parameter>: This
|
---|
| 169 | switch forces <command>saslauthd</command> to use the FHS compliant
|
---|
| 170 | directory <filename class="directory">/var/run/saslauthd</filename>
|
---|
| 171 | for variable run-time data.
|
---|
| 172 | </para>
|
---|
| 173 |
|
---|
[a5ce76f] | 174 | <para>
|
---|
| 175 | <parameter>--enable-auth-sasldb</parameter>: This switch enables
|
---|
| 176 | SASLDB authentication backend.
|
---|
| 177 | </para>
|
---|
| 178 |
|
---|
[faf325d] | 179 | <para>
|
---|
[f859e6fd] | 180 | <option>--with-dblib=gdbm</option>: This switch forces
|
---|
[faf325d] | 181 | <application>GDBM</application> to be used instead of
|
---|
| 182 | <application>Berkeley DB</application>.
|
---|
| 183 | </para>
|
---|
| 184 |
|
---|
| 185 | <para>
|
---|
| 186 | <option>--with-ldap</option>: This switch enables the
|
---|
| 187 | <application>OpenLDAP</application> support.
|
---|
| 188 | </para>
|
---|
| 189 |
|
---|
| 190 | <para>
|
---|
| 191 | <option>--enable-ldapdb</option>: This switch enables the
|
---|
| 192 | LDAPDB authentication backend. There is a circular dependency with this
|
---|
| 193 | parameter. See <ulink url="&blfs-wiki;/cyrus-sasl"/> for a solution to
|
---|
| 194 | this problem.
|
---|
| 195 | </para>
|
---|
| 196 |
|
---|
| 197 | <para>
|
---|
| 198 | <option>--enable-java</option>: This switch enables compiling of the
|
---|
| 199 | <application>Java</application> support libraries.
|
---|
| 200 | </para>
|
---|
| 201 |
|
---|
| 202 | <para>
|
---|
| 203 | <option>--enable-login</option>: This option enables unsupported
|
---|
| 204 | LOGIN authentication.
|
---|
| 205 | </para>
|
---|
| 206 |
|
---|
| 207 | <para>
|
---|
| 208 | <option>--enable-ntlm</option>: This option enables unsupported
|
---|
| 209 | NTLM authentication.
|
---|
| 210 | </para>
|
---|
| 211 |
|
---|
| 212 | <para>
|
---|
| 213 | <command>install -v -m644 ...</command>: These commands
|
---|
| 214 | install documentation which is not installed by the
|
---|
| 215 | <command>make install</command> command.
|
---|
| 216 | </para>
|
---|
| 217 |
|
---|
| 218 | <para>
|
---|
| 219 | <command>install -v -m700 -d /var/lib/sasl</command>: This directory
|
---|
| 220 | must exist when starting <command>saslauthd</command> or using the
|
---|
| 221 | sasldb plugin. If you're not going to be running the daemon or
|
---|
| 222 | using the plugins, you may omit the creation of this directory.
|
---|
| 223 | </para>
|
---|
[1cc0752] | 224 |
|
---|
| 225 | </sect2>
|
---|
| 226 |
|
---|
| 227 | <sect2 role="configuration">
|
---|
| 228 | <title>Configuring Cyrus SASL</title>
|
---|
| 229 |
|
---|
| 230 | <sect3 id="cyrus-sasl-config">
|
---|
| 231 | <title>Config Files</title>
|
---|
| 232 |
|
---|
[faf325d] | 233 | <para>
|
---|
| 234 | <filename>/etc/saslauthd.conf</filename>
|
---|
| 235 | (for <command>saslauthd</command> LDAP configuration) and
|
---|
| 236 | <filename>/etc/sasl2/Appname.conf</filename>
|
---|
| 237 | (where "Appname" is the application defined name of the application)
|
---|
| 238 | </para>
|
---|
[1cc0752] | 239 |
|
---|
| 240 | <indexterm zone="cyrus-sasl cyrus-sasl-config">
|
---|
| 241 | <primary sortas="e-etc-saslauthd.conf">/etc/saslauthd.conf</primary>
|
---|
| 242 | </indexterm>
|
---|
| 243 |
|
---|
| 244 | </sect3>
|
---|
| 245 |
|
---|
| 246 | <sect3>
|
---|
| 247 | <title>Configuration Information</title>
|
---|
| 248 |
|
---|
[faf325d] | 249 | <para>
|
---|
| 250 | See
|
---|
[0d381254] | 251 | <ulink url="file:///usr/share/doc/cyrus-sasl-&cyrus-sasl-version;/sysadmin.html"/>
|
---|
[faf325d] | 252 | for information on what to include in the application configuration files.
|
---|
| 253 | </para>
|
---|
| 254 |
|
---|
| 255 | <para>
|
---|
| 256 | See
|
---|
[0d381254] | 257 | <ulink url="file:///usr/share/doc/cyrus-sasl-&cyrus-sasl-version;/LDAP_SASLAUTHD"/>
|
---|
[faf325d] | 258 | for configuring <command>saslauthd</command> with
|
---|
| 259 | <application>OpenLDAP</application>.
|
---|
| 260 | </para>
|
---|
| 261 |
|
---|
| 262 | <para>
|
---|
| 263 | See
|
---|
[0d381254] | 264 | <ulink url="file:///usr/share/doc/cyrus-sasl-&cyrus-sasl-version;/gssapi.html"/>
|
---|
[faf325d] | 265 | for configuring <command>saslauthd</command> with <application>Kerberos</application>.
|
---|
[fae66a0] | 266 | </para>
|
---|
[1cc0752] | 267 |
|
---|
| 268 | </sect3>
|
---|
| 269 |
|
---|
[e445195] | 270 | <sect3 id="cyrus-sasl-init">
|
---|
| 271 | <title>Init Script</title>
|
---|
| 272 |
|
---|
| 273 | <para>
|
---|
| 274 | If you need to run the <command>saslauthd</command> daemon at system
|
---|
| 275 | startup, install the <filename>/etc/rc.d/init.d/saslauthd</filename>
|
---|
| 276 | init script included in the <xref linkend="bootscripts"/>
|
---|
| 277 | package using the following command:
|
---|
| 278 | </para>
|
---|
| 279 |
|
---|
| 280 | <indexterm zone="cyrus-sasl cyrus-sasl-init">
|
---|
| 281 | <primary sortas="f-saslauthd">saslauthd</primary>
|
---|
| 282 | </indexterm>
|
---|
| 283 |
|
---|
| 284 | <screen role="root"><userinput>make install-saslauthd</userinput></screen>
|
---|
| 285 |
|
---|
| 286 | <note>
|
---|
| 287 | <para>
|
---|
| 288 | You'll need to modify /etc/sysconfig/saslauthd and replace the
|
---|
| 289 | <option><replaceable>AUTHMECH</replaceable></option> parameter
|
---|
| 290 | with your desired authentication mechanism.
|
---|
| 291 | </para>
|
---|
| 292 | </note>
|
---|
| 293 |
|
---|
| 294 | </sect3>
|
---|
[1cc0752] | 295 |
|
---|
| 296 | </sect2>
|
---|
| 297 |
|
---|
| 298 | <sect2 role="content">
|
---|
| 299 | <title>Contents</title>
|
---|
| 300 |
|
---|
| 301 | <segmentedlist>
|
---|
| 302 | <segtitle>Installed Programs</segtitle>
|
---|
[faf325d] | 303 | <segtitle>Installed Library</segtitle>
|
---|
[1cc0752] | 304 | <segtitle>Installed Directories</segtitle>
|
---|
| 305 |
|
---|
| 306 | <seglistitem>
|
---|
[faf325d] | 307 | <seg>
|
---|
| 308 | pluginviewer, saslauthd, sasldblistusers2, saslpasswd2 and
|
---|
| 309 | testsaslauthd
|
---|
| 310 | </seg>
|
---|
| 311 | <seg>
|
---|
| 312 | libsasl2.so
|
---|
| 313 | </seg>
|
---|
| 314 | <seg>
|
---|
| 315 | /usr/include/sasl,
|
---|
| 316 | /usr/lib/sasl2,
|
---|
| 317 | /usr/share/doc/cyrus-sasl-&cyrus-sasl-version; and
|
---|
| 318 | /var/lib/sasl
|
---|
| 319 | </seg>
|
---|
[1cc0752] | 320 | </seglistitem>
|
---|
| 321 | </segmentedlist>
|
---|
| 322 |
|
---|
| 323 | <variablelist>
|
---|
| 324 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 325 | <?dbfo list-presentation="list"?>
|
---|
| 326 | <?dbhtml list-presentation="table"?>
|
---|
| 327 |
|
---|
[fae66a0] | 328 | <varlistentry id="pluginviewer">
|
---|
| 329 | <term><command>pluginviewer</command></term>
|
---|
| 330 | <listitem>
|
---|
[faf325d] | 331 | <para>
|
---|
| 332 | is used to list loadable SASL plugins and their properties.
|
---|
| 333 | </para>
|
---|
[fae66a0] | 334 | <indexterm zone="cyrus-sasl pluginviewer">
|
---|
| 335 | <primary sortas="b-pluginviewer">pluginviewer</primary>
|
---|
| 336 | </indexterm>
|
---|
| 337 | </listitem>
|
---|
| 338 | </varlistentry>
|
---|
| 339 |
|
---|
[1cc0752] | 340 | <varlistentry id="saslauthd">
|
---|
| 341 | <term><command>saslauthd</command></term>
|
---|
| 342 | <listitem>
|
---|
[faf325d] | 343 | <para>
|
---|
| 344 | is the SASL authentication server.
|
---|
| 345 | </para>
|
---|
[1cc0752] | 346 | <indexterm zone="cyrus-sasl saslauthd">
|
---|
| 347 | <primary sortas="b-saslauthd">saslauthd</primary>
|
---|
| 348 | </indexterm>
|
---|
| 349 | </listitem>
|
---|
| 350 | </varlistentry>
|
---|
| 351 |
|
---|
| 352 | <varlistentry id="sasldblistusers2">
|
---|
| 353 | <term><command>sasldblistusers2</command></term>
|
---|
| 354 | <listitem>
|
---|
[faf325d] | 355 | <para>
|
---|
| 356 | is used to list the users in the SASL password database
|
---|
| 357 | <filename>sasldb2</filename>.
|
---|
| 358 | </para>
|
---|
[1cc0752] | 359 | <indexterm zone="cyrus-sasl sasldblistusers2">
|
---|
| 360 | <primary sortas="b-sasldblistusers2">sasldblistusers2</primary>
|
---|
| 361 | </indexterm>
|
---|
| 362 | </listitem>
|
---|
| 363 | </varlistentry>
|
---|
| 364 |
|
---|
| 365 | <varlistentry id="saslpasswd2">
|
---|
| 366 | <term><command>saslpasswd2</command></term>
|
---|
| 367 | <listitem>
|
---|
[faf325d] | 368 | <para>
|
---|
| 369 | is used to set and delete a user's SASL password and
|
---|
| 370 | mechanism specific secrets in the SASL password
|
---|
| 371 | database <filename>sasldb2</filename>.
|
---|
| 372 | </para>
|
---|
[1cc0752] | 373 | <indexterm zone="cyrus-sasl saslpasswd2">
|
---|
| 374 | <primary sortas="b-saslpasswd2">saslpasswd2</primary>
|
---|
| 375 | </indexterm>
|
---|
| 376 | </listitem>
|
---|
| 377 | </varlistentry>
|
---|
| 378 |
|
---|
[fae66a0] | 379 | <varlistentry id="testsaslauthd">
|
---|
| 380 | <term><command>testsaslauthd</command></term>
|
---|
| 381 | <listitem>
|
---|
[faf325d] | 382 | <para>
|
---|
| 383 | is a test utility for the SASL authentication server.
|
---|
| 384 | </para>
|
---|
[fae66a0] | 385 | <indexterm zone="cyrus-sasl testsaslauthd">
|
---|
| 386 | <primary sortas="b-testsaslauthd">testsaslauthd</primary>
|
---|
| 387 | </indexterm>
|
---|
| 388 | </listitem>
|
---|
| 389 | </varlistentry>
|
---|
| 390 |
|
---|
[1cc0752] | 391 | <varlistentry id="libsasl2">
|
---|
[faf325d] | 392 | <term><filename class="libraryfile">libsasl2.so</filename></term>
|
---|
[1cc0752] | 393 | <listitem>
|
---|
[faf325d] | 394 | <para>
|
---|
| 395 | is a general purpose authentication library for server
|
---|
| 396 | and client applications.
|
---|
| 397 | </para>
|
---|
[1cc0752] | 398 | <indexterm zone="cyrus-sasl libsasl2">
|
---|
| 399 | <primary sortas="c-libsasl2">libsasl2.so</primary>
|
---|
| 400 | </indexterm>
|
---|
| 401 | </listitem>
|
---|
| 402 | </varlistentry>
|
---|
| 403 |
|
---|
| 404 | </variablelist>
|
---|
| 405 |
|
---|
| 406 | </sect2>
|
---|
| 407 |
|
---|
| 408 | </sect1>
|
---|