1 /* $OpenBSD: misc.c,v 1.55 2006/07/09 15:15:10 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/ioctl.h>
30 #include <sys/types.h>
31 #include <sys/socket.h>
33 #include <netinet/in.h>
34 #include <netinet/tcp.h>
41 #ifdef SSH_TUN_OPENBSD
49 /* remove newline at end of string */
55 if (*t == '\n' || *t == '\r') {
65 /* set/unset filedescriptor to non-blocking */
71 val = fcntl(fd, F_GETFL, 0);
73 error("fcntl(%d, F_GETFL, 0): %s", fd, strerror(errno));
76 if (val & O_NONBLOCK) {
77 debug3("fd %d is O_NONBLOCK", fd);
80 debug2("fd %d setting O_NONBLOCK", fd);
82 if (fcntl(fd, F_SETFL, val) == -1) {
83 debug("fcntl(%d, F_SETFL, O_NONBLOCK): %s", fd,
91 unset_nonblock(int fd)
95 val = fcntl(fd, F_GETFL, 0);
97 error("fcntl(%d, F_GETFL, 0): %s", fd, strerror(errno));
100 if (!(val & O_NONBLOCK)) {
101 debug3("fd %d is not O_NONBLOCK", fd);
104 debug("fd %d clearing O_NONBLOCK", fd);
106 if (fcntl(fd, F_SETFL, val) == -1) {
107 debug("fcntl(%d, F_SETFL, ~O_NONBLOCK): %s",
108 fd, strerror(errno));
114 /* disable nagle on socket */
122 if (getsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &opt, &optlen) == -1) {
123 debug("getsockopt TCP_NODELAY: %.100s", strerror(errno));
127 debug2("fd %d is TCP_NODELAY", fd);
131 debug2("fd %d setting TCP_NODELAY", fd);
132 if (setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &opt, sizeof opt) == -1)
133 error("setsockopt TCP_NODELAY: %.100s", strerror(errno));
136 /* Characters considered whitespace in strsep calls. */
137 #define WHITESPACE " \t\r\n"
140 /* return next token in configuration line */
152 *s = strpbrk(*s, WHITESPACE QUOTE "=");
157 memmove(*s, *s + 1, strlen(*s)); /* move nul too */
158 /* Find matching quote */
159 if ((*s = strpbrk(*s, QUOTE)) == NULL) {
160 return (NULL); /* no matching quote */
167 /* Allow only one '=' to be skipped */
172 /* Skip any extra whitespace after first token */
173 *s += strspn(*s + 1, WHITESPACE) + 1;
174 if (*s[0] == '=' && !wspace)
175 *s += strspn(*s + 1, WHITESPACE) + 1;
181 pwcopy(struct passwd *pw)
183 struct passwd *copy = xcalloc(1, sizeof(*copy));
185 copy->pw_name = xstrdup(pw->pw_name);
186 copy->pw_passwd = xstrdup(pw->pw_passwd);
187 copy->pw_gecos = xstrdup(pw->pw_gecos);
188 copy->pw_uid = pw->pw_uid;
189 copy->pw_gid = pw->pw_gid;
190 #ifdef HAVE_PW_EXPIRE_IN_PASSWD
191 copy->pw_expire = pw->pw_expire;
193 #ifdef HAVE_PW_CHANGE_IN_PASSWD
194 copy->pw_change = pw->pw_change;
196 #ifdef HAVE_PW_CLASS_IN_PASSWD
197 copy->pw_class = xstrdup(pw->pw_class);
199 copy->pw_dir = xstrdup(pw->pw_dir);
200 copy->pw_shell = xstrdup(pw->pw_shell);
205 * Convert ASCII string to TCP/IP port number.
206 * Port must be >0 and <=65535.
207 * Return 0 if invalid.
210 a2port(const char *s)
216 port = strtol(s, &endp, 0);
217 if (s == endp || *endp != '\0' ||
218 (errno == ERANGE && (port == LONG_MIN || port == LONG_MAX)) ||
219 port <= 0 || port > 65535)
226 a2tun(const char *s, int *remote)
228 const char *errstr = NULL;
232 if (remote != NULL) {
233 *remote = SSH_TUNID_ANY;
235 if ((ep = strchr(sp, ':')) == NULL) {
237 return (a2tun(s, NULL));
240 *remote = a2tun(ep, NULL);
241 tun = a2tun(sp, NULL);
243 return (*remote == SSH_TUNID_ERR ? *remote : tun);
246 if (strcasecmp(s, "any") == 0)
247 return (SSH_TUNID_ANY);
249 tun = strtonum(s, 0, SSH_TUNID_MAX, &errstr);
251 return (SSH_TUNID_ERR);
257 #define MINUTES (SECONDS * 60)
258 #define HOURS (MINUTES * 60)
259 #define DAYS (HOURS * 24)
260 #define WEEKS (DAYS * 7)
263 * Convert a time string into seconds; format is
267 * Valid time qualifiers are:
281 * Return -1 if time string is invalid.
284 convtime(const char *s)
294 if (p == NULL || *p == '\0')
298 secs = strtol(p, &endp, 10);
300 (errno == ERANGE && (secs == LONG_MIN || secs == LONG_MAX)) ||
340 * Search for next delimiter between hostnames/addresses and ports.
341 * Argument may be modified (for termination).
342 * Returns *cp if parsing succeeds.
343 * *cp is set to the start of the next delimiter, if one was found.
344 * If this is the last field, *cp is set to NULL.
351 if (cp == NULL || *cp == NULL)
356 if ((s = strchr(s, ']')) == NULL)
360 } else if ((s = strpbrk(s, ":/")) == NULL)
361 s = *cp + strlen(*cp); /* skip to end (see first case below) */
365 *cp = NULL; /* no more fields*/
370 *s = '\0'; /* terminate */
382 cleanhostname(char *host)
384 if (*host == '[' && host[strlen(host) - 1] == ']') {
385 host[strlen(host) - 1] = '\0';
396 if (*cp == ':') /* Leading colon is part of file name. */
402 if (*cp == '@' && *(cp+1) == '[')
404 if (*cp == ']' && *(cp+1) == ':' && flag)
406 if (*cp == ':' && !flag)
414 /* function to assist building execv() arguments */
416 addargs(arglist *args, char *fmt, ...)
424 r = vasprintf(&cp, fmt, ap);
427 fatal("addargs: argument too long");
429 nalloc = args->nalloc;
430 if (args->list == NULL) {
433 } else if (args->num+2 >= nalloc)
436 args->list = xrealloc(args->list, nalloc, sizeof(char *));
437 args->nalloc = nalloc;
438 args->list[args->num++] = cp;
439 args->list[args->num] = NULL;
443 replacearg(arglist *args, u_int which, char *fmt, ...)
450 r = vasprintf(&cp, fmt, ap);
453 fatal("replacearg: argument too long");
455 if (which >= args->num)
456 fatal("replacearg: tried to replace invalid arg %d >= %d",
458 xfree(args->list[which]);
459 args->list[which] = cp;
463 freeargs(arglist *args)
467 if (args->list != NULL) {
468 for (i = 0; i < args->num; i++)
469 xfree(args->list[i]);
471 args->nalloc = args->num = 0;
477 * Expands tildes in the file name. Returns data allocated by xmalloc.
478 * Warning: this calls getpw*.
481 tilde_expand_filename(const char *filename, uid_t uid)
484 char user[128], ret[MAXPATHLEN];
488 if (*filename != '~')
489 return (xstrdup(filename));
492 path = strchr(filename, '/');
493 if (path != NULL && path > filename) { /* ~user/path */
494 slash = path - filename;
495 if (slash > sizeof(user) - 1)
496 fatal("tilde_expand_filename: ~username too long");
497 memcpy(user, filename, slash);
499 if ((pw = getpwnam(user)) == NULL)
500 fatal("tilde_expand_filename: No such user %s", user);
501 } else if ((pw = getpwuid(uid)) == NULL) /* ~/path */
502 fatal("tilde_expand_filename: No such uid %d", uid);
504 if (strlcpy(ret, pw->pw_dir, sizeof(ret)) >= sizeof(ret))
505 fatal("tilde_expand_filename: Path too long");
507 /* Make sure directory has a trailing '/' */
508 len = strlen(pw->pw_dir);
509 if ((len == 0 || pw->pw_dir[len - 1] != '/') &&
510 strlcat(ret, "/", sizeof(ret)) >= sizeof(ret))
511 fatal("tilde_expand_filename: Path too long");
513 /* Skip leading '/' from specified path */
516 if (strlcat(ret, filename, sizeof(ret)) >= sizeof(ret))
517 fatal("tilde_expand_filename: Path too long");
519 return (xstrdup(ret));
523 * Expand a string with a set of %[char] escapes. A number of escapes may be
524 * specified as (char *escape_chars, char *replacement) pairs. The list must
525 * be terminated by a NULL escape_char. Returns replaced string in memory
526 * allocated by xmalloc.
529 percent_expand(const char *string, ...)
531 #define EXPAND_MAX_KEYS 16
535 } keys[EXPAND_MAX_KEYS];
536 u_int num_keys, i, j;
541 va_start(ap, string);
542 for (num_keys = 0; num_keys < EXPAND_MAX_KEYS; num_keys++) {
543 keys[num_keys].key = va_arg(ap, char *);
544 if (keys[num_keys].key == NULL)
546 keys[num_keys].repl = va_arg(ap, char *);
547 if (keys[num_keys].repl == NULL)
548 fatal("percent_expand: NULL replacement");
552 if (num_keys >= EXPAND_MAX_KEYS)
553 fatal("percent_expand: too many keys");
557 for (i = 0; *string != '\0'; string++) {
558 if (*string != '%') {
561 if (i >= sizeof(buf))
562 fatal("percent_expand: string too long");
569 for (j = 0; j < num_keys; j++) {
570 if (strchr(keys[j].key, *string) != NULL) {
571 i = strlcat(buf, keys[j].repl, sizeof(buf));
572 if (i >= sizeof(buf))
573 fatal("percent_expand: string too long");
578 fatal("percent_expand: unknown key %%%c", *string);
580 return (xstrdup(buf));
581 #undef EXPAND_MAX_KEYS
585 * Read an entire line from a public key file into a static buffer, discarding
586 * lines that exceed the buffer size. Returns 0 on success, -1 on failure.
589 read_keyfile_line(FILE *f, const char *filename, char *buf, size_t bufsz,
592 while (fgets(buf, bufsz, f) != NULL) {
594 if (buf[strlen(buf) - 1] == '\n' || feof(f)) {
597 debug("%s: %s line %lu exceeds size limit", __func__,
599 /* discard remainder of line */
600 while (fgetc(f) != '\n' && !feof(f))
608 tun_open(int tun, int mode)
610 #if defined(CUSTOM_SYS_TUN_OPEN)
611 return (sys_tun_open(tun, mode));
612 #elif defined(SSH_TUN_OPENBSD)
617 /* Open the tunnel device */
618 if (tun <= SSH_TUNID_MAX) {
619 snprintf(name, sizeof(name), "/dev/tun%d", tun);
620 fd = open(name, O_RDWR);
621 } else if (tun == SSH_TUNID_ANY) {
622 for (tun = 100; tun >= 0; tun--) {
623 snprintf(name, sizeof(name), "/dev/tun%d", tun);
624 if ((fd = open(name, O_RDWR)) >= 0)
628 debug("%s: invalid tunnel %u", __func__, tun);
633 debug("%s: %s open failed: %s", __func__, name, strerror(errno));
637 debug("%s: %s mode %d fd %d", __func__, name, mode, fd);
639 /* Set the tunnel device operation mode */
640 snprintf(ifr.ifr_name, sizeof(ifr.ifr_name), "tun%d", tun);
641 if ((sock = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
644 if (ioctl(sock, SIOCGIFFLAGS, &ifr) == -1)
647 /* Set interface mode */
648 ifr.ifr_flags &= ~IFF_UP;
649 if (mode == SSH_TUNMODE_ETHERNET)
650 ifr.ifr_flags |= IFF_LINK0;
652 ifr.ifr_flags &= ~IFF_LINK0;
653 if (ioctl(sock, SIOCSIFFLAGS, &ifr) == -1)
656 /* Bring interface up */
657 ifr.ifr_flags |= IFF_UP;
658 if (ioctl(sock, SIOCSIFFLAGS, &ifr) == -1)
669 debug("%s: failed to set %s mode %d: %s", __func__, name,
670 mode, strerror(errno));
673 error("Tunnel interfaces are not supported on this platform");
683 if ((nullfd = dupfd = open(_PATH_DEVNULL, O_RDWR)) == -1) {
684 fprintf(stderr, "Couldn't open /dev/null: %s", strerror(errno));
687 while (++dupfd <= 2) {
688 /* Only clobber closed fds */
689 if (fcntl(dupfd, F_GETFL, 0) >= 0)
691 if (dup2(nullfd, dupfd) == -1) {
692 fprintf(stderr, "dup2: %s", strerror(errno));
701 tohex(const void *vp, size_t l)
703 const u_char *p = (const u_char *)vp;
708 return xstrdup("tohex: length > 65536");
712 for (i = 0; i < l; i++) {
713 snprintf(b, sizeof(b), "%02x", p[i]);
720 get_u64(const void *vp)
722 const u_char *p = (const u_char *)vp;
725 v = (u_int64_t)p[0] << 56;
726 v |= (u_int64_t)p[1] << 48;
727 v |= (u_int64_t)p[2] << 40;
728 v |= (u_int64_t)p[3] << 32;
729 v |= (u_int64_t)p[4] << 24;
730 v |= (u_int64_t)p[5] << 16;
731 v |= (u_int64_t)p[6] << 8;
732 v |= (u_int64_t)p[7];
738 get_u32(const void *vp)
740 const u_char *p = (const u_char *)vp;
743 v = (u_int32_t)p[0] << 24;
744 v |= (u_int32_t)p[1] << 16;
745 v |= (u_int32_t)p[2] << 8;
746 v |= (u_int32_t)p[3];
752 get_u16(const void *vp)
754 const u_char *p = (const u_char *)vp;
757 v = (u_int16_t)p[0] << 8;
758 v |= (u_int16_t)p[1];
764 put_u64(void *vp, u_int64_t v)
766 u_char *p = (u_char *)vp;
768 p[0] = (u_char)(v >> 56) & 0xff;
769 p[1] = (u_char)(v >> 48) & 0xff;
770 p[2] = (u_char)(v >> 40) & 0xff;
771 p[3] = (u_char)(v >> 32) & 0xff;
772 p[4] = (u_char)(v >> 24) & 0xff;
773 p[5] = (u_char)(v >> 16) & 0xff;
774 p[6] = (u_char)(v >> 8) & 0xff;
775 p[7] = (u_char)v & 0xff;
779 put_u32(void *vp, u_int32_t v)
781 u_char *p = (u_char *)vp;
783 p[0] = (u_char)(v >> 24) & 0xff;
784 p[1] = (u_char)(v >> 16) & 0xff;
785 p[2] = (u_char)(v >> 8) & 0xff;
786 p[3] = (u_char)v & 0xff;
791 put_u16(void *vp, u_int16_t v)
793 u_char *p = (u_char *)vp;
795 p[0] = (u_char)(v >> 8) & 0xff;
796 p[1] = (u_char)v & 0xff;