1 /* $OpenBSD: misc.c,v 1.53 2006/07/05 02:42:09 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/socket.h>
32 #include <netinet/in.h>
33 #include <netinet/tcp.h>
38 #ifdef SSH_TUN_OPENBSD
46 /* remove newline at end of string */
52 if (*t == '\n' || *t == '\r') {
62 /* set/unset filedescriptor to non-blocking */
68 val = fcntl(fd, F_GETFL, 0);
70 error("fcntl(%d, F_GETFL, 0): %s", fd, strerror(errno));
73 if (val & O_NONBLOCK) {
74 debug3("fd %d is O_NONBLOCK", fd);
77 debug2("fd %d setting O_NONBLOCK", fd);
79 if (fcntl(fd, F_SETFL, val) == -1) {
80 debug("fcntl(%d, F_SETFL, O_NONBLOCK): %s", fd,
88 unset_nonblock(int fd)
92 val = fcntl(fd, F_GETFL, 0);
94 error("fcntl(%d, F_GETFL, 0): %s", fd, strerror(errno));
97 if (!(val & O_NONBLOCK)) {
98 debug3("fd %d is not O_NONBLOCK", fd);
101 debug("fd %d clearing O_NONBLOCK", fd);
103 if (fcntl(fd, F_SETFL, val) == -1) {
104 debug("fcntl(%d, F_SETFL, ~O_NONBLOCK): %s",
105 fd, strerror(errno));
111 /* disable nagle on socket */
119 if (getsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &opt, &optlen) == -1) {
120 debug("getsockopt TCP_NODELAY: %.100s", strerror(errno));
124 debug2("fd %d is TCP_NODELAY", fd);
128 debug2("fd %d setting TCP_NODELAY", fd);
129 if (setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &opt, sizeof opt) == -1)
130 error("setsockopt TCP_NODELAY: %.100s", strerror(errno));
133 /* Characters considered whitespace in strsep calls. */
134 #define WHITESPACE " \t\r\n"
137 /* return next token in configuration line */
149 *s = strpbrk(*s, WHITESPACE QUOTE "=");
154 memmove(*s, *s + 1, strlen(*s)); /* move nul too */
155 /* Find matching quote */
156 if ((*s = strpbrk(*s, QUOTE)) == NULL) {
157 return (NULL); /* no matching quote */
164 /* Allow only one '=' to be skipped */
169 /* Skip any extra whitespace after first token */
170 *s += strspn(*s + 1, WHITESPACE) + 1;
171 if (*s[0] == '=' && !wspace)
172 *s += strspn(*s + 1, WHITESPACE) + 1;
178 pwcopy(struct passwd *pw)
180 struct passwd *copy = xcalloc(1, sizeof(*copy));
182 copy->pw_name = xstrdup(pw->pw_name);
183 copy->pw_passwd = xstrdup(pw->pw_passwd);
184 copy->pw_gecos = xstrdup(pw->pw_gecos);
185 copy->pw_uid = pw->pw_uid;
186 copy->pw_gid = pw->pw_gid;
187 #ifdef HAVE_PW_EXPIRE_IN_PASSWD
188 copy->pw_expire = pw->pw_expire;
190 #ifdef HAVE_PW_CHANGE_IN_PASSWD
191 copy->pw_change = pw->pw_change;
193 #ifdef HAVE_PW_CLASS_IN_PASSWD
194 copy->pw_class = xstrdup(pw->pw_class);
196 copy->pw_dir = xstrdup(pw->pw_dir);
197 copy->pw_shell = xstrdup(pw->pw_shell);
202 * Convert ASCII string to TCP/IP port number.
203 * Port must be >0 and <=65535.
204 * Return 0 if invalid.
207 a2port(const char *s)
213 port = strtol(s, &endp, 0);
214 if (s == endp || *endp != '\0' ||
215 (errno == ERANGE && (port == LONG_MIN || port == LONG_MAX)) ||
216 port <= 0 || port > 65535)
223 a2tun(const char *s, int *remote)
225 const char *errstr = NULL;
229 if (remote != NULL) {
230 *remote = SSH_TUNID_ANY;
232 if ((ep = strchr(sp, ':')) == NULL) {
234 return (a2tun(s, NULL));
237 *remote = a2tun(ep, NULL);
238 tun = a2tun(sp, NULL);
240 return (*remote == SSH_TUNID_ERR ? *remote : tun);
243 if (strcasecmp(s, "any") == 0)
244 return (SSH_TUNID_ANY);
246 tun = strtonum(s, 0, SSH_TUNID_MAX, &errstr);
248 return (SSH_TUNID_ERR);
254 #define MINUTES (SECONDS * 60)
255 #define HOURS (MINUTES * 60)
256 #define DAYS (HOURS * 24)
257 #define WEEKS (DAYS * 7)
260 * Convert a time string into seconds; format is
264 * Valid time qualifiers are:
278 * Return -1 if time string is invalid.
281 convtime(const char *s)
291 if (p == NULL || *p == '\0')
295 secs = strtol(p, &endp, 10);
297 (errno == ERANGE && (secs == LONG_MIN || secs == LONG_MAX)) ||
337 * Search for next delimiter between hostnames/addresses and ports.
338 * Argument may be modified (for termination).
339 * Returns *cp if parsing succeeds.
340 * *cp is set to the start of the next delimiter, if one was found.
341 * If this is the last field, *cp is set to NULL.
348 if (cp == NULL || *cp == NULL)
353 if ((s = strchr(s, ']')) == NULL)
357 } else if ((s = strpbrk(s, ":/")) == NULL)
358 s = *cp + strlen(*cp); /* skip to end (see first case below) */
362 *cp = NULL; /* no more fields*/
367 *s = '\0'; /* terminate */
379 cleanhostname(char *host)
381 if (*host == '[' && host[strlen(host) - 1] == ']') {
382 host[strlen(host) - 1] = '\0';
393 if (*cp == ':') /* Leading colon is part of file name. */
399 if (*cp == '@' && *(cp+1) == '[')
401 if (*cp == ']' && *(cp+1) == ':' && flag)
403 if (*cp == ':' && !flag)
411 /* function to assist building execv() arguments */
413 addargs(arglist *args, char *fmt, ...)
421 r = vasprintf(&cp, fmt, ap);
424 fatal("addargs: argument too long");
426 nalloc = args->nalloc;
427 if (args->list == NULL) {
430 } else if (args->num+2 >= nalloc)
433 args->list = xrealloc(args->list, nalloc, sizeof(char *));
434 args->nalloc = nalloc;
435 args->list[args->num++] = cp;
436 args->list[args->num] = NULL;
440 replacearg(arglist *args, u_int which, char *fmt, ...)
447 r = vasprintf(&cp, fmt, ap);
450 fatal("replacearg: argument too long");
452 if (which >= args->num)
453 fatal("replacearg: tried to replace invalid arg %d >= %d",
455 xfree(args->list[which]);
456 args->list[which] = cp;
460 freeargs(arglist *args)
464 if (args->list != NULL) {
465 for (i = 0; i < args->num; i++)
466 xfree(args->list[i]);
468 args->nalloc = args->num = 0;
474 * Expands tildes in the file name. Returns data allocated by xmalloc.
475 * Warning: this calls getpw*.
478 tilde_expand_filename(const char *filename, uid_t uid)
481 char user[128], ret[MAXPATHLEN];
485 if (*filename != '~')
486 return (xstrdup(filename));
489 path = strchr(filename, '/');
490 if (path != NULL && path > filename) { /* ~user/path */
491 slash = path - filename;
492 if (slash > sizeof(user) - 1)
493 fatal("tilde_expand_filename: ~username too long");
494 memcpy(user, filename, slash);
496 if ((pw = getpwnam(user)) == NULL)
497 fatal("tilde_expand_filename: No such user %s", user);
498 } else if ((pw = getpwuid(uid)) == NULL) /* ~/path */
499 fatal("tilde_expand_filename: No such uid %d", uid);
501 if (strlcpy(ret, pw->pw_dir, sizeof(ret)) >= sizeof(ret))
502 fatal("tilde_expand_filename: Path too long");
504 /* Make sure directory has a trailing '/' */
505 len = strlen(pw->pw_dir);
506 if ((len == 0 || pw->pw_dir[len - 1] != '/') &&
507 strlcat(ret, "/", sizeof(ret)) >= sizeof(ret))
508 fatal("tilde_expand_filename: Path too long");
510 /* Skip leading '/' from specified path */
513 if (strlcat(ret, filename, sizeof(ret)) >= sizeof(ret))
514 fatal("tilde_expand_filename: Path too long");
516 return (xstrdup(ret));
520 * Expand a string with a set of %[char] escapes. A number of escapes may be
521 * specified as (char *escape_chars, char *replacement) pairs. The list must
522 * be terminated by a NULL escape_char. Returns replaced string in memory
523 * allocated by xmalloc.
526 percent_expand(const char *string, ...)
528 #define EXPAND_MAX_KEYS 16
532 } keys[EXPAND_MAX_KEYS];
533 u_int num_keys, i, j;
538 va_start(ap, string);
539 for (num_keys = 0; num_keys < EXPAND_MAX_KEYS; num_keys++) {
540 keys[num_keys].key = va_arg(ap, char *);
541 if (keys[num_keys].key == NULL)
543 keys[num_keys].repl = va_arg(ap, char *);
544 if (keys[num_keys].repl == NULL)
545 fatal("percent_expand: NULL replacement");
549 if (num_keys >= EXPAND_MAX_KEYS)
550 fatal("percent_expand: too many keys");
554 for (i = 0; *string != '\0'; string++) {
555 if (*string != '%') {
558 if (i >= sizeof(buf))
559 fatal("percent_expand: string too long");
566 for (j = 0; j < num_keys; j++) {
567 if (strchr(keys[j].key, *string) != NULL) {
568 i = strlcat(buf, keys[j].repl, sizeof(buf));
569 if (i >= sizeof(buf))
570 fatal("percent_expand: string too long");
575 fatal("percent_expand: unknown key %%%c", *string);
577 return (xstrdup(buf));
578 #undef EXPAND_MAX_KEYS
582 * Read an entire line from a public key file into a static buffer, discarding
583 * lines that exceed the buffer size. Returns 0 on success, -1 on failure.
586 read_keyfile_line(FILE *f, const char *filename, char *buf, size_t bufsz,
589 while (fgets(buf, bufsz, f) != NULL) {
591 if (buf[strlen(buf) - 1] == '\n' || feof(f)) {
594 debug("%s: %s line %lu exceeds size limit", __func__,
596 /* discard remainder of line */
597 while (fgetc(f) != '\n' && !feof(f))
605 tun_open(int tun, int mode)
607 #if defined(CUSTOM_SYS_TUN_OPEN)
608 return (sys_tun_open(tun, mode));
609 #elif defined(SSH_TUN_OPENBSD)
614 /* Open the tunnel device */
615 if (tun <= SSH_TUNID_MAX) {
616 snprintf(name, sizeof(name), "/dev/tun%d", tun);
617 fd = open(name, O_RDWR);
618 } else if (tun == SSH_TUNID_ANY) {
619 for (tun = 100; tun >= 0; tun--) {
620 snprintf(name, sizeof(name), "/dev/tun%d", tun);
621 if ((fd = open(name, O_RDWR)) >= 0)
625 debug("%s: invalid tunnel %u", __func__, tun);
630 debug("%s: %s open failed: %s", __func__, name, strerror(errno));
634 debug("%s: %s mode %d fd %d", __func__, name, mode, fd);
636 /* Set the tunnel device operation mode */
637 snprintf(ifr.ifr_name, sizeof(ifr.ifr_name), "tun%d", tun);
638 if ((sock = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
641 if (ioctl(sock, SIOCGIFFLAGS, &ifr) == -1)
644 /* Set interface mode */
645 ifr.ifr_flags &= ~IFF_UP;
646 if (mode == SSH_TUNMODE_ETHERNET)
647 ifr.ifr_flags |= IFF_LINK0;
649 ifr.ifr_flags &= ~IFF_LINK0;
650 if (ioctl(sock, SIOCSIFFLAGS, &ifr) == -1)
653 /* Bring interface up */
654 ifr.ifr_flags |= IFF_UP;
655 if (ioctl(sock, SIOCSIFFLAGS, &ifr) == -1)
666 debug("%s: failed to set %s mode %d: %s", __func__, name,
667 mode, strerror(errno));
670 error("Tunnel interfaces are not supported on this platform");
680 if ((nullfd = dupfd = open(_PATH_DEVNULL, O_RDWR)) == -1) {
681 fprintf(stderr, "Couldn't open /dev/null: %s", strerror(errno));
684 while (++dupfd <= 2) {
685 /* Only clobber closed fds */
686 if (fcntl(dupfd, F_GETFL, 0) >= 0)
688 if (dup2(nullfd, dupfd) == -1) {
689 fprintf(stderr, "dup2: %s", strerror(errno));
698 tohex(const void *vp, size_t l)
700 const u_char *p = (const u_char *)vp;
705 return xstrdup("tohex: length > 65536");
709 for (i = 0; i < l; i++) {
710 snprintf(b, sizeof(b), "%02x", p[i]);
717 get_u64(const void *vp)
719 const u_char *p = (const u_char *)vp;
722 v = (u_int64_t)p[0] << 56;
723 v |= (u_int64_t)p[1] << 48;
724 v |= (u_int64_t)p[2] << 40;
725 v |= (u_int64_t)p[3] << 32;
726 v |= (u_int64_t)p[4] << 24;
727 v |= (u_int64_t)p[5] << 16;
728 v |= (u_int64_t)p[6] << 8;
729 v |= (u_int64_t)p[7];
735 get_u32(const void *vp)
737 const u_char *p = (const u_char *)vp;
740 v = (u_int32_t)p[0] << 24;
741 v |= (u_int32_t)p[1] << 16;
742 v |= (u_int32_t)p[2] << 8;
743 v |= (u_int32_t)p[3];
749 get_u16(const void *vp)
751 const u_char *p = (const u_char *)vp;
754 v = (u_int16_t)p[0] << 8;
755 v |= (u_int16_t)p[1];
761 put_u64(void *vp, u_int64_t v)
763 u_char *p = (u_char *)vp;
765 p[0] = (u_char)(v >> 56) & 0xff;
766 p[1] = (u_char)(v >> 48) & 0xff;
767 p[2] = (u_char)(v >> 40) & 0xff;
768 p[3] = (u_char)(v >> 32) & 0xff;
769 p[4] = (u_char)(v >> 24) & 0xff;
770 p[5] = (u_char)(v >> 16) & 0xff;
771 p[6] = (u_char)(v >> 8) & 0xff;
772 p[7] = (u_char)v & 0xff;
776 put_u32(void *vp, u_int32_t v)
778 u_char *p = (u_char *)vp;
780 p[0] = (u_char)(v >> 24) & 0xff;
781 p[1] = (u_char)(v >> 16) & 0xff;
782 p[2] = (u_char)(v >> 8) & 0xff;
783 p[3] = (u_char)v & 0xff;
788 put_u16(void *vp, u_int16_t v)
790 u_char *p = (u_char *)vp;
792 p[0] = (u_char)(v >> 8) & 0xff;
793 p[1] = (u_char)v & 0xff;