source: server/major/vsftpd.xml@ d42fa7ee

10.0 10.1 11.0 9.1 ken/refactor-virt lazarus qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since d42fa7ee was d42fa7ee, checked in by Bruce Dubbs <bdubbs@…>, 20 months ago

Tweak lsb-tools instructions.
Tags.

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

  • Property mode set to 100644
File size: 10.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 vsftpd-download-http "https://security.appspot.com/downloads/vsftpd-&vsftpd-version;.tar.gz">
8 <!ENTITY vsftpd-download-ftp " ">
9 <!ENTITY vsftpd-md5sum "da119d084bd3f98664636ea05b5bb398">
10 <!ENTITY vsftpd-size "196 KB">
11 <!ENTITY vsftpd-buildsize "2 MB">
12 <!ENTITY vsftpd-time "less than 0.1 SBU">
13 <!ENTITY vsftpd-empty "/usr/share/vsftpd/empty">
14]>
15
16<sect1 id="vsftpd" xreflabel="vsftpd-&vsftpd-version;">
17 <?dbhtml filename="vsftpd.html"?>
18
19 <sect1info>
20 <othername>$LastChangedBy$</othername>
21 <date>$Date$</date>
22 </sect1info>
23
24 <title>vsftpd-&vsftpd-version;</title>
25
26 <indexterm zone="vsftpd">
27 <primary sortas="a-vsftpd">vsftpd</primary>
28 </indexterm>
29
30 <sect2 role="package">
31 <title>Introduction to vsftpd</title>
32
33 <para>The <application>vsftpd</application> package contains a very
34 secure and very small FTP daemon. This is useful for serving files
35 over a network.</para>
36
37 &lfs91_checked;
38
39 <bridgehead renderas="sect3">Package Information</bridgehead>
40 <itemizedlist spacing="compact">
41 <listitem>
42 <para>Download (HTTP): <ulink url="&vsftpd-download-http;"/></para>
43 </listitem>
44 <listitem>
45 <para>Download (FTP): <ulink url="&vsftpd-download-ftp;"/></para>
46 </listitem>
47 <listitem>
48 <para>Download MD5 sum: &vsftpd-md5sum;</para>
49 </listitem>
50 <listitem>
51 <para>Download size: &vsftpd-size;</para>
52 </listitem>
53 <listitem>
54 <para>Estimated disk space required: &vsftpd-buildsize;</para>
55 </listitem>
56 <listitem>
57 <para>Estimated build time: &vsftpd-time;</para>
58 </listitem>
59 </itemizedlist>
60
61 <bridgehead renderas="sect3">vsftpd Dependencies</bridgehead>
62
63 <bridgehead renderas="sect4">Required</bridgehead>
64 <para role="required">
65 <xref linkend="libnsl"/>
66 </para>
67
68 <bridgehead renderas="sect4">Optional</bridgehead>
69 <para role="optional">
70 <xref linkend="libcap-pam"/>, and
71 <xref linkend="linux-pam"/>
72 </para>
73
74 <para condition="html" role="usernotes">User Notes:
75 <ulink url="&blfs-wiki;/vsftpd"/></para>
76
77 </sect2>
78
79 <sect2 role="installation">
80 <title>Installation of vsftpd</title>
81
82 <para>For security reasons, running <application>vsftpd</application>
83 as an unprivileged user and group is encouraged. Also, a user should be
84 created to map anonymous users. As the <systemitem
85 class="username">root</systemitem> user, create the needed directories,
86 users, and groups with the following commands:</para>
87
88<screen role="root"><userinput>install -v -d -m 0755 &vsftpd-empty; &amp;&amp;
89install -v -d -m 0755 /home/ftp &amp;&amp;
90groupadd -g 47 vsftpd &amp;&amp;
91groupadd -g 45 ftp &amp;&amp;
92
93useradd -c "vsftpd User" -d /dev/null -g vsftpd -s /bin/false -u 47 vsftpd &amp;&amp;
94useradd -c anonymous_user -d /home/ftp -g ftp -s /bin/false -u 45 ftp</userinput></screen>
95<!--
96 <para>If you did not install the optional <application>libcap2</application> package,
97 run the following to avoid a build error:</para>
98
99<screen><userinput>sed -i -e 's|#define VSF_SYSDEP_HAVE_LIBCAP|//&amp;|' sysdeputil.c</userinput></screen>-->
100
101 <para>Build <application>vsftpd</application> as an unprivileged user
102 using the following command:</para>
103
104<screen><userinput>make</userinput></screen>
105
106 <para>This package does not come with a test suite.</para>
107
108 <para>Once again, become the <systemitem class="username">root</systemitem>
109 user and install <application>vsftpd</application> with the following
110 commands:</para>
111
112<screen role="root"><userinput>install -v -m 755 vsftpd /usr/sbin/vsftpd &amp;&amp;
113install -v -m 644 vsftpd.8 /usr/share/man/man8 &amp;&amp;
114install -v -m 644 vsftpd.conf.5 /usr/share/man/man5 &amp;&amp;
115install -v -m 644 vsftpd.conf /etc</userinput></screen>
116
117 </sect2>
118
119 <sect2 role="commands">
120 <title>Command Explanations</title>
121
122 <para><command>install -v -d ...</command>: This creates the
123 directory that anonymous users will use (<filename
124 class='directory'>/home/ftp</filename>)
125 and the directory the daemon will chroot into
126 (<filename class='directory'>&vsftpd-empty;</filename>).</para>
127
128 <note>
129 <para><filename class="directory">/home/ftp</filename> should not be
130 owned by the user <systemitem class="username">vsftpd</systemitem>,
131 or the user <systemitem class="username">ftp</systemitem>.</para>
132 </note>
133
134 <para><command>echo "#define VSF_BUILD_TCPWRAPPERS" >>builddefs.h</command>:
135 Use this prior to <command>make</command> to add support for
136 <application>tcpwrappers</application>.</para>
137
138 <para><command>echo "#define VSF_BUILD_SSL" >>builddefs.h</command>:
139 Use this prior to <command>make</command> to add support for SSL.</para>
140
141 <para><command>install -v -m ...</command>:
142 The <filename>Makefile</filename> uses non-standard installation paths.
143 These commands install the files in
144 <filename class='directory'>/usr</filename> and
145 <filename class='directory'>/etc</filename>.</para>
146
147 </sect2>
148
149 <sect2 role="configuration">
150 <title>Configuring vsftpd</title>
151
152 <sect3 id="vsftpd-config">
153 <title>Config Files</title>
154
155 <para><filename>/etc/vsftpd.conf</filename></para>
156
157 <indexterm zone="vsftpd vsftpd-config">
158 <primary sortas="e-etc-vsftpd.conf">/etc/vsftpd.conf</primary>
159 </indexterm>
160
161 </sect3>
162
163 <sect3>
164 <title>Configuration Information</title>
165
166 <para><application>vsftpd</application> comes with a basic
167 anonymous-only configuration file that was copied to
168 <filename class='directory'>/etc</filename> above. While still as
169 <systemitem class="username">root</systemitem>, this file should be
170 modified because it is now recommended to run <command>vsftpd</command>
171 in standalone mode. <!-- as opposed to
172 <command>inetd</command>/<command>xinetd</command> mode. -->Also, you
173 should specify the privilege separation user created above. Finally,
174 you should specify the <command>chroot</command> directory.
175 <command>man vsftpd.conf</command> will give you all the details.</para>
176
177<screen role="root"><userinput>cat &gt;&gt; /etc/vsftpd.conf &lt;&lt; "EOF"
178<literal>background=YES
179listen=YES
180nopriv_user=vsftpd
181secure_chroot_dir=&vsftpd-empty;</literal>
182EOF</userinput></screen>
183
184 <!-- recheck this issue when vsftpd is updated -->
185 <para>The vsftpd daemon uses seccomp to improve security by default.
186 But it's known to cause vsftpd unable to handle ftp
187 <literal>LIST</literal> command with recent kernel versions. Append
188 a line to <filename>/etc/vsftpd.conf</filename> (as the
189 <systemitem class="username">root</systemitem> user) to disable
190 seccomp and workaround this issue:</para>
191
192<screen role="root"><userinput>cat &gt;&gt; /etc/vsftpd.conf &lt;&lt; "EOF"
193<literal>seccomp_sandbox=NO</literal>
194EOF</userinput></screen>
195
196 <para>To enable local logins, append the following to the
197 <filename>/etc/vsftpd.conf</filename> file (as the
198 <systemitem class="username">root</systemitem> user):</para>
199
200<screen role="root"><userinput>cat &gt;&gt; /etc/vsftpd.conf &lt;&lt; "EOF"
201<literal>local_enable=YES</literal>
202EOF</userinput></screen>
203
204 <para>In addition, if using <application>Linux-PAM</application> and
205 <application>vsftpd</application> with local user logins, you will need
206 a <application>Linux-PAM</application> configuration file. As the
207 <systemitem class="username">root</systemitem> user, create the
208 <filename>/etc/pam.d/vsftpd</filename> file, and add the needed
209 configuration changes for <application>Linux-PAM</application> session
210 support using the following commands:</para>
211
212<screen role="root"><userinput>cat &gt; /etc/pam.d/vsftpd &lt;&lt; "EOF" &amp;&amp;
213<literal># Begin /etc/pam.d/vsftpd
214auth required /lib/security/pam_listfile.so item=user sense=deny \
215 file=/etc/ftpusers \
216 onerr=succeed
217auth required pam_shells.so
218auth include system-auth
219account include system-account
220session include system-session</literal>
221EOF
222
223cat &gt;&gt; /etc/vsftpd.conf &lt;&lt; "EOF"
224<literal>session_support=YES
225pam_service_name=vsftpd</literal>
226EOF</userinput></screen>
227
228 </sect3>
229
230 <sect3 id="vsftpd-init">
231 <title><phrase revision="sysv">Boot Script</phrase>
232 <phrase revision="systemd">Systemd Unit</phrase></title>
233
234 <para>Install the
235 <phrase revision="sysv"><filename>/etc/rc.d/init.d/vsftpd</filename> init
236 script</phrase>
237 <phrase revision="systemd"><filename>vsftpd.service</filename>
238 unit</phrase> included in the
239 <xref linkend="bootscripts" revision="sysv"/>
240 <xref linkend="systemd-units" revision="systemd"/> package.</para>
241
242<screen role="root"><userinput>make install-vsftpd</userinput></screen>
243
244 </sect3>
245
246 </sect2>
247
248 <sect2 role="content">
249 <title>Contents</title>
250
251 <segmentedlist>
252 <segtitle>Installed Program</segtitle>
253 <segtitle>Installed Libraries</segtitle>
254 <segtitle>Installed Directories</segtitle>
255
256 <seglistitem>
257 <seg>vsftpd</seg>
258 <seg>None</seg>
259 <seg>/usr/share/vsftpd, /home/ftp</seg>
260 </seglistitem>
261 </segmentedlist>
262
263 <variablelist>
264 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
265 <?dbfo list-presentation="list"?>
266 <?dbhtml list-presentation="table"?>
267
268 <varlistentry id="vsftpd-prog">
269 <term><command>vsftpd</command></term>
270 <listitem>
271 <para>is the FTP daemon.</para>
272 <indexterm zone="vsftpd vsftpd-prog">
273 <primary sortas="b-vsftpd">vsftpd</primary>
274 </indexterm>
275 </listitem>
276 </varlistentry>
277
278 </variablelist>
279
280 </sect2>
281
282</sect1>
Note: See TracBrowser for help on using the repository browser.