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 .\" $FreeBSD$
  34 .\"
  35 .Dd September 14, 2000
  36 .Dt TFTPD 8
  37 .Os
  38 .Sh NAME
  39 .Nm tftpd
  40 .Nd Internet Trivial File Transfer Protocol server
  41 .Sh SYNOPSIS
  42 .Nm tftpd
  43 .Op Fl cClnw
  44 .Op Fl s Ar directory
  45 .Op Fl u Ar user
  46 .Op Fl U Ar umask
  47 .Op Ar directory ...
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 utility is a server which supports the
  52 Internet Trivial File Transfer
  53 Protocol
  54 .Pq Tn RFC 1350 .
  55 The
  56 .Tn TFTP
  57 server operates
  58 at the port indicated in the
  59 .Ql tftp
  60 service description;
  61 see
  62 .Xr services 5 .
  63 The server is normally started by
  64 .Xr inetd 8 .
  65 .Pp
  66 The use of
  67 .Xr tftp 1
  68 does not require an account or password on the remote system.
  69 Due to the lack of authentication information,
  70 .Nm
  71 will allow only publicly readable files to be
  72 accessed.
  73 Files containing the string
  74 .Dq Li "/../"
  75 or starting with
  76 .Dq Li "../"
  77 are not allowed.
  78 Files may be written only if they already exist and are publicly writable.
  79 Note that this extends the concept of
  80 .Dq public
  81 to include
  82 all users on all hosts that can be reached through the network;
  83 this may not be appropriate on all systems, and its implications
  84 should be considered before enabling tftp service.
  85 The server should have the user ID with the lowest possible privilege.
  86 .Pp
  87 Access to files may be restricted by invoking
  88 .Nm
  89 with a list of directories by including up to 20 pathnames
  90 as server program arguments in
  91 .Xr inetd.conf 5 .
  92 In this case access is restricted to files whose
  93 names are prefixed by the one of the given directories.
  94 The given directories are also treated as a search path for
  95 relative filename requests.
  96 .Pp
  97 The
  98 .Fl s
  99 option provides additional security by changing
 100 the root directory of
 101 .Nm ,
 102 thereby prohibiting accesses to outside of the specified
 103 .Ar directory .
 104 Because
 105 .Xr chroot 2
 106 requires super-user privileges,
 107 .Nm
 108 must be run as
 109 .Li root .
 110 However, after performing the
 111 .Xr chroot 2
 112 call,
 113 .Nm
 114 will set its user ID to that of the specified
 115 .Ar user ,
 116 or
 117 .Dq Li nobody
 118 if no
 119 .Fl u
 120 option is specified.
 121 .Pp
 122 The options are:
 123 .Bl -tag -width Ds
 124 .It Fl c
 125 Changes the default root directory of a connecting host via
 126 .Xr chroot 2
 127 based on the connecting IP address.
 128 This prevents multiple clients from writing to the same file at the same time.
 129 If the directory does not exist, the client connection is refused.
 130 The
 131 .Fl s
 132 option is required for
 133 .Fl c
 134 and the specified
 135 .Ar directory
 136 is used as a base.
 137 .It Fl C
 138 Operates the same as
 139 .Fl c
 140 except it falls back to
 141 .Ar directory
 142 specified via
 143 .Fl s
 144 if a directory does not exist for the client's IP.
 145 .It Fl l
 146 Log all requests using
 147 .Xr syslog 3
 148 with the facility of
 149 .Dv LOG_FTP .
 150 .Sy Note :
 151 Logging of
 152 .Dv LOG_FTP
 153 messages
 154 must also be enabled in the syslog configuration file,
 155 .Xr syslog.conf 5 .
 156 .It Fl n
 157 Suppress negative acknowledgement of requests for nonexistent
 158 relative filenames.
 159 .It Fl s Ar directory
 160 Cause
 161 .Nm
 162 to change its root directory to
 163 .Ar directory .
 164 After doing that but before accepting commands,
 165 .Nm
 166 will switch credentials to an unprivileged user.
 167 .It Fl u Ar user
 168 Switch credentials to
 169 .Ar user
 170 (default
 171 .Dq Li nobody )
 172 when the
 173 .Fl s
 174 option is used.
 175 The user must be specified by name, not a numeric UID.
 176 .It Fl U Ar umask
 177 Set the
 178 .Ar umask
 179 for newly created files.
 180 The default is 022
 181 .Pq Dv S_IWGRP | S_IWOTH .
 182 .It Fl w
 183 Allow write requests to create new files.
 184 By default
 185 .Nm
 186 requires that the file specified in a write request exist.
 187 .El
 188 .Sh SEE ALSO
 189 .Xr tftp 1 ,
 190 .Xr chroot 2 ,
 191 .Xr syslog 3 ,
 192 .Xr inetd.conf 5 ,
 193 .Xr services 5 ,
 194 .Xr syslog.conf 5 ,
 195 .Xr inetd 8
 196 .Rs
 197 .%A K. R. Sollins
 198 .%T The TFTP Protocol (Revision 2)
 199 .%D July 1992
 200 .%O RFC 1350, STD 33
 201 .Re
 202 .Sh HISTORY
 203 The
 204 .Nm
 205 utility appeared in
 206 .Bx 4.2 ;
 207 the
 208 .Fl s
 209 option was introduced in
 210 .Fx 2.2 ,
 211 the
 212 .Fl u
 213 option was introduced in
 214 .Fx 4.2 ,
 215 and the
 216 .Fl c
 217 option was introduced in
 218 .Fx 4.3 .
 219 .Sh BUGS
 220 Files larger than 33488896 octets (65535 blocks) cannot be transferred
 221 without client and server supporting blocksize negotiation (RFC1783).
 222 .Pp
 223 Many tftp clients will not transfer files over 16744448 octets (32767 blocks).