1 /* $NetBSD: tftp.c,v 1.4 1997/09/17 16:57:07 drochner Exp $ */
5 * Matthias Drochner. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. All advertising materials mentioning features or use of this software
16 * must display the following acknowledgement:
17 * This product includes software developed for the NetBSD Project
18 * by Matthias Drochner.
19 * 4. The name of the author may not be used to endorse or promote products
20 * derived from this software without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
27 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
31 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 #include <sys/cdefs.h>
35 __FBSDID("$FreeBSD$");
38 * Simple TFTP implementation for libsa.
40 * - socket descriptor (int) at open_file->f_devdata
41 * - server host IP in global servip
44 * - lseek only with SEEK_SET or SEEK_CUR
45 * - no big time differences between transfers (<tftp timeout)
48 #include <sys/types.h>
50 #include <netinet/in.h>
51 #include <netinet/udp.h>
52 #include <netinet/in_systm.h>
53 #include <arpa/tftp.h>
64 struct tftprecv_extra;
66 static ssize_t recvtftp(struct iodesc *d, void **pkt, void **payload,
67 time_t tleft, void *recv_extra);
68 static int tftp_open(const char *path, struct open_file *f);
69 static int tftp_close(struct open_file *f);
70 static int tftp_parse_oack(struct tftp_handle *h, char *buf, size_t len);
71 static int tftp_read(struct open_file *f, void *buf, size_t size, size_t *resid);
72 static int tftp_write(struct open_file *f, void *buf, size_t size, size_t *resid);
73 static off_t tftp_seek(struct open_file *f, off_t offset, int where);
74 static int tftp_set_blksize(struct tftp_handle *h, const char *str);
75 static int tftp_stat(struct open_file *f, struct stat *sb);
77 struct fs_ops tftp_fsops = {
88 extern struct in_addr servip;
90 static int tftpport = 2000;
91 static int is_open = 0;
94 * The legacy TFTP_BLKSIZE value was SEGSIZE(512).
95 * TFTP_REQUESTED_BLKSIZE of 1428 is (Ethernet MTU, less the TFTP, UDP and
98 #define TFTP_REQUESTED_BLKSIZE 1428
101 * Choose a blksize big enough so we can test with Ethernet
102 * Jumbo frames in the future.
104 #define TFTP_MAX_BLKSIZE 9008
107 struct iodesc *iodesc;
108 int currblock; /* contents of lastdata */
109 int islastblock; /* flag */
112 char *path; /* saved for re-requests */
113 unsigned int tftp_blksize;
114 unsigned long tftp_tsize;
116 struct tftphdr *tftp_hdr;
119 struct tftprecv_extra {
120 struct tftp_handle *tftp_handle;
121 unsigned short rtype; /* Received type */
124 #define TFTP_MAX_ERRCODE EOPTNEG
125 static const int tftperrors[TFTP_MAX_ERRCODE + 1] = {
134 EINVAL, /* Option negotiation failed. */
137 static int tftp_getnextblock(struct tftp_handle *h);
139 /* send error message back. */
141 tftp_senderr(struct tftp_handle *h, u_short errcode, const char *msg)
144 u_char header[HEADER_SIZE];
146 u_char space[63]; /* +1 from t */
147 } __packed __aligned(4) wbuf;
152 if (len > sizeof(wbuf.space))
153 len = sizeof(wbuf.space);
155 wbuf.t.th_opcode = htons((u_short) ERROR);
156 wbuf.t.th_code = htons(errcode);
158 wtail = wbuf.t.th_msg;
159 bcopy(msg, wtail, len);
163 sendudp(h->iodesc, &wbuf.t, wtail - (char *) &wbuf.t);
167 tftp_sendack(struct tftp_handle *h)
170 u_char header[HEADER_SIZE];
172 } __packed __aligned(4) wbuf;
175 wbuf.t.th_opcode = htons((u_short) ACK);
176 wtail = (char *) &wbuf.t.th_block;
177 wbuf.t.th_block = htons((u_short) h->currblock);
180 sendudp(h->iodesc, &wbuf.t, wtail - (char *) &wbuf.t);
184 recvtftp(struct iodesc *d, void **pkt, void **payload, time_t tleft,
187 struct tftprecv_extra *extra;
188 struct tftp_handle *h;
190 unsigned short *rtype;
195 extra = (struct tftprecv_extra *)recv_extra;
196 h = extra->tftp_handle;
198 len = readudp(d, &ptr, (void **)&t, tleft);
205 extra->rtype = ntohs(t->th_opcode);
206 switch (ntohs(t->th_opcode)) {
210 if (htons(t->th_block) != (u_short) d->xid) {
219 * First data packet from new port.
222 uh = (struct udphdr *) t - 1;
223 d->destport = uh->uh_sport;
224 } /* else check uh_sport has not changed??? */
225 got = len - (t->th_data - (char *)t);
231 if ((unsigned) ntohs(t->th_code) > TFTP_MAX_ERRCODE) {
232 printf("illegal tftp error %d\n", ntohs(t->th_code));
236 printf("tftp-error %d\n", ntohs(t->th_code));
238 errno = tftperrors[ntohs(t->th_code)];
247 * Unexpected OACK. TFTP transfer already in progress.
256 * Remember which port this OACK came from, because we need
257 * to send the ACK or errors back to it.
259 uh = (struct udphdr *) t - 1;
260 d->destport = uh->uh_sport;
262 /* Parse options ACK-ed by the server. */
263 tftp_oack_len = len - sizeof(t->th_opcode);
264 if (tftp_parse_oack(h, t->th_u.tu_stuff, tftp_oack_len) != 0) {
265 tftp_senderr(h, EOPTNEG, "Malformed OACK");
276 printf("tftp type %d not handled\n", ntohs(t->th_opcode));
283 /* send request, expect first block (or error) */
285 tftp_makereq(struct tftp_handle *h)
288 u_char header[HEADER_SIZE];
290 u_char space[FNAME_SIZE + 6];
291 } __packed __aligned(4) wbuf;
292 struct tftprecv_extra recv_extra;
298 char *tftp_blksize = NULL;
302 * Allow overriding default TFTP block size by setting
303 * a tftp.blksize environment variable.
305 if ((tftp_blksize = getenv("tftp.blksize")) != NULL) {
306 tftp_set_blksize(h, tftp_blksize);
309 wbuf.t.th_opcode = htons((u_short) RRQ);
310 wtail = wbuf.t.th_stuff;
312 #ifdef TFTP_PREPEND_PATH
313 if (l > FNAME_SIZE - (sizeof(TFTP_PREPEND_PATH) - 1))
314 return (ENAMETOOLONG);
315 bcopy(TFTP_PREPEND_PATH, wtail, sizeof(TFTP_PREPEND_PATH) - 1);
316 wtail += sizeof(TFTP_PREPEND_PATH) - 1;
319 return (ENAMETOOLONG);
321 bcopy(h->path, wtail, l + 1);
323 bcopy("octet", wtail, 6);
325 bcopy("blksize", wtail, 8);
327 blksize_l = sprintf(wtail, "%d", h->tftp_blksize);
328 wtail += blksize_l + 1;
329 bcopy("tsize", wtail, 6);
331 bcopy("0", wtail, 2);
334 /* h->iodesc->myport = htons(--tftpport); */
335 h->iodesc->myport = htons(tftpport + (getsecs() & 0x3ff));
336 h->iodesc->destport = htons(IPPORT_TFTP);
337 h->iodesc->xid = 1; /* expected block */
344 recv_extra.tftp_handle = h;
345 res = sendrecv(h->iodesc, &sendudp, &wbuf.t, wtail - (char *) &wbuf.t,
346 (void *)&recvtftp, &pkt, (void **)&t, &recv_extra);
356 if (recv_extra.rtype == OACK)
357 return (tftp_getnextblock(h));
359 /* Server ignored our blksize request, revert to TFTP default. */
360 h->tftp_blksize = SEGSIZE;
362 switch (recv_extra.rtype) {
367 if (res < h->tftp_blksize) {
368 h->islastblock = 1; /* very short file */
380 /* ack block, expect next */
382 tftp_getnextblock(struct tftp_handle *h)
385 u_char header[HEADER_SIZE];
387 } __packed __aligned(4) wbuf;
388 struct tftprecv_extra recv_extra;
393 wbuf.t.th_opcode = htons((u_short) ACK);
394 wtail = (char *) &wbuf.t.th_block;
395 wbuf.t.th_block = htons((u_short) h->currblock);
398 h->iodesc->xid = h->currblock + 1; /* expected block */
401 recv_extra.tftp_handle = h;
402 res = sendrecv(h->iodesc, &sendudp, &wbuf.t, wtail - (char *) &wbuf.t,
403 (void *)&recvtftp, &pkt, (void **)&t, &recv_extra);
405 if (res == -1) { /* 0 is OK! */
415 if (res < h->tftp_blksize)
416 h->islastblock = 1; /* EOF */
418 if (h->islastblock == 1) {
419 /* Send an ACK for the last block */
420 wbuf.t.th_block = htons((u_short) h->currblock);
421 sendudp(h->iodesc, &wbuf.t, wtail - (char *)&wbuf.t);
428 tftp_open(const char *path, struct open_file *f)
430 struct tftp_handle *tftpfile;
434 const char *extraslash;
436 if (netproto != NET_TFTP)
439 if (f->f_dev->dv_type != DEVT_NET)
445 tftpfile = (struct tftp_handle *) malloc(sizeof(*tftpfile));
449 memset(tftpfile, 0, sizeof(*tftpfile));
450 tftpfile->tftp_blksize = TFTP_REQUESTED_BLKSIZE;
451 tftpfile->iodesc = io = socktodesc(*(int *) (f->f_devdata));
457 pathsize = (strlen(rootpath) + 1 + strlen(path) + 1) * sizeof(char);
458 tftpfile->path = malloc(pathsize);
459 if (tftpfile->path == NULL) {
463 if (rootpath[strlen(rootpath) - 1] == '/' || path[0] == '/')
467 res = snprintf(tftpfile->path, pathsize, "%s%s%s",
468 rootpath, extraslash, path);
469 if (res < 0 || res > pathsize) {
470 free(tftpfile->path);
475 res = tftp_makereq(tftpfile);
478 free(tftpfile->path);
483 f->f_fsdata = (void *) tftpfile;
489 tftp_read(struct open_file *f, void *addr, size_t size,
490 size_t *resid /* out */)
492 struct tftp_handle *tftpfile;
493 tftpfile = (struct tftp_handle *) f->f_fsdata;
496 int needblock, count;
500 needblock = tftpfile->off / tftpfile->tftp_blksize + 1;
502 if (tftpfile->currblock > needblock) { /* seek backwards */
503 tftp_senderr(tftpfile, 0, "No error: read aborted");
504 tftp_makereq(tftpfile); /* no error check, it worked
508 while (tftpfile->currblock < needblock) {
511 res = tftp_getnextblock(tftpfile);
512 if (res) { /* no answer */
514 printf("tftp: read error\n");
518 if (tftpfile->islastblock)
522 if (tftpfile->currblock == needblock) {
523 int offinblock, inbuffer;
525 offinblock = tftpfile->off % tftpfile->tftp_blksize;
527 inbuffer = tftpfile->validsize - offinblock;
530 printf("tftp: invalid offset %d\n",
535 count = (size < inbuffer ? size : inbuffer);
536 bcopy(tftpfile->tftp_hdr->th_data + offinblock,
539 addr = (char *)addr + count;
540 tftpfile->off += count;
543 if ((tftpfile->islastblock) && (count == inbuffer))
547 printf("tftp: block %d not found\n", needblock);
560 tftp_close(struct open_file *f)
562 struct tftp_handle *tftpfile;
563 tftpfile = (struct tftp_handle *) f->f_fsdata;
565 /* let it time out ... */
568 free(tftpfile->path);
577 tftp_write(struct open_file *f __unused, void *start __unused, size_t size __unused,
578 size_t *resid __unused /* out */)
584 tftp_stat(struct open_file *f, struct stat *sb)
586 struct tftp_handle *tftpfile;
587 tftpfile = (struct tftp_handle *) f->f_fsdata;
589 sb->st_mode = 0444 | S_IFREG;
593 sb->st_size = (off_t) tftpfile->tftp_tsize;
598 tftp_seek(struct open_file *f, off_t offset, int where)
600 struct tftp_handle *tftpfile;
601 tftpfile = (struct tftp_handle *) f->f_fsdata;
605 tftpfile->off = offset;
608 tftpfile->off += offset;
614 return (tftpfile->off);
618 tftp_set_blksize(struct tftp_handle *h, const char *str)
624 if (h == NULL || str == NULL)
628 (unsigned int)strtol(str, &endptr, 0);
631 * Only accept blksize value if it is numeric.
632 * RFC2348 specifies that acceptable values are 8-65464.
633 * Let's choose a limit less than MAXRSPACE.
635 if (*endptr == '\0' && new_blksize >= 8
636 && new_blksize <= TFTP_MAX_BLKSIZE) {
637 h->tftp_blksize = new_blksize;
645 * In RFC2347, the TFTP Option Acknowledgement package (OACK)
646 * is used to acknowledge a client's option negotiation request.
647 * The format of an OACK packet is:
648 * +-------+---~~---+---+---~~---+---+---~~---+---+---~~---+---+
649 * | opc | opt1 | 0 | value1 | 0 | optN | 0 | valueN | 0 |
650 * +-------+---~~---+---+---~~---+---+---~~---+---+---~~---+---+
653 * The opcode field contains a 6, for Option Acknowledgment.
656 * The first option acknowledgment, copied from the original
660 * The acknowledged value associated with the first option. If
661 * and how this value may differ from the original request is
662 * detailed in the specification for the option.
665 * The final option/value acknowledgment pair.
668 tftp_parse_oack(struct tftp_handle *h, char *buf, size_t len)
671 * We parse the OACK strings into an array
672 * of name-value pairs.
674 char *tftp_options[128] = { 0 };
678 int blksize_is_set = 0;
681 unsigned int orig_blksize;
683 while (option_idx < 128 && i < len) {
684 if (buf[i] == '\0') {
686 tftp_options[option_idx] = val;
694 /* Save the block size we requested for sanity check later. */
695 orig_blksize = h->tftp_blksize;
698 * Parse individual TFTP options.
699 * * "blksize" is specified in RFC2348.
700 * * "tsize" is specified in RFC2349.
702 for (i = 0; i < option_idx; i += 2) {
703 if (strcasecmp(tftp_options[i], "blksize") == 0) {
704 if (i + 1 < option_idx)
706 tftp_set_blksize(h, tftp_options[i + 1]);
707 } else if (strcasecmp(tftp_options[i], "tsize") == 0) {
708 if (i + 1 < option_idx)
709 tsize = strtol(tftp_options[i + 1], (char **)NULL, 10);
711 h->tftp_tsize = tsize;
713 /* Do not allow any options we did not expect to be ACKed. */
714 printf("unexpected tftp option '%s'\n", tftp_options[i]);
719 if (!blksize_is_set) {
721 * If TFTP blksize was not set, try defaulting
722 * to the legacy TFTP blksize of SEGSIZE(512)
724 h->tftp_blksize = SEGSIZE;
725 } else if (h->tftp_blksize > orig_blksize) {
727 * Server should not be proposing block sizes that
728 * exceed what we said we can handle.
730 printf("unexpected blksize %u\n", h->tftp_blksize);
735 printf("tftp_blksize: %u\n", h->tftp_blksize);
736 printf("tftp_tsize: %lu\n", h->tftp_tsize);