ifplugd: code shrink
[oweals/busybox.git] / networking / tftp.c
index 9b08c147a8cb660a3cc3ce313832092d0b4a061e..630fdaf9a8b66b1da5b38465ef91064cbacf9f59 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
@@ -81,19 +116,47 @@ enum {
 struct globals {
        /* u16 TFTP_ERROR; u16 reason; both network-endian, then error text: */
        uint8_t error_pkt[4 + 32];
-       char *user_opt;
+       struct passwd *pw;
        /* 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)
-#define block_buf        (G.block_buf   )
-#define user_opt         (G.user_opt    )
-#define error_pkt        (G.error_pkt   )
+struct BUG_G_too_big {
+       char BUG_G_too_big[sizeof(G) <= COMMON_BUFSIZE ? 1 : -1];
+};
 #define INIT_G() do { } while (0)
 
-#define error_pkt_reason (error_pkt[3])
-#define error_pkt_str    (error_pkt + 4)
+#define G_error_pkt_reason (G.error_pkt[3])
+#define G_error_pkt_str    ((char*)(G.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
 
@@ -110,9 +173,9 @@ static int tftp_blksize_check(const char *blksize_str, int maxsize)
                bb_error_msg("bad blocksize '%s'", blksize_str);
                return -1;
        }
-#if ENABLE_TFTP_DEBUG
+# if ENABLE_TFTP_DEBUG
        bb_error_msg("using blksize %u", blksize);
-#endif
+# endif
        return blksize;
 }
 
@@ -154,19 +217,18 @@ static char *tftp_get_option(const char *option, char *buf, int len)
 #endif
 
 static int tftp_protocol(
-               len_and_sockaddr *our_lsa, /* NULL if tftp, !NULL if tftpd */
+               /* NULL if tftp, !NULL if tftpd: */
+               len_and_sockaddr *our_lsa,
                len_and_sockaddr *peer_lsa,
                const char *local_file
                IF_TFTP(, const char *remote_file)
-               IF_FEATURE_TFTP_BLOCKSIZE(IF_TFTPD(, void *tsize))
-               IF_FEATURE_TFTP_BLOCKSIZE(, int blksize))
-{
 #if !ENABLE_TFTP
 # define remote_file NULL
 #endif
-#if !(ENABLE_FEATURE_TFTP_BLOCKSIZE && ENABLE_TFTPD)
-# define tsize NULL
-#endif
+               /* 1 for tftp; 1/0 for tftpd depending whether client asked about it: */
+               IF_FEATURE_TFTP_BLOCKSIZE(, int want_transfer_size)
+               IF_FEATURE_TFTP_BLOCKSIZE(, int blksize))
+{
 #if !ENABLE_FEATURE_TFTP_BLOCKSIZE
        enum { blksize = TFTP_BLKSIZE_DEFAULT };
 #endif
@@ -207,12 +269,11 @@ static int tftp_protocol(
                xconnect(socket_fd, &peer_lsa->u.sa, peer_lsa->len);
 
                /* Is there an error already? Send pkt and bail out */
-               if (error_pkt_reason || error_pkt_str[0])
+               if (G_error_pkt_reason || G_error_pkt_str[0])
                        goto send_err_pkt;
 
-               if (user_opt) {
-                       struct passwd *pw = xgetpwnam(user_opt);
-                       change_identity(pw); /* initgroups, setgid, setuid */
+               if (G.pw) {
+                       change_identity(G.pw); /* initgroups, setgid, setuid */
                }
        }
 
@@ -262,15 +323,15 @@ 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");
+                       G_error_pkt_reason = ERR_NOFILE;
+                       strcpy(G_error_pkt_str, "can't open file");
                        goto send_err_pkt;
                }
 /* gcc 4.3.1 would NOT optimize it out as it should! */
 #if ENABLE_FEATURE_TFTP_BLOCKSIZE
-               if (blksize != TFTP_BLKSIZE_DEFAULT || tsize) {
+               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),
@@ -321,41 +382,52 @@ static int tftp_protocol(
                }
                strcpy(cp, remote_file);
                cp += len;
-               /* add "mode" part of the package */
+               /* add "mode" part of the packet */
                strcpy(cp, "octet");
                cp += sizeof("octet");
 
-#if ENABLE_FEATURE_TFTP_BLOCKSIZE
-               if (blksize == TFTP_BLKSIZE_DEFAULT)
+# if ENABLE_FEATURE_TFTP_BLOCKSIZE
+               if (blksize == TFTP_BLKSIZE_DEFAULT && !want_transfer_size)
                        goto send_pkt;
 
-               /* Non-standard blocksize: add option to pkt */
-               if ((&xbuf[io_bufsize - 1] - cp) < sizeof("blksize NNNNN")) {
+               /* Need to add option to pkt */
+               if ((&xbuf[io_bufsize - 1] - cp) < sizeof("blksize NNNNN tsize ") + sizeof(off_t)*3) {
                        bb_error_msg("remote filename is too long");
                        goto ret;
                }
                expect_OACK = 1;
-#endif
+# endif
 #endif /* ENABLE_TFTP */
 
 #if ENABLE_FEATURE_TFTP_BLOCKSIZE
  add_blksize_opt:
-#if ENABLE_TFTPD
-               if (tsize) {
-                       struct stat st;
-                       /* add "tsize", <nul>, size, <nul> */
-                       strcpy(cp, "tsize");
-                       cp += sizeof("tsize");
-                       fstat(local_fd, &st);
-                       cp += snprintf(cp, 10, "%u", (int) st.st_size) + 1;
-               }
-#endif
                if (blksize != TFTP_BLKSIZE_DEFAULT) {
                        /* add "blksize", <nul>, blksize, <nul> */
                        strcpy(cp, "blksize");
                        cp += sizeof("blksize");
                        cp += snprintf(cp, 6, "%d", blksize) + 1;
                }
+               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: !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 ENABLE_FEATURE_TFTP_PROGRESS_BAR
+                       /* Save for progress bar. If 0 (tftp downloading),
+                        * we look at server's reply later */
+                       G.size = st.st_size;
+                       if (remote_file && st.st_size)
+                               tftp_progress_init();
+# endif
+               }
 #endif
                /* First packet is built, so skip packet generation */
                goto send_pkt;
@@ -380,6 +452,7 @@ static int tftp_protocol(
                                finished = 1;
                        }
                        cp += len;
+                       IF_FEATURE_TFTP_PROGRESS_BAR(G.pos += len;)
                }
  send_pkt:
                /* Send packet */
@@ -388,7 +461,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:
@@ -399,6 +472,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;
@@ -414,6 +492,7 @@ static int tftp_protocol(
                case 0:
                        retries--;
                        if (retries == 0) {
+                               tftp_progress_done();
                                bb_error_msg("timeout");
                                goto ret; /* no err packet sent */
                        }
@@ -492,11 +571,21 @@ static int tftp_protocol(
                                if (res) {
                                        blksize = tftp_blksize_check(res, blksize);
                                        if (blksize < 0) {
-                                               error_pkt_reason = ERR_BAD_OPT;
+                                               G_error_pkt_reason = ERR_BAD_OPT;
                                                goto send_err_pkt;
                                        }
                                        io_bufsize = blksize + 4;
                                }
+# 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) {
+                                               G.size = bb_strtoull(res, NULL, 10);
+                                               if (G.size)
+                                                       tftp_progress_init();
+                                       }
+                               }
+# endif
                                if (CMD_GET(option_mask32)) {
                                        /* We'll send ACK for OACK,
                                         * such ACK has "block no" of 0 */
@@ -506,9 +595,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;
                }
@@ -520,13 +610,14 @@ static int tftp_protocol(
                        if (recv_blk == block_nr) {
                                int sz = full_write(local_fd, &rbuf[4], len - 4);
                                if (sz != len - 4) {
-                                       strcpy((char*)error_pkt_str, bb_msg_write_error);
-                                       error_pkt_reason = ERR_WRITE;
+                                       strcpy(G_error_pkt_str, bb_msg_write_error);
+                                       G_error_pkt_reason = ERR_WRITE;
                                        goto send_err_pkt;
                                }
                                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 */
@@ -569,16 +660,15 @@ static int tftp_protocol(
        return finished == 0; /* returns 1 on failure */
 
  send_read_err_pkt:
-       strcpy((char*)error_pkt_str, bb_msg_read_error);
+       strcpy(G_error_pkt_str, bb_msg_read_error);
  send_err_pkt:
-       if (error_pkt_str[0])
-               bb_error_msg("%s", (char*)error_pkt_str);
-       error_pkt[1] = TFTP_ERROR;
-       xsendto(socket_fd, error_pkt, 4 + 1 + strlen((char*)error_pkt_str),
+       if (G_error_pkt_str[0])
+               bb_error_msg("%s", G_error_pkt_str);
+       G.error_pkt[1] = TFTP_ERROR;
+       xsendto(socket_fd, G.error_pkt, 4 + 1 + strlen(G_error_pkt_str),
                        &peer_lsa->u.sa, peer_lsa->len);
        return EXIT_FAILURE;
 #undef remote_file
-#undef tsize
 }
 
 #if ENABLE_TFTP
@@ -589,10 +679,10 @@ int tftp_main(int argc UNUSED_PARAM, char **argv)
        len_and_sockaddr *peer_lsa;
        const char *local_file = NULL;
        const char *remote_file = NULL;
-#if ENABLE_FEATURE_TFTP_BLOCKSIZE
+# if ENABLE_FEATURE_TFTP_BLOCKSIZE
        const char *blksize_str = TFTP_BLKSIZE_DEFAULT_STR;
        int blksize;
-#endif
+# endif
        int result;
        int port;
        IF_GETPUT(int opt;)
@@ -610,7 +700,7 @@ int tftp_main(int argc UNUSED_PARAM, char **argv)
                        IF_FEATURE_TFTP_BLOCKSIZE(, &blksize_str));
        argv += optind;
 
-#if ENABLE_FEATURE_TFTP_BLOCKSIZE
+# if ENABLE_FEATURE_TFTP_BLOCKSIZE
        /* Check if the blksize is valid:
         * RFC2348 says between 8 and 65464 */
        blksize = tftp_blksize_check(blksize_str, 65564);
@@ -618,7 +708,7 @@ int tftp_main(int argc UNUSED_PARAM, char **argv)
                //bb_error_msg("bad block size");
                return EXIT_FAILURE;
        }
-#endif
+# endif
 
        if (remote_file) {
                if (!local_file) {
@@ -636,18 +726,22 @@ int tftp_main(int argc UNUSED_PARAM, char **argv)
        port = bb_lookup_port(argv[1], "udp", 69);
        peer_lsa = xhost2sockaddr(argv[0], port);
 
-#if ENABLE_TFTP_DEBUG
+# if ENABLE_TFTP_DEBUG
        fprintf(stderr, "using server '%s', remote_file '%s', local_file '%s'\n",
                        xmalloc_sockaddr2dotted(&peer_lsa->u.sa),
                        remote_file, local_file);
-#endif
+# 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(IF_TFTPD(, NULL /*tsize*/))
+               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);
@@ -663,11 +757,11 @@ int tftpd_main(int argc UNUSED_PARAM, char **argv)
 {
        len_and_sockaddr *our_lsa;
        len_and_sockaddr *peer_lsa;
-       char *local_file, *mode;
+       char *local_file, *mode, *user_opt;
        const char *error_msg;
        int opt, result, opcode;
        IF_FEATURE_TFTP_BLOCKSIZE(int blksize = TFTP_BLKSIZE_DEFAULT;)
-       IF_FEATURE_TFTP_BLOCKSIZE(char *tsize = NULL;)
+       IF_FEATURE_TFTP_BLOCKSIZE(int want_transfer_size = 0;)
 
        INIT_G();
 
@@ -685,19 +779,28 @@ 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 (opt & TFTPD_OPT_u) {
+               /* Must be before xchroot */
+               G.pw = xgetpwnam(user_opt);
+       }
+       if (argv[0]) {
+               xchroot(argv[0]);
+       }
 
-       result = recv_from_to(STDIN_FILENO, block_buf, sizeof(block_buf),
+       result = recv_from_to(STDIN_FILENO, G.block_buf, sizeof(G.block_buf),
                        0 /* flags */,
                        &peer_lsa->u.sa, &our_lsa->u.sa, our_lsa->len);
 
        error_msg = "malformed packet";
-       opcode = ntohs(*(uint16_t*)block_buf);
-       if (result < 4 || result >= sizeof(block_buf)
-        || block_buf[result-1] != '\0'
+       opcode = ntohs(*(uint16_t*)G.block_buf);
+       if (result < 4 || result >= sizeof(G.block_buf)
+        || G.block_buf[result-1] != '\0'
         || (IF_FEATURE_TFTP_PUT(opcode != TFTP_RRQ) /* not download */
             IF_GETPUT(&&)
             IF_FEATURE_TFTP_GET(opcode != TFTP_WRQ) /* not upload */
@@ -705,40 +808,45 @@ int tftpd_main(int argc UNUSED_PARAM, char **argv)
        ) {
                goto err;
        }
-       local_file = block_buf + 2;
+       local_file = G.block_buf + 2;
        if (local_file[0] == '.' || strstr(local_file, "/.")) {
                error_msg = "dot in file name";
                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 >= G.block_buf + result || strcasecmp(mode, "octet") != 0) {
                goto err;
        }
-#if ENABLE_FEATURE_TFTP_BLOCKSIZE
+# if ENABLE_FEATURE_TFTP_BLOCKSIZE
        {
                char *res;
                char *opt_str = mode + sizeof("octet");
-               int opt_len = block_buf + result - opt_str;
+               int opt_len = G.block_buf + result - opt_str;
                if (opt_len > 0) {
                        res = tftp_get_option("blksize", opt_str, opt_len);
                        if (res) {
                                blksize = tftp_blksize_check(res, 65564);
                                if (blksize < 0) {
-                                       error_pkt_reason = ERR_BAD_OPT;
+                                       G_error_pkt_reason = ERR_BAD_OPT;
                                        /* will just send error pkt */
                                        goto do_proto;
                                }
                        }
+                       if (opcode != TFTP_WRQ /* download? */
                        /* did client ask us about file size? */
-                       tsize = tftp_get_option("tsize", opt_str, opt_len);
+                        && tftp_get_option("tsize", opt_str, opt_len)
+                       ) {
+                               want_transfer_size = 1;
+                       }
                }
        }
-#endif
+# endif
 
        if (!ENABLE_FEATURE_TFTP_PUT || opcode == TFTP_WRQ) {
                if (opt & TFTPD_OPT_r) {
                        /* This would mean "disk full" - not true */
-                       /*error_pkt_reason = ERR_WRITE;*/
+                       /*G_error_pkt_reason = ERR_WRITE;*/
                        error_msg = bb_msg_write_error;
                        goto err;
                }
@@ -747,7 +855,7 @@ int tftpd_main(int argc UNUSED_PARAM, char **argv)
                IF_GETPUT(option_mask32 |= TFTP_OPT_PUT;) /* will send file's data */
        }
 
-       /* NB: if error_pkt_str or error_pkt_reason is set up,
+       /* NB: if G_error_pkt_str or G_error_pkt_reason is set up,
         * tftp_protocol() just sends one error pkt and returns */
 
  do_proto:
@@ -756,13 +864,13 @@ 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(, tsize)
+               IF_FEATURE_TFTP_BLOCKSIZE(, want_transfer_size)
                IF_FEATURE_TFTP_BLOCKSIZE(, blksize)
        );
 
        return result;
  err:
-       strcpy((char*)error_pkt_str, error_msg);
+       strcpy(G_error_pkt_str, error_msg);
        goto do_proto;
 }