1 /* $OpenBSD: misc.c,v 1.82 2010/09/24 13:33:00 matthew 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 /* return next token in configuration line */
170 *s
= strpbrk(*s
, WHITESPACE QUOTE
"=");
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 */
181 *s
+= strspn(*s
+ 1, WHITESPACE
) + 1;
186 /* Allow only one '=' to be skipped */
191 /* Skip any extra whitespace after first token */
192 *s
+= strspn(*s
+ 1, WHITESPACE
) + 1;
193 if (*s
[0] == '=' && !wspace
)
194 *s
+= strspn(*s
+ 1, WHITESPACE
) + 1;
200 pwcopy(struct passwd
*pw
)
202 struct passwd
*copy
= xcalloc(1, sizeof(*copy
));
204 copy
->pw_name
= xstrdup(pw
->pw_name
);
205 copy
->pw_passwd
= xstrdup(pw
->pw_passwd
);
206 copy
->pw_gecos
= xstrdup(pw
->pw_gecos
);
207 copy
->pw_uid
= pw
->pw_uid
;
208 copy
->pw_gid
= pw
->pw_gid
;
209 #ifdef HAVE_PW_EXPIRE_IN_PASSWD
210 copy
->pw_expire
= pw
->pw_expire
;
212 #ifdef HAVE_PW_CHANGE_IN_PASSWD
213 copy
->pw_change
= pw
->pw_change
;
215 #ifdef HAVE_PW_CLASS_IN_PASSWD
216 copy
->pw_class
= xstrdup(pw
->pw_class
);
218 copy
->pw_dir
= xstrdup(pw
->pw_dir
);
219 copy
->pw_shell
= xstrdup(pw
->pw_shell
);
224 * Convert ASCII string to TCP/IP port number.
225 * Port must be >=0 and <=65535.
226 * Return -1 if invalid.
229 a2port(const char *s
)
234 port
= strtonum(s
, 0, 65535, &errstr
);
241 a2tun(const char *s
, int *remote
)
243 const char *errstr
= NULL
;
247 if (remote
!= NULL
) {
248 *remote
= SSH_TUNID_ANY
;
250 if ((ep
= strchr(sp
, ':')) == NULL
) {
252 return (a2tun(s
, NULL
));
255 *remote
= a2tun(ep
, NULL
);
256 tun
= a2tun(sp
, NULL
);
258 return (*remote
== SSH_TUNID_ERR
? *remote
: tun
);
261 if (strcasecmp(s
, "any") == 0)
262 return (SSH_TUNID_ANY
);
264 tun
= strtonum(s
, 0, SSH_TUNID_MAX
, &errstr
);
266 return (SSH_TUNID_ERR
);
272 #define MINUTES (SECONDS * 60)
273 #define HOURS (MINUTES * 60)
274 #define DAYS (HOURS * 24)
275 #define WEEKS (DAYS * 7)
278 * Convert a time string into seconds; format is
282 * Valid time qualifiers are:
296 * Return -1 if time string is invalid.
299 convtime(const char *s
)
309 if (p
== NULL
|| *p
== '\0')
313 secs
= strtol(p
, &endp
, 10);
315 (errno
== ERANGE
&& (secs
== LONG_MIN
|| secs
== LONG_MAX
)) ||
355 * Returns a standardized host+port identifier string.
356 * Caller must free returned string.
359 put_host_port(const char *host
, u_short port
)
363 if (port
== 0 || port
== SSH_DEFAULT_PORT
)
364 return(xstrdup(host
));
365 if (asprintf(&hoststr
, "[%s]:%d", host
, (int)port
) < 0)
366 fatal("put_host_port: asprintf: %s", strerror(errno
));
367 debug3("put_host_port: %s", hoststr
);
372 * Search for next delimiter between hostnames/addresses and ports.
373 * Argument may be modified (for termination).
374 * Returns *cp if parsing succeeds.
375 * *cp is set to the start of the next delimiter, if one was found.
376 * If this is the last field, *cp is set to NULL.
383 if (cp
== NULL
|| *cp
== NULL
)
388 if ((s
= strchr(s
, ']')) == NULL
)
392 } else if ((s
= strpbrk(s
, ":/")) == NULL
)
393 s
= *cp
+ strlen(*cp
); /* skip to end (see first case below) */
397 *cp
= NULL
; /* no more fields*/
402 *s
= '\0'; /* terminate */
414 cleanhostname(char *host
)
416 if (*host
== '[' && host
[strlen(host
) - 1] == ']') {
417 host
[strlen(host
) - 1] = '\0';
428 if (*cp
== ':') /* Leading colon is part of file name. */
434 if (*cp
== '@' && *(cp
+1) == '[')
436 if (*cp
== ']' && *(cp
+1) == ':' && flag
)
438 if (*cp
== ':' && !flag
)
446 /* function to assist building execv() arguments */
448 addargs(arglist
*args
, char *fmt
, ...)
456 r
= vasprintf(&cp
, fmt
, ap
);
459 fatal("addargs: argument too long");
461 nalloc
= args
->nalloc
;
462 if (args
->list
== NULL
) {
465 } else if (args
->num
+2 >= nalloc
)
468 args
->list
= xrealloc(args
->list
, nalloc
, sizeof(char *));
469 args
->nalloc
= nalloc
;
470 args
->list
[args
->num
++] = cp
;
471 args
->list
[args
->num
] = NULL
;
475 replacearg(arglist
*args
, u_int which
, char *fmt
, ...)
482 r
= vasprintf(&cp
, fmt
, ap
);
485 fatal("replacearg: argument too long");
487 if (which
>= args
->num
)
488 fatal("replacearg: tried to replace invalid arg %d >= %d",
490 xfree(args
->list
[which
]);
491 args
->list
[which
] = cp
;
495 freeargs(arglist
*args
)
499 if (args
->list
!= NULL
) {
500 for (i
= 0; i
< args
->num
; i
++)
501 xfree(args
->list
[i
]);
503 args
->nalloc
= args
->num
= 0;
509 * Expands tildes in the file name. Returns data allocated by xmalloc.
510 * Warning: this calls getpw*.
513 tilde_expand_filename(const char *filename
, uid_t uid
)
516 char user
[128], ret
[MAXPATHLEN
];
520 if (*filename
!= '~')
521 return (xstrdup(filename
));
524 path
= strchr(filename
, '/');
525 if (path
!= NULL
&& path
> filename
) { /* ~user/path */
526 slash
= path
- filename
;
527 if (slash
> sizeof(user
) - 1)
528 fatal("tilde_expand_filename: ~username too long");
529 memcpy(user
, filename
, slash
);
531 if ((pw
= getpwnam(user
)) == NULL
)
532 fatal("tilde_expand_filename: No such user %s", user
);
533 } else if ((pw
= getpwuid(uid
)) == NULL
) /* ~/path */
534 fatal("tilde_expand_filename: No such uid %ld", (long)uid
);
536 if (strlcpy(ret
, pw
->pw_dir
, sizeof(ret
)) >= sizeof(ret
))
537 fatal("tilde_expand_filename: Path too long");
539 /* Make sure directory has a trailing '/' */
540 len
= strlen(pw
->pw_dir
);
541 if ((len
== 0 || pw
->pw_dir
[len
- 1] != '/') &&
542 strlcat(ret
, "/", sizeof(ret
)) >= sizeof(ret
))
543 fatal("tilde_expand_filename: Path too long");
545 /* Skip leading '/' from specified path */
548 if (strlcat(ret
, filename
, sizeof(ret
)) >= sizeof(ret
))
549 fatal("tilde_expand_filename: Path too long");
551 return (xstrdup(ret
));
555 * Expand a string with a set of %[char] escapes. A number of escapes may be
556 * specified as (char *escape_chars, char *replacement) pairs. The list must
557 * be terminated by a NULL escape_char. Returns replaced string in memory
558 * allocated by xmalloc.
561 percent_expand(const char *string
, ...)
563 #define EXPAND_MAX_KEYS 16
564 u_int num_keys
, i
, j
;
568 } keys
[EXPAND_MAX_KEYS
];
573 va_start(ap
, string
);
574 for (num_keys
= 0; num_keys
< EXPAND_MAX_KEYS
; num_keys
++) {
575 keys
[num_keys
].key
= va_arg(ap
, char *);
576 if (keys
[num_keys
].key
== NULL
)
578 keys
[num_keys
].repl
= va_arg(ap
, char *);
579 if (keys
[num_keys
].repl
== NULL
)
580 fatal("%s: NULL replacement", __func__
);
582 if (num_keys
== EXPAND_MAX_KEYS
&& va_arg(ap
, char *) != NULL
)
583 fatal("%s: too many keys", __func__
);
588 for (i
= 0; *string
!= '\0'; string
++) {
589 if (*string
!= '%') {
592 if (i
>= sizeof(buf
))
593 fatal("%s: string too long", __func__
);
601 for (j
= 0; j
< num_keys
; j
++) {
602 if (strchr(keys
[j
].key
, *string
) != NULL
) {
603 i
= strlcat(buf
, keys
[j
].repl
, sizeof(buf
));
604 if (i
>= sizeof(buf
))
605 fatal("%s: string too long", __func__
);
610 fatal("%s: unknown key %%%c", __func__
, *string
);
612 return (xstrdup(buf
));
613 #undef EXPAND_MAX_KEYS
617 * Read an entire line from a public key file into a static buffer, discarding
618 * lines that exceed the buffer size. Returns 0 on success, -1 on failure.
621 read_keyfile_line(FILE *f
, const char *filename
, char *buf
, size_t bufsz
,
624 while (fgets(buf
, bufsz
, f
) != NULL
) {
628 if (buf
[strlen(buf
) - 1] == '\n' || feof(f
)) {
631 debug("%s: %s line %lu exceeds size limit", __func__
,
633 /* discard remainder of line */
634 while (fgetc(f
) != '\n' && !feof(f
))
642 tun_open(int tun
, int mode
)
644 #if defined(CUSTOM_SYS_TUN_OPEN)
645 return (sys_tun_open(tun
, mode
));
646 #elif defined(SSH_TUN_OPENBSD)
651 /* Open the tunnel device */
652 if (tun
<= SSH_TUNID_MAX
) {
653 snprintf(name
, sizeof(name
), "/dev/tun%d", tun
);
654 fd
= open(name
, O_RDWR
);
655 } else if (tun
== SSH_TUNID_ANY
) {
656 for (tun
= 100; tun
>= 0; tun
--) {
657 snprintf(name
, sizeof(name
), "/dev/tun%d", tun
);
658 if ((fd
= open(name
, O_RDWR
)) >= 0)
662 debug("%s: invalid tunnel %u", __func__
, tun
);
667 debug("%s: %s open failed: %s", __func__
, name
, strerror(errno
));
671 debug("%s: %s mode %d fd %d", __func__
, name
, mode
, fd
);
673 /* Set the tunnel device operation mode */
674 snprintf(ifr
.ifr_name
, sizeof(ifr
.ifr_name
), "tun%d", tun
);
675 if ((sock
= socket(PF_UNIX
, SOCK_STREAM
, 0)) == -1)
678 if (ioctl(sock
, SIOCGIFFLAGS
, &ifr
) == -1)
681 /* Set interface mode */
682 ifr
.ifr_flags
&= ~IFF_UP
;
683 if (mode
== SSH_TUNMODE_ETHERNET
)
684 ifr
.ifr_flags
|= IFF_LINK0
;
686 ifr
.ifr_flags
&= ~IFF_LINK0
;
687 if (ioctl(sock
, SIOCSIFFLAGS
, &ifr
) == -1)
690 /* Bring interface up */
691 ifr
.ifr_flags
|= IFF_UP
;
692 if (ioctl(sock
, SIOCSIFFLAGS
, &ifr
) == -1)
703 debug("%s: failed to set %s mode %d: %s", __func__
, name
,
704 mode
, strerror(errno
));
707 error("Tunnel interfaces are not supported on this platform");
717 if ((nullfd
= dupfd
= open(_PATH_DEVNULL
, O_RDWR
)) == -1) {
718 fprintf(stderr
, "Couldn't open /dev/null: %s\n",
722 while (++dupfd
<= 2) {
723 /* Only clobber closed fds */
724 if (fcntl(dupfd
, F_GETFL
, 0) >= 0)
726 if (dup2(nullfd
, dupfd
) == -1) {
727 fprintf(stderr
, "dup2: %s\n", strerror(errno
));
736 tohex(const void *vp
, size_t l
)
738 const u_char
*p
= (const u_char
*)vp
;
743 return xstrdup("tohex: length > 65536");
747 for (i
= 0; i
< l
; i
++) {
748 snprintf(b
, sizeof(b
), "%02x", p
[i
]);
755 get_u64(const void *vp
)
757 const u_char
*p
= (const u_char
*)vp
;
760 v
= (u_int64_t
)p
[0] << 56;
761 v
|= (u_int64_t
)p
[1] << 48;
762 v
|= (u_int64_t
)p
[2] << 40;
763 v
|= (u_int64_t
)p
[3] << 32;
764 v
|= (u_int64_t
)p
[4] << 24;
765 v
|= (u_int64_t
)p
[5] << 16;
766 v
|= (u_int64_t
)p
[6] << 8;
767 v
|= (u_int64_t
)p
[7];
773 get_u32(const void *vp
)
775 const u_char
*p
= (const u_char
*)vp
;
778 v
= (u_int32_t
)p
[0] << 24;
779 v
|= (u_int32_t
)p
[1] << 16;
780 v
|= (u_int32_t
)p
[2] << 8;
781 v
|= (u_int32_t
)p
[3];
787 get_u16(const void *vp
)
789 const u_char
*p
= (const u_char
*)vp
;
792 v
= (u_int16_t
)p
[0] << 8;
793 v
|= (u_int16_t
)p
[1];
799 put_u64(void *vp
, u_int64_t v
)
801 u_char
*p
= (u_char
*)vp
;
803 p
[0] = (u_char
)(v
>> 56) & 0xff;
804 p
[1] = (u_char
)(v
>> 48) & 0xff;
805 p
[2] = (u_char
)(v
>> 40) & 0xff;
806 p
[3] = (u_char
)(v
>> 32) & 0xff;
807 p
[4] = (u_char
)(v
>> 24) & 0xff;
808 p
[5] = (u_char
)(v
>> 16) & 0xff;
809 p
[6] = (u_char
)(v
>> 8) & 0xff;
810 p
[7] = (u_char
)v
& 0xff;
814 put_u32(void *vp
, u_int32_t v
)
816 u_char
*p
= (u_char
*)vp
;
818 p
[0] = (u_char
)(v
>> 24) & 0xff;
819 p
[1] = (u_char
)(v
>> 16) & 0xff;
820 p
[2] = (u_char
)(v
>> 8) & 0xff;
821 p
[3] = (u_char
)v
& 0xff;
826 put_u16(void *vp
, u_int16_t v
)
828 u_char
*p
= (u_char
*)vp
;
830 p
[0] = (u_char
)(v
>> 8) & 0xff;
831 p
[1] = (u_char
)v
& 0xff;
835 ms_subtract_diff(struct timeval
*start
, int *ms
)
837 struct timeval diff
, finish
;
839 gettimeofday(&finish
, NULL
);
840 timersub(&finish
, start
, &diff
);
841 *ms
-= (diff
.tv_sec
* 1000) + (diff
.tv_usec
/ 1000);
845 ms_to_timeval(struct timeval
*tv
, int ms
)
849 tv
->tv_sec
= ms
/ 1000;
850 tv
->tv_usec
= (ms
% 1000) * 1000;
854 bandwidth_limit_init(struct bwlimit
*bw
, u_int64_t kbps
, size_t buflen
)
858 bw
->thresh
= bw
->rate
;
860 timerclear(&bw
->bwstart
);
861 timerclear(&bw
->bwend
);
864 /* Callback from read/write loop to insert bandwidth-limiting delays */
866 bandwidth_limit(struct bwlimit
*bw
, size_t read_len
)
869 struct timespec ts
, rm
;
871 if (!timerisset(&bw
->bwstart
)) {
872 gettimeofday(&bw
->bwstart
, NULL
);
876 bw
->lamt
+= read_len
;
877 if (bw
->lamt
< bw
->thresh
)
880 gettimeofday(&bw
->bwend
, NULL
);
881 timersub(&bw
->bwend
, &bw
->bwstart
, &bw
->bwend
);
882 if (!timerisset(&bw
->bwend
))
886 waitlen
= (double)1000000L * bw
->lamt
/ bw
->rate
;
888 bw
->bwstart
.tv_sec
= waitlen
/ 1000000L;
889 bw
->bwstart
.tv_usec
= waitlen
% 1000000L;
891 if (timercmp(&bw
->bwstart
, &bw
->bwend
, >)) {
892 timersub(&bw
->bwstart
, &bw
->bwend
, &bw
->bwend
);
894 /* Adjust the wait time */
895 if (bw
->bwend
.tv_sec
) {
897 if (bw
->thresh
< bw
->buflen
/ 4)
898 bw
->thresh
= bw
->buflen
/ 4;
899 } else if (bw
->bwend
.tv_usec
< 10000) {
901 if (bw
->thresh
> bw
->buflen
* 8)
902 bw
->thresh
= bw
->buflen
* 8;
905 TIMEVAL_TO_TIMESPEC(&bw
->bwend
, &ts
);
906 while (nanosleep(&ts
, &rm
) == -1) {
914 gettimeofday(&bw
->bwstart
, NULL
);
917 sock_set_v6only(int s
)
922 debug3("%s: set socket %d IPV6_V6ONLY", __func__
, s
);
923 if (setsockopt(s
, IPPROTO_IPV6
, IPV6_V6ONLY
, &on
, sizeof(on
)) == -1)
924 error("setsockopt IPV6_V6ONLY: %s", strerror(errno
));