1 /* $OpenBSD: misc.c,v 1.85 2011/03/29 18:54:17 stevesk Exp $ */
3 * Copyright (c) 2000 Markus Friedl. All rights reserved.
4 * Copyright (c) 2005,2006 Damien Miller. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 #include <sys/types.h>
30 #include <sys/ioctl.h>
31 #include <sys/socket.h>
32 #include <sys/param.h>
41 #include <netinet/in.h>
42 #include <netinet/in_systm.h>
43 #include <netinet/ip.h>
44 #include <netinet/tcp.h>
53 #ifdef SSH_TUN_OPENBSD
62 /* remove newline at end of string */
68 if (*t == '\n' || *t == '\r') {
78 /* set/unset filedescriptor to non-blocking */
84 val = fcntl(fd, F_GETFL, 0);
86 error("fcntl(%d, F_GETFL, 0): %s", fd, strerror(errno));
89 if (val & O_NONBLOCK) {
90 debug3("fd %d is O_NONBLOCK", fd);
93 debug2("fd %d setting O_NONBLOCK", fd);
95 if (fcntl(fd, F_SETFL, val) == -1) {
96 debug("fcntl(%d, F_SETFL, O_NONBLOCK): %s", fd,
104 unset_nonblock(int fd)
108 val = fcntl(fd, F_GETFL, 0);
110 error("fcntl(%d, F_GETFL, 0): %s", fd, strerror(errno));
113 if (!(val & O_NONBLOCK)) {
114 debug3("fd %d is not O_NONBLOCK", fd);
117 debug("fd %d clearing O_NONBLOCK", fd);
119 if (fcntl(fd, F_SETFL, val) == -1) {
120 debug("fcntl(%d, F_SETFL, ~O_NONBLOCK): %s",
121 fd, strerror(errno));
128 ssh_gai_strerror(int gaierr)
130 if (gaierr == EAI_SYSTEM)
131 return strerror(errno);
132 return gai_strerror(gaierr);
135 /* disable nagle on socket */
143 if (getsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &opt, &optlen) == -1) {
144 debug("getsockopt TCP_NODELAY: %.100s", strerror(errno));
148 debug2("fd %d is TCP_NODELAY", fd);
152 debug2("fd %d setting TCP_NODELAY", fd);
153 if (setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &opt, sizeof opt) == -1)
154 error("setsockopt TCP_NODELAY: %.100s", strerror(errno));
157 /* Characters considered whitespace in strsep calls. */
158 #define WHITESPACE " \t\r\n"
161 /* return next token in configuration line */
173 *s = strpbrk(*s, WHITESPACE QUOTE "=");
178 memmove(*s, *s + 1, strlen(*s)); /* move nul too */
179 /* Find matching quote */
180 if ((*s = strpbrk(*s, QUOTE)) == NULL) {
181 return (NULL); /* no matching quote */
184 *s += strspn(*s + 1, WHITESPACE) + 1;
189 /* Allow only one '=' to be skipped */
194 /* Skip any extra whitespace after first token */
195 *s += strspn(*s + 1, WHITESPACE) + 1;
196 if (*s[0] == '=' && !wspace)
197 *s += strspn(*s + 1, WHITESPACE) + 1;
203 pwcopy(struct passwd *pw)
205 struct passwd *copy = xcalloc(1, sizeof(*copy));
207 copy->pw_name = xstrdup(pw->pw_name);
208 copy->pw_passwd = pw->pw_passwd ? xstrdup(pw->pw_passwd) : NULL;
209 #ifdef HAVE_PW_GECOS_IN_PASSWD
210 copy->pw_gecos = xstrdup(pw->pw_gecos);
212 copy->pw_uid = pw->pw_uid;
213 copy->pw_gid = pw->pw_gid;
214 #ifdef HAVE_PW_EXPIRE_IN_PASSWD
215 copy->pw_expire = pw->pw_expire;
217 #ifdef HAVE_PW_CHANGE_IN_PASSWD
218 copy->pw_change = pw->pw_change;
220 #ifdef HAVE_PW_CLASS_IN_PASSWD
221 copy->pw_class = xstrdup(pw->pw_class);
223 copy->pw_dir = xstrdup(pw->pw_dir);
224 copy->pw_shell = xstrdup(pw->pw_shell);
229 * Convert ASCII string to TCP/IP port number.
230 * Port must be >=0 and <=65535.
231 * Return -1 if invalid.
234 a2port(const char *s)
239 port = strtonum(s, 0, 65535, &errstr);
246 a2tun(const char *s, int *remote)
248 const char *errstr = NULL;
252 if (remote != NULL) {
253 *remote = SSH_TUNID_ANY;
255 if ((ep = strchr(sp, ':')) == NULL) {
257 return (a2tun(s, NULL));
260 *remote = a2tun(ep, NULL);
261 tun = a2tun(sp, NULL);
263 return (*remote == SSH_TUNID_ERR ? *remote : tun);
266 if (strcasecmp(s, "any") == 0)
267 return (SSH_TUNID_ANY);
269 tun = strtonum(s, 0, SSH_TUNID_MAX, &errstr);
271 return (SSH_TUNID_ERR);
277 #define MINUTES (SECONDS * 60)
278 #define HOURS (MINUTES * 60)
279 #define DAYS (HOURS * 24)
280 #define WEEKS (DAYS * 7)
283 * Convert a time string into seconds; format is
287 * Valid time qualifiers are:
301 * Return -1 if time string is invalid.
304 convtime(const char *s)
314 if (p == NULL || *p == '\0')
318 secs = strtol(p, &endp, 10);
320 (errno == ERANGE && (secs == LONG_MIN || secs == LONG_MAX)) ||
360 * Returns a standardized host+port identifier string.
361 * Caller must free returned string.
364 put_host_port(const char *host, u_short port)
368 if (port == 0 || port == SSH_DEFAULT_PORT)
369 return(xstrdup(host));
370 if (asprintf(&hoststr, "[%s]:%d", host, (int)port) < 0)
371 fatal("put_host_port: asprintf: %s", strerror(errno));
372 debug3("put_host_port: %s", hoststr);
377 * Search for next delimiter between hostnames/addresses and ports.
378 * Argument may be modified (for termination).
379 * Returns *cp if parsing succeeds.
380 * *cp is set to the start of the next delimiter, if one was found.
381 * If this is the last field, *cp is set to NULL.
388 if (cp == NULL || *cp == NULL)
393 if ((s = strchr(s, ']')) == NULL)
397 } else if ((s = strpbrk(s, ":/")) == NULL)
398 s = *cp + strlen(*cp); /* skip to end (see first case below) */
402 *cp = NULL; /* no more fields*/
407 *s = '\0'; /* terminate */
419 cleanhostname(char *host)
421 if (*host == '[' && host[strlen(host) - 1] == ']') {
422 host[strlen(host) - 1] = '\0';
433 if (*cp == ':') /* Leading colon is part of file name. */
439 if (*cp == '@' && *(cp+1) == '[')
441 if (*cp == ']' && *(cp+1) == ':' && flag)
443 if (*cp == ':' && !flag)
451 /* function to assist building execv() arguments */
453 addargs(arglist *args, char *fmt, ...)
461 r = vasprintf(&cp, fmt, ap);
464 fatal("addargs: argument too long");
466 nalloc = args->nalloc;
467 if (args->list == NULL) {
470 } else if (args->num+2 >= nalloc)
473 args->list = xrealloc(args->list, nalloc, sizeof(char *));
474 args->nalloc = nalloc;
475 args->list[args->num++] = cp;
476 args->list[args->num] = NULL;
480 replacearg(arglist *args, u_int which, char *fmt, ...)
487 r = vasprintf(&cp, fmt, ap);
490 fatal("replacearg: argument too long");
492 if (which >= args->num)
493 fatal("replacearg: tried to replace invalid arg %d >= %d",
495 xfree(args->list[which]);
496 args->list[which] = cp;
500 freeargs(arglist *args)
504 if (args->list != NULL) {
505 for (i = 0; i < args->num; i++)
506 xfree(args->list[i]);
508 args->nalloc = args->num = 0;
514 * Expands tildes in the file name. Returns data allocated by xmalloc.
515 * Warning: this calls getpw*.
518 tilde_expand_filename(const char *filename, uid_t uid)
521 char user[128], ret[MAXPATHLEN];
525 if (*filename != '~')
526 return (xstrdup(filename));
529 path = strchr(filename, '/');
530 if (path != NULL && path > filename) { /* ~user/path */
531 slash = path - filename;
532 if (slash > sizeof(user) - 1)
533 fatal("tilde_expand_filename: ~username too long");
534 memcpy(user, filename, slash);
536 if ((pw = getpwnam(user)) == NULL)
537 fatal("tilde_expand_filename: No such user %s", user);
538 } else if ((pw = getpwuid(uid)) == NULL) /* ~/path */
539 fatal("tilde_expand_filename: No such uid %ld", (long)uid);
541 if (strlcpy(ret, pw->pw_dir, sizeof(ret)) >= sizeof(ret))
542 fatal("tilde_expand_filename: Path too long");
544 /* Make sure directory has a trailing '/' */
545 len = strlen(pw->pw_dir);
546 if ((len == 0 || pw->pw_dir[len - 1] != '/') &&
547 strlcat(ret, "/", sizeof(ret)) >= sizeof(ret))
548 fatal("tilde_expand_filename: Path too long");
550 /* Skip leading '/' from specified path */
553 if (strlcat(ret, filename, sizeof(ret)) >= sizeof(ret))
554 fatal("tilde_expand_filename: Path too long");
556 return (xstrdup(ret));
560 * Expand a string with a set of %[char] escapes. A number of escapes may be
561 * specified as (char *escape_chars, char *replacement) pairs. The list must
562 * be terminated by a NULL escape_char. Returns replaced string in memory
563 * allocated by xmalloc.
566 percent_expand(const char *string, ...)
568 #define EXPAND_MAX_KEYS 16
569 u_int num_keys, i, j;
573 } keys[EXPAND_MAX_KEYS];
578 va_start(ap, string);
579 for (num_keys = 0; num_keys < EXPAND_MAX_KEYS; num_keys++) {
580 keys[num_keys].key = va_arg(ap, char *);
581 if (keys[num_keys].key == NULL)
583 keys[num_keys].repl = va_arg(ap, char *);
584 if (keys[num_keys].repl == NULL)
585 fatal("%s: NULL replacement", __func__);
587 if (num_keys == EXPAND_MAX_KEYS && va_arg(ap, char *) != NULL)
588 fatal("%s: too many keys", __func__);
593 for (i = 0; *string != '\0'; string++) {
594 if (*string != '%') {
597 if (i >= sizeof(buf))
598 fatal("%s: string too long", __func__);
606 for (j = 0; j < num_keys; j++) {
607 if (strchr(keys[j].key, *string) != NULL) {
608 i = strlcat(buf, keys[j].repl, sizeof(buf));
609 if (i >= sizeof(buf))
610 fatal("%s: string too long", __func__);
615 fatal("%s: unknown key %%%c", __func__, *string);
617 return (xstrdup(buf));
618 #undef EXPAND_MAX_KEYS
622 * Read an entire line from a public key file into a static buffer, discarding
623 * lines that exceed the buffer size. Returns 0 on success, -1 on failure.
626 read_keyfile_line(FILE *f, const char *filename, char *buf, size_t bufsz,
629 while (fgets(buf, bufsz, f) != NULL) {
633 if (buf[strlen(buf) - 1] == '\n' || feof(f)) {
636 debug("%s: %s line %lu exceeds size limit", __func__,
638 /* discard remainder of line */
639 while (fgetc(f) != '\n' && !feof(f))
647 tun_open(int tun, int mode)
649 #if defined(CUSTOM_SYS_TUN_OPEN)
650 return (sys_tun_open(tun, mode));
651 #elif defined(SSH_TUN_OPENBSD)
656 /* Open the tunnel device */
657 if (tun <= SSH_TUNID_MAX) {
658 snprintf(name, sizeof(name), "/dev/tun%d", tun);
659 fd = open(name, O_RDWR);
660 } else if (tun == SSH_TUNID_ANY) {
661 for (tun = 100; tun >= 0; tun--) {
662 snprintf(name, sizeof(name), "/dev/tun%d", tun);
663 if ((fd = open(name, O_RDWR)) >= 0)
667 debug("%s: invalid tunnel %u", __func__, tun);
672 debug("%s: %s open failed: %s", __func__, name, strerror(errno));
676 debug("%s: %s mode %d fd %d", __func__, name, mode, fd);
678 /* Set the tunnel device operation mode */
679 snprintf(ifr.ifr_name, sizeof(ifr.ifr_name), "tun%d", tun);
680 if ((sock = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
683 if (ioctl(sock, SIOCGIFFLAGS, &ifr) == -1)
686 /* Set interface mode */
687 ifr.ifr_flags &= ~IFF_UP;
688 if (mode == SSH_TUNMODE_ETHERNET)
689 ifr.ifr_flags |= IFF_LINK0;
691 ifr.ifr_flags &= ~IFF_LINK0;
692 if (ioctl(sock, SIOCSIFFLAGS, &ifr) == -1)
695 /* Bring interface up */
696 ifr.ifr_flags |= IFF_UP;
697 if (ioctl(sock, SIOCSIFFLAGS, &ifr) == -1)
708 debug("%s: failed to set %s mode %d: %s", __func__, name,
709 mode, strerror(errno));
712 error("Tunnel interfaces are not supported on this platform");
722 if ((nullfd = dupfd = open(_PATH_DEVNULL, O_RDWR)) == -1) {
723 fprintf(stderr, "Couldn't open /dev/null: %s\n",
727 while (++dupfd <= 2) {
728 /* Only clobber closed fds */
729 if (fcntl(dupfd, F_GETFL, 0) >= 0)
731 if (dup2(nullfd, dupfd) == -1) {
732 fprintf(stderr, "dup2: %s\n", strerror(errno));
741 tohex(const void *vp, size_t l)
743 const u_char *p = (const u_char *)vp;
748 return xstrdup("tohex: length > 65536");
752 for (i = 0; i < l; i++) {
753 snprintf(b, sizeof(b), "%02x", p[i]);
760 get_u64(const void *vp)
762 const u_char *p = (const u_char *)vp;
765 v = (u_int64_t)p[0] << 56;
766 v |= (u_int64_t)p[1] << 48;
767 v |= (u_int64_t)p[2] << 40;
768 v |= (u_int64_t)p[3] << 32;
769 v |= (u_int64_t)p[4] << 24;
770 v |= (u_int64_t)p[5] << 16;
771 v |= (u_int64_t)p[6] << 8;
772 v |= (u_int64_t)p[7];
778 get_u32(const void *vp)
780 const u_char *p = (const u_char *)vp;
783 v = (u_int32_t)p[0] << 24;
784 v |= (u_int32_t)p[1] << 16;
785 v |= (u_int32_t)p[2] << 8;
786 v |= (u_int32_t)p[3];
792 get_u16(const void *vp)
794 const u_char *p = (const u_char *)vp;
797 v = (u_int16_t)p[0] << 8;
798 v |= (u_int16_t)p[1];
804 put_u64(void *vp, u_int64_t v)
806 u_char *p = (u_char *)vp;
808 p[0] = (u_char)(v >> 56) & 0xff;
809 p[1] = (u_char)(v >> 48) & 0xff;
810 p[2] = (u_char)(v >> 40) & 0xff;
811 p[3] = (u_char)(v >> 32) & 0xff;
812 p[4] = (u_char)(v >> 24) & 0xff;
813 p[5] = (u_char)(v >> 16) & 0xff;
814 p[6] = (u_char)(v >> 8) & 0xff;
815 p[7] = (u_char)v & 0xff;
819 put_u32(void *vp, u_int32_t v)
821 u_char *p = (u_char *)vp;
823 p[0] = (u_char)(v >> 24) & 0xff;
824 p[1] = (u_char)(v >> 16) & 0xff;
825 p[2] = (u_char)(v >> 8) & 0xff;
826 p[3] = (u_char)v & 0xff;
831 put_u16(void *vp, u_int16_t v)
833 u_char *p = (u_char *)vp;
835 p[0] = (u_char)(v >> 8) & 0xff;
836 p[1] = (u_char)v & 0xff;
840 ms_subtract_diff(struct timeval *start, int *ms)
842 struct timeval diff, finish;
844 gettimeofday(&finish, NULL);
845 timersub(&finish, start, &diff);
846 *ms -= (diff.tv_sec * 1000) + (diff.tv_usec / 1000);
850 ms_to_timeval(struct timeval *tv, int ms)
854 tv->tv_sec = ms / 1000;
855 tv->tv_usec = (ms % 1000) * 1000;
859 bandwidth_limit_init(struct bwlimit *bw, u_int64_t kbps, size_t buflen)
863 bw->thresh = bw->rate;
865 timerclear(&bw->bwstart);
866 timerclear(&bw->bwend);
869 /* Callback from read/write loop to insert bandwidth-limiting delays */
871 bandwidth_limit(struct bwlimit *bw, size_t read_len)
874 struct timespec ts, rm;
876 if (!timerisset(&bw->bwstart)) {
877 gettimeofday(&bw->bwstart, NULL);
881 bw->lamt += read_len;
882 if (bw->lamt < bw->thresh)
885 gettimeofday(&bw->bwend, NULL);
886 timersub(&bw->bwend, &bw->bwstart, &bw->bwend);
887 if (!timerisset(&bw->bwend))
891 waitlen = (double)1000000L * bw->lamt / bw->rate;
893 bw->bwstart.tv_sec = waitlen / 1000000L;
894 bw->bwstart.tv_usec = waitlen % 1000000L;
896 if (timercmp(&bw->bwstart, &bw->bwend, >)) {
897 timersub(&bw->bwstart, &bw->bwend, &bw->bwend);
899 /* Adjust the wait time */
900 if (bw->bwend.tv_sec) {
902 if (bw->thresh < bw->buflen / 4)
903 bw->thresh = bw->buflen / 4;
904 } else if (bw->bwend.tv_usec < 10000) {
906 if (bw->thresh > bw->buflen * 8)
907 bw->thresh = bw->buflen * 8;
910 TIMEVAL_TO_TIMESPEC(&bw->bwend, &ts);
911 while (nanosleep(&ts, &rm) == -1) {
919 gettimeofday(&bw->bwstart, NULL);
922 /* Make a template filename for mk[sd]temp() */
924 mktemp_proto(char *s, size_t len)
929 if ((tmpdir = getenv("TMPDIR")) != NULL) {
930 r = snprintf(s, len, "%s/ssh-XXXXXXXXXXXX", tmpdir);
931 if (r > 0 && (size_t)r < len)
934 r = snprintf(s, len, "/tmp/ssh-XXXXXXXXXXXX");
935 if (r < 0 || (size_t)r >= len)
936 fatal("%s: template string too short", __func__);
939 static const struct {
943 { "af11", IPTOS_DSCP_AF11 },
944 { "af12", IPTOS_DSCP_AF12 },
945 { "af13", IPTOS_DSCP_AF13 },
946 { "af14", IPTOS_DSCP_AF21 },
947 { "af22", IPTOS_DSCP_AF22 },
948 { "af23", IPTOS_DSCP_AF23 },
949 { "af31", IPTOS_DSCP_AF31 },
950 { "af32", IPTOS_DSCP_AF32 },
951 { "af33", IPTOS_DSCP_AF33 },
952 { "af41", IPTOS_DSCP_AF41 },
953 { "af42", IPTOS_DSCP_AF42 },
954 { "af43", IPTOS_DSCP_AF43 },
955 { "cs0", IPTOS_DSCP_CS0 },
956 { "cs1", IPTOS_DSCP_CS1 },
957 { "cs2", IPTOS_DSCP_CS2 },
958 { "cs3", IPTOS_DSCP_CS3 },
959 { "cs4", IPTOS_DSCP_CS4 },
960 { "cs5", IPTOS_DSCP_CS5 },
961 { "cs6", IPTOS_DSCP_CS6 },
962 { "cs7", IPTOS_DSCP_CS7 },
963 { "ef", IPTOS_DSCP_EF },
964 { "lowdelay", IPTOS_LOWDELAY },
965 { "throughput", IPTOS_THROUGHPUT },
966 { "reliability", IPTOS_RELIABILITY },
971 parse_ipqos(const char *cp)
979 for (i = 0; ipqos[i].name != NULL; i++) {
980 if (strcasecmp(cp, ipqos[i].name) == 0)
981 return ipqos[i].value;
983 /* Try parsing as an integer */
984 val = strtol(cp, &ep, 0);
985 if (*cp == '\0' || *ep != '\0' || val < 0 || val > 255)
994 static char iptos_str[sizeof "0xff"];
996 for (i = 0; ipqos[i].name != NULL; i++) {
997 if (ipqos[i].value == iptos)
998 return ipqos[i].name;
1000 snprintf(iptos_str, sizeof iptos_str, "0x%02x", iptos);
1004 sock_set_v6only(int s)
1009 debug3("%s: set socket %d IPV6_V6ONLY", __func__, s);
1010 if (setsockopt(s, IPPROTO_IPV6, IPV6_V6ONLY, &on, sizeof(on)) == -1)
1011 error("setsockopt IPV6_V6ONLY: %s", strerror(errno));