1 /* $OpenBSD: misc.c,v 1.67 2008/01/01 08:47:04 dtucker 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 /* Characters considered whitespace in strsep calls. */
155 #define WHITESPACE " \t\r\n"
158 /* Characters considered as quotations. */
161 /* return next token in configuration line */
173 if ((q=strchr(QUOTES, (int) *old)) && *q)
175 /* find next quote character, point old to start of quoted
177 for (p = ++old;*p && *p!=*q; p++)
180 /* find start of next token */
181 *s = (*p) ? p + strspn(p + 1, WHITESPACE) + 1 : NULL;
183 /* terminate 'old' token */
188 *s = strpbrk(*s, WHITESPACE QUOTE "=");
193 memmove(*s, *s + 1, strlen(*s)); /* move nul too */
194 /* Find matching quote */
195 if ((*s = strpbrk(*s, QUOTE)) == NULL) {
196 return (NULL); /* no matching quote */
203 /* Allow only one '=' to be skipped */
208 /* Skip any extra whitespace after first token */
209 *s += strspn(*s + 1, WHITESPACE) + 1;
210 if (*s[0] == '=' && !wspace)
211 *s += strspn(*s + 1, WHITESPACE) + 1;
217 pwcopy(struct passwd *pw)
219 struct passwd *copy = xcalloc(1, sizeof(*copy));
221 copy->pw_name = xstrdup(pw->pw_name);
222 copy->pw_passwd = xstrdup(pw->pw_passwd);
223 copy->pw_gecos = xstrdup(pw->pw_gecos);
224 copy->pw_uid = pw->pw_uid;
225 copy->pw_gid = pw->pw_gid;
226 #ifdef HAVE_PW_EXPIRE_IN_PASSWD
227 copy->pw_expire = pw->pw_expire;
229 #ifdef HAVE_PW_CHANGE_IN_PASSWD
230 copy->pw_change = pw->pw_change;
232 #ifdef HAVE_PW_CLASS_IN_PASSWD
233 copy->pw_class = xstrdup(pw->pw_class);
235 copy->pw_dir = xstrdup(pw->pw_dir);
236 copy->pw_shell = xstrdup(pw->pw_shell);
241 * Convert ASCII string to TCP/IP port number.
242 * Port must be >0 and <=65535.
243 * Return 0 if invalid.
246 a2port(const char *s)
252 port = strtol(s, &endp, 0);
253 if (s == endp || *endp != '\0' ||
254 (errno == ERANGE && (port == LONG_MIN || port == LONG_MAX)) ||
255 port <= 0 || port > 65535)
262 a2tun(const char *s, int *remote)
264 const char *errstr = NULL;
268 if (remote != NULL) {
269 *remote = SSH_TUNID_ANY;
271 if ((ep = strchr(sp, ':')) == NULL) {
273 return (a2tun(s, NULL));
276 *remote = a2tun(ep, NULL);
277 tun = a2tun(sp, NULL);
279 return (*remote == SSH_TUNID_ERR ? *remote : tun);
282 if (strcasecmp(s, "any") == 0)
283 return (SSH_TUNID_ANY);
285 tun = strtonum(s, 0, SSH_TUNID_MAX, &errstr);
287 return (SSH_TUNID_ERR);
293 #define MINUTES (SECONDS * 60)
294 #define HOURS (MINUTES * 60)
295 #define DAYS (HOURS * 24)
296 #define WEEKS (DAYS * 7)
299 * Convert a time string into seconds; format is
303 * Valid time qualifiers are:
317 * Return -1 if time string is invalid.
320 convtime(const char *s)
330 if (p == NULL || *p == '\0')
334 secs = strtol(p, &endp, 10);
336 (errno == ERANGE && (secs == LONG_MIN || secs == LONG_MAX)) ||
376 * Returns a standardized host+port identifier string.
377 * Caller must free returned string.
380 put_host_port(const char *host, u_short port)
384 if (port == 0 || port == SSH_DEFAULT_PORT)
385 return(xstrdup(host));
386 if (asprintf(&hoststr, "[%s]:%d", host, (int)port) < 0)
387 fatal("put_host_port: asprintf: %s", strerror(errno));
388 debug3("put_host_port: %s", hoststr);
393 * Search for next delimiter between hostnames/addresses and ports.
394 * Argument may be modified (for termination).
395 * Returns *cp if parsing succeeds.
396 * *cp is set to the start of the next delimiter, if one was found.
397 * If this is the last field, *cp is set to NULL.
404 if (cp == NULL || *cp == NULL)
409 if ((s = strchr(s, ']')) == NULL)
413 } else if ((s = strpbrk(s, ":/")) == NULL)
414 s = *cp + strlen(*cp); /* skip to end (see first case below) */
418 *cp = NULL; /* no more fields*/
423 *s = '\0'; /* terminate */
435 cleanhostname(char *host)
437 if (*host == '[' && host[strlen(host) - 1] == ']') {
438 host[strlen(host) - 1] = '\0';
449 if (*cp == ':') /* Leading colon is part of file name. */
455 if (*cp == '@' && *(cp+1) == '[')
457 if (*cp == ']' && *(cp+1) == ':' && flag)
459 if (*cp == ':' && !flag)
467 /* function to assist building execv() arguments */
469 addargs(arglist *args, char *fmt, ...)
477 r = vasprintf(&cp, fmt, ap);
480 fatal("addargs: argument too long");
482 nalloc = args->nalloc;
483 if (args->list == NULL) {
486 } else if (args->num+2 >= nalloc)
489 args->list = xrealloc(args->list, nalloc, sizeof(char *));
490 args->nalloc = nalloc;
491 args->list[args->num++] = cp;
492 args->list[args->num] = NULL;
496 replacearg(arglist *args, u_int which, char *fmt, ...)
503 r = vasprintf(&cp, fmt, ap);
506 fatal("replacearg: argument too long");
508 if (which >= args->num)
509 fatal("replacearg: tried to replace invalid arg %d >= %d",
511 xfree(args->list[which]);
512 args->list[which] = cp;
516 freeargs(arglist *args)
520 if (args->list != NULL) {
521 for (i = 0; i < args->num; i++)
522 xfree(args->list[i]);
524 args->nalloc = args->num = 0;
530 * Expands tildes in the file name. Returns data allocated by xmalloc.
531 * Warning: this calls getpw*.
534 tilde_expand_filename(const char *filename, uid_t uid)
537 char user[128], ret[MAXPATHLEN];
541 if (*filename != '~')
542 return (xstrdup(filename));
545 path = strchr(filename, '/');
546 if (path != NULL && path > filename) { /* ~user/path */
547 slash = path - filename;
548 if (slash > sizeof(user) - 1)
549 fatal("tilde_expand_filename: ~username too long");
550 memcpy(user, filename, slash);
552 if ((pw = getpwnam(user)) == NULL)
553 fatal("tilde_expand_filename: No such user %s", user);
554 } else if ((pw = getpwuid(uid)) == NULL) /* ~/path */
555 fatal("tilde_expand_filename: No such uid %d", uid);
557 if (strlcpy(ret, pw->pw_dir, sizeof(ret)) >= sizeof(ret))
558 fatal("tilde_expand_filename: Path too long");
560 /* Make sure directory has a trailing '/' */
561 len = strlen(pw->pw_dir);
562 if ((len == 0 || pw->pw_dir[len - 1] != '/') &&
563 strlcat(ret, "/", sizeof(ret)) >= sizeof(ret))
564 fatal("tilde_expand_filename: Path too long");
566 /* Skip leading '/' from specified path */
569 if (strlcat(ret, filename, sizeof(ret)) >= sizeof(ret))
570 fatal("tilde_expand_filename: Path too long");
572 return (xstrdup(ret));
576 * Expand a string with a set of %[char] escapes. A number of escapes may be
577 * specified as (char *escape_chars, char *replacement) pairs. The list must
578 * be terminated by a NULL escape_char. Returns replaced string in memory
579 * allocated by xmalloc.
582 percent_expand(const char *string, ...)
584 #define EXPAND_MAX_KEYS 16
588 } keys[EXPAND_MAX_KEYS];
589 u_int num_keys, i, j;
594 va_start(ap, string);
595 for (num_keys = 0; num_keys < EXPAND_MAX_KEYS; num_keys++) {
596 keys[num_keys].key = va_arg(ap, char *);
597 if (keys[num_keys].key == NULL)
599 keys[num_keys].repl = va_arg(ap, char *);
600 if (keys[num_keys].repl == NULL)
601 fatal("percent_expand: NULL replacement");
605 if (num_keys >= EXPAND_MAX_KEYS)
606 fatal("percent_expand: too many keys");
610 for (i = 0; *string != '\0'; string++) {
611 if (*string != '%') {
614 if (i >= sizeof(buf))
615 fatal("percent_expand: string too long");
622 for (j = 0; j < num_keys; j++) {
623 if (strchr(keys[j].key, *string) != NULL) {
624 i = strlcat(buf, keys[j].repl, sizeof(buf));
625 if (i >= sizeof(buf))
626 fatal("percent_expand: string too long");
631 fatal("percent_expand: unknown key %%%c", *string);
633 return (xstrdup(buf));
634 #undef EXPAND_MAX_KEYS
638 * Read an entire line from a public key file into a static buffer, discarding
639 * lines that exceed the buffer size. Returns 0 on success, -1 on failure.
642 read_keyfile_line(FILE *f, const char *filename, char *buf, size_t bufsz,
645 while (fgets(buf, bufsz, f) != NULL) {
649 if (buf[strlen(buf) - 1] == '\n' || feof(f)) {
652 debug("%s: %s line %lu exceeds size limit", __func__,
654 /* discard remainder of line */
655 while (fgetc(f) != '\n' && !feof(f))
663 tun_open(int tun, int mode)
665 #if defined(CUSTOM_SYS_TUN_OPEN)
666 return (sys_tun_open(tun, mode));
667 #elif defined(SSH_TUN_OPENBSD)
672 /* Open the tunnel device */
673 if (tun <= SSH_TUNID_MAX) {
674 snprintf(name, sizeof(name), "/dev/tun%d", tun);
675 fd = open(name, O_RDWR);
676 } else if (tun == SSH_TUNID_ANY) {
677 for (tun = 100; tun >= 0; tun--) {
678 snprintf(name, sizeof(name), "/dev/tun%d", tun);
679 if ((fd = open(name, O_RDWR)) >= 0)
683 debug("%s: invalid tunnel %u", __func__, tun);
688 debug("%s: %s open failed: %s", __func__, name, strerror(errno));
692 debug("%s: %s mode %d fd %d", __func__, name, mode, fd);
694 /* Set the tunnel device operation mode */
695 snprintf(ifr.ifr_name, sizeof(ifr.ifr_name), "tun%d", tun);
696 if ((sock = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
699 if (ioctl(sock, SIOCGIFFLAGS, &ifr) == -1)
702 /* Set interface mode */
703 ifr.ifr_flags &= ~IFF_UP;
704 if (mode == SSH_TUNMODE_ETHERNET)
705 ifr.ifr_flags |= IFF_LINK0;
707 ifr.ifr_flags &= ~IFF_LINK0;
708 if (ioctl(sock, SIOCSIFFLAGS, &ifr) == -1)
711 /* Bring interface up */
712 ifr.ifr_flags |= IFF_UP;
713 if (ioctl(sock, SIOCSIFFLAGS, &ifr) == -1)
724 debug("%s: failed to set %s mode %d: %s", __func__, name,
725 mode, strerror(errno));
728 error("Tunnel interfaces are not supported on this platform");
738 if ((nullfd = dupfd = open(_PATH_DEVNULL, O_RDWR)) == -1) {
739 fprintf(stderr, "Couldn't open /dev/null: %s", strerror(errno));
742 while (++dupfd <= 2) {
743 /* Only clobber closed fds */
744 if (fcntl(dupfd, F_GETFL, 0) >= 0)
746 if (dup2(nullfd, dupfd) == -1) {
747 fprintf(stderr, "dup2: %s", strerror(errno));
756 tohex(const void *vp, size_t l)
758 const u_char *p = (const u_char *)vp;
763 return xstrdup("tohex: length > 65536");
767 for (i = 0; i < l; i++) {
768 snprintf(b, sizeof(b), "%02x", p[i]);
775 get_u64(const void *vp)
777 const u_char *p = (const u_char *)vp;
780 v = (u_int64_t)p[0] << 56;
781 v |= (u_int64_t)p[1] << 48;
782 v |= (u_int64_t)p[2] << 40;
783 v |= (u_int64_t)p[3] << 32;
784 v |= (u_int64_t)p[4] << 24;
785 v |= (u_int64_t)p[5] << 16;
786 v |= (u_int64_t)p[6] << 8;
787 v |= (u_int64_t)p[7];
793 get_u32(const void *vp)
795 const u_char *p = (const u_char *)vp;
798 v = (u_int32_t)p[0] << 24;
799 v |= (u_int32_t)p[1] << 16;
800 v |= (u_int32_t)p[2] << 8;
801 v |= (u_int32_t)p[3];
807 get_u16(const void *vp)
809 const u_char *p = (const u_char *)vp;
812 v = (u_int16_t)p[0] << 8;
813 v |= (u_int16_t)p[1];
819 put_u64(void *vp, u_int64_t v)
821 u_char *p = (u_char *)vp;
823 p[0] = (u_char)(v >> 56) & 0xff;
824 p[1] = (u_char)(v >> 48) & 0xff;
825 p[2] = (u_char)(v >> 40) & 0xff;
826 p[3] = (u_char)(v >> 32) & 0xff;
827 p[4] = (u_char)(v >> 24) & 0xff;
828 p[5] = (u_char)(v >> 16) & 0xff;
829 p[6] = (u_char)(v >> 8) & 0xff;
830 p[7] = (u_char)v & 0xff;
834 put_u32(void *vp, u_int32_t v)
836 u_char *p = (u_char *)vp;
838 p[0] = (u_char)(v >> 24) & 0xff;
839 p[1] = (u_char)(v >> 16) & 0xff;
840 p[2] = (u_char)(v >> 8) & 0xff;
841 p[3] = (u_char)v & 0xff;
846 put_u16(void *vp, u_int16_t v)
848 u_char *p = (u_char *)vp;
850 p[0] = (u_char)(v >> 8) & 0xff;
851 p[1] = (u_char)v & 0xff;