1 /* $OpenBSD: misc.c,v 1.64 2006/08/03 03:34:42 deraadt 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>
49 #ifdef SSH_TUN_OPENBSD
58 /* remove newline at end of string */
64 if (*t == '\n' || *t == '\r') {
74 /* set/unset filedescriptor to non-blocking */
80 val = fcntl(fd, F_GETFL, 0);
82 error("fcntl(%d, F_GETFL, 0): %s", fd, strerror(errno));
85 if (val & O_NONBLOCK) {
86 debug3("fd %d is O_NONBLOCK", fd);
89 debug2("fd %d setting O_NONBLOCK", fd);
91 if (fcntl(fd, F_SETFL, val) == -1) {
92 debug("fcntl(%d, F_SETFL, O_NONBLOCK): %s", fd,
100 unset_nonblock(int fd)
104 val = fcntl(fd, F_GETFL, 0);
106 error("fcntl(%d, F_GETFL, 0): %s", fd, strerror(errno));
109 if (!(val & O_NONBLOCK)) {
110 debug3("fd %d is not O_NONBLOCK", fd);
113 debug("fd %d clearing O_NONBLOCK", fd);
115 if (fcntl(fd, F_SETFL, val) == -1) {
116 debug("fcntl(%d, F_SETFL, ~O_NONBLOCK): %s",
117 fd, strerror(errno));
123 /* disable nagle on socket */
131 if (getsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &opt, &optlen) == -1) {
132 debug("getsockopt TCP_NODELAY: %.100s", strerror(errno));
136 debug2("fd %d is TCP_NODELAY", fd);
140 debug2("fd %d setting TCP_NODELAY", fd);
141 if (setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &opt, sizeof opt) == -1)
142 error("setsockopt TCP_NODELAY: %.100s", strerror(errno));
145 /* Characters considered whitespace in strsep calls. */
146 #define WHITESPACE " \t\r\n"
149 /* Characters considered as quotations. */
152 /* return next token in configuration line */
164 if ((q=strchr(QUOTES, (int) *old)) && *q)
166 /* find next quote character, point old to start of quoted
168 for (p = ++old;*p && *p!=*q; p++)
171 /* find start of next token */
172 *s = (*p) ? p + strspn(p + 1, WHITESPACE) + 1 : NULL;
174 /* terminate 'old' token */
179 *s = strpbrk(*s, WHITESPACE QUOTE "=");
184 memmove(*s, *s + 1, strlen(*s)); /* move nul too */
185 /* Find matching quote */
186 if ((*s = strpbrk(*s, QUOTE)) == NULL) {
187 return (NULL); /* no matching quote */
194 /* Allow only one '=' to be skipped */
199 /* Skip any extra whitespace after first token */
200 *s += strspn(*s + 1, WHITESPACE) + 1;
201 if (*s[0] == '=' && !wspace)
202 *s += strspn(*s + 1, WHITESPACE) + 1;
208 pwcopy(struct passwd *pw)
210 struct passwd *copy = xcalloc(1, sizeof(*copy));
212 copy->pw_name = xstrdup(pw->pw_name);
213 copy->pw_passwd = xstrdup(pw->pw_passwd);
214 copy->pw_gecos = xstrdup(pw->pw_gecos);
215 copy->pw_uid = pw->pw_uid;
216 copy->pw_gid = pw->pw_gid;
217 #ifdef HAVE_PW_EXPIRE_IN_PASSWD
218 copy->pw_expire = pw->pw_expire;
220 #ifdef HAVE_PW_CHANGE_IN_PASSWD
221 copy->pw_change = pw->pw_change;
223 #ifdef HAVE_PW_CLASS_IN_PASSWD
224 copy->pw_class = xstrdup(pw->pw_class);
226 copy->pw_dir = xstrdup(pw->pw_dir);
227 copy->pw_shell = xstrdup(pw->pw_shell);
232 * Convert ASCII string to TCP/IP port number.
233 * Port must be >0 and <=65535.
234 * Return 0 if invalid.
237 a2port(const char *s)
243 port = strtol(s, &endp, 0);
244 if (s == endp || *endp != '\0' ||
245 (errno == ERANGE && (port == LONG_MIN || port == LONG_MAX)) ||
246 port <= 0 || port > 65535)
253 a2tun(const char *s, int *remote)
255 const char *errstr = NULL;
259 if (remote != NULL) {
260 *remote = SSH_TUNID_ANY;
262 if ((ep = strchr(sp, ':')) == NULL) {
264 return (a2tun(s, NULL));
267 *remote = a2tun(ep, NULL);
268 tun = a2tun(sp, NULL);
270 return (*remote == SSH_TUNID_ERR ? *remote : tun);
273 if (strcasecmp(s, "any") == 0)
274 return (SSH_TUNID_ANY);
276 tun = strtonum(s, 0, SSH_TUNID_MAX, &errstr);
278 return (SSH_TUNID_ERR);
284 #define MINUTES (SECONDS * 60)
285 #define HOURS (MINUTES * 60)
286 #define DAYS (HOURS * 24)
287 #define WEEKS (DAYS * 7)
290 * Convert a time string into seconds; format is
294 * Valid time qualifiers are:
308 * Return -1 if time string is invalid.
311 convtime(const char *s)
321 if (p == NULL || *p == '\0')
325 secs = strtol(p, &endp, 10);
327 (errno == ERANGE && (secs == LONG_MIN || secs == LONG_MAX)) ||
367 * Returns a standardized host+port identifier string.
368 * Caller must free returned string.
371 put_host_port(const char *host, u_short port)
375 if (port == 0 || port == SSH_DEFAULT_PORT)
376 return(xstrdup(host));
377 if (asprintf(&hoststr, "[%s]:%d", host, (int)port) < 0)
378 fatal("put_host_port: asprintf: %s", strerror(errno));
379 debug3("put_host_port: %s", hoststr);
384 * Search for next delimiter between hostnames/addresses and ports.
385 * Argument may be modified (for termination).
386 * Returns *cp if parsing succeeds.
387 * *cp is set to the start of the next delimiter, if one was found.
388 * If this is the last field, *cp is set to NULL.
395 if (cp == NULL || *cp == NULL)
400 if ((s = strchr(s, ']')) == NULL)
404 } else if ((s = strpbrk(s, ":/")) == NULL)
405 s = *cp + strlen(*cp); /* skip to end (see first case below) */
409 *cp = NULL; /* no more fields*/
414 *s = '\0'; /* terminate */
426 cleanhostname(char *host)
428 if (*host == '[' && host[strlen(host) - 1] == ']') {
429 host[strlen(host) - 1] = '\0';
440 if (*cp == ':') /* Leading colon is part of file name. */
446 if (*cp == '@' && *(cp+1) == '[')
448 if (*cp == ']' && *(cp+1) == ':' && flag)
450 if (*cp == ':' && !flag)
458 /* function to assist building execv() arguments */
460 addargs(arglist *args, char *fmt, ...)
468 r = vasprintf(&cp, fmt, ap);
471 fatal("addargs: argument too long");
473 nalloc = args->nalloc;
474 if (args->list == NULL) {
477 } else if (args->num+2 >= nalloc)
480 args->list = xrealloc(args->list, nalloc, sizeof(char *));
481 args->nalloc = nalloc;
482 args->list[args->num++] = cp;
483 args->list[args->num] = NULL;
487 replacearg(arglist *args, u_int which, char *fmt, ...)
494 r = vasprintf(&cp, fmt, ap);
497 fatal("replacearg: argument too long");
499 if (which >= args->num)
500 fatal("replacearg: tried to replace invalid arg %d >= %d",
502 xfree(args->list[which]);
503 args->list[which] = cp;
507 freeargs(arglist *args)
511 if (args->list != NULL) {
512 for (i = 0; i < args->num; i++)
513 xfree(args->list[i]);
515 args->nalloc = args->num = 0;
521 * Expands tildes in the file name. Returns data allocated by xmalloc.
522 * Warning: this calls getpw*.
525 tilde_expand_filename(const char *filename, uid_t uid)
528 char user[128], ret[MAXPATHLEN];
532 if (*filename != '~')
533 return (xstrdup(filename));
536 path = strchr(filename, '/');
537 if (path != NULL && path > filename) { /* ~user/path */
538 slash = path - filename;
539 if (slash > sizeof(user) - 1)
540 fatal("tilde_expand_filename: ~username too long");
541 memcpy(user, filename, slash);
543 if ((pw = getpwnam(user)) == NULL)
544 fatal("tilde_expand_filename: No such user %s", user);
545 } else if ((pw = getpwuid(uid)) == NULL) /* ~/path */
546 fatal("tilde_expand_filename: No such uid %d", uid);
548 if (strlcpy(ret, pw->pw_dir, sizeof(ret)) >= sizeof(ret))
549 fatal("tilde_expand_filename: Path too long");
551 /* Make sure directory has a trailing '/' */
552 len = strlen(pw->pw_dir);
553 if ((len == 0 || pw->pw_dir[len - 1] != '/') &&
554 strlcat(ret, "/", sizeof(ret)) >= sizeof(ret))
555 fatal("tilde_expand_filename: Path too long");
557 /* Skip leading '/' from specified path */
560 if (strlcat(ret, filename, sizeof(ret)) >= sizeof(ret))
561 fatal("tilde_expand_filename: Path too long");
563 return (xstrdup(ret));
567 * Expand a string with a set of %[char] escapes. A number of escapes may be
568 * specified as (char *escape_chars, char *replacement) pairs. The list must
569 * be terminated by a NULL escape_char. Returns replaced string in memory
570 * allocated by xmalloc.
573 percent_expand(const char *string, ...)
575 #define EXPAND_MAX_KEYS 16
579 } keys[EXPAND_MAX_KEYS];
580 u_int num_keys, i, j;
585 va_start(ap, string);
586 for (num_keys = 0; num_keys < EXPAND_MAX_KEYS; num_keys++) {
587 keys[num_keys].key = va_arg(ap, char *);
588 if (keys[num_keys].key == NULL)
590 keys[num_keys].repl = va_arg(ap, char *);
591 if (keys[num_keys].repl == NULL)
592 fatal("percent_expand: NULL replacement");
596 if (num_keys >= EXPAND_MAX_KEYS)
597 fatal("percent_expand: too many keys");
601 for (i = 0; *string != '\0'; string++) {
602 if (*string != '%') {
605 if (i >= sizeof(buf))
606 fatal("percent_expand: string too long");
613 for (j = 0; j < num_keys; j++) {
614 if (strchr(keys[j].key, *string) != NULL) {
615 i = strlcat(buf, keys[j].repl, sizeof(buf));
616 if (i >= sizeof(buf))
617 fatal("percent_expand: string too long");
622 fatal("percent_expand: unknown key %%%c", *string);
624 return (xstrdup(buf));
625 #undef EXPAND_MAX_KEYS
629 * Read an entire line from a public key file into a static buffer, discarding
630 * lines that exceed the buffer size. Returns 0 on success, -1 on failure.
633 read_keyfile_line(FILE *f, const char *filename, char *buf, size_t bufsz,
636 while (fgets(buf, bufsz, f) != NULL) {
638 if (buf[strlen(buf) - 1] == '\n' || feof(f)) {
641 debug("%s: %s line %lu exceeds size limit", __func__,
643 /* discard remainder of line */
644 while (fgetc(f) != '\n' && !feof(f))
652 tun_open(int tun, int mode)
654 #if defined(CUSTOM_SYS_TUN_OPEN)
655 return (sys_tun_open(tun, mode));
656 #elif defined(SSH_TUN_OPENBSD)
661 /* Open the tunnel device */
662 if (tun <= SSH_TUNID_MAX) {
663 snprintf(name, sizeof(name), "/dev/tun%d", tun);
664 fd = open(name, O_RDWR);
665 } else if (tun == SSH_TUNID_ANY) {
666 for (tun = 100; tun >= 0; tun--) {
667 snprintf(name, sizeof(name), "/dev/tun%d", tun);
668 if ((fd = open(name, O_RDWR)) >= 0)
672 debug("%s: invalid tunnel %u", __func__, tun);
677 debug("%s: %s open failed: %s", __func__, name, strerror(errno));
681 debug("%s: %s mode %d fd %d", __func__, name, mode, fd);
683 /* Set the tunnel device operation mode */
684 snprintf(ifr.ifr_name, sizeof(ifr.ifr_name), "tun%d", tun);
685 if ((sock = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
688 if (ioctl(sock, SIOCGIFFLAGS, &ifr) == -1)
691 /* Set interface mode */
692 ifr.ifr_flags &= ~IFF_UP;
693 if (mode == SSH_TUNMODE_ETHERNET)
694 ifr.ifr_flags |= IFF_LINK0;
696 ifr.ifr_flags &= ~IFF_LINK0;
697 if (ioctl(sock, SIOCSIFFLAGS, &ifr) == -1)
700 /* Bring interface up */
701 ifr.ifr_flags |= IFF_UP;
702 if (ioctl(sock, SIOCSIFFLAGS, &ifr) == -1)
713 debug("%s: failed to set %s mode %d: %s", __func__, name,
714 mode, strerror(errno));
717 error("Tunnel interfaces are not supported on this platform");
727 if ((nullfd = dupfd = open(_PATH_DEVNULL, O_RDWR)) == -1) {
728 fprintf(stderr, "Couldn't open /dev/null: %s", strerror(errno));
731 while (++dupfd <= 2) {
732 /* Only clobber closed fds */
733 if (fcntl(dupfd, F_GETFL, 0) >= 0)
735 if (dup2(nullfd, dupfd) == -1) {
736 fprintf(stderr, "dup2: %s", strerror(errno));
745 tohex(const void *vp, size_t l)
747 const u_char *p = (const u_char *)vp;
752 return xstrdup("tohex: length > 65536");
756 for (i = 0; i < l; i++) {
757 snprintf(b, sizeof(b), "%02x", p[i]);
764 get_u64(const void *vp)
766 const u_char *p = (const u_char *)vp;
769 v = (u_int64_t)p[0] << 56;
770 v |= (u_int64_t)p[1] << 48;
771 v |= (u_int64_t)p[2] << 40;
772 v |= (u_int64_t)p[3] << 32;
773 v |= (u_int64_t)p[4] << 24;
774 v |= (u_int64_t)p[5] << 16;
775 v |= (u_int64_t)p[6] << 8;
776 v |= (u_int64_t)p[7];
782 get_u32(const void *vp)
784 const u_char *p = (const u_char *)vp;
787 v = (u_int32_t)p[0] << 24;
788 v |= (u_int32_t)p[1] << 16;
789 v |= (u_int32_t)p[2] << 8;
790 v |= (u_int32_t)p[3];
796 get_u16(const void *vp)
798 const u_char *p = (const u_char *)vp;
801 v = (u_int16_t)p[0] << 8;
802 v |= (u_int16_t)p[1];
808 put_u64(void *vp, u_int64_t v)
810 u_char *p = (u_char *)vp;
812 p[0] = (u_char)(v >> 56) & 0xff;
813 p[1] = (u_char)(v >> 48) & 0xff;
814 p[2] = (u_char)(v >> 40) & 0xff;
815 p[3] = (u_char)(v >> 32) & 0xff;
816 p[4] = (u_char)(v >> 24) & 0xff;
817 p[5] = (u_char)(v >> 16) & 0xff;
818 p[6] = (u_char)(v >> 8) & 0xff;
819 p[7] = (u_char)v & 0xff;
823 put_u32(void *vp, u_int32_t v)
825 u_char *p = (u_char *)vp;
827 p[0] = (u_char)(v >> 24) & 0xff;
828 p[1] = (u_char)(v >> 16) & 0xff;
829 p[2] = (u_char)(v >> 8) & 0xff;
830 p[3] = (u_char)v & 0xff;
835 put_u16(void *vp, u_int16_t v)
837 u_char *p = (u_char *)vp;
839 p[0] = (u_char)(v >> 8) & 0xff;
840 p[1] = (u_char)v & 0xff;