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