1 /***************************************************************************
3 * Project ___| | | | _ \| |
5 * | (__| |_| | _ <| |___
6 * \___|\___/|_| \_\_____|
8 * Copyright (C) 1998 - 2010, 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 static CURLcode tftp_do(struct connectdata *conn, bool *done);
171 static CURLcode tftp_done(struct connectdata *conn,
172 CURLcode, bool premature);
173 static CURLcode tftp_setup_connection(struct connectdata * conn);
174 static CURLcode tftp_multi_statemach(struct connectdata *conn, bool *done);
175 static CURLcode tftp_doing(struct connectdata *conn, bool *dophase_done);
176 static int tftp_getsock(struct connectdata *conn, curl_socket_t *socks,
178 static CURLcode tftp_translate_code(tftp_error_t error);
182 * TFTP protocol handler.
185 const struct Curl_handler Curl_handler_tftp = {
187 tftp_setup_connection, /* setup_connection */
189 tftp_done, /* done */
190 ZERO_NULL, /* do_more */
191 tftp_connect, /* connect_it */
192 tftp_multi_statemach, /* connecting */
193 tftp_doing, /* doing */
194 tftp_getsock, /* proto_getsock */
195 tftp_getsock, /* doing_getsock */
196 ZERO_NULL, /* perform_getsock */
197 tftp_disconnect, /* disconnect */
198 PORT_TFTP, /* defport */
199 PROT_TFTP /* protocol */
202 /**********************************************************
204 * tftp_set_timeouts -
206 * Set timeouts based on state machine state.
207 * Use user provided connect timeouts until DATA or ACK
208 * packet is received, then use user-provided transfer timeouts
211 **********************************************************/
212 static CURLcode tftp_set_timeouts(tftp_state_data_t *state)
214 time_t maxtime, timeout;
216 bool start = (bool)(state->state == TFTP_STATE_START);
218 time(&state->start_time);
220 /* Compute drop-dead time */
221 timeout_ms = Curl_timeleft(state->conn, NULL, start);
224 /* time-out, bail out, go home */
225 failf(state->conn->data, "Connection time-out");
226 return CURLE_OPERATION_TIMEDOUT;
231 maxtime = (time_t)(timeout_ms + 500) / 1000;
232 state->max_time = state->start_time+maxtime;
234 /* Set per-block timeout to total */
237 /* Average restart after 5 seconds */
238 state->retry_max = (int)timeout/5;
240 if(state->retry_max < 1)
241 /* avoid division by zero below */
242 state->retry_max = 1;
244 /* Compute the re-start interval to suit the timeout */
245 state->retry_time = (int)timeout/state->retry_max;
246 if(state->retry_time<1)
252 maxtime = (time_t)(timeout_ms + 500) / 1000;
256 state->max_time = state->start_time+maxtime;
258 /* Set per-block timeout to 10% of total */
259 timeout = maxtime/10 ;
261 /* Average reposting an ACK after 15 seconds */
262 state->retry_max = (int)timeout/15;
264 /* But bound the total number */
265 if(state->retry_max<3)
268 if(state->retry_max>50)
271 /* Compute the re-ACK interval to suit the timeout */
272 state->retry_time = (int)(timeout/state->retry_max);
273 if(state->retry_time<1)
276 infof(state->conn->data,
277 "set timeouts for state %d; Total %ld, retry %d maxtry %d\n",
278 (int)state->state, (long)(state->max_time-state->start_time),
279 state->retry_time, state->retry_max);
282 time(&state->rx_time);
287 /**********************************************************
289 * tftp_set_send_first
291 * Event handler for the START state
293 **********************************************************/
295 static void setpacketevent(tftp_packet_t *packet, unsigned short num)
297 packet->data[0] = (unsigned char)(num >> 8);
298 packet->data[1] = (unsigned char)(num & 0xff);
302 static void setpacketblock(tftp_packet_t *packet, unsigned short num)
304 packet->data[2] = (unsigned char)(num >> 8);
305 packet->data[3] = (unsigned char)(num & 0xff);
308 static unsigned short getrpacketevent(const tftp_packet_t *packet)
310 return (unsigned short)((packet->data[0] << 8) | packet->data[1]);
313 static unsigned short getrpacketblock(const tftp_packet_t *packet)
315 return (unsigned short)((packet->data[2] << 8) | packet->data[3]);
318 static size_t Curl_strnlen(const char *string, size_t maxlen)
320 const char *end = memchr (string, '\0', maxlen);
321 return end ? (size_t) (end - string) : maxlen;
324 static const char *tftp_option_get(const char *buf, size_t len,
325 const char **option, const char **value)
329 loc = Curl_strnlen( buf, len );
330 loc++; /* NULL term */
336 loc += Curl_strnlen( buf+loc, len-loc );
337 loc++; /* NULL term */
341 *value = &buf[strlen(*option) + 1];
346 static CURLcode tftp_parse_option_ack(tftp_state_data_t *state,
347 const char *ptr, int len)
349 const char *tmp = ptr;
350 struct SessionHandle *data = state->conn->data;
352 /* if OACK doesn't contain blksize option, the default (512) must be used */
353 state->blksize = TFTP_BLKSIZE_DEFAULT;
355 while (tmp < ptr + len) {
356 const char *option, *value;
358 tmp = tftp_option_get(tmp, ptr + len - tmp, &option, &value);
360 failf(data, "Malformed ACK packet, rejecting");
361 return CURLE_TFTP_ILLEGAL;
364 infof(data, "got option=(%s) value=(%s)\n", option, value);
366 if(checkprefix(option, TFTP_OPTION_BLKSIZE)) {
369 blksize = strtol( value, NULL, 10 );
372 failf(data, "invalid blocksize value in OACK packet");
373 return CURLE_TFTP_ILLEGAL;
375 else if(blksize > TFTP_BLKSIZE_MAX) {
376 failf(data, "%s (%d)", "blksize is larger than max supported",
378 return CURLE_TFTP_ILLEGAL;
380 else if(blksize < TFTP_BLKSIZE_MIN) {
381 failf(data, "%s (%d)", "blksize is smaller than min supported",
383 return CURLE_TFTP_ILLEGAL;
385 else if (blksize > state->requested_blksize) {
386 /* could realloc pkt buffers here, but the spec doesn't call out
387 * support for the server requesting a bigger blksize than the client
389 failf(data, "%s (%ld)",
390 "server requested blksize larger than allocated", blksize);
391 return CURLE_TFTP_ILLEGAL;
394 state->blksize = (int)blksize;
395 infof(data, "%s (%d) %s (%d)\n", "blksize parsed from OACK",
396 state->blksize, "requested", state->requested_blksize);
398 else if(checkprefix(option, TFTP_OPTION_TSIZE)) {
401 tsize = strtol( value, NULL, 10 );
402 infof(data, "%s (%ld)\n", "tsize parsed from OACK", tsize);
404 /* tsize should be ignored on upload: Who cares about the size of the
406 if (!data->set.upload) {
408 failf(data, "invalid tsize -:%s:- value in OACK packet", value);
409 return CURLE_TFTP_ILLEGAL;
411 Curl_pgrsSetDownloadSize(data, tsize);
419 static size_t tftp_option_add(tftp_state_data_t *state, size_t csize,
420 char *buf, const char *option)
422 if( ( strlen(option) + csize + 1 ) > (size_t)state->blksize )
425 return( strlen(option) + 1 );
428 static CURLcode tftp_connect_for_tx(tftp_state_data_t *state,
432 #ifndef CURL_DISABLE_VERBOSE_STRINGS
433 struct SessionHandle *data = state->conn->data;
435 infof(data, "%s\n", "Connected for transmit");
437 state->state = TFTP_STATE_TX;
438 res = tftp_set_timeouts(state);
441 return tftp_tx(state, event);
444 static CURLcode tftp_connect_for_rx(tftp_state_data_t *state,
448 #ifndef CURL_DISABLE_VERBOSE_STRINGS
449 struct SessionHandle *data = state->conn->data;
451 infof(data, "%s\n", "Connected for receive");
453 state->state = TFTP_STATE_RX;
454 res = tftp_set_timeouts(state);
457 return tftp_rx(state, event);
460 static CURLcode tftp_send_first(tftp_state_data_t *state, tftp_event_t event)
464 const char *mode = "octet";
467 struct SessionHandle *data = state->conn->data;
468 CURLcode res = CURLE_OK;
470 /* Set ascii mode if -B flag was used */
471 if(data->set.prefer_ascii)
476 case TFTP_EVENT_INIT: /* Send the first packet out */
477 case TFTP_EVENT_TIMEOUT: /* Resend the first packet out */
478 /* Increment the retry counter, quit if over the limit */
480 if(state->retries>state->retry_max) {
481 state->error = TFTP_ERR_NORESPONSE;
482 state->state = TFTP_STATE_FIN;
486 if(data->set.upload) {
487 /* If we are uploading, send an WRQ */
488 setpacketevent(&state->spacket, TFTP_EVENT_WRQ);
489 state->conn->data->req.upload_fromhere =
490 (char *)state->spacket.data+4;
491 if(data->set.infilesize != -1)
492 Curl_pgrsSetUploadSize(data, data->set.infilesize);
495 /* If we are downloading, send an RRQ */
496 setpacketevent(&state->spacket, TFTP_EVENT_RRQ);
498 /* As RFC3617 describes the separator slash is not actually part of the
499 file name so we skip the always-present first letter of the path
501 filename = curl_easy_unescape(data, &state->conn->data->state.path[1], 0,
504 return CURLE_OUT_OF_MEMORY;
506 snprintf((char *)state->spacket.data+2,
508 "%s%c%s%c", filename, '\0', mode, '\0');
509 sbytes = 4 + strlen(filename) + strlen(mode);
511 /* add tsize option */
512 if(data->set.upload && (data->set.infilesize != -1))
513 snprintf( buf, sizeof(buf), "%" FORMAT_OFF_T, data->set.infilesize );
515 strcpy(buf, "0"); /* the destination is large enough */
517 sbytes += tftp_option_add(state, sbytes,
518 (char *)state->spacket.data+sbytes,
520 sbytes += tftp_option_add(state, sbytes,
521 (char *)state->spacket.data+sbytes, buf);
522 /* add blksize option */
523 snprintf( buf, sizeof(buf), "%d", state->requested_blksize );
524 sbytes += tftp_option_add(state, sbytes,
525 (char *)state->spacket.data+sbytes,
526 TFTP_OPTION_BLKSIZE);
527 sbytes += tftp_option_add(state, sbytes,
528 (char *)state->spacket.data+sbytes, buf );
530 /* add timeout option */
531 snprintf( buf, sizeof(buf), "%d", state->retry_time);
532 sbytes += tftp_option_add(state, sbytes,
533 (char *)state->spacket.data+sbytes,
534 TFTP_OPTION_INTERVAL);
535 sbytes += tftp_option_add(state, sbytes,
536 (char *)state->spacket.data+sbytes, buf );
538 /* the typecase for the 3rd argument is mostly for systems that do
539 not have a size_t argument, like older unixes that want an 'int' */
540 senddata = sendto(state->sockfd, (void *)state->spacket.data,
541 (SEND_TYPE_ARG3)sbytes, 0,
542 state->conn->ip_addr->ai_addr,
543 state->conn->ip_addr->ai_addrlen);
544 if(senddata != (ssize_t)sbytes) {
545 failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
547 Curl_safefree(filename);
550 case TFTP_EVENT_OACK:
551 if(data->set.upload) {
552 res = tftp_connect_for_tx(state, event);
555 res = tftp_connect_for_rx(state, event);
559 case TFTP_EVENT_ACK: /* Connected for transmit */
560 res = tftp_connect_for_tx(state, event);
563 case TFTP_EVENT_DATA: /* Connected for receive */
564 res = tftp_connect_for_rx(state, event);
567 case TFTP_EVENT_ERROR:
568 state->state = TFTP_STATE_FIN;
572 failf(state->conn->data, "tftp_send_first: internal error");
578 /* the next blocknum is x + 1 but it needs to wrap at an unsigned 16bit
580 #define NEXT_BLOCKNUM(x) (((x)+1)&0xffff)
582 /**********************************************************
586 * Event handler for the RX state
588 **********************************************************/
589 static CURLcode tftp_rx(tftp_state_data_t *state, tftp_event_t event)
593 struct SessionHandle *data = state->conn->data;
597 case TFTP_EVENT_DATA:
598 /* Is this the block we expect? */
599 rblock = getrpacketblock(&state->rpacket);
600 if(NEXT_BLOCKNUM(state->block) != rblock) {
601 /* No, log it, up the retry count and fail if over the limit */
603 "Received unexpected DATA packet block %d\n", rblock);
605 if(state->retries > state->retry_max) {
606 failf(data, "tftp_rx: giving up waiting for block %d",
607 NEXT_BLOCKNUM(state->block));
608 return CURLE_TFTP_ILLEGAL;
612 /* This is the expected block. Reset counters and ACK it. */
613 state->block = (unsigned short)rblock;
615 setpacketevent(&state->spacket, TFTP_EVENT_ACK);
616 setpacketblock(&state->spacket, state->block);
617 sbytes = sendto(state->sockfd, (void *)state->spacket.data,
619 (struct sockaddr *)&state->remote_addr,
620 state->remote_addrlen);
622 failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
623 return CURLE_SEND_ERROR;
626 /* Check if completed (That is, a less than full packet is received) */
627 if(state->rbytes < (ssize_t)state->blksize+4){
628 state->state = TFTP_STATE_FIN;
631 state->state = TFTP_STATE_RX;
633 time(&state->rx_time);
636 case TFTP_EVENT_OACK:
637 /* ACK option acknowledgement so we can move on to data */
640 setpacketevent(&state->spacket, TFTP_EVENT_ACK);
641 setpacketblock(&state->spacket, state->block);
642 sbytes = sendto(state->sockfd, (void *)state->spacket.data,
644 (struct sockaddr *)&state->remote_addr,
645 state->remote_addrlen);
647 failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
648 return CURLE_SEND_ERROR;
651 /* we're ready to RX data */
652 state->state = TFTP_STATE_RX;
653 time(&state->rx_time);
656 case TFTP_EVENT_TIMEOUT:
657 /* Increment the retry count and fail if over the limit */
660 "Timeout waiting for block %d ACK. Retries = %d\n",
661 NEXT_BLOCKNUM(state->block), state->retries);
662 if(state->retries > state->retry_max) {
663 state->error = TFTP_ERR_TIMEOUT;
664 state->state = TFTP_STATE_FIN;
667 /* Resend the previous ACK */
668 sbytes = sendto(state->sockfd, (void *)state->spacket.data,
670 (struct sockaddr *)&state->remote_addr,
671 state->remote_addrlen);
673 failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
674 return CURLE_SEND_ERROR;
679 case TFTP_EVENT_ERROR:
680 setpacketevent(&state->spacket, TFTP_EVENT_ERROR);
681 setpacketblock(&state->spacket, state->block);
682 (void)sendto(state->sockfd, (void *)state->spacket.data,
684 (struct sockaddr *)&state->remote_addr,
685 state->remote_addrlen);
686 /* don't bother with the return code, but if the socket is still up we
687 * should be a good TFTP client and let the server know we're done */
688 state->state = TFTP_STATE_FIN;
692 failf(data, "%s", "tftp_rx: internal error");
693 return CURLE_TFTP_ILLEGAL; /* not really the perfect return code for
699 /**********************************************************
703 * Event handler for the TX state
705 **********************************************************/
706 static CURLcode tftp_tx(tftp_state_data_t *state, tftp_event_t event)
708 struct SessionHandle *data = state->conn->data;
711 CURLcode res = CURLE_OK;
712 struct SingleRequest *k = &data->req;
717 case TFTP_EVENT_OACK:
718 if (event == TFTP_EVENT_ACK) {
720 rblock = getrpacketblock(&state->rpacket);
722 if(rblock != state->block) {
723 /* This isn't the expected block. Log it and up the retry counter */
724 infof(data, "Received ACK for block %d, expecting %d\n",
725 rblock, state->block);
727 /* Bail out if over the maximum */
728 if(state->retries>state->retry_max) {
729 failf(data, "tftp_tx: giving up waiting for block %d ack",
731 res = CURLE_SEND_ERROR;
734 /* Re-send the data packet */
735 sbytes = sendto(state->sockfd, (void *)&state->spacket,
736 4+state->sbytes, SEND_4TH_ARG,
737 (struct sockaddr *)&state->remote_addr,
738 state->remote_addrlen);
739 /* Check all sbytes were sent */
741 failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
742 res = CURLE_SEND_ERROR;
747 /* This is the expected packet. Reset the counters and send the next
749 time(&state->rx_time);
753 state->block = 1; /* first data block is 1 when using OACK */
756 setpacketevent(&state->spacket, TFTP_EVENT_DATA);
757 setpacketblock(&state->spacket, state->block);
758 if(state->block > 1 && state->sbytes < (int)state->blksize) {
759 state->state = TFTP_STATE_FIN;
762 res = Curl_fillreadbuffer(state->conn, state->blksize, &state->sbytes);
765 sbytes = sendto(state->sockfd, (void *)state->spacket.data,
766 4+state->sbytes, SEND_4TH_ARG,
767 (struct sockaddr *)&state->remote_addr,
768 state->remote_addrlen);
769 /* Check all sbytes were sent */
771 failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
772 return CURLE_SEND_ERROR;
774 /* Update the progress meter */
775 k->writebytecount += state->sbytes;
776 Curl_pgrsSetUploadCounter(data, k->writebytecount);
779 case TFTP_EVENT_TIMEOUT:
780 /* Increment the retry counter and log the timeout */
782 infof(data, "Timeout waiting for block %d ACK. "
783 " Retries = %d\n", NEXT_BLOCKNUM(state->block), state->retries);
784 /* Decide if we've had enough */
785 if(state->retries > state->retry_max) {
786 state->error = TFTP_ERR_TIMEOUT;
787 state->state = TFTP_STATE_FIN;
790 /* Re-send the data packet */
791 sbytes = sendto(state->sockfd, (void *)state->spacket.data,
792 4+state->sbytes, SEND_4TH_ARG,
793 (struct sockaddr *)&state->remote_addr,
794 state->remote_addrlen);
795 /* Check all sbytes were sent */
797 failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
798 return CURLE_SEND_ERROR;
800 /* since this was a re-send, we remain at the still byte position */
801 Curl_pgrsSetUploadCounter(data, k->writebytecount);
805 case TFTP_EVENT_ERROR:
806 state->state = TFTP_STATE_FIN;
807 setpacketevent(&state->spacket, TFTP_EVENT_ERROR);
808 setpacketblock(&state->spacket, state->block);
809 (void)sendto(state->sockfd, (void *)state->spacket.data, 4, SEND_4TH_ARG,
810 (struct sockaddr *)&state->remote_addr,
811 state->remote_addrlen);
812 /* don't bother with the return code, but if the socket is still up we
813 * should be a good TFTP client and let the server know we're done */
814 state->state = TFTP_STATE_FIN;
818 failf(data, "tftp_tx: internal error, event: %i", (int)(event));
825 /**********************************************************
827 * tftp_translate_code
829 * Translate internal error codes to CURL error codes
831 **********************************************************/
832 static CURLcode tftp_translate_code(tftp_error_t error)
834 CURLcode code = CURLE_OK;
836 if(error != TFTP_ERR_NONE) {
838 case TFTP_ERR_NOTFOUND:
839 code = CURLE_TFTP_NOTFOUND;
842 code = CURLE_TFTP_PERM;
844 case TFTP_ERR_DISKFULL:
845 code = CURLE_REMOTE_DISK_FULL;
848 case TFTP_ERR_ILLEGAL:
849 code = CURLE_TFTP_ILLEGAL;
851 case TFTP_ERR_UNKNOWNID:
852 code = CURLE_TFTP_UNKNOWNID;
854 case TFTP_ERR_EXISTS:
855 code = CURLE_REMOTE_FILE_EXISTS;
857 case TFTP_ERR_NOSUCHUSER:
858 code = CURLE_TFTP_NOSUCHUSER;
860 case TFTP_ERR_TIMEOUT:
861 code = CURLE_OPERATION_TIMEDOUT;
863 case TFTP_ERR_NORESPONSE:
864 code = CURLE_COULDNT_CONNECT;
867 code= CURLE_ABORTED_BY_CALLBACK;
878 /**********************************************************
882 * The tftp state machine event dispatcher
884 **********************************************************/
885 static CURLcode tftp_state_machine(tftp_state_data_t *state,
888 CURLcode res = CURLE_OK;
889 struct SessionHandle *data = state->conn->data;
890 switch(state->state) {
891 case TFTP_STATE_START:
892 DEBUGF(infof(data, "TFTP_STATE_START\n"));
893 res = tftp_send_first(state, event);
896 DEBUGF(infof(data, "TFTP_STATE_RX\n"));
897 res = tftp_rx(state, event);
900 DEBUGF(infof(data, "TFTP_STATE_TX\n"));
901 res = tftp_tx(state, event);
904 infof(data, "%s\n", "TFTP finished");
907 DEBUGF(infof(data, "STATE: %d\n", state->state));
908 failf(data, "%s", "Internal state machine error");
909 res = CURLE_TFTP_ILLEGAL;
915 /**********************************************************
919 * The disconnect callback
921 **********************************************************/
922 static CURLcode tftp_disconnect(struct connectdata *conn)
924 tftp_state_data_t *state = conn->proto.tftpc;
926 /* done, free dynamically allocated pkt buffers */
928 Curl_safefree(state->rpacket.data);
929 Curl_safefree(state->spacket.data);
936 /**********************************************************
940 * The connect callback
942 **********************************************************/
943 static CURLcode tftp_connect(struct connectdata *conn, bool *done)
946 tftp_state_data_t *state;
949 blksize = TFTP_BLKSIZE_DEFAULT;
951 /* If there already is a protocol-specific struct allocated for this
952 sessionhandle, deal with it */
953 Curl_reset_reqproto(conn);
955 state = conn->proto.tftpc = calloc(1, sizeof(tftp_state_data_t));
957 return CURLE_OUT_OF_MEMORY;
959 /* alloc pkt buffers based on specified blksize */
960 if(conn->data->set.tftp_blksize) {
961 blksize = (int)conn->data->set.tftp_blksize;
962 if(blksize > TFTP_BLKSIZE_MAX || blksize < TFTP_BLKSIZE_MIN )
963 return CURLE_TFTP_ILLEGAL;
966 if(!state->rpacket.data) {
967 state->rpacket.data = calloc(1, blksize + 2 + 2);
969 if(!state->rpacket.data)
970 return CURLE_OUT_OF_MEMORY;
973 if(!state->spacket.data) {
974 state->spacket.data = calloc(1, blksize + 2 + 2);
976 if(!state->spacket.data)
977 return CURLE_OUT_OF_MEMORY;
980 conn->bits.close = TRUE; /* we don't keep TFTP connections up bascially
981 because there's none or very little gain for UDP
985 state->sockfd = state->conn->sock[FIRSTSOCKET];
986 state->state = TFTP_STATE_START;
987 state->error = TFTP_ERR_NONE;
988 state->blksize = TFTP_BLKSIZE_DEFAULT;
989 state->requested_blksize = blksize;
991 ((struct sockaddr *)&state->local_addr)->sa_family =
992 (unsigned short)(conn->ip_addr->ai_family);
994 tftp_set_timeouts(state);
996 if(!conn->bits.bound) {
997 /* If not already bound, bind to any interface, random UDP port. If it is
998 * reused or a custom local port was desired, this has already been done!
1000 * We once used the size of the local_addr struct as the third argument
1001 * for bind() to better work with IPv6 or whatever size the struct could
1002 * have, but we learned that at least Tru64, AIX and IRIX *requires* the
1003 * size of that argument to match the exact size of a 'sockaddr_in' struct
1004 * when running IPv4-only.
1006 * Therefore we use the size from the address we connected to, which we
1007 * assume uses the same IP version and thus hopefully this works for both
1010 rc = bind(state->sockfd, (struct sockaddr *)&state->local_addr,
1011 conn->ip_addr->ai_addrlen);
1013 failf(conn->data, "bind() failed; %s",
1014 Curl_strerror(conn, SOCKERRNO));
1015 return CURLE_COULDNT_CONNECT;
1017 conn->bits.bound = TRUE;
1020 Curl_pgrsStartNow(conn->data);
1027 /**********************************************************
1033 **********************************************************/
1034 static CURLcode tftp_done(struct connectdata *conn, CURLcode status,
1037 CURLcode code = CURLE_OK;
1038 tftp_state_data_t *state = (tftp_state_data_t *)conn->proto.tftpc;
1040 (void)status; /* unused */
1041 (void)premature; /* not used */
1043 Curl_pgrsDone(conn);
1045 /* If we have encountered an error */
1046 code = tftp_translate_code(state->error);
1051 /**********************************************************
1055 * The getsock callback
1057 **********************************************************/
1058 static int tftp_getsock(struct connectdata *conn, curl_socket_t *socks,
1062 return GETSOCK_BLANK;
1064 socks[0] = conn->sock[FIRSTSOCKET];
1066 return GETSOCK_READSOCK(0);
1069 /**********************************************************
1071 * tftp_receive_packet
1073 * Called once select fires and data is ready on the socket
1075 **********************************************************/
1076 static CURLcode tftp_receive_packet(struct connectdata *conn)
1078 struct Curl_sockaddr_storage fromaddr;
1079 curl_socklen_t fromlen;
1080 CURLcode result = CURLE_OK;
1081 struct SessionHandle *data = conn->data;
1082 tftp_state_data_t *state = (tftp_state_data_t *)conn->proto.tftpc;
1083 struct SingleRequest *k = &data->req;
1085 /* Receive the packet */
1086 fromlen = sizeof(fromaddr);
1087 state->rbytes = (int)recvfrom(state->sockfd,
1088 (void *)state->rpacket.data,
1091 (struct sockaddr *)&fromaddr,
1093 if(state->remote_addrlen==0) {
1094 memcpy(&state->remote_addr, &fromaddr, fromlen);
1095 state->remote_addrlen = fromlen;
1098 /* Sanity check packet length */
1099 if(state->rbytes < 4) {
1100 failf(data, "Received too short packet");
1101 /* Not a timeout, but how best to handle it? */
1102 state->event = TFTP_EVENT_TIMEOUT;
1105 /* The event is given by the TFTP packet time */
1106 state->event = (tftp_event_t)getrpacketevent(&state->rpacket);
1108 switch(state->event) {
1109 case TFTP_EVENT_DATA:
1110 /* Don't pass to the client empty or retransmitted packets */
1111 if(state->rbytes > 4 &&
1112 (NEXT_BLOCKNUM(state->block) == getrpacketblock(&state->rpacket))) {
1113 result = Curl_client_write(conn, CLIENTWRITE_BODY,
1114 (char *)state->rpacket.data+4,
1117 tftp_state_machine(state, TFTP_EVENT_ERROR);
1120 k->bytecount += state->rbytes-4;
1121 Curl_pgrsSetDownloadCounter(data, (curl_off_t) k->bytecount);
1124 case TFTP_EVENT_ERROR:
1125 state->error = (tftp_error_t)getrpacketblock(&state->rpacket);
1126 infof(data, "%s\n", (const char *)state->rpacket.data+4);
1128 case TFTP_EVENT_ACK:
1130 case TFTP_EVENT_OACK:
1131 result = tftp_parse_option_ack(state,
1132 (const char *)state->rpacket.data+2,
1137 case TFTP_EVENT_RRQ:
1138 case TFTP_EVENT_WRQ:
1140 failf(data, "%s", "Internal error: Unexpected packet");
1144 /* Update the progress meter */
1145 if(Curl_pgrsUpdate(conn)) {
1146 tftp_state_machine(state, TFTP_EVENT_ERROR);
1147 return CURLE_ABORTED_BY_CALLBACK;
1153 /**********************************************************
1155 * tftp_state_timeout
1157 * Check if timeouts have been reached
1159 **********************************************************/
1160 static long tftp_state_timeout(struct connectdata *conn, tftp_event_t *event)
1163 tftp_state_data_t *state = (tftp_state_data_t *)conn->proto.tftpc;
1166 *event = TFTP_EVENT_NONE;
1169 if(current > state->max_time) {
1170 DEBUGF(infof(conn->data, "timeout: %ld > %ld\n",
1171 (long)current, (long)state->max_time));
1172 state->error = TFTP_ERR_TIMEOUT;
1173 state->state = TFTP_STATE_FIN;
1176 else if (current > state->rx_time+state->retry_time) {
1178 *event = TFTP_EVENT_TIMEOUT;
1179 time(&state->rx_time); /* update even though we received nothing */
1182 /* there's a typecast below here since 'time_t' may in fact be larger than
1183 'long', but we estimate that a 'long' will still be able to hold number
1184 of seconds even if "only" 32 bit */
1185 return (long)(state->max_time - current);
1189 /**********************************************************
1191 * tftp_easy_statemach
1193 * Handle easy request until completion
1195 **********************************************************/
1196 static CURLcode tftp_easy_statemach(struct connectdata *conn)
1200 CURLcode result = CURLE_OK;
1201 struct SessionHandle *data = conn->data;
1202 tftp_state_data_t *state = (tftp_state_data_t *)conn->proto.tftpc;
1203 curl_socket_t fd_read;
1205 struct SingleRequest *k = &data->req;
1206 struct timeval transaction_start = Curl_tvnow();
1208 k->start = transaction_start;
1209 k->now = transaction_start;
1211 /* Run the TFTP State Machine */
1212 for(; (state->state != TFTP_STATE_FIN) && (result == CURLE_OK); ) {
1214 timeout_ms = state->retry_time * 1000;
1216 if (data->set.upload) {
1217 if (data->set.max_send_speed &&
1218 (data->progress.ulspeed > data->set.max_send_speed)) {
1219 fd_read = CURL_SOCKET_BAD;
1220 timeout_ms = Curl_sleep_time(data->set.max_send_speed,
1221 data->progress.ulspeed, state->blksize);
1224 fd_read = state->sockfd;
1228 if (data->set.max_recv_speed &&
1229 (data->progress.dlspeed > data->set.max_recv_speed)) {
1230 fd_read = CURL_SOCKET_BAD;
1231 timeout_ms = Curl_sleep_time(data->set.max_recv_speed,
1232 data->progress.dlspeed, state->blksize);
1235 fd_read = state->sockfd;
1239 if(data->set.timeout) {
1240 timeout_ms = data->set.timeout - Curl_tvdiff(k->now, k->start);
1241 if (timeout_ms > state->retry_time * 1000)
1242 timeout_ms = state->retry_time * 1000;
1243 else if(timeout_ms < 0)
1248 /* Wait until ready to read or timeout occurs */
1249 rc = Curl_socket_ready(fd_read, CURL_SOCKET_BAD, (int)(timeout_ms));
1251 k->now = Curl_tvnow();
1253 /* Force a progress callback if it's been too long */
1254 if (Curl_tvdiff(k->now, k->start) >= data->set.timeout) {
1255 if(Curl_pgrsUpdate(conn)) {
1256 tftp_state_machine(state, TFTP_EVENT_ERROR);
1257 return CURLE_ABORTED_BY_CALLBACK;
1264 int error = SOCKERRNO;
1265 failf(data, "%s", Curl_strerror(conn, error));
1266 state->event = TFTP_EVENT_ERROR;
1271 /* A timeout occured, but our timeout is variable, so maybe
1273 long rtms = state->retry_time * 1000;
1274 if (Curl_tvdiff(k->now, transaction_start) > rtms) {
1275 state->event = TFTP_EVENT_TIMEOUT;
1276 /* Force a look at transfer timeouts */
1280 continue; /* skip state machine */
1284 result = tftp_receive_packet(conn);
1285 if (result == CURLE_OK)
1286 transaction_start = Curl_tvnow();
1289 *k->bytecountp = k->bytecount; /* read count */
1290 if(k->writebytecountp)
1291 *k->writebytecountp = k->writebytecount; /* write count */
1296 tftp_state_timeout(conn, NULL);
1303 result = tftp_state_machine(state, state->event);
1306 /* Tell curl we're done */
1307 Curl_setup_transfer(conn, -1, -1, FALSE, NULL, -1, NULL);
1312 /**********************************************************
1314 * tftp_multi_statemach
1316 * Handle single RX socket event and return
1318 **********************************************************/
1319 static CURLcode tftp_multi_statemach(struct connectdata *conn, bool *done)
1323 CURLcode result = CURLE_OK;
1324 struct SessionHandle *data = conn->data;
1325 tftp_state_data_t *state = (tftp_state_data_t *)conn->proto.tftpc;
1326 long timeout_ms = tftp_state_timeout(conn, &event);
1330 if(timeout_ms <= 0) {
1331 failf(data, "TFTP response timeout");
1332 return CURLE_OPERATION_TIMEDOUT;
1334 else if (event != TFTP_EVENT_NONE) {
1335 result = tftp_state_machine(state, event);
1336 if(result != CURLE_OK)
1338 *done = (bool)(state->state == TFTP_STATE_FIN);
1340 /* Tell curl we're done */
1341 Curl_setup_transfer(conn, -1, -1, FALSE, NULL, -1, NULL);
1344 /* no timeouts to handle, check our socket */
1345 rc = Curl_socket_ready(state->sockfd, CURL_SOCKET_BAD, 0);
1349 int error = SOCKERRNO;
1350 failf(data, "%s", Curl_strerror(conn, error));
1351 state->event = TFTP_EVENT_ERROR;
1354 result = tftp_receive_packet(conn);
1355 if(result != CURLE_OK)
1357 result = tftp_state_machine(state, state->event);
1358 if(result != CURLE_OK)
1360 *done = (bool)(state->state == TFTP_STATE_FIN);
1362 /* Tell curl we're done */
1363 Curl_setup_transfer(conn, -1, -1, FALSE, NULL, -1, NULL);
1365 /* if rc == 0, then select() timed out */
1371 /**********************************************************
1375 * Called from multi.c while DOing
1377 **********************************************************/
1378 static CURLcode tftp_doing(struct connectdata *conn, bool *dophase_done)
1381 result = tftp_multi_statemach(conn, dophase_done);
1384 DEBUGF(infof(conn->data, "DO phase is complete\n"));
1389 /**********************************************************
1393 * Entry point for transfer from tftp_do, sarts state mach
1395 **********************************************************/
1396 static CURLcode tftp_perform(struct connectdata *conn, bool *dophase_done)
1398 CURLcode result = CURLE_OK;
1399 tftp_state_data_t *state = (tftp_state_data_t *)conn->proto.tftpc;
1401 *dophase_done = FALSE;
1403 result = tftp_state_machine(state, TFTP_EVENT_INIT);
1405 if(state->state == TFTP_STATE_FIN || result != CURLE_OK)
1408 if(conn->data->state.used_interface == Curl_if_multi)
1409 tftp_multi_statemach(conn, dophase_done);
1411 result = tftp_easy_statemach(conn);
1412 *dophase_done = TRUE; /* with the easy interface we are done here */
1416 DEBUGF(infof(conn->data, "DO phase is complete\n"));
1422 /**********************************************************
1428 * This callback initiates the TFTP transfer
1430 **********************************************************/
1432 static CURLcode tftp_do(struct connectdata *conn, bool *done)
1434 tftp_state_data_t *state;
1440 Since connections can be re-used between SessionHandles, this might be a
1441 connection already existing but on a fresh SessionHandle struct so we must
1442 make sure we have a good 'struct TFTP' to play with. For new connections,
1443 the struct TFTP is allocated and setup in the tftp_connect() function.
1445 Curl_reset_reqproto(conn);
1447 if(!conn->proto.tftpc) {
1448 code = tftp_connect(conn, done);
1452 state = (tftp_state_data_t *)conn->proto.tftpc;
1454 code = tftp_perform(conn, done);
1456 /* If tftp_perform() returned an error, use that for return code. If it
1457 was OK, see if tftp_translate_code() has an error. */
1458 if (code == CURLE_OK)
1459 /* If we have encountered an internal tftp error, translate it. */
1460 code = tftp_translate_code(state->error);
1465 static CURLcode tftp_setup_connection(struct connectdata * conn)
1467 struct SessionHandle *data = conn->data;
1471 conn->socktype = SOCK_DGRAM; /* UDP datagram based */
1473 /* TFTP URLs support an extension like ";mode=<typecode>" that
1474 * we'll try to get now! */
1475 type = strstr(data->state.path, ";mode=");
1478 type = strstr(conn->host.rawalloc, ";mode=");
1481 *type = 0; /* it was in the middle of the hostname */
1482 command = Curl_raw_toupper(type[6]);
1485 case 'A': /* ASCII mode */
1486 case 'N': /* NETASCII mode */
1487 data->set.prefer_ascii = TRUE;
1490 case 'O': /* octet mode */
1491 case 'I': /* binary mode */
1493 /* switch off ASCII */
1494 data->set.prefer_ascii = FALSE;