2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1983, 1993
5 * The Regents of the University of California. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 /* Many bug fixes are from Jim Guyton <guyton@rand-unix> */
35 * TFTP User Program -- Command Interface.
37 #include <sys/param.h>
39 #include <sys/socket.h>
41 #include <sys/sysctl.h>
43 #include <netinet/in.h>
44 #include <arpa/inet.h>
45 #include <arpa/tftp.h>
60 #include "tftp-utils.h"
62 #include "tftp-options.h"
65 #define MAXLINE (2 * MAXPATHLEN)
66 #define TIMEOUT 5 /* secs between rexmt's */
68 typedef struct sockaddr_storage peeraddr;
71 static jmp_buf toplevel;
72 static int txrx_error;
77 static char *margv[MAX_MARGV];
80 static char *port = NULL;
82 static void get(int, char **);
83 static void help(int, char **);
84 static void intr(int);
85 static void modecmd(int, char **);
86 static void put(int, char **);
87 static void quit(int, char **);
88 static void setascii(int, char **);
89 static void setbinary(int, char **);
90 static void setpeer0(char *, const char *);
91 static void setpeer(int, char **);
92 static void settimeoutpacket(int, char **);
93 static void settimeoutnetwork(int, char **);
94 static void setdebug(int, char **);
95 static void setverbose(int, char **);
96 static void showstatus(int, char **);
97 static void setblocksize(int, char **);
98 static void setblocksize2(int, char **);
99 static void setoptions(int, char **);
100 static void setrollover(int, char **);
101 static void setpacketdrop(int, char **);
102 static void setwindowsize(int, char **);
104 static void command(bool, EditLine *, History *, HistEvent *) __dead2;
105 static const char *command_prompt(void);
107 static void urihandling(char *URI);
108 static void getusage(char *);
109 static void makeargv(char *line);
110 static void putusage(char *);
111 static void settftpmode(const char *);
113 static char *tail(char *);
114 static const struct cmd *getcmd(const char *);
116 #define HELPINDENT (sizeof("connect"))
120 void (*handler)(int, char **);
124 static struct cmd cmdtab[] = {
125 { "connect", setpeer, "connect to remote tftp" },
126 { "mode", modecmd, "set file transfer mode" },
127 { "put", put, "send file" },
128 { "get", get, "receive file" },
129 { "quit", quit, "exit tftp" },
130 { "verbose", setverbose, "toggle verbose mode" },
131 { "status", showstatus, "show current status" },
132 { "binary", setbinary, "set mode to octet" },
133 { "ascii", setascii, "set mode to netascii" },
134 { "rexmt", settimeoutpacket,
135 "set per-packet retransmission timeout[-]" },
136 { "timeout", settimeoutnetwork,
137 "set total retransmission timeout" },
138 { "trace", setdebug, "enable 'debug packet'[-]" },
139 { "debug", setdebug, "enable verbose output" },
140 { "blocksize", setblocksize, "set blocksize[*]" },
141 { "blocksize2", setblocksize2, "set blocksize as a power of 2[**]" },
142 { "rollover", setrollover, "rollover after 64K packets[**]" },
143 { "options", setoptions,
144 "enable or disable RFC2347 style options" },
145 { "help", help, "print help information" },
146 { "packetdrop", setpacketdrop, "artificial packetloss feature" },
147 { "windowsize", setwindowsize, "set windowsize[*]" },
148 { "?", help, "print help information" },
152 static struct modes {
156 { "ascii", "netascii" },
157 { "netascii", "netascii" },
158 { "binary", "octet" },
159 { "image", "octet" },
160 { "octet", "octet" },
165 main(int argc, char *argv[])
169 static History *hist;
172 acting_as_client = 1;
174 strcpy(mode, "octet");
175 signal(SIGINT, intr);
177 interactive = isatty(STDIN_FILENO);
179 el = el_init("tftp", stdin, stdout, stderr);
180 hist = history_init();
181 history(hist, &he, H_SETSIZE, 100);
182 el_set(el, EL_HIST, history, hist);
183 el_set(el, EL_EDITOR, "emacs");
184 el_set(el, EL_PROMPT, command_prompt);
185 el_set(el, EL_SIGNAL, 1);
190 if (setjmp(toplevel) != 0)
193 if (strncmp(argv[1], "tftp://", 7) == 0) {
194 urihandling(argv[1]);
201 if (setjmp(toplevel) != 0) {
208 command(interactive, el, hist, &he);
212 * RFC3617 handling of TFTP URIs:
214 * tftpURI = "tftp://" host "/" file [ mode ]
215 * mode = ";" "mode=" ( "netascii" / "octet" )
216 * file = *( unreserved / escaped )
217 * host = <as specified by RFC 2732>
218 * unreserved = <as specified in RFC 2396>
219 * escaped = <as specified in RFC 2396>
221 * We are cheating a little bit by allowing any mode as specified in the
222 * modes table defined earlier on in this file and mapping it on the real
226 urihandling(char *URI)
232 const char *tmode = "octet";
237 strlcpy(uri, URI, ARG_MAX);
240 if ((s = strchr(host, '/')) == NULL) {
242 "Invalid URI: Couldn't find / after hostname\n");
248 if ((s = strchr(path, ';')) != NULL) {
252 if (strncmp(opts, "mode=", 5) == 0) {
256 for (i = 0; modes[i].m_name != NULL; i++) {
257 if (strcmp(modes[i].m_name, tmode) == 0)
260 if (modes[i].m_name == NULL) {
261 fprintf(stderr, "Invalid mode: '%s'\n", mode);
264 settftpmode(modes[i].m_mode);
267 settftpmode("octet");
270 setpeer0(host, NULL);
272 sprintf(line, "get %s", path);
277 static char hostname[MAXHOSTNAMELEN];
280 setpeer0(char *host, const char *lport)
282 struct addrinfo hints, *res0, *res;
284 const char *cause = "unknown";
292 memset(&hints, 0, sizeof(hints));
293 hints.ai_family = PF_UNSPEC;
294 hints.ai_socktype = SOCK_DGRAM;
295 hints.ai_protocol = IPPROTO_UDP;
296 hints.ai_flags = AI_CANONNAME;
299 error = getaddrinfo(host, lport, &hints, &res0);
301 warnx("%s", gai_strerror(error));
305 for (res = res0; res; res = res->ai_next) {
306 if (res->ai_addrlen > sizeof(peeraddr))
308 peer = socket(res->ai_family, res->ai_socktype,
315 memset(&peer_sock, 0, sizeof(peer_sock));
316 peer_sock.ss_family = res->ai_family;
317 peer_sock.ss_len = res->ai_addrlen;
318 if (bind(peer, (struct sockaddr *)&peer_sock, peer_sock.ss_len) < 0) {
331 /* res->ai_addr <= sizeof(peeraddr) is guaranteed */
332 memcpy(&peer_sock, res->ai_addr, res->ai_addrlen);
333 if (res->ai_canonname) {
334 (void) strlcpy(hostname, res->ai_canonname,
337 (void) strlcpy(hostname, host, sizeof(hostname));
345 setpeer(int argc, char *argv[])
350 strcpy(line, "Connect ");
352 fgets(&line[strlen(line)], sizeof line - strlen(line), stdin);
357 if ((argc < 2) || (argc > 3)) {
358 printf("usage: %s [host [port]]\n", argv[0]);
363 setpeer0(argv[1], argv[2]);
365 setpeer0(argv[1], NULL);
369 modecmd(int argc, char *argv[])
375 printf("Using %s mode to transfer files.\n", mode);
379 for (p = modes; p->m_name; p++)
380 if (strcmp(argv[1], p->m_name) == 0)
383 settftpmode(p->m_mode);
386 printf("%s: unknown mode\n", argv[1]);
387 /* drop through and print usage message */
390 printf("usage: %s [", argv[0]);
392 for (p = modes; p->m_name != NULL; p++) {
393 printf("%s%s", sep, p->m_name);
402 setbinary(int argc __unused, char *argv[] __unused)
405 settftpmode("octet");
409 setascii(int argc __unused, char *argv[] __unused)
412 settftpmode("netascii");
416 settftpmode(const char *newmode)
419 strlcpy(mode, newmode, sizeof(mode));
421 printf("mode set to %s\n", mode);
429 put(int argc, char *argv[])
433 char *cp, *targ, *path;
438 strcpy(line, "send ");
440 fgets(&line[strlen(line)], sizeof line - strlen(line), stdin);
449 targ = argv[argc - 1];
450 if (strrchr(argv[argc - 1], ':')) {
453 for (n = 1; n < argc - 1; n++)
454 if (strchr(argv[n], ':')) {
458 lcp = argv[argc - 1];
459 targ = strrchr(lcp, ':');
461 if (lcp[0] == '[' && lcp[strlen(lcp) - 1] == ']') {
462 lcp[strlen(lcp) - 1] = '\0';
468 printf("No target machine specified.\n");
472 cp = argc == 2 ? tail(targ) : argv[1];
473 fd = open(cp, O_RDONLY);
479 if (fstat(fd, &sb) < 0) {
484 options_set_request(OPT_TSIZE, "%ju", (uintmax_t)sb.st_size);
487 printf("putting %s to %s:%s [%s]\n",
488 cp, hostname, targ, mode);
489 if (xmitfile(peer, port, fd, targ, mode))
494 /* this assumes the target is a directory */
495 /* on a remote unix system. hmmmm. */
496 for (n = 1; n < argc - 1; n++) {
497 if (asprintf(&path, "%s/%s", targ, tail(argv[n])) < 0)
500 fd = open(argv[n], O_RDONLY);
507 if (fstat(fd, &sb) < 0) {
513 options_set_request(OPT_TSIZE, "%ju", (uintmax_t)sb.st_size);
516 printf("putting %s to %s:%s [%s]\n",
517 argv[n], hostname, path, mode);
518 if (xmitfile(peer, port, fd, path, mode) != 0)
530 printf("usage: %s file [remotename]\n", s);
531 printf(" %s file host:remotename\n", s);
532 printf(" %s file1 file2 ... fileN [[host:]remote-directory]\n", s);
539 get(int argc, char *argv[])
548 strcpy(line, "get ");
550 fgets(&line[strlen(line)], sizeof line - strlen(line), stdin);
560 for (n = 1; n < argc ; n++)
561 if (strrchr(argv[n], ':') == 0) {
562 printf("No remote host specified and "
563 "no host given for file '%s'\n", argv[n]);
568 for (n = 1; n < argc ; n++) {
569 src = strrchr(argv[n], ':');
577 if (lcp[0] == '[' && lcp[strlen(lcp) - 1] == ']') {
578 lcp[strlen(lcp) - 1] = '\0';
586 cp = argc == 3 ? argv[2] : tail(src);
587 fd = creat(cp, 0644);
593 printf("getting from %s:%s to %s [%s]\n",
594 hostname, src, cp, mode);
595 if (recvfile(peer, port, fd, src, mode) != 0)
599 cp = tail(src); /* new .. jdg */
600 fd = creat(cp, 0644);
606 printf("getting from %s:%s to %s [%s]\n",
607 hostname, src, cp, mode);
608 if (recvfile(peer, port, fd, src, mode) != 0)
617 printf("usage: %s file [localname]\n", s);
618 printf(" %s [host:]file [localname]\n", s);
619 printf(" %s [host1:]file1 [host2:]file2 ... [hostN:]fileN\n", s);
623 settimeoutpacket(int argc, char *argv[])
629 strcpy(line, "Packet timeout ");
631 fgets(&line[strlen(line)], sizeof line - strlen(line), stdin);
637 printf("usage: %s value\n", argv[0]);
642 printf("%s: bad value\n", argv[1]);
646 settimeouts(t, timeoutnetwork, maxtimeouts);
650 settimeoutnetwork(int argc, char *argv[])
656 strcpy(line, "Network timeout ");
658 fgets(&line[strlen(line)], sizeof line - strlen(line), stdin);
664 printf("usage: %s value\n", argv[0]);
669 printf("%s: bad value\n", argv[1]);
673 settimeouts(timeoutpacket, t, maxtimeouts);
677 showstatus(int argc __unused, char *argv[] __unused)
680 printf("Remote host: %s\n",
681 connected ? hostname : "none specified yet");
682 printf("RFC2347 Options support: %s\n",
683 options_rfc_enabled ? "enabled" : "disabled");
684 printf("Non-RFC defined options support: %s\n",
685 options_extra_enabled ? "enabled" : "disabled");
686 printf("Mode: %s\n", mode);
687 printf("Verbose: %s\n", verbose ? "on" : "off");
688 printf("Debug: %s\n", debug_show(debug));
689 printf("Artificial packetloss: %d in 100 packets\n",
690 packetdroppercentage);
691 printf("Segment size: %d bytes\n", segsize);
692 printf("Network timeout: %d seconds\n", timeoutpacket);
693 printf("Maximum network timeout: %d seconds\n", timeoutnetwork);
694 printf("Maximum timeouts: %d \n", maxtimeouts);
698 intr(int dummy __unused)
701 signal(SIGALRM, SIG_IGN);
703 longjmp(toplevel, -1);
712 s = strrchr(filename, '/');
733 command(bool interactive, EditLine *el, History *hist, HistEvent *hep)
743 if ((bp = el_gets(el, &num)) == NULL || num == 0)
745 len = MIN(MAXLINE, num);
746 memcpy(line, bp, len);
747 line[len - 1] = '\0';
748 history(hist, hep, H_ENTER, bp);
751 if (fgets(line, sizeof line , stdin) == NULL) {
759 if ((cp = strchr(line, '\n')))
766 c = getcmd(margv[0]);
767 if (c == (struct cmd *)-1) {
768 printf("?Ambiguous command\n");
772 printf("?Invalid command\n");
775 (*c->handler)(margc, margv);
779 static const struct cmd *
780 getcmd(const char *name)
783 const struct cmd *c, *found;
790 for (c = cmdtab; (p = c->name) != NULL; c++) {
791 for (q = name; *q == *p++; q++)
792 if (*q == '\0') /* exact match? */
794 if (*q == '\0') { /* the name was a prefix */
795 if (q - name > longest) {
799 } else if (q - name == longest)
804 return ((struct cmd *)-1);
809 * Slice a string up into argc/argv.
818 if ((cp = strchr(line, '\n')) != NULL)
820 for (cp = line; margc < MAX_MARGV - 1 && *cp != '\0';) {
827 while (*cp != '\0' && !isspace(*cp))
837 quit(int argc __unused, char *argv[] __unused)
847 help(int argc, char *argv[])
852 printf("Commands may be abbreviated. Commands are:\n\n");
853 for (c = cmdtab; c->name; c++)
854 printf("%-*s\t%s\n", (int)HELPINDENT, c->name, c->help);
856 printf("\n[-] : You shouldn't use these ones anymore.\n");
857 printf("[*] : RFC2347 options support required.\n");
858 printf("[**] : Non-standard RFC2347 option.\n");
865 if (c == (struct cmd *)-1)
866 printf("?Ambiguous help command: %s\n", arg);
867 else if (c == (struct cmd *)0)
868 printf("?Invalid help command: %s\n", arg);
870 printf("%s\n", c->help);
875 setverbose(int argc __unused, char *argv[] __unused)
879 printf("Verbose mode %s.\n", verbose ? "on" : "off");
883 setoptions(int argc, char *argv[])
887 if (strcasecmp(argv[1], "enable") == 0 ||
888 strcasecmp(argv[1], "on") == 0) {
889 options_extra_enabled = 1;
890 options_rfc_enabled = 1;
892 if (strcasecmp(argv[1], "disable") == 0 ||
893 strcasecmp(argv[1], "off") == 0) {
894 options_extra_enabled = 0;
895 options_rfc_enabled = 0;
897 if (strcasecmp(argv[1], "extra") == 0)
898 options_extra_enabled = !options_extra_enabled;
900 printf("Support for RFC2347 style options are now %s.\n",
901 options_rfc_enabled ? "enabled" : "disabled");
902 printf("Support for non-RFC defined options are now %s.\n",
903 options_extra_enabled ? "enabled" : "disabled");
905 printf("\nThe following options are available:\n"
906 "\toptions on : enable support for RFC2347 style options\n"
907 "\toptions off : disable support for RFC2347 style options\n"
908 "\toptions extra : toggle support for non-RFC defined options\n"
913 setrollover(int argc, char *argv[])
917 if (strcasecmp(argv[1], "never") == 0 ||
918 strcasecmp(argv[1], "none") == 0) {
919 options_set_request(OPT_ROLLOVER, NULL);
921 if (strcasecmp(argv[1], "1") == 0) {
922 options_set_request(OPT_ROLLOVER, "1");
924 if (strcasecmp(argv[1], "0") == 0) {
925 options_set_request(OPT_ROLLOVER, "0");
928 printf("Support for the rollover options is %s.\n",
929 options[OPT_ROLLOVER].o_request != NULL ? "enabled" : "disabled");
930 if (options[OPT_ROLLOVER].o_request != NULL)
931 printf("Block rollover will be to block %s.\n",
932 options[OPT_ROLLOVER].o_request);
935 printf("\nThe following rollover options are available:\n"
936 "\trollover 0 : rollover to block zero (default)\n"
937 "\trollover 1 : rollover to block one\n"
938 "\trollover never : do not support the rollover option\n"
939 "\trollover none : do not support the rollover option\n"
944 setdebug(int argc, char *argv[])
951 debug ^= debug_find(argv[i++]);
953 printf("The following debugging is enabled: %s\n", debug_show(debug));
955 printf("\nThe following debugs are available:\n");
957 while (debugs[i].name != NULL) {
958 printf("\t%s\t%s\n", debugs[i].name, debugs[i].desc);
964 setblocksize(int argc, char *argv[])
967 if (!options_rfc_enabled)
968 printf("RFC2347 style options are not enabled "
969 "(but proceeding anyway)\n");
972 int size = atoi(argv[1]);
976 max = sizeof(maxdgram);
977 if (sysctlbyname("net.inet.udp.maxdgram",
978 &maxdgram, &max, NULL, 0) < 0) {
979 perror("sysctl: net.inet.udp.maxdgram");
983 if (size < BLKSIZE_MIN || size > BLKSIZE_MAX) {
984 printf("Blocksize should be between %d and %d bytes.\n",
985 BLKSIZE_MIN, BLKSIZE_MAX);
987 } else if (size > (int)maxdgram - 4) {
988 printf("Blocksize can't be bigger than %ld bytes due "
989 "to the net.inet.udp.maxdgram sysctl limitation.\n",
991 options_set_request(OPT_BLKSIZE, "%ld", maxdgram - 4);
993 options_set_request(OPT_BLKSIZE, "%d", size);
996 printf("Blocksize is now %s bytes.\n", options[OPT_BLKSIZE].o_request);
1000 setblocksize2(int argc, char *argv[])
1003 if (!options_rfc_enabled || !options_extra_enabled)
1005 "RFC2347 style or non-RFC defined options are not enabled "
1006 "(but proceeding anyway)\n");
1009 int size = atoi(argv[1]);
1015 8, 16, 32, 64, 128, 256, 512, 1024,
1016 2048, 4096, 8192, 16384, 32768, 0
1019 max = sizeof(maxdgram);
1020 if (sysctlbyname("net.inet.udp.maxdgram",
1021 &maxdgram, &max, NULL, 0) < 0) {
1022 perror("sysctl: net.inet.udp.maxdgram");
1026 for (i = 0; sizes[i] != 0; i++) {
1027 if (sizes[i] == size) break;
1029 if (sizes[i] == 0) {
1030 printf("Blocksize2 should be a power of two between "
1035 if (size < BLKSIZE_MIN || size > BLKSIZE_MAX) {
1036 printf("Blocksize2 should be between "
1037 "%d and %d bytes.\n", BLKSIZE_MIN, BLKSIZE_MAX);
1039 } else if (size > (int)maxdgram - 4) {
1040 printf("Blocksize2 can't be bigger than %ld bytes due "
1041 "to the net.inet.udp.maxdgram sysctl limitation.\n",
1043 for (i = 0; sizes[i+1] != 0; i++) {
1044 if ((int)maxdgram < sizes[i+1]) break;
1046 options_set_request(OPT_BLKSIZE2, "%d", sizes[i]);
1048 options_set_request(OPT_BLKSIZE2, "%d", size);
1051 printf("Blocksize2 is now %s bytes.\n",
1052 options[OPT_BLKSIZE2].o_request);
1056 setpacketdrop(int argc, char *argv[])
1060 packetdroppercentage = atoi(argv[1]);
1062 printf("Randomly %d in 100 packets will be dropped\n",
1063 packetdroppercentage);
1067 setwindowsize(int argc, char *argv[])
1070 if (!options_rfc_enabled)
1071 printf("RFC2347 style options are not enabled "
1072 "(but proceeding anyway)\n");
1075 int size = atoi(argv[1]);
1077 if (size < WINDOWSIZE_MIN || size > WINDOWSIZE_MAX) {
1078 printf("Windowsize should be between %d and %d "
1079 "blocks.\n", WINDOWSIZE_MIN, WINDOWSIZE_MAX);
1082 options_set_request(OPT_WINDOWSIZE, "%d", size);
1085 printf("Windowsize is now %s blocks.\n",
1086 options[OPT_WINDOWSIZE].o_request);