1TFTPD(8) System Manager's Manual TFTPD(8)
2
6 tftpd - Trivial File Transfer Protocol server
7
9 in.tftpd [options...] directory...
10
12 tftpd is a server for the Trivial File Transfer Protocol. The TFTP
13 protocol is extensively used to support remote booting of diskless
14 devices. The server is normally started by inetd, but can also run
15 standalone.
16
18 --ipv4, -4
19 Connect with IPv4 only, even if IPv6 support was compiled in.
20 --ipv6, -6
22 Connect with IPv6 only, if compiled in.
23 -l, --listen
25 Run the server in standalone (listen) mode, rather than run from
26 inetd. In listen mode, the --timeout option is ignored, and the
27 --address option can be used to specify a specific local address
28 or port to listen to.
29 --foreground, -L
31 Similar to --listen but do not detach from the foreground
32 process. Implies --listen.
33 --address [address][:port], -a [address][:port]
35 Specify a specific address and port to listen to when called
36 with the --listen or --foreground option. The default is to
37 listen to the tftp port specified in /etc/services on all local
38 addresses.
39 Please note: Numeric IPv6 adresses must be enclosed in square
41 brackets to avoid ambiguity with the optional port information.
42 --create, -c
44 Allow new files to be created. By default, tftpd will only
45 allow upload of files that already exist. Files are created
46 with default permissions allowing anyone to read or write them,
47 unless the --permissive or --umask options are specified.
48 --secure, -s
50 Change root directory on startup. This means the remote host
51 does not need to pass along the directory as part of the trans‐
52 fer, and may add security. When --secure is specified, exactly
53 one directory should be specified on the command line. The use
54 of this option is recommended for security as well as compati‐
55 bility with some boot ROMs which cannot be easily made to
56 include a directory name in its request.
57 --user username, -u username
59 Specify the username which tftpd will run as; the default is
60 "nobody". The user ID, group ID, and (if possible on the plat‐
61 form) the supplementary group IDs will be set to the ones speci‐
62 fied in the system permission database for this username.
63 --umask umask, -U umask
65 Sets the umask for newly created files to the specified value.
66 The default is zero (anyone can read or write) if the --permis‐
67 sive option is not specified, or inherited from the invoking
68 process if --permissive is specified.
69 --permissive, -p
71 Perform no additional permissions checks above the normal sys‐
72 tem-provided access controls for the user specified via the
73 --user option.
74 --pidfile pidfile, -P pidfile
76 When run in standalone mode, write the process ID of the listen‐
77 ing server into pidfile. On normal termination (SIGTERM or SIG‐
78 INT) the pid file is automatically removed.
79 --timeout timeout, -t timeout
81 When run from inetd this specifies how long, in seconds, to wait
82 for a second connection before terminating the server. inetd
83 will then respawn the server when another request comes in. The
84 default is 900 (15 minutes.)
85 --retransmit timeout, -T timeout
87 Determine the default timeout, in microseconds, before the first
88 packet is retransmitted. This can be modified by the client if
89 the timeout or utimeout option is negotiated. The default is
90 1000000 (1 second.)
91 --map-file remap-file, -m remap-file
93 Specify the use of filename remapping. The remap-file is a file
94 containing the remapping rules. See the section on filename
95 remapping below. This option may not be compiled in, see the
96 output of in.tftpd -V to verify whether or not it is available.
97 --verbose, -v
99 Increase the logging verbosity of tftpd. This flag can be spec‐
100 ified multiple times for even higher verbosity.
101 --verbosity value
103 Set the verbosity value to value.
104 --refuse tftp-option, -r tftp-option
106 Indicate that a specific RFC 2347 TFTP option should never be
107 accepted.
108 --blocksize max-block-size, -B max-block-size
110 Specifies the maximum permitted block size. The permitted range
111 for this parameter is from 512 to 65464. Some embedded clients
112 request large block sizes and yet do not handle fragmented pack‐
113 ets correctly; for these clients, it is recommended to set this
114 value to the smallest MTU on your network minus 32 bytes (20
115 bytes for IP, 8 for UDP, and 4 for TFTP; less if you use IP
116 options on your network.) For example, on a standard Ethernet
117 (MTU 1500) a value of 1468 is reasonable.
118 --port-range port:port, -R port:port
120 Force the server port number (the Transaction ID) to be in the
121 specified range of port numbers.
122 --version, -V
124 Print the version number and configuration to standard output,
125 then exit gracefully.
126
128 This version of tftpd supports RFC 2347 option negotation. Currently
129 implemented options are:
130 blksize (RFC 2348)
132 Set the transfer block size to anything less than or equal to
133 the specified option. This version of tftpd can support any
134 block size up to the theoretical maximum of 65464 bytes.
135 blksize2 (nonstandard)
137 Set the transfer block size to anything less than or equal to
138 the specified option, but restrict the possible responses to
139 powers of 2. The maximum is 32768 bytes (the largest power of 2
140 less than or equal to 65464.)
141 tsize (RFC 2349)
143 Report the size of the file that is about to be transferred.
144 This version of tftpd only supports the tsize option for binary
145 (octet) mode transfers.
146 timeout (RFC 2349)
148 Set the time before the server retransmits a packet, in seconds.
149 utimeout (nonstandard)
151 Set the time before the server retransmits a packet, in
152 microseconds.
153 rollover (nonstandard)
155 Set the block number to resume at after a block number rollover.
156 The default and recommended value is zero.
157 windowsize (RFC 7440)
159 Set the windowsize to a number of blocks that should be sent
160 before expecting an ack. The default is 1, which means the same
161 functionality as if windowsize wasn't used. Maximum is 64.
162 The --refuse option can be used to disable specific options; this may
164 be necessary to work around bugs in specific TFTP client implementa‐
165 tions. For example, some TFTP clients have been found to request the
166 blksize option, but crash with an error if they actually get the option
167 accepted by the server.
168
170 The --map-file option specifies a file which contains filename remap‐
171 ping rules. Each non-comment line (comments begin with hash marks, #)
172 contains an operation, specified below; a regex, a regular expression
173 in the style of egrep; and optionally a replacement pattern. The oper‐
174 ation indicated by operation is performed if the regex matches all or
175 part of the filename. Rules are processed from the top down, and by
176 default, all rules are processed even if there is a match.
177 The operation can be any combination of the following letters:
179 r Replace the substring matched by regex by the replacement pat‐
181 tern. The replacement pattern may contain escape sequences; see
182 below.
183 g Repeat this rule until it no longer matches. This is always
185 used with r.
186 i Match the regex case-insensitively. By default it is case sen‐
188 sitive.
189 e If this rule matches, end rule processing after executing the
191 rule.
192 s If this rule matches, start rule processing over from the very
194 first rule after executing this rule.
195 a If this rule matches, refuse the request and send an access
197 denied error to the client.
198 G This rule applies to GET (RRQ) requests only.
200 P This rule applies to PUT (WRQ) requests only.
202 ~ Inverse the sense of this rule, i.e. execute the operation only
204 if the regex doesn't match. Cannot used together with r.
205 The following escape sequences are recognized as part of the replace‐
207 ment pattern:
208 \0 The entire string matched by the regex.
210 \1 to \9
212 The strings matched by each of the first nine parenthesized sub‐
213 expressions, \( ... \), of the regex pattern.
214 \i The IP address of the requesting host, in dotted-quad notation
216 (e.g. 192.0.2.169).
217 \x The IP address of the requesting host, in hexadecimal notation
219 (e.g. C00002A9).
220 \\ Literal backslash.
222 \whitespace
224 Literal whitespace.
225 \# Literal hash mark.
227 \U Turns all subsequent letters to upper case.
229 \L Turns all subsequent letters to lower case.
231 \E Cancels the effect of \U or \L.
233 If the mapping file is changed, you need to send SIGHUP to any out‐
235 standing tftpd process.
236
238 The use of TFTP services does not require an account or password on the
239 server system. Due to the lack of authentication information, tftpd
240 will allow only publicly readable files (o+r) to be accessed, unless
241 the --permissive option is specified. Files may be written only if
242 they already exist and are publicly writable, unless the --create
243 option is specified. Note that this extends the concept of ``public''
244 to include all users on all hosts that can be reached through the net‐
245 work; this may not be appropriate on all systems, and its implications
246 should be considered before enabling TFTP service. Typically, some
247 kind of firewall or packet-filter solution should be employed. If
248 appropriately compiled (see the output of in.tftpd --version) tftpd
249 will query the hosts_access(5) database for access control information.
250 This may be slow; sites requiring maximum performance may want to com‐
251 pile without this option and rely on firewalling or kernel-based packet
252 filters instead.
253 The server should be set to run as the user with the lowest possible
255 privilege; please see the --user flag. It is probably a good idea to
256 set up a specific user account for tftpd, rather than letting it run as
257 "nobody", to guard against privilege leaks between applications.
258 Access to files can, and should, be restricted by invoking tftpd with a
260 list of directories by including pathnames as server program arguments
261 on the command line. In this case access is restricted to files whole
262 names are prefixed by one of the given directories. If possible, it is
263 recommended that the --secure flag is used to set up a chroot() envi‐
264 ronment for the server to run in once a connection has been set up.
265 Finally, the filename remapping (--map-file flag) support can be used
267 to provide a limited amount of additional access control.
268
270 RFC 1123, Requirements for Internet Hosts - Application and Support.
271 RFC 1350, The TFTP Protocol (revision 2).
272 RFC 2347, TFTP Option Extension.
273 RFC 2348, TFTP Blocksize Option.
274 RFC 2349, TFTP Timeout Interval and Transfer Size Options.
275 RFC 7440, TFTP Windowsize Option.
276
278 This version of tftpd is maintained by H. Peter Anvin <hpa@zytor.com>.
279 It was derived from, but has substantially diverged from, an OpenBSD
280 source base, with added patches by Markus Gutschke and Gero Kulhman.
281
283 tftp(1), egrep(1), umask(2), hosts_access(5), regex(7), inetd(8).
284tftp-hpa 5.2 14 September 2009 TFTPD(8)