1 /***************************************************************************
3 * Project ___| | | | _ \| |
5 * | (__| |_| | _ <| |___
6 * \___|\___/|_| \_\_____|
8 * Copyright (C) 1998 - 2017, 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 https://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 ***************************************************************************/
23 #include "curl_setup.h"
25 #ifndef CURL_DISABLE_TFTP
27 #ifdef HAVE_NETINET_IN_H
28 #include <netinet/in.h>
33 #ifdef HAVE_ARPA_INET_H
34 #include <arpa/inet.h>
39 #ifdef HAVE_SYS_IOCTL_H
40 #include <sys/ioctl.h>
43 #ifdef HAVE_SYS_PARAM_H
44 #include <sys/param.h>
48 #include <curl/curl.h>
55 #include "sockaddr.h" /* required for Curl_sockaddr_storage */
59 #include "speedcheck.h"
63 /* The last 3 #include files should be in this order */
64 #include "curl_printf.h"
65 #include "curl_memory.h"
68 /* RFC2348 allows the block size to be negotiated */
69 #define TFTP_BLKSIZE_DEFAULT 512
70 #define TFTP_BLKSIZE_MIN 8
71 #define TFTP_BLKSIZE_MAX 65464
72 #define TFTP_OPTION_BLKSIZE "blksize"
75 #define TFTP_OPTION_TSIZE "tsize"
76 #define TFTP_OPTION_INTERVAL "timeout"
79 TFTP_MODE_NETASCII = 0,
110 TFTP_ERR_NOSUCHUSER, /* This will never be triggered by this code */
112 /* The remaining error codes are internal to curl */
113 TFTP_ERR_NONE = -100,
118 typedef struct tftp_packet {
122 typedef struct tftp_state_data {
127 struct connectdata *conn;
128 curl_socket_t sockfd;
135 unsigned short block;
136 struct Curl_sockaddr_storage local_addr;
137 struct Curl_sockaddr_storage remote_addr;
138 curl_socklen_t remote_addrlen;
142 int requested_blksize;
143 tftp_packet_t rpacket;
144 tftp_packet_t spacket;
148 /* Forward declarations */
149 static CURLcode tftp_rx(tftp_state_data_t *state, tftp_event_t event);
150 static CURLcode tftp_tx(tftp_state_data_t *state, tftp_event_t event);
151 static CURLcode tftp_connect(struct connectdata *conn, bool *done);
152 static CURLcode tftp_disconnect(struct connectdata *conn,
153 bool dead_connection);
154 static CURLcode tftp_do(struct connectdata *conn, bool *done);
155 static CURLcode tftp_done(struct connectdata *conn,
156 CURLcode, bool premature);
157 static CURLcode tftp_setup_connection(struct connectdata * conn);
158 static CURLcode tftp_multi_statemach(struct connectdata *conn, bool *done);
159 static CURLcode tftp_doing(struct connectdata *conn, bool *dophase_done);
160 static int tftp_getsock(struct connectdata *conn, curl_socket_t *socks,
162 static CURLcode tftp_translate_code(tftp_error_t error);
166 * TFTP protocol handler.
169 const struct Curl_handler Curl_handler_tftp = {
171 tftp_setup_connection, /* setup_connection */
173 tftp_done, /* done */
174 ZERO_NULL, /* do_more */
175 tftp_connect, /* connect_it */
176 tftp_multi_statemach, /* connecting */
177 tftp_doing, /* doing */
178 tftp_getsock, /* proto_getsock */
179 tftp_getsock, /* doing_getsock */
180 ZERO_NULL, /* domore_getsock */
181 ZERO_NULL, /* perform_getsock */
182 tftp_disconnect, /* disconnect */
183 ZERO_NULL, /* readwrite */
184 ZERO_NULL, /* connection_check */
185 PORT_TFTP, /* defport */
186 CURLPROTO_TFTP, /* protocol */
187 PROTOPT_NONE | PROTOPT_NOURLQUERY /* flags */
190 /**********************************************************
192 * tftp_set_timeouts -
194 * Set timeouts based on state machine state.
195 * Use user provided connect timeouts until DATA or ACK
196 * packet is received, then use user-provided transfer timeouts
199 **********************************************************/
200 static CURLcode tftp_set_timeouts(tftp_state_data_t *state)
202 time_t maxtime, timeout;
203 timediff_t timeout_ms;
204 bool start = (state->state == TFTP_STATE_START) ? TRUE : FALSE;
206 time(&state->start_time);
208 /* Compute drop-dead time */
209 timeout_ms = Curl_timeleft(state->conn->data, NULL, start);
212 /* time-out, bail out, go home */
213 failf(state->conn->data, "Connection time-out");
214 return CURLE_OPERATION_TIMEDOUT;
219 maxtime = (time_t)(timeout_ms + 500) / 1000;
220 state->max_time = state->start_time + maxtime;
222 /* Set per-block timeout to total */
225 /* Average restart after 5 seconds */
226 state->retry_max = (int)timeout/5;
228 if(state->retry_max < 1)
229 /* avoid division by zero below */
230 state->retry_max = 1;
232 /* Compute the re-start interval to suit the timeout */
233 state->retry_time = (int)timeout/state->retry_max;
234 if(state->retry_time<1)
235 state->retry_time = 1;
240 maxtime = (time_t)(timeout_ms + 500) / 1000;
244 state->max_time = state->start_time + maxtime;
246 /* Set per-block timeout to total */
249 /* Average reposting an ACK after 5 seconds */
250 state->retry_max = (int)timeout/5;
252 /* But bound the total number */
253 if(state->retry_max<3)
254 state->retry_max = 3;
256 if(state->retry_max>50)
257 state->retry_max = 50;
259 /* Compute the re-ACK interval to suit the timeout */
260 state->retry_time = (int)(timeout/state->retry_max);
261 if(state->retry_time<1)
262 state->retry_time = 1;
264 infof(state->conn->data,
265 "set timeouts for state %d; Total %ld, retry %d maxtry %d\n",
266 (int)state->state, (long)(state->max_time-state->start_time),
267 state->retry_time, state->retry_max);
270 time(&state->rx_time);
275 /**********************************************************
277 * tftp_set_send_first
279 * Event handler for the START state
281 **********************************************************/
283 static void setpacketevent(tftp_packet_t *packet, unsigned short num)
285 packet->data[0] = (unsigned char)(num >> 8);
286 packet->data[1] = (unsigned char)(num & 0xff);
290 static void setpacketblock(tftp_packet_t *packet, unsigned short num)
292 packet->data[2] = (unsigned char)(num >> 8);
293 packet->data[3] = (unsigned char)(num & 0xff);
296 static unsigned short getrpacketevent(const tftp_packet_t *packet)
298 return (unsigned short)((packet->data[0] << 8) | packet->data[1]);
301 static unsigned short getrpacketblock(const tftp_packet_t *packet)
303 return (unsigned short)((packet->data[2] << 8) | packet->data[3]);
306 static size_t Curl_strnlen(const char *string, size_t maxlen)
308 const char *end = memchr(string, '\0', maxlen);
309 return end ? (size_t) (end - string) : maxlen;
312 static const char *tftp_option_get(const char *buf, size_t len,
313 const char **option, const char **value)
317 loc = Curl_strnlen(buf, len);
318 loc++; /* NULL term */
324 loc += Curl_strnlen(buf + loc, len-loc);
325 loc++; /* NULL term */
329 *value = &buf[strlen(*option) + 1];
334 static CURLcode tftp_parse_option_ack(tftp_state_data_t *state,
335 const char *ptr, int len)
337 const char *tmp = ptr;
338 struct Curl_easy *data = state->conn->data;
340 /* if OACK doesn't contain blksize option, the default (512) must be used */
341 state->blksize = TFTP_BLKSIZE_DEFAULT;
343 while(tmp < ptr + len) {
344 const char *option, *value;
346 tmp = tftp_option_get(tmp, ptr + len - tmp, &option, &value);
348 failf(data, "Malformed ACK packet, rejecting");
349 return CURLE_TFTP_ILLEGAL;
352 infof(data, "got option=(%s) value=(%s)\n", option, value);
354 if(checkprefix(option, TFTP_OPTION_BLKSIZE)) {
357 blksize = strtol(value, NULL, 10);
360 failf(data, "invalid blocksize value in OACK packet");
361 return CURLE_TFTP_ILLEGAL;
363 if(blksize > TFTP_BLKSIZE_MAX) {
364 failf(data, "%s (%d)", "blksize is larger than max supported",
366 return CURLE_TFTP_ILLEGAL;
368 else if(blksize < TFTP_BLKSIZE_MIN) {
369 failf(data, "%s (%d)", "blksize is smaller than min supported",
371 return CURLE_TFTP_ILLEGAL;
373 else if(blksize > state->requested_blksize) {
374 /* could realloc pkt buffers here, but the spec doesn't call out
375 * support for the server requesting a bigger blksize than the client
377 failf(data, "%s (%ld)",
378 "server requested blksize larger than allocated", blksize);
379 return CURLE_TFTP_ILLEGAL;
382 state->blksize = (int)blksize;
383 infof(data, "%s (%d) %s (%d)\n", "blksize parsed from OACK",
384 state->blksize, "requested", state->requested_blksize);
386 else if(checkprefix(option, TFTP_OPTION_TSIZE)) {
389 tsize = strtol(value, NULL, 10);
390 infof(data, "%s (%ld)\n", "tsize parsed from OACK", tsize);
392 /* tsize should be ignored on upload: Who cares about the size of the
394 if(!data->set.upload) {
396 failf(data, "invalid tsize -:%s:- value in OACK packet", value);
397 return CURLE_TFTP_ILLEGAL;
399 Curl_pgrsSetDownloadSize(data, tsize);
407 static size_t tftp_option_add(tftp_state_data_t *state, size_t csize,
408 char *buf, const char *option)
410 if(( strlen(option) + csize + 1) > (size_t)state->blksize)
413 return strlen(option) + 1;
416 static CURLcode tftp_connect_for_tx(tftp_state_data_t *state,
420 #ifndef CURL_DISABLE_VERBOSE_STRINGS
421 struct Curl_easy *data = state->conn->data;
423 infof(data, "%s\n", "Connected for transmit");
425 state->state = TFTP_STATE_TX;
426 result = tftp_set_timeouts(state);
429 return tftp_tx(state, event);
432 static CURLcode tftp_connect_for_rx(tftp_state_data_t *state,
436 #ifndef CURL_DISABLE_VERBOSE_STRINGS
437 struct Curl_easy *data = state->conn->data;
439 infof(data, "%s\n", "Connected for receive");
441 state->state = TFTP_STATE_RX;
442 result = tftp_set_timeouts(state);
445 return tftp_rx(state, event);
448 static CURLcode tftp_send_first(tftp_state_data_t *state, tftp_event_t event)
452 const char *mode = "octet";
455 struct Curl_easy *data = state->conn->data;
456 CURLcode result = CURLE_OK;
458 /* Set ascii mode if -B flag was used */
459 if(data->set.prefer_ascii)
464 case TFTP_EVENT_INIT: /* Send the first packet out */
465 case TFTP_EVENT_TIMEOUT: /* Resend the first packet out */
466 /* Increment the retry counter, quit if over the limit */
468 if(state->retries>state->retry_max) {
469 state->error = TFTP_ERR_NORESPONSE;
470 state->state = TFTP_STATE_FIN;
474 if(data->set.upload) {
475 /* If we are uploading, send an WRQ */
476 setpacketevent(&state->spacket, TFTP_EVENT_WRQ);
477 state->conn->data->req.upload_fromhere =
478 (char *)state->spacket.data + 4;
479 if(data->state.infilesize != -1)
480 Curl_pgrsSetUploadSize(data, data->state.infilesize);
483 /* If we are downloading, send an RRQ */
484 setpacketevent(&state->spacket, TFTP_EVENT_RRQ);
486 /* As RFC3617 describes the separator slash is not actually part of the
487 file name so we skip the always-present first letter of the path
489 result = Curl_urldecode(data, &state->conn->data->state.path[1], 0,
490 &filename, NULL, FALSE);
494 if(strlen(filename) > (state->blksize - strlen(mode) - 4)) {
495 failf(data, "TFTP file name too long\n");
497 return CURLE_TFTP_ILLEGAL; /* too long file name field */
500 snprintf((char *)state->spacket.data + 2,
502 "%s%c%s%c", filename, '\0', mode, '\0');
503 sbytes = 4 + strlen(filename) + strlen(mode);
505 /* optional addition of TFTP options */
506 if(!data->set.tftp_no_options) {
507 /* add tsize option */
508 if(data->set.upload && (data->state.infilesize != -1))
509 snprintf(buf, sizeof(buf), "%" CURL_FORMAT_CURL_OFF_T,
510 data->state.infilesize);
512 strcpy(buf, "0"); /* the destination is large enough */
514 sbytes += tftp_option_add(state, sbytes,
515 (char *)state->spacket.data + sbytes,
517 sbytes += tftp_option_add(state, sbytes,
518 (char *)state->spacket.data + sbytes, buf);
519 /* add blksize option */
520 snprintf(buf, sizeof(buf), "%d", state->requested_blksize);
521 sbytes += tftp_option_add(state, sbytes,
522 (char *)state->spacket.data + sbytes,
523 TFTP_OPTION_BLKSIZE);
524 sbytes += tftp_option_add(state, sbytes,
525 (char *)state->spacket.data + sbytes, buf);
527 /* add timeout option */
528 snprintf(buf, sizeof(buf), "%d", state->retry_time);
529 sbytes += tftp_option_add(state, sbytes,
530 (char *)state->spacket.data + sbytes,
531 TFTP_OPTION_INTERVAL);
532 sbytes += tftp_option_add(state, sbytes,
533 (char *)state->spacket.data + sbytes, buf);
536 /* the typecase for the 3rd argument is mostly for systems that do
537 not have a size_t argument, like older unixes that want an 'int' */
538 senddata = sendto(state->sockfd, (void *)state->spacket.data,
539 (SEND_TYPE_ARG3)sbytes, 0,
540 state->conn->ip_addr->ai_addr,
541 state->conn->ip_addr->ai_addrlen);
542 if(senddata != (ssize_t)sbytes) {
543 failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
548 case TFTP_EVENT_OACK:
549 if(data->set.upload) {
550 result = tftp_connect_for_tx(state, event);
553 result = tftp_connect_for_rx(state, event);
557 case TFTP_EVENT_ACK: /* Connected for transmit */
558 result = tftp_connect_for_tx(state, event);
561 case TFTP_EVENT_DATA: /* Connected for receive */
562 result = tftp_connect_for_rx(state, event);
565 case TFTP_EVENT_ERROR:
566 state->state = TFTP_STATE_FIN;
570 failf(state->conn->data, "tftp_send_first: internal error");
577 /* the next blocknum is x + 1 but it needs to wrap at an unsigned 16bit
579 #define NEXT_BLOCKNUM(x) (((x) + 1)&0xffff)
581 /**********************************************************
585 * Event handler for the RX state
587 **********************************************************/
588 static CURLcode tftp_rx(tftp_state_data_t *state, tftp_event_t event)
592 struct Curl_easy *data = state->conn->data;
596 case TFTP_EVENT_DATA:
597 /* Is this the block we expect? */
598 rblock = getrpacketblock(&state->rpacket);
599 if(NEXT_BLOCKNUM(state->block) == rblock) {
600 /* This is the expected block. Reset counters and ACK it. */
603 else if(state->block == rblock) {
604 /* This is the last recently received block again. Log it and ACK it
606 infof(data, "Received last DATA packet block %d again.\n", rblock);
609 /* totally unexpected, just log it */
611 "Received unexpected DATA packet block %d, expecting block %d\n",
612 rblock, NEXT_BLOCKNUM(state->block));
616 /* ACK this block. */
617 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 Curl_easy *data = state->conn->data;
714 CURLcode result = CURLE_OK;
715 struct SingleRequest *k = &data->req;
716 int cb; /* Bytes currently read */
721 case TFTP_EVENT_OACK:
722 if(event == TFTP_EVENT_ACK) {
724 rblock = getrpacketblock(&state->rpacket);
726 if(rblock != state->block &&
727 /* There's a bug in tftpd-hpa that causes it to send us an ack for
728 * 65535 when the block number wraps to 0. So when we're expecting
729 * 0, also accept 65535. See
730 * http://syslinux.zytor.com/archives/2010-September/015253.html
732 !(state->block == 0 && rblock == 65535)) {
733 /* This isn't the expected block. Log it and up the retry counter */
734 infof(data, "Received ACK for block %d, expecting %d\n",
735 rblock, state->block);
737 /* Bail out if over the maximum */
738 if(state->retries>state->retry_max) {
739 failf(data, "tftp_tx: giving up waiting for block %d ack",
741 result = CURLE_SEND_ERROR;
744 /* Re-send the data packet */
745 sbytes = sendto(state->sockfd, (void *)state->spacket.data,
746 4 + state->sbytes, SEND_4TH_ARG,
747 (struct sockaddr *)&state->remote_addr,
748 state->remote_addrlen);
749 /* Check all sbytes were sent */
751 failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
752 result = CURLE_SEND_ERROR;
758 /* This is the expected packet. Reset the counters and send the next
760 time(&state->rx_time);
764 state->block = 1; /* first data block is 1 when using OACK */
767 setpacketevent(&state->spacket, TFTP_EVENT_DATA);
768 setpacketblock(&state->spacket, state->block);
769 if(state->block > 1 && state->sbytes < (int)state->blksize) {
770 state->state = TFTP_STATE_FIN;
774 /* TFTP considers data block size < 512 bytes as an end of session. So
775 * in some cases we must wait for additional data to build full (512 bytes)
779 state->conn->data->req.upload_fromhere = (char *)state->spacket.data + 4;
781 result = Curl_fillreadbuffer(state->conn, state->blksize - state->sbytes,
786 state->conn->data->req.upload_fromhere += cb;
787 } while(state->sbytes < state->blksize && cb != 0);
789 sbytes = sendto(state->sockfd, (void *) state->spacket.data,
790 4 + state->sbytes, SEND_4TH_ARG,
791 (struct sockaddr *)&state->remote_addr,
792 state->remote_addrlen);
793 /* Check all sbytes were sent */
795 failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
796 return CURLE_SEND_ERROR;
798 /* Update the progress meter */
799 k->writebytecount += state->sbytes;
800 Curl_pgrsSetUploadCounter(data, k->writebytecount);
803 case TFTP_EVENT_TIMEOUT:
804 /* Increment the retry counter and log the timeout */
806 infof(data, "Timeout waiting for block %d ACK. "
807 " Retries = %d\n", NEXT_BLOCKNUM(state->block), state->retries);
808 /* Decide if we've had enough */
809 if(state->retries > state->retry_max) {
810 state->error = TFTP_ERR_TIMEOUT;
811 state->state = TFTP_STATE_FIN;
814 /* Re-send the data packet */
815 sbytes = sendto(state->sockfd, (void *)state->spacket.data,
816 4 + state->sbytes, SEND_4TH_ARG,
817 (struct sockaddr *)&state->remote_addr,
818 state->remote_addrlen);
819 /* Check all sbytes were sent */
821 failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
822 return CURLE_SEND_ERROR;
824 /* since this was a re-send, we remain at the still byte position */
825 Curl_pgrsSetUploadCounter(data, k->writebytecount);
829 case TFTP_EVENT_ERROR:
830 state->state = TFTP_STATE_FIN;
831 setpacketevent(&state->spacket, TFTP_EVENT_ERROR);
832 setpacketblock(&state->spacket, state->block);
833 (void)sendto(state->sockfd, (void *)state->spacket.data, 4, SEND_4TH_ARG,
834 (struct sockaddr *)&state->remote_addr,
835 state->remote_addrlen);
836 /* don't bother with the return code, but if the socket is still up we
837 * should be a good TFTP client and let the server know we're done */
838 state->state = TFTP_STATE_FIN;
842 failf(data, "tftp_tx: internal error, event: %i", (int)(event));
849 /**********************************************************
851 * tftp_translate_code
853 * Translate internal error codes to CURL error codes
855 **********************************************************/
856 static CURLcode tftp_translate_code(tftp_error_t error)
858 CURLcode result = CURLE_OK;
860 if(error != TFTP_ERR_NONE) {
862 case TFTP_ERR_NOTFOUND:
863 result = CURLE_TFTP_NOTFOUND;
866 result = CURLE_TFTP_PERM;
868 case TFTP_ERR_DISKFULL:
869 result = CURLE_REMOTE_DISK_FULL;
872 case TFTP_ERR_ILLEGAL:
873 result = CURLE_TFTP_ILLEGAL;
875 case TFTP_ERR_UNKNOWNID:
876 result = CURLE_TFTP_UNKNOWNID;
878 case TFTP_ERR_EXISTS:
879 result = CURLE_REMOTE_FILE_EXISTS;
881 case TFTP_ERR_NOSUCHUSER:
882 result = CURLE_TFTP_NOSUCHUSER;
884 case TFTP_ERR_TIMEOUT:
885 result = CURLE_OPERATION_TIMEDOUT;
887 case TFTP_ERR_NORESPONSE:
888 result = CURLE_COULDNT_CONNECT;
891 result = CURLE_ABORTED_BY_CALLBACK;
901 /**********************************************************
905 * The tftp state machine event dispatcher
907 **********************************************************/
908 static CURLcode tftp_state_machine(tftp_state_data_t *state,
911 CURLcode result = CURLE_OK;
912 struct Curl_easy *data = state->conn->data;
914 switch(state->state) {
915 case TFTP_STATE_START:
916 DEBUGF(infof(data, "TFTP_STATE_START\n"));
917 result = tftp_send_first(state, event);
920 DEBUGF(infof(data, "TFTP_STATE_RX\n"));
921 result = tftp_rx(state, event);
924 DEBUGF(infof(data, "TFTP_STATE_TX\n"));
925 result = tftp_tx(state, event);
928 infof(data, "%s\n", "TFTP finished");
931 DEBUGF(infof(data, "STATE: %d\n", state->state));
932 failf(data, "%s", "Internal state machine error");
933 result = CURLE_TFTP_ILLEGAL;
940 /**********************************************************
944 * The disconnect callback
946 **********************************************************/
947 static CURLcode tftp_disconnect(struct connectdata *conn, bool dead_connection)
949 tftp_state_data_t *state = conn->proto.tftpc;
950 (void) dead_connection;
952 /* done, free dynamically allocated pkt buffers */
954 Curl_safefree(state->rpacket.data);
955 Curl_safefree(state->spacket.data);
962 /**********************************************************
966 * The connect callback
968 **********************************************************/
969 static CURLcode tftp_connect(struct connectdata *conn, bool *done)
971 tftp_state_data_t *state;
974 blksize = TFTP_BLKSIZE_DEFAULT;
976 state = conn->proto.tftpc = calloc(1, sizeof(tftp_state_data_t));
978 return CURLE_OUT_OF_MEMORY;
980 /* alloc pkt buffers based on specified blksize */
981 if(conn->data->set.tftp_blksize) {
982 blksize = (int)conn->data->set.tftp_blksize;
983 if(blksize > TFTP_BLKSIZE_MAX || blksize < TFTP_BLKSIZE_MIN)
984 return CURLE_TFTP_ILLEGAL;
987 if(!state->rpacket.data) {
988 state->rpacket.data = calloc(1, blksize + 2 + 2);
990 if(!state->rpacket.data)
991 return CURLE_OUT_OF_MEMORY;
994 if(!state->spacket.data) {
995 state->spacket.data = calloc(1, blksize + 2 + 2);
997 if(!state->spacket.data)
998 return CURLE_OUT_OF_MEMORY;
1001 /* we don't keep TFTP connections up basically because there's none or very
1002 * little gain for UDP */
1003 connclose(conn, "TFTP");
1006 state->sockfd = state->conn->sock[FIRSTSOCKET];
1007 state->state = TFTP_STATE_START;
1008 state->error = TFTP_ERR_NONE;
1009 state->blksize = TFTP_BLKSIZE_DEFAULT;
1010 state->requested_blksize = blksize;
1012 ((struct sockaddr *)&state->local_addr)->sa_family =
1013 (unsigned short)(conn->ip_addr->ai_family);
1015 tftp_set_timeouts(state);
1017 if(!conn->bits.bound) {
1018 /* If not already bound, bind to any interface, random UDP port. If it is
1019 * reused or a custom local port was desired, this has already been done!
1021 * We once used the size of the local_addr struct as the third argument
1022 * for bind() to better work with IPv6 or whatever size the struct could
1023 * have, but we learned that at least Tru64, AIX and IRIX *requires* the
1024 * size of that argument to match the exact size of a 'sockaddr_in' struct
1025 * when running IPv4-only.
1027 * Therefore we use the size from the address we connected to, which we
1028 * assume uses the same IP version and thus hopefully this works for both
1031 rc = bind(state->sockfd, (struct sockaddr *)&state->local_addr,
1032 conn->ip_addr->ai_addrlen);
1034 failf(conn->data, "bind() failed; %s",
1035 Curl_strerror(conn, SOCKERRNO));
1036 return CURLE_COULDNT_CONNECT;
1038 conn->bits.bound = TRUE;
1041 Curl_pgrsStartNow(conn->data);
1048 /**********************************************************
1054 **********************************************************/
1055 static CURLcode tftp_done(struct connectdata *conn, CURLcode status,
1058 CURLcode result = CURLE_OK;
1059 tftp_state_data_t *state = (tftp_state_data_t *)conn->proto.tftpc;
1061 (void)status; /* unused */
1062 (void)premature; /* not used */
1064 if(Curl_pgrsDone(conn))
1065 return CURLE_ABORTED_BY_CALLBACK;
1067 /* If we have encountered an error */
1069 result = tftp_translate_code(state->error);
1074 /**********************************************************
1078 * The getsock callback
1080 **********************************************************/
1081 static int tftp_getsock(struct connectdata *conn, curl_socket_t *socks,
1085 return GETSOCK_BLANK;
1087 socks[0] = conn->sock[FIRSTSOCKET];
1089 return GETSOCK_READSOCK(0);
1092 /**********************************************************
1094 * tftp_receive_packet
1096 * Called once select fires and data is ready on the socket
1098 **********************************************************/
1099 static CURLcode tftp_receive_packet(struct connectdata *conn)
1101 struct Curl_sockaddr_storage fromaddr;
1102 curl_socklen_t fromlen;
1103 CURLcode result = CURLE_OK;
1104 struct Curl_easy *data = conn->data;
1105 tftp_state_data_t *state = (tftp_state_data_t *)conn->proto.tftpc;
1106 struct SingleRequest *k = &data->req;
1108 /* Receive the packet */
1109 fromlen = sizeof(fromaddr);
1110 state->rbytes = (int)recvfrom(state->sockfd,
1111 (void *)state->rpacket.data,
1114 (struct sockaddr *)&fromaddr,
1116 if(state->remote_addrlen == 0) {
1117 memcpy(&state->remote_addr, &fromaddr, fromlen);
1118 state->remote_addrlen = fromlen;
1121 /* Sanity check packet length */
1122 if(state->rbytes < 4) {
1123 failf(data, "Received too short packet");
1124 /* Not a timeout, but how best to handle it? */
1125 state->event = TFTP_EVENT_TIMEOUT;
1128 /* The event is given by the TFTP packet time */
1129 unsigned short event = getrpacketevent(&state->rpacket);
1130 state->event = (tftp_event_t)event;
1132 switch(state->event) {
1133 case TFTP_EVENT_DATA:
1134 /* Don't pass to the client empty or retransmitted packets */
1135 if(state->rbytes > 4 &&
1136 (NEXT_BLOCKNUM(state->block) == getrpacketblock(&state->rpacket))) {
1137 result = Curl_client_write(conn, CLIENTWRITE_BODY,
1138 (char *)state->rpacket.data + 4,
1141 tftp_state_machine(state, TFTP_EVENT_ERROR);
1144 k->bytecount += state->rbytes-4;
1145 Curl_pgrsSetDownloadCounter(data, (curl_off_t) k->bytecount);
1148 case TFTP_EVENT_ERROR:
1150 unsigned short error = getrpacketblock(&state->rpacket);
1151 state->error = (tftp_error_t)error;
1152 infof(data, "%s\n", (const char *)state->rpacket.data + 4);
1155 case TFTP_EVENT_ACK:
1157 case TFTP_EVENT_OACK:
1158 result = tftp_parse_option_ack(state,
1159 (const char *)state->rpacket.data + 2,
1164 case TFTP_EVENT_RRQ:
1165 case TFTP_EVENT_WRQ:
1167 failf(data, "%s", "Internal error: Unexpected packet");
1171 /* Update the progress meter */
1172 if(Curl_pgrsUpdate(conn)) {
1173 tftp_state_machine(state, TFTP_EVENT_ERROR);
1174 return CURLE_ABORTED_BY_CALLBACK;
1180 /**********************************************************
1182 * tftp_state_timeout
1184 * Check if timeouts have been reached
1186 **********************************************************/
1187 static long tftp_state_timeout(struct connectdata *conn, tftp_event_t *event)
1190 tftp_state_data_t *state = (tftp_state_data_t *)conn->proto.tftpc;
1193 *event = TFTP_EVENT_NONE;
1196 if(current > state->max_time) {
1197 DEBUGF(infof(conn->data, "timeout: %ld > %ld\n",
1198 (long)current, (long)state->max_time));
1199 state->error = TFTP_ERR_TIMEOUT;
1200 state->state = TFTP_STATE_FIN;
1203 if(current > state->rx_time + state->retry_time) {
1205 *event = TFTP_EVENT_TIMEOUT;
1206 time(&state->rx_time); /* update even though we received nothing */
1209 /* there's a typecast below here since 'time_t' may in fact be larger than
1210 'long', but we estimate that a 'long' will still be able to hold number
1211 of seconds even if "only" 32 bit */
1212 return (long)(state->max_time - current);
1215 /**********************************************************
1217 * tftp_multi_statemach
1219 * Handle single RX socket event and return
1221 **********************************************************/
1222 static CURLcode tftp_multi_statemach(struct connectdata *conn, bool *done)
1226 CURLcode result = CURLE_OK;
1227 struct Curl_easy *data = conn->data;
1228 tftp_state_data_t *state = (tftp_state_data_t *)conn->proto.tftpc;
1229 long timeout_ms = tftp_state_timeout(conn, &event);
1233 if(timeout_ms <= 0) {
1234 failf(data, "TFTP response timeout");
1235 return CURLE_OPERATION_TIMEDOUT;
1237 if(event != TFTP_EVENT_NONE) {
1238 result = tftp_state_machine(state, event);
1241 *done = (state->state == TFTP_STATE_FIN) ? TRUE : FALSE;
1243 /* Tell curl we're done */
1244 Curl_setup_transfer(conn, -1, -1, FALSE, NULL, -1, NULL);
1247 /* no timeouts to handle, check our socket */
1248 rc = SOCKET_READABLE(state->sockfd, 0);
1252 int error = SOCKERRNO;
1253 failf(data, "%s", Curl_strerror(conn, error));
1254 state->event = TFTP_EVENT_ERROR;
1257 result = tftp_receive_packet(conn);
1260 result = tftp_state_machine(state, state->event);
1263 *done = (state->state == TFTP_STATE_FIN) ? TRUE : FALSE;
1265 /* Tell curl we're done */
1266 Curl_setup_transfer(conn, -1, -1, FALSE, NULL, -1, NULL);
1268 /* if rc == 0, then select() timed out */
1274 /**********************************************************
1278 * Called from multi.c while DOing
1280 **********************************************************/
1281 static CURLcode tftp_doing(struct connectdata *conn, bool *dophase_done)
1284 result = tftp_multi_statemach(conn, dophase_done);
1287 DEBUGF(infof(conn->data, "DO phase is complete\n"));
1290 /* The multi code doesn't have this logic for the DOING state so we
1291 provide it for TFTP since it may do the entire transfer in this
1293 if(Curl_pgrsUpdate(conn))
1294 result = CURLE_ABORTED_BY_CALLBACK;
1296 result = Curl_speedcheck(conn->data, Curl_now());
1301 /**********************************************************
1305 * Entry point for transfer from tftp_do, sarts state mach
1307 **********************************************************/
1308 static CURLcode tftp_perform(struct connectdata *conn, bool *dophase_done)
1310 CURLcode result = CURLE_OK;
1311 tftp_state_data_t *state = (tftp_state_data_t *)conn->proto.tftpc;
1313 *dophase_done = FALSE;
1315 result = tftp_state_machine(state, TFTP_EVENT_INIT);
1317 if((state->state == TFTP_STATE_FIN) || result)
1320 tftp_multi_statemach(conn, dophase_done);
1323 DEBUGF(infof(conn->data, "DO phase is complete\n"));
1329 /**********************************************************
1335 * This callback initiates the TFTP transfer
1337 **********************************************************/
1339 static CURLcode tftp_do(struct connectdata *conn, bool *done)
1341 tftp_state_data_t *state;
1346 if(!conn->proto.tftpc) {
1347 result = tftp_connect(conn, done);
1352 state = (tftp_state_data_t *)conn->proto.tftpc;
1354 return CURLE_TFTP_ILLEGAL;
1356 result = tftp_perform(conn, done);
1358 /* If tftp_perform() returned an error, use that for return code. If it
1359 was OK, see if tftp_translate_code() has an error. */
1361 /* If we have encountered an internal tftp error, translate it. */
1362 result = tftp_translate_code(state->error);
1367 static CURLcode tftp_setup_connection(struct connectdata * conn)
1369 struct Curl_easy *data = conn->data;
1373 conn->socktype = SOCK_DGRAM; /* UDP datagram based */
1375 /* TFTP URLs support an extension like ";mode=<typecode>" that
1376 * we'll try to get now! */
1377 type = strstr(data->state.path, ";mode=");
1380 type = strstr(conn->host.rawalloc, ";mode=");
1383 *type = 0; /* it was in the middle of the hostname */
1384 command = Curl_raw_toupper(type[6]);
1387 case 'A': /* ASCII mode */
1388 case 'N': /* NETASCII mode */
1389 data->set.prefer_ascii = TRUE;
1392 case 'O': /* octet mode */
1393 case 'I': /* binary mode */
1395 /* switch off ASCII */
1396 data->set.prefer_ascii = FALSE;