source: postlfs/security/stunnel.xml@ e764ee3

10.0 10.1 11.0 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind ken/refactor-virt lazarus nosym perl-modules qt5new trunk upgradedb xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since e764ee3 was e764ee3, checked in by Bruce Dubbs <bdubbs@…>, 5 years ago

Update to stunnel-5.37.
Update to sysstat-11.5.2.
Update to gnutls-3.5.6.
Update to scons-2.5.1.
Update to feh-2.18.

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

  • Property mode set to 100644
File size: 12.8 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 stunnel-download-http " ">
8 <!-- Following ftp also has older releases -->
9 <!ENTITY stunnel-download-ftp "ftp://ftp.stunnel.org/stunnel/archive/5.x/stunnel-&stunnel-version;.tar.gz">
10 <!-- Following ftp only has later release -->
11<!-- "ftp://ftp.stunnel.org/stunnel/stunnel-&stunnel-version;.tar.gz"> -->
12 <!ENTITY stunnel-md5sum "96de707ac49db271cfaca35c36a44cbf">
13 <!ENTITY stunnel-size "632 KB">
14 <!ENTITY stunnel-buildsize "6.7 MB">
15 <!ENTITY stunnel-time "0.1 SBU">
16]>
17
18<sect1 id="stunnel" xreflabel="stunnel-&stunnel-version;">
19 <?dbhtml filename="stunnel.html"?>
20
21 <sect1info>
22 <othername>$LastChangedBy$</othername>
23 <date>$Date$</date>
24 </sect1info>
25
26 <title>stunnel-&stunnel-version;</title>
27
28 <indexterm zone="stunnel">
29 <primary sortas="a-stunnel">stunnel</primary>
30 </indexterm>
31
32 <sect2 role="package">
33 <title>Introduction to stunnel</title>
34
35 <para>The <application>stunnel</application> package contains a program
36 that allows you to encrypt arbitrary TCP connections inside SSL (Secure
37 Sockets Layer) so you can easily communicate with clients over secure
38 channels. <application>stunnel</application> can be used to add SSL
39 functionality to commonly used <application>Inetd</application> daemons
40 such as POP-2, POP-3, and IMAP servers, along with standalone daemons such
41 as NNTP, SMTP, and HTTP. <application>stunnel</application> can also be
42 used to tunnel PPP over network sockets without changes to the server
43 package source code.</para>
44
45 &lfs7a_checked;
46
47 <bridgehead renderas="sect3">Package Information</bridgehead>
48 <itemizedlist spacing="compact">
49 <listitem>
50 <para>Download (HTTP): <ulink url="&stunnel-download-http;"/></para>
51 </listitem>
52 <listitem>
53 <para>Download (FTP): <ulink url="&stunnel-download-ftp;"/></para>
54 </listitem>
55 <listitem>
56 <para>Download MD5 sum: &stunnel-md5sum;</para>
57 </listitem>
58 <listitem>
59 <para>Download size: &stunnel-size;</para>
60 </listitem>
61 <listitem>
62 <para>Estimated disk space required: &stunnel-buildsize;</para>
63 </listitem>
64 <listitem>
65 <para>Estimated build time: &stunnel-time;</para>
66 </listitem>
67 </itemizedlist>
68
69 <bridgehead renderas="sect3">stunnel Dependencies</bridgehead>
70
71 <bridgehead renderas="sect4">Required</bridgehead>
72 <para role="required">
73 <xref linkend="openssl"/>
74 </para>
75
76 <bridgehead renderas="sect4">Optional</bridgehead>
77 <para role="optional">
78 <ulink url="ftp://ftp.porcupine.org/pub/security/">tcpwrappers</ulink> and
79 <ulink url="https://dist.torproject.org/">TOR</ulink>
80 </para>
81
82 <para condition="html" role="usernotes">User Notes:
83 <ulink url="&blfs-wiki;/stunnel"/></para>
84
85 </sect2>
86
87 <sect2 role="installation">
88 <title>Installation of stunnel</title>
89
90 <para>The <command>stunnel</command> daemon will be run in a
91 <command>chroot</command> jail by an unprivileged user. Create the
92 new user and group using the following commands as the
93 <systemitem class="username">root</systemitem> user:</para>
94
95<screen role="root"><userinput>groupadd -g 51 stunnel &amp;&amp;
96useradd -c "stunnel Daemon" -d /var/lib/stunnel \
97 -g stunnel -s /bin/false -u 51 stunnel</userinput></screen>
98
99 <note>
100 <para>A signed SSL Certificate and a Private Key is necessary to run the
101 <command>stunnel</command> daemon. After the package is installed, there
102 are instructions to generate them. However, if you own or have already
103 created a signed SSL Certificate you wish to use, copy it to
104 <filename>/etc/stunnel/stunnel.pem</filename> before starting the build
105 (ensure only <systemitem class="username">root</systemitem> has read and
106 write access). The <filename class="extension">.pem</filename> file must
107 be formatted as shown below:</para>
108
109<screen><literal>-----BEGIN PRIVATE KEY-----
110<replaceable>&lt;many encrypted lines of private key&gt;</replaceable>
111-----END PRIVATE KEY-----
112-----BEGIN CERTIFICATE-----
113<replaceable>&lt;many encrypted lines of certificate&gt;</replaceable>
114-----END CERTIFICATE-----
115-----BEGIN DH PARAMETERS-----
116<replaceable>&lt;encrypted lines of dh parms&gt;</replaceable>
117-----END DH PARAMETERS-----</literal></screen>
118 </note>
119
120 <para>Install <application>stunnel</application> by running the following
121 commands:</para>
122
123 <note>
124 <para>For some systems with <application>binutils</application>
125 versions prior to 2.25, <command>configure</command> may fail. If
126 necessary, fix it either with:</para>
127
128<screen><userinput>sed -i '/LDFLAGS.*static_flag/ s/^/#/' configure</userinput></screen>
129
130 <para>or, if <xref linkend="llvm"/> with Clang is installed, you can
131 replace <command>./configure ...</command> with <command>CC=clang
132 ./configure ...</command> in the first command below.</para>
133 </note>
134
135<screen revision="sysv"><userinput>./configure --prefix=/usr \
136 --sysconfdir=/etc \
137 --localstatedir=/var \
138 --disable-systemd &amp;&amp;
139make</userinput></screen>
140
141<screen revision="systemd"><userinput>./configure --prefix=/usr \
142 --sysconfdir=/etc \
143 --localstatedir=/var &amp;&amp;
144make</userinput></screen>
145
146 <para>This package does not come with a test suite.</para>
147
148 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
149
150<screen role="root"><userinput>make docdir=/usr/share/doc/stunnel-&stunnel-version; install</userinput></screen>
151
152 <para revision="systemd">
153 Install the included systemd unit by running the following command as the
154 <systemitem class="username">root</systemitem> user:
155 </para>
156
157<screen role="root" revision="systemd"><userinput>install -v -m644 tools/stunnel.service /lib/systemd/system</userinput></screen>
158
159 <para>If you do not already have a signed SSL Certificate and Private Key,
160 create the <filename>stunnel.pem</filename> file in the
161 <filename class="directory">/etc/stunnel</filename> directory using the
162 command below. You will be prompted to enter the necessary
163 information. Ensure you reply to the</para>
164
165<screen><prompt>Common Name (FQDN of your server) [localhost]:</prompt></screen>
166
167 <para>prompt with the name or IP address you will be using
168 to access the service(s).</para>
169
170 <para>To generate a certificate, as the
171 <systemitem class="username">root</systemitem> user, issue:</para>
172
173<screen role="root"><userinput>make cert</userinput></screen>
174
175 </sect2>
176
177 <sect2 role="commands">
178 <title>Command Explanations</title>
179
180 <para revision="sysv"><parameter>--disable-systemd</parameter>: This switch
181 disables systemd socket activation support which is not available in
182 BLFS.</para>
183
184 <para><command>make docdir=... install</command>: This command installs the
185 package and changes the documentation installation directory to standard
186 naming conventions.</para>
187
188 </sect2>
189
190 <sect2 role="configuration">
191 <title>Configuring stunnel</title>
192
193 <sect3 id="stunnel-config">
194 <title>Config Files</title>
195
196 <para><filename>/etc/stunnel/stunnel.conf</filename></para>
197
198 <indexterm zone="stunnel stunnel-config">
199 <primary sortas="e-etc-stunnel-stunnel.conf">/etc/stunnel/stunnel.conf</primary>
200 </indexterm>
201
202 </sect3>
203
204 <sect3>
205 <title>Configuration Information</title>
206
207 <para>As the <systemitem class="username">root</systemitem> user,
208 create the directory used for the
209 <filename class="extension">.pid</filename> file created
210 when the <application>stunnel</application> daemon starts:</para>
211
212<screen role="root"><userinput>install -v -m750 -o stunnel -g stunnel -d /var/lib/stunnel/run &amp;&amp;
213chown stunnel:stunnel /var/lib/stunnel</userinput></screen>
214
215 <para>Next, create a basic <filename>/etc/stunnel/stunnel.conf</filename>
216 configuration file using the following commands as the
217 <systemitem class="username">root</systemitem> user:</para>
218
219<screen role="root"><userinput>cat &gt;/etc/stunnel/stunnel.conf &lt;&lt; "EOF"
220<literal>; File: /etc/stunnel/stunnel.conf
221
222; Note: The pid and output locations are relative to the chroot location.
223
224pid = /run/stunnel.pid
225chroot = /var/lib/stunnel
226client = no
227setuid = stunnel
228setgid = stunnel
229cert = /etc/stunnel/stunnel.pem
230
231;debug = 7
232;output = stunnel.log
233
234;[https]
235;accept = 443
236;connect = 80
237;; "TIMEOUTclose = 0" is a workaround for a design flaw in Microsoft SSL
238;; Microsoft implementations do not use SSL close-notify alert and thus
239;; they are vulnerable to truncation attacks
240;TIMEOUTclose = 0</literal>
241
242EOF</userinput></screen>
243
244 <para>Finally, add the service(s) you wish to encrypt to the
245 configuration file. The format is as follows:</para>
246
247<screen><literal>[<replaceable>&lt;service&gt;</replaceable>]
248accept = <replaceable>&lt;hostname:portnumber&gt;</replaceable>
249connect = <replaceable>&lt;hostname:portnumber&gt;</replaceable></literal></screen>
250
251 <para>If you use <application>stunnel</application> to encrypt a daemon
252 started from <command>[x]inetd</command>, you may need to disable that
253 daemon in the <filename>/etc/[x]inetd.conf</filename> file and enable a
254 corresponding <replaceable>&lt;service&gt;</replaceable>_stunnel service. You
255 may have to add an appropriate entry in <filename>/etc/services</filename>
256 as well.</para>
257
258 <para>For a full explanation of the commands and syntax used in the
259 configuration file, issue <command>man stunnel</command>.</para>
260
261 </sect3>
262
263 <sect3 id="stunnel-init">
264 <title><phrase revision="sysv">Boot Script</phrase>
265 <phrase revision="systemd">Systemd Unit</phrase></title>
266
267 <para revision="sysv">To automatically start the
268 <command>stunnel</command> daemon when the system is booted, install the
269 <filename>/etc/rc.d/init.d/stunnel</filename> bootscript from the
270 <xref linkend="bootscripts"/> package.</para>
271
272 <para revision="systemd">To start the <command>stunnel</command>
273 daemon at boot, enalbe the previously installed
274 <application>systemd</application> unit by running the following command
275 as the <systemitem class="username">root</systemitem> user:</para>
276
277 <indexterm zone="stunnel stunnel-init">
278 <primary sortas="f-stunnel">stunnel</primary>
279 </indexterm>
280
281<screen role="root" revision="sysv"><userinput>make install-stunnel</userinput></screen>
282
283<screen role="root" revision="systemd"><userinput>systemctl enable stunnel</userinput></screen>
284
285 </sect3>
286
287 </sect2>
288
289 <sect2 role="content">
290 <title>Contents</title>
291
292 <segmentedlist>
293 <segtitle>Installed Programs</segtitle>
294 <segtitle>Installed Library</segtitle>
295 <segtitle>Installed Directories</segtitle>
296
297 <seglistitem>
298 <seg>
299 stunnel and stunnel3
300 </seg>
301 <seg>
302 libstunnel.so
303 </seg>
304 <seg>
305 /{etc,usr/lib,var/lib}/stunnel and
306 /usr/share/doc/stunnel-&stunnel-version;
307 </seg>
308 </seglistitem>
309 </segmentedlist>
310
311 <variablelist>
312 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
313 <?dbfo list-presentation="list"?>
314 <?dbhtml list-presentation="table"?>
315
316 <varlistentry id="stunnel-prog">
317 <term><command>stunnel</command></term>
318 <listitem>
319 <para> is a program designed to work as an SSL
320 encryption wrapper between remote clients and local
321 (<command>{x}inetd</command>-startable) or remote servers.</para>
322 <indexterm zone="stunnel stunnel-prog">
323 <primary sortas="b-stunnel">stunnel</primary>
324 </indexterm>
325 </listitem>
326 </varlistentry>
327
328 <varlistentry id="stunnel3">
329 <term><command>stunnel3</command></term>
330 <listitem>
331 <para>is a <application>Perl</application> wrapper script to use
332 <command>stunnel</command> 3.x syntax with <command>stunnel</command>
333 >=4.05.</para>
334 <indexterm zone="stunnel stunnel3">
335 <primary sortas="b-stunnel3">stunnel3</primary>
336 </indexterm>
337 </listitem>
338 </varlistentry>
339
340 <varlistentry id="libstunnel">
341 <term><filename class='libraryfile'>libstunnel.so</filename></term>
342 <listitem>
343 <para> contains the API functions required by
344 <application>stunnel</application>.</para>
345 <indexterm zone="stunnel libstunnel">
346 <primary sortas="c-libstunnel">libstunnel.so</primary>
347 </indexterm>
348 </listitem>
349 </varlistentry>
350
351 </variablelist>
352
353 </sect2>
354
355</sect1>
Note: See TracBrowser for help on using the repository browser.