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>
65 static int tftp_open(const char *path, struct open_file *f);
66 static int tftp_close(struct open_file *f);
67 static int tftp_parse_oack(struct tftp_handle *h, char *buf, size_t len);
68 static int tftp_read(struct open_file *f, void *buf, size_t size, size_t *resid);
69 static int tftp_write(struct open_file *f, void *buf, size_t size, size_t *resid);
70 static off_t tftp_seek(struct open_file *f, off_t offset, int where);
71 static int tftp_set_blksize(struct tftp_handle *h, const char *str);
72 static int tftp_stat(struct open_file *f, struct stat *sb);
73 static ssize_t sendrecv_tftp(struct tftp_handle *h,
74 ssize_t (*sproc)(struct iodesc *, void *, size_t),
75 void *sbuf, size_t ssize,
76 ssize_t (*rproc)(struct tftp_handle *h, void *, ssize_t, time_t, unsigned short *),
77 void *rbuf, size_t rsize, unsigned short *rtype);
79 struct fs_ops tftp_fsops = {
90 extern struct in_addr servip;
92 static int tftpport = 2000;
93 static int is_open = 0;
96 * The legacy TFTP_BLKSIZE value was SEGSIZE(512).
97 * TFTP_REQUESTED_BLKSIZE of 1428 is (Ethernet MTU, less the TFTP, UDP and
100 #define TFTP_REQUESTED_BLKSIZE 1428
103 * Choose a blksize big enough so we can test with Ethernet
104 * Jumbo frames in the future.
106 #define TFTP_MAX_BLKSIZE 9008
109 struct iodesc *iodesc;
110 int currblock; /* contents of lastdata */
111 int islastblock; /* flag */
114 char *path; /* saved for re-requests */
115 unsigned int tftp_blksize;
116 unsigned long tftp_tsize;
118 u_char header[HEADER_SIZE];
120 u_char space[TFTP_MAX_BLKSIZE];
121 } __packed __aligned(4) lastdata;
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 tftp_handle *h, void *pkt, ssize_t len, time_t tleft,
185 unsigned short *rtype)
187 struct iodesc *d = h->iodesc;
192 len = readudp(d, pkt, len, tleft);
197 t = (struct tftphdr *) pkt;
198 *rtype = ntohs(t->th_opcode);
199 switch (ntohs(t->th_opcode)) {
203 if (htons(t->th_block) != d->xid) {
211 * First data packet from new port.
214 uh = (struct udphdr *) pkt - 1;
215 d->destport = uh->uh_sport;
216 } /* else check uh_sport has not changed??? */
217 got = len - (t->th_data - (char *) t);
221 if ((unsigned) ntohs(t->th_code) > TFTP_MAX_ERRCODE) {
222 printf("illegal tftp error %d\n", ntohs(t->th_code));
226 printf("tftp-error %d\n", ntohs(t->th_code));
228 errno = tftperrors[ntohs(t->th_code)];
236 * Unexpected OACK. TFTP transfer already in progress.
244 * Remember which port this OACK came from, because we need
245 * to send the ACK or errors back to it.
247 uh = (struct udphdr *) pkt - 1;
248 d->destport = uh->uh_sport;
250 /* Parse options ACK-ed by the server. */
251 tftp_oack_len = len - sizeof(t->th_opcode);
252 if (tftp_parse_oack(h, t->th_u.tu_stuff, tftp_oack_len) != 0) {
253 tftp_senderr(h, EOPTNEG, "Malformed OACK");
261 printf("tftp type %d not handled\n", ntohs(t->th_opcode));
267 /* send request, expect first block (or error) */
269 tftp_makereq(struct tftp_handle *h)
272 u_char header[HEADER_SIZE];
274 u_char space[FNAME_SIZE + 6];
275 } __packed __aligned(4) wbuf;
280 char *tftp_blksize = NULL;
282 unsigned short rtype = 0;
285 * Allow overriding default TFTP block size by setting
286 * a tftp.blksize environment variable.
288 if ((tftp_blksize = getenv("tftp.blksize")) != NULL) {
289 tftp_set_blksize(h, tftp_blksize);
292 wbuf.t.th_opcode = htons((u_short) RRQ);
293 wtail = wbuf.t.th_stuff;
295 #ifdef TFTP_PREPEND_PATH
296 if (l > FNAME_SIZE - (sizeof(TFTP_PREPEND_PATH) - 1))
297 return (ENAMETOOLONG);
298 bcopy(TFTP_PREPEND_PATH, wtail, sizeof(TFTP_PREPEND_PATH) - 1);
299 wtail += sizeof(TFTP_PREPEND_PATH) - 1;
302 return (ENAMETOOLONG);
304 bcopy(h->path, wtail, l + 1);
306 bcopy("octet", wtail, 6);
308 bcopy("blksize", wtail, 8);
310 blksize_l = sprintf(wtail, "%d", h->tftp_blksize);
311 wtail += blksize_l + 1;
312 bcopy("tsize", wtail, 6);
314 bcopy("0", wtail, 2);
319 /* h->iodesc->myport = htons(--tftpport); */
320 h->iodesc->myport = htons(tftpport + (getsecs() & 0x3ff));
321 h->iodesc->destport = htons(IPPORT_TFTP);
322 h->iodesc->xid = 1; /* expected block */
328 res = sendrecv_tftp(h, &sendudp, &wbuf.t, wtail - (char *) &wbuf.t,
329 &recvtftp, t, sizeof(*t) + h->tftp_blksize, &rtype);
332 return (tftp_getnextblock(h));
334 /* Server ignored our blksize request, revert to TFTP default. */
335 h->tftp_blksize = SEGSIZE;
342 if (res < h->tftp_blksize) {
343 h->islastblock = 1; /* very short file */
355 /* ack block, expect next */
357 tftp_getnextblock(struct tftp_handle *h)
360 u_char header[HEADER_SIZE];
362 } __packed __aligned(4) wbuf;
366 unsigned short rtype = 0;
367 wbuf.t.th_opcode = htons((u_short) ACK);
368 wtail = (char *) &wbuf.t.th_block;
369 wbuf.t.th_block = htons((u_short) h->currblock);
374 h->iodesc->xid = h->currblock + 1; /* expected block */
376 res = sendrecv_tftp(h, &sendudp, &wbuf.t, wtail - (char *) &wbuf.t,
377 &recvtftp, t, sizeof(*t) + h->tftp_blksize, &rtype);
379 if (res == -1) /* 0 is OK! */
384 if (res < h->tftp_blksize)
385 h->islastblock = 1; /* EOF */
387 if (h->islastblock == 1) {
388 /* Send an ACK for the last block */
389 wbuf.t.th_block = htons((u_short) h->currblock);
390 sendudp(h->iodesc, &wbuf.t, wtail - (char *)&wbuf.t);
397 tftp_open(const char *path, struct open_file *f)
399 struct tftp_handle *tftpfile;
403 const char *extraslash;
405 if (strcmp(f->f_dev->dv_name, "net") != 0) {
407 if (strcmp(f->f_dev->dv_name, "pxe") != 0)
417 tftpfile = (struct tftp_handle *) malloc(sizeof(*tftpfile));
421 memset(tftpfile, 0, sizeof(*tftpfile));
422 tftpfile->tftp_blksize = TFTP_REQUESTED_BLKSIZE;
423 tftpfile->iodesc = io = socktodesc(*(int *) (f->f_devdata));
429 pathsize = (strlen(rootpath) + 1 + strlen(path) + 1) * sizeof(char);
430 tftpfile->path = malloc(pathsize);
431 if (tftpfile->path == NULL) {
435 if (rootpath[strlen(rootpath) - 1] == '/' || path[0] == '/')
439 res = snprintf(tftpfile->path, pathsize, "%s%s%s",
440 rootpath, extraslash, path);
441 if (res < 0 || res > pathsize) {
442 free(tftpfile->path);
447 res = tftp_makereq(tftpfile);
450 free(tftpfile->path);
454 f->f_fsdata = (void *) tftpfile;
460 tftp_read(struct open_file *f, void *addr, size_t size,
461 size_t *resid /* out */)
463 struct tftp_handle *tftpfile;
464 tftpfile = (struct tftp_handle *) f->f_fsdata;
467 int needblock, count;
471 needblock = tftpfile->off / tftpfile->tftp_blksize + 1;
473 if (tftpfile->currblock > needblock) { /* seek backwards */
474 tftp_senderr(tftpfile, 0, "No error: read aborted");
475 tftp_makereq(tftpfile); /* no error check, it worked
479 while (tftpfile->currblock < needblock) {
482 res = tftp_getnextblock(tftpfile);
483 if (res) { /* no answer */
485 printf("tftp: read error\n");
489 if (tftpfile->islastblock)
493 if (tftpfile->currblock == needblock) {
494 int offinblock, inbuffer;
496 offinblock = tftpfile->off % tftpfile->tftp_blksize;
498 inbuffer = tftpfile->validsize - offinblock;
501 printf("tftp: invalid offset %d\n",
506 count = (size < inbuffer ? size : inbuffer);
507 bcopy(tftpfile->lastdata.t.th_data + offinblock,
510 addr = (char *)addr + count;
511 tftpfile->off += count;
514 if ((tftpfile->islastblock) && (count == inbuffer))
518 printf("tftp: block %d not found\n", needblock);
531 tftp_close(struct open_file *f)
533 struct tftp_handle *tftpfile;
534 tftpfile = (struct tftp_handle *) f->f_fsdata;
536 /* let it time out ... */
539 free(tftpfile->path);
547 tftp_write(struct open_file *f __unused, void *start __unused, size_t size __unused,
548 size_t *resid __unused /* out */)
554 tftp_stat(struct open_file *f, struct stat *sb)
556 struct tftp_handle *tftpfile;
557 tftpfile = (struct tftp_handle *) f->f_fsdata;
559 sb->st_mode = 0444 | S_IFREG;
568 tftp_seek(struct open_file *f, off_t offset, int where)
570 struct tftp_handle *tftpfile;
571 tftpfile = (struct tftp_handle *) f->f_fsdata;
575 tftpfile->off = offset;
578 tftpfile->off += offset;
584 return (tftpfile->off);
588 sendrecv_tftp(struct tftp_handle *h,
589 ssize_t (*sproc)(struct iodesc *, void *, size_t),
590 void *sbuf, size_t ssize,
591 ssize_t (*rproc)(struct tftp_handle *, void *, ssize_t, time_t, unsigned short *),
592 void *rbuf, size_t rsize, unsigned short *rtype)
594 struct iodesc *d = h->iodesc;
600 printf("sendrecv: called\n");
606 if ((getsecs() - t) > MAXTMO) {
611 cc = (*sproc)(d, sbuf, ssize);
612 if (cc != -1 && cc < ssize)
613 panic("sendrecv: short write! (%zd < %zu)",
617 /* Error on transmit; wait before retrying */
618 while ((getsecs() - t1) < tleft);
623 /* Try to get a packet and process it. */
624 cc = (*rproc)(h, rbuf, rsize, tleft, rtype);
625 /* Return on data, EOF or real error. */
626 if (cc != -1 || errno != 0)
628 if ((getsecs() - t1) < tleft) {
632 /* Timed out or didn't get the packet we're waiting for */
634 if (tleft > (2 * MINTMO)) {
635 tleft = (2 * MINTMO);
642 tftp_set_blksize(struct tftp_handle *h, const char *str)
648 if (h == NULL || str == NULL)
652 (unsigned int)strtol(str, &endptr, 0);
655 * Only accept blksize value if it is numeric.
656 * RFC2348 specifies that acceptable values are 8-65464.
657 * Let's choose a limit less than MAXRSPACE.
659 if (*endptr == '\0' && new_blksize >= 8
660 && new_blksize <= TFTP_MAX_BLKSIZE) {
661 h->tftp_blksize = new_blksize;
669 * In RFC2347, the TFTP Option Acknowledgement package (OACK)
670 * is used to acknowledge a client's option negotiation request.
671 * The format of an OACK packet is:
672 * +-------+---~~---+---+---~~---+---+---~~---+---+---~~---+---+
673 * | opc | opt1 | 0 | value1 | 0 | optN | 0 | valueN | 0 |
674 * +-------+---~~---+---+---~~---+---+---~~---+---+---~~---+---+
677 * The opcode field contains a 6, for Option Acknowledgment.
680 * The first option acknowledgment, copied from the original
684 * The acknowledged value associated with the first option. If
685 * and how this value may differ from the original request is
686 * detailed in the specification for the option.
689 * The final option/value acknowledgment pair.
692 tftp_parse_oack(struct tftp_handle *h, char *buf, size_t len)
695 * We parse the OACK strings into an array
696 * of name-value pairs.
698 char *tftp_options[128] = { 0 };
702 int blksize_is_set = 0;
705 unsigned int orig_blksize;
707 while (option_idx < 128 && i < len) {
708 if (buf[i] == '\0') {
710 tftp_options[option_idx] = val;
718 /* Save the block size we requested for sanity check later. */
719 orig_blksize = h->tftp_blksize;
722 * Parse individual TFTP options.
723 * * "blksize" is specified in RFC2348.
724 * * "tsize" is specified in RFC2349.
726 for (i = 0; i < option_idx; i += 2) {
727 if (strcasecmp(tftp_options[i], "blksize") == 0) {
728 if (i + 1 < option_idx)
730 tftp_set_blksize(h, tftp_options[i + 1]);
731 } else if (strcasecmp(tftp_options[i], "tsize") == 0) {
732 if (i + 1 < option_idx)
733 tsize = strtol(tftp_options[i + 1], (char **)NULL, 10);
735 /* Do not allow any options we did not expect to be ACKed. */
736 printf("unexpected tftp option '%s'\n", tftp_options[i]);
741 if (!blksize_is_set) {
743 * If TFTP blksize was not set, try defaulting
744 * to the legacy TFTP blksize of SEGSIZE(512)
746 h->tftp_blksize = SEGSIZE;
747 } else if (h->tftp_blksize > orig_blksize) {
749 * Server should not be proposing block sizes that
750 * exceed what we said we can handle.
752 printf("unexpected blksize %u\n", h->tftp_blksize);
757 printf("tftp_blksize: %u\n", h->tftp_blksize);
758 printf("tftp_tsize: %lu\n", h->tftp_tsize);