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>
37 * Simple TFTP implementation for libsa.
39 * - socket descriptor (int) at open_file->f_devdata
40 * - server host IP in global servip
43 * - lseek only with SEEK_SET or SEEK_CUR
44 * - no big time differences between transfers (<tftp timeout)
47 #include <sys/types.h>
49 #include <netinet/in.h>
50 #include <netinet/udp.h>
51 #include <netinet/in_systm.h>
52 #include <arpa/tftp.h>
64 static int tftp_open(const char *path
, struct open_file
*f
);
65 static int tftp_close(struct open_file
*f
);
66 static int tftp_parse_oack(struct tftp_handle
*h
, char *buf
, size_t len
);
67 static int tftp_read(struct open_file
*f
, void *buf
, size_t size
, size_t *resid
);
68 static int tftp_write(struct open_file
*f
, void *buf
, size_t size
, size_t *resid
);
69 static off_t
tftp_seek(struct open_file
*f
, off_t offset
, int where
);
70 static int tftp_set_blksize(struct tftp_handle
*h
, const char *str
);
71 static int tftp_stat(struct open_file
*f
, struct stat
*sb
);
72 static ssize_t
sendrecv_tftp(struct tftp_handle
*h
,
73 ssize_t (*sproc
)(struct iodesc
*, void *, size_t),
74 void *sbuf
, size_t ssize
,
75 ssize_t (*rproc
)(struct tftp_handle
*h
, void **, void **, time_t, unsigned short *),
76 void **, void **, unsigned short *rtype
);
78 struct fs_ops tftp_fsops
= {
89 extern struct in_addr servip
;
91 static int tftpport
= 2000;
92 static int is_open
= 0;
95 * The legacy TFTP_BLKSIZE value was SEGSIZE(512).
96 * TFTP_REQUESTED_BLKSIZE of 1428 is (Ethernet MTU, less the TFTP, UDP and
99 #define TFTP_REQUESTED_BLKSIZE 1428
102 * Choose a blksize big enough so we can test with Ethernet
103 * Jumbo frames in the future.
105 #define TFTP_MAX_BLKSIZE 9008
108 struct iodesc
*iodesc
;
109 int currblock
; /* contents of lastdata */
110 int islastblock
; /* flag */
113 char *path
; /* saved for re-requests */
114 unsigned int tftp_blksize
;
115 unsigned long tftp_tsize
;
117 struct tftphdr
*tftp_hdr
;
120 #define TFTP_MAX_ERRCODE EOPTNEG
121 static const int tftperrors
[TFTP_MAX_ERRCODE
+ 1] = {
130 EINVAL
, /* Option negotiation failed. */
133 static int tftp_getnextblock(struct tftp_handle
*h
);
135 /* send error message back. */
137 tftp_senderr(struct tftp_handle
*h
, u_short errcode
, const char *msg
)
140 u_char header
[HEADER_SIZE
];
142 u_char space
[63]; /* +1 from t */
143 } __packed
__aligned(4) wbuf
;
148 if (len
> sizeof(wbuf
.space
))
149 len
= sizeof(wbuf
.space
);
151 wbuf
.t
.th_opcode
= htons((u_short
) ERROR
);
152 wbuf
.t
.th_code
= htons(errcode
);
154 wtail
= wbuf
.t
.th_msg
;
155 bcopy(msg
, wtail
, len
);
159 sendudp(h
->iodesc
, &wbuf
.t
, wtail
- (char *) &wbuf
.t
);
163 tftp_sendack(struct tftp_handle
*h
)
166 u_char header
[HEADER_SIZE
];
168 } __packed
__aligned(4) wbuf
;
171 wbuf
.t
.th_opcode
= htons((u_short
) ACK
);
172 wtail
= (char *) &wbuf
.t
.th_block
;
173 wbuf
.t
.th_block
= htons((u_short
) h
->currblock
);
176 sendudp(h
->iodesc
, &wbuf
.t
, wtail
- (char *) &wbuf
.t
);
180 recvtftp(struct tftp_handle
*h
, void **pkt
, void **payload
, time_t tleft
,
181 unsigned short *rtype
)
183 struct iodesc
*d
= h
->iodesc
;
190 len
= readudp(d
, &ptr
, (void **)&t
, tleft
);
197 *rtype
= ntohs(t
->th_opcode
);
198 switch (ntohs(t
->th_opcode
)) {
202 if (htons(t
->th_block
) != (u_short
) d
->xid
) {
211 * First data packet from new port.
214 uh
= (struct udphdr
*) t
- 1;
215 d
->destport
= uh
->uh_sport
;
216 } /* else check uh_sport has not changed??? */
217 got
= len
- (t
->th_data
- (char *)t
);
223 if ((unsigned) ntohs(t
->th_code
) > TFTP_MAX_ERRCODE
) {
224 printf("illegal tftp error %d\n", ntohs(t
->th_code
));
228 printf("tftp-error %d\n", ntohs(t
->th_code
));
230 errno
= tftperrors
[ntohs(t
->th_code
)];
239 * Unexpected OACK. TFTP transfer already in progress.
248 * Remember which port this OACK came from, because we need
249 * to send the ACK or errors back to it.
251 uh
= (struct udphdr
*) t
- 1;
252 d
->destport
= uh
->uh_sport
;
254 /* Parse options ACK-ed by the server. */
255 tftp_oack_len
= len
- sizeof(t
->th_opcode
);
256 if (tftp_parse_oack(h
, t
->th_u
.tu_stuff
, tftp_oack_len
) != 0) {
257 tftp_senderr(h
, EOPTNEG
, "Malformed OACK");
268 printf("tftp type %d not handled\n", ntohs(t
->th_opcode
));
275 /* send request, expect first block (or error) */
277 tftp_makereq(struct tftp_handle
*h
)
280 u_char header
[HEADER_SIZE
];
282 u_char space
[FNAME_SIZE
+ 6];
283 } __packed
__aligned(4) wbuf
;
289 char *tftp_blksize
= NULL
;
291 unsigned short rtype
= 0;
294 * Allow overriding default TFTP block size by setting
295 * a tftp.blksize environment variable.
297 if ((tftp_blksize
= getenv("tftp.blksize")) != NULL
) {
298 tftp_set_blksize(h
, tftp_blksize
);
301 wbuf
.t
.th_opcode
= htons((u_short
) RRQ
);
302 wtail
= wbuf
.t
.th_stuff
;
304 #ifdef TFTP_PREPEND_PATH
305 if (l
> FNAME_SIZE
- (sizeof(TFTP_PREPEND_PATH
) - 1))
306 return (ENAMETOOLONG
);
307 bcopy(TFTP_PREPEND_PATH
, wtail
, sizeof(TFTP_PREPEND_PATH
) - 1);
308 wtail
+= sizeof(TFTP_PREPEND_PATH
) - 1;
311 return (ENAMETOOLONG
);
313 bcopy(h
->path
, wtail
, l
+ 1);
315 bcopy("octet", wtail
, 6);
317 bcopy("blksize", wtail
, 8);
319 blksize_l
= sprintf(wtail
, "%d", h
->tftp_blksize
);
320 wtail
+= blksize_l
+ 1;
321 bcopy("tsize", wtail
, 6);
323 bcopy("0", wtail
, 2);
326 /* h->iodesc->myport = htons(--tftpport); */
327 h
->iodesc
->myport
= htons(tftpport
+ (getsecs() & 0x3ff));
328 h
->iodesc
->destport
= htons(IPPORT_TFTP
);
329 h
->iodesc
->xid
= 1; /* expected block */
336 res
= sendrecv_tftp(h
, &sendudp
, &wbuf
.t
, wtail
- (char *) &wbuf
.t
,
337 &recvtftp
, &pkt
, (void **)&t
, &rtype
);
348 return (tftp_getnextblock(h
));
350 /* Server ignored our blksize request, revert to TFTP default. */
351 h
->tftp_blksize
= SEGSIZE
;
358 if (res
< h
->tftp_blksize
) {
359 h
->islastblock
= 1; /* very short file */
371 /* ack block, expect next */
373 tftp_getnextblock(struct tftp_handle
*h
)
376 u_char header
[HEADER_SIZE
];
378 } __packed
__aligned(4) wbuf
;
383 unsigned short rtype
= 0;
384 wbuf
.t
.th_opcode
= htons((u_short
) ACK
);
385 wtail
= (char *) &wbuf
.t
.th_block
;
386 wbuf
.t
.th_block
= htons((u_short
) h
->currblock
);
389 h
->iodesc
->xid
= h
->currblock
+ 1; /* expected block */
392 res
= sendrecv_tftp(h
, &sendudp
, &wbuf
.t
, wtail
- (char *) &wbuf
.t
,
393 &recvtftp
, &pkt
, (void **)&t
, &rtype
);
395 if (res
== -1) { /* 0 is OK! */
405 if (res
< h
->tftp_blksize
)
406 h
->islastblock
= 1; /* EOF */
408 if (h
->islastblock
== 1) {
409 /* Send an ACK for the last block */
410 wbuf
.t
.th_block
= htons((u_short
) h
->currblock
);
411 sendudp(h
->iodesc
, &wbuf
.t
, wtail
- (char *)&wbuf
.t
);
418 tftp_open(const char *path
, struct open_file
*f
)
420 struct tftp_handle
*tftpfile
;
424 const char *extraslash
;
426 if (netproto
!= NET_TFTP
)
429 if (f
->f_dev
->dv_type
!= DEVT_NET
)
435 tftpfile
= (struct tftp_handle
*) malloc(sizeof(*tftpfile
));
439 memset(tftpfile
, 0, sizeof(*tftpfile
));
440 tftpfile
->tftp_blksize
= TFTP_REQUESTED_BLKSIZE
;
441 tftpfile
->iodesc
= io
= socktodesc(*(int *) (f
->f_devdata
));
447 pathsize
= (strlen(rootpath
) + 1 + strlen(path
) + 1) * sizeof(char);
448 tftpfile
->path
= malloc(pathsize
);
449 if (tftpfile
->path
== NULL
) {
453 if (rootpath
[strlen(rootpath
) - 1] == '/' || path
[0] == '/')
457 res
= snprintf(tftpfile
->path
, pathsize
, "%s%s%s",
458 rootpath
, extraslash
, path
);
459 if (res
< 0 || res
> pathsize
) {
460 free(tftpfile
->path
);
465 res
= tftp_makereq(tftpfile
);
468 free(tftpfile
->path
);
473 f
->f_fsdata
= (void *) tftpfile
;
479 tftp_read(struct open_file
*f
, void *addr
, size_t size
,
480 size_t *resid
/* out */)
482 struct tftp_handle
*tftpfile
;
483 tftpfile
= (struct tftp_handle
*) f
->f_fsdata
;
486 int needblock
, count
;
490 needblock
= tftpfile
->off
/ tftpfile
->tftp_blksize
+ 1;
492 if (tftpfile
->currblock
> needblock
) { /* seek backwards */
493 tftp_senderr(tftpfile
, 0, "No error: read aborted");
494 tftp_makereq(tftpfile
); /* no error check, it worked
498 while (tftpfile
->currblock
< needblock
) {
501 res
= tftp_getnextblock(tftpfile
);
502 if (res
) { /* no answer */
504 printf("tftp: read error\n");
508 if (tftpfile
->islastblock
)
512 if (tftpfile
->currblock
== needblock
) {
513 int offinblock
, inbuffer
;
515 offinblock
= tftpfile
->off
% tftpfile
->tftp_blksize
;
517 inbuffer
= tftpfile
->validsize
- offinblock
;
520 printf("tftp: invalid offset %d\n",
525 count
= (size
< inbuffer
? size
: inbuffer
);
526 bcopy(tftpfile
->tftp_hdr
->th_data
+ offinblock
,
529 addr
= (char *)addr
+ count
;
530 tftpfile
->off
+= count
;
533 if ((tftpfile
->islastblock
) && (count
== inbuffer
))
537 printf("tftp: block %d not found\n", needblock
);
550 tftp_close(struct open_file
*f
)
552 struct tftp_handle
*tftpfile
;
553 tftpfile
= (struct tftp_handle
*) f
->f_fsdata
;
555 /* let it time out ... */
558 free(tftpfile
->path
);
567 tftp_write(struct open_file
*f __unused
, void *start __unused
, size_t size __unused
,
568 size_t *resid __unused
/* out */)
574 tftp_stat(struct open_file
*f
, struct stat
*sb
)
576 struct tftp_handle
*tftpfile
;
577 tftpfile
= (struct tftp_handle
*) f
->f_fsdata
;
579 sb
->st_mode
= 0444 | S_IFREG
;
583 sb
->st_size
= (off_t
) tftpfile
->tftp_tsize
;
588 tftp_seek(struct open_file
*f
, off_t offset
, int where
)
590 struct tftp_handle
*tftpfile
;
591 tftpfile
= (struct tftp_handle
*) f
->f_fsdata
;
595 tftpfile
->off
= offset
;
598 tftpfile
->off
+= offset
;
604 return (tftpfile
->off
);
608 sendrecv_tftp(struct tftp_handle
*h
,
609 ssize_t (*sproc
)(struct iodesc
*, void *, size_t),
610 void *sbuf
, size_t ssize
,
611 ssize_t (*rproc
)(struct tftp_handle
*, void **, void **, time_t,
613 void **pkt
, void **payload
, unsigned short *rtype
)
615 struct iodesc
*d
= h
->iodesc
;
621 printf("sendrecv: called\n");
627 if ((getsecs() - t
) > MAXTMO
) {
632 cc
= (*sproc
)(d
, sbuf
, ssize
);
633 if (cc
!= -1 && cc
< ssize
)
634 panic("sendrecv: short write! (%zd < %zu)",
638 /* Error on transmit; wait before retrying */
639 while ((getsecs() - t1
) < tleft
);
646 if ((getsecs() - t
) > MAXTMO
) {
650 /* Try to get a packet and process it. */
651 cc
= (*rproc
)(h
, pkt
, payload
, tleft
, rtype
);
652 /* Return on data, EOF or real error. */
653 if (cc
!= -1 || (errno
!= 0 && errno
!= ETIMEDOUT
))
655 if ((getsecs() - t1
) < tleft
) {
659 /* Timed out or didn't get the packet we're waiting for */
661 if (tleft
> (2 * MINTMO
)) {
662 tleft
= (2 * MINTMO
);
669 tftp_set_blksize(struct tftp_handle
*h
, const char *str
)
675 if (h
== NULL
|| str
== NULL
)
679 (unsigned int)strtol(str
, &endptr
, 0);
682 * Only accept blksize value if it is numeric.
683 * RFC2348 specifies that acceptable values are 8-65464.
684 * Let's choose a limit less than MAXRSPACE.
686 if (*endptr
== '\0' && new_blksize
>= 8
687 && new_blksize
<= TFTP_MAX_BLKSIZE
) {
688 h
->tftp_blksize
= new_blksize
;
696 * In RFC2347, the TFTP Option Acknowledgement package (OACK)
697 * is used to acknowledge a client's option negotiation request.
698 * The format of an OACK packet is:
699 * +-------+---~~---+---+---~~---+---+---~~---+---+---~~---+---+
700 * | opc | opt1 | 0 | value1 | 0 | optN | 0 | valueN | 0 |
701 * +-------+---~~---+---+---~~---+---+---~~---+---+---~~---+---+
704 * The opcode field contains a 6, for Option Acknowledgment.
707 * The first option acknowledgment, copied from the original
711 * The acknowledged value associated with the first option. If
712 * and how this value may differ from the original request is
713 * detailed in the specification for the option.
716 * The final option/value acknowledgment pair.
719 tftp_parse_oack(struct tftp_handle
*h
, char *buf
, size_t len
)
722 * We parse the OACK strings into an array
723 * of name-value pairs.
725 char *tftp_options
[128] = { 0 };
729 int blksize_is_set
= 0;
732 unsigned int orig_blksize
;
734 while (option_idx
< 128 && i
< len
) {
735 if (buf
[i
] == '\0') {
737 tftp_options
[option_idx
] = val
;
745 /* Save the block size we requested for sanity check later. */
746 orig_blksize
= h
->tftp_blksize
;
749 * Parse individual TFTP options.
750 * * "blksize" is specified in RFC2348.
751 * * "tsize" is specified in RFC2349.
753 for (i
= 0; i
< option_idx
; i
+= 2) {
754 if (strcasecmp(tftp_options
[i
], "blksize") == 0) {
755 if (i
+ 1 < option_idx
)
757 tftp_set_blksize(h
, tftp_options
[i
+ 1]);
758 } else if (strcasecmp(tftp_options
[i
], "tsize") == 0) {
759 if (i
+ 1 < option_idx
)
760 tsize
= strtol(tftp_options
[i
+ 1], (char **)NULL
, 10);
762 h
->tftp_tsize
= tsize
;
764 /* Do not allow any options we did not expect to be ACKed. */
765 printf("unexpected tftp option '%s'\n", tftp_options
[i
]);
770 if (!blksize_is_set
) {
772 * If TFTP blksize was not set, try defaulting
773 * to the legacy TFTP blksize of SEGSIZE(512)
775 h
->tftp_blksize
= SEGSIZE
;
776 } else if (h
->tftp_blksize
> orig_blksize
) {
778 * Server should not be proposing block sizes that
779 * exceed what we said we can handle.
781 printf("unexpected blksize %u\n", h
->tftp_blksize
);
786 printf("tftp_blksize: %u\n", h
->tftp_blksize
);
787 printf("tftp_tsize: %lu\n", h
->tftp_tsize
);