1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
|
---|
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">
|
---|
9 | <!ENTITY cyrus-sasl-md5sum "268ead27f4ac39bcfe17d9e38e0f2977">
|
---|
10 | <!ENTITY cyrus-sasl-size "1.7 MB">
|
---|
11 | <!ENTITY cyrus-sasl-buildsize "17 MB">
|
---|
12 | <!ENTITY cyrus-sasl-time "0.28 SBU">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="cyrus-sasl" xreflabel="Cyrus SASL-&cyrus-sasl-version;">
|
---|
16 | <sect1info>
|
---|
17 | <othername>$LastChangedBy$</othername>
|
---|
18 | <date>$Date$</date>
|
---|
19 | </sect1info>
|
---|
20 | <?dbhtml filename="cyrus-sasl.html"?>
|
---|
21 | <title>Cyrus <acronym>SASL</acronym>-&cyrus-sasl-version;</title>
|
---|
22 | <indexterm zone="cyrus-sasl">
|
---|
23 | <primary sortas="a-Cyrus-SASL">Cyrus SASL</primary></indexterm>
|
---|
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
|
---|
35 | is inserted between the protocol and the connection.</para>
|
---|
36 |
|
---|
37 | <sect3><title>Package information</title>
|
---|
38 | <itemizedlist spacing="compact">
|
---|
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>
|
---|
43 | <listitem><para>Download MD5 sum: &cyrus-sasl-md5sum;</para></listitem>
|
---|
44 | <listitem><para>Download size: &cyrus-sasl-size;</para></listitem>
|
---|
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>
|
---|
49 | </itemizedlist>
|
---|
50 | </sect3>
|
---|
51 |
|
---|
52 | <sect3><title><application>Cyrus <acronym>SASL</acronym></application>
|
---|
53 | dependencies</title>
|
---|
54 |
|
---|
55 | <sect4><title>Required</title>
|
---|
56 | <para><xref linkend="openssl"/></para>
|
---|
57 | </sect4>
|
---|
58 |
|
---|
59 | <sect4><title>Optional</title>
|
---|
60 | <para><xref linkend="Linux_PAM"/>,
|
---|
61 | <xref linkend="openldap"/>,
|
---|
62 | <xref linkend="heimdal"/> or <xref linkend="mitkrb"/>,
|
---|
63 | <xref linkend="jdk"/>,
|
---|
64 | <xref linkend="mysql"/>,
|
---|
65 | <xref linkend="postgresql"/>,
|
---|
66 | <xref linkend="db"/>,
|
---|
67 | <xref linkend="gdbm"/>,
|
---|
68 | <xref linkend="courier"/>,
|
---|
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>
|
---|
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 |
|
---|
84 | <screen><userinput><command>./configure --prefix=/usr --sysconfdir=/etc \
|
---|
85 | --with-dbpath=/var/lib/sasl/sasldb2 \
|
---|
86 | --with-saslauthd=/var/run &&
|
---|
87 | make</command></userinput></screen>
|
---|
88 |
|
---|
89 | <para>Now, as the root user:</para>
|
---|
90 |
|
---|
91 | <screen><userinput role='root'><command>make install &&
|
---|
92 | install -v -m644 saslauthd/saslauthd.mdoc \
|
---|
93 | /usr/share/man/man8/saslauthd.8 &&
|
---|
94 | install -v -d -m755 /usr/share/doc/cyrus-sasl-&cyrus-sasl-version; &&
|
---|
95 | install -v -m644 doc/{*.{html,txt,fig},ONEWS,TODO} \
|
---|
96 | saslauthd/LDAP_SASLAUTHD /usr/share/doc/cyrus-sasl-&cyrus-sasl-version; &&
|
---|
97 | install -v -d -m700 /var/lib/sasl</command></userinput></screen>
|
---|
98 |
|
---|
99 | </sect2>
|
---|
100 |
|
---|
101 | <sect2>
|
---|
102 | <title>Command explanations</title>
|
---|
103 |
|
---|
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>
|
---|
108 |
|
---|
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>
|
---|
113 |
|
---|
114 | <para><parameter>--with-ldap</parameter>: This parameter enables use
|
---|
115 | with <application>OpenLDAP</application>.</para>
|
---|
116 |
|
---|
117 | <para><command>install -m644 ...</command>: These commands
|
---|
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>
|
---|
125 |
|
---|
126 | </sect2>
|
---|
127 |
|
---|
128 | <sect2>
|
---|
129 | <title>Configuring <application>Cyrus
|
---|
130 | <acronym>SASL</acronym></application></title>
|
---|
131 |
|
---|
132 | <sect3 id="cyrus-sasl-config"><title>Config Files</title>
|
---|
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>
|
---|
136 | <indexterm zone="cyrus-sasl cyrus-sasl-config">
|
---|
137 | <primary sortas="e-etc-saslauthd.conf">/etc/saslauthd.conf</primary>
|
---|
138 | </indexterm>
|
---|
139 | </sect3>
|
---|
140 |
|
---|
141 | <sect3><title>Configuration Information</title>
|
---|
142 | <para>See <ulink
|
---|
143 | url="file:///usr/share/doc/cyrus-sasl-&cyrus-sasl-version;/sysadmin.html"/> for
|
---|
144 | information on what to include in the application configuration files. See
|
---|
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>
|
---|
149 | </sect3>
|
---|
150 |
|
---|
151 | <sect3 id="cyrus-sasl-init"><title>Init Script</title>
|
---|
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>
|
---|
156 | <indexterm zone="cyrus-sasl cyrus-sasl-init">
|
---|
157 | <primary sortas="f-cyrus-sasl-init">cyrus-sasl</primary>
|
---|
158 | </indexterm>
|
---|
159 |
|
---|
160 | <screen><userinput role='root'><command>make install-cyrus-sasl</command></userinput></screen>
|
---|
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>
|
---|
166 | </sect3>
|
---|
167 |
|
---|
168 | </sect2>
|
---|
169 |
|
---|
170 | <sect2>
|
---|
171 | <title>Contents</title>
|
---|
172 |
|
---|
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>
|
---|
179 | <seg>libjavasasl.so, libsasl2.so and <acronym>SASL</acronym> plugins/Java
|
---|
180 | classes</seg>
|
---|
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>
|
---|
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>
|
---|
219 | <listitem><para>is a general purpose authentication library for server and
|
---|
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>
|
---|
226 |
|
---|
227 | </sect2>
|
---|
228 |
|
---|
229 | </sect1>
|
---|
230 |
|
---|