[d7c8734] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[d7c8734] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[436af1c] | 7 | <!ENTITY vsftpd-download-http "https://security.appspot.com/downloads/vsftpd-&vsftpd-version;.tar.gz">
|
---|
| 8 | <!ENTITY vsftpd-download-ftp " ">
|
---|
[73fe507] | 9 | <!ENTITY vsftpd-md5sum "da119d084bd3f98664636ea05b5bb398">
|
---|
[59c4cab] | 10 | <!ENTITY vsftpd-size "196 KB">
|
---|
[73fe507] | 11 | <!ENTITY vsftpd-buildsize "2 MB">
|
---|
[939e5f5] | 12 | <!ENTITY vsftpd-time "less than 0.1 SBU">
|
---|
[620b04a] | 13 | <!ENTITY vsftpd-empty "/usr/share/vsftpd/empty">
|
---|
[d7c8734] | 14 | ]>
|
---|
| 15 |
|
---|
[32ccdf34] | 16 | <sect1 id="vsftpd" xreflabel="vsftpd-&vsftpd-version;">
|
---|
[f8ff412] | 17 | <?dbhtml filename="vsftpd.html"?>
|
---|
| 18 |
|
---|
| 19 | <sect1info>
|
---|
| 20 | <othername>$LastChangedBy$</othername>
|
---|
| 21 | <date>$Date$</date>
|
---|
| 22 | </sect1info>
|
---|
| 23 |
|
---|
[32ccdf34] | 24 | <title>vsftpd-&vsftpd-version;</title>
|
---|
[f8ff412] | 25 |
|
---|
| 26 | <indexterm zone="vsftpd">
|
---|
[32ccdf34] | 27 | <primary sortas="a-vsftpd">vsftpd</primary>
|
---|
[f8ff412] | 28 | </indexterm>
|
---|
| 29 |
|
---|
[4e82a189] | 30 | <sect2 role="package">
|
---|
[32ccdf34] | 31 | <title>Introduction to vsftpd</title>
|
---|
[f8ff412] | 32 |
|
---|
[32ccdf34] | 33 | <para>The <application>vsftpd</application> package contains a very
|
---|
[f8ff412] | 34 | secure and very small FTP daemon. This is useful for serving files
|
---|
| 35 | over a network.</para>
|
---|
| 36 |
|
---|
[506d935] | 37 | &lfs84_checked;
|
---|
[5f2eb36] | 38 |
|
---|
[f8ff412] | 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 |
|
---|
[32ccdf34] | 61 | <bridgehead renderas="sect3">vsftpd Dependencies</bridgehead>
|
---|
[f8ff412] | 62 |
|
---|
[fa5ba12] | 63 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 64 | <para role="required">
|
---|
| 65 | <xref linkend="libnsl"/>
|
---|
| 66 | </para>
|
---|
| 67 |
|
---|
[f8ff412] | 68 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[e79ed72] | 69 | <para role="optional">
|
---|
[421e0cb2] | 70 | <xref linkend="libcap-pam"/>, and
|
---|
| 71 | <xref linkend="linux-pam"/>
|
---|
[e79ed72] | 72 | </para>
|
---|
[f8ff412] | 73 |
|
---|
[3cb0c57] | 74 | <para condition="html" role="usernotes">User Notes:
|
---|
| 75 | <ulink url="&blfs-wiki;/vsftpd"/></para>
|
---|
| 76 |
|
---|
[f8ff412] | 77 | </sect2>
|
---|
| 78 |
|
---|
| 79 | <sect2 role="installation">
|
---|
[32ccdf34] | 80 | <title>Installation of vsftpd</title>
|
---|
[f8ff412] | 81 |
|
---|
[32ccdf34] | 82 | <para>For security reasons, running <application>vsftpd</application>
|
---|
[939e5f5] | 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>
|
---|
[f8ff412] | 87 |
|
---|
[620b04a] | 88 | <screen role="root"><userinput>install -v -d -m 0755 &vsftpd-empty; &&
|
---|
| 89 | install -v -d -m 0755 /home/ftp &&
|
---|
| 90 | groupadd -g 47 vsftpd &&
|
---|
| 91 | groupadd -g 45 ftp &&
|
---|
[283bd88] | 92 |
|
---|
[5f2eb36] | 93 | useradd -c "vsftpd User" -d /dev/null -g vsftpd -s /bin/false -u 47 vsftpd &&
|
---|
| 94 | useradd -c anonymous_user -d /home/ftp -g ftp -s /bin/false -u 45 ftp</userinput></screen>
|
---|
[523c6e95] | 95 | <!--
|
---|
[5f2eb36] | 96 | <para>If you did not install the optional <application>libcap2</application> package,
|
---|
| 97 | run the following to avoid a build error:</para>
|
---|
| 98 |
|
---|
[523c6e95] | 99 | <screen><userinput>sed -i -e 's|#define VSF_SYSDEP_HAVE_LIBCAP|//&|' sysdeputil.c</userinput></screen>-->
|
---|
[d7c8734] | 100 |
|
---|
[32ccdf34] | 101 | <para>Build <application>vsftpd</application> as an unprivileged user
|
---|
[2bc0646] | 102 | using the following command:</para>
|
---|
[d7c8734] | 103 |
|
---|
[939e5f5] | 104 | <screen><userinput>make</userinput></screen>
|
---|
| 105 |
|
---|
[81d09ea] | 106 | <para>This package does not come with a test suite.</para>
|
---|
| 107 |
|
---|
[939e5f5] | 108 | <para>Once again, become the <systemitem class="username">root</systemitem>
|
---|
[32ccdf34] | 109 | user and install <application>vsftpd</application> with the following
|
---|
[939e5f5] | 110 | commands:</para>
|
---|
| 111 |
|
---|
[1c7e5c8a] | 112 | <screen role="root"><userinput>install -v -m 755 vsftpd /usr/sbin/vsftpd &&
|
---|
[5f2eb36] | 113 | install -v -m 644 vsftpd.8 /usr/share/man/man8 &&
|
---|
[f8ff412] | 114 | install -v -m 644 vsftpd.conf.5 /usr/share/man/man5 &&
|
---|
[5f2eb36] | 115 | install -v -m 644 vsftpd.conf /etc</userinput></screen>
|
---|
[d7c8734] | 116 |
|
---|
[f8ff412] | 117 | </sect2>
|
---|
[d7c8734] | 118 |
|
---|
[f8ff412] | 119 | <sect2 role="commands">
|
---|
| 120 | <title>Command Explanations</title>
|
---|
[d7c8734] | 121 |
|
---|
[2bc0646] | 122 | <para><command>install -v -d ...</command>: This creates the
|
---|
[f8ff412] | 123 | directory that anonymous users will use (<filename
|
---|
| 124 | class='directory'>/home/ftp</filename>)
|
---|
| 125 | and the directory the daemon will chroot into
|
---|
[620b04a] | 126 | (<filename class='directory'>&vsftpd-empty;</filename>).</para>
|
---|
[d7c8734] | 127 |
|
---|
[f8ff412] | 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>
|
---|
[d7c8734] | 133 |
|
---|
[2bc0646] | 134 | <para><command>echo "#define VSF_BUILD_TCPWRAPPERS" >>builddefs.h</command>:
|
---|
[f8ff412] | 135 | Use this prior to <command>make</command> to add support for
|
---|
| 136 | <application>tcpwrappers</application>.</para>
|
---|
[d7c8734] | 137 |
|
---|
[2bc0646] | 138 | <para><command>echo "#define VSF_BUILD_SSL" >>builddefs.h</command>:
|
---|
[f8ff412] | 139 | Use this prior to <command>make</command> to add support for SSL.</para>
|
---|
[d7c8734] | 140 |
|
---|
[2bc0646] | 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>
|
---|
[d7c8734] | 146 |
|
---|
[f8ff412] | 147 | </sect2>
|
---|
[d7c8734] | 148 |
|
---|
[f8ff412] | 149 | <sect2 role="configuration">
|
---|
[32ccdf34] | 150 | <title>Configuring vsftpd</title>
|
---|
[d7c8734] | 151 |
|
---|
[f8ff412] | 152 | <sect3 id="vsftpd-config">
|
---|
| 153 | <title>Config Files</title>
|
---|
[1586494] | 154 |
|
---|
[f8ff412] | 155 | <para><filename>/etc/vsftpd.conf</filename></para>
|
---|
[d7c8734] | 156 |
|
---|
[f8ff412] | 157 | <indexterm zone="vsftpd vsftpd-config">
|
---|
| 158 | <primary sortas="e-etc-vsftpd.conf">/etc/vsftpd.conf</primary>
|
---|
| 159 | </indexterm>
|
---|
[d7c8734] | 160 |
|
---|
[f8ff412] | 161 | </sect3>
|
---|
[d7c8734] | 162 |
|
---|
[f8ff412] | 163 | <sect3>
|
---|
| 164 | <title>Configuration Information</title>
|
---|
[d7c8734] | 165 |
|
---|
[32ccdf34] | 166 | <para><application>vsftpd</application> comes with a basic
|
---|
[f8ff412] | 167 | anonymous-only configuration file that was copied to
|
---|
[939e5f5] | 168 | <filename class='directory'>/etc</filename> above. While still as
|
---|
| 169 | <systemitem class="username">root</systemitem>, this file should be
|
---|
[f8ff412] | 170 | modified because it is now recommended to run <command>vsftpd</command>
|
---|
[59048cd9] | 171 | in standalone mode. <!-- as opposed to
|
---|
| 172 | <command>inetd</command>/<command>xinetd</command> mode. -->Also, you
|
---|
[f8ff412] | 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 >> /etc/vsftpd.conf << "EOF"
|
---|
| 178 | <literal>background=YES
|
---|
[d7c8734] | 179 | listen=YES
|
---|
| 180 | nopriv_user=vsftpd
|
---|
[620b04a] | 181 | secure_chroot_dir=&vsftpd-empty;</literal>
|
---|
[21a30d1] | 182 | EOF</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 >> /etc/vsftpd.conf << "EOF"
|
---|
| 193 | <literal>seccomp_sandbox=NO</literal>
|
---|
[ee92087f] | 194 | EOF</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 |
|
---|
[1dd7b0ae] | 200 | <screen role="root"><userinput>cat >> /etc/vsftpd.conf << "EOF"
|
---|
[ee92087f] | 201 | <literal>local_enable=YES</literal>
|
---|
| 202 | EOF</userinput></screen>
|
---|
| 203 |
|
---|
[1dd7b0ae] | 204 | <para>In addition, if using <application>Linux-PAM</application> and
|
---|
[ee92087f] | 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 |
|
---|
[1dd7b0ae] | 212 | <screen role="root"><userinput>cat > /etc/pam.d/vsftpd << "EOF" &&
|
---|
[ee92087f] | 213 | <literal># Begin /etc/pam.d/vsftpd
|
---|
| 214 | auth required /lib/security/pam_listfile.so item=user sense=deny \
|
---|
| 215 | file=/etc/ftpusers \
|
---|
| 216 | onerr=succeed
|
---|
| 217 | auth required pam_shells.so
|
---|
| 218 | auth include system-auth
|
---|
| 219 | account include system-account
|
---|
| 220 | session include system-session</literal>
|
---|
| 221 | EOF
|
---|
| 222 |
|
---|
| 223 | cat >> /etc/vsftpd.conf << "EOF"
|
---|
| 224 | <literal>session_support=YES
|
---|
| 225 | pam_service_name=vsftpd</literal>
|
---|
[f8ff412] | 226 | EOF</userinput></screen>
|
---|
[d7c8734] | 227 |
|
---|
[f8ff412] | 228 | </sect3>
|
---|
[d7c8734] | 229 |
|
---|
[f8ff412] | 230 | <sect3 id="vsftpd-init">
|
---|
[ee92087f] | 231 | <title><phrase revision="sysv">Boot Script</phrase>
|
---|
| 232 | <phrase revision="systemd">Systemd Unit</phrase></title>
|
---|
| 233 |
|
---|
[1258125] | 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"/>
|
---|
[3c7bd00] | 240 | <xref linkend="systemd-units" revision="systemd"/> package.</para>
|
---|
[d7c8734] | 241 |
|
---|
[f8ff412] | 242 | <screen role="root"><userinput>make install-vsftpd</userinput></screen>
|
---|
[d7c8734] | 243 |
|
---|
[f8ff412] | 244 | </sect3>
|
---|
[d7c8734] | 245 |
|
---|
[f8ff412] | 246 | </sect2>
|
---|
[d7c8734] | 247 |
|
---|
[f8ff412] | 248 | <sect2 role="content">
|
---|
| 249 | <title>Contents</title>
|
---|
[d7c8734] | 250 |
|
---|
[f8ff412] | 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>
|
---|
[523c6e95] | 259 | <seg>/usr/share/vsftpd, /home/ftp</seg>
|
---|
[f8ff412] | 260 | </seglistitem>
|
---|
| 261 | </segmentedlist>
|
---|
| 262 |
|
---|
| 263 | <variablelist>
|
---|
| 264 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 265 | <?dbfo list-presentation="list"?>
|
---|
| 266 | <?dbhtml list-presentation="table"?>
|
---|
[d7c8734] | 267 |
|
---|
[f8ff412] | 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>
|
---|