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

10.0 10.1 11.0 6.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 7da83f1 was 7da83f1, checked in by Randy McMurchy <randy@…>, 17 years ago

Fixed typo in Cyrus SASL instructions

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

  • Property mode set to 100644
File size: 7.8 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-size "1.8 MB">
10 <!ENTITY cyrus-sasl-buildsize "17.3 MB">
11 <!ENTITY cyrus-sasl-time "0.28 SBU">
12]>
13
14<sect1 id="cyrus-sasl" xreflabel="Cyrus SASL-&cyrus-sasl-version;">
15<sect1info>
16<othername>$LastChangedBy$</othername>
17<date>$Date$</date>
18</sect1info>
19<?dbhtml filename="cyrus-sasl.html"?>
20<title>Cyrus <acronym>SASL</acronym>-&cyrus-sasl-version;</title>
21<indexterm zone="cyrus-sasl">
22<primary sortas="a-Cyrus SASL">Cyrus SASL</primary></indexterm>
23
24<sect2>
25<title>Introduction to <application>Cyrus <acronym>SASL</acronym></application>
26</title>
27
28<para>The <application>Cyrus <acronym>SASL</acronym></application> package
29contains a Simple Authentication and Security Layer, a method for adding
30authentication support to connection-based protocols. To use
31<acronym>SASL</acronym>, a protocol includes a command for identifying and
32authenticating a user to a server and for optionally negotiating protection of
33subsequent protocol interactions. If its use is negotiated, a security layer
34is inserted between the protocol and the connection.</para>
35
36<sect3><title>Package information</title>
37<itemizedlist spacing="compact">
38<listitem><para>Download (HTTP):
39<ulink url="&cyrus-sasl-download-http;"/></para></listitem>
40<listitem><para>Download (FTP):
41<ulink url="&cyrus-sasl-download-ftp;"/></para></listitem>
42<listitem><para>Download size: &cyrus-sasl-size;</para></listitem>
43<listitem><para>Estimated disk space required:
44&cyrus-sasl-buildsize;</para></listitem>
45<listitem><para>Estimated build time:
46&cyrus-sasl-time;</para></listitem>
47</itemizedlist>
48</sect3>
49
50<sect3><title><application>Cyrus <acronym>SASL</acronym></application>
51dependencies</title>
52
53<sect4><title>Required</title>
54<para><xref linkend="openssl-package"/></para>
55</sect4>
56
57<sect4><title>Optional</title>
58<para><xref linkend="Linux_PAM"/>,
59<xref linkend="openldap"/>,
60<xref linkend="heimdal"/> or <xref linkend="mitkrb"/>,
61<xref linkend="j2sdk"/>,
62<xref linkend="mysql"/>,
63<xref linkend="postgresql"/>,
64<xref linkend="db"/>,
65<xref linkend="gdbm"/>,
66<xref linkend="courier"/>,
67<ulink url="http://www.pdc.kth.se/kth-krb/">krb4</ulink>,
68<ulink url="http://sqlite.org/">SQLite</ulink> and
69<ulink url="http://dmalloc.com/">Dmalloc</ulink></para>
70</sect4>
71</sect3>
72
73</sect2>
74
75<sect2>
76<title>Installation of <application>Cyrus <acronym>SASL</acronym></application>
77</title>
78
79<para>Install <application>Cyrus <acronym>SASL</acronym></application> by
80running the following commands:</para>
81
82<screen><userinput><command>./configure --prefix=/usr --sysconfdir=/etc \
83 --with-dbpath=/var/lib/sasl/sasldb2 \
84 --with-saslauthd=/var/run &amp;&amp;
85make &amp;&amp;
86make install &amp;&amp;
87install -m644 saslauthd/saslauthd.mdoc \
88 /usr/share/man/man8/saslauthd.8 &amp;&amp;
89install -d -m755 /usr/share/doc/sasl &amp;&amp;
90install -m644 doc/{*.{html,txt,fig},ONEWS,TODO} \
91 saslauthd/LDAP_SASLAUTHD /usr/share/doc/sasl &amp;&amp;
92install -d -m700 /var/lib/sasl</command></userinput></screen>
93
94</sect2>
95
96<sect2>
97<title>Command explanations</title>
98
99<para><parameter>--with-dbpath=/var/lib/sasl/sasldb2</parameter>: This
100parameter forces the <command>saslauthd</command> database to be created
101in <filename class='directory'>/var/lib/sasl</filename> instead of
102<filename class='directory'>/etc</filename>.</para>
103
104<para><parameter>--with-saslauthd=/var/run</parameter>: This parameter forces
105<command>saslauthd</command> to use the <acronym>FHS</acronym> compliant
106directory <filename class='directory'>/var/run</filename> for variable run-time
107data.</para>
108
109<para><command>install -m644 ...</command>: These commands
110install documentation which is not installed by the
111<command>make install</command> command.</para>
112
113<para><command>install -d -m700 /var/lib/sasl</command>: This directory must
114exist when starting <command>saslauthd</command>. If you're not going to be
115running the daemon, you may omit the creation of this directory.
116</para>
117
118</sect2>
119
120<sect2>
121<title>Configuring <application>Cyrus
122<acronym>SASL</acronym></application></title>
123
124<sect3 id="cyrus-sasl-config"><title>Config Files</title>
125<para><filename>/etc/saslauthd.conf</filename> (for <acronym>LDAP</acronym>
126configuration) and <filename>/usr/lib/sasl2/Appname.conf</filename> (where
127"Appname" is the application defined name of the application)</para>
128<indexterm zone="cyrus-sasl cyrus-sasl-config">
129<primary sortas="e-etc-saslauthd.conf">/etc/saslauthd.conf</primary>
130</indexterm>
131</sect3>
132
133<sect3><title>Configuration Information</title>
134<para>See <ulink url="file:///usr/share/doc/sasl/sysadmin.html"/> for
135information on what to include in the application configuration files. See
136<ulink url="file:///usr/share/doc/sasl/LDAP_SASLAUTHD"/> for configuring
137<command>saslauthd</command> with <acronym>LDAP</acronym>.</para>
138</sect3>
139
140<sect3 id="cyrus-sasl-init"><title>Init Script</title>
141<para>If you need to run the <command>saslauthd</command> daemon at system
142startup, install the <filename>/etc/rc.d/init.d/cyrus-sasl</filename>
143init script included in the
144<xref linkend="intro-important-bootscripts"/> package.</para>
145<indexterm zone="cyrus-sasl cyrus-sasl-init">
146<primary sortas="f-cyrus-sasl-init">cyrus-sasl</primary>
147</indexterm>
148
149<screen><userinput><command>make install-cyrus-sasl</command></userinput></screen>
150
151<note><para>You'll need to modify the init script and replace the
152<parameter><replaceable>[authmech]</replaceable></parameter> parameter to the
153<parameter>-a</parameter> switch with your desired authentication mechanism.
154</para></note>
155</sect3>
156
157</sect2>
158
159<sect2>
160<title>Contents</title>
161
162<segmentedlist>
163<segtitle>Installed Programs</segtitle>
164<segtitle>Installed Libraries</segtitle>
165<segtitle>Installed Directories</segtitle>
166<seglistitem>
167<seg>saslauthd, sasldblistusers2 and saslpasswd2</seg>
168<seg>libjavasasl.so, libsasl2.so and <acronym>SASL</acronym> plugins/JAVA
169classes</seg>
170<seg>/usr/lib/sasl2, /usr/share/doc/sasl and /var/lib/sasl</seg>
171</seglistitem>
172</segmentedlist>
173
174<variablelist>
175<bridgehead renderas="sect3">Short Descriptions</bridgehead>
176<?dbfo list-presentation="list"?>
177
178<varlistentry id="saslauthd">
179<term><command>saslauthd</command></term>
180<listitem><para>is the <acronym>SASL</acronym> authentication server.</para>
181<indexterm zone="cyrus-sasl saslauthd">
182<primary sortas="b-saslauthd">saslauthd</primary></indexterm>
183</listitem>
184</varlistentry>
185
186<varlistentry id="sasldblistusers2">
187<term><command>sasldblistusers2</command></term>
188<listitem><para>is used to list the users in the <acronym>SASL</acronym>
189password database.</para>
190<indexterm zone="cyrus-sasl sasldblistusers2">
191<primary sortas="b-sasldblistusers2">sasldblistusers2</primary></indexterm>
192</listitem>
193</varlistentry>
194
195<varlistentry id="saslpasswd2">
196<term><command>saslpasswd2</command></term>
197<listitem><para>is used to set and delete a user's <acronym>SASL</acronym>
198password and mechanism specific secrets in the <acronym>SASL</acronym>
199password database.</para>
200<indexterm zone="cyrus-sasl saslpasswd2">
201<primary sortas="b-saslpasswd2">saslpasswd2</primary></indexterm>
202</listitem>
203</varlistentry>
204
205<varlistentry id="libsasl2">
206<term><filename class='libraryfile'>libsasl2.so</filename></term>
207<listitem><para>is a general purpose authentication library for server and
208client applications.</para>
209<indexterm zone="cyrus-sasl libsasl2">
210<primary sortas="c-libsasl2">libsasl2.so</primary></indexterm>
211</listitem>
212</varlistentry>
213
214</variablelist>
215
216</sect2>
217
218</sect1>
219
Note: See TracBrowser for help on using the repository browser.