source: postlfs/security/cyrus-sasl.xml@ fb1f32b

11.2 11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/soup3 xry111/xf86-video-removal
Last change on this file since fb1f32b was fb1f32b, checked in by Douglas R. Reno <renodr@…>, 22 months ago

cyrus-sasl: Java support was removed in 2.1.28.
  • Property mode set to 100644
File size: 14.5 KB
Line 
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 "https://github.com/cyrusimap/cyrus-sasl/releases/download/cyrus-sasl-&cyrus-sasl-version;/cyrus-sasl-&cyrus-sasl-version;.tar.gz">
8 <!ENTITY cyrus-sasl-download-ftp " ">
9 <!ENTITY cyrus-sasl-md5sum "6f228a692516f5318a64505b46966cfa">
10 <!ENTITY cyrus-sasl-size "3.9 MB">
11 <!ENTITY cyrus-sasl-buildsize "28 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 <date>$Date$</date>
20 </sect1info>
21
22 <title>Cyrus SASL-&cyrus-sasl-version;</title>
23
24 <indexterm zone="cyrus-sasl">
25 <primary sortas="a-Cyrus-SASL">Cyrus SASL</primary>
26 </indexterm>
27
28 <sect2 role="package">
29 <title>Introduction to Cyrus SASL</title>
30
31 <para>
32 The <application>Cyrus SASL</application> package contains a Simple
33 Authentication and Security Layer implementation, a method for adding
34 authentication support to connection-based protocols. To use SASL, a
35 protocol includes a command for identifying and authenticating a user to
36 a server and for optionally negotiating protection of subsequent protocol
37 interactions. If its use is negotiated, a security layer is inserted
38 between the protocol and the connection.
39 </para>
40
41 &lfs111_checked;
42
43 <!-- To test this package at freeze, run the following command:
44 testsaslauthd -u <current user> -p <password>
45 after saslauthd is started. -->
46 <bridgehead renderas="sect3">Package Information</bridgehead>
47 <itemizedlist spacing="compact">
48 <listitem>
49 <para>
50 Download (HTTP): <ulink url="&cyrus-sasl-download-http;"/>
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download (FTP): <ulink url="&cyrus-sasl-download-ftp;"/>
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Download MD5 sum: &cyrus-sasl-md5sum;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Download size: &cyrus-sasl-size;
66 </para>
67 </listitem>
68 <listitem>
69 <para>
70 Estimated disk space required: &cyrus-sasl-buildsize;
71 </para>
72 </listitem>
73 <listitem>
74 <para>
75 Estimated build time: &cyrus-sasl-time;
76 </para>
77 </listitem>
78 </itemizedlist>
79
80 <!-- Not needed anymore
81 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
82 <itemizedlist spacing="compact">
83 <listitem>
84 <para>
85 Required patch:
86 <ulink url="&patch-root;/cyrus-sasl-&cyrus-sasl-version;-doc_fixes-1.patch"/>
87 </para>
88 </listitem>
89 <!- -<listitem>
90 <para>
91 Required patch:
92 <ulink url="&patch-root;/cyrus-sasl-&cyrus-sasl-version;-openssl-1.1.0-1.patch"/>
93 </para>
94 </listitem>- ->
95 </itemizedlist>
96 -->
97
98 <bridgehead renderas="sect3">Cyrus SASL Dependencies</bridgehead>
99
100 <bridgehead renderas="sect4">Recommended</bridgehead>
101 <para role="recommended">
102 <xref linkend="db"/>
103 </para>
104
105 <bridgehead renderas="sect4">Optional</bridgehead>
106 <para role="optional">
107 <xref linkend="linux-pam"/>,
108 <xref linkend="mitkrb"/>,
109 <xref linkend="mariadb"/> or <ulink url="http://www.mysql.com/">MySQL</ulink>,
110 <!--<xref linkend="openjdk"/>, Removed in 2.1.28 -->
111 <xref linkend="openldap"/>,
112 <xref linkend="postgresql"/>,
113 <xref linkend="sqlite"/>,
114 <ulink url="https://stuff.mit.edu/afs/net.mit.edu/project/attic/krb4/">krb4</ulink>,
115 <ulink url="http://dmalloc.com/">Dmalloc</ulink>,
116 <ulink url="https://metacpan.org/pod/Pod::POM::View::Restructured">Pod::POM::View::Restructured</ulink>,
117 and <ulink url="https://pypi.org/project/Sphinx">Sphinx</ulink>
118 </para>
119
120 <para condition="html" role="usernotes">User Notes:
121 <ulink url="&blfs-wiki;/cyrus-sasl"/>
122 </para>
123 </sect2>
124
125 <sect2 role="installation">
126 <title>Installation of Cyrus SASL</title>
127
128 <note>
129 <para>
130 This package does not support parallel build.
131 </para>
132 </note>
133
134 <!-- Without this patch, having Sphinx and/or doctools (doctools not tested)
135 on the system causes an FTBFS when man pages are generated. The Sphinx
136 and Docutils API has changed significantly between Sphinx-{1,2} and
137 Sphinx-3.0.
138
139 <para>
140 First, fix a build failure if Sphinx or
141 <xref role="nodep" linkend="docutils"/> is installed on the system:
142 </para>
143
144<screen><userinput remap="pre">patch -Np1 -i ../cyrus-sasl-2.1.27-doc_fixes-1.patch</userinput></screen>
145 -->
146
147 <para>
148 Install <application>Cyrus SASL</application> by
149 running the following commands:
150 </para>
151
152<screen><userinput>./configure --prefix=/usr \
153 --sysconfdir=/etc \
154 --enable-auth-sasldb \
155 --with-dbpath=/var/lib/sasl/sasldb2 \
156 --with-sphinx-build=no \
157 --with-saslauthd=/var/run/saslauthd &amp;&amp;
158make -j1</userinput></screen>
159
160 <para>
161 This package does not come with a test suite. If you are planning
162 on using the GSSAPI authentication mechanism, test
163 it after installing the package using the sample server and client
164 programs which were built in the preceding step. Instructions for
165 performing the tests can be found at
166 <ulink url="&hints-root;/downloads/files/cyrus-sasl.txt"/>.
167 </para>
168
169 <para>
170 Now, as the <systemitem class="username">root</systemitem> user:
171 </para>
172
173<screen role="root"><userinput>make install &amp;&amp;
174install -v -dm755 /usr/share/doc/cyrus-sasl-&cyrus-sasl-version;/html &amp;&amp;
175install -v -m644 saslauthd/LDAP_SASLAUTHD /usr/share/doc/cyrus-sasl-&cyrus-sasl-version; &amp;&amp;
176install -v -m644 doc/legacy/*.html /usr/share/doc/cyrus-sasl-&cyrus-sasl-version;/html &amp;&amp;
177install -v -dm700 /var/lib/sasl</userinput></screen>
178
179 </sect2>
180
181 <sect2 role="commands">
182 <title>Command Explanations</title>
183
184 <para>
185 <parameter>--with-dbpath=/var/lib/sasl/sasldb2</parameter>: This
186 switch forces the <command>sasldb</command> database to be created
187 in <filename class="directory">/var/lib/sasl</filename> instead of
188 <filename class="directory">/etc</filename>.
189 </para>
190
191 <para>
192 <parameter>--with-saslauthd=/var/run/saslauthd</parameter>: This
193 switch forces <command>saslauthd</command> to use the FHS compliant
194 directory <filename class="directory">/var/run/saslauthd</filename>
195 for variable run-time data.
196 </para>
197
198 <para>
199 <parameter>--enable-auth-sasldb</parameter>: This switch enables
200 SASLDB authentication backend.
201 </para>
202
203 <para>
204 <option>--with-dblib=gdbm</option>: This switch forces
205 <application>GDBM</application> to be used instead of
206 <application>Berkeley DB</application>.
207 </para>
208
209 <para>
210 <option>--with-ldap</option>: This switch enables the
211 <application>OpenLDAP</application> support.
212 </para>
213
214 <para>
215 <option>--enable-ldapdb</option>: This switch enables the
216 LDAPDB authentication backend. <!--There is a circular dependency with this
217 parameter. See <ulink url="&blfs-wiki;/cyrus-sasl"/> for a solution to
218 this problem.-->
219 </para>
220
221<!-- Removed in 2.1.28
222 <para>
223 <option>- -enable-java</option>: This switch enables compiling of the
224 <application>Java</application> support libraries.
225 </para>
226-->
227
228 <para>
229 <option>--enable-login</option>: This option enables unsupported
230 LOGIN authentication.
231 </para>
232
233 <para>
234 <option>--enable-ntlm</option>: This option enables unsupported
235 NTLM authentication.
236 </para>
237
238 <para>
239 <command>install -v -m644 ...</command>: These commands
240 install documentation which is not installed by the
241 <command>make install</command> command.
242 </para>
243
244 <para>
245 <command>install -v -m700 -d /var/lib/sasl</command>: This directory
246 must exist when starting <command>saslauthd</command> or using the
247 sasldb plugin. If you're not going to be running the daemon or
248 using the plugins, you may omit the creation of this directory.
249 </para>
250
251 </sect2>
252
253 <sect2 role="configuration">
254 <title>Configuring Cyrus SASL</title>
255
256 <sect3 id="cyrus-sasl-config">
257 <title>Config Files</title>
258
259 <para>
260 <filename>/etc/saslauthd.conf</filename>
261 (for <command>saslauthd</command> LDAP configuration) and
262 <filename>/etc/sasl2/Appname.conf</filename>
263 (where "Appname" is the application defined name of the application)
264 </para>
265
266 <indexterm zone="cyrus-sasl cyrus-sasl-config">
267 <primary sortas="e-etc-saslauthd.conf">/etc/saslauthd.conf</primary>
268 </indexterm>
269
270 </sect3>
271
272 <sect3>
273 <title>Configuration Information</title>
274
275 <para>
276 See
277 <ulink url="https://www.cyrusimap.org/sasl/sasl/sysadmin.html"/>
278 for information on what to include in the application configuration files.
279 </para>
280
281 <para>
282 See
283 <ulink url="file:///usr/share/doc/cyrus-sasl-&cyrus-sasl-version;/LDAP_SASLAUTHD"/>
284 for configuring <command>saslauthd</command> with
285 <application>OpenLDAP</application>.
286 </para>
287
288 <para>
289 See
290 <ulink url="https://www.cyrusimap.org/sasl/sasl/gssapi.html#gssapi"/>
291 for configuring <command>saslauthd</command> with <application>Kerberos</application>.
292 </para>
293
294 </sect3>
295
296 <sect3 id="cyrus-sasl-init">
297 <title><phrase revision="sysv">Init Script</phrase>
298 <phrase revision="systemd">Systemd Unit</phrase></title>
299
300 <para revision="sysv">
301 If you need to run the <command>saslauthd</command> daemon at system
302 startup, install the <filename>/etc/rc.d/init.d/saslauthd</filename>
303 init script included in the
304 <xref linkend="bootscripts"/> package using the following command:
305 </para>
306
307 <para revision="systemd">
308 If you need to run the <command>saslauthd</command> daemon at system
309 startup, install the <filename>saslauthd.service</filename> unit
310 included in the <xref linkend="systemd-units"/> package using the
311 following command:
312 </para>
313
314 <indexterm zone="cyrus-sasl cyrus-sasl-init">
315 <primary sortas="f-saslauthd">saslauthd</primary>
316 </indexterm>
317
318<screen role="root"><userinput>make install-saslauthd</userinput></screen>
319
320 <note>
321 <para>
322 You'll need to modify
323 <filename revision="sysv">/etc/sysconfig/saslauthd</filename>
324 <filename revision="systemd">/etc/default/saslauthd</filename>
325 and modify the
326 <option revision="sysv">AUTHMECH</option>
327 <option revision="systemd">MECHANISM</option>
328 parameter with your desired authentication mechanism.
329 <phrase revision="systemd">The default authentication
330 mechanism is "shadow".</phrase>
331 </para>
332 </note>
333
334 </sect3>
335
336 </sect2>
337
338 <sect2 role="content">
339 <title>Contents</title>
340
341 <segmentedlist>
342 <segtitle>Installed Programs</segtitle>
343 <segtitle>Installed Library</segtitle>
344 <segtitle>Installed Directories</segtitle>
345
346 <seglistitem>
347 <seg>
348 pluginviewer, saslauthd, sasldblistusers2, saslpasswd2 and
349 testsaslauthd
350 </seg>
351 <seg>
352 libsasl2.so
353 </seg>
354 <seg>
355 /usr/include/sasl,
356 /usr/lib/sasl2,
357 /usr/share/doc/cyrus-sasl-&cyrus-sasl-version; and
358 /var/lib/sasl
359 </seg>
360 </seglistitem>
361 </segmentedlist>
362
363 <variablelist>
364 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
365 <?dbfo list-presentation="list"?>
366 <?dbhtml list-presentation="table"?>
367
368 <varlistentry id="pluginviewer">
369 <term><command>pluginviewer</command></term>
370 <listitem>
371 <para>
372 is used to list loadable SASL plugins and their properties
373 </para>
374 <indexterm zone="cyrus-sasl pluginviewer">
375 <primary sortas="b-pluginviewer">pluginviewer</primary>
376 </indexterm>
377 </listitem>
378 </varlistentry>
379
380 <varlistentry id="saslauthd">
381 <term><command>saslauthd</command></term>
382 <listitem>
383 <para>
384 is the SASL authentication server
385 </para>
386 <indexterm zone="cyrus-sasl saslauthd">
387 <primary sortas="b-saslauthd">saslauthd</primary>
388 </indexterm>
389 </listitem>
390 </varlistentry>
391
392 <varlistentry id="sasldblistusers2">
393 <term><command>sasldblistusers2</command></term>
394 <listitem>
395 <para>
396 is used to list the users in the SASL password database
397 <filename>sasldb2</filename>
398 </para>
399 <indexterm zone="cyrus-sasl sasldblistusers2">
400 <primary sortas="b-sasldblistusers2">sasldblistusers2</primary>
401 </indexterm>
402 </listitem>
403 </varlistentry>
404
405 <varlistentry id="saslpasswd2">
406 <term><command>saslpasswd2</command></term>
407 <listitem>
408 <para>
409 is used to set and delete a user's SASL password and
410 mechanism specific secrets in the SASL password
411 database <filename>sasldb2</filename>
412 </para>
413 <indexterm zone="cyrus-sasl saslpasswd2">
414 <primary sortas="b-saslpasswd2">saslpasswd2</primary>
415 </indexterm>
416 </listitem>
417 </varlistentry>
418
419 <varlistentry id="testsaslauthd">
420 <term><command>testsaslauthd</command></term>
421 <listitem>
422 <para>
423 is a test utility for the SASL authentication server
424 </para>
425 <indexterm zone="cyrus-sasl testsaslauthd">
426 <primary sortas="b-testsaslauthd">testsaslauthd</primary>
427 </indexterm>
428 </listitem>
429 </varlistentry>
430
431 <varlistentry id="libsasl2">
432 <term><filename class="libraryfile">libsasl2.so</filename></term>
433 <listitem>
434 <para>
435 is a general purpose authentication library for server
436 and client applications
437 </para>
438 <indexterm zone="cyrus-sasl libsasl2">
439 <primary sortas="c-libsasl2">libsasl2.so</primary>
440 </indexterm>
441 </listitem>
442 </varlistentry>
443
444 </variablelist>
445
446 </sect2>
447
448</sect1>
Note: See TracBrowser for help on using the repository browser.