ifupdown: improve compatibility with Debian
[oweals/busybox.git] / networking / tftp.c
index c2d3ccfa8c7f3c377a5c82cf36c2314b8a5ada93..ce48a1edd5f5089f5a68ea3467c9b5d8f59465c9 100644 (file)
  *
  * tftpd added by Denys Vlasenko & Vladimir Dronnikov
  *
- * Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
+ * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  */
+
+//usage:#define tftp_trivial_usage
+//usage:       "[OPTIONS] HOST [PORT]"
+//usage:#define tftp_full_usage "\n\n"
+//usage:       "Transfer a file from/to tftp server\n"
+//usage:     "\n       -l FILE Local FILE"
+//usage:     "\n       -r FILE Remote FILE"
+//usage:       IF_FEATURE_TFTP_GET(
+//usage:     "\n       -g      Get file"
+//usage:       )
+//usage:       IF_FEATURE_TFTP_PUT(
+//usage:     "\n       -p      Put file"
+//usage:       )
+//usage:       IF_FEATURE_TFTP_BLOCKSIZE(
+//usage:     "\n       -b SIZE Transfer blocks of SIZE octets"
+//usage:       )
+//usage:
+//usage:#define tftpd_trivial_usage
+//usage:       "[-cr] [-u USER] [DIR]"
+//usage:#define tftpd_full_usage "\n\n"
+//usage:       "Transfer a file on tftp client's request\n"
+//usage:       "\n"
+//usage:       "tftpd should be used as an inetd service.\n"
+//usage:       "tftpd's line for inetd.conf:\n"
+//usage:       "       69 dgram udp nowait root tftpd tftpd -l /files/to/serve\n"
+//usage:       "It also can be ran from udpsvd:\n"
+//usage:       "       udpsvd -vE 0.0.0.0 69 tftpd /files/to/serve\n"
+//usage:     "\n       -r      Prohibit upload"
+//usage:     "\n       -c      Allow file creation via upload"
+//usage:     "\n       -u      Access files as USER"
+//usage:     "\n       -l      Log to syslog (inetd mode requires this)"
+
 #include "libbb.h"
+#include <syslog.h>
 
 #if ENABLE_FEATURE_TFTP_GET || ENABLE_FEATURE_TFTP_PUT
 
 #define TFTP_BLKSIZE_DEFAULT       512  /* according to RFC 1350, don't change */
 #define TFTP_BLKSIZE_DEFAULT_STR "512"
-#define TFTP_TIMEOUT_MS             50
+/* Was 50 ms but users asked to bump it up a bit */
+#define TFTP_TIMEOUT_MS            100
 #define TFTP_MAXTIMEOUT_MS        2000
 #define TFTP_NUM_RETRIES            12  /* number of backed-off retries */
 
@@ -58,6 +92,7 @@ enum {
        TFTPD_OPT_r = (1 << 8) * ENABLE_TFTPD,
        TFTPD_OPT_c = (1 << 9) * ENABLE_TFTPD,
        TFTPD_OPT_u = (1 << 10) * ENABLE_TFTPD,
+       TFTPD_OPT_l = (1 << 11) * ENABLE_TFTPD,
 };
 
 #if ENABLE_FEATURE_TFTP_GET && !ENABLE_FEATURE_TFTP_PUT
@@ -84,8 +119,17 @@ struct globals {
        char *user_opt;
        /* used in tftpd_main(), a bit big for stack: */
        char block_buf[TFTP_BLKSIZE_DEFAULT];
-};
+#if ENABLE_FEATURE_TFTP_PROGRESS_BAR
+       off_t pos;
+       off_t size;
+       const char *file;
+       bb_progress_t pmt;
+#endif
+} FIX_ALIASING;
 #define G (*(struct globals*)&bb_common_bufsiz1)
+struct BUG_G_too_big {
+       char BUG_G_too_big[sizeof(G) <= COMMON_BUFSIZE ? 1 : -1];
+};
 #define block_buf        (G.block_buf   )
 #define user_opt         (G.user_opt    )
 #define error_pkt        (G.error_pkt   )
@@ -94,6 +138,28 @@ struct globals {
 #define error_pkt_reason (error_pkt[3])
 #define error_pkt_str    (error_pkt + 4)
 
+#if ENABLE_FEATURE_TFTP_PROGRESS_BAR
+static void tftp_progress_update(void)
+{
+       bb_progress_update(&G.pmt, 0, G.pos, G.size);
+}
+static void tftp_progress_init(void)
+{
+       bb_progress_init(&G.pmt, G.file);
+       tftp_progress_update();
+}
+static void tftp_progress_done(void)
+{
+       if (is_bb_progress_inited(&G.pmt)) {
+               tftp_progress_update();
+               bb_putchar_stderr('\n');
+               bb_progress_free(&G.pmt);
+       }
+}
+#else
+# define tftp_progress_init() ((void)0)
+# define tftp_progress_done() ((void)0)
+#endif
 
 #if ENABLE_FEATURE_TFTP_BLOCKSIZE
 
@@ -163,7 +229,7 @@ static int tftp_protocol(
 # define remote_file NULL
 #endif
                /* 1 for tftp; 1/0 for tftpd depending whether client asked about it: */
-               IF_FEATURE_TFTP_BLOCKSIZE(, off_t transfer_size)
+               IF_FEATURE_TFTP_BLOCKSIZE(, int want_transfer_size)
                IF_FEATURE_TFTP_BLOCKSIZE(, int blksize))
 {
 #if !ENABLE_FEATURE_TFTP_BLOCKSIZE
@@ -261,7 +327,7 @@ static int tftp_protocol(
 
        if (!ENABLE_TFTP || our_lsa) { /* tftpd */
                /* Open file (must be after changing user) */
-               local_fd = open(local_file, open_mode);
+               local_fd = open(local_file, open_mode, 0666);
                if (local_fd < 0) {
                        error_pkt_reason = ERR_NOFILE;
                        strcpy((char*)error_pkt_str, "can't open file");
@@ -269,7 +335,7 @@ static int tftp_protocol(
                }
 /* gcc 4.3.1 would NOT optimize it out as it should! */
 #if ENABLE_FEATURE_TFTP_BLOCKSIZE
-               if (blksize != TFTP_BLKSIZE_DEFAULT || transfer_size) {
+               if (blksize != TFTP_BLKSIZE_DEFAULT || want_transfer_size) {
                        /* Create and send OACK packet. */
                        /* For the download case, block_nr is still 1 -
                         * we expect 1st ACK from peer to be for (block_nr-1),
@@ -325,11 +391,11 @@ static int tftp_protocol(
                cp += sizeof("octet");
 
 # if ENABLE_FEATURE_TFTP_BLOCKSIZE
-               if (blksize == TFTP_BLKSIZE_DEFAULT && !transfer_size)
+               if (blksize == TFTP_BLKSIZE_DEFAULT && !want_transfer_size)
                        goto send_pkt;
 
                /* Need to add option to pkt */
-               if ((&xbuf[io_bufsize - 1] - cp) < sizeof("blksize NNNNN tsize ") + sizeof(transfer_size)*3) {
+               if ((&xbuf[io_bufsize - 1] - cp) < sizeof("blksize NNNNN tsize ") + sizeof(off_t)*3) {
                        bb_error_msg("remote filename is too long");
                        goto ret;
                }
@@ -345,23 +411,25 @@ static int tftp_protocol(
                        cp += sizeof("blksize");
                        cp += snprintf(cp, 6, "%d", blksize) + 1;
                }
-               if (transfer_size) {
+               if (want_transfer_size) {
                        /* add "tsize", <nul>, size, <nul> (see RFC2349) */
                        /* if tftp and downloading, we send "0" (since we opened local_fd with O_TRUNC)
                         * and this makes server to send "tsize" option with the size */
                        /* if tftp and uploading, we send file size (maybe dont, to not confuse old servers???) */
                        /* if tftpd and downloading, we are answering to client's request */
-                       /* if tftpd and uploading: transfer_size == 0, this code is not executed */
+                       /* if tftpd and uploading: !want_transfer_size, this code is not executed */
                        struct stat st;
                        strcpy(cp, "tsize");
                        cp += sizeof("tsize");
                        st.st_size = 0;
                        fstat(local_fd, &st);
                        cp += sprintf(cp, "%"OFF_FMT"u", (off_t)st.st_size) + 1;
-# if 0 /*ENABLE_FEATURE_TFTP_PROGRESS_BAR*/
+# if ENABLE_FEATURE_TFTP_PROGRESS_BAR
                        /* Save for progress bar. If 0 (tftp downloading),
                         * we look at server's reply later */
-                       transfer_size = st.st_size;
+                       G.size = st.st_size;
+                       if (remote_file && st.st_size)
+                               tftp_progress_init();
 # endif
                }
 #endif
@@ -388,6 +456,7 @@ static int tftp_protocol(
                                finished = 1;
                        }
                        cp += len;
+                       IF_FEATURE_TFTP_PROGRESS_BAR(G.pos += len;)
                }
  send_pkt:
                /* Send packet */
@@ -396,7 +465,7 @@ static int tftp_protocol(
                /* NB: send_len value is preserved in code below
                 * for potential resend */
 
-               retries = TFTP_NUM_RETRIES;     /* re-initialize */
+               retries = TFTP_NUM_RETRIES;  /* re-initialize */
                waittime_ms = TFTP_TIMEOUT_MS;
 
  send_again:
@@ -407,6 +476,11 @@ static int tftp_protocol(
                fprintf(stderr, "\n");
 #endif
                xsendto(socket_fd, xbuf, send_len, &peer_lsa->u.sa, peer_lsa->len);
+
+#if ENABLE_FEATURE_TFTP_PROGRESS_BAR
+               if (is_bb_progress_inited(&G.pmt))
+                       tftp_progress_update();
+#endif
                /* Was it final ACK? then exit */
                if (finished && (opcode == TFTP_ACK))
                        goto ret;
@@ -422,6 +496,7 @@ static int tftp_protocol(
                case 0:
                        retries--;
                        if (retries == 0) {
+                               tftp_progress_done();
                                bb_error_msg("timeout");
                                goto ret; /* no err packet sent */
                        }
@@ -505,11 +580,13 @@ static int tftp_protocol(
                                        }
                                        io_bufsize = blksize + 4;
                                }
-# if 0 /*ENABLE_FEATURE_TFTP_PROGRESS_BAR*/
-                               if (transfer_size == 0) { /* if we don't know it yet */
+# if ENABLE_FEATURE_TFTP_PROGRESS_BAR
+                               if (remote_file && G.size == 0) { /* if we don't know it yet */
                                        res = tftp_get_option("tsize", &rbuf[2], len - 2);
                                        if (res) {
-                                               transfer_size = bb_strtoull(res, NULL, 10);
+                                               G.size = bb_strtoull(res, NULL, 10);
+                                               if (G.size)
+                                                       tftp_progress_init();
                                        }
                                }
 # endif
@@ -522,9 +599,10 @@ static int tftp_protocol(
                        }
                        /* rfc2347:
                         * "An option not acknowledged by the server
-                        *  must be ignored by the client and server
-                        *  as if it were never requested." */
-                       bb_error_msg("server only supports blocksize of 512");
+                        * must be ignored by the client and server
+                        * as if it were never requested." */
+                       if (blksize != TFTP_BLKSIZE_DEFAULT)
+                               bb_error_msg("falling back to blocksize "TFTP_BLKSIZE_DEFAULT_STR);
                        blksize = TFTP_BLKSIZE_DEFAULT;
                        io_bufsize = TFTP_BLKSIZE_DEFAULT + 4;
                }
@@ -543,6 +621,7 @@ static int tftp_protocol(
                                if (sz != blksize) {
                                        finished = 1;
                                }
+                               IF_FEATURE_TFTP_PROGRESS_BAR(G.pos += sz;)
                                continue; /* send ACK */
                        }
 /* Disabled to cope with servers with Sorcerer's Apprentice Syndrome */
@@ -657,12 +736,16 @@ int tftp_main(int argc UNUSED_PARAM, char **argv)
                        remote_file, local_file);
 # endif
 
+# if ENABLE_FEATURE_TFTP_PROGRESS_BAR
+       G.file = remote_file;
+# endif
        result = tftp_protocol(
                NULL /*our_lsa*/, peer_lsa,
                local_file, remote_file
-               IF_FEATURE_TFTP_BLOCKSIZE(, 1 /* transfer_size */)
+               IF_FEATURE_TFTP_BLOCKSIZE(, 1 /* want_transfer_size */)
                IF_FEATURE_TFTP_BLOCKSIZE(, blksize)
        );
+       tftp_progress_done();
 
        if (result != EXIT_SUCCESS && NOT_LONE_DASH(local_file) && CMD_GET(opt)) {
                unlink(local_file);
@@ -682,7 +765,7 @@ int tftpd_main(int argc UNUSED_PARAM, char **argv)
        const char *error_msg;
        int opt, result, opcode;
        IF_FEATURE_TFTP_BLOCKSIZE(int blksize = TFTP_BLKSIZE_DEFAULT;)
-       IF_FEATURE_TFTP_BLOCKSIZE(off_t transfer_size = 0;)
+       IF_FEATURE_TFTP_BLOCKSIZE(int want_transfer_size = 0;)
 
        INIT_G();
 
@@ -700,10 +783,15 @@ int tftpd_main(int argc UNUSED_PARAM, char **argv)
        peer_lsa->len = our_lsa->len;
 
        /* Shifting to not collide with TFTP_OPTs */
-       opt = option_mask32 = TFTPD_OPT | (getopt32(argv, "rcu:", &user_opt) << 8);
+       opt = option_mask32 = TFTPD_OPT | (getopt32(argv, "rcu:l", &user_opt) << 8);
        argv += optind;
-       if (argv[0])
-               xchdir(argv[0]);
+       if (opt & TFTPD_OPT_l) {
+               openlog(applet_name, LOG_PID, LOG_DAEMON);
+               logmode = LOGMODE_SYSLOG;
+       }
+       if (argv[0]) {
+               xchroot(argv[0]);
+       }
 
        result = recv_from_to(STDIN_FILENO, block_buf, sizeof(block_buf),
                        0 /* flags */,
@@ -726,7 +814,8 @@ int tftpd_main(int argc UNUSED_PARAM, char **argv)
                goto err;
        }
        mode = local_file + strlen(local_file) + 1;
-       if (mode >= block_buf + result || strcmp(mode, "octet") != 0) {
+       /* RFC 1350 says mode string is case independent */
+       if (mode >= block_buf + result || strcasecmp(mode, "octet") != 0) {
                goto err;
        }
 # if ENABLE_FEATURE_TFTP_BLOCKSIZE
@@ -744,9 +833,11 @@ int tftpd_main(int argc UNUSED_PARAM, char **argv)
                                        goto do_proto;
                                }
                        }
+                       if (opcode != TFTP_WRQ /* download? */
                        /* did client ask us about file size? */
-                       if (tftp_get_option("tsize", opt_str, opt_len)) {
-                               transfer_size = 1;
+                        && tftp_get_option("tsize", opt_str, opt_len)
+                       ) {
+                               want_transfer_size = 1;
                        }
                }
        }
@@ -760,7 +851,6 @@ int tftpd_main(int argc UNUSED_PARAM, char **argv)
                        goto err;
                }
                IF_GETPUT(option_mask32 |= TFTP_OPT_GET;) /* will receive file's data */
-               transfer_size = 0; /* do not send file size, it's meaningless */
        } else {
                IF_GETPUT(option_mask32 |= TFTP_OPT_PUT;) /* will send file's data */
        }
@@ -774,7 +864,7 @@ int tftpd_main(int argc UNUSED_PARAM, char **argv)
        result = tftp_protocol(
                our_lsa, peer_lsa,
                local_file IF_TFTP(, NULL /*remote_file*/)
-               IF_FEATURE_TFTP_BLOCKSIZE(, transfer_size)
+               IF_FEATURE_TFTP_BLOCKSIZE(, want_transfer_size)
                IF_FEATURE_TFTP_BLOCKSIZE(, blksize)
        );