1 /* $OpenBSD: misc.c,v 1.84 2010/11/21 01:01:13 djm 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/in_systm.h>
42 #include <netinet/ip.h>
43 #include <netinet/tcp.h>
52 #ifdef SSH_TUN_OPENBSD
61 /* remove newline at end of string */
67 if (*t
== '\n' || *t
== '\r') {
77 /* set/unset filedescriptor to non-blocking */
83 val
= fcntl(fd
, F_GETFL
, 0);
85 error("fcntl(%d, F_GETFL, 0): %s", fd
, strerror(errno
));
88 if (val
& O_NONBLOCK
) {
89 debug3("fd %d is O_NONBLOCK", fd
);
92 debug2("fd %d setting O_NONBLOCK", fd
);
94 if (fcntl(fd
, F_SETFL
, val
) == -1) {
95 debug("fcntl(%d, F_SETFL, O_NONBLOCK): %s", fd
,
103 unset_nonblock(int fd
)
107 val
= fcntl(fd
, F_GETFL
, 0);
109 error("fcntl(%d, F_GETFL, 0): %s", fd
, strerror(errno
));
112 if (!(val
& O_NONBLOCK
)) {
113 debug3("fd %d is not O_NONBLOCK", fd
);
116 debug("fd %d clearing O_NONBLOCK", fd
);
118 if (fcntl(fd
, F_SETFL
, val
) == -1) {
119 debug("fcntl(%d, F_SETFL, ~O_NONBLOCK): %s",
120 fd
, strerror(errno
));
127 ssh_gai_strerror(int gaierr
)
129 if (gaierr
== EAI_SYSTEM
)
130 return strerror(errno
);
131 return gai_strerror(gaierr
);
134 /* disable nagle on socket */
142 if (getsockopt(fd
, IPPROTO_TCP
, TCP_NODELAY
, &opt
, &optlen
) == -1) {
143 debug("getsockopt TCP_NODELAY: %.100s", strerror(errno
));
147 debug2("fd %d is TCP_NODELAY", fd
);
151 debug2("fd %d setting TCP_NODELAY", fd
);
152 if (setsockopt(fd
, IPPROTO_TCP
, TCP_NODELAY
, &opt
, sizeof opt
) == -1)
153 error("setsockopt TCP_NODELAY: %.100s", strerror(errno
));
156 /* Characters considered whitespace in strsep calls. */
157 #define WHITESPACE " \t\r\n"
160 /* return next token in configuration line */
172 *s
= strpbrk(*s
, WHITESPACE QUOTE
"=");
177 memmove(*s
, *s
+ 1, strlen(*s
)); /* move nul too */
178 /* Find matching quote */
179 if ((*s
= strpbrk(*s
, QUOTE
)) == NULL
) {
180 return (NULL
); /* no matching quote */
183 *s
+= strspn(*s
+ 1, WHITESPACE
) + 1;
188 /* Allow only one '=' to be skipped */
193 /* Skip any extra whitespace after first token */
194 *s
+= strspn(*s
+ 1, WHITESPACE
) + 1;
195 if (*s
[0] == '=' && !wspace
)
196 *s
+= strspn(*s
+ 1, WHITESPACE
) + 1;
202 pwcopy(struct passwd
*pw
)
204 struct passwd
*copy
= xcalloc(1, sizeof(*copy
));
206 copy
->pw_name
= xstrdup(pw
->pw_name
);
207 copy
->pw_passwd
= xstrdup(pw
->pw_passwd
);
208 copy
->pw_gecos
= xstrdup(pw
->pw_gecos
);
209 copy
->pw_uid
= pw
->pw_uid
;
210 copy
->pw_gid
= pw
->pw_gid
;
211 #ifdef HAVE_PW_EXPIRE_IN_PASSWD
212 copy
->pw_expire
= pw
->pw_expire
;
214 #ifdef HAVE_PW_CHANGE_IN_PASSWD
215 copy
->pw_change
= pw
->pw_change
;
217 #ifdef HAVE_PW_CLASS_IN_PASSWD
218 copy
->pw_class
= xstrdup(pw
->pw_class
);
220 copy
->pw_dir
= xstrdup(pw
->pw_dir
);
221 copy
->pw_shell
= xstrdup(pw
->pw_shell
);
226 * Convert ASCII string to TCP/IP port number.
227 * Port must be >=0 and <=65535.
228 * Return -1 if invalid.
231 a2port(const char *s
)
236 port
= strtonum(s
, 0, 65535, &errstr
);
243 a2tun(const char *s
, int *remote
)
245 const char *errstr
= NULL
;
249 if (remote
!= NULL
) {
250 *remote
= SSH_TUNID_ANY
;
252 if ((ep
= strchr(sp
, ':')) == NULL
) {
254 return (a2tun(s
, NULL
));
257 *remote
= a2tun(ep
, NULL
);
258 tun
= a2tun(sp
, NULL
);
260 return (*remote
== SSH_TUNID_ERR
? *remote
: tun
);
263 if (strcasecmp(s
, "any") == 0)
264 return (SSH_TUNID_ANY
);
266 tun
= strtonum(s
, 0, SSH_TUNID_MAX
, &errstr
);
268 return (SSH_TUNID_ERR
);
274 #define MINUTES (SECONDS * 60)
275 #define HOURS (MINUTES * 60)
276 #define DAYS (HOURS * 24)
277 #define WEEKS (DAYS * 7)
280 * Convert a time string into seconds; format is
284 * Valid time qualifiers are:
298 * Return -1 if time string is invalid.
301 convtime(const char *s
)
311 if (p
== NULL
|| *p
== '\0')
315 secs
= strtol(p
, &endp
, 10);
317 (errno
== ERANGE
&& (secs
== LONG_MIN
|| secs
== LONG_MAX
)) ||
357 * Returns a standardized host+port identifier string.
358 * Caller must free returned string.
361 put_host_port(const char *host
, u_short port
)
365 if (port
== 0 || port
== SSH_DEFAULT_PORT
)
366 return(xstrdup(host
));
367 if (asprintf(&hoststr
, "[%s]:%d", host
, (int)port
) < 0)
368 fatal("put_host_port: asprintf: %s", strerror(errno
));
369 debug3("put_host_port: %s", hoststr
);
374 * Search for next delimiter between hostnames/addresses and ports.
375 * Argument may be modified (for termination).
376 * Returns *cp if parsing succeeds.
377 * *cp is set to the start of the next delimiter, if one was found.
378 * If this is the last field, *cp is set to NULL.
385 if (cp
== NULL
|| *cp
== NULL
)
390 if ((s
= strchr(s
, ']')) == NULL
)
394 } else if ((s
= strpbrk(s
, ":/")) == NULL
)
395 s
= *cp
+ strlen(*cp
); /* skip to end (see first case below) */
399 *cp
= NULL
; /* no more fields*/
404 *s
= '\0'; /* terminate */
416 cleanhostname(char *host
)
418 if (*host
== '[' && host
[strlen(host
) - 1] == ']') {
419 host
[strlen(host
) - 1] = '\0';
430 if (*cp
== ':') /* Leading colon is part of file name. */
436 if (*cp
== '@' && *(cp
+1) == '[')
438 if (*cp
== ']' && *(cp
+1) == ':' && flag
)
440 if (*cp
== ':' && !flag
)
448 /* function to assist building execv() arguments */
450 addargs(arglist
*args
, char *fmt
, ...)
458 r
= vasprintf(&cp
, fmt
, ap
);
461 fatal("addargs: argument too long");
463 nalloc
= args
->nalloc
;
464 if (args
->list
== NULL
) {
467 } else if (args
->num
+2 >= nalloc
)
470 args
->list
= xrealloc(args
->list
, nalloc
, sizeof(char *));
471 args
->nalloc
= nalloc
;
472 args
->list
[args
->num
++] = cp
;
473 args
->list
[args
->num
] = NULL
;
477 replacearg(arglist
*args
, u_int which
, char *fmt
, ...)
484 r
= vasprintf(&cp
, fmt
, ap
);
487 fatal("replacearg: argument too long");
489 if (which
>= args
->num
)
490 fatal("replacearg: tried to replace invalid arg %d >= %d",
492 xfree(args
->list
[which
]);
493 args
->list
[which
] = cp
;
497 freeargs(arglist
*args
)
501 if (args
->list
!= NULL
) {
502 for (i
= 0; i
< args
->num
; i
++)
503 xfree(args
->list
[i
]);
505 args
->nalloc
= args
->num
= 0;
511 * Expands tildes in the file name. Returns data allocated by xmalloc.
512 * Warning: this calls getpw*.
515 tilde_expand_filename(const char *filename
, uid_t uid
)
518 char user
[128], ret
[MAXPATHLEN
];
522 if (*filename
!= '~')
523 return (xstrdup(filename
));
526 path
= strchr(filename
, '/');
527 if (path
!= NULL
&& path
> filename
) { /* ~user/path */
528 slash
= path
- filename
;
529 if (slash
> sizeof(user
) - 1)
530 fatal("tilde_expand_filename: ~username too long");
531 memcpy(user
, filename
, slash
);
533 if ((pw
= getpwnam(user
)) == NULL
)
534 fatal("tilde_expand_filename: No such user %s", user
);
535 } else if ((pw
= getpwuid(uid
)) == NULL
) /* ~/path */
536 fatal("tilde_expand_filename: No such uid %ld", (long)uid
);
538 if (strlcpy(ret
, pw
->pw_dir
, sizeof(ret
)) >= sizeof(ret
))
539 fatal("tilde_expand_filename: Path too long");
541 /* Make sure directory has a trailing '/' */
542 len
= strlen(pw
->pw_dir
);
543 if ((len
== 0 || pw
->pw_dir
[len
- 1] != '/') &&
544 strlcat(ret
, "/", sizeof(ret
)) >= sizeof(ret
))
545 fatal("tilde_expand_filename: Path too long");
547 /* Skip leading '/' from specified path */
550 if (strlcat(ret
, filename
, sizeof(ret
)) >= sizeof(ret
))
551 fatal("tilde_expand_filename: Path too long");
553 return (xstrdup(ret
));
557 * Expand a string with a set of %[char] escapes. A number of escapes may be
558 * specified as (char *escape_chars, char *replacement) pairs. The list must
559 * be terminated by a NULL escape_char. Returns replaced string in memory
560 * allocated by xmalloc.
563 percent_expand(const char *string
, ...)
565 #define EXPAND_MAX_KEYS 16
566 u_int num_keys
, i
, j
;
570 } keys
[EXPAND_MAX_KEYS
];
575 va_start(ap
, string
);
576 for (num_keys
= 0; num_keys
< EXPAND_MAX_KEYS
; num_keys
++) {
577 keys
[num_keys
].key
= va_arg(ap
, char *);
578 if (keys
[num_keys
].key
== NULL
)
580 keys
[num_keys
].repl
= va_arg(ap
, char *);
581 if (keys
[num_keys
].repl
== NULL
)
582 fatal("%s: NULL replacement", __func__
);
584 if (num_keys
== EXPAND_MAX_KEYS
&& va_arg(ap
, char *) != NULL
)
585 fatal("%s: too many keys", __func__
);
590 for (i
= 0; *string
!= '\0'; string
++) {
591 if (*string
!= '%') {
594 if (i
>= sizeof(buf
))
595 fatal("%s: string too long", __func__
);
603 for (j
= 0; j
< num_keys
; j
++) {
604 if (strchr(keys
[j
].key
, *string
) != NULL
) {
605 i
= strlcat(buf
, keys
[j
].repl
, sizeof(buf
));
606 if (i
>= sizeof(buf
))
607 fatal("%s: string too long", __func__
);
612 fatal("%s: unknown key %%%c", __func__
, *string
);
614 return (xstrdup(buf
));
615 #undef EXPAND_MAX_KEYS
619 * Read an entire line from a public key file into a static buffer, discarding
620 * lines that exceed the buffer size. Returns 0 on success, -1 on failure.
623 read_keyfile_line(FILE *f
, const char *filename
, char *buf
, size_t bufsz
,
626 while (fgets(buf
, bufsz
, f
) != NULL
) {
630 if (buf
[strlen(buf
) - 1] == '\n' || feof(f
)) {
633 debug("%s: %s line %lu exceeds size limit", __func__
,
635 /* discard remainder of line */
636 while (fgetc(f
) != '\n' && !feof(f
))
644 tun_open(int tun
, int mode
)
646 #if defined(CUSTOM_SYS_TUN_OPEN)
647 return (sys_tun_open(tun
, mode
));
648 #elif defined(SSH_TUN_OPENBSD)
653 /* Open the tunnel device */
654 if (tun
<= SSH_TUNID_MAX
) {
655 snprintf(name
, sizeof(name
), "/dev/tun%d", tun
);
656 fd
= open(name
, O_RDWR
);
657 } else if (tun
== SSH_TUNID_ANY
) {
658 for (tun
= 100; tun
>= 0; tun
--) {
659 snprintf(name
, sizeof(name
), "/dev/tun%d", tun
);
660 if ((fd
= open(name
, O_RDWR
)) >= 0)
664 debug("%s: invalid tunnel %u", __func__
, tun
);
669 debug("%s: %s open failed: %s", __func__
, name
, strerror(errno
));
673 debug("%s: %s mode %d fd %d", __func__
, name
, mode
, fd
);
675 /* Set the tunnel device operation mode */
676 snprintf(ifr
.ifr_name
, sizeof(ifr
.ifr_name
), "tun%d", tun
);
677 if ((sock
= socket(PF_UNIX
, SOCK_STREAM
, 0)) == -1)
680 if (ioctl(sock
, SIOCGIFFLAGS
, &ifr
) == -1)
683 /* Set interface mode */
684 ifr
.ifr_flags
&= ~IFF_UP
;
685 if (mode
== SSH_TUNMODE_ETHERNET
)
686 ifr
.ifr_flags
|= IFF_LINK0
;
688 ifr
.ifr_flags
&= ~IFF_LINK0
;
689 if (ioctl(sock
, SIOCSIFFLAGS
, &ifr
) == -1)
692 /* Bring interface up */
693 ifr
.ifr_flags
|= IFF_UP
;
694 if (ioctl(sock
, SIOCSIFFLAGS
, &ifr
) == -1)
705 debug("%s: failed to set %s mode %d: %s", __func__
, name
,
706 mode
, strerror(errno
));
709 error("Tunnel interfaces are not supported on this platform");
719 if ((nullfd
= dupfd
= open(_PATH_DEVNULL
, O_RDWR
)) == -1) {
720 fprintf(stderr
, "Couldn't open /dev/null: %s\n",
724 while (++dupfd
<= 2) {
725 /* Only clobber closed fds */
726 if (fcntl(dupfd
, F_GETFL
, 0) >= 0)
728 if (dup2(nullfd
, dupfd
) == -1) {
729 fprintf(stderr
, "dup2: %s\n", strerror(errno
));
738 tohex(const void *vp
, size_t l
)
740 const u_char
*p
= (const u_char
*)vp
;
745 return xstrdup("tohex: length > 65536");
749 for (i
= 0; i
< l
; i
++) {
750 snprintf(b
, sizeof(b
), "%02x", p
[i
]);
757 get_u64(const void *vp
)
759 const u_char
*p
= (const u_char
*)vp
;
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];
775 get_u32(const void *vp
)
777 const u_char
*p
= (const u_char
*)vp
;
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];
789 get_u16(const void *vp
)
791 const u_char
*p
= (const u_char
*)vp
;
794 v
= (u_int16_t
)p
[0] << 8;
795 v
|= (u_int16_t
)p
[1];
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;
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;
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;
837 ms_subtract_diff(struct timeval
*start
, int *ms
)
839 struct timeval diff
, finish
;
841 gettimeofday(&finish
, NULL
);
842 timersub(&finish
, start
, &diff
);
843 *ms
-= (diff
.tv_sec
* 1000) + (diff
.tv_usec
/ 1000);
847 ms_to_timeval(struct timeval
*tv
, int ms
)
851 tv
->tv_sec
= ms
/ 1000;
852 tv
->tv_usec
= (ms
% 1000) * 1000;
856 bandwidth_limit_init(struct bwlimit
*bw
, u_int64_t kbps
, size_t buflen
)
860 bw
->thresh
= bw
->rate
;
862 timerclear(&bw
->bwstart
);
863 timerclear(&bw
->bwend
);
866 /* Callback from read/write loop to insert bandwidth-limiting delays */
868 bandwidth_limit(struct bwlimit
*bw
, size_t read_len
)
871 struct timespec ts
, rm
;
873 if (!timerisset(&bw
->bwstart
)) {
874 gettimeofday(&bw
->bwstart
, NULL
);
878 bw
->lamt
+= read_len
;
879 if (bw
->lamt
< bw
->thresh
)
882 gettimeofday(&bw
->bwend
, NULL
);
883 timersub(&bw
->bwend
, &bw
->bwstart
, &bw
->bwend
);
884 if (!timerisset(&bw
->bwend
))
888 waitlen
= (double)1000000L * bw
->lamt
/ bw
->rate
;
890 bw
->bwstart
.tv_sec
= waitlen
/ 1000000L;
891 bw
->bwstart
.tv_usec
= waitlen
% 1000000L;
893 if (timercmp(&bw
->bwstart
, &bw
->bwend
, >)) {
894 timersub(&bw
->bwstart
, &bw
->bwend
, &bw
->bwend
);
896 /* Adjust the wait time */
897 if (bw
->bwend
.tv_sec
) {
899 if (bw
->thresh
< bw
->buflen
/ 4)
900 bw
->thresh
= bw
->buflen
/ 4;
901 } else if (bw
->bwend
.tv_usec
< 10000) {
903 if (bw
->thresh
> bw
->buflen
* 8)
904 bw
->thresh
= bw
->buflen
* 8;
907 TIMEVAL_TO_TIMESPEC(&bw
->bwend
, &ts
);
908 while (nanosleep(&ts
, &rm
) == -1) {
916 gettimeofday(&bw
->bwstart
, NULL
);
919 /* Make a template filename for mk[sd]temp() */
921 mktemp_proto(char *s
, size_t len
)
926 if ((tmpdir
= getenv("TMPDIR")) != NULL
) {
927 r
= snprintf(s
, len
, "%s/ssh-XXXXXXXXXXXX", tmpdir
);
928 if (r
> 0 && (size_t)r
< len
)
931 r
= snprintf(s
, len
, "/tmp/ssh-XXXXXXXXXXXX");
932 if (r
< 0 || (size_t)r
>= len
)
933 fatal("%s: template string too short", __func__
);
936 static const struct {
940 { "af11", IPTOS_DSCP_AF11
},
941 { "af12", IPTOS_DSCP_AF12
},
942 { "af13", IPTOS_DSCP_AF13
},
943 { "af14", IPTOS_DSCP_AF21
},
944 { "af22", IPTOS_DSCP_AF22
},
945 { "af23", IPTOS_DSCP_AF23
},
946 { "af31", IPTOS_DSCP_AF31
},
947 { "af32", IPTOS_DSCP_AF32
},
948 { "af33", IPTOS_DSCP_AF33
},
949 { "af41", IPTOS_DSCP_AF41
},
950 { "af42", IPTOS_DSCP_AF42
},
951 { "af43", IPTOS_DSCP_AF43
},
952 { "cs0", IPTOS_DSCP_CS0
},
953 { "cs1", IPTOS_DSCP_CS1
},
954 { "cs2", IPTOS_DSCP_CS2
},
955 { "cs3", IPTOS_DSCP_CS3
},
956 { "cs4", IPTOS_DSCP_CS4
},
957 { "cs5", IPTOS_DSCP_CS5
},
958 { "cs6", IPTOS_DSCP_CS6
},
959 { "cs7", IPTOS_DSCP_CS7
},
960 { "ef", IPTOS_DSCP_EF
},
961 { "lowdelay", IPTOS_LOWDELAY
},
962 { "throughput", IPTOS_THROUGHPUT
},
963 { "reliability", IPTOS_RELIABILITY
},
968 parse_ipqos(const char *cp
)
976 for (i
= 0; ipqos
[i
].name
!= NULL
; i
++) {
977 if (strcasecmp(cp
, ipqos
[i
].name
) == 0)
978 return ipqos
[i
].value
;
980 /* Try parsing as an integer */
981 val
= strtol(cp
, &ep
, 0);
982 if (*cp
== '\0' || *ep
!= '\0' || val
< 0 || val
> 255)
988 sock_set_v6only(int s
)
993 debug3("%s: set socket %d IPV6_V6ONLY", __func__
, s
);
994 if (setsockopt(s
, IPPROTO_IPV6
, IPV6_V6ONLY
, &on
, sizeof(on
)) == -1)
995 error("setsockopt IPV6_V6ONLY: %s", strerror(errno
));