tftp: use the current blksize for recvfrom()
[platform/upstream/curl.git] / lib / tftp.c
1 /***************************************************************************
2  *                                  _   _ ____  _
3  *  Project                     ___| | | |  _ \| |
4  *                             / __| | | | |_) | |
5  *                            | (__| |_| |  _ <| |___
6  *                             \___|\___/|_| \_\_____|
7  *
8  * Copyright (C) 1998 - 2018, Daniel Stenberg, <daniel@haxx.se>, et al.
9  *
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.
13  *
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.
17  *
18  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19  * KIND, either express or implied.
20  *
21  ***************************************************************************/
22
23 #include "curl_setup.h"
24
25 #ifndef CURL_DISABLE_TFTP
26
27 #ifdef HAVE_NETINET_IN_H
28 #include <netinet/in.h>
29 #endif
30 #ifdef HAVE_NETDB_H
31 #include <netdb.h>
32 #endif
33 #ifdef HAVE_ARPA_INET_H
34 #include <arpa/inet.h>
35 #endif
36 #ifdef HAVE_NET_IF_H
37 #include <net/if.h>
38 #endif
39 #ifdef HAVE_SYS_IOCTL_H
40 #include <sys/ioctl.h>
41 #endif
42
43 #ifdef HAVE_SYS_PARAM_H
44 #include <sys/param.h>
45 #endif
46
47 #include "urldata.h"
48 #include <curl/curl.h>
49 #include "transfer.h"
50 #include "sendf.h"
51 #include "tftp.h"
52 #include "progress.h"
53 #include "connect.h"
54 #include "strerror.h"
55 #include "sockaddr.h" /* required for Curl_sockaddr_storage */
56 #include "multiif.h"
57 #include "url.h"
58 #include "strcase.h"
59 #include "speedcheck.h"
60 #include "select.h"
61 #include "escape.h"
62
63 /* The last 3 #include files should be in this order */
64 #include "curl_printf.h"
65 #include "curl_memory.h"
66 #include "memdebug.h"
67
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"
73
74 /* from RFC2349: */
75 #define TFTP_OPTION_TSIZE    "tsize"
76 #define TFTP_OPTION_INTERVAL "timeout"
77
78 typedef enum {
79   TFTP_MODE_NETASCII = 0,
80   TFTP_MODE_OCTET
81 } tftp_mode_t;
82
83 typedef enum {
84   TFTP_STATE_START = 0,
85   TFTP_STATE_RX,
86   TFTP_STATE_TX,
87   TFTP_STATE_FIN
88 } tftp_state_t;
89
90 typedef enum {
91   TFTP_EVENT_NONE = -1,
92   TFTP_EVENT_INIT = 0,
93   TFTP_EVENT_RRQ = 1,
94   TFTP_EVENT_WRQ = 2,
95   TFTP_EVENT_DATA = 3,
96   TFTP_EVENT_ACK = 4,
97   TFTP_EVENT_ERROR = 5,
98   TFTP_EVENT_OACK = 6,
99   TFTP_EVENT_TIMEOUT
100 } tftp_event_t;
101
102 typedef enum {
103   TFTP_ERR_UNDEF = 0,
104   TFTP_ERR_NOTFOUND,
105   TFTP_ERR_PERM,
106   TFTP_ERR_DISKFULL,
107   TFTP_ERR_ILLEGAL,
108   TFTP_ERR_UNKNOWNID,
109   TFTP_ERR_EXISTS,
110   TFTP_ERR_NOSUCHUSER,  /* This will never be triggered by this code */
111
112   /* The remaining error codes are internal to curl */
113   TFTP_ERR_NONE = -100,
114   TFTP_ERR_TIMEOUT,
115   TFTP_ERR_NORESPONSE
116 } tftp_error_t;
117
118 typedef struct tftp_packet {
119   unsigned char *data;
120 } tftp_packet_t;
121
122 typedef struct tftp_state_data {
123   tftp_state_t    state;
124   tftp_mode_t     mode;
125   tftp_error_t    error;
126   tftp_event_t    event;
127   struct connectdata      *conn;
128   curl_socket_t   sockfd;
129   int             retries;
130   int             retry_time;
131   int             retry_max;
132   time_t          start_time;
133   time_t          max_time;
134   time_t          rx_time;
135   unsigned short  block;
136   struct Curl_sockaddr_storage   local_addr;
137   struct Curl_sockaddr_storage   remote_addr;
138   curl_socklen_t  remote_addrlen;
139   int             rbytes;
140   int             sbytes;
141   int             blksize;
142   int             requested_blksize;
143   tftp_packet_t   rpacket;
144   tftp_packet_t   spacket;
145 } tftp_state_data_t;
146
147
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,
161                         int numsocks);
162 static CURLcode tftp_translate_code(tftp_error_t error);
163
164
165 /*
166  * TFTP protocol handler.
167  */
168
169 const struct Curl_handler Curl_handler_tftp = {
170   "TFTP",                               /* scheme */
171   tftp_setup_connection,                /* setup_connection */
172   tftp_do,                              /* do_it */
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 */
188 };
189
190 /**********************************************************
191  *
192  * tftp_set_timeouts -
193  *
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
197  *
198  *
199  **********************************************************/
200 static CURLcode tftp_set_timeouts(tftp_state_data_t *state)
201 {
202   time_t maxtime, timeout;
203   timediff_t timeout_ms;
204   bool start = (state->state == TFTP_STATE_START) ? TRUE : FALSE;
205
206   time(&state->start_time);
207
208   /* Compute drop-dead time */
209   timeout_ms = Curl_timeleft(state->conn->data, NULL, start);
210
211   if(timeout_ms < 0) {
212     /* time-out, bail out, go home */
213     failf(state->conn->data, "Connection time-out");
214     return CURLE_OPERATION_TIMEDOUT;
215   }
216
217   if(start) {
218
219     maxtime = (time_t)(timeout_ms + 500) / 1000;
220     state->max_time = state->start_time + maxtime;
221
222     /* Set per-block timeout to total */
223     timeout = maxtime;
224
225     /* Average restart after 5 seconds */
226     state->retry_max = (int)timeout/5;
227
228     if(state->retry_max < 1)
229       /* avoid division by zero below */
230       state->retry_max = 1;
231
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;
236
237   }
238   else {
239     if(timeout_ms > 0)
240       maxtime = (time_t)(timeout_ms + 500) / 1000;
241     else
242       maxtime = 3600;
243
244     state->max_time = state->start_time + maxtime;
245
246     /* Set per-block timeout to total */
247     timeout = maxtime;
248
249     /* Average reposting an ACK after 5 seconds */
250     state->retry_max = (int)timeout/5;
251   }
252   /* But bound the total number */
253   if(state->retry_max<3)
254     state->retry_max = 3;
255
256   if(state->retry_max>50)
257     state->retry_max = 50;
258
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;
263
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);
268
269   /* init RX time */
270   time(&state->rx_time);
271
272   return CURLE_OK;
273 }
274
275 /**********************************************************
276  *
277  * tftp_set_send_first
278  *
279  * Event handler for the START state
280  *
281  **********************************************************/
282
283 static void setpacketevent(tftp_packet_t *packet, unsigned short num)
284 {
285   packet->data[0] = (unsigned char)(num >> 8);
286   packet->data[1] = (unsigned char)(num & 0xff);
287 }
288
289
290 static void setpacketblock(tftp_packet_t *packet, unsigned short num)
291 {
292   packet->data[2] = (unsigned char)(num >> 8);
293   packet->data[3] = (unsigned char)(num & 0xff);
294 }
295
296 static unsigned short getrpacketevent(const tftp_packet_t *packet)
297 {
298   return (unsigned short)((packet->data[0] << 8) | packet->data[1]);
299 }
300
301 static unsigned short getrpacketblock(const tftp_packet_t *packet)
302 {
303   return (unsigned short)((packet->data[2] << 8) | packet->data[3]);
304 }
305
306 static size_t Curl_strnlen(const char *string, size_t maxlen)
307 {
308   const char *end = memchr(string, '\0', maxlen);
309   return end ? (size_t) (end - string) : maxlen;
310 }
311
312 static const char *tftp_option_get(const char *buf, size_t len,
313                                    const char **option, const char **value)
314 {
315   size_t loc;
316
317   loc = Curl_strnlen(buf, len);
318   loc++; /* NULL term */
319
320   if(loc >= len)
321     return NULL;
322   *option = buf;
323
324   loc += Curl_strnlen(buf + loc, len-loc);
325   loc++; /* NULL term */
326
327   if(loc > len)
328     return NULL;
329   *value = &buf[strlen(*option) + 1];
330
331   return &buf[loc];
332 }
333
334 static CURLcode tftp_parse_option_ack(tftp_state_data_t *state,
335                                       const char *ptr, int len)
336 {
337   const char *tmp = ptr;
338   struct Curl_easy *data = state->conn->data;
339
340   /* if OACK doesn't contain blksize option, the default (512) must be used */
341   state->blksize = TFTP_BLKSIZE_DEFAULT;
342
343   while(tmp < ptr + len) {
344     const char *option, *value;
345
346     tmp = tftp_option_get(tmp, ptr + len - tmp, &option, &value);
347     if(tmp == NULL) {
348       failf(data, "Malformed ACK packet, rejecting");
349       return CURLE_TFTP_ILLEGAL;
350     }
351
352     infof(data, "got option=(%s) value=(%s)\n", option, value);
353
354     if(checkprefix(option, TFTP_OPTION_BLKSIZE)) {
355       long blksize;
356
357       blksize = strtol(value, NULL, 10);
358
359       if(!blksize) {
360         failf(data, "invalid blocksize value in OACK packet");
361         return CURLE_TFTP_ILLEGAL;
362       }
363       if(blksize > TFTP_BLKSIZE_MAX) {
364         failf(data, "%s (%d)", "blksize is larger than max supported",
365               TFTP_BLKSIZE_MAX);
366         return CURLE_TFTP_ILLEGAL;
367       }
368       else if(blksize < TFTP_BLKSIZE_MIN) {
369         failf(data, "%s (%d)", "blksize is smaller than min supported",
370               TFTP_BLKSIZE_MIN);
371         return CURLE_TFTP_ILLEGAL;
372       }
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
376          * requests */
377         failf(data, "%s (%ld)",
378               "server requested blksize larger than allocated", blksize);
379         return CURLE_TFTP_ILLEGAL;
380       }
381
382       state->blksize = (int)blksize;
383       infof(data, "%s (%d) %s (%d)\n", "blksize parsed from OACK",
384             state->blksize, "requested", state->requested_blksize);
385     }
386     else if(checkprefix(option, TFTP_OPTION_TSIZE)) {
387       long tsize = 0;
388
389       tsize = strtol(value, NULL, 10);
390       infof(data, "%s (%ld)\n", "tsize parsed from OACK", tsize);
391
392       /* tsize should be ignored on upload: Who cares about the size of the
393          remote file? */
394       if(!data->set.upload) {
395         if(!tsize) {
396           failf(data, "invalid tsize -:%s:- value in OACK packet", value);
397           return CURLE_TFTP_ILLEGAL;
398         }
399         Curl_pgrsSetDownloadSize(data, tsize);
400       }
401     }
402   }
403
404   return CURLE_OK;
405 }
406
407 static size_t tftp_option_add(tftp_state_data_t *state, size_t csize,
408                               char *buf, const char *option)
409 {
410   if(( strlen(option) + csize + 1) > (size_t)state->blksize)
411     return 0;
412   strcpy(buf, option);
413   return strlen(option) + 1;
414 }
415
416 static CURLcode tftp_connect_for_tx(tftp_state_data_t *state,
417                                     tftp_event_t event)
418 {
419   CURLcode result;
420 #ifndef CURL_DISABLE_VERBOSE_STRINGS
421   struct Curl_easy *data = state->conn->data;
422
423   infof(data, "%s\n", "Connected for transmit");
424 #endif
425   state->state = TFTP_STATE_TX;
426   result = tftp_set_timeouts(state);
427   if(result)
428     return result;
429   return tftp_tx(state, event);
430 }
431
432 static CURLcode tftp_connect_for_rx(tftp_state_data_t *state,
433                                     tftp_event_t event)
434 {
435   CURLcode result;
436 #ifndef CURL_DISABLE_VERBOSE_STRINGS
437   struct Curl_easy *data = state->conn->data;
438
439   infof(data, "%s\n", "Connected for receive");
440 #endif
441   state->state = TFTP_STATE_RX;
442   result = tftp_set_timeouts(state);
443   if(result)
444     return result;
445   return tftp_rx(state, event);
446 }
447
448 static CURLcode tftp_send_first(tftp_state_data_t *state, tftp_event_t event)
449 {
450   size_t sbytes;
451   ssize_t senddata;
452   const char *mode = "octet";
453   char *filename;
454   struct Curl_easy *data = state->conn->data;
455   CURLcode result = CURLE_OK;
456
457   /* Set ascii mode if -B flag was used */
458   if(data->set.prefer_ascii)
459     mode = "netascii";
460
461   switch(event) {
462
463   case TFTP_EVENT_INIT:    /* Send the first packet out */
464   case TFTP_EVENT_TIMEOUT: /* Resend the first packet out */
465     /* Increment the retry counter, quit if over the limit */
466     state->retries++;
467     if(state->retries>state->retry_max) {
468       state->error = TFTP_ERR_NORESPONSE;
469       state->state = TFTP_STATE_FIN;
470       return result;
471     }
472
473     if(data->set.upload) {
474       /* If we are uploading, send an WRQ */
475       setpacketevent(&state->spacket, TFTP_EVENT_WRQ);
476       state->conn->data->req.upload_fromhere =
477         (char *)state->spacket.data + 4;
478       if(data->state.infilesize != -1)
479         Curl_pgrsSetUploadSize(data, data->state.infilesize);
480     }
481     else {
482       /* If we are downloading, send an RRQ */
483       setpacketevent(&state->spacket, TFTP_EVENT_RRQ);
484     }
485     /* As RFC3617 describes the separator slash is not actually part of the
486        file name so we skip the always-present first letter of the path
487        string. */
488     result = Curl_urldecode(data, &state->conn->data->state.up.path[1], 0,
489                             &filename, NULL, FALSE);
490     if(result)
491       return result;
492
493     if(strlen(filename) > (state->blksize - strlen(mode) - 4)) {
494       failf(data, "TFTP file name too long\n");
495       free(filename);
496       return CURLE_TFTP_ILLEGAL; /* too long file name field */
497     }
498
499     snprintf((char *)state->spacket.data + 2,
500              state->blksize,
501              "%s%c%s%c", filename, '\0',  mode, '\0');
502     sbytes = 4 + strlen(filename) + strlen(mode);
503
504     /* optional addition of TFTP options */
505     if(!data->set.tftp_no_options) {
506       char buf[64];
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);
511       else
512         strcpy(buf, "0"); /* the destination is large enough */
513
514       sbytes += tftp_option_add(state, sbytes,
515                                 (char *)state->spacket.data + sbytes,
516                                 TFTP_OPTION_TSIZE);
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);
526
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);
534     }
535
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));
544     }
545     free(filename);
546     break;
547
548   case TFTP_EVENT_OACK:
549     if(data->set.upload) {
550       result = tftp_connect_for_tx(state, event);
551     }
552     else {
553       result = tftp_connect_for_rx(state, event);
554     }
555     break;
556
557   case TFTP_EVENT_ACK: /* Connected for transmit */
558     result = tftp_connect_for_tx(state, event);
559     break;
560
561   case TFTP_EVENT_DATA: /* Connected for receive */
562     result = tftp_connect_for_rx(state, event);
563     break;
564
565   case TFTP_EVENT_ERROR:
566     state->state = TFTP_STATE_FIN;
567     break;
568
569   default:
570     failf(state->conn->data, "tftp_send_first: internal error");
571     break;
572   }
573
574   return result;
575 }
576
577 /* the next blocknum is x + 1 but it needs to wrap at an unsigned 16bit
578    boundary */
579 #define NEXT_BLOCKNUM(x) (((x) + 1)&0xffff)
580
581 /**********************************************************
582  *
583  * tftp_rx
584  *
585  * Event handler for the RX state
586  *
587  **********************************************************/
588 static CURLcode tftp_rx(tftp_state_data_t *state, tftp_event_t event)
589 {
590   ssize_t sbytes;
591   int rblock;
592   struct Curl_easy *data = state->conn->data;
593
594   switch(event) {
595
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. */
601       state->retries = 0;
602     }
603     else if(state->block == rblock) {
604       /* This is the last recently received block again. Log it and ACK it
605          again. */
606       infof(data, "Received last DATA packet block %d again.\n", rblock);
607     }
608     else {
609       /* totally unexpected, just log it */
610       infof(data,
611             "Received unexpected DATA packet block %d, expecting block %d\n",
612             rblock, NEXT_BLOCKNUM(state->block));
613       break;
614     }
615
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,
621                     4, SEND_4TH_ARG,
622                     (struct sockaddr *)&state->remote_addr,
623                     state->remote_addrlen);
624     if(sbytes < 0) {
625       failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
626       return CURLE_SEND_ERROR;
627     }
628
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;
632     }
633     else {
634       state->state = TFTP_STATE_RX;
635     }
636     time(&state->rx_time);
637     break;
638
639   case TFTP_EVENT_OACK:
640     /* ACK option acknowledgement so we can move on to data */
641     state->block = 0;
642     state->retries = 0;
643     setpacketevent(&state->spacket, TFTP_EVENT_ACK);
644     setpacketblock(&state->spacket, state->block);
645     sbytes = sendto(state->sockfd, (void *)state->spacket.data,
646                     4, SEND_4TH_ARG,
647                     (struct sockaddr *)&state->remote_addr,
648                     state->remote_addrlen);
649     if(sbytes < 0) {
650       failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
651       return CURLE_SEND_ERROR;
652     }
653
654     /* we're ready to RX data */
655     state->state = TFTP_STATE_RX;
656     time(&state->rx_time);
657     break;
658
659   case TFTP_EVENT_TIMEOUT:
660     /* Increment the retry count and fail if over the limit */
661     state->retries++;
662     infof(data,
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;
668     }
669     else {
670       /* Resend the previous ACK */
671       sbytes = sendto(state->sockfd, (void *)state->spacket.data,
672                       4, SEND_4TH_ARG,
673                       (struct sockaddr *)&state->remote_addr,
674                       state->remote_addrlen);
675       if(sbytes<0) {
676         failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
677         return CURLE_SEND_ERROR;
678       }
679     }
680     break;
681
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,
686                  4, SEND_4TH_ARG,
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;
692     break;
693
694   default:
695     failf(data, "%s", "tftp_rx: internal error");
696     return CURLE_TFTP_ILLEGAL; /* not really the perfect return code for
697                                   this */
698   }
699   return CURLE_OK;
700 }
701
702 /**********************************************************
703  *
704  * tftp_tx
705  *
706  * Event handler for the TX state
707  *
708  **********************************************************/
709 static CURLcode tftp_tx(tftp_state_data_t *state, tftp_event_t event)
710 {
711   struct Curl_easy *data = state->conn->data;
712   ssize_t sbytes;
713   CURLcode result = CURLE_OK;
714   struct SingleRequest *k = &data->req;
715   size_t cb; /* Bytes currently read */
716
717   switch(event) {
718
719   case TFTP_EVENT_ACK:
720   case TFTP_EVENT_OACK:
721     if(event == TFTP_EVENT_ACK) {
722       /* Ack the packet */
723       int rblock = getrpacketblock(&state->rpacket);
724
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
730           * */
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);
735         state->retries++;
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",
739                 state->block);
740           result = CURLE_SEND_ERROR;
741         }
742         else {
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 */
749           if(sbytes<0) {
750             failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
751             result = CURLE_SEND_ERROR;
752           }
753         }
754
755         return result;
756       }
757       /* This is the expected packet.  Reset the counters and send the next
758          block */
759       time(&state->rx_time);
760       state->block++;
761     }
762     else
763       state->block = 1; /* first data block is 1 when using OACK */
764
765     state->retries = 0;
766     setpacketevent(&state->spacket, TFTP_EVENT_DATA);
767     setpacketblock(&state->spacket, state->block);
768     if(state->block > 1 && state->sbytes < state->blksize) {
769       state->state = TFTP_STATE_FIN;
770       return CURLE_OK;
771     }
772
773     /* TFTP considers data block size < 512 bytes as an end of session. So
774      * in some cases we must wait for additional data to build full (512 bytes)
775      * data block.
776      * */
777     state->sbytes = 0;
778     state->conn->data->req.upload_fromhere = (char *)state->spacket.data + 4;
779     do {
780       result = Curl_fillreadbuffer(state->conn, state->blksize - state->sbytes,
781                                    &cb);
782       if(result)
783         return result;
784       state->sbytes += (int)cb;
785       state->conn->data->req.upload_fromhere += cb;
786     } while(state->sbytes < state->blksize && cb != 0);
787
788     sbytes = sendto(state->sockfd, (void *) state->spacket.data,
789                     4 + state->sbytes, SEND_4TH_ARG,
790                     (struct sockaddr *)&state->remote_addr,
791                     state->remote_addrlen);
792     /* Check all sbytes were sent */
793     if(sbytes<0) {
794       failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
795       return CURLE_SEND_ERROR;
796     }
797     /* Update the progress meter */
798     k->writebytecount += state->sbytes;
799     Curl_pgrsSetUploadCounter(data, k->writebytecount);
800     break;
801
802   case TFTP_EVENT_TIMEOUT:
803     /* Increment the retry counter and log the timeout */
804     state->retries++;
805     infof(data, "Timeout waiting for block %d ACK. "
806           " Retries = %d\n", NEXT_BLOCKNUM(state->block), state->retries);
807     /* Decide if we've had enough */
808     if(state->retries > state->retry_max) {
809       state->error = TFTP_ERR_TIMEOUT;
810       state->state = TFTP_STATE_FIN;
811     }
812     else {
813       /* Re-send the data packet */
814       sbytes = sendto(state->sockfd, (void *)state->spacket.data,
815                       4 + state->sbytes, SEND_4TH_ARG,
816                       (struct sockaddr *)&state->remote_addr,
817                       state->remote_addrlen);
818       /* Check all sbytes were sent */
819       if(sbytes<0) {
820         failf(data, "%s", Curl_strerror(state->conn, SOCKERRNO));
821         return CURLE_SEND_ERROR;
822       }
823       /* since this was a re-send, we remain at the still byte position */
824       Curl_pgrsSetUploadCounter(data, k->writebytecount);
825     }
826     break;
827
828   case TFTP_EVENT_ERROR:
829     state->state = TFTP_STATE_FIN;
830     setpacketevent(&state->spacket, TFTP_EVENT_ERROR);
831     setpacketblock(&state->spacket, state->block);
832     (void)sendto(state->sockfd, (void *)state->spacket.data, 4, SEND_4TH_ARG,
833                  (struct sockaddr *)&state->remote_addr,
834                  state->remote_addrlen);
835     /* don't bother with the return code, but if the socket is still up we
836      * should be a good TFTP client and let the server know we're done */
837     state->state = TFTP_STATE_FIN;
838     break;
839
840   default:
841     failf(data, "tftp_tx: internal error, event: %i", (int)(event));
842     break;
843   }
844
845   return result;
846 }
847
848 /**********************************************************
849  *
850  * tftp_translate_code
851  *
852  * Translate internal error codes to CURL error codes
853  *
854  **********************************************************/
855 static CURLcode tftp_translate_code(tftp_error_t error)
856 {
857   CURLcode result = CURLE_OK;
858
859   if(error != TFTP_ERR_NONE) {
860     switch(error) {
861     case TFTP_ERR_NOTFOUND:
862       result = CURLE_TFTP_NOTFOUND;
863       break;
864     case TFTP_ERR_PERM:
865       result = CURLE_TFTP_PERM;
866       break;
867     case TFTP_ERR_DISKFULL:
868       result = CURLE_REMOTE_DISK_FULL;
869       break;
870     case TFTP_ERR_UNDEF:
871     case TFTP_ERR_ILLEGAL:
872       result = CURLE_TFTP_ILLEGAL;
873       break;
874     case TFTP_ERR_UNKNOWNID:
875       result = CURLE_TFTP_UNKNOWNID;
876       break;
877     case TFTP_ERR_EXISTS:
878       result = CURLE_REMOTE_FILE_EXISTS;
879       break;
880     case TFTP_ERR_NOSUCHUSER:
881       result = CURLE_TFTP_NOSUCHUSER;
882       break;
883     case TFTP_ERR_TIMEOUT:
884       result = CURLE_OPERATION_TIMEDOUT;
885       break;
886     case TFTP_ERR_NORESPONSE:
887       result = CURLE_COULDNT_CONNECT;
888       break;
889     default:
890       result = CURLE_ABORTED_BY_CALLBACK;
891       break;
892     }
893   }
894   else
895     result = CURLE_OK;
896
897   return result;
898 }
899
900 /**********************************************************
901  *
902  * tftp_state_machine
903  *
904  * The tftp state machine event dispatcher
905  *
906  **********************************************************/
907 static CURLcode tftp_state_machine(tftp_state_data_t *state,
908                                    tftp_event_t event)
909 {
910   CURLcode result = CURLE_OK;
911   struct Curl_easy *data = state->conn->data;
912
913   switch(state->state) {
914   case TFTP_STATE_START:
915     DEBUGF(infof(data, "TFTP_STATE_START\n"));
916     result = tftp_send_first(state, event);
917     break;
918   case TFTP_STATE_RX:
919     DEBUGF(infof(data, "TFTP_STATE_RX\n"));
920     result = tftp_rx(state, event);
921     break;
922   case TFTP_STATE_TX:
923     DEBUGF(infof(data, "TFTP_STATE_TX\n"));
924     result = tftp_tx(state, event);
925     break;
926   case TFTP_STATE_FIN:
927     infof(data, "%s\n", "TFTP finished");
928     break;
929   default:
930     DEBUGF(infof(data, "STATE: %d\n", state->state));
931     failf(data, "%s", "Internal state machine error");
932     result = CURLE_TFTP_ILLEGAL;
933     break;
934   }
935
936   return result;
937 }
938
939 /**********************************************************
940  *
941  * tftp_disconnect
942  *
943  * The disconnect callback
944  *
945  **********************************************************/
946 static CURLcode tftp_disconnect(struct connectdata *conn, bool dead_connection)
947 {
948   tftp_state_data_t *state = conn->proto.tftpc;
949   (void) dead_connection;
950
951   /* done, free dynamically allocated pkt buffers */
952   if(state) {
953     Curl_safefree(state->rpacket.data);
954     Curl_safefree(state->spacket.data);
955     free(state);
956   }
957
958   return CURLE_OK;
959 }
960
961 /**********************************************************
962  *
963  * tftp_connect
964  *
965  * The connect callback
966  *
967  **********************************************************/
968 static CURLcode tftp_connect(struct connectdata *conn, bool *done)
969 {
970   tftp_state_data_t *state;
971   int blksize;
972
973   blksize = TFTP_BLKSIZE_DEFAULT;
974
975   state = conn->proto.tftpc = calloc(1, sizeof(tftp_state_data_t));
976   if(!state)
977     return CURLE_OUT_OF_MEMORY;
978
979   /* alloc pkt buffers based on specified blksize */
980   if(conn->data->set.tftp_blksize) {
981     blksize = (int)conn->data->set.tftp_blksize;
982     if(blksize > TFTP_BLKSIZE_MAX || blksize < TFTP_BLKSIZE_MIN)
983       return CURLE_TFTP_ILLEGAL;
984   }
985
986   if(!state->rpacket.data) {
987     state->rpacket.data = calloc(1, blksize + 2 + 2);
988
989     if(!state->rpacket.data)
990       return CURLE_OUT_OF_MEMORY;
991   }
992
993   if(!state->spacket.data) {
994     state->spacket.data = calloc(1, blksize + 2 + 2);
995
996     if(!state->spacket.data)
997       return CURLE_OUT_OF_MEMORY;
998   }
999
1000   /* we don't keep TFTP connections up basically because there's none or very
1001    * little gain for UDP */
1002   connclose(conn, "TFTP");
1003
1004   state->conn = conn;
1005   state->sockfd = state->conn->sock[FIRSTSOCKET];
1006   state->state = TFTP_STATE_START;
1007   state->error = TFTP_ERR_NONE;
1008   state->blksize = blksize;
1009   state->requested_blksize = blksize;
1010
1011   ((struct sockaddr *)&state->local_addr)->sa_family =
1012     (CURL_SA_FAMILY_T)(conn->ip_addr->ai_family);
1013
1014   tftp_set_timeouts(state);
1015
1016   if(!conn->bits.bound) {
1017     /* If not already bound, bind to any interface, random UDP port. If it is
1018      * reused or a custom local port was desired, this has already been done!
1019      *
1020      * We once used the size of the local_addr struct as the third argument
1021      * for bind() to better work with IPv6 or whatever size the struct could
1022      * have, but we learned that at least Tru64, AIX and IRIX *requires* the
1023      * size of that argument to match the exact size of a 'sockaddr_in' struct
1024      * when running IPv4-only.
1025      *
1026      * Therefore we use the size from the address we connected to, which we
1027      * assume uses the same IP version and thus hopefully this works for both
1028      * IPv4 and IPv6...
1029      */
1030     int rc = bind(state->sockfd, (struct sockaddr *)&state->local_addr,
1031                   conn->ip_addr->ai_addrlen);
1032     if(rc) {
1033       failf(conn->data, "bind() failed; %s",
1034             Curl_strerror(conn, SOCKERRNO));
1035       return CURLE_COULDNT_CONNECT;
1036     }
1037     conn->bits.bound = TRUE;
1038   }
1039
1040   Curl_pgrsStartNow(conn->data);
1041
1042   *done = TRUE;
1043
1044   return CURLE_OK;
1045 }
1046
1047 /**********************************************************
1048  *
1049  * tftp_done
1050  *
1051  * The done callback
1052  *
1053  **********************************************************/
1054 static CURLcode tftp_done(struct connectdata *conn, CURLcode status,
1055                           bool premature)
1056 {
1057   CURLcode result = CURLE_OK;
1058   tftp_state_data_t *state = (tftp_state_data_t *)conn->proto.tftpc;
1059
1060   (void)status; /* unused */
1061   (void)premature; /* not used */
1062
1063   if(Curl_pgrsDone(conn))
1064     return CURLE_ABORTED_BY_CALLBACK;
1065
1066   /* If we have encountered an error */
1067   if(state)
1068     result = tftp_translate_code(state->error);
1069
1070   return result;
1071 }
1072
1073 /**********************************************************
1074  *
1075  * tftp_getsock
1076  *
1077  * The getsock callback
1078  *
1079  **********************************************************/
1080 static int tftp_getsock(struct connectdata *conn, curl_socket_t *socks,
1081                         int numsocks)
1082 {
1083   if(!numsocks)
1084     return GETSOCK_BLANK;
1085
1086   socks[0] = conn->sock[FIRSTSOCKET];
1087
1088   return GETSOCK_READSOCK(0);
1089 }
1090
1091 /**********************************************************
1092  *
1093  * tftp_receive_packet
1094  *
1095  * Called once select fires and data is ready on the socket
1096  *
1097  **********************************************************/
1098 static CURLcode tftp_receive_packet(struct connectdata *conn)
1099 {
1100   struct Curl_sockaddr_storage fromaddr;
1101   curl_socklen_t        fromlen;
1102   CURLcode              result = CURLE_OK;
1103   struct Curl_easy  *data = conn->data;
1104   tftp_state_data_t     *state = (tftp_state_data_t *)conn->proto.tftpc;
1105   struct SingleRequest  *k = &data->req;
1106
1107   /* Receive the packet */
1108   fromlen = sizeof(fromaddr);
1109   state->rbytes = (int)recvfrom(state->sockfd,
1110                                 (void *)state->rpacket.data,
1111                                 state->blksize + 4,
1112                                 0,
1113                                 (struct sockaddr *)&fromaddr,
1114                                 &fromlen);
1115   if(state->remote_addrlen == 0) {
1116     memcpy(&state->remote_addr, &fromaddr, fromlen);
1117     state->remote_addrlen = fromlen;
1118   }
1119
1120   /* Sanity check packet length */
1121   if(state->rbytes < 4) {
1122     failf(data, "Received too short packet");
1123     /* Not a timeout, but how best to handle it? */
1124     state->event = TFTP_EVENT_TIMEOUT;
1125   }
1126   else {
1127     /* The event is given by the TFTP packet time */
1128     unsigned short event = getrpacketevent(&state->rpacket);
1129     state->event = (tftp_event_t)event;
1130
1131     switch(state->event) {
1132     case TFTP_EVENT_DATA:
1133       /* Don't pass to the client empty or retransmitted packets */
1134       if(state->rbytes > 4 &&
1135          (NEXT_BLOCKNUM(state->block) == getrpacketblock(&state->rpacket))) {
1136         result = Curl_client_write(conn, CLIENTWRITE_BODY,
1137                                    (char *)state->rpacket.data + 4,
1138                                    state->rbytes-4);
1139         if(result) {
1140           tftp_state_machine(state, TFTP_EVENT_ERROR);
1141           return result;
1142         }
1143         k->bytecount += state->rbytes-4;
1144         Curl_pgrsSetDownloadCounter(data, (curl_off_t) k->bytecount);
1145       }
1146       break;
1147     case TFTP_EVENT_ERROR:
1148     {
1149       unsigned short error = getrpacketblock(&state->rpacket);
1150       char *str = (char *)state->rpacket.data + 4;
1151       size_t strn = state->rbytes - 4;
1152       state->error = (tftp_error_t)error;
1153       if(Curl_strnlen(str, strn) < strn)
1154         infof(data, "TFTP error: %s\n", str);
1155       break;
1156     }
1157     case TFTP_EVENT_ACK:
1158       break;
1159     case TFTP_EVENT_OACK:
1160       result = tftp_parse_option_ack(state,
1161                                      (const char *)state->rpacket.data + 2,
1162                                      state->rbytes-2);
1163       if(result)
1164         return result;
1165       break;
1166     case TFTP_EVENT_RRQ:
1167     case TFTP_EVENT_WRQ:
1168     default:
1169       failf(data, "%s", "Internal error: Unexpected packet");
1170       break;
1171     }
1172
1173     /* Update the progress meter */
1174     if(Curl_pgrsUpdate(conn)) {
1175       tftp_state_machine(state, TFTP_EVENT_ERROR);
1176       return CURLE_ABORTED_BY_CALLBACK;
1177     }
1178   }
1179   return result;
1180 }
1181
1182 /**********************************************************
1183  *
1184  * tftp_state_timeout
1185  *
1186  * Check if timeouts have been reached
1187  *
1188  **********************************************************/
1189 static long tftp_state_timeout(struct connectdata *conn, tftp_event_t *event)
1190 {
1191   time_t                current;
1192   tftp_state_data_t     *state = (tftp_state_data_t *)conn->proto.tftpc;
1193
1194   if(event)
1195     *event = TFTP_EVENT_NONE;
1196
1197   time(&current);
1198   if(current > state->max_time) {
1199     DEBUGF(infof(conn->data, "timeout: %ld > %ld\n",
1200                  (long)current, (long)state->max_time));
1201     state->error = TFTP_ERR_TIMEOUT;
1202     state->state = TFTP_STATE_FIN;
1203     return 0;
1204   }
1205   if(current > state->rx_time + state->retry_time) {
1206     if(event)
1207       *event = TFTP_EVENT_TIMEOUT;
1208     time(&state->rx_time); /* update even though we received nothing */
1209   }
1210
1211   /* there's a typecast below here since 'time_t' may in fact be larger than
1212      'long', but we estimate that a 'long' will still be able to hold number
1213      of seconds even if "only" 32 bit */
1214   return (long)(state->max_time - current);
1215 }
1216
1217 /**********************************************************
1218  *
1219  * tftp_multi_statemach
1220  *
1221  * Handle single RX socket event and return
1222  *
1223  **********************************************************/
1224 static CURLcode tftp_multi_statemach(struct connectdata *conn, bool *done)
1225 {
1226   tftp_event_t          event;
1227   CURLcode              result = CURLE_OK;
1228   struct Curl_easy  *data = conn->data;
1229   tftp_state_data_t     *state = (tftp_state_data_t *)conn->proto.tftpc;
1230   long                  timeout_ms = tftp_state_timeout(conn, &event);
1231
1232   *done = FALSE;
1233
1234   if(timeout_ms <= 0) {
1235     failf(data, "TFTP response timeout");
1236     return CURLE_OPERATION_TIMEDOUT;
1237   }
1238   if(event != TFTP_EVENT_NONE) {
1239     result = tftp_state_machine(state, event);
1240     if(result)
1241       return result;
1242     *done = (state->state == TFTP_STATE_FIN) ? TRUE : FALSE;
1243     if(*done)
1244       /* Tell curl we're done */
1245       Curl_setup_transfer(conn, -1, -1, FALSE, NULL, -1, NULL);
1246   }
1247   else {
1248     /* no timeouts to handle, check our socket */
1249     int rc = SOCKET_READABLE(state->sockfd, 0);
1250
1251     if(rc == -1) {
1252       /* bail out */
1253       int error = SOCKERRNO;
1254       failf(data, "%s", Curl_strerror(conn, error));
1255       state->event = TFTP_EVENT_ERROR;
1256     }
1257     else if(rc != 0) {
1258       result = tftp_receive_packet(conn);
1259       if(result)
1260         return result;
1261       result = tftp_state_machine(state, state->event);
1262       if(result)
1263         return result;
1264       *done = (state->state == TFTP_STATE_FIN) ? TRUE : FALSE;
1265       if(*done)
1266         /* Tell curl we're done */
1267         Curl_setup_transfer(conn, -1, -1, FALSE, NULL, -1, NULL);
1268     }
1269     /* if rc == 0, then select() timed out */
1270   }
1271
1272   return result;
1273 }
1274
1275 /**********************************************************
1276  *
1277  * tftp_doing
1278  *
1279  * Called from multi.c while DOing
1280  *
1281  **********************************************************/
1282 static CURLcode tftp_doing(struct connectdata *conn, bool *dophase_done)
1283 {
1284   CURLcode result;
1285   result = tftp_multi_statemach(conn, dophase_done);
1286
1287   if(*dophase_done) {
1288     DEBUGF(infof(conn->data, "DO phase is complete\n"));
1289   }
1290   else if(!result) {
1291     /* The multi code doesn't have this logic for the DOING state so we
1292        provide it for TFTP since it may do the entire transfer in this
1293        state. */
1294     if(Curl_pgrsUpdate(conn))
1295       result = CURLE_ABORTED_BY_CALLBACK;
1296     else
1297       result = Curl_speedcheck(conn->data, Curl_now());
1298   }
1299   return result;
1300 }
1301
1302 /**********************************************************
1303  *
1304  * tftp_peform
1305  *
1306  * Entry point for transfer from tftp_do, sarts state mach
1307  *
1308  **********************************************************/
1309 static CURLcode tftp_perform(struct connectdata *conn, bool *dophase_done)
1310 {
1311   CURLcode              result = CURLE_OK;
1312   tftp_state_data_t     *state = (tftp_state_data_t *)conn->proto.tftpc;
1313
1314   *dophase_done = FALSE;
1315
1316   result = tftp_state_machine(state, TFTP_EVENT_INIT);
1317
1318   if((state->state == TFTP_STATE_FIN) || result)
1319     return result;
1320
1321   tftp_multi_statemach(conn, dophase_done);
1322
1323   if(*dophase_done)
1324     DEBUGF(infof(conn->data, "DO phase is complete\n"));
1325
1326   return result;
1327 }
1328
1329
1330 /**********************************************************
1331  *
1332  * tftp_do
1333  *
1334  * The do callback
1335  *
1336  * This callback initiates the TFTP transfer
1337  *
1338  **********************************************************/
1339
1340 static CURLcode tftp_do(struct connectdata *conn, bool *done)
1341 {
1342   tftp_state_data_t *state;
1343   CURLcode result;
1344
1345   *done = FALSE;
1346
1347   if(!conn->proto.tftpc) {
1348     result = tftp_connect(conn, done);
1349     if(result)
1350       return result;
1351   }
1352
1353   state = (tftp_state_data_t *)conn->proto.tftpc;
1354   if(!state)
1355     return CURLE_TFTP_ILLEGAL;
1356
1357   result = tftp_perform(conn, done);
1358
1359   /* If tftp_perform() returned an error, use that for return code. If it
1360      was OK, see if tftp_translate_code() has an error. */
1361   if(!result)
1362     /* If we have encountered an internal tftp error, translate it. */
1363     result = tftp_translate_code(state->error);
1364
1365   return result;
1366 }
1367
1368 static CURLcode tftp_setup_connection(struct connectdata * conn)
1369 {
1370   struct Curl_easy *data = conn->data;
1371   char *type;
1372
1373   conn->socktype = SOCK_DGRAM;   /* UDP datagram based */
1374
1375   /* TFTP URLs support an extension like ";mode=<typecode>" that
1376    * we'll try to get now! */
1377   type = strstr(data->state.up.path, ";mode=");
1378
1379   if(!type)
1380     type = strstr(conn->host.rawalloc, ";mode=");
1381
1382   if(type) {
1383     char command;
1384     *type = 0;                   /* it was in the middle of the hostname */
1385     command = Curl_raw_toupper(type[6]);
1386
1387     switch(command) {
1388     case 'A': /* ASCII mode */
1389     case 'N': /* NETASCII mode */
1390       data->set.prefer_ascii = TRUE;
1391       break;
1392
1393     case 'O': /* octet mode */
1394     case 'I': /* binary mode */
1395     default:
1396       /* switch off ASCII */
1397       data->set.prefer_ascii = FALSE;
1398       break;
1399     }
1400   }
1401
1402   return CURLE_OK;
1403 }
1404 #endif