2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (C) 2008 Edwin Groothuis. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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.
15 * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD$");
31 #include <sys/socket.h>
32 #include <sys/types.h>
33 #include <sys/sysctl.h>
36 #include <netinet/in.h>
37 #include <arpa/tftp.h>
45 #include "tftp-utils.h"
47 #include "tftp-options.h"
53 struct options options[] = {
54 { "tsize", NULL, NULL, NULL /* option_tsize */, 1 },
55 { "timeout", NULL, NULL, option_timeout, 1 },
56 { "blksize", NULL, NULL, option_blksize, 1 },
57 { "blksize2", NULL, NULL, option_blksize2, 0 },
58 { "rollover", NULL, NULL, option_rollover, 0 },
59 { NULL, NULL, NULL, NULL, 0 }
62 /* By default allow them */
63 int options_rfc_enabled = 1;
64 int options_extra_enabled = 1;
67 * Rules for the option handlers:
68 * - If there is no o_request, there will be no processing.
71 * - Logging is done as warnings.
72 * - The handler exit()s if there is a serious problem with the
73 * values submitted in the option.
76 * - Logging is done as errors. After all, the server shouldn't
78 * - The handler returns if there is a serious problem with the
79 * values submitted in the option.
80 * - Sending the EBADOP packets is done by the handler.
84 option_tsize(int peer __unused, struct tftphdr *tp __unused, int mode,
88 if (options[OPT_TSIZE].o_request == NULL)
92 asprintf(&options[OPT_TSIZE].o_reply,
93 "%ju", stbuf->st_size);
95 /* XXX Allows writes of all sizes. */
96 options[OPT_TSIZE].o_reply =
97 strdup(options[OPT_TSIZE].o_request);
102 option_timeout(int peer)
106 if (options[OPT_TIMEOUT].o_request == NULL)
109 to = atoi(options[OPT_TIMEOUT].o_request);
110 if (to < TIMEOUT_MIN || to > TIMEOUT_MAX) {
111 tftp_log(acting_as_client ? LOG_ERR : LOG_WARNING,
112 "Received bad value for timeout. "
113 "Should be between %d and %d, received %d",
114 TIMEOUT_MIN, TIMEOUT_MAX, to);
115 send_error(peer, EBADOP);
116 if (acting_as_client)
121 options[OPT_TIMEOUT].o_reply =
122 strdup(options[OPT_TIMEOUT].o_request);
124 settimeouts(timeoutpacket, timeoutnetwork, maxtimeouts);
126 if (debug&DEBUG_OPTIONS)
127 tftp_log(LOG_DEBUG, "Setting timeout to '%s'",
128 options[OPT_TIMEOUT].o_reply);
134 option_rollover(int peer)
137 if (options[OPT_ROLLOVER].o_request == NULL)
140 if (strcmp(options[OPT_ROLLOVER].o_request, "0") != 0
141 && strcmp(options[OPT_ROLLOVER].o_request, "1") != 0) {
142 tftp_log(acting_as_client ? LOG_ERR : LOG_WARNING,
143 "Bad value for rollover, "
144 "should be either 0 or 1, received '%s', "
146 options[OPT_ROLLOVER].o_request);
147 if (acting_as_client) {
148 send_error(peer, EBADOP);
153 options[OPT_ROLLOVER].o_reply =
154 strdup(options[OPT_ROLLOVER].o_request);
156 if (debug&DEBUG_OPTIONS)
157 tftp_log(LOG_DEBUG, "Setting rollover to '%s'",
158 options[OPT_ROLLOVER].o_reply);
164 option_blksize(int peer)
169 if (options[OPT_BLKSIZE].o_request == NULL)
172 /* maximum size of an UDP packet according to the system */
173 len = sizeof(maxdgram);
174 if (sysctlbyname("net.inet.udp.maxdgram",
175 &maxdgram, &len, NULL, 0) < 0) {
176 tftp_log(LOG_ERR, "sysctl: net.inet.udp.maxdgram");
177 return (acting_as_client ? 1 : 0);
180 int size = atoi(options[OPT_BLKSIZE].o_request);
181 if (size < BLKSIZE_MIN || size > BLKSIZE_MAX) {
182 if (acting_as_client) {
184 "Invalid blocksize (%d bytes), aborting",
186 send_error(peer, EBADOP);
189 tftp_log(LOG_WARNING,
190 "Invalid blocksize (%d bytes), ignoring request",
196 if (size > (int)maxdgram) {
197 if (acting_as_client) {
199 "Invalid blocksize (%d bytes), "
200 "net.inet.udp.maxdgram sysctl limits it to "
201 "%ld bytes.\n", size, maxdgram);
202 send_error(peer, EBADOP);
205 tftp_log(LOG_WARNING,
206 "Invalid blocksize (%d bytes), "
207 "net.inet.udp.maxdgram sysctl limits it to "
208 "%ld bytes.\n", size, maxdgram);
210 /* No reason to return */
214 asprintf(&options[OPT_BLKSIZE].o_reply, "%d", size);
217 if (debug&DEBUG_OPTIONS)
218 tftp_log(LOG_DEBUG, "Setting blksize to '%s'",
219 options[OPT_BLKSIZE].o_reply);
225 option_blksize2(int peer __unused)
232 8, 16, 32, 64, 128, 256, 512, 1024,
233 2048, 4096, 8192, 16384, 32768, 0
236 if (options[OPT_BLKSIZE2].o_request == NULL)
239 /* maximum size of an UDP packet according to the system */
240 len = sizeof(maxdgram);
241 if (sysctlbyname("net.inet.udp.maxdgram",
242 &maxdgram, &len, NULL, 0) < 0) {
243 tftp_log(LOG_ERR, "sysctl: net.inet.udp.maxdgram");
244 return (acting_as_client ? 1 : 0);
247 size = atoi(options[OPT_BLKSIZE2].o_request);
248 for (i = 0; sizes[i] != 0; i++) {
249 if (size == sizes[i]) break;
253 "Invalid blocksize2 (%d bytes), ignoring request", size);
254 return (acting_as_client ? 1 : 0);
257 if (size > (int)maxdgram) {
258 for (i = 0; sizes[i+1] != 0; i++) {
259 if ((int)maxdgram < sizes[i+1]) break;
262 "Invalid blocksize2 (%d bytes), net.inet.udp.maxdgram "
263 "sysctl limits it to %ld bytes.\n", size, maxdgram);
265 /* No need to return */
268 asprintf(&options[OPT_BLKSIZE2].o_reply, "%d", size);
271 if (debug&DEBUG_OPTIONS)
272 tftp_log(LOG_DEBUG, "Setting blksize2 to '%s'",
273 options[OPT_BLKSIZE2].o_reply);
279 * Append the available options to the header
282 make_options(int peer __unused, char *buffer, uint16_t size) {
287 uint16_t returnsize = 0;
289 if (!options_rfc_enabled) return (0);
291 for (i = 0; options[i].o_type != NULL; i++) {
292 if (options[i].rfc == 0 && !options_extra_enabled)
295 option = options[i].o_type;
296 if (acting_as_client)
297 value = options[i].o_request;
299 value = options[i].o_reply;
303 length = strlen(value) + strlen(option) + 2;
304 if (size <= length) {
306 "Running out of option space for "
307 "option '%s' with value '%s': "
308 "needed %d bytes, got %d bytes",
309 option, value, size, length);
313 sprintf(buffer, "%s%c%s%c", option, '\000', value, '\000');
316 returnsize += length;
323 * Parse the received options in the header
326 parse_options(int peer, char *buffer, uint16_t size)
328 int i, options_failed;
329 char *c, *cp, *option, *value;
331 if (!options_rfc_enabled) return (0);
333 /* Parse the options */
338 i = get_field(peer, cp, size);
342 i = get_field(peer, cp, size);
345 /* We are at the end */
346 if (*option == '\0') break;
348 if (debug&DEBUG_OPTIONS)
350 "option: '%s' value: '%s'", option, value);
352 for (c = option; *c; c++)
355 for (i = 0; options[i].o_type != NULL; i++) {
356 if (strcmp(option, options[i].o_type) == 0) {
357 if (!acting_as_client)
358 options[i].o_request = value;
359 if (!options_extra_enabled && !options[i].rfc) {
361 "Option '%s' with value '%s' found "
362 "but it is not an RFC option",
366 if (options[i].o_handler)
368 (options[i].o_handler)(peer);
372 if (options[i].o_type == NULL)
373 tftp_log(LOG_WARNING,
374 "Unknown option: '%s'", option);
376 size -= strlen(option) + strlen(value) + 2;
379 return (options_failed);
383 * Set some default values in the options
389 options[OPT_ROLLOVER].o_request = strdup("0");