1 /* $OpenBSD: misc.c,v 1.72 2009/10/28 16:38:18 reyk 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)
168 ipproto = IPPROTO_IPV6;
171 debug2("socket %d af %d setting rdomain %d",
172 sock, domain, rdomain);
173 if (setsockopt(sock, ipproto, SO_RDOMAIN, &rdomain,
174 sizeof(rdomain)) == -1) {
175 debug("setsockopt SO_RDOMAIN: %.100s",
182 debug("socket %d af %d does not support rdomain %d",
183 sock, domain, rdomain);
191 /* Characters considered whitespace in strsep calls. */
192 #define WHITESPACE " \t\r\n"
195 /* return next token in configuration line */
207 *s = strpbrk(*s, WHITESPACE QUOTE "=");
212 memmove(*s, *s + 1, strlen(*s)); /* move nul too */
213 /* Find matching quote */
214 if ((*s = strpbrk(*s, QUOTE)) == NULL) {
215 return (NULL); /* no matching quote */
222 /* Allow only one '=' to be skipped */
227 /* Skip any extra whitespace after first token */
228 *s += strspn(*s + 1, WHITESPACE) + 1;
229 if (*s[0] == '=' && !wspace)
230 *s += strspn(*s + 1, WHITESPACE) + 1;
236 pwcopy(struct passwd *pw)
238 struct passwd *copy = xcalloc(1, sizeof(*copy));
240 copy->pw_name = xstrdup(pw->pw_name);
241 copy->pw_passwd = xstrdup(pw->pw_passwd);
242 copy->pw_gecos = xstrdup(pw->pw_gecos);
243 copy->pw_uid = pw->pw_uid;
244 copy->pw_gid = pw->pw_gid;
245 #ifdef HAVE_PW_EXPIRE_IN_PASSWD
246 copy->pw_expire = pw->pw_expire;
248 #ifdef HAVE_PW_CHANGE_IN_PASSWD
249 copy->pw_change = pw->pw_change;
251 #ifdef HAVE_PW_CLASS_IN_PASSWD
252 copy->pw_class = xstrdup(pw->pw_class);
254 copy->pw_dir = xstrdup(pw->pw_dir);
255 copy->pw_shell = xstrdup(pw->pw_shell);
260 * Convert ASCII string to TCP/IP port number.
261 * Port must be >=0 and <=65535.
262 * Return -1 if invalid.
265 a2port(const char *s)
270 port = strtonum(s, 0, 65535, &errstr);
277 a2tun(const char *s, int *remote)
279 const char *errstr = NULL;
283 if (remote != NULL) {
284 *remote = SSH_TUNID_ANY;
286 if ((ep = strchr(sp, ':')) == NULL) {
288 return (a2tun(s, NULL));
291 *remote = a2tun(ep, NULL);
292 tun = a2tun(sp, NULL);
294 return (*remote == SSH_TUNID_ERR ? *remote : tun);
297 if (strcasecmp(s, "any") == 0)
298 return (SSH_TUNID_ANY);
300 tun = strtonum(s, 0, SSH_TUNID_MAX, &errstr);
302 return (SSH_TUNID_ERR);
308 #define MINUTES (SECONDS * 60)
309 #define HOURS (MINUTES * 60)
310 #define DAYS (HOURS * 24)
311 #define WEEKS (DAYS * 7)
314 * Convert a time string into seconds; format is
318 * Valid time qualifiers are:
332 * Return -1 if time string is invalid.
335 convtime(const char *s)
345 if (p == NULL || *p == '\0')
349 secs = strtol(p, &endp, 10);
351 (errno == ERANGE && (secs == LONG_MIN || secs == LONG_MAX)) ||
391 * Returns a standardized host+port identifier string.
392 * Caller must free returned string.
395 put_host_port(const char *host, u_short port)
399 if (port == 0 || port == SSH_DEFAULT_PORT)
400 return(xstrdup(host));
401 if (asprintf(&hoststr, "[%s]:%d", host, (int)port) < 0)
402 fatal("put_host_port: asprintf: %s", strerror(errno));
403 debug3("put_host_port: %s", hoststr);
408 * Search for next delimiter between hostnames/addresses and ports.
409 * Argument may be modified (for termination).
410 * Returns *cp if parsing succeeds.
411 * *cp is set to the start of the next delimiter, if one was found.
412 * If this is the last field, *cp is set to NULL.
419 if (cp == NULL || *cp == NULL)
424 if ((s = strchr(s, ']')) == NULL)
428 } else if ((s = strpbrk(s, ":/")) == NULL)
429 s = *cp + strlen(*cp); /* skip to end (see first case below) */
433 *cp = NULL; /* no more fields*/
438 *s = '\0'; /* terminate */
450 cleanhostname(char *host)
452 if (*host == '[' && host[strlen(host) - 1] == ']') {
453 host[strlen(host) - 1] = '\0';
464 if (*cp == ':') /* Leading colon is part of file name. */
470 if (*cp == '@' && *(cp+1) == '[')
472 if (*cp == ']' && *(cp+1) == ':' && flag)
474 if (*cp == ':' && !flag)
482 /* function to assist building execv() arguments */
484 addargs(arglist *args, char *fmt, ...)
492 r = vasprintf(&cp, fmt, ap);
495 fatal("addargs: argument too long");
497 nalloc = args->nalloc;
498 if (args->list == NULL) {
501 } else if (args->num+2 >= nalloc)
504 args->list = xrealloc(args->list, nalloc, sizeof(char *));
505 args->nalloc = nalloc;
506 args->list[args->num++] = cp;
507 args->list[args->num] = NULL;
511 replacearg(arglist *args, u_int which, char *fmt, ...)
518 r = vasprintf(&cp, fmt, ap);
521 fatal("replacearg: argument too long");
523 if (which >= args->num)
524 fatal("replacearg: tried to replace invalid arg %d >= %d",
526 xfree(args->list[which]);
527 args->list[which] = cp;
531 freeargs(arglist *args)
535 if (args->list != NULL) {
536 for (i = 0; i < args->num; i++)
537 xfree(args->list[i]);
539 args->nalloc = args->num = 0;
545 * Expands tildes in the file name. Returns data allocated by xmalloc.
546 * Warning: this calls getpw*.
549 tilde_expand_filename(const char *filename, uid_t uid)
552 char user[128], ret[MAXPATHLEN];
556 if (*filename != '~')
557 return (xstrdup(filename));
560 path = strchr(filename, '/');
561 if (path != NULL && path > filename) { /* ~user/path */
562 slash = path - filename;
563 if (slash > sizeof(user) - 1)
564 fatal("tilde_expand_filename: ~username too long");
565 memcpy(user, filename, slash);
567 if ((pw = getpwnam(user)) == NULL)
568 fatal("tilde_expand_filename: No such user %s", user);
569 } else if ((pw = getpwuid(uid)) == NULL) /* ~/path */
570 fatal("tilde_expand_filename: No such uid %ld", (long)uid);
572 if (strlcpy(ret, pw->pw_dir, sizeof(ret)) >= sizeof(ret))
573 fatal("tilde_expand_filename: Path too long");
575 /* Make sure directory has a trailing '/' */
576 len = strlen(pw->pw_dir);
577 if ((len == 0 || pw->pw_dir[len - 1] != '/') &&
578 strlcat(ret, "/", sizeof(ret)) >= sizeof(ret))
579 fatal("tilde_expand_filename: Path too long");
581 /* Skip leading '/' from specified path */
584 if (strlcat(ret, filename, sizeof(ret)) >= sizeof(ret))
585 fatal("tilde_expand_filename: Path too long");
587 return (xstrdup(ret));
591 * Expand a string with a set of %[char] escapes. A number of escapes may be
592 * specified as (char *escape_chars, char *replacement) pairs. The list must
593 * be terminated by a NULL escape_char. Returns replaced string in memory
594 * allocated by xmalloc.
597 percent_expand(const char *string, ...)
599 #define EXPAND_MAX_KEYS 16
603 } keys[EXPAND_MAX_KEYS];
604 u_int num_keys, i, j;
609 va_start(ap, string);
610 for (num_keys = 0; num_keys < EXPAND_MAX_KEYS; num_keys++) {
611 keys[num_keys].key = va_arg(ap, char *);
612 if (keys[num_keys].key == NULL)
614 keys[num_keys].repl = va_arg(ap, char *);
615 if (keys[num_keys].repl == NULL)
616 fatal("percent_expand: NULL replacement");
620 if (num_keys >= EXPAND_MAX_KEYS)
621 fatal("percent_expand: too many keys");
625 for (i = 0; *string != '\0'; string++) {
626 if (*string != '%') {
629 if (i >= sizeof(buf))
630 fatal("percent_expand: string too long");
637 for (j = 0; j < num_keys; j++) {
638 if (strchr(keys[j].key, *string) != NULL) {
639 i = strlcat(buf, keys[j].repl, sizeof(buf));
640 if (i >= sizeof(buf))
641 fatal("percent_expand: string too long");
646 fatal("percent_expand: unknown key %%%c", *string);
648 return (xstrdup(buf));
649 #undef EXPAND_MAX_KEYS
653 * Read an entire line from a public key file into a static buffer, discarding
654 * lines that exceed the buffer size. Returns 0 on success, -1 on failure.
657 read_keyfile_line(FILE *f, const char *filename, char *buf, size_t bufsz,
660 while (fgets(buf, bufsz, f) != NULL) {
664 if (buf[strlen(buf) - 1] == '\n' || feof(f)) {
667 debug("%s: %s line %lu exceeds size limit", __func__,
669 /* discard remainder of line */
670 while (fgetc(f) != '\n' && !feof(f))
678 tun_open(int tun, int mode)
680 #if defined(CUSTOM_SYS_TUN_OPEN)
681 return (sys_tun_open(tun, mode));
682 #elif defined(SSH_TUN_OPENBSD)
687 /* Open the tunnel device */
688 if (tun <= SSH_TUNID_MAX) {
689 snprintf(name, sizeof(name), "/dev/tun%d", tun);
690 fd = open(name, O_RDWR);
691 } else if (tun == SSH_TUNID_ANY) {
692 for (tun = 100; tun >= 0; tun--) {
693 snprintf(name, sizeof(name), "/dev/tun%d", tun);
694 if ((fd = open(name, O_RDWR)) >= 0)
698 debug("%s: invalid tunnel %u", __func__, tun);
703 debug("%s: %s open failed: %s", __func__, name, strerror(errno));
707 debug("%s: %s mode %d fd %d", __func__, name, mode, fd);
709 /* Set the tunnel device operation mode */
710 snprintf(ifr.ifr_name, sizeof(ifr.ifr_name), "tun%d", tun);
711 if ((sock = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
714 if (ioctl(sock, SIOCGIFFLAGS, &ifr) == -1)
717 /* Set interface mode */
718 ifr.ifr_flags &= ~IFF_UP;
719 if (mode == SSH_TUNMODE_ETHERNET)
720 ifr.ifr_flags |= IFF_LINK0;
722 ifr.ifr_flags &= ~IFF_LINK0;
723 if (ioctl(sock, SIOCSIFFLAGS, &ifr) == -1)
726 /* Bring interface up */
727 ifr.ifr_flags |= IFF_UP;
728 if (ioctl(sock, SIOCSIFFLAGS, &ifr) == -1)
739 debug("%s: failed to set %s mode %d: %s", __func__, name,
740 mode, strerror(errno));
743 error("Tunnel interfaces are not supported on this platform");
753 if ((nullfd = dupfd = open(_PATH_DEVNULL, O_RDWR)) == -1) {
754 fprintf(stderr, "Couldn't open /dev/null: %s\n",
758 while (++dupfd <= 2) {
759 /* Only clobber closed fds */
760 if (fcntl(dupfd, F_GETFL, 0) >= 0)
762 if (dup2(nullfd, dupfd) == -1) {
763 fprintf(stderr, "dup2: %s\n", strerror(errno));
772 tohex(const void *vp, size_t l)
774 const u_char *p = (const u_char *)vp;
779 return xstrdup("tohex: length > 65536");
783 for (i = 0; i < l; i++) {
784 snprintf(b, sizeof(b), "%02x", p[i]);
791 get_u64(const void *vp)
793 const u_char *p = (const u_char *)vp;
796 v = (u_int64_t)p[0] << 56;
797 v |= (u_int64_t)p[1] << 48;
798 v |= (u_int64_t)p[2] << 40;
799 v |= (u_int64_t)p[3] << 32;
800 v |= (u_int64_t)p[4] << 24;
801 v |= (u_int64_t)p[5] << 16;
802 v |= (u_int64_t)p[6] << 8;
803 v |= (u_int64_t)p[7];
809 get_u32(const void *vp)
811 const u_char *p = (const u_char *)vp;
814 v = (u_int32_t)p[0] << 24;
815 v |= (u_int32_t)p[1] << 16;
816 v |= (u_int32_t)p[2] << 8;
817 v |= (u_int32_t)p[3];
823 get_u16(const void *vp)
825 const u_char *p = (const u_char *)vp;
828 v = (u_int16_t)p[0] << 8;
829 v |= (u_int16_t)p[1];
835 put_u64(void *vp, u_int64_t v)
837 u_char *p = (u_char *)vp;
839 p[0] = (u_char)(v >> 56) & 0xff;
840 p[1] = (u_char)(v >> 48) & 0xff;
841 p[2] = (u_char)(v >> 40) & 0xff;
842 p[3] = (u_char)(v >> 32) & 0xff;
843 p[4] = (u_char)(v >> 24) & 0xff;
844 p[5] = (u_char)(v >> 16) & 0xff;
845 p[6] = (u_char)(v >> 8) & 0xff;
846 p[7] = (u_char)v & 0xff;
850 put_u32(void *vp, u_int32_t v)
852 u_char *p = (u_char *)vp;
854 p[0] = (u_char)(v >> 24) & 0xff;
855 p[1] = (u_char)(v >> 16) & 0xff;
856 p[2] = (u_char)(v >> 8) & 0xff;
857 p[3] = (u_char)v & 0xff;
862 put_u16(void *vp, u_int16_t v)
864 u_char *p = (u_char *)vp;
866 p[0] = (u_char)(v >> 8) & 0xff;
867 p[1] = (u_char)v & 0xff;
871 ms_subtract_diff(struct timeval *start, int *ms)
873 struct timeval diff, finish;
875 gettimeofday(&finish, NULL);
876 timersub(&finish, start, &diff);
877 *ms -= (diff.tv_sec * 1000) + (diff.tv_usec / 1000);
881 ms_to_timeval(struct timeval *tv, int ms)
885 tv->tv_sec = ms / 1000;
886 tv->tv_usec = (ms % 1000) * 1000;
890 sock_set_v6only(int s)
895 debug3("%s: set socket %d IPV6_V6ONLY", __func__, s);
896 if (setsockopt(s, IPPROTO_IPV6, IPV6_V6ONLY, &on, sizeof(on)) == -1)
897 error("setsockopt IPV6_V6ONLY: %s", strerror(errno));