source: postlfs/security/cyrus-sasl.xml@ 7f76b96

10.0 10.1 11.0 6.1 6.2 6.2.0 6.2.0-rc1 6.2.0-rc2 6.3 6.3-rc1 6.3-rc2 6.3-rc3 7.10 7.4 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 ken/refactor-virt krejzi/svn lazarus nosym perl-modules qt5new systemd-11177 systemd-13485 trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 7f76b96 was 7f76b96, checked in by Manuel Canales Esparcia <manuel@…>, 17 years ago

Reverted the DTD change. That don't be done untiltomorrow.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@3632 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 8.3 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
3 "http://www.oasis-open.org/docbook/xml/4.3/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.8 MB">
11 <!ENTITY cyrus-sasl-buildsize "17.3 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
30contains a Simple Authentication and Security Layer, a method for adding
31authentication support to connection-based protocols. To use
32<acronym>SASL</acronym>, a protocol includes a command for identifying and
33authenticating a user to a server and for optionally negotiating protection of
34subsequent protocol interactions. If its use is negotiated, a security layer
35is 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>
53dependencies</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="j2sdk"/>,
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
82running 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 &amp;&amp;
87make</command></userinput></screen>
88
89<para>Now, as the root user:</para>
90
91<screen><userinput role='root'><command>make install &amp;&amp;
92install -v -m644 saslauthd/saslauthd.mdoc \
93 /usr/share/man/man8/saslauthd.8 &amp;&amp;
94install -v -d -m755 /usr/share/doc/cyrus-sasl-&cyrus-sasl-version; &amp;&amp;
95install -v -m644 doc/{*.{html,txt,fig},ONEWS,TODO} \
96 saslauthd/LDAP_SASLAUTHD /usr/share/doc/cyrus-sasl-&cyrus-sasl-version; &amp;&amp;
97install -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
105parameter forces the <command>saslauthd</command> database to be created
106in <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
111directory <filename class='directory'>/var/run</filename> for variable run-time
112data.</para>
113
114<para><parameter>--with-ldap</parameter>: This parameter enables use
115with <application>OpenLDAP</application>.</para>
116
117<para><command>install -m644 ...</command>: These commands
118install 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
122exist when starting <command>saslauthd</command>. If you're not going to be
123running 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>
134configuration) 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 url="file:///usr/share/doc/sasl/sysadmin.html"/> for
143information on what to include in the application configuration files. See
144<ulink url="file:///usr/share/doc/sasl/LDAP_SASLAUTHD"/> for configuring
145<command>saslauthd</command> with <acronym>LDAP</acronym>.</para>
146</sect3>
147
148<sect3 id="cyrus-sasl-init"><title>Init Script</title>
149<para>If you need to run the <command>saslauthd</command> daemon at system
150startup, install the <filename>/etc/rc.d/init.d/cyrus-sasl</filename>
151init script included in the
152<xref linkend="intro-important-bootscripts"/> package.</para>
153<indexterm zone="cyrus-sasl cyrus-sasl-init">
154<primary sortas="f-cyrus-sasl-init">cyrus-sasl</primary>
155</indexterm>
156
157<screen><userinput role='root'><command>make install-cyrus-sasl</command></userinput></screen>
158
159<note><para>You'll need to modify the init script and replace the
160<parameter><replaceable>[authmech]</replaceable></parameter> parameter to the
161<parameter>-a</parameter> switch with your desired authentication mechanism.
162</para></note>
163</sect3>
164
165</sect2>
166
167<sect2>
168<title>Contents</title>
169
170<segmentedlist>
171<segtitle>Installed Programs</segtitle>
172<segtitle>Installed Libraries</segtitle>
173<segtitle>Installed Directories</segtitle>
174<seglistitem>
175<seg>saslauthd, sasldblistusers2 and saslpasswd2</seg>
176<seg>libjavasasl.so, libsasl2.so and <acronym>SASL</acronym> plugins/JAVA
177classes</seg>
178<seg>/usr/include/sasl, /usr/lib/sasl2, /usr/share/doc/sasl and /var/lib/sasl</seg>
179</seglistitem>
180</segmentedlist>
181
182<variablelist>
183<bridgehead renderas="sect3">Short Descriptions</bridgehead>
184<?dbfo list-presentation="list"?>
185
186<varlistentry id="saslauthd">
187<term><command>saslauthd</command></term>
188<listitem><para>is the <acronym>SASL</acronym> authentication server.</para>
189<indexterm zone="cyrus-sasl saslauthd">
190<primary sortas="b-saslauthd">saslauthd</primary></indexterm>
191</listitem>
192</varlistentry>
193
194<varlistentry id="sasldblistusers2">
195<term><command>sasldblistusers2</command></term>
196<listitem><para>is used to list the users in the <acronym>SASL</acronym>
197password database.</para>
198<indexterm zone="cyrus-sasl sasldblistusers2">
199<primary sortas="b-sasldblistusers2">sasldblistusers2</primary></indexterm>
200</listitem>
201</varlistentry>
202
203<varlistentry id="saslpasswd2">
204<term><command>saslpasswd2</command></term>
205<listitem><para>is used to set and delete a user's <acronym>SASL</acronym>
206password and mechanism specific secrets in the <acronym>SASL</acronym>
207password database.</para>
208<indexterm zone="cyrus-sasl saslpasswd2">
209<primary sortas="b-saslpasswd2">saslpasswd2</primary></indexterm>
210</listitem>
211</varlistentry>
212
213<varlistentry id="libsasl2">
214<term><filename class='libraryfile'>libsasl2.so</filename></term>
215<listitem><para>is a general purpose authentication library for server and
216client applications.</para>
217<indexterm zone="cyrus-sasl libsasl2">
218<primary sortas="c-libsasl2">libsasl2.so</primary></indexterm>
219</listitem>
220</varlistentry>
221
222</variablelist>
223
224</sect2>
225
226</sect1>
227
Note: See TracBrowser for help on using the repository browser.