1 /* $OpenBSD: misc.c,v 1.71 2009/02/21 19:32:04 tobias 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 pwfree(struct passwd *pw)
244 xfree(pw->pw_passwd);
246 #ifdef HAVE_PW_CLASS_IN_PASSWD
255 * Convert ASCII string to TCP/IP port number.
256 * Port must be >=0 and <=65535.
257 * Return -1 if invalid.
260 a2port(const char *s)
265 port = strtonum(s, 0, 65535, &errstr);
272 a2tun(const char *s, int *remote)
274 const char *errstr = NULL;
278 if (remote != NULL) {
279 *remote = SSH_TUNID_ANY;
281 if ((ep = strchr(sp, ':')) == NULL) {
283 return (a2tun(s, NULL));
286 *remote = a2tun(ep, NULL);
287 tun = a2tun(sp, NULL);
289 return (*remote == SSH_TUNID_ERR ? *remote : tun);
292 if (strcasecmp(s, "any") == 0)
293 return (SSH_TUNID_ANY);
295 tun = strtonum(s, 0, SSH_TUNID_MAX, &errstr);
297 return (SSH_TUNID_ERR);
303 #define MINUTES (SECONDS * 60)
304 #define HOURS (MINUTES * 60)
305 #define DAYS (HOURS * 24)
306 #define WEEKS (DAYS * 7)
309 * Convert a time string into seconds; format is
313 * Valid time qualifiers are:
327 * Return -1 if time string is invalid.
330 convtime(const char *s)
340 if (p == NULL || *p == '\0')
344 secs = strtol(p, &endp, 10);
346 (errno == ERANGE && (secs == LONG_MIN || secs == LONG_MAX)) ||
386 * Returns a standardized host+port identifier string.
387 * Caller must free returned string.
390 put_host_port(const char *host, u_short port)
394 if (port == 0 || port == SSH_DEFAULT_PORT)
395 return(xstrdup(host));
396 if (asprintf(&hoststr, "[%s]:%d", host, (int)port) < 0)
397 fatal("put_host_port: asprintf: %s", strerror(errno));
398 debug3("put_host_port: %s", hoststr);
403 * Search for next delimiter between hostnames/addresses and ports.
404 * Argument may be modified (for termination).
405 * Returns *cp if parsing succeeds.
406 * *cp is set to the start of the next delimiter, if one was found.
407 * If this is the last field, *cp is set to NULL.
414 if (cp == NULL || *cp == NULL)
419 if ((s = strchr(s, ']')) == NULL)
423 } else if ((s = strpbrk(s, ":/")) == NULL)
424 s = *cp + strlen(*cp); /* skip to end (see first case below) */
428 *cp = NULL; /* no more fields*/
433 *s = '\0'; /* terminate */
445 cleanhostname(char *host)
447 if (*host == '[' && host[strlen(host) - 1] == ']') {
448 host[strlen(host) - 1] = '\0';
459 if (*cp == ':') /* Leading colon is part of file name. */
465 if (*cp == '@' && *(cp+1) == '[')
467 if (*cp == ']' && *(cp+1) == ':' && flag)
469 if (*cp == ':' && !flag)
477 /* function to assist building execv() arguments */
479 addargs(arglist *args, char *fmt, ...)
487 r = vasprintf(&cp, fmt, ap);
490 fatal("addargs: argument too long");
492 nalloc = args->nalloc;
493 if (args->list == NULL) {
496 } else if (args->num+2 >= nalloc)
499 args->list = xrealloc(args->list, nalloc, sizeof(char *));
500 args->nalloc = nalloc;
501 args->list[args->num++] = cp;
502 args->list[args->num] = NULL;
506 replacearg(arglist *args, u_int which, char *fmt, ...)
513 r = vasprintf(&cp, fmt, ap);
516 fatal("replacearg: argument too long");
518 if (which >= args->num)
519 fatal("replacearg: tried to replace invalid arg %d >= %d",
521 xfree(args->list[which]);
522 args->list[which] = cp;
526 freeargs(arglist *args)
530 if (args->list != NULL) {
531 for (i = 0; i < args->num; i++)
532 xfree(args->list[i]);
534 args->nalloc = args->num = 0;
540 * Expands tildes in the file name. Returns data allocated by xmalloc.
541 * Warning: this calls getpw*.
544 tilde_expand_filename(const char *filename, uid_t uid)
547 char user[128], ret[MAXPATHLEN];
551 if (*filename != '~')
552 return (xstrdup(filename));
555 path = strchr(filename, '/');
556 if (path != NULL && path > filename) { /* ~user/path */
557 slash = path - filename;
558 if (slash > sizeof(user) - 1)
559 fatal("tilde_expand_filename: ~username too long");
560 memcpy(user, filename, slash);
562 if ((pw = getpwnam(user)) == NULL)
563 fatal("tilde_expand_filename: No such user %s", user);
564 } else if ((pw = getpwuid(uid)) == NULL) /* ~/path */
565 fatal("tilde_expand_filename: No such uid %ld", (long)uid);
567 if (strlcpy(ret, pw->pw_dir, sizeof(ret)) >= sizeof(ret))
568 fatal("tilde_expand_filename: Path too long");
570 /* Make sure directory has a trailing '/' */
571 len = strlen(pw->pw_dir);
572 if ((len == 0 || pw->pw_dir[len - 1] != '/') &&
573 strlcat(ret, "/", sizeof(ret)) >= sizeof(ret))
574 fatal("tilde_expand_filename: Path too long");
576 /* Skip leading '/' from specified path */
579 if (strlcat(ret, filename, sizeof(ret)) >= sizeof(ret))
580 fatal("tilde_expand_filename: Path too long");
582 return (xstrdup(ret));
586 * Expand a string with a set of %[char] escapes. A number of escapes may be
587 * specified as (char *escape_chars, char *replacement) pairs. The list must
588 * be terminated by a NULL escape_char. Returns replaced string in memory
589 * allocated by xmalloc.
592 percent_expand(const char *string, ...)
594 #define EXPAND_MAX_KEYS 16
598 } keys[EXPAND_MAX_KEYS];
599 u_int num_keys, i, j;
604 va_start(ap, string);
605 for (num_keys = 0; num_keys < EXPAND_MAX_KEYS; num_keys++) {
606 keys[num_keys].key = va_arg(ap, char *);
607 if (keys[num_keys].key == NULL)
609 keys[num_keys].repl = va_arg(ap, char *);
610 if (keys[num_keys].repl == NULL)
611 fatal("percent_expand: NULL replacement");
615 if (num_keys >= EXPAND_MAX_KEYS)
616 fatal("percent_expand: too many keys");
620 for (i = 0; *string != '\0'; string++) {
621 if (*string != '%') {
624 if (i >= sizeof(buf))
625 fatal("percent_expand: string too long");
632 for (j = 0; j < num_keys; j++) {
633 if (strchr(keys[j].key, *string) != NULL) {
634 i = strlcat(buf, keys[j].repl, sizeof(buf));
635 if (i >= sizeof(buf))
636 fatal("percent_expand: string too long");
641 fatal("percent_expand: unknown key %%%c", *string);
643 return (xstrdup(buf));
644 #undef EXPAND_MAX_KEYS
648 * Read an entire line from a public key file into a static buffer, discarding
649 * lines that exceed the buffer size. Returns 0 on success, -1 on failure.
652 read_keyfile_line(FILE *f, const char *filename, char *buf, size_t bufsz,
655 while (fgets(buf, bufsz, f) != NULL) {
659 if (buf[strlen(buf) - 1] == '\n' || feof(f)) {
662 debug("%s: %s line %lu exceeds size limit", __func__,
664 /* discard remainder of line */
665 while (fgetc(f) != '\n' && !feof(f))
673 tun_open(int tun, int mode)
675 #if defined(CUSTOM_SYS_TUN_OPEN)
676 return (sys_tun_open(tun, mode));
677 #elif defined(SSH_TUN_OPENBSD)
682 /* Open the tunnel device */
683 if (tun <= SSH_TUNID_MAX) {
684 snprintf(name, sizeof(name), "/dev/tun%d", tun);
685 fd = open(name, O_RDWR);
686 } else if (tun == SSH_TUNID_ANY) {
687 for (tun = 100; tun >= 0; tun--) {
688 snprintf(name, sizeof(name), "/dev/tun%d", tun);
689 if ((fd = open(name, O_RDWR)) >= 0)
693 debug("%s: invalid tunnel %u", __func__, tun);
698 debug("%s: %s open failed: %s", __func__, name, strerror(errno));
702 debug("%s: %s mode %d fd %d", __func__, name, mode, fd);
704 /* Set the tunnel device operation mode */
705 snprintf(ifr.ifr_name, sizeof(ifr.ifr_name), "tun%d", tun);
706 if ((sock = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
709 if (ioctl(sock, SIOCGIFFLAGS, &ifr) == -1)
712 /* Set interface mode */
713 ifr.ifr_flags &= ~IFF_UP;
714 if (mode == SSH_TUNMODE_ETHERNET)
715 ifr.ifr_flags |= IFF_LINK0;
717 ifr.ifr_flags &= ~IFF_LINK0;
718 if (ioctl(sock, SIOCSIFFLAGS, &ifr) == -1)
721 /* Bring interface up */
722 ifr.ifr_flags |= IFF_UP;
723 if (ioctl(sock, SIOCSIFFLAGS, &ifr) == -1)
734 debug("%s: failed to set %s mode %d: %s", __func__, name,
735 mode, strerror(errno));
738 error("Tunnel interfaces are not supported on this platform");
748 if ((nullfd = dupfd = open(_PATH_DEVNULL, O_RDWR)) == -1) {
749 fprintf(stderr, "Couldn't open /dev/null: %s\n",
753 while (++dupfd <= 2) {
754 /* Only clobber closed fds */
755 if (fcntl(dupfd, F_GETFL, 0) >= 0)
757 if (dup2(nullfd, dupfd) == -1) {
758 fprintf(stderr, "dup2: %s\n", strerror(errno));
767 tohex(const void *vp, size_t l)
769 const u_char *p = (const u_char *)vp;
774 return xstrdup("tohex: length > 65536");
778 for (i = 0; i < l; i++) {
779 snprintf(b, sizeof(b), "%02x", p[i]);
786 get_u64(const void *vp)
788 const u_char *p = (const u_char *)vp;
791 v = (u_int64_t)p[0] << 56;
792 v |= (u_int64_t)p[1] << 48;
793 v |= (u_int64_t)p[2] << 40;
794 v |= (u_int64_t)p[3] << 32;
795 v |= (u_int64_t)p[4] << 24;
796 v |= (u_int64_t)p[5] << 16;
797 v |= (u_int64_t)p[6] << 8;
798 v |= (u_int64_t)p[7];
804 get_u32(const void *vp)
806 const u_char *p = (const u_char *)vp;
809 v = (u_int32_t)p[0] << 24;
810 v |= (u_int32_t)p[1] << 16;
811 v |= (u_int32_t)p[2] << 8;
812 v |= (u_int32_t)p[3];
818 get_u16(const void *vp)
820 const u_char *p = (const u_char *)vp;
823 v = (u_int16_t)p[0] << 8;
824 v |= (u_int16_t)p[1];
830 put_u64(void *vp, u_int64_t v)
832 u_char *p = (u_char *)vp;
834 p[0] = (u_char)(v >> 56) & 0xff;
835 p[1] = (u_char)(v >> 48) & 0xff;
836 p[2] = (u_char)(v >> 40) & 0xff;
837 p[3] = (u_char)(v >> 32) & 0xff;
838 p[4] = (u_char)(v >> 24) & 0xff;
839 p[5] = (u_char)(v >> 16) & 0xff;
840 p[6] = (u_char)(v >> 8) & 0xff;
841 p[7] = (u_char)v & 0xff;
845 put_u32(void *vp, u_int32_t v)
847 u_char *p = (u_char *)vp;
849 p[0] = (u_char)(v >> 24) & 0xff;
850 p[1] = (u_char)(v >> 16) & 0xff;
851 p[2] = (u_char)(v >> 8) & 0xff;
852 p[3] = (u_char)v & 0xff;
857 put_u16(void *vp, u_int16_t v)
859 u_char *p = (u_char *)vp;
861 p[0] = (u_char)(v >> 8) & 0xff;
862 p[1] = (u_char)v & 0xff;
866 ms_subtract_diff(struct timeval *start, int *ms)
868 struct timeval diff, finish;
870 gettimeofday(&finish, NULL);
871 timersub(&finish, start, &diff);
872 *ms -= (diff.tv_sec * 1000) + (diff.tv_usec / 1000);
876 ms_to_timeval(struct timeval *tv, int ms)
880 tv->tv_sec = ms / 1000;
881 tv->tv_usec = (ms % 1000) * 1000;