1 /* $OpenBSD: misc.c,v 1.74 2009/12/25 19:40:21 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>
40 #include <netinet/in.h>
41 #include <netinet/tcp.h>
50 #ifdef SSH_TUN_OPENBSD
59 /* remove newline at end of string */
65 if (*t == '\n' || *t == '\r') {
75 /* set/unset filedescriptor to non-blocking */
81 val = fcntl(fd, F_GETFL, 0);
83 error("fcntl(%d, F_GETFL, 0): %s", fd, strerror(errno));
86 if (val & O_NONBLOCK) {
87 debug3("fd %d is O_NONBLOCK", fd);
90 debug2("fd %d setting O_NONBLOCK", fd);
92 if (fcntl(fd, F_SETFL, val) == -1) {
93 debug("fcntl(%d, F_SETFL, O_NONBLOCK): %s", fd,
101 unset_nonblock(int fd)
105 val = fcntl(fd, F_GETFL, 0);
107 error("fcntl(%d, F_GETFL, 0): %s", fd, strerror(errno));
110 if (!(val & O_NONBLOCK)) {
111 debug3("fd %d is not O_NONBLOCK", fd);
114 debug("fd %d clearing O_NONBLOCK", fd);
116 if (fcntl(fd, F_SETFL, val) == -1) {
117 debug("fcntl(%d, F_SETFL, ~O_NONBLOCK): %s",
118 fd, strerror(errno));
125 ssh_gai_strerror(int gaierr)
127 if (gaierr == EAI_SYSTEM)
128 return strerror(errno);
129 return gai_strerror(gaierr);
132 /* disable nagle on socket */
140 if (getsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &opt, &optlen) == -1) {
141 debug("getsockopt TCP_NODELAY: %.100s", strerror(errno));
145 debug2("fd %d is TCP_NODELAY", fd);
149 debug2("fd %d setting TCP_NODELAY", fd);
150 if (setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &opt, sizeof opt) == -1)
151 error("setsockopt TCP_NODELAY: %.100s", strerror(errno));
154 /* open a socket in the specified routing domain */
156 socket_rdomain(int domain, int type, int protocol, int rdomain)
158 int sock, ipproto = IPPROTO_IP;
160 if ((sock = socket(domain, type, protocol)) == -1)
169 ipproto = IPPROTO_IPV6;
173 #ifdef USE_ROUTINGDOMAIN
174 debug2("socket %d af %d setting rdomain %d",
175 sock, domain, rdomain);
176 if (setsockopt(sock, ipproto, SO_RDOMAIN, &rdomain,
177 sizeof(rdomain)) == -1) {
178 debug("setsockopt SO_RDOMAIN: %.100s",
186 debug("socket %d af %d does not support rdomain %d",
187 sock, domain, rdomain);
195 /* Characters considered whitespace in strsep calls. */
196 #define WHITESPACE " \t\r\n"
199 /* return next token in configuration line */
211 *s = strpbrk(*s, WHITESPACE QUOTE "=");
216 memmove(*s, *s + 1, strlen(*s)); /* move nul too */
217 /* Find matching quote */
218 if ((*s = strpbrk(*s, QUOTE)) == NULL) {
219 return (NULL); /* no matching quote */
226 /* Allow only one '=' to be skipped */
231 /* Skip any extra whitespace after first token */
232 *s += strspn(*s + 1, WHITESPACE) + 1;
233 if (*s[0] == '=' && !wspace)
234 *s += strspn(*s + 1, WHITESPACE) + 1;
240 pwcopy(struct passwd *pw)
242 struct passwd *copy = xcalloc(1, sizeof(*copy));
244 copy->pw_name = xstrdup(pw->pw_name);
245 copy->pw_passwd = xstrdup(pw->pw_passwd);
246 copy->pw_gecos = xstrdup(pw->pw_gecos);
247 copy->pw_uid = pw->pw_uid;
248 copy->pw_gid = pw->pw_gid;
249 #ifdef HAVE_PW_EXPIRE_IN_PASSWD
250 copy->pw_expire = pw->pw_expire;
252 #ifdef HAVE_PW_CHANGE_IN_PASSWD
253 copy->pw_change = pw->pw_change;
255 #ifdef HAVE_PW_CLASS_IN_PASSWD
256 copy->pw_class = xstrdup(pw->pw_class);
258 copy->pw_dir = xstrdup(pw->pw_dir);
259 copy->pw_shell = xstrdup(pw->pw_shell);
264 * Convert ASCII string to TCP/IP port number.
265 * Port must be >=0 and <=65535.
266 * Return -1 if invalid.
269 a2port(const char *s)
274 port = strtonum(s, 0, 65535, &errstr);
280 #ifdef USE_ROUTINGDOMAIN
282 a2rdomain(const char *s)
287 rdomain = strtonum(s, 0, RT_TABLEID_MAX, &errstr);
295 a2tun(const char *s, int *remote)
297 const char *errstr = NULL;
301 if (remote != NULL) {
302 *remote = SSH_TUNID_ANY;
304 if ((ep = strchr(sp, ':')) == NULL) {
306 return (a2tun(s, NULL));
309 *remote = a2tun(ep, NULL);
310 tun = a2tun(sp, NULL);
312 return (*remote == SSH_TUNID_ERR ? *remote : tun);
315 if (strcasecmp(s, "any") == 0)
316 return (SSH_TUNID_ANY);
318 tun = strtonum(s, 0, SSH_TUNID_MAX, &errstr);
320 return (SSH_TUNID_ERR);
326 #define MINUTES (SECONDS * 60)
327 #define HOURS (MINUTES * 60)
328 #define DAYS (HOURS * 24)
329 #define WEEKS (DAYS * 7)
332 * Convert a time string into seconds; format is
336 * Valid time qualifiers are:
350 * Return -1 if time string is invalid.
353 convtime(const char *s)
363 if (p == NULL || *p == '\0')
367 secs = strtol(p, &endp, 10);
369 (errno == ERANGE && (secs == LONG_MIN || secs == LONG_MAX)) ||
409 * Returns a standardized host+port identifier string.
410 * Caller must free returned string.
413 put_host_port(const char *host, u_short port)
417 if (port == 0 || port == SSH_DEFAULT_PORT)
418 return(xstrdup(host));
419 if (asprintf(&hoststr, "[%s]:%d", host, (int)port) < 0)
420 fatal("put_host_port: asprintf: %s", strerror(errno));
421 debug3("put_host_port: %s", hoststr);
426 * Search for next delimiter between hostnames/addresses and ports.
427 * Argument may be modified (for termination).
428 * Returns *cp if parsing succeeds.
429 * *cp is set to the start of the next delimiter, if one was found.
430 * If this is the last field, *cp is set to NULL.
437 if (cp == NULL || *cp == NULL)
442 if ((s = strchr(s, ']')) == NULL)
446 } else if ((s = strpbrk(s, ":/")) == NULL)
447 s = *cp + strlen(*cp); /* skip to end (see first case below) */
451 *cp = NULL; /* no more fields*/
456 *s = '\0'; /* terminate */
468 cleanhostname(char *host)
470 if (*host == '[' && host[strlen(host) - 1] == ']') {
471 host[strlen(host) - 1] = '\0';
482 if (*cp == ':') /* Leading colon is part of file name. */
488 if (*cp == '@' && *(cp+1) == '[')
490 if (*cp == ']' && *(cp+1) == ':' && flag)
492 if (*cp == ':' && !flag)
500 /* function to assist building execv() arguments */
502 addargs(arglist *args, char *fmt, ...)
510 r = vasprintf(&cp, fmt, ap);
513 fatal("addargs: argument too long");
515 nalloc = args->nalloc;
516 if (args->list == NULL) {
519 } else if (args->num+2 >= nalloc)
522 args->list = xrealloc(args->list, nalloc, sizeof(char *));
523 args->nalloc = nalloc;
524 args->list[args->num++] = cp;
525 args->list[args->num] = NULL;
529 replacearg(arglist *args, u_int which, char *fmt, ...)
536 r = vasprintf(&cp, fmt, ap);
539 fatal("replacearg: argument too long");
541 if (which >= args->num)
542 fatal("replacearg: tried to replace invalid arg %d >= %d",
544 xfree(args->list[which]);
545 args->list[which] = cp;
549 freeargs(arglist *args)
553 if (args->list != NULL) {
554 for (i = 0; i < args->num; i++)
555 xfree(args->list[i]);
557 args->nalloc = args->num = 0;
563 * Expands tildes in the file name. Returns data allocated by xmalloc.
564 * Warning: this calls getpw*.
567 tilde_expand_filename(const char *filename, uid_t uid)
570 char user[128], ret[MAXPATHLEN];
574 if (*filename != '~')
575 return (xstrdup(filename));
578 path = strchr(filename, '/');
579 if (path != NULL && path > filename) { /* ~user/path */
580 slash = path - filename;
581 if (slash > sizeof(user) - 1)
582 fatal("tilde_expand_filename: ~username too long");
583 memcpy(user, filename, slash);
585 if ((pw = getpwnam(user)) == NULL)
586 fatal("tilde_expand_filename: No such user %s", user);
587 } else if ((pw = getpwuid(uid)) == NULL) /* ~/path */
588 fatal("tilde_expand_filename: No such uid %ld", (long)uid);
590 if (strlcpy(ret, pw->pw_dir, sizeof(ret)) >= sizeof(ret))
591 fatal("tilde_expand_filename: Path too long");
593 /* Make sure directory has a trailing '/' */
594 len = strlen(pw->pw_dir);
595 if ((len == 0 || pw->pw_dir[len - 1] != '/') &&
596 strlcat(ret, "/", sizeof(ret)) >= sizeof(ret))
597 fatal("tilde_expand_filename: Path too long");
599 /* Skip leading '/' from specified path */
602 if (strlcat(ret, filename, sizeof(ret)) >= sizeof(ret))
603 fatal("tilde_expand_filename: Path too long");
605 return (xstrdup(ret));
609 * Expand a string with a set of %[char] escapes. A number of escapes may be
610 * specified as (char *escape_chars, char *replacement) pairs. The list must
611 * be terminated by a NULL escape_char. Returns replaced string in memory
612 * allocated by xmalloc.
615 percent_expand(const char *string, ...)
617 #define EXPAND_MAX_KEYS 16
618 u_int num_keys, i, j;
622 } keys[EXPAND_MAX_KEYS];
627 va_start(ap, string);
628 for (num_keys = 0; num_keys < EXPAND_MAX_KEYS; num_keys++) {
629 keys[num_keys].key = va_arg(ap, char *);
630 if (keys[num_keys].key == NULL)
632 keys[num_keys].repl = va_arg(ap, char *);
633 if (keys[num_keys].repl == NULL)
634 fatal("%s: NULL replacement", __func__);
636 if (num_keys == EXPAND_MAX_KEYS && va_arg(ap, char *) != NULL)
637 fatal("%s: too many keys", __func__);
642 for (i = 0; *string != '\0'; string++) {
643 if (*string != '%') {
646 if (i >= sizeof(buf))
647 fatal("%s: string too long", __func__);
655 for (j = 0; j < num_keys; j++) {
656 if (strchr(keys[j].key, *string) != NULL) {
657 i = strlcat(buf, keys[j].repl, sizeof(buf));
658 if (i >= sizeof(buf))
659 fatal("%s: string too long", __func__);
664 fatal("%s: unknown key %%%c", __func__, *string);
666 return (xstrdup(buf));
667 #undef EXPAND_MAX_KEYS
671 * Read an entire line from a public key file into a static buffer, discarding
672 * lines that exceed the buffer size. Returns 0 on success, -1 on failure.
675 read_keyfile_line(FILE *f, const char *filename, char *buf, size_t bufsz,
678 while (fgets(buf, bufsz, f) != NULL) {
682 if (buf[strlen(buf) - 1] == '\n' || feof(f)) {
685 debug("%s: %s line %lu exceeds size limit", __func__,
687 /* discard remainder of line */
688 while (fgetc(f) != '\n' && !feof(f))
696 tun_open(int tun, int mode)
698 #if defined(CUSTOM_SYS_TUN_OPEN)
699 return (sys_tun_open(tun, mode));
700 #elif defined(SSH_TUN_OPENBSD)
705 /* Open the tunnel device */
706 if (tun <= SSH_TUNID_MAX) {
707 snprintf(name, sizeof(name), "/dev/tun%d", tun);
708 fd = open(name, O_RDWR);
709 } else if (tun == SSH_TUNID_ANY) {
710 for (tun = 100; tun >= 0; tun--) {
711 snprintf(name, sizeof(name), "/dev/tun%d", tun);
712 if ((fd = open(name, O_RDWR)) >= 0)
716 debug("%s: invalid tunnel %u", __func__, tun);
721 debug("%s: %s open failed: %s", __func__, name, strerror(errno));
725 debug("%s: %s mode %d fd %d", __func__, name, mode, fd);
727 /* Set the tunnel device operation mode */
728 snprintf(ifr.ifr_name, sizeof(ifr.ifr_name), "tun%d", tun);
729 if ((sock = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
732 if (ioctl(sock, SIOCGIFFLAGS, &ifr) == -1)
735 /* Set interface mode */
736 ifr.ifr_flags &= ~IFF_UP;
737 if (mode == SSH_TUNMODE_ETHERNET)
738 ifr.ifr_flags |= IFF_LINK0;
740 ifr.ifr_flags &= ~IFF_LINK0;
741 if (ioctl(sock, SIOCSIFFLAGS, &ifr) == -1)
744 /* Bring interface up */
745 ifr.ifr_flags |= IFF_UP;
746 if (ioctl(sock, SIOCSIFFLAGS, &ifr) == -1)
757 debug("%s: failed to set %s mode %d: %s", __func__, name,
758 mode, strerror(errno));
761 error("Tunnel interfaces are not supported on this platform");
771 if ((nullfd = dupfd = open(_PATH_DEVNULL, O_RDWR)) == -1) {
772 fprintf(stderr, "Couldn't open /dev/null: %s\n",
776 while (++dupfd <= 2) {
777 /* Only clobber closed fds */
778 if (fcntl(dupfd, F_GETFL, 0) >= 0)
780 if (dup2(nullfd, dupfd) == -1) {
781 fprintf(stderr, "dup2: %s\n", strerror(errno));
790 tohex(const void *vp, size_t l)
792 const u_char *p = (const u_char *)vp;
797 return xstrdup("tohex: length > 65536");
801 for (i = 0; i < l; i++) {
802 snprintf(b, sizeof(b), "%02x", p[i]);
809 get_u64(const void *vp)
811 const u_char *p = (const u_char *)vp;
814 v = (u_int64_t)p[0] << 56;
815 v |= (u_int64_t)p[1] << 48;
816 v |= (u_int64_t)p[2] << 40;
817 v |= (u_int64_t)p[3] << 32;
818 v |= (u_int64_t)p[4] << 24;
819 v |= (u_int64_t)p[5] << 16;
820 v |= (u_int64_t)p[6] << 8;
821 v |= (u_int64_t)p[7];
827 get_u32(const void *vp)
829 const u_char *p = (const u_char *)vp;
832 v = (u_int32_t)p[0] << 24;
833 v |= (u_int32_t)p[1] << 16;
834 v |= (u_int32_t)p[2] << 8;
835 v |= (u_int32_t)p[3];
841 get_u16(const void *vp)
843 const u_char *p = (const u_char *)vp;
846 v = (u_int16_t)p[0] << 8;
847 v |= (u_int16_t)p[1];
853 put_u64(void *vp, u_int64_t v)
855 u_char *p = (u_char *)vp;
857 p[0] = (u_char)(v >> 56) & 0xff;
858 p[1] = (u_char)(v >> 48) & 0xff;
859 p[2] = (u_char)(v >> 40) & 0xff;
860 p[3] = (u_char)(v >> 32) & 0xff;
861 p[4] = (u_char)(v >> 24) & 0xff;
862 p[5] = (u_char)(v >> 16) & 0xff;
863 p[6] = (u_char)(v >> 8) & 0xff;
864 p[7] = (u_char)v & 0xff;
868 put_u32(void *vp, u_int32_t v)
870 u_char *p = (u_char *)vp;
872 p[0] = (u_char)(v >> 24) & 0xff;
873 p[1] = (u_char)(v >> 16) & 0xff;
874 p[2] = (u_char)(v >> 8) & 0xff;
875 p[3] = (u_char)v & 0xff;
880 put_u16(void *vp, u_int16_t v)
882 u_char *p = (u_char *)vp;
884 p[0] = (u_char)(v >> 8) & 0xff;
885 p[1] = (u_char)v & 0xff;
889 ms_subtract_diff(struct timeval *start, int *ms)
891 struct timeval diff, finish;
893 gettimeofday(&finish, NULL);
894 timersub(&finish, start, &diff);
895 *ms -= (diff.tv_sec * 1000) + (diff.tv_usec / 1000);
899 ms_to_timeval(struct timeval *tv, int ms)
903 tv->tv_sec = ms / 1000;
904 tv->tv_usec = (ms % 1000) * 1000;
908 sock_set_v6only(int s)
913 debug3("%s: set socket %d IPV6_V6ONLY", __func__, s);
914 if (setsockopt(s, IPPROTO_IPV6, IPV6_V6ONLY, &on, sizeof(on)) == -1)
915 error("setsockopt IPV6_V6ONLY: %s", strerror(errno));