libexec/tftpd/tftpd.8

   1 .\"     $NetBSD: tftpd.8,v 1.21 2003/08/07 09:46:53 agc Exp $
   2 .\"
   3 .\" Copyright (c) 1983, 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     from: @(#)tftpd.8       8.1 (Berkeley) 6/4/93
  31 .\"
  32 .Dd January 8, 2010
  33 .Dt TFTPD 8
  34 .Os
  35 .Sh NAME
  36 .Nm tftpd
  37 .Nd
  38 .Tn DARPA
  39 Internet Trivial File Transfer Protocol server
  40 .Sh SYNOPSIS
  41 .Nm
  42 .Op Fl d
  43 .Op Fl g Ar group
  44 .Op Fl l
  45 .Op Fl n
  46 .Op Fl p Ar path separator
  47 .Op Fl s Ar directory
  48 .Op Fl u Ar user
  49 .Op Ar directory ...
  50 .Sh DESCRIPTION
  51 .Nm
  52 is a server which supports the
  53 .Tn DARPA
  54 Trivial File Transfer Protocol.
  55 The
  56 .Tn TFTP
  57 server operates at the port indicated in the
  58 .Ql tftp
  59 service description; 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 accessed.
  70 Filenames beginning in ``\|\fB.\|.\fP\|/'' or
  71 containing ``/\|\fB.\|.\fP\|/'' are not allowed.
  72 Files may be written to only if they already exist and are publicly writable.
  73 .Pp
  74 Note that this extends the concept of
  75 .Qq 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 options are:
  93 .Bl -tag -width "directory"
  94 .It Fl d
  95 Enable verbose debugging messages to
  96 .Xr syslogd 8 .
  97 .It Fl g Ar group
  98 Change gid to that of
  99 .Ar group
 100 on startup.
 101 If this isn't specified, the gid is set to that of the
 102 .Ar user
 103 specified with
 104 .Fl u .
 105 .It Fl l
 106 Logs all requests using
 107 .Xr syslog 3 .
 108 .It Fl n
 109 Suppresses negative acknowledgement of requests for nonexistent
 110 relative filenames.
 111 .It Fl p Ar path separator
 112 All occurances of the single character
 113 .Ar path separator
 114 in the requested filename are replaced with
 115 .Sq / .
 116 .It Fl s Ar directory
 117 .Nm
 118 will
 119 .Xr chroot 2
 120 to
 121 .Ar directory
 122 on startup.
 123 This is recommended for security reasons (so that files other than
 124 those in the
 125 .Pa /tftpboot
 126 directory aren't accessible).
 127 If the remote host passes the directory name as part of the
 128 file name to transfer, you may have to create a symbolic link
 129 from
 130 .Sq tftpboot
 131 to
 132 .Sq \&.
 133 under
 134 .Pa /tftpboot .
 135 .It Fl u Ar user
 136 Change uid to that of
 137 .Ar user
 138 on startup.
 139 If
 140 .Fl u
 141 isn't given,
 142 .Ar user
 143 defaults to
 144 .Dq nobody .
 145 If
 146 .Fl g
 147 isn't also given, change the gid to that of
 148 .Ar user
 149 as well.
 150 .El
 151 .Sh SEE ALSO
 152 .Xr tftp 1 ,
 153 .Xr inetd 8
 154 .Rs
 155 .%R RFC
 156 .%N 1350
 157 .%D July 1992
 158 .%T "The TFTP Protocol (Revision 2)"
 159 .Re
 160 .Rs
 161 .%R RFC
 162 .%N 2347
 163 .%D May 1998
 164 .%T "TFTP Option Extension"
 165 .Re
 166 .Rs
 167 .%R RFC
 168 .%N 2348
 169 .%D May 1998
 170 .%T "TFTP Blocksize Option"
 171 .Re
 172 .Rs
 173 .%R RFC
 174 .%N 2349
 175 .%D May 1998
 176 .%T "TFTP Timeout Interval and Transfer Size Options"
 177 .Re
 178 .Sh HISTORY
 179 The
 180 .Nm
 181 command appeared in
 182 .Bx 4.2 .
 183 .Pp
 184 The
 185 .Fl s
 186 flag appeared in
 187 .Nx 1.0 .
 188 .Pp
 189 The
 190 .Fl g
 191 and
 192 .Fl u
 193 flags appeared in
 194 .Nx 1.4 .
 195 .Pp
 196 IPv6 support was implemented by WIDE/KAME project in 1999.
 197 .Pp
 198 TFTP options were implemented by Wasabi Systems, Inc., in 2003,
 199 and first appeared in
 200 .Nx 2.0 .
 201 .Sh BUGS
 202 Files larger than 33,553,919 octets (65535 blocks, last one <512
 203 octets) cannot be correctly transferred without client and server
 204 supporting blocksize negotiation (RFCs 2347 and 2348). As a kludge,
 205 .Nm
 206 accepts a sequence of block numbers which wrap to zero after 65535.
 207 .Pp
 208 Many tftp clients will not transfer files over 16,776,703 octets
 209 (32767 blocks), as they incorrectly count the block number using
 210 a signed rather than unsigned 16-bit integer.
 211 .Sh SECURITY CONSIDERATIONS
 212 You are
 213 .Em strongly
 214 advised to set up
 215 .Nm
 216 using the
 217 .Fl s
 218 flag in conjunction with the name of the directory that
 219 contains the files that
 220 .Nm
 221 will serve to remote hosts (e.g.,
 222 .Pa /tftpboot ) .
 223 This ensures that only the files that should be served
 224 to remote hosts can be accessed by them.
 225 .Pp
 226 Because there is no user-login or validation within
 227 the
 228 .Tn TFTP
 229 protocol, the remote site will probably have some
 230 sort of file-access restrictions in place.
 231 The exact methods are specific to each site and therefore
 232 difficult to document here.