1 /***************************************************************************
3 * Project ___| | | | _ \| |
5 * | (__| |_| | _ <| |___
6 * \___|\___/|_| \_\_____|
8 * Copyright (C) 1998 - 2008, Daniel Stenberg, <daniel@haxx.se>, et al.
10 * This software is licensed as described in the file COPYING, which
11 * you should have received as part of this distribution. The terms
12 * are also available at http://curl.haxx.se/docs/copyright.html.
14 * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15 * copies of the Software, and permit persons to whom the Software is
16 * furnished to do so, under the terms of the COPYING file.
18 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 * KIND, either express or implied.
22 ***************************************************************************/
26 #ifndef CURL_DISABLE_TFTP
27 /* -- WIN32 approved -- */
38 #ifdef HAVE_SYS_SOCKET_H
39 #include <sys/socket.h>
41 #include <netinet/in.h>
42 #ifdef HAVE_SYS_TIME_H
49 #ifdef HAVE_ARPA_INET_H
50 #include <arpa/inet.h>
55 #include <sys/ioctl.h>
58 #ifdef HAVE_SYS_PARAM_H
59 #include <sys/param.h>
65 #include <curl/curl.h>
72 #include "sockaddr.h" /* required for Curl_sockaddr_storage */
75 #define _MPRINTF_REPLACE /* use our functions only */
76 #include <curl/mprintf.h>
81 /* The last #include file should be: */
84 /* RFC2348 allows the block size to be negotiated, but we don't support that */
85 #define TFTP_BLOCKSIZE 512
105 TFTP_EVENT_ERROR = 5,
117 TFTP_ERR_NOSUCHUSER, /* This will never be triggered by this code */
119 /* The remaining error codes are internal to curl */
120 TFTP_ERR_NONE = -100,
125 typedef struct tftp_packet {
126 unsigned char data[2 + 2 + TFTP_BLOCKSIZE];
129 typedef struct tftp_state_data {
133 struct connectdata *conn;
134 curl_socket_t sockfd;
140 unsigned short block;
141 struct Curl_sockaddr_storage local_addr;
142 struct Curl_sockaddr_storage remote_addr;
143 socklen_t remote_addrlen;
146 tftp_packet_t rpacket;
147 tftp_packet_t spacket;
151 /* Forward declarations */
152 static CURLcode tftp_rx(tftp_state_data_t *state, tftp_event_t event) ;
153 static CURLcode tftp_tx(tftp_state_data_t *state, tftp_event_t event) ;
154 static CURLcode tftp_connect(struct connectdata *conn, bool *done);
155 static CURLcode tftp_do(struct connectdata *conn, bool *done);
156 static CURLcode tftp_done(struct connectdata *conn,
157 CURLcode, bool premature);
158 static CURLcode tftp_setup_connection(struct connectdata * conn);
162 * TFTP protocol handler.
165 const struct Curl_handler Curl_handler_tftp = {
167 tftp_setup_connection, /* setup_connection */
169 tftp_done, /* done */
170 ZERO_NULL, /* do_more */
171 tftp_connect, /* connect_it */
172 ZERO_NULL, /* connecting */
173 ZERO_NULL, /* doing */
174 ZERO_NULL, /* proto_getsock */
175 ZERO_NULL, /* doing_getsock */
176 ZERO_NULL, /* disconnect */
177 PORT_TFTP, /* defport */
178 PROT_TFTP /* protocol */
182 /**********************************************************
184 * tftp_set_timeouts -
186 * Set timeouts based on state machine state.
187 * Use user provided connect timeouts until DATA or ACK
188 * packet is received, then use user-provided transfer timeouts
191 **********************************************************/
192 static CURLcode tftp_set_timeouts(tftp_state_data_t *state)
194 time_t maxtime, timeout;
197 time(&state->start_time);
199 /* Compute drop-dead time */
200 timeout_ms = Curl_timeleft(state->conn, NULL, TRUE);
203 /* time-out, bail out, go home */
204 failf(state->conn->data, "Connection time-out");
205 return CURLE_OPERATION_TIMEDOUT;
208 if(state->state == TFTP_STATE_START) {
210 maxtime = (time_t)(timeout_ms + 500) / 1000;
211 state->max_time = state->start_time+maxtime;
213 /* Set per-block timeout to total */
216 /* Average restart after 5 seconds */
217 state->retry_max = timeout/5;
219 if(state->retry_max < 1)
220 /* avoid division by zero below */
221 state->retry_max = 1;
223 /* Compute the re-start interval to suit the timeout */
224 state->retry_time = timeout/state->retry_max;
225 if(state->retry_time<1)
231 maxtime = (time_t)(timeout_ms + 500) / 1000;
235 state->max_time = state->start_time+maxtime;
237 /* Set per-block timeout to 10% of total */
238 timeout = maxtime/10 ;
240 /* Average reposting an ACK after 15 seconds */
241 state->retry_max = timeout/15;
243 /* But bound the total number */
244 if(state->retry_max<3)
247 if(state->retry_max>50)
250 /* Compute the re-ACK interval to suit the timeout */
251 state->retry_time = timeout/state->retry_max;
252 if(state->retry_time<1)
255 infof(state->conn->data,
256 "set timeouts for state %d; Total %d, retry %d maxtry %d\n",
257 state->state, (state->max_time-state->start_time),
258 state->retry_time, state->retry_max);
263 /**********************************************************
265 * tftp_set_send_first
267 * Event handler for the START state
269 **********************************************************/
271 static void setpacketevent(tftp_packet_t *packet, unsigned short num)
273 packet->data[0] = (unsigned char)(num >> 8);
274 packet->data[1] = (unsigned char)(num & 0xff);
278 static void setpacketblock(tftp_packet_t *packet, unsigned short num)
280 packet->data[2] = (unsigned char)(num >> 8);
281 packet->data[3] = (unsigned char)(num & 0xff);
284 static unsigned short getrpacketevent(const tftp_packet_t *packet)
286 return (unsigned short)((packet->data[0] << 8) | packet->data[1]);
289 static unsigned short getrpacketblock(const tftp_packet_t *packet)
291 return (unsigned short)((packet->data[2] << 8) | packet->data[3]);
294 static CURLcode tftp_send_first(tftp_state_data_t *state, tftp_event_t event)
297 const char *mode = "octet";
299 struct SessionHandle *data = state->conn->data;
300 CURLcode res = CURLE_OK;
302 /* Set ascii mode if -B flag was used */
303 if(data->set.prefer_ascii)
308 case TFTP_EVENT_INIT: /* Send the first packet out */
309 case TFTP_EVENT_TIMEOUT: /* Resend the first packet out */
310 /* Increment the retry counter, quit if over the limit */
312 if(state->retries>state->retry_max) {
313 state->error = TFTP_ERR_NORESPONSE;
314 state->state = TFTP_STATE_FIN;
318 if(data->set.upload) {
319 /* If we are uploading, send an WRQ */
320 setpacketevent(&state->spacket, TFTP_EVENT_WRQ);
321 state->conn->data->req.upload_fromhere =
322 (char *)&state->spacket.data[4];
323 if(data->set.infilesize != -1)
324 Curl_pgrsSetUploadSize(data, data->set.infilesize);
327 /* If we are downloading, send an RRQ */
328 setpacketevent(&state->spacket, TFTP_EVENT_RRQ);
330 /* As RFC3617 describes the separator slash is not actually part of the
331 file name so we skip the always-present first letter of the path string. */
332 filename = curl_easy_unescape(data, &state->conn->data->state.path[1], 0,
335 return CURLE_OUT_OF_MEMORY;
337 snprintf((char *)&state->spacket.data[2],
339 "%s%c%s%c", filename, '\0', mode, '\0');
340 sbytes = 4 + (int)strlen(filename) + (int)strlen(mode);
341 sbytes = sendto(state->sockfd, (void *)&state->spacket,
343 state->conn->ip_addr->ai_addr,
344 state->conn->ip_addr->ai_addrlen);
346 failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
348 Curl_safefree(filename);
351 case TFTP_EVENT_ACK: /* Connected for transmit */
352 infof(data, "%s\n", "Connected for transmit");
353 state->state = TFTP_STATE_TX;
354 res = tftp_set_timeouts(state);
357 return tftp_tx(state, event);
359 case TFTP_EVENT_DATA: /* connected for receive */
360 infof(data, "%s\n", "Connected for receive");
361 state->state = TFTP_STATE_RX;
362 res = tftp_set_timeouts(state);
365 return tftp_rx(state, event);
367 case TFTP_EVENT_ERROR:
368 state->state = TFTP_STATE_FIN;
372 failf(state->conn->data, "tftp_send_first: internal error");
378 /**********************************************************
382 * Event handler for the RX state
384 **********************************************************/
385 static CURLcode tftp_rx(tftp_state_data_t *state, tftp_event_t event)
389 struct SessionHandle *data = state->conn->data;
393 case TFTP_EVENT_DATA:
395 /* Is this the block we expect? */
396 rblock = getrpacketblock(&state->rpacket);
397 if((state->block+1) != rblock) {
398 /* No, log it, up the retry count and fail if over the limit */
400 "Received unexpected DATA packet block %d\n", rblock);
402 if(state->retries>state->retry_max) {
403 failf(data, "tftp_rx: giving up waiting for block %d",
405 return CURLE_TFTP_ILLEGAL;
408 /* This is the expected block. Reset counters and ACK it. */
409 state->block = (unsigned short)rblock;
411 setpacketevent(&state->spacket, TFTP_EVENT_ACK);
412 setpacketblock(&state->spacket, state->block);
413 sbytes = sendto(state->sockfd, (void *)state->spacket.data,
415 (struct sockaddr *)&state->remote_addr,
416 state->remote_addrlen);
418 failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
419 return CURLE_SEND_ERROR;
422 /* Check if completed (That is, a less than full packet is received) */
423 if(state->rbytes < (ssize_t)sizeof(state->spacket)){
424 state->state = TFTP_STATE_FIN;
427 state->state = TFTP_STATE_RX;
431 case TFTP_EVENT_TIMEOUT:
432 /* Increment the retry count and fail if over the limit */
435 "Timeout waiting for block %d ACK. Retries = %d\n", state->retries);
436 if(state->retries > state->retry_max) {
437 state->error = TFTP_ERR_TIMEOUT;
438 state->state = TFTP_STATE_FIN;
441 /* Resend the previous ACK */
442 sbytes = sendto(state->sockfd, (void *)&state->spacket,
444 (struct sockaddr *)&state->remote_addr,
445 state->remote_addrlen);
446 /* Check all sbytes were sent */
448 failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
449 return CURLE_SEND_ERROR;
454 case TFTP_EVENT_ERROR:
455 state->state = TFTP_STATE_FIN;
459 failf(data, "%s", "tftp_rx: internal error");
460 return CURLE_TFTP_ILLEGAL; /* not really the perfect return code for
466 /**********************************************************
470 * Event handler for the TX state
472 **********************************************************/
473 static CURLcode tftp_tx(tftp_state_data_t *state, tftp_event_t event)
475 struct SessionHandle *data = state->conn->data;
478 CURLcode res = CURLE_OK;
479 struct SingleRequest *k = &data->req;
485 rblock = getrpacketblock(&state->rpacket);
487 if(rblock != state->block) {
488 /* This isn't the expected block. Log it and up the retry counter */
489 infof(data, "Received ACK for block %d, expecting %d\n",
490 rblock, state->block);
492 /* Bail out if over the maximum */
493 if(state->retries>state->retry_max) {
494 failf(data, "tftp_tx: giving up waiting for block %d ack",
496 res = CURLE_SEND_ERROR;
499 /* Re-send the data packet */
500 sbytes = sendto(state->sockfd, (void *)&state->spacket,
501 4+state->sbytes, SEND_4TH_ARG,
502 (struct sockaddr *)&state->remote_addr,
503 state->remote_addrlen);
504 /* Check all sbytes were sent */
506 failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
507 res = CURLE_SEND_ERROR;
512 /* This is the expected packet. Reset the counters and send the next
516 setpacketevent(&state->spacket, TFTP_EVENT_DATA);
517 setpacketblock(&state->spacket, state->block);
518 if(state->block > 1 && state->sbytes < TFTP_BLOCKSIZE) {
519 state->state = TFTP_STATE_FIN;
522 res = Curl_fillreadbuffer(state->conn, TFTP_BLOCKSIZE, &state->sbytes);
525 sbytes = sendto(state->sockfd, (void *)state->spacket.data,
526 4+state->sbytes, SEND_4TH_ARG,
527 (struct sockaddr *)&state->remote_addr,
528 state->remote_addrlen);
529 /* Check all sbytes were sent */
531 failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
532 return CURLE_SEND_ERROR;
534 /* Update the progress meter */
535 k->writebytecount += state->sbytes;
536 Curl_pgrsSetUploadCounter(data, k->writebytecount);
539 case TFTP_EVENT_TIMEOUT:
540 /* Increment the retry counter and log the timeout */
542 infof(data, "Timeout waiting for block %d ACK. "
543 " Retries = %d\n", state->retries);
544 /* Decide if we've had enough */
545 if(state->retries > state->retry_max) {
546 state->error = TFTP_ERR_TIMEOUT;
547 state->state = TFTP_STATE_FIN;
550 /* Re-send the data packet */
551 sbytes = sendto(state->sockfd, (void *)&state->spacket,
552 4+state->sbytes, SEND_4TH_ARG,
553 (struct sockaddr *)&state->remote_addr,
554 state->remote_addrlen);
555 /* Check all sbytes were sent */
557 failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
558 return CURLE_SEND_ERROR;
560 /* since this was a re-send, we remain at the still byte position */
561 Curl_pgrsSetUploadCounter(data, k->writebytecount);
565 case TFTP_EVENT_ERROR:
566 state->state = TFTP_STATE_FIN;
570 failf(data, "%s", "tftp_tx: internal error");
577 /**********************************************************
581 * The tftp state machine event dispatcher
583 **********************************************************/
584 static CURLcode tftp_state_machine(tftp_state_data_t *state,
587 CURLcode res = CURLE_OK;
588 struct SessionHandle *data = state->conn->data;
589 switch(state->state) {
590 case TFTP_STATE_START:
591 DEBUGF(infof(data, "TFTP_STATE_START\n"));
592 res = tftp_send_first(state, event);
595 DEBUGF(infof(data, "TFTP_STATE_RX\n"));
596 res = tftp_rx(state, event);
599 DEBUGF(infof(data, "TFTP_STATE_TX\n"));
600 res = tftp_tx(state, event);
603 infof(data, "%s\n", "TFTP finished");
606 DEBUGF(infof(data, "STATE: %d\n", state->state));
607 failf(data, "%s", "Internal state machine error");
608 res = CURLE_TFTP_ILLEGAL;
615 /**********************************************************
619 * The connect callback
621 **********************************************************/
622 static CURLcode tftp_connect(struct connectdata *conn, bool *done)
625 tftp_state_data_t *state;
628 /* If there already is a protocol-specific struct allocated for this
629 sessionhandle, deal with it */
630 Curl_reset_reqproto(conn);
632 state = conn->data->state.proto.tftp;
634 state = conn->data->state.proto.tftp = calloc(sizeof(tftp_state_data_t),
637 return CURLE_OUT_OF_MEMORY;
640 conn->bits.close = FALSE; /* keep it open if possible */
643 state->sockfd = state->conn->sock[FIRSTSOCKET];
644 state->state = TFTP_STATE_START;
645 state->error = TFTP_ERR_NONE;
647 ((struct sockaddr *)&state->local_addr)->sa_family =
648 (unsigned short)(conn->ip_addr->ai_family);
650 tftp_set_timeouts(state);
652 if(!conn->bits.bound) {
653 /* If not already bound, bind to any interface, random UDP port. If it is
654 * reused or a custom local port was desired, this has already been done!
656 * We once used the size of the local_addr struct as the third argument for
657 * bind() to better work with IPv6 or whatever size the struct could have,
658 * but we learned that at least Tru64, AIX and IRIX *requires* the size of
659 * that argument to match the exact size of a 'sockaddr_in' struct when
662 * Therefore we use the size from the address we connected to, which we
663 * assume uses the same IP version and thus hopefully this works for both
666 rc = bind(state->sockfd, (struct sockaddr *)&state->local_addr,
667 conn->ip_addr->ai_addrlen);
669 failf(conn->data, "bind() failed; %s",
670 Curl_strerror(conn, SOCKERRNO));
671 return CURLE_COULDNT_CONNECT;
673 conn->bits.bound = TRUE;
676 Curl_pgrsStartNow(conn->data);
683 /**********************************************************
689 **********************************************************/
690 static CURLcode tftp_done(struct connectdata *conn, CURLcode status,
693 (void)status; /* unused */
694 (void)premature; /* not used */
702 /**********************************************************
708 * This callback handles the entire TFTP transfer
710 **********************************************************/
712 static CURLcode tftp_do(struct connectdata *conn, bool *done)
714 struct SessionHandle *data = conn->data;
715 tftp_state_data_t *state;
719 struct Curl_sockaddr_storage fromaddr;
720 RECVFROM_ARG6_T fromlen;
722 struct SingleRequest *k = &data->req;
727 Since connections can be re-used between SessionHandles, this might be a
728 connection already existing but on a fresh SessionHandle struct so we must
729 make sure we have a good 'struct TFTP' to play with. For new connections,
730 the struct TFTP is allocated and setup in the tftp_connect() function.
732 Curl_reset_reqproto(conn);
734 if(!data->state.proto.tftp) {
735 code = tftp_connect(conn, done);
739 state = (tftp_state_data_t *)data->state.proto.tftp;
741 /* Run the TFTP State Machine */
742 for(code=tftp_state_machine(state, TFTP_EVENT_INIT);
743 (state->state != TFTP_STATE_FIN) && (code == CURLE_OK);
744 code=tftp_state_machine(state, event) ) {
746 /* Wait until ready to read or timeout occurs */
747 rc=Curl_socket_ready(state->sockfd, CURL_SOCKET_BAD,
748 state->retry_time * 1000);
752 int error = SOCKERRNO;
753 failf(data, "%s", Curl_strerror(conn, error));
754 event = TFTP_EVENT_ERROR;
757 /* A timeout occured */
758 event = TFTP_EVENT_TIMEOUT;
760 /* Force a look at transfer timeouts */
766 /* Receive the packet */
767 fromlen = (RECVFROM_ARG6_T)sizeof(fromaddr);
768 state->rbytes = sreadfrom(state->sockfd,
769 &state->rpacket, sizeof(state->rpacket),
770 &fromaddr, &fromlen);
771 if(state->remote_addrlen==0) {
772 memcpy(&state->remote_addr, &fromaddr, fromlen);
773 state->remote_addrlen = fromlen;
776 /* Sanity check packet length */
777 if(state->rbytes < 4) {
778 failf(data, "Received too short packet");
779 /* Not a timeout, but how best to handle it? */
780 event = TFTP_EVENT_TIMEOUT;
784 /* The event is given by the TFTP packet time */
785 event = (tftp_event_t)getrpacketevent(&state->rpacket);
788 case TFTP_EVENT_DATA:
789 /* Don't pass to the client empty or retransmitted packets */
790 if(state->rbytes > 4 &&
791 ((state->block+1) == getrpacketblock(&state->rpacket))) {
792 code = Curl_client_write(conn, CLIENTWRITE_BODY,
793 (char *)&state->rpacket.data[4],
797 k->bytecount += state->rbytes-4;
798 Curl_pgrsSetDownloadCounter(data, (curl_off_t) k->bytecount);
801 case TFTP_EVENT_ERROR:
802 state->error = (tftp_error_t)getrpacketblock(&state->rpacket);
803 infof(data, "%s\n", (char *)&state->rpacket.data[4]);
810 failf(data, "%s", "Internal error: Unexpected packet");
814 /* Update the progress meter */
815 if(Curl_pgrsUpdate(conn))
816 return CURLE_ABORTED_BY_CALLBACK;
820 /* Check for transfer timeout every 10 blocks, or after timeout */
821 if(check_time%10==0) {
824 if(current>state->max_time) {
825 DEBUGF(infof(data, "timeout: %d > %d\n",
826 current, state->max_time));
827 state->error = TFTP_ERR_TIMEOUT;
828 state->state = TFTP_STATE_FIN;
836 /* Tell curl we're done */
837 code = Curl_setup_transfer(conn, -1, -1, FALSE, NULL, -1, NULL);
841 /* If we have encountered an error */
842 if(state->error != TFTP_ERR_NONE) {
844 /* Translate internal error codes to curl error codes */
845 switch(state->error) {
846 case TFTP_ERR_NOTFOUND:
847 code = CURLE_TFTP_NOTFOUND;
850 code = CURLE_TFTP_PERM;
852 case TFTP_ERR_DISKFULL:
853 code = CURLE_REMOTE_DISK_FULL;
856 case TFTP_ERR_ILLEGAL:
857 code = CURLE_TFTP_ILLEGAL;
859 case TFTP_ERR_UNKNOWNID:
860 code = CURLE_TFTP_UNKNOWNID;
862 case TFTP_ERR_EXISTS:
863 code = CURLE_REMOTE_FILE_EXISTS;
865 case TFTP_ERR_NOSUCHUSER:
866 code = CURLE_TFTP_NOSUCHUSER;
868 case TFTP_ERR_TIMEOUT:
869 code = CURLE_OPERATION_TIMEDOUT;
871 case TFTP_ERR_NORESPONSE:
872 code = CURLE_COULDNT_CONNECT;
875 code= CURLE_ABORTED_BY_CALLBACK;
884 static CURLcode tftp_setup_connection(struct connectdata * conn)
886 struct SessionHandle *data = conn->data;
890 conn->socktype = SOCK_DGRAM; /* UDP datagram based */
892 /* TFTP URLs support an extension like ";mode=<typecode>" that
893 * we'll try to get now! */
894 type = strstr(data->state.path, ";mode=");
897 type = strstr(conn->host.rawalloc, ";mode=");
900 *type = 0; /* it was in the middle of the hostname */
901 command = (char) toupper((int) type[6]);
904 case 'A': /* ASCII mode */
905 case 'N': /* NETASCII mode */
906 data->set.prefer_ascii = TRUE;
909 case 'O': /* octet mode */
910 case 'I': /* binary mode */
912 /* switch off ASCII */
913 data->set.prefer_ascii = FALSE;