source: postlfs/security/stunnel.xml@ aa51c97

10.0 10.1 11.0 7.10 7.7 7.8 7.9 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 aa51c97 was aa51c97, checked in by Igor Živković <igor@…>, 7 years ago

remove needless stunnel configure switch

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

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