- djm@cvs.openbsd.org 2008/06/12 05:15:41
[openssh-git.git] / misc.c
blobb4fe489af52febae5a89e874434fb176e348bb53
1 /* $OpenBSD: misc.c,v 1.67 2008/01/01 08:47:04 dtucker 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/types.h>
30 #include <sys/ioctl.h>
31 #include <sys/socket.h>
32 #include <sys/param.h>
34 #include <stdarg.h>
35 #include <stdio.h>
36 #include <stdlib.h>
37 #include <string.h>
38 #include <unistd.h>
40 #include <netinet/in.h>
41 #include <netinet/tcp.h>
43 #include <errno.h>
44 #include <fcntl.h>
45 #include <netdb.h>
46 #ifdef HAVE_PATHS_H
47 # include <paths.h>
48 #include <pwd.h>
49 #endif
50 #ifdef SSH_TUN_OPENBSD
51 #include <net/if.h>
52 #endif
54 #include "xmalloc.h"
55 #include "misc.h"
56 #include "log.h"
57 #include "ssh.h"
59 /* remove newline at end of string */
60 char *
61 chop(char *s)
63 char *t = s;
64 while (*t) {
65 if (*t == '\n' || *t == '\r') {
66 *t = '\0';
67 return s;
69 t++;
71 return s;
75 /* set/unset filedescriptor to non-blocking */
76 int
77 set_nonblock(int fd)
79 int val;
81 val = fcntl(fd, F_GETFL, 0);
82 if (val < 0) {
83 error("fcntl(%d, F_GETFL, 0): %s", fd, strerror(errno));
84 return (-1);
86 if (val & O_NONBLOCK) {
87 debug3("fd %d is O_NONBLOCK", fd);
88 return (0);
90 debug2("fd %d setting O_NONBLOCK", fd);
91 val |= O_NONBLOCK;
92 if (fcntl(fd, F_SETFL, val) == -1) {
93 debug("fcntl(%d, F_SETFL, O_NONBLOCK): %s", fd,
94 strerror(errno));
95 return (-1);
97 return (0);
101 unset_nonblock(int fd)
103 int val;
105 val = fcntl(fd, F_GETFL, 0);
106 if (val < 0) {
107 error("fcntl(%d, F_GETFL, 0): %s", fd, strerror(errno));
108 return (-1);
110 if (!(val & O_NONBLOCK)) {
111 debug3("fd %d is not O_NONBLOCK", fd);
112 return (0);
114 debug("fd %d clearing O_NONBLOCK", fd);
115 val &= ~O_NONBLOCK;
116 if (fcntl(fd, F_SETFL, val) == -1) {
117 debug("fcntl(%d, F_SETFL, ~O_NONBLOCK): %s",
118 fd, strerror(errno));
119 return (-1);
121 return (0);
124 const char *
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 */
133 void
134 set_nodelay(int fd)
136 int opt;
137 socklen_t optlen;
139 optlen = sizeof opt;
140 if (getsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &opt, &optlen) == -1) {
141 debug("getsockopt TCP_NODELAY: %.100s", strerror(errno));
142 return;
144 if (opt == 1) {
145 debug2("fd %d is TCP_NODELAY", fd);
146 return;
148 opt = 1;
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"
156 #define QUOTE "\""
158 /* return next token in configuration line */
159 char *
160 strdelim(char **s)
162 char *old;
163 int wspace = 0;
165 if (*s == NULL)
166 return NULL;
168 old = *s;
170 *s = strpbrk(*s, WHITESPACE QUOTE "=");
171 if (*s == NULL)
172 return (old);
174 if (*s[0] == '\"') {
175 memmove(*s, *s + 1, strlen(*s)); /* move nul too */
176 /* Find matching quote */
177 if ((*s = strpbrk(*s, QUOTE)) == NULL) {
178 return (NULL); /* no matching quote */
179 } else {
180 *s[0] = '\0';
181 return (old);
185 /* Allow only one '=' to be skipped */
186 if (*s[0] == '=')
187 wspace = 1;
188 *s[0] = '\0';
190 /* Skip any extra whitespace after first token */
191 *s += strspn(*s + 1, WHITESPACE) + 1;
192 if (*s[0] == '=' && !wspace)
193 *s += strspn(*s + 1, WHITESPACE) + 1;
195 return (old);
198 struct passwd *
199 pwcopy(struct passwd *pw)
201 struct passwd *copy = xcalloc(1, sizeof(*copy));
203 copy->pw_name = xstrdup(pw->pw_name);
204 copy->pw_passwd = xstrdup(pw->pw_passwd);
205 copy->pw_gecos = xstrdup(pw->pw_gecos);
206 copy->pw_uid = pw->pw_uid;
207 copy->pw_gid = pw->pw_gid;
208 #ifdef HAVE_PW_EXPIRE_IN_PASSWD
209 copy->pw_expire = pw->pw_expire;
210 #endif
211 #ifdef HAVE_PW_CHANGE_IN_PASSWD
212 copy->pw_change = pw->pw_change;
213 #endif
214 #ifdef HAVE_PW_CLASS_IN_PASSWD
215 copy->pw_class = xstrdup(pw->pw_class);
216 #endif
217 copy->pw_dir = xstrdup(pw->pw_dir);
218 copy->pw_shell = xstrdup(pw->pw_shell);
219 return copy;
223 * Convert ASCII string to TCP/IP port number.
224 * Port must be >0 and <=65535.
225 * Return 0 if invalid.
228 a2port(const char *s)
230 long port;
231 char *endp;
233 errno = 0;
234 port = strtol(s, &endp, 0);
235 if (s == endp || *endp != '\0' ||
236 (errno == ERANGE && (port == LONG_MIN || port == LONG_MAX)) ||
237 port <= 0 || port > 65535)
238 return 0;
240 return port;
244 a2tun(const char *s, int *remote)
246 const char *errstr = NULL;
247 char *sp, *ep;
248 int tun;
250 if (remote != NULL) {
251 *remote = SSH_TUNID_ANY;
252 sp = xstrdup(s);
253 if ((ep = strchr(sp, ':')) == NULL) {
254 xfree(sp);
255 return (a2tun(s, NULL));
257 ep[0] = '\0'; ep++;
258 *remote = a2tun(ep, NULL);
259 tun = a2tun(sp, NULL);
260 xfree(sp);
261 return (*remote == SSH_TUNID_ERR ? *remote : tun);
264 if (strcasecmp(s, "any") == 0)
265 return (SSH_TUNID_ANY);
267 tun = strtonum(s, 0, SSH_TUNID_MAX, &errstr);
268 if (errstr != NULL)
269 return (SSH_TUNID_ERR);
271 return (tun);
274 #define SECONDS 1
275 #define MINUTES (SECONDS * 60)
276 #define HOURS (MINUTES * 60)
277 #define DAYS (HOURS * 24)
278 #define WEEKS (DAYS * 7)
281 * Convert a time string into seconds; format is
282 * a sequence of:
283 * time[qualifier]
285 * Valid time qualifiers are:
286 * <none> seconds
287 * s|S seconds
288 * m|M minutes
289 * h|H hours
290 * d|D days
291 * w|W weeks
293 * Examples:
294 * 90m 90 minutes
295 * 1h30m 90 minutes
296 * 2d 2 days
297 * 1w 1 week
299 * Return -1 if time string is invalid.
301 long
302 convtime(const char *s)
304 long total, secs;
305 const char *p;
306 char *endp;
308 errno = 0;
309 total = 0;
310 p = s;
312 if (p == NULL || *p == '\0')
313 return -1;
315 while (*p) {
316 secs = strtol(p, &endp, 10);
317 if (p == endp ||
318 (errno == ERANGE && (secs == LONG_MIN || secs == LONG_MAX)) ||
319 secs < 0)
320 return -1;
322 switch (*endp++) {
323 case '\0':
324 endp--;
325 break;
326 case 's':
327 case 'S':
328 break;
329 case 'm':
330 case 'M':
331 secs *= MINUTES;
332 break;
333 case 'h':
334 case 'H':
335 secs *= HOURS;
336 break;
337 case 'd':
338 case 'D':
339 secs *= DAYS;
340 break;
341 case 'w':
342 case 'W':
343 secs *= WEEKS;
344 break;
345 default:
346 return -1;
348 total += secs;
349 if (total < 0)
350 return -1;
351 p = endp;
354 return total;
358 * Returns a standardized host+port identifier string.
359 * Caller must free returned string.
361 char *
362 put_host_port(const char *host, u_short port)
364 char *hoststr;
366 if (port == 0 || port == SSH_DEFAULT_PORT)
367 return(xstrdup(host));
368 if (asprintf(&hoststr, "[%s]:%d", host, (int)port) < 0)
369 fatal("put_host_port: asprintf: %s", strerror(errno));
370 debug3("put_host_port: %s", hoststr);
371 return hoststr;
375 * Search for next delimiter between hostnames/addresses and ports.
376 * Argument may be modified (for termination).
377 * Returns *cp if parsing succeeds.
378 * *cp is set to the start of the next delimiter, if one was found.
379 * If this is the last field, *cp is set to NULL.
381 char *
382 hpdelim(char **cp)
384 char *s, *old;
386 if (cp == NULL || *cp == NULL)
387 return NULL;
389 old = s = *cp;
390 if (*s == '[') {
391 if ((s = strchr(s, ']')) == NULL)
392 return NULL;
393 else
394 s++;
395 } else if ((s = strpbrk(s, ":/")) == NULL)
396 s = *cp + strlen(*cp); /* skip to end (see first case below) */
398 switch (*s) {
399 case '\0':
400 *cp = NULL; /* no more fields*/
401 break;
403 case ':':
404 case '/':
405 *s = '\0'; /* terminate */
406 *cp = s + 1;
407 break;
409 default:
410 return NULL;
413 return old;
416 char *
417 cleanhostname(char *host)
419 if (*host == '[' && host[strlen(host) - 1] == ']') {
420 host[strlen(host) - 1] = '\0';
421 return (host + 1);
422 } else
423 return host;
426 char *
427 colon(char *cp)
429 int flag = 0;
431 if (*cp == ':') /* Leading colon is part of file name. */
432 return (0);
433 if (*cp == '[')
434 flag = 1;
436 for (; *cp; ++cp) {
437 if (*cp == '@' && *(cp+1) == '[')
438 flag = 1;
439 if (*cp == ']' && *(cp+1) == ':' && flag)
440 return (cp+1);
441 if (*cp == ':' && !flag)
442 return (cp);
443 if (*cp == '/')
444 return (0);
446 return (0);
449 /* function to assist building execv() arguments */
450 void
451 addargs(arglist *args, char *fmt, ...)
453 va_list ap;
454 char *cp;
455 u_int nalloc;
456 int r;
458 va_start(ap, fmt);
459 r = vasprintf(&cp, fmt, ap);
460 va_end(ap);
461 if (r == -1)
462 fatal("addargs: argument too long");
464 nalloc = args->nalloc;
465 if (args->list == NULL) {
466 nalloc = 32;
467 args->num = 0;
468 } else if (args->num+2 >= nalloc)
469 nalloc *= 2;
471 args->list = xrealloc(args->list, nalloc, sizeof(char *));
472 args->nalloc = nalloc;
473 args->list[args->num++] = cp;
474 args->list[args->num] = NULL;
477 void
478 replacearg(arglist *args, u_int which, char *fmt, ...)
480 va_list ap;
481 char *cp;
482 int r;
484 va_start(ap, fmt);
485 r = vasprintf(&cp, fmt, ap);
486 va_end(ap);
487 if (r == -1)
488 fatal("replacearg: argument too long");
490 if (which >= args->num)
491 fatal("replacearg: tried to replace invalid arg %d >= %d",
492 which, args->num);
493 xfree(args->list[which]);
494 args->list[which] = cp;
497 void
498 freeargs(arglist *args)
500 u_int i;
502 if (args->list != NULL) {
503 for (i = 0; i < args->num; i++)
504 xfree(args->list[i]);
505 xfree(args->list);
506 args->nalloc = args->num = 0;
507 args->list = NULL;
512 * Expands tildes in the file name. Returns data allocated by xmalloc.
513 * Warning: this calls getpw*.
515 char *
516 tilde_expand_filename(const char *filename, uid_t uid)
518 const char *path;
519 char user[128], ret[MAXPATHLEN];
520 struct passwd *pw;
521 u_int len, slash;
523 if (*filename != '~')
524 return (xstrdup(filename));
525 filename++;
527 path = strchr(filename, '/');
528 if (path != NULL && path > filename) { /* ~user/path */
529 slash = path - filename;
530 if (slash > sizeof(user) - 1)
531 fatal("tilde_expand_filename: ~username too long");
532 memcpy(user, filename, slash);
533 user[slash] = '\0';
534 if ((pw = getpwnam(user)) == NULL)
535 fatal("tilde_expand_filename: No such user %s", user);
536 } else if ((pw = getpwuid(uid)) == NULL) /* ~/path */
537 fatal("tilde_expand_filename: No such uid %d", uid);
539 if (strlcpy(ret, pw->pw_dir, sizeof(ret)) >= sizeof(ret))
540 fatal("tilde_expand_filename: Path too long");
542 /* Make sure directory has a trailing '/' */
543 len = strlen(pw->pw_dir);
544 if ((len == 0 || pw->pw_dir[len - 1] != '/') &&
545 strlcat(ret, "/", sizeof(ret)) >= sizeof(ret))
546 fatal("tilde_expand_filename: Path too long");
548 /* Skip leading '/' from specified path */
549 if (path != NULL)
550 filename = path + 1;
551 if (strlcat(ret, filename, sizeof(ret)) >= sizeof(ret))
552 fatal("tilde_expand_filename: Path too long");
554 return (xstrdup(ret));
558 * Expand a string with a set of %[char] escapes. A number of escapes may be
559 * specified as (char *escape_chars, char *replacement) pairs. The list must
560 * be terminated by a NULL escape_char. Returns replaced string in memory
561 * allocated by xmalloc.
563 char *
564 percent_expand(const char *string, ...)
566 #define EXPAND_MAX_KEYS 16
567 struct {
568 const char *key;
569 const char *repl;
570 } keys[EXPAND_MAX_KEYS];
571 u_int num_keys, i, j;
572 char buf[4096];
573 va_list ap;
575 /* Gather keys */
576 va_start(ap, string);
577 for (num_keys = 0; num_keys < EXPAND_MAX_KEYS; num_keys++) {
578 keys[num_keys].key = va_arg(ap, char *);
579 if (keys[num_keys].key == NULL)
580 break;
581 keys[num_keys].repl = va_arg(ap, char *);
582 if (keys[num_keys].repl == NULL)
583 fatal("percent_expand: NULL replacement");
585 va_end(ap);
587 if (num_keys >= EXPAND_MAX_KEYS)
588 fatal("percent_expand: too many keys");
590 /* Expand string */
591 *buf = '\0';
592 for (i = 0; *string != '\0'; string++) {
593 if (*string != '%') {
594 append:
595 buf[i++] = *string;
596 if (i >= sizeof(buf))
597 fatal("percent_expand: string too long");
598 buf[i] = '\0';
599 continue;
601 string++;
602 if (*string == '%')
603 goto append;
604 for (j = 0; j < num_keys; j++) {
605 if (strchr(keys[j].key, *string) != NULL) {
606 i = strlcat(buf, keys[j].repl, sizeof(buf));
607 if (i >= sizeof(buf))
608 fatal("percent_expand: string too long");
609 break;
612 if (j >= num_keys)
613 fatal("percent_expand: unknown key %%%c", *string);
615 return (xstrdup(buf));
616 #undef EXPAND_MAX_KEYS
620 * Read an entire line from a public key file into a static buffer, discarding
621 * lines that exceed the buffer size. Returns 0 on success, -1 on failure.
624 read_keyfile_line(FILE *f, const char *filename, char *buf, size_t bufsz,
625 u_long *lineno)
627 while (fgets(buf, bufsz, f) != NULL) {
628 if (buf[0] == '\0')
629 continue;
630 (*lineno)++;
631 if (buf[strlen(buf) - 1] == '\n' || feof(f)) {
632 return 0;
633 } else {
634 debug("%s: %s line %lu exceeds size limit", __func__,
635 filename, *lineno);
636 /* discard remainder of line */
637 while (fgetc(f) != '\n' && !feof(f))
638 ; /* nothing */
641 return -1;
645 tun_open(int tun, int mode)
647 #if defined(CUSTOM_SYS_TUN_OPEN)
648 return (sys_tun_open(tun, mode));
649 #elif defined(SSH_TUN_OPENBSD)
650 struct ifreq ifr;
651 char name[100];
652 int fd = -1, sock;
654 /* Open the tunnel device */
655 if (tun <= SSH_TUNID_MAX) {
656 snprintf(name, sizeof(name), "/dev/tun%d", tun);
657 fd = open(name, O_RDWR);
658 } else if (tun == SSH_TUNID_ANY) {
659 for (tun = 100; tun >= 0; tun--) {
660 snprintf(name, sizeof(name), "/dev/tun%d", tun);
661 if ((fd = open(name, O_RDWR)) >= 0)
662 break;
664 } else {
665 debug("%s: invalid tunnel %u", __func__, tun);
666 return (-1);
669 if (fd < 0) {
670 debug("%s: %s open failed: %s", __func__, name, strerror(errno));
671 return (-1);
674 debug("%s: %s mode %d fd %d", __func__, name, mode, fd);
676 /* Set the tunnel device operation mode */
677 snprintf(ifr.ifr_name, sizeof(ifr.ifr_name), "tun%d", tun);
678 if ((sock = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
679 goto failed;
681 if (ioctl(sock, SIOCGIFFLAGS, &ifr) == -1)
682 goto failed;
684 /* Set interface mode */
685 ifr.ifr_flags &= ~IFF_UP;
686 if (mode == SSH_TUNMODE_ETHERNET)
687 ifr.ifr_flags |= IFF_LINK0;
688 else
689 ifr.ifr_flags &= ~IFF_LINK0;
690 if (ioctl(sock, SIOCSIFFLAGS, &ifr) == -1)
691 goto failed;
693 /* Bring interface up */
694 ifr.ifr_flags |= IFF_UP;
695 if (ioctl(sock, SIOCSIFFLAGS, &ifr) == -1)
696 goto failed;
698 close(sock);
699 return (fd);
701 failed:
702 if (fd >= 0)
703 close(fd);
704 if (sock >= 0)
705 close(sock);
706 debug("%s: failed to set %s mode %d: %s", __func__, name,
707 mode, strerror(errno));
708 return (-1);
709 #else
710 error("Tunnel interfaces are not supported on this platform");
711 return (-1);
712 #endif
715 void
716 sanitise_stdfd(void)
718 int nullfd, dupfd;
720 if ((nullfd = dupfd = open(_PATH_DEVNULL, O_RDWR)) == -1) {
721 fprintf(stderr, "Couldn't open /dev/null: %s", strerror(errno));
722 exit(1);
724 while (++dupfd <= 2) {
725 /* Only clobber closed fds */
726 if (fcntl(dupfd, F_GETFL, 0) >= 0)
727 continue;
728 if (dup2(nullfd, dupfd) == -1) {
729 fprintf(stderr, "dup2: %s", strerror(errno));
730 exit(1);
733 if (nullfd > 2)
734 close(nullfd);
737 char *
738 tohex(const void *vp, size_t l)
740 const u_char *p = (const u_char *)vp;
741 char b[3], *r;
742 size_t i, hl;
744 if (l > 65536)
745 return xstrdup("tohex: length > 65536");
747 hl = l * 2 + 1;
748 r = xcalloc(1, hl);
749 for (i = 0; i < l; i++) {
750 snprintf(b, sizeof(b), "%02x", p[i]);
751 strlcat(r, b, hl);
753 return (r);
756 u_int64_t
757 get_u64(const void *vp)
759 const u_char *p = (const u_char *)vp;
760 u_int64_t v;
762 v = (u_int64_t)p[0] << 56;
763 v |= (u_int64_t)p[1] << 48;
764 v |= (u_int64_t)p[2] << 40;
765 v |= (u_int64_t)p[3] << 32;
766 v |= (u_int64_t)p[4] << 24;
767 v |= (u_int64_t)p[5] << 16;
768 v |= (u_int64_t)p[6] << 8;
769 v |= (u_int64_t)p[7];
771 return (v);
774 u_int32_t
775 get_u32(const void *vp)
777 const u_char *p = (const u_char *)vp;
778 u_int32_t v;
780 v = (u_int32_t)p[0] << 24;
781 v |= (u_int32_t)p[1] << 16;
782 v |= (u_int32_t)p[2] << 8;
783 v |= (u_int32_t)p[3];
785 return (v);
788 u_int16_t
789 get_u16(const void *vp)
791 const u_char *p = (const u_char *)vp;
792 u_int16_t v;
794 v = (u_int16_t)p[0] << 8;
795 v |= (u_int16_t)p[1];
797 return (v);
800 void
801 put_u64(void *vp, u_int64_t v)
803 u_char *p = (u_char *)vp;
805 p[0] = (u_char)(v >> 56) & 0xff;
806 p[1] = (u_char)(v >> 48) & 0xff;
807 p[2] = (u_char)(v >> 40) & 0xff;
808 p[3] = (u_char)(v >> 32) & 0xff;
809 p[4] = (u_char)(v >> 24) & 0xff;
810 p[5] = (u_char)(v >> 16) & 0xff;
811 p[6] = (u_char)(v >> 8) & 0xff;
812 p[7] = (u_char)v & 0xff;
815 void
816 put_u32(void *vp, u_int32_t v)
818 u_char *p = (u_char *)vp;
820 p[0] = (u_char)(v >> 24) & 0xff;
821 p[1] = (u_char)(v >> 16) & 0xff;
822 p[2] = (u_char)(v >> 8) & 0xff;
823 p[3] = (u_char)v & 0xff;
827 void
828 put_u16(void *vp, u_int16_t v)
830 u_char *p = (u_char *)vp;
832 p[0] = (u_char)(v >> 8) & 0xff;
833 p[1] = (u_char)v & 0xff;