1 /***************************************************************************
3 * Project ___| | | | _ \| |
5 * | (__| |_| | _ <| |___
6 * \___|\___/|_| \_\_____|
8 * Copyright (C) 1998 - 2011, 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.
21 ***************************************************************************/
25 #ifndef CURL_DISABLE_TFTP
26 /* -- WIN32 approved -- */
36 #ifdef HAVE_SYS_SOCKET_H
37 #include <sys/socket.h>
39 #include <netinet/in.h>
40 #ifdef HAVE_SYS_TIME_H
47 #ifdef HAVE_ARPA_INET_H
48 #include <arpa/inet.h>
53 #ifdef HAVE_SYS_IOCTL_H
54 #include <sys/ioctl.h>
57 #ifdef HAVE_SYS_PARAM_H
58 #include <sys/param.h>
64 #include <curl/curl.h>
71 #include "sockaddr.h" /* required for Curl_sockaddr_storage */
76 #define _MPRINTF_REPLACE /* use our functions only */
77 #include <curl/mprintf.h>
79 #include "curl_memory.h"
82 /* The last #include file should be: */
85 /* RFC2348 allows the block size to be negotiated */
86 #define TFTP_BLKSIZE_DEFAULT 512
87 #define TFTP_BLKSIZE_MIN 8
88 #define TFTP_BLKSIZE_MAX 65464
89 #define TFTP_OPTION_BLKSIZE "blksize"
92 #define TFTP_OPTION_TSIZE "tsize"
93 #define TFTP_OPTION_INTERVAL "timeout"
108 TFTP_EVENT_NONE = -1,
114 TFTP_EVENT_ERROR = 5,
127 TFTP_ERR_NOSUCHUSER, /* This will never be triggered by this code */
129 /* The remaining error codes are internal to curl */
130 TFTP_ERR_NONE = -100,
135 typedef struct tftp_packet {
139 typedef struct tftp_state_data {
144 struct connectdata *conn;
145 curl_socket_t sockfd;
152 unsigned short block;
153 struct Curl_sockaddr_storage local_addr;
154 struct Curl_sockaddr_storage remote_addr;
155 curl_socklen_t remote_addrlen;
159 int requested_blksize;
160 tftp_packet_t rpacket;
161 tftp_packet_t spacket;
165 /* Forward declarations */
166 static CURLcode tftp_rx(tftp_state_data_t *state, tftp_event_t event) ;
167 static CURLcode tftp_tx(tftp_state_data_t *state, tftp_event_t event) ;
168 static CURLcode tftp_connect(struct connectdata *conn, bool *done);
169 static CURLcode tftp_disconnect(struct connectdata *conn,
170 bool dead_connection);
171 static CURLcode tftp_do(struct connectdata *conn, bool *done);
172 static CURLcode tftp_done(struct connectdata *conn,
173 CURLcode, bool premature);
174 static CURLcode tftp_setup_connection(struct connectdata * conn);
175 static CURLcode tftp_multi_statemach(struct connectdata *conn, bool *done);
176 static CURLcode tftp_doing(struct connectdata *conn, bool *dophase_done);
177 static int tftp_getsock(struct connectdata *conn, curl_socket_t *socks,
179 static CURLcode tftp_translate_code(tftp_error_t error);
183 * TFTP protocol handler.
186 const struct Curl_handler Curl_handler_tftp = {
188 tftp_setup_connection, /* setup_connection */
190 tftp_done, /* done */
191 ZERO_NULL, /* do_more */
192 tftp_connect, /* connect_it */
193 tftp_multi_statemach, /* connecting */
194 tftp_doing, /* doing */
195 tftp_getsock, /* proto_getsock */
196 tftp_getsock, /* doing_getsock */
197 ZERO_NULL, /* perform_getsock */
198 tftp_disconnect, /* disconnect */
199 ZERO_NULL, /* readwrite */
200 PORT_TFTP, /* defport */
201 CURLPROTO_TFTP, /* protocol */
202 PROTOPT_NONE /* flags */
205 /**********************************************************
207 * tftp_set_timeouts -
209 * Set timeouts based on state machine state.
210 * Use user provided connect timeouts until DATA or ACK
211 * packet is received, then use user-provided transfer timeouts
214 **********************************************************/
215 static CURLcode tftp_set_timeouts(tftp_state_data_t *state)
217 time_t maxtime, timeout;
219 bool start = (bool)(state->state == TFTP_STATE_START);
221 time(&state->start_time);
223 /* Compute drop-dead time */
224 timeout_ms = Curl_timeleft(state->conn->data, NULL, start);
227 /* time-out, bail out, go home */
228 failf(state->conn->data, "Connection time-out");
229 return CURLE_OPERATION_TIMEDOUT;
234 maxtime = (time_t)(timeout_ms + 500) / 1000;
235 state->max_time = state->start_time+maxtime;
237 /* Set per-block timeout to total */
240 /* Average restart after 5 seconds */
241 state->retry_max = (int)timeout/5;
243 if(state->retry_max < 1)
244 /* avoid division by zero below */
245 state->retry_max = 1;
247 /* Compute the re-start interval to suit the timeout */
248 state->retry_time = (int)timeout/state->retry_max;
249 if(state->retry_time<1)
255 maxtime = (time_t)(timeout_ms + 500) / 1000;
259 state->max_time = state->start_time+maxtime;
261 /* Set per-block timeout to 10% of total */
262 timeout = maxtime/10 ;
264 /* Average reposting an ACK after 15 seconds */
265 state->retry_max = (int)timeout/15;
267 /* But bound the total number */
268 if(state->retry_max<3)
271 if(state->retry_max>50)
274 /* Compute the re-ACK interval to suit the timeout */
275 state->retry_time = (int)(timeout/state->retry_max);
276 if(state->retry_time<1)
279 infof(state->conn->data,
280 "set timeouts for state %d; Total %ld, retry %d maxtry %d\n",
281 (int)state->state, (long)(state->max_time-state->start_time),
282 state->retry_time, state->retry_max);
285 time(&state->rx_time);
290 /**********************************************************
292 * tftp_set_send_first
294 * Event handler for the START state
296 **********************************************************/
298 static void setpacketevent(tftp_packet_t *packet, unsigned short num)
300 packet->data[0] = (unsigned char)(num >> 8);
301 packet->data[1] = (unsigned char)(num & 0xff);
305 static void setpacketblock(tftp_packet_t *packet, unsigned short num)
307 packet->data[2] = (unsigned char)(num >> 8);
308 packet->data[3] = (unsigned char)(num & 0xff);
311 static unsigned short getrpacketevent(const tftp_packet_t *packet)
313 return (unsigned short)((packet->data[0] << 8) | packet->data[1]);
316 static unsigned short getrpacketblock(const tftp_packet_t *packet)
318 return (unsigned short)((packet->data[2] << 8) | packet->data[3]);
321 static size_t Curl_strnlen(const char *string, size_t maxlen)
323 const char *end = memchr (string, '\0', maxlen);
324 return end ? (size_t) (end - string) : maxlen;
327 static const char *tftp_option_get(const char *buf, size_t len,
328 const char **option, const char **value)
332 loc = Curl_strnlen( buf, len );
333 loc++; /* NULL term */
339 loc += Curl_strnlen( buf+loc, len-loc );
340 loc++; /* NULL term */
344 *value = &buf[strlen(*option) + 1];
349 static CURLcode tftp_parse_option_ack(tftp_state_data_t *state,
350 const char *ptr, int len)
352 const char *tmp = ptr;
353 struct SessionHandle *data = state->conn->data;
355 /* if OACK doesn't contain blksize option, the default (512) must be used */
356 state->blksize = TFTP_BLKSIZE_DEFAULT;
358 while(tmp < ptr + len) {
359 const char *option, *value;
361 tmp = tftp_option_get(tmp, ptr + len - tmp, &option, &value);
363 failf(data, "Malformed ACK packet, rejecting");
364 return CURLE_TFTP_ILLEGAL;
367 infof(data, "got option=(%s) value=(%s)\n", option, value);
369 if(checkprefix(option, TFTP_OPTION_BLKSIZE)) {
372 blksize = strtol( value, NULL, 10 );
375 failf(data, "invalid blocksize value in OACK packet");
376 return CURLE_TFTP_ILLEGAL;
378 else if(blksize > TFTP_BLKSIZE_MAX) {
379 failf(data, "%s (%d)", "blksize is larger than max supported",
381 return CURLE_TFTP_ILLEGAL;
383 else if(blksize < TFTP_BLKSIZE_MIN) {
384 failf(data, "%s (%d)", "blksize is smaller than min supported",
386 return CURLE_TFTP_ILLEGAL;
388 else if(blksize > state->requested_blksize) {
389 /* could realloc pkt buffers here, but the spec doesn't call out
390 * support for the server requesting a bigger blksize than the client
392 failf(data, "%s (%ld)",
393 "server requested blksize larger than allocated", blksize);
394 return CURLE_TFTP_ILLEGAL;
397 state->blksize = (int)blksize;
398 infof(data, "%s (%d) %s (%d)\n", "blksize parsed from OACK",
399 state->blksize, "requested", state->requested_blksize);
401 else if(checkprefix(option, TFTP_OPTION_TSIZE)) {
404 tsize = strtol( value, NULL, 10 );
405 infof(data, "%s (%ld)\n", "tsize parsed from OACK", tsize);
407 /* tsize should be ignored on upload: Who cares about the size of the
409 if(!data->set.upload) {
411 failf(data, "invalid tsize -:%s:- value in OACK packet", value);
412 return CURLE_TFTP_ILLEGAL;
414 Curl_pgrsSetDownloadSize(data, tsize);
422 static size_t tftp_option_add(tftp_state_data_t *state, size_t csize,
423 char *buf, const char *option)
425 if(( strlen(option) + csize + 1 ) > (size_t)state->blksize)
428 return( strlen(option) + 1 );
431 static CURLcode tftp_connect_for_tx(tftp_state_data_t *state,
435 #ifndef CURL_DISABLE_VERBOSE_STRINGS
436 struct SessionHandle *data = state->conn->data;
438 infof(data, "%s\n", "Connected for transmit");
440 state->state = TFTP_STATE_TX;
441 res = tftp_set_timeouts(state);
444 return tftp_tx(state, event);
447 static CURLcode tftp_connect_for_rx(tftp_state_data_t *state,
451 #ifndef CURL_DISABLE_VERBOSE_STRINGS
452 struct SessionHandle *data = state->conn->data;
454 infof(data, "%s\n", "Connected for receive");
456 state->state = TFTP_STATE_RX;
457 res = tftp_set_timeouts(state);
460 return tftp_rx(state, event);
463 static CURLcode tftp_send_first(tftp_state_data_t *state, tftp_event_t event)
467 const char *mode = "octet";
470 struct SessionHandle *data = state->conn->data;
471 CURLcode res = CURLE_OK;
473 /* Set ascii mode if -B flag was used */
474 if(data->set.prefer_ascii)
479 case TFTP_EVENT_INIT: /* Send the first packet out */
480 case TFTP_EVENT_TIMEOUT: /* Resend the first packet out */
481 /* Increment the retry counter, quit if over the limit */
483 if(state->retries>state->retry_max) {
484 state->error = TFTP_ERR_NORESPONSE;
485 state->state = TFTP_STATE_FIN;
489 if(data->set.upload) {
490 /* If we are uploading, send an WRQ */
491 setpacketevent(&state->spacket, TFTP_EVENT_WRQ);
492 state->conn->data->req.upload_fromhere =
493 (char *)state->spacket.data+4;
494 if(data->set.infilesize != -1)
495 Curl_pgrsSetUploadSize(data, data->set.infilesize);
498 /* If we are downloading, send an RRQ */
499 setpacketevent(&state->spacket, TFTP_EVENT_RRQ);
501 /* As RFC3617 describes the separator slash is not actually part of the
502 file name so we skip the always-present first letter of the path
504 filename = curl_easy_unescape(data, &state->conn->data->state.path[1], 0,
507 return CURLE_OUT_OF_MEMORY;
509 snprintf((char *)state->spacket.data+2,
511 "%s%c%s%c", filename, '\0', mode, '\0');
512 sbytes = 4 + strlen(filename) + strlen(mode);
514 /* add tsize option */
515 if(data->set.upload && (data->set.infilesize != -1))
516 snprintf( buf, sizeof(buf), "%" FORMAT_OFF_T, data->set.infilesize );
518 strcpy(buf, "0"); /* the destination is large enough */
520 sbytes += tftp_option_add(state, sbytes,
521 (char *)state->spacket.data+sbytes,
523 sbytes += tftp_option_add(state, sbytes,
524 (char *)state->spacket.data+sbytes, buf);
525 /* add blksize option */
526 snprintf( buf, sizeof(buf), "%d", state->requested_blksize );
527 sbytes += tftp_option_add(state, sbytes,
528 (char *)state->spacket.data+sbytes,
529 TFTP_OPTION_BLKSIZE);
530 sbytes += tftp_option_add(state, sbytes,
531 (char *)state->spacket.data+sbytes, buf );
533 /* add timeout option */
534 snprintf( buf, sizeof(buf), "%d", state->retry_time);
535 sbytes += tftp_option_add(state, sbytes,
536 (char *)state->spacket.data+sbytes,
537 TFTP_OPTION_INTERVAL);
538 sbytes += tftp_option_add(state, sbytes,
539 (char *)state->spacket.data+sbytes, buf );
541 /* the typecase for the 3rd argument is mostly for systems that do
542 not have a size_t argument, like older unixes that want an 'int' */
543 senddata = sendto(state->sockfd, (void *)state->spacket.data,
544 (SEND_TYPE_ARG3)sbytes, 0,
545 state->conn->ip_addr->ai_addr,
546 state->conn->ip_addr->ai_addrlen);
547 if(senddata != (ssize_t)sbytes) {
548 failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
550 Curl_safefree(filename);
553 case TFTP_EVENT_OACK:
554 if(data->set.upload) {
555 res = tftp_connect_for_tx(state, event);
558 res = tftp_connect_for_rx(state, event);
562 case TFTP_EVENT_ACK: /* Connected for transmit */
563 res = tftp_connect_for_tx(state, event);
566 case TFTP_EVENT_DATA: /* Connected for receive */
567 res = tftp_connect_for_rx(state, event);
570 case TFTP_EVENT_ERROR:
571 state->state = TFTP_STATE_FIN;
575 failf(state->conn->data, "tftp_send_first: internal error");
581 /* the next blocknum is x + 1 but it needs to wrap at an unsigned 16bit
583 #define NEXT_BLOCKNUM(x) (((x)+1)&0xffff)
585 /**********************************************************
589 * Event handler for the RX state
591 **********************************************************/
592 static CURLcode tftp_rx(tftp_state_data_t *state, tftp_event_t event)
596 struct SessionHandle *data = state->conn->data;
600 case TFTP_EVENT_DATA:
601 /* Is this the block we expect? */
602 rblock = getrpacketblock(&state->rpacket);
603 if(NEXT_BLOCKNUM(state->block) != rblock) {
604 /* No, log it, up the retry count and fail if over the limit */
606 "Received unexpected DATA packet block %d\n", rblock);
608 if(state->retries > state->retry_max) {
609 failf(data, "tftp_rx: giving up waiting for block %d",
610 NEXT_BLOCKNUM(state->block));
611 return CURLE_TFTP_ILLEGAL;
615 /* This is the expected block. Reset counters and ACK it. */
616 state->block = (unsigned short)rblock;
618 setpacketevent(&state->spacket, TFTP_EVENT_ACK);
619 setpacketblock(&state->spacket, state->block);
620 sbytes = sendto(state->sockfd, (void *)state->spacket.data,
622 (struct sockaddr *)&state->remote_addr,
623 state->remote_addrlen);
625 failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
626 return CURLE_SEND_ERROR;
629 /* Check if completed (That is, a less than full packet is received) */
630 if(state->rbytes < (ssize_t)state->blksize+4) {
631 state->state = TFTP_STATE_FIN;
634 state->state = TFTP_STATE_RX;
636 time(&state->rx_time);
639 case TFTP_EVENT_OACK:
640 /* ACK option acknowledgement so we can move on to data */
643 setpacketevent(&state->spacket, TFTP_EVENT_ACK);
644 setpacketblock(&state->spacket, state->block);
645 sbytes = sendto(state->sockfd, (void *)state->spacket.data,
647 (struct sockaddr *)&state->remote_addr,
648 state->remote_addrlen);
650 failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
651 return CURLE_SEND_ERROR;
654 /* we're ready to RX data */
655 state->state = TFTP_STATE_RX;
656 time(&state->rx_time);
659 case TFTP_EVENT_TIMEOUT:
660 /* Increment the retry count and fail if over the limit */
663 "Timeout waiting for block %d ACK. Retries = %d\n",
664 NEXT_BLOCKNUM(state->block), state->retries);
665 if(state->retries > state->retry_max) {
666 state->error = TFTP_ERR_TIMEOUT;
667 state->state = TFTP_STATE_FIN;
670 /* Resend the previous ACK */
671 sbytes = sendto(state->sockfd, (void *)state->spacket.data,
673 (struct sockaddr *)&state->remote_addr,
674 state->remote_addrlen);
676 failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
677 return CURLE_SEND_ERROR;
682 case TFTP_EVENT_ERROR:
683 setpacketevent(&state->spacket, TFTP_EVENT_ERROR);
684 setpacketblock(&state->spacket, state->block);
685 (void)sendto(state->sockfd, (void *)state->spacket.data,
687 (struct sockaddr *)&state->remote_addr,
688 state->remote_addrlen);
689 /* don't bother with the return code, but if the socket is still up we
690 * should be a good TFTP client and let the server know we're done */
691 state->state = TFTP_STATE_FIN;
695 failf(data, "%s", "tftp_rx: internal error");
696 return CURLE_TFTP_ILLEGAL; /* not really the perfect return code for
702 /**********************************************************
706 * Event handler for the TX state
708 **********************************************************/
709 static CURLcode tftp_tx(tftp_state_data_t *state, tftp_event_t event)
711 struct SessionHandle *data = state->conn->data;
714 CURLcode res = CURLE_OK;
715 struct SingleRequest *k = &data->req;
720 case TFTP_EVENT_OACK:
721 if(event == TFTP_EVENT_ACK) {
723 rblock = getrpacketblock(&state->rpacket);
725 if(rblock != state->block &&
726 /* There's a bug in tftpd-hpa that causes it to send us an ack for
727 * 65535 when the block number wraps to 0. So when we're expecting
728 * 0, also accept 65535. See
729 * http://syslinux.zytor.com/archives/2010-September/015253.html
731 !(state->block == 0 && rblock == 65535)) {
732 /* This isn't the expected block. Log it and up the retry counter */
733 infof(data, "Received ACK for block %d, expecting %d\n",
734 rblock, state->block);
736 /* Bail out if over the maximum */
737 if(state->retries>state->retry_max) {
738 failf(data, "tftp_tx: giving up waiting for block %d ack",
740 res = CURLE_SEND_ERROR;
743 /* Re-send the data packet */
744 sbytes = sendto(state->sockfd, (void *)&state->spacket.data,
745 4+state->sbytes, SEND_4TH_ARG,
746 (struct sockaddr *)&state->remote_addr,
747 state->remote_addrlen);
748 /* Check all sbytes were sent */
750 failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
751 res = CURLE_SEND_ERROR;
756 /* This is the expected packet. Reset the counters and send the next
758 time(&state->rx_time);
762 state->block = 1; /* first data block is 1 when using OACK */
765 setpacketevent(&state->spacket, TFTP_EVENT_DATA);
766 setpacketblock(&state->spacket, state->block);
767 if(state->block > 1 && state->sbytes < (int)state->blksize) {
768 state->state = TFTP_STATE_FIN;
771 res = Curl_fillreadbuffer(state->conn, state->blksize, &state->sbytes);
774 sbytes = sendto(state->sockfd, (void *)state->spacket.data,
775 4+state->sbytes, SEND_4TH_ARG,
776 (struct sockaddr *)&state->remote_addr,
777 state->remote_addrlen);
778 /* Check all sbytes were sent */
780 failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
781 return CURLE_SEND_ERROR;
783 /* Update the progress meter */
784 k->writebytecount += state->sbytes;
785 Curl_pgrsSetUploadCounter(data, k->writebytecount);
788 case TFTP_EVENT_TIMEOUT:
789 /* Increment the retry counter and log the timeout */
791 infof(data, "Timeout waiting for block %d ACK. "
792 " Retries = %d\n", NEXT_BLOCKNUM(state->block), state->retries);
793 /* Decide if we've had enough */
794 if(state->retries > state->retry_max) {
795 state->error = TFTP_ERR_TIMEOUT;
796 state->state = TFTP_STATE_FIN;
799 /* Re-send the data packet */
800 sbytes = sendto(state->sockfd, (void *)state->spacket.data,
801 4+state->sbytes, SEND_4TH_ARG,
802 (struct sockaddr *)&state->remote_addr,
803 state->remote_addrlen);
804 /* Check all sbytes were sent */
806 failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
807 return CURLE_SEND_ERROR;
809 /* since this was a re-send, we remain at the still byte position */
810 Curl_pgrsSetUploadCounter(data, k->writebytecount);
814 case TFTP_EVENT_ERROR:
815 state->state = TFTP_STATE_FIN;
816 setpacketevent(&state->spacket, TFTP_EVENT_ERROR);
817 setpacketblock(&state->spacket, state->block);
818 (void)sendto(state->sockfd, (void *)state->spacket.data, 4, SEND_4TH_ARG,
819 (struct sockaddr *)&state->remote_addr,
820 state->remote_addrlen);
821 /* don't bother with the return code, but if the socket is still up we
822 * should be a good TFTP client and let the server know we're done */
823 state->state = TFTP_STATE_FIN;
827 failf(data, "tftp_tx: internal error, event: %i", (int)(event));
834 /**********************************************************
836 * tftp_translate_code
838 * Translate internal error codes to CURL error codes
840 **********************************************************/
841 static CURLcode tftp_translate_code(tftp_error_t error)
843 CURLcode code = CURLE_OK;
845 if(error != TFTP_ERR_NONE) {
847 case TFTP_ERR_NOTFOUND:
848 code = CURLE_TFTP_NOTFOUND;
851 code = CURLE_TFTP_PERM;
853 case TFTP_ERR_DISKFULL:
854 code = CURLE_REMOTE_DISK_FULL;
857 case TFTP_ERR_ILLEGAL:
858 code = CURLE_TFTP_ILLEGAL;
860 case TFTP_ERR_UNKNOWNID:
861 code = CURLE_TFTP_UNKNOWNID;
863 case TFTP_ERR_EXISTS:
864 code = CURLE_REMOTE_FILE_EXISTS;
866 case TFTP_ERR_NOSUCHUSER:
867 code = CURLE_TFTP_NOSUCHUSER;
869 case TFTP_ERR_TIMEOUT:
870 code = CURLE_OPERATION_TIMEDOUT;
872 case TFTP_ERR_NORESPONSE:
873 code = CURLE_COULDNT_CONNECT;
876 code= CURLE_ABORTED_BY_CALLBACK;
887 /**********************************************************
891 * The tftp state machine event dispatcher
893 **********************************************************/
894 static CURLcode tftp_state_machine(tftp_state_data_t *state,
897 CURLcode res = CURLE_OK;
898 struct SessionHandle *data = state->conn->data;
899 switch(state->state) {
900 case TFTP_STATE_START:
901 DEBUGF(infof(data, "TFTP_STATE_START\n"));
902 res = tftp_send_first(state, event);
905 DEBUGF(infof(data, "TFTP_STATE_RX\n"));
906 res = tftp_rx(state, event);
909 DEBUGF(infof(data, "TFTP_STATE_TX\n"));
910 res = tftp_tx(state, event);
913 infof(data, "%s\n", "TFTP finished");
916 DEBUGF(infof(data, "STATE: %d\n", state->state));
917 failf(data, "%s", "Internal state machine error");
918 res = CURLE_TFTP_ILLEGAL;
924 /**********************************************************
928 * The disconnect callback
930 **********************************************************/
931 static CURLcode tftp_disconnect(struct connectdata *conn, bool dead_connection)
933 tftp_state_data_t *state = conn->proto.tftpc;
934 (void) dead_connection;
936 /* done, free dynamically allocated pkt buffers */
938 Curl_safefree(state->rpacket.data);
939 Curl_safefree(state->spacket.data);
946 /**********************************************************
950 * The connect callback
952 **********************************************************/
953 static CURLcode tftp_connect(struct connectdata *conn, bool *done)
956 tftp_state_data_t *state;
959 blksize = TFTP_BLKSIZE_DEFAULT;
961 /* If there already is a protocol-specific struct allocated for this
962 sessionhandle, deal with it */
963 Curl_reset_reqproto(conn);
965 state = conn->proto.tftpc = calloc(1, sizeof(tftp_state_data_t));
967 return CURLE_OUT_OF_MEMORY;
969 /* alloc pkt buffers based on specified blksize */
970 if(conn->data->set.tftp_blksize) {
971 blksize = (int)conn->data->set.tftp_blksize;
972 if(blksize > TFTP_BLKSIZE_MAX || blksize < TFTP_BLKSIZE_MIN )
973 return CURLE_TFTP_ILLEGAL;
976 if(!state->rpacket.data) {
977 state->rpacket.data = calloc(1, blksize + 2 + 2);
979 if(!state->rpacket.data)
980 return CURLE_OUT_OF_MEMORY;
983 if(!state->spacket.data) {
984 state->spacket.data = calloc(1, blksize + 2 + 2);
986 if(!state->spacket.data)
987 return CURLE_OUT_OF_MEMORY;
990 conn->bits.close = TRUE; /* we don't keep TFTP connections up bascially
991 because there's none or very little gain for UDP
995 state->sockfd = state->conn->sock[FIRSTSOCKET];
996 state->state = TFTP_STATE_START;
997 state->error = TFTP_ERR_NONE;
998 state->blksize = TFTP_BLKSIZE_DEFAULT;
999 state->requested_blksize = blksize;
1001 ((struct sockaddr *)&state->local_addr)->sa_family =
1002 (unsigned short)(conn->ip_addr->ai_family);
1004 tftp_set_timeouts(state);
1006 if(!conn->bits.bound) {
1007 /* If not already bound, bind to any interface, random UDP port. If it is
1008 * reused or a custom local port was desired, this has already been done!
1010 * We once used the size of the local_addr struct as the third argument
1011 * for bind() to better work with IPv6 or whatever size the struct could
1012 * have, but we learned that at least Tru64, AIX and IRIX *requires* the
1013 * size of that argument to match the exact size of a 'sockaddr_in' struct
1014 * when running IPv4-only.
1016 * Therefore we use the size from the address we connected to, which we
1017 * assume uses the same IP version and thus hopefully this works for both
1020 rc = bind(state->sockfd, (struct sockaddr *)&state->local_addr,
1021 conn->ip_addr->ai_addrlen);
1023 failf(conn->data, "bind() failed; %s",
1024 Curl_strerror(conn, SOCKERRNO));
1025 return CURLE_COULDNT_CONNECT;
1027 conn->bits.bound = TRUE;
1030 Curl_pgrsStartNow(conn->data);
1037 /**********************************************************
1043 **********************************************************/
1044 static CURLcode tftp_done(struct connectdata *conn, CURLcode status,
1047 CURLcode code = CURLE_OK;
1048 tftp_state_data_t *state = (tftp_state_data_t *)conn->proto.tftpc;
1050 (void)status; /* unused */
1051 (void)premature; /* not used */
1053 Curl_pgrsDone(conn);
1055 /* If we have encountered an error */
1056 code = tftp_translate_code(state->error);
1061 /**********************************************************
1065 * The getsock callback
1067 **********************************************************/
1068 static int tftp_getsock(struct connectdata *conn, curl_socket_t *socks,
1072 return GETSOCK_BLANK;
1074 socks[0] = conn->sock[FIRSTSOCKET];
1076 return GETSOCK_READSOCK(0);
1079 /**********************************************************
1081 * tftp_receive_packet
1083 * Called once select fires and data is ready on the socket
1085 **********************************************************/
1086 static CURLcode tftp_receive_packet(struct connectdata *conn)
1088 struct Curl_sockaddr_storage fromaddr;
1089 curl_socklen_t fromlen;
1090 CURLcode result = CURLE_OK;
1091 struct SessionHandle *data = conn->data;
1092 tftp_state_data_t *state = (tftp_state_data_t *)conn->proto.tftpc;
1093 struct SingleRequest *k = &data->req;
1095 /* Receive the packet */
1096 fromlen = sizeof(fromaddr);
1097 state->rbytes = (int)recvfrom(state->sockfd,
1098 (void *)state->rpacket.data,
1101 (struct sockaddr *)&fromaddr,
1103 if(state->remote_addrlen==0) {
1104 memcpy(&state->remote_addr, &fromaddr, fromlen);
1105 state->remote_addrlen = fromlen;
1108 /* Sanity check packet length */
1109 if(state->rbytes < 4) {
1110 failf(data, "Received too short packet");
1111 /* Not a timeout, but how best to handle it? */
1112 state->event = TFTP_EVENT_TIMEOUT;
1115 /* The event is given by the TFTP packet time */
1116 state->event = (tftp_event_t)getrpacketevent(&state->rpacket);
1118 switch(state->event) {
1119 case TFTP_EVENT_DATA:
1120 /* Don't pass to the client empty or retransmitted packets */
1121 if(state->rbytes > 4 &&
1122 (NEXT_BLOCKNUM(state->block) == getrpacketblock(&state->rpacket))) {
1123 result = Curl_client_write(conn, CLIENTWRITE_BODY,
1124 (char *)state->rpacket.data+4,
1127 tftp_state_machine(state, TFTP_EVENT_ERROR);
1130 k->bytecount += state->rbytes-4;
1131 Curl_pgrsSetDownloadCounter(data, (curl_off_t) k->bytecount);
1134 case TFTP_EVENT_ERROR:
1135 state->error = (tftp_error_t)getrpacketblock(&state->rpacket);
1136 infof(data, "%s\n", (const char *)state->rpacket.data+4);
1138 case TFTP_EVENT_ACK:
1140 case TFTP_EVENT_OACK:
1141 result = tftp_parse_option_ack(state,
1142 (const char *)state->rpacket.data+2,
1147 case TFTP_EVENT_RRQ:
1148 case TFTP_EVENT_WRQ:
1150 failf(data, "%s", "Internal error: Unexpected packet");
1154 /* Update the progress meter */
1155 if(Curl_pgrsUpdate(conn)) {
1156 tftp_state_machine(state, TFTP_EVENT_ERROR);
1157 return CURLE_ABORTED_BY_CALLBACK;
1163 /**********************************************************
1165 * tftp_state_timeout
1167 * Check if timeouts have been reached
1169 **********************************************************/
1170 static long tftp_state_timeout(struct connectdata *conn, tftp_event_t *event)
1173 tftp_state_data_t *state = (tftp_state_data_t *)conn->proto.tftpc;
1176 *event = TFTP_EVENT_NONE;
1179 if(current > state->max_time) {
1180 DEBUGF(infof(conn->data, "timeout: %ld > %ld\n",
1181 (long)current, (long)state->max_time));
1182 state->error = TFTP_ERR_TIMEOUT;
1183 state->state = TFTP_STATE_FIN;
1186 else if(current > state->rx_time+state->retry_time) {
1188 *event = TFTP_EVENT_TIMEOUT;
1189 time(&state->rx_time); /* update even though we received nothing */
1192 /* there's a typecast below here since 'time_t' may in fact be larger than
1193 'long', but we estimate that a 'long' will still be able to hold number
1194 of seconds even if "only" 32 bit */
1195 return (long)(state->max_time - current);
1199 /**********************************************************
1201 * tftp_easy_statemach
1203 * Handle easy request until completion
1205 **********************************************************/
1206 static CURLcode tftp_easy_statemach(struct connectdata *conn)
1210 CURLcode result = CURLE_OK;
1211 struct SessionHandle *data = conn->data;
1212 tftp_state_data_t *state = (tftp_state_data_t *)conn->proto.tftpc;
1213 curl_socket_t fd_read;
1215 struct SingleRequest *k = &data->req;
1216 struct timeval transaction_start = Curl_tvnow();
1218 k->start = transaction_start;
1219 k->now = transaction_start;
1221 /* Run the TFTP State Machine */
1222 for(; (state->state != TFTP_STATE_FIN) && (result == CURLE_OK); ) {
1224 timeout_ms = state->retry_time * 1000;
1226 if(data->set.upload) {
1227 if(data->set.max_send_speed &&
1228 (data->progress.ulspeed > data->set.max_send_speed)) {
1229 fd_read = CURL_SOCKET_BAD;
1230 timeout_ms = Curl_sleep_time(data->set.max_send_speed,
1231 data->progress.ulspeed, state->blksize);
1234 fd_read = state->sockfd;
1238 if(data->set.max_recv_speed &&
1239 (data->progress.dlspeed > data->set.max_recv_speed)) {
1240 fd_read = CURL_SOCKET_BAD;
1241 timeout_ms = Curl_sleep_time(data->set.max_recv_speed,
1242 data->progress.dlspeed, state->blksize);
1245 fd_read = state->sockfd;
1248 if(data->set.timeout) {
1249 timeout_ms = data->set.timeout - Curl_tvdiff(k->now, k->start);
1250 if(timeout_ms > state->retry_time * 1000)
1251 timeout_ms = state->retry_time * 1000;
1252 else if(timeout_ms < 0)
1257 /* Wait until ready to read or timeout occurs */
1258 rc = Curl_socket_ready(fd_read, CURL_SOCKET_BAD, timeout_ms);
1260 k->now = Curl_tvnow();
1262 /* Force a progress callback if it's been too long */
1263 if(Curl_tvdiff(k->now, k->start) >= data->set.timeout) {
1264 if(Curl_pgrsUpdate(conn)) {
1265 tftp_state_machine(state, TFTP_EVENT_ERROR);
1266 return CURLE_ABORTED_BY_CALLBACK;
1273 int error = SOCKERRNO;
1274 failf(data, "%s", Curl_strerror(conn, error));
1275 state->event = TFTP_EVENT_ERROR;
1280 /* A timeout occurred, but our timeout is variable, so maybe
1282 long rtms = state->retry_time * 1000;
1283 if(Curl_tvdiff(k->now, transaction_start) > rtms) {
1284 state->event = TFTP_EVENT_TIMEOUT;
1285 /* Force a look at transfer timeouts */
1289 continue; /* skip state machine */
1293 result = tftp_receive_packet(conn);
1294 if(result == CURLE_OK)
1295 transaction_start = Curl_tvnow();
1298 *k->bytecountp = k->bytecount; /* read count */
1299 if(k->writebytecountp)
1300 *k->writebytecountp = k->writebytecount; /* write count */
1305 tftp_state_timeout(conn, NULL);
1312 result = tftp_state_machine(state, state->event);
1315 /* Tell curl we're done */
1316 Curl_setup_transfer(conn, -1, -1, FALSE, NULL, -1, NULL);
1321 /**********************************************************
1323 * tftp_multi_statemach
1325 * Handle single RX socket event and return
1327 **********************************************************/
1328 static CURLcode tftp_multi_statemach(struct connectdata *conn, bool *done)
1332 CURLcode result = CURLE_OK;
1333 struct SessionHandle *data = conn->data;
1334 tftp_state_data_t *state = (tftp_state_data_t *)conn->proto.tftpc;
1335 long timeout_ms = tftp_state_timeout(conn, &event);
1339 if(timeout_ms <= 0) {
1340 failf(data, "TFTP response timeout");
1341 return CURLE_OPERATION_TIMEDOUT;
1343 else if(event != TFTP_EVENT_NONE) {
1344 result = tftp_state_machine(state, event);
1345 if(result != CURLE_OK)
1347 *done = (bool)(state->state == TFTP_STATE_FIN);
1349 /* Tell curl we're done */
1350 Curl_setup_transfer(conn, -1, -1, FALSE, NULL, -1, NULL);
1353 /* no timeouts to handle, check our socket */
1354 rc = Curl_socket_ready(state->sockfd, CURL_SOCKET_BAD, 0);
1358 int error = SOCKERRNO;
1359 failf(data, "%s", Curl_strerror(conn, error));
1360 state->event = TFTP_EVENT_ERROR;
1363 result = tftp_receive_packet(conn);
1364 if(result != CURLE_OK)
1366 result = tftp_state_machine(state, state->event);
1367 if(result != CURLE_OK)
1369 *done = (bool)(state->state == TFTP_STATE_FIN);
1371 /* Tell curl we're done */
1372 Curl_setup_transfer(conn, -1, -1, FALSE, NULL, -1, NULL);
1374 /* if rc == 0, then select() timed out */
1380 /**********************************************************
1384 * Called from multi.c while DOing
1386 **********************************************************/
1387 static CURLcode tftp_doing(struct connectdata *conn, bool *dophase_done)
1390 result = tftp_multi_statemach(conn, dophase_done);
1393 DEBUGF(infof(conn->data, "DO phase is complete\n"));
1398 /**********************************************************
1402 * Entry point for transfer from tftp_do, sarts state mach
1404 **********************************************************/
1405 static CURLcode tftp_perform(struct connectdata *conn, bool *dophase_done)
1407 CURLcode result = CURLE_OK;
1408 tftp_state_data_t *state = (tftp_state_data_t *)conn->proto.tftpc;
1410 *dophase_done = FALSE;
1412 result = tftp_state_machine(state, TFTP_EVENT_INIT);
1414 if(state->state == TFTP_STATE_FIN || result != CURLE_OK)
1417 if(conn->data->state.used_interface == Curl_if_multi)
1418 tftp_multi_statemach(conn, dophase_done);
1420 result = tftp_easy_statemach(conn);
1421 *dophase_done = TRUE; /* with the easy interface we are done here */
1425 DEBUGF(infof(conn->data, "DO phase is complete\n"));
1431 /**********************************************************
1437 * This callback initiates the TFTP transfer
1439 **********************************************************/
1441 static CURLcode tftp_do(struct connectdata *conn, bool *done)
1443 tftp_state_data_t *state;
1449 Since connections can be re-used between SessionHandles, this might be a
1450 connection already existing but on a fresh SessionHandle struct so we must
1451 make sure we have a good 'struct TFTP' to play with. For new connections,
1452 the struct TFTP is allocated and setup in the tftp_connect() function.
1454 Curl_reset_reqproto(conn);
1456 if(!conn->proto.tftpc) {
1457 code = tftp_connect(conn, done);
1461 state = (tftp_state_data_t *)conn->proto.tftpc;
1463 code = tftp_perform(conn, done);
1465 /* If tftp_perform() returned an error, use that for return code. If it
1466 was OK, see if tftp_translate_code() has an error. */
1467 if(code == CURLE_OK)
1468 /* If we have encountered an internal tftp error, translate it. */
1469 code = tftp_translate_code(state->error);
1474 static CURLcode tftp_setup_connection(struct connectdata * conn)
1476 struct SessionHandle *data = conn->data;
1480 conn->socktype = SOCK_DGRAM; /* UDP datagram based */
1482 /* TFTP URLs support an extension like ";mode=<typecode>" that
1483 * we'll try to get now! */
1484 type = strstr(data->state.path, ";mode=");
1487 type = strstr(conn->host.rawalloc, ";mode=");
1490 *type = 0; /* it was in the middle of the hostname */
1491 command = Curl_raw_toupper(type[6]);
1494 case 'A': /* ASCII mode */
1495 case 'N': /* NETASCII mode */
1496 data->set.prefer_ascii = TRUE;
1499 case 'O': /* octet mode */
1500 case 'I': /* binary mode */
1502 /* switch off ASCII */
1503 data->set.prefer_ascii = FALSE;