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