[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">
|
---|
[1f01e700] | 9 | <!ENTITY cyrus-sasl-md5sum "dde02db234dea892bee298390890502e">
|
---|
| 10 | <!ENTITY cyrus-sasl-size "1.6 MB">
|
---|
| 11 | <!ENTITY cyrus-sasl-buildsize "16 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>
|
---|
[e19ad480] | 21 | <keywordset>
|
---|
| 22 | <keyword role="package">cyrus-sasl-&cyrus-sasl-version;.tar</keyword>
|
---|
[9084c2eb] | 23 | <keyword role="ftpdir">cyrus-sasl</keyword>
|
---|
[e19ad480] | 24 | </keywordset>
|
---|
[1cc0752] | 25 | </sect1info>
|
---|
| 26 |
|
---|
| 27 | <title>Cyrus SASL-&cyrus-sasl-version;</title>
|
---|
| 28 |
|
---|
| 29 | <indexterm zone="cyrus-sasl">
|
---|
| 30 | <primary sortas="a-Cyrus-SASL">Cyrus SASL</primary>
|
---|
| 31 | </indexterm>
|
---|
| 32 |
|
---|
| 33 | <sect2 role="package">
|
---|
| 34 | <title>Introduction to Cyrus SASL</title>
|
---|
| 35 |
|
---|
[0afcfa88] | 36 | <para>The <application>Cyrus SASL</application> package contains a Simple
|
---|
| 37 | Authentication and Security Layer, a method for adding authentication
|
---|
| 38 | support to connection-based protocols. To use SASL, a protocol includes a
|
---|
| 39 | command for identifying and authenticating a user to a server and for
|
---|
| 40 | optionally negotiating protection of subsequent protocol interactions. If
|
---|
| 41 | its use is negotiated, a security layer is inserted between the protocol
|
---|
[1cc0752] | 42 | and the connection.</para>
|
---|
| 43 |
|
---|
| 44 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 45 | <itemizedlist spacing="compact">
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>Download (HTTP): <ulink url="&cyrus-sasl-download-http;"/></para>
|
---|
| 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
| 50 | <para>Download (FTP): <ulink url="&cyrus-sasl-download-ftp;"/></para>
|
---|
| 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
| 53 | <para>Download MD5 sum: &cyrus-sasl-md5sum;</para>
|
---|
| 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
| 56 | <para>Download size: &cyrus-sasl-size;</para>
|
---|
| 57 | </listitem>
|
---|
| 58 | <listitem>
|
---|
| 59 | <para>Estimated disk space required: &cyrus-sasl-buildsize;</para>
|
---|
| 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
| 62 | <para>Estimated build time: &cyrus-sasl-time;</para>
|
---|
| 63 | </listitem>
|
---|
| 64 | </itemizedlist>
|
---|
| 65 |
|
---|
[42cedf2] | 66 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
| 67 | <itemizedlist spacing="compact">
|
---|
| 68 | <listitem>
|
---|
| 69 | <para>Required patch: <ulink
|
---|
| 70 | url="&patch-root;/cyrus-sasl-&cyrus-sasl-version;-gcc4-1.patch"/></para>
|
---|
| 71 | </listitem>
|
---|
| 72 | </itemizedlist>
|
---|
| 73 |
|
---|
[1cc0752] | 74 | <bridgehead renderas="sect3">Cyrus SASL Dependencies</bridgehead>
|
---|
| 75 |
|
---|
| 76 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[e19ad480] | 77 | <para role="required"><xref linkend="openssl"/></para>
|
---|
[1cc0752] | 78 |
|
---|
| 79 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[e19ad480] | 80 | <para role="optional"><xref linkend="linux-pam"/>,
|
---|
[0afcfa88] | 81 | <xref linkend="openldap"/>,
|
---|
| 82 | <xref linkend="heimdal"/> or <xref linkend="mitkrb"/>,
|
---|
| 83 | <xref linkend="jdk"/>,
|
---|
| 84 | <xref linkend="mysql"/>,
|
---|
| 85 | <xref linkend="postgresql"/>,
|
---|
| 86 | <xref linkend="db"/>,
|
---|
| 87 | <xref linkend="gdbm"/>,
|
---|
[b0ff55f3] | 88 | <!-- <xref linkend="courier"/>, -->
|
---|
[0afcfa88] | 89 | <ulink url="http://www.pdc.kth.se/kth-krb/">krb4</ulink>,
|
---|
| 90 | <ulink url="http://sqlite.org/">SQLite</ulink> and
|
---|
[1cc0752] | 91 | <ulink url="http://dmalloc.com/">Dmalloc</ulink></para>
|
---|
| 92 |
|
---|
| 93 | </sect2>
|
---|
| 94 |
|
---|
| 95 | <sect2 role="installation">
|
---|
| 96 | <title>Installation of Cyrus SASL</title>
|
---|
| 97 |
|
---|
[0afcfa88] | 98 | <para>Install <application>Cyrus SASL</application> by
|
---|
[1cc0752] | 99 | running the following commands:</para>
|
---|
| 100 |
|
---|
[42cedf2] | 101 | <screen><userinput>patch -Np1 -i ../cyrus-sasl-&cyrus-sasl-version;-gcc4-1.patch &&
|
---|
| 102 | ./configure --prefix=/usr --sysconfdir=/etc \
|
---|
[a8c9494] | 103 | --with-dbpath=/var/lib/sasl/sasldb2 \
|
---|
| 104 | --with-saslauthd=/var/run &&
|
---|
[1cc0752] | 105 | make</userinput></screen>
|
---|
[305e60de] | 106 |
|
---|
[1f01e700] | 107 | <para>This package does not come with a test suite. If you are planning
|
---|
| 108 | on using the GSSAPI authentication mechanism, it is recommended to test
|
---|
| 109 | it after installing the package using the sample server and client programs
|
---|
| 110 | which were built in the preceding step. Instructions for performing the
|
---|
| 111 | tests can be found at <ulink
|
---|
[01bf7b38] | 112 | url="&hints-root;/downloads/files/cyrus-sasl.txt"/>.</para>
|
---|
[1f01e700] | 113 |
|
---|
[1cc0752] | 114 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
[305e60de] | 115 |
|
---|
[1cc0752] | 116 | <screen role="root"><userinput>make install &&
|
---|
[1f01e700] | 117 | install -v -m644 saslauthd/saslauthd.8 /usr/share/man/man8 &&
|
---|
| 118 | install -v -m755 -d /usr/share/doc/cyrus-sasl-&cyrus-sasl-version; &&
|
---|
[dfdbccd] | 119 | install -v -m644 doc/{*.{html,txt,fig},ONEWS,TODO} \
|
---|
[72e3bf7] | 120 | saslauthd/LDAP_SASLAUTHD /usr/share/doc/cyrus-sasl-&cyrus-sasl-version; &&
|
---|
[1f01e700] | 121 | install -v -m700 -d /var/lib/sasl</userinput></screen>
|
---|
[da4aff6] | 122 |
|
---|
[1cc0752] | 123 | </sect2>
|
---|
| 124 |
|
---|
| 125 | <sect2 role="commands">
|
---|
| 126 | <title>Command Explanations</title>
|
---|
| 127 |
|
---|
[0afcfa88] | 128 | <para><parameter>--with-dbpath=/var/lib/sasl/sasldb2</parameter>: This
|
---|
[1cc0752] | 129 | parameter forces the <command>saslauthd</command> database to be created
|
---|
[0afcfa88] | 130 | in <filename class='directory'>/var/lib/sasl</filename> instead of
|
---|
[1cc0752] | 131 | <filename class='directory'>/etc</filename>.</para>
|
---|
[da4aff6] | 132 |
|
---|
[0afcfa88] | 133 | <para><parameter>--with-saslauthd=/var/run</parameter>: This parameter
|
---|
| 134 | forces <command>saslauthd</command> to use the FHS compliant
|
---|
| 135 | directory <filename class='directory'>/var/run</filename> for variable
|
---|
[1cc0752] | 136 | run-time data.</para>
|
---|
| 137 |
|
---|
| 138 | <para><option>--with-ldap</option>: This parameter enables use
|
---|
| 139 | with <application>OpenLDAP</application>.</para>
|
---|
| 140 |
|
---|
[1f01e700] | 141 | <para><option>--enable-ldapdb</option>: This parameter enables the
|
---|
| 142 | LDAPDB authentication backend. There is a circular dependency with this
|
---|
| 143 | parameter which requires you to build the
|
---|
| 144 | <application>Cyrus SASL</application> package, then the
|
---|
| 145 | <application>OpenLDAP</application> package (with SASL support), then
|
---|
| 146 | finally building the <application>Cyrus SASL</application> package again
|
---|
| 147 | with this parameter.</para>
|
---|
| 148 |
|
---|
[0afcfa88] | 149 | <para><command>install -v -m644 ...</command>: These commands
|
---|
| 150 | install documentation which is not installed by the
|
---|
[1cc0752] | 151 | <command>make install</command> command.</para>
|
---|
| 152 |
|
---|
[1f01e700] | 153 | <para><command>install -v -m700 -d /var/lib/sasl</command>: This directory
|
---|
[0afcfa88] | 154 | must exist when starting <command>saslauthd</command>. If you're not going
|
---|
[1cc0752] | 155 | to be running the daemon, you may omit the creation of this directory.</para>
|
---|
| 156 |
|
---|
| 157 | </sect2>
|
---|
| 158 |
|
---|
| 159 | <sect2 role="configuration">
|
---|
| 160 | <title>Configuring Cyrus SASL</title>
|
---|
| 161 |
|
---|
| 162 | <sect3 id="cyrus-sasl-config">
|
---|
| 163 | <title>Config Files</title>
|
---|
| 164 |
|
---|
[0afcfa88] | 165 | <para><filename>/etc/saslauthd.conf</filename> (for LDAP configuration)
|
---|
| 166 | and <filename>/usr/lib/sasl2/Appname.conf</filename> (where "Appname"
|
---|
[1cc0752] | 167 | is the application defined name of the application)</para>
|
---|
| 168 |
|
---|
| 169 | <indexterm zone="cyrus-sasl cyrus-sasl-config">
|
---|
| 170 | <primary sortas="e-etc-saslauthd.conf">/etc/saslauthd.conf</primary>
|
---|
| 171 | </indexterm>
|
---|
| 172 |
|
---|
| 173 | </sect3>
|
---|
| 174 |
|
---|
| 175 | <sect3>
|
---|
| 176 | <title>Configuration Information</title>
|
---|
| 177 |
|
---|
[0afcfa88] | 178 | <para>See <ulink
|
---|
[d612b9f] | 179 | url="file:///usr/share/doc/cyrus-sasl-&cyrus-sasl-version;/sysadmin.html"/>
|
---|
[0afcfa88] | 180 | for information on what to include in the application configuration files.
|
---|
| 181 | See <ulink
|
---|
[d612b9f] | 182 | url="file:///usr/share/doc/cyrus-sasl-&cyrus-sasl-version;/LDAP_SASLAUTHD"/>
|
---|
[1f01e700] | 183 | for configuring <command>saslauthd</command> with
|
---|
| 184 | <application>OpenLDAP</application>.</para>
|
---|
[1cc0752] | 185 |
|
---|
| 186 | </sect3>
|
---|
| 187 |
|
---|
| 188 | <sect3 id="cyrus-sasl-init">
|
---|
| 189 | <title>Init Script</title>
|
---|
| 190 |
|
---|
[0afcfa88] | 191 | <para>If you need to run the <command>saslauthd</command> daemon at system
|
---|
[1cc0752] | 192 | startup, install the <filename>/etc/rc.d/init.d/cyrus-sasl</filename>
|
---|
[d612b9f] | 193 | init script included in the <xref linkend="intro-important-bootscripts"/>
|
---|
[1cc0752] | 194 | package.</para>
|
---|
| 195 |
|
---|
| 196 | <indexterm zone="cyrus-sasl cyrus-sasl-init">
|
---|
| 197 | <primary sortas="f-cyrus-sasl-init">cyrus-sasl</primary>
|
---|
| 198 | </indexterm>
|
---|
| 199 |
|
---|
| 200 | <screen role="root"><userinput>make install-cyrus-sasl</userinput></screen>
|
---|
| 201 |
|
---|
| 202 | <note>
|
---|
[0afcfa88] | 203 | <para>You'll need to modify the init script and replace the
|
---|
| 204 | <option><replaceable>[authmech]</replaceable></option> parameter
|
---|
| 205 | to the <option>-a</option> switch with your desired authentication
|
---|
[1cc0752] | 206 | mechanism.</para>
|
---|
| 207 | </note>
|
---|
| 208 |
|
---|
| 209 | </sect3>
|
---|
| 210 |
|
---|
| 211 | </sect2>
|
---|
| 212 |
|
---|
| 213 | <sect2 role="content">
|
---|
| 214 | <title>Contents</title>
|
---|
| 215 |
|
---|
| 216 | <segmentedlist>
|
---|
| 217 | <segtitle>Installed Programs</segtitle>
|
---|
| 218 | <segtitle>Installed Libraries</segtitle>
|
---|
| 219 | <segtitle>Installed Directories</segtitle>
|
---|
| 220 |
|
---|
| 221 | <seglistitem>
|
---|
| 222 | <seg>saslauthd, sasldblistusers2, and saslpasswd2</seg>
|
---|
[1f01e700] | 223 | <seg>libjavasasl.so, libsasl2.so, and numerous SASL plugins and
|
---|
| 224 | Java classes</seg>
|
---|
| 225 | <seg>/usr/include/sasl, /usr/lib/java/classes/sasl, /usr/lib/sasl2,
|
---|
[1cc0752] | 226 | /usr/share/doc/cyrus-sasl-&cyrus-sasl-version;, and /var/lib/sasl</seg>
|
---|
| 227 | </seglistitem>
|
---|
| 228 | </segmentedlist>
|
---|
| 229 |
|
---|
| 230 | <variablelist>
|
---|
| 231 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 232 | <?dbfo list-presentation="list"?>
|
---|
| 233 | <?dbhtml list-presentation="table"?>
|
---|
| 234 |
|
---|
| 235 | <varlistentry id="saslauthd">
|
---|
| 236 | <term><command>saslauthd</command></term>
|
---|
| 237 | <listitem>
|
---|
| 238 | <para>is the SASL authentication server.</para>
|
---|
| 239 | <indexterm zone="cyrus-sasl saslauthd">
|
---|
| 240 | <primary sortas="b-saslauthd">saslauthd</primary>
|
---|
| 241 | </indexterm>
|
---|
| 242 | </listitem>
|
---|
| 243 | </varlistentry>
|
---|
| 244 |
|
---|
| 245 | <varlistentry id="sasldblistusers2">
|
---|
| 246 | <term><command>sasldblistusers2</command></term>
|
---|
| 247 | <listitem>
|
---|
| 248 | <para>is used to list the users in the SASL password database.</para>
|
---|
| 249 | <indexterm zone="cyrus-sasl sasldblistusers2">
|
---|
| 250 | <primary sortas="b-sasldblistusers2">sasldblistusers2</primary>
|
---|
| 251 | </indexterm>
|
---|
| 252 | </listitem>
|
---|
| 253 | </varlistentry>
|
---|
| 254 |
|
---|
| 255 | <varlistentry id="saslpasswd2">
|
---|
| 256 | <term><command>saslpasswd2</command></term>
|
---|
| 257 | <listitem>
|
---|
[0afcfa88] | 258 | <para>is used to set and delete a user's SASL password and
|
---|
[1cc0752] | 259 | mechanism specific secrets in the SASL password database.</para>
|
---|
| 260 | <indexterm zone="cyrus-sasl saslpasswd2">
|
---|
| 261 | <primary sortas="b-saslpasswd2">saslpasswd2</primary>
|
---|
| 262 | </indexterm>
|
---|
| 263 | </listitem>
|
---|
| 264 | </varlistentry>
|
---|
| 265 |
|
---|
| 266 | <varlistentry id="libsasl2">
|
---|
| 267 | <term><filename class='libraryfile'>libsasl2.so</filename></term>
|
---|
| 268 | <listitem>
|
---|
[0afcfa88] | 269 | <para>is a general purpose authentication library for server and
|
---|
[1cc0752] | 270 | client applications.</para>
|
---|
| 271 | <indexterm zone="cyrus-sasl libsasl2">
|
---|
| 272 | <primary sortas="c-libsasl2">libsasl2.so</primary>
|
---|
| 273 | </indexterm>
|
---|
| 274 | </listitem>
|
---|
| 275 | </varlistentry>
|
---|
| 276 |
|
---|
| 277 | </variablelist>
|
---|
| 278 |
|
---|
| 279 | </sect2>
|
---|
| 280 |
|
---|
| 281 | </sect1>
|
---|