libexec/tftpd/tftpd.8

   1 .\" Copyright (c) 1983, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)tftpd.8     8.1 (Berkeley) 6/4/93
  33 .\"
  34 .Dd June 4, 1993
  35 .Dt TFTPD 8
  36 .Os BSD 4.2
  37 .Sh NAME
  38 .Nm tftpd
  39 .Nd
  40 Internet Trivial File Transfer Protocol server
  41 .Sh SYNOPSIS
  42 .Nm /usr/libexec/tftpd
  43 .Op Fl l
  44 .Op Fl n
  45 .Op Fl s Ar directory
  46 .Op Ar directory ...
  47 .Sh DESCRIPTION
  48 .Nm Tftpd
  49 is a server which supports the
  50 Internet Trivial File Transfer
  51 Protocol (\c
  52 .Tn RFC 783).
  53 The
  54 .Tn TFTP
  55 server operates
  56 at the port indicated in the
  57 .Ql tftp
  58 service description;
  59 see
  60 .Xr services 5 .
  61 The server is normally started by
  62 .Xr inetd 8 .
  63 .Pp
  64 The use of
  65 .Xr tftp 1
  66 does not require an account or password on the remote system.
  67 Due to the lack of authentication information,
  68 .Nm
  69 will allow only publicly readable files to be
  70 accessed.
  71 Files containing the string ``/\|\fB.\|.\fP\|/'' or starting with
  72 ``\|\fB.\|.\fP\|/'' are not allowed.
  73 Files may be written only if they already exist and are publicly writable.
  74 Note that this extends the concept of
  75 .Dq public
  76 to include
  77 all users on all hosts that can be reached through the network;
  78 this may not be appropriate on all systems, and its implications
  79 should be considered before enabling tftp service.
  80 The server should have the user ID with the lowest possible privilege.
  81 .Pp
  82 Access to files may be restricted by invoking
  83 .Nm
  84 with a list of directories by including up to 20 pathnames
  85 as server program arguments in
  86 .Pa /etc/inetd.conf .
  87 In this case access is restricted to files whose
  88 names are prefixed by the one of the given directories.
  89 The given directories are also treated as a search path for
  90 relative filename requests.
  91 .Pp
  92 The chroot option provides additional security by restricting access
  93 of
  94 .Nm
  95 to only a chroot'd file system.  This is useful when moving
  96 from an OS that supported
  97 .Fl s
  98 as a boot server.  Because chroot is restricted to root, you must run
  99 .Nm
 100 as root.  However, if you chroot, then
 101 .Nm
 102 will set its user id to nobody.
 103 .Pp
 104 The options are:
 105 .Bl -tag -width Ds
 106 .It Fl l
 107 Log all requests using
 108 .Xr syslog 3
 109 with the facility of LOG_FTP.  Note: Logging of LOG_FTP messages
 110 will also need to be enabled in the syslog configuration file
 111 .Xr syslog.conf 5 .
 112 .It Fl n
 113 Suppress negative acknowledgement of requests for nonexistent
 114 relative filenames.
 115 .It Fl s Ar directory
 116 Cause
 117 .Nm
 118 to chroot to
 119 .Pa directory
 120 before accepting commands.  In addition, the user id is set to
 121 nobody.
 122 .Pp
 123 If you are not running
 124 .Fl s ,
 125 no user id change will be
 126 attempted.  You should not run
 127 .Nm
 128 as root unless you are using
 129 .Fl s .
 130 .El
 131 .Sh SEE ALSO
 132 .Xr tftp 1 ,
 133 .Xr inetd 8 ,
 134 .Xr syslogd 8
 135 .Sh HISTORY
 136 The
 137 .Nm
 138 command appeared in
 139 .Bx 4.2 .