- stevesk@cvs.openbsd.org 2006/07/22 20:48:23
[openssh-git.git] / misc.c
blob4c202db2a80e16dd5583cecb5194abac9326fc22
1 /* $OpenBSD: misc.c,v 1.60 2006/07/22 20:48:23 stevesk Exp $ */
2 /*
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
8 * are met:
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.
27 #include "includes.h"
29 #include <sys/ioctl.h>
30 #include <sys/types.h>
31 #include <sys/socket.h>
33 #include <stdarg.h>
34 #include <string.h>
35 #include <unistd.h>
37 #include <netinet/in.h>
38 #include <netinet/tcp.h>
40 #include <errno.h>
41 #include <fcntl.h>
42 #ifdef HAVE_PATHS_H
43 # include <paths.h>
44 #include <pwd.h>
45 #endif
46 #ifdef SSH_TUN_OPENBSD
47 #include <net/if.h>
48 #endif
50 #include "misc.h"
51 #include "log.h"
52 #include "xmalloc.h"
53 #include "ssh.h"
55 /* remove newline at end of string */
56 char *
57 chop(char *s)
59 char *t = s;
60 while (*t) {
61 if (*t == '\n' || *t == '\r') {
62 *t = '\0';
63 return s;
65 t++;
67 return s;
71 /* set/unset filedescriptor to non-blocking */
72 int
73 set_nonblock(int fd)
75 int val;
77 val = fcntl(fd, F_GETFL, 0);
78 if (val < 0) {
79 error("fcntl(%d, F_GETFL, 0): %s", fd, strerror(errno));
80 return (-1);
82 if (val & O_NONBLOCK) {
83 debug3("fd %d is O_NONBLOCK", fd);
84 return (0);
86 debug2("fd %d setting O_NONBLOCK", fd);
87 val |= O_NONBLOCK;
88 if (fcntl(fd, F_SETFL, val) == -1) {
89 debug("fcntl(%d, F_SETFL, O_NONBLOCK): %s", fd,
90 strerror(errno));
91 return (-1);
93 return (0);
96 int
97 unset_nonblock(int fd)
99 int val;
101 val = fcntl(fd, F_GETFL, 0);
102 if (val < 0) {
103 error("fcntl(%d, F_GETFL, 0): %s", fd, strerror(errno));
104 return (-1);
106 if (!(val & O_NONBLOCK)) {
107 debug3("fd %d is not O_NONBLOCK", fd);
108 return (0);
110 debug("fd %d clearing O_NONBLOCK", fd);
111 val &= ~O_NONBLOCK;
112 if (fcntl(fd, F_SETFL, val) == -1) {
113 debug("fcntl(%d, F_SETFL, ~O_NONBLOCK): %s",
114 fd, strerror(errno));
115 return (-1);
117 return (0);
120 /* disable nagle on socket */
121 void
122 set_nodelay(int fd)
124 int opt;
125 socklen_t optlen;
127 optlen = sizeof opt;
128 if (getsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &opt, &optlen) == -1) {
129 debug("getsockopt TCP_NODELAY: %.100s", strerror(errno));
130 return;
132 if (opt == 1) {
133 debug2("fd %d is TCP_NODELAY", fd);
134 return;
136 opt = 1;
137 debug2("fd %d setting TCP_NODELAY", fd);
138 if (setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &opt, sizeof opt) == -1)
139 error("setsockopt TCP_NODELAY: %.100s", strerror(errno));
142 /* Characters considered whitespace in strsep calls. */
143 #define WHITESPACE " \t\r\n"
144 #define QUOTE "\""
146 /* return next token in configuration line */
147 char *
148 strdelim(char **s)
150 char *old;
151 int wspace = 0;
153 if (*s == NULL)
154 return NULL;
156 old = *s;
158 *s = strpbrk(*s, WHITESPACE QUOTE "=");
159 if (*s == NULL)
160 return (old);
162 if (*s[0] == '\"') {
163 memmove(*s, *s + 1, strlen(*s)); /* move nul too */
164 /* Find matching quote */
165 if ((*s = strpbrk(*s, QUOTE)) == NULL) {
166 return (NULL); /* no matching quote */
167 } else {
168 *s[0] = '\0';
169 return (old);
173 /* Allow only one '=' to be skipped */
174 if (*s[0] == '=')
175 wspace = 1;
176 *s[0] = '\0';
178 /* Skip any extra whitespace after first token */
179 *s += strspn(*s + 1, WHITESPACE) + 1;
180 if (*s[0] == '=' && !wspace)
181 *s += strspn(*s + 1, WHITESPACE) + 1;
183 return (old);
186 struct passwd *
187 pwcopy(struct passwd *pw)
189 struct passwd *copy = xcalloc(1, sizeof(*copy));
191 copy->pw_name = xstrdup(pw->pw_name);
192 copy->pw_passwd = xstrdup(pw->pw_passwd);
193 copy->pw_gecos = xstrdup(pw->pw_gecos);
194 copy->pw_uid = pw->pw_uid;
195 copy->pw_gid = pw->pw_gid;
196 #ifdef HAVE_PW_EXPIRE_IN_PASSWD
197 copy->pw_expire = pw->pw_expire;
198 #endif
199 #ifdef HAVE_PW_CHANGE_IN_PASSWD
200 copy->pw_change = pw->pw_change;
201 #endif
202 #ifdef HAVE_PW_CLASS_IN_PASSWD
203 copy->pw_class = xstrdup(pw->pw_class);
204 #endif
205 copy->pw_dir = xstrdup(pw->pw_dir);
206 copy->pw_shell = xstrdup(pw->pw_shell);
207 return copy;
211 * Convert ASCII string to TCP/IP port number.
212 * Port must be >0 and <=65535.
213 * Return 0 if invalid.
216 a2port(const char *s)
218 long port;
219 char *endp;
221 errno = 0;
222 port = strtol(s, &endp, 0);
223 if (s == endp || *endp != '\0' ||
224 (errno == ERANGE && (port == LONG_MIN || port == LONG_MAX)) ||
225 port <= 0 || port > 65535)
226 return 0;
228 return port;
232 a2tun(const char *s, int *remote)
234 const char *errstr = NULL;
235 char *sp, *ep;
236 int tun;
238 if (remote != NULL) {
239 *remote = SSH_TUNID_ANY;
240 sp = xstrdup(s);
241 if ((ep = strchr(sp, ':')) == NULL) {
242 xfree(sp);
243 return (a2tun(s, NULL));
245 ep[0] = '\0'; ep++;
246 *remote = a2tun(ep, NULL);
247 tun = a2tun(sp, NULL);
248 xfree(sp);
249 return (*remote == SSH_TUNID_ERR ? *remote : tun);
252 if (strcasecmp(s, "any") == 0)
253 return (SSH_TUNID_ANY);
255 tun = strtonum(s, 0, SSH_TUNID_MAX, &errstr);
256 if (errstr != NULL)
257 return (SSH_TUNID_ERR);
259 return (tun);
262 #define SECONDS 1
263 #define MINUTES (SECONDS * 60)
264 #define HOURS (MINUTES * 60)
265 #define DAYS (HOURS * 24)
266 #define WEEKS (DAYS * 7)
269 * Convert a time string into seconds; format is
270 * a sequence of:
271 * time[qualifier]
273 * Valid time qualifiers are:
274 * <none> seconds
275 * s|S seconds
276 * m|M minutes
277 * h|H hours
278 * d|D days
279 * w|W weeks
281 * Examples:
282 * 90m 90 minutes
283 * 1h30m 90 minutes
284 * 2d 2 days
285 * 1w 1 week
287 * Return -1 if time string is invalid.
289 long
290 convtime(const char *s)
292 long total, secs;
293 const char *p;
294 char *endp;
296 errno = 0;
297 total = 0;
298 p = s;
300 if (p == NULL || *p == '\0')
301 return -1;
303 while (*p) {
304 secs = strtol(p, &endp, 10);
305 if (p == endp ||
306 (errno == ERANGE && (secs == LONG_MIN || secs == LONG_MAX)) ||
307 secs < 0)
308 return -1;
310 switch (*endp++) {
311 case '\0':
312 endp--;
313 break;
314 case 's':
315 case 'S':
316 break;
317 case 'm':
318 case 'M':
319 secs *= MINUTES;
320 break;
321 case 'h':
322 case 'H':
323 secs *= HOURS;
324 break;
325 case 'd':
326 case 'D':
327 secs *= DAYS;
328 break;
329 case 'w':
330 case 'W':
331 secs *= WEEKS;
332 break;
333 default:
334 return -1;
336 total += secs;
337 if (total < 0)
338 return -1;
339 p = endp;
342 return total;
346 * Returns a standardized host+port identifier string.
347 * Caller must free returned string.
349 char *
350 put_host_port(const char *host, u_short port)
352 char *hoststr;
354 if (port == 0 || port == SSH_DEFAULT_PORT)
355 return(xstrdup(host));
356 if (asprintf(&hoststr, "[%s]:%d", host, (int)port) < 0)
357 fatal("put_host_port: asprintf: %s", strerror(errno));
358 debug3("put_host_port: %s", hoststr);
359 return hoststr;
363 * Search for next delimiter between hostnames/addresses and ports.
364 * Argument may be modified (for termination).
365 * Returns *cp if parsing succeeds.
366 * *cp is set to the start of the next delimiter, if one was found.
367 * If this is the last field, *cp is set to NULL.
369 char *
370 hpdelim(char **cp)
372 char *s, *old;
374 if (cp == NULL || *cp == NULL)
375 return NULL;
377 old = s = *cp;
378 if (*s == '[') {
379 if ((s = strchr(s, ']')) == NULL)
380 return NULL;
381 else
382 s++;
383 } else if ((s = strpbrk(s, ":/")) == NULL)
384 s = *cp + strlen(*cp); /* skip to end (see first case below) */
386 switch (*s) {
387 case '\0':
388 *cp = NULL; /* no more fields*/
389 break;
391 case ':':
392 case '/':
393 *s = '\0'; /* terminate */
394 *cp = s + 1;
395 break;
397 default:
398 return NULL;
401 return old;
404 char *
405 cleanhostname(char *host)
407 if (*host == '[' && host[strlen(host) - 1] == ']') {
408 host[strlen(host) - 1] = '\0';
409 return (host + 1);
410 } else
411 return host;
414 char *
415 colon(char *cp)
417 int flag = 0;
419 if (*cp == ':') /* Leading colon is part of file name. */
420 return (0);
421 if (*cp == '[')
422 flag = 1;
424 for (; *cp; ++cp) {
425 if (*cp == '@' && *(cp+1) == '[')
426 flag = 1;
427 if (*cp == ']' && *(cp+1) == ':' && flag)
428 return (cp+1);
429 if (*cp == ':' && !flag)
430 return (cp);
431 if (*cp == '/')
432 return (0);
434 return (0);
437 /* function to assist building execv() arguments */
438 void
439 addargs(arglist *args, char *fmt, ...)
441 va_list ap;
442 char *cp;
443 u_int nalloc;
444 int r;
446 va_start(ap, fmt);
447 r = vasprintf(&cp, fmt, ap);
448 va_end(ap);
449 if (r == -1)
450 fatal("addargs: argument too long");
452 nalloc = args->nalloc;
453 if (args->list == NULL) {
454 nalloc = 32;
455 args->num = 0;
456 } else if (args->num+2 >= nalloc)
457 nalloc *= 2;
459 args->list = xrealloc(args->list, nalloc, sizeof(char *));
460 args->nalloc = nalloc;
461 args->list[args->num++] = cp;
462 args->list[args->num] = NULL;
465 void
466 replacearg(arglist *args, u_int which, char *fmt, ...)
468 va_list ap;
469 char *cp;
470 int r;
472 va_start(ap, fmt);
473 r = vasprintf(&cp, fmt, ap);
474 va_end(ap);
475 if (r == -1)
476 fatal("replacearg: argument too long");
478 if (which >= args->num)
479 fatal("replacearg: tried to replace invalid arg %d >= %d",
480 which, args->num);
481 xfree(args->list[which]);
482 args->list[which] = cp;
485 void
486 freeargs(arglist *args)
488 u_int i;
490 if (args->list != NULL) {
491 for (i = 0; i < args->num; i++)
492 xfree(args->list[i]);
493 xfree(args->list);
494 args->nalloc = args->num = 0;
495 args->list = NULL;
500 * Expands tildes in the file name. Returns data allocated by xmalloc.
501 * Warning: this calls getpw*.
503 char *
504 tilde_expand_filename(const char *filename, uid_t uid)
506 const char *path;
507 char user[128], ret[MAXPATHLEN];
508 struct passwd *pw;
509 u_int len, slash;
511 if (*filename != '~')
512 return (xstrdup(filename));
513 filename++;
515 path = strchr(filename, '/');
516 if (path != NULL && path > filename) { /* ~user/path */
517 slash = path - filename;
518 if (slash > sizeof(user) - 1)
519 fatal("tilde_expand_filename: ~username too long");
520 memcpy(user, filename, slash);
521 user[slash] = '\0';
522 if ((pw = getpwnam(user)) == NULL)
523 fatal("tilde_expand_filename: No such user %s", user);
524 } else if ((pw = getpwuid(uid)) == NULL) /* ~/path */
525 fatal("tilde_expand_filename: No such uid %d", uid);
527 if (strlcpy(ret, pw->pw_dir, sizeof(ret)) >= sizeof(ret))
528 fatal("tilde_expand_filename: Path too long");
530 /* Make sure directory has a trailing '/' */
531 len = strlen(pw->pw_dir);
532 if ((len == 0 || pw->pw_dir[len - 1] != '/') &&
533 strlcat(ret, "/", sizeof(ret)) >= sizeof(ret))
534 fatal("tilde_expand_filename: Path too long");
536 /* Skip leading '/' from specified path */
537 if (path != NULL)
538 filename = path + 1;
539 if (strlcat(ret, filename, sizeof(ret)) >= sizeof(ret))
540 fatal("tilde_expand_filename: Path too long");
542 return (xstrdup(ret));
546 * Expand a string with a set of %[char] escapes. A number of escapes may be
547 * specified as (char *escape_chars, char *replacement) pairs. The list must
548 * be terminated by a NULL escape_char. Returns replaced string in memory
549 * allocated by xmalloc.
551 char *
552 percent_expand(const char *string, ...)
554 #define EXPAND_MAX_KEYS 16
555 struct {
556 const char *key;
557 const char *repl;
558 } keys[EXPAND_MAX_KEYS];
559 u_int num_keys, i, j;
560 char buf[4096];
561 va_list ap;
563 /* Gather keys */
564 va_start(ap, string);
565 for (num_keys = 0; num_keys < EXPAND_MAX_KEYS; num_keys++) {
566 keys[num_keys].key = va_arg(ap, char *);
567 if (keys[num_keys].key == NULL)
568 break;
569 keys[num_keys].repl = va_arg(ap, char *);
570 if (keys[num_keys].repl == NULL)
571 fatal("percent_expand: NULL replacement");
573 va_end(ap);
575 if (num_keys >= EXPAND_MAX_KEYS)
576 fatal("percent_expand: too many keys");
578 /* Expand string */
579 *buf = '\0';
580 for (i = 0; *string != '\0'; string++) {
581 if (*string != '%') {
582 append:
583 buf[i++] = *string;
584 if (i >= sizeof(buf))
585 fatal("percent_expand: string too long");
586 buf[i] = '\0';
587 continue;
589 string++;
590 if (*string == '%')
591 goto append;
592 for (j = 0; j < num_keys; j++) {
593 if (strchr(keys[j].key, *string) != NULL) {
594 i = strlcat(buf, keys[j].repl, sizeof(buf));
595 if (i >= sizeof(buf))
596 fatal("percent_expand: string too long");
597 break;
600 if (j >= num_keys)
601 fatal("percent_expand: unknown key %%%c", *string);
603 return (xstrdup(buf));
604 #undef EXPAND_MAX_KEYS
608 * Read an entire line from a public key file into a static buffer, discarding
609 * lines that exceed the buffer size. Returns 0 on success, -1 on failure.
612 read_keyfile_line(FILE *f, const char *filename, char *buf, size_t bufsz,
613 u_long *lineno)
615 while (fgets(buf, bufsz, f) != NULL) {
616 (*lineno)++;
617 if (buf[strlen(buf) - 1] == '\n' || feof(f)) {
618 return 0;
619 } else {
620 debug("%s: %s line %lu exceeds size limit", __func__,
621 filename, *lineno);
622 /* discard remainder of line */
623 while (fgetc(f) != '\n' && !feof(f))
624 ; /* nothing */
627 return -1;
631 tun_open(int tun, int mode)
633 #if defined(CUSTOM_SYS_TUN_OPEN)
634 return (sys_tun_open(tun, mode));
635 #elif defined(SSH_TUN_OPENBSD)
636 struct ifreq ifr;
637 char name[100];
638 int fd = -1, sock;
640 /* Open the tunnel device */
641 if (tun <= SSH_TUNID_MAX) {
642 snprintf(name, sizeof(name), "/dev/tun%d", tun);
643 fd = open(name, O_RDWR);
644 } else if (tun == SSH_TUNID_ANY) {
645 for (tun = 100; tun >= 0; tun--) {
646 snprintf(name, sizeof(name), "/dev/tun%d", tun);
647 if ((fd = open(name, O_RDWR)) >= 0)
648 break;
650 } else {
651 debug("%s: invalid tunnel %u", __func__, tun);
652 return (-1);
655 if (fd < 0) {
656 debug("%s: %s open failed: %s", __func__, name, strerror(errno));
657 return (-1);
660 debug("%s: %s mode %d fd %d", __func__, name, mode, fd);
662 /* Set the tunnel device operation mode */
663 snprintf(ifr.ifr_name, sizeof(ifr.ifr_name), "tun%d", tun);
664 if ((sock = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
665 goto failed;
667 if (ioctl(sock, SIOCGIFFLAGS, &ifr) == -1)
668 goto failed;
670 /* Set interface mode */
671 ifr.ifr_flags &= ~IFF_UP;
672 if (mode == SSH_TUNMODE_ETHERNET)
673 ifr.ifr_flags |= IFF_LINK0;
674 else
675 ifr.ifr_flags &= ~IFF_LINK0;
676 if (ioctl(sock, SIOCSIFFLAGS, &ifr) == -1)
677 goto failed;
679 /* Bring interface up */
680 ifr.ifr_flags |= IFF_UP;
681 if (ioctl(sock, SIOCSIFFLAGS, &ifr) == -1)
682 goto failed;
684 close(sock);
685 return (fd);
687 failed:
688 if (fd >= 0)
689 close(fd);
690 if (sock >= 0)
691 close(sock);
692 debug("%s: failed to set %s mode %d: %s", __func__, name,
693 mode, strerror(errno));
694 return (-1);
695 #else
696 error("Tunnel interfaces are not supported on this platform");
697 return (-1);
698 #endif
701 void
702 sanitise_stdfd(void)
704 int nullfd, dupfd;
706 if ((nullfd = dupfd = open(_PATH_DEVNULL, O_RDWR)) == -1) {
707 fprintf(stderr, "Couldn't open /dev/null: %s", strerror(errno));
708 exit(1);
710 while (++dupfd <= 2) {
711 /* Only clobber closed fds */
712 if (fcntl(dupfd, F_GETFL, 0) >= 0)
713 continue;
714 if (dup2(nullfd, dupfd) == -1) {
715 fprintf(stderr, "dup2: %s", strerror(errno));
716 exit(1);
719 if (nullfd > 2)
720 close(nullfd);
723 char *
724 tohex(const void *vp, size_t l)
726 const u_char *p = (const u_char *)vp;
727 char b[3], *r;
728 size_t i, hl;
730 if (l > 65536)
731 return xstrdup("tohex: length > 65536");
733 hl = l * 2 + 1;
734 r = xcalloc(1, hl);
735 for (i = 0; i < l; i++) {
736 snprintf(b, sizeof(b), "%02x", p[i]);
737 strlcat(r, b, hl);
739 return (r);
742 u_int64_t
743 get_u64(const void *vp)
745 const u_char *p = (const u_char *)vp;
746 u_int64_t v;
748 v = (u_int64_t)p[0] << 56;
749 v |= (u_int64_t)p[1] << 48;
750 v |= (u_int64_t)p[2] << 40;
751 v |= (u_int64_t)p[3] << 32;
752 v |= (u_int64_t)p[4] << 24;
753 v |= (u_int64_t)p[5] << 16;
754 v |= (u_int64_t)p[6] << 8;
755 v |= (u_int64_t)p[7];
757 return (v);
760 u_int32_t
761 get_u32(const void *vp)
763 const u_char *p = (const u_char *)vp;
764 u_int32_t v;
766 v = (u_int32_t)p[0] << 24;
767 v |= (u_int32_t)p[1] << 16;
768 v |= (u_int32_t)p[2] << 8;
769 v |= (u_int32_t)p[3];
771 return (v);
774 u_int16_t
775 get_u16(const void *vp)
777 const u_char *p = (const u_char *)vp;
778 u_int16_t v;
780 v = (u_int16_t)p[0] << 8;
781 v |= (u_int16_t)p[1];
783 return (v);
786 void
787 put_u64(void *vp, u_int64_t v)
789 u_char *p = (u_char *)vp;
791 p[0] = (u_char)(v >> 56) & 0xff;
792 p[1] = (u_char)(v >> 48) & 0xff;
793 p[2] = (u_char)(v >> 40) & 0xff;
794 p[3] = (u_char)(v >> 32) & 0xff;
795 p[4] = (u_char)(v >> 24) & 0xff;
796 p[5] = (u_char)(v >> 16) & 0xff;
797 p[6] = (u_char)(v >> 8) & 0xff;
798 p[7] = (u_char)v & 0xff;
801 void
802 put_u32(void *vp, u_int32_t v)
804 u_char *p = (u_char *)vp;
806 p[0] = (u_char)(v >> 24) & 0xff;
807 p[1] = (u_char)(v >> 16) & 0xff;
808 p[2] = (u_char)(v >> 8) & 0xff;
809 p[3] = (u_char)v & 0xff;
813 void
814 put_u16(void *vp, u_int16_t v)
816 u_char *p = (u_char *)vp;
818 p[0] = (u_char)(v >> 8) & 0xff;
819 p[1] = (u_char)v & 0xff;