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 stunnel-download-http "http://www.stunnel.org/download/stunnel/src/stunnel-&stunnel-version;.tar.gz">
|
---|
8 | <!ENTITY stunnel-download-ftp "ftp://ftp.fu-berlin.de/unix/linux/mirrors/gentoo/distfiles/stunnel-&stunnel-version;.tar.gz">
|
---|
9 | <!ENTITY stunnel-size "486 KB">
|
---|
10 | <!ENTITY stunnel-buildsize "3.9 MB">
|
---|
11 | <!ENTITY stunnel-time "0.11 SBU">
|
---|
12 | ]>
|
---|
13 |
|
---|
14 | <sect1 id="stunnel-package" xreflabel="Stunnel-&stunnel-version;">
|
---|
15 | <sect1info>
|
---|
16 | <othername>$LastChangedBy$</othername>
|
---|
17 | <date>$Date$</date>
|
---|
18 | </sect1info>
|
---|
19 | <?dbhtml filename="stunnel.html"?>
|
---|
20 | <title>Stunnel-&stunnel-version;</title>
|
---|
21 | <indexterm zone="stunnel-package">
|
---|
22 | <primary sortas="a-Stunnel-package">Stunnel</primary></indexterm>
|
---|
23 |
|
---|
24 | <sect2>
|
---|
25 | <title>Introduction to <application>Stunnel</application></title>
|
---|
26 |
|
---|
27 | <para>The <application>Stunnel</application> package contains a program that
|
---|
28 | allows you to encrypt arbitrary <acronym>TCP</acronym> connections inside
|
---|
29 | <acronym>SSL</acronym> (Secure Sockets Layer) so you can easily communicate
|
---|
30 | with clients over secure channels. <application>Stunnel</application> can be
|
---|
31 | used to add <acronym>SSL</acronym> functionality to commonly used Inetd
|
---|
32 | daemons like <acronym>POP</acronym>-2, <acronym>POP</acronym>-3, and
|
---|
33 | <acronym>IMAP</acronym> servers, to standalone daemons like
|
---|
34 | <acronym>NNTP</acronym>, <acronym>SMTP</acronym> and <acronym>HTTP</acronym>,
|
---|
35 | and in tunneling <acronym>PPP</acronym> over network sockets without changes
|
---|
36 | to the server package source code.</para>
|
---|
37 |
|
---|
38 | <sect3><title>Package information</title>
|
---|
39 | <itemizedlist spacing="compact">
|
---|
40 | <listitem><para>Download (HTTP):
|
---|
41 | <ulink url="&stunnel-download-http;"/></para></listitem>
|
---|
42 | <listitem><para>Download (FTP):
|
---|
43 | <ulink url="&stunnel-download-ftp;"/></para></listitem>
|
---|
44 | <listitem><para>Download size:
|
---|
45 | &stunnel-size;</para></listitem>
|
---|
46 | <listitem><para>Estimated disk space required:
|
---|
47 | &stunnel-buildsize;</para></listitem>
|
---|
48 | <listitem><para>Estimated build time:
|
---|
49 | &stunnel-time;</para></listitem></itemizedlist>
|
---|
50 | </sect3>
|
---|
51 |
|
---|
52 | <sect3><title><application>Stunnel</application> dependencies</title>
|
---|
53 | <sect4><title>Required</title>
|
---|
54 | <para><xref linkend="openssl-package"/></para>
|
---|
55 | </sect4>
|
---|
56 |
|
---|
57 | <sect4><title>Optional</title>
|
---|
58 | <para><xref linkend="tcpwrappers"/></para>
|
---|
59 | </sect4>
|
---|
60 | </sect3>
|
---|
61 |
|
---|
62 | </sect2>
|
---|
63 |
|
---|
64 | <sect2>
|
---|
65 | <title>Installation of <application>Stunnel</application></title>
|
---|
66 |
|
---|
67 | <para>The <command>stunnel</command> daemon will be run in a
|
---|
68 | <command>chroot</command> jail by an unprivileged user. Create the new user,
|
---|
69 | group and <command>chroot</command> home directory structure using the
|
---|
70 | following commands:</para>
|
---|
71 |
|
---|
72 | <screen><userinput><command>groupadd stunnel &&
|
---|
73 | useradd -c "Stunnel Daemon" -d /var/lib/stunnel -g stunnel -s /bin/false stunnel &&
|
---|
74 | install -d -m 700 -o stunnel -g stunnel /var/lib/stunnel/run</command></userinput></screen>
|
---|
75 |
|
---|
76 | <note><para>A signed <acronym>SSL</acronym> Certificate and a Private Key is
|
---|
77 | necessary to run the <command>stunnel</command> daemon. If you own, or have
|
---|
78 | already created a signed <acronym>SSL</acronym> Certificate you wish to use,
|
---|
79 | copy it to <filename>tools/stunnel.pem</filename> in the source directory
|
---|
80 | before starting the build, otherwise you will be prompted to create one. The
|
---|
81 | <filename>.pem</filename> file must be formatted as shown below:</para>
|
---|
82 |
|
---|
83 | <screen>-----BEGIN RSA PRIVATE KEY-----
|
---|
84 | <replaceable>[many encrypted lines of unencrypted key]</replaceable>
|
---|
85 | -----END RSA PRIVATE KEY-----
|
---|
86 | -----BEGIN CERTIFICATE-----
|
---|
87 | <replaceable>[many encrypted lines of certificate]</replaceable>
|
---|
88 | -----END CERTIFICATE-----</screen></note>
|
---|
89 |
|
---|
90 | <para>Install <application>Stunnel</application> by running the following
|
---|
91 | commands:</para>
|
---|
92 |
|
---|
93 | <screen><userinput><command>./configure --prefix=/usr --sysconfdir=/etc \
|
---|
94 | --localstatedir=/var/lib/stunnel &&
|
---|
95 | make &&
|
---|
96 | make install</command></userinput></screen>
|
---|
97 |
|
---|
98 | </sect2>
|
---|
99 |
|
---|
100 | <sect2>
|
---|
101 | <title>Command explanations</title>
|
---|
102 |
|
---|
103 | <para><parameter>--sysconfdir=/etc</parameter>: This parameter forces the
|
---|
104 | configuration directory to <filename class='directory'>/etc</filename> instead
|
---|
105 | of <filename class='directory'>/usr/etc</filename>.</para>
|
---|
106 |
|
---|
107 | <para><parameter>--localstatedir=/var/lib/stunnel</parameter>: This parameter
|
---|
108 | causes the installation process to create
|
---|
109 | <filename class='directory'>/var/lib/stunnel/stunnel</filename> instead of
|
---|
110 | <filename class='directory'>/usr/var/stunnel</filename>.</para>
|
---|
111 |
|
---|
112 | <para><command>make</command>: This command builds the package and, if you
|
---|
113 | did not copy an <filename>stunnel.pem</filename> file to the source
|
---|
114 | <filename class='directory'>tools/</filename> directory, prompts you for the
|
---|
115 | necessary information to create one. Ensure you reply to the</para>
|
---|
116 |
|
---|
117 | <screen><computeroutput>Common Name (FQDN of your server) [localhost]:</computeroutput></screen>
|
---|
118 |
|
---|
119 | <para>prompt with the name or <acronym>IP</acronym> address you will be using
|
---|
120 | to access the service.</para>
|
---|
121 |
|
---|
122 | </sect2>
|
---|
123 |
|
---|
124 | <sect2>
|
---|
125 | <title>Configuring <application>Stunnel</application></title>
|
---|
126 |
|
---|
127 | <sect3 id="stunnel-config"><title>Config files</title>
|
---|
128 | <para><filename>/etc/stunnel/stunnel.conf</filename></para>
|
---|
129 | <indexterm zone="stunnel-package stunnel-config">
|
---|
130 | <primary sortas="e-etc-stunnel-stunnel.conf">/etc/stunnel/stunnel.conf</primary>
|
---|
131 | </indexterm>
|
---|
132 | </sect3>
|
---|
133 |
|
---|
134 | <sect3><title>Configuration Information</title>
|
---|
135 |
|
---|
136 | <para>Create a basic <filename>/etc/stunnel/stunnel.conf</filename>
|
---|
137 | configuration file using the following commands:</para>
|
---|
138 |
|
---|
139 | <screen><userinput><command>cat >/etc/stunnel/stunnel.conf << "EOF"</command>
|
---|
140 | # File: /etc/stunnel/stunnel.conf
|
---|
141 |
|
---|
142 | pid = /run/stunnel.pid
|
---|
143 | chroot = /var/lib/stunnel
|
---|
144 | client = no
|
---|
145 | setuid = stunnel
|
---|
146 | setgid = stunnel
|
---|
147 |
|
---|
148 | <command>EOF</command></userinput></screen>
|
---|
149 |
|
---|
150 | <para>Next, you need to add the service you wish to encrypt to the
|
---|
151 | configuration file. The format is as follows:</para>
|
---|
152 |
|
---|
153 | <screen><userinput>[<replaceable>[service]</replaceable>]
|
---|
154 | accept = <replaceable>[hostname:portnumber]</replaceable>
|
---|
155 | connect = <replaceable>[hostname:portnumber]</replaceable></userinput></screen>
|
---|
156 |
|
---|
157 | <para>If you use <application>Stunnel</application> to encrypt a daemon
|
---|
158 | started from <command>[x]inetd</command>, you may need to disable that daemon
|
---|
159 | in the <filename>/etc/[x]inetd.conf</filename> file and enable a corresponding
|
---|
160 | <replaceable>[service]</replaceable>_stunnel service. You may have to add an
|
---|
161 | appropriate entry in <filename>/etc/services</filename> as well.</para>
|
---|
162 |
|
---|
163 | <para>For a full explanation of the commands and syntax used in the
|
---|
164 | configuration file, run <command>man stunnel</command>. To see a
|
---|
165 | <acronym>BLFS</acronym> example of an actual setup of an
|
---|
166 | <command>stunnel</command> encrypted service, read the
|
---|
167 | <acronym>SWAT</acronym> configuration section in the <xref linkend="samba3"/>
|
---|
168 | instructions.</para>
|
---|
169 |
|
---|
170 | <para id="stunnel.init">To automatically start the <command>stunnel</command>
|
---|
171 | daemon when the system is rebooted, install the
|
---|
172 | <filename>/etc/rc.d/init.d/stunnel</filename> bootscript from the
|
---|
173 | <xref linkend="intro-important-bootscripts"/> package.</para>
|
---|
174 | <indexterm zone="stunnel-package stunnel.init">
|
---|
175 | <primary sortas="f-stunnel.init">stunnel</primary></indexterm>
|
---|
176 |
|
---|
177 | <screen><userinput><command>make install-stunnel</command></userinput></screen>
|
---|
178 | </sect3>
|
---|
179 |
|
---|
180 | </sect2>
|
---|
181 |
|
---|
182 | <sect2>
|
---|
183 | <title>Contents</title>
|
---|
184 | <segmentedlist>
|
---|
185 | <segtitle>Installed Programs</segtitle>
|
---|
186 | <segtitle>Installed Library</segtitle>
|
---|
187 | <segtitle>Installed Directories</segtitle>
|
---|
188 | <seglistitem>
|
---|
189 | <seg>stunnel and stunnel3</seg>
|
---|
190 | <seg>libstunnel.so</seg>
|
---|
191 | <seg>/etc/stunnel, /var/lib/stunnel and
|
---|
192 | /usr/share/doc/stunnel</seg></seglistitem>
|
---|
193 | </segmentedlist>
|
---|
194 |
|
---|
195 | <variablelist>
|
---|
196 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
197 | <?dbfo list-presentation="list"?>
|
---|
198 |
|
---|
199 | <varlistentry id="stunnel">
|
---|
200 | <term><command>stunnel</command></term>
|
---|
201 | <listitem><para> is a program designed to work as an <acronym>SSL</acronym>
|
---|
202 | encryption wrapper between remote clients and local
|
---|
203 | (<command>[x]inetd</command>-startable) or remote servers.</para>
|
---|
204 | <indexterm zone="stunnel-package stunnel">
|
---|
205 | <primary sortas="b-stunnel">stunnel</primary></indexterm>
|
---|
206 | </listitem>
|
---|
207 | </varlistentry>
|
---|
208 |
|
---|
209 | <varlistentry id="stunnel3">
|
---|
210 | <term><command>stunnel3</command></term>
|
---|
211 | <listitem><para>is a <application>Perl</application> wrapper script to use
|
---|
212 | <command>stunnel</command> 3.x syntax with <command>stunnel</command>
|
---|
213 | >=4.05.</para>
|
---|
214 | <indexterm zone="stunnel-package stunnel3">
|
---|
215 | <primary sortas="b-stunnel3">stunnel3</primary></indexterm>
|
---|
216 | </listitem>
|
---|
217 | </varlistentry>
|
---|
218 |
|
---|
219 | <varlistentry id="libstunnel">
|
---|
220 | <term><filename class='libraryfile'>libstunnel.so</filename></term>
|
---|
221 | <listitem><para> contains the <acronym>API</acronym> functions required by
|
---|
222 | <application>Stunnel</application>.</para>
|
---|
223 | <indexterm zone="stunnel-package libstunnel">
|
---|
224 | <primary sortas="c-libstunnel">libstunnel.so</primary></indexterm>
|
---|
225 | </listitem>
|
---|
226 | </varlistentry>
|
---|
227 | </variablelist>
|
---|
228 |
|
---|
229 | </sect2>
|
---|
230 |
|
---|
231 | </sect1>
|
---|
232 |
|
---|