source: postlfs/security/cyrus-sasl.xml@ 83c4744

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/xf86-video-removal
Last change on this file since 83c4744 was 3f2db3a6, checked in by Pierre Labastie <pierre.labastie@…>, 19 months ago

Remove sect1info tags

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