1 /* $OpenBSD: misc.c,v 1.52 2006/03/30 09:58:15 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/ioctl.h>
30 #include <netinet/tcp.h>
34 #ifdef SSH_TUN_OPENBSD
42 /* remove newline at end of string */
48 if (*t
== '\n' || *t
== '\r') {
58 /* set/unset filedescriptor to non-blocking */
64 val
= fcntl(fd
, F_GETFL
, 0);
66 error("fcntl(%d, F_GETFL, 0): %s", fd
, strerror(errno
));
69 if (val
& O_NONBLOCK
) {
70 debug3("fd %d is O_NONBLOCK", fd
);
73 debug2("fd %d setting O_NONBLOCK", fd
);
75 if (fcntl(fd
, F_SETFL
, val
) == -1) {
76 debug("fcntl(%d, F_SETFL, O_NONBLOCK): %s", fd
,
84 unset_nonblock(int fd
)
88 val
= fcntl(fd
, F_GETFL
, 0);
90 error("fcntl(%d, F_GETFL, 0): %s", fd
, strerror(errno
));
93 if (!(val
& O_NONBLOCK
)) {
94 debug3("fd %d is not O_NONBLOCK", fd
);
97 debug("fd %d clearing O_NONBLOCK", fd
);
99 if (fcntl(fd
, F_SETFL
, val
) == -1) {
100 debug("fcntl(%d, F_SETFL, ~O_NONBLOCK): %s",
101 fd
, strerror(errno
));
107 /* disable nagle on socket */
115 if (getsockopt(fd
, IPPROTO_TCP
, TCP_NODELAY
, &opt
, &optlen
) == -1) {
116 debug("getsockopt TCP_NODELAY: %.100s", strerror(errno
));
120 debug2("fd %d is TCP_NODELAY", fd
);
124 debug2("fd %d setting TCP_NODELAY", fd
);
125 if (setsockopt(fd
, IPPROTO_TCP
, TCP_NODELAY
, &opt
, sizeof opt
) == -1)
126 error("setsockopt TCP_NODELAY: %.100s", strerror(errno
));
129 /* Characters considered whitespace in strsep calls. */
130 #define WHITESPACE " \t\r\n"
133 /* return next token in configuration line */
145 *s
= strpbrk(*s
, WHITESPACE QUOTE
"=");
150 memmove(*s
, *s
+ 1, strlen(*s
)); /* move nul too */
151 /* Find matching quote */
152 if ((*s
= strpbrk(*s
, QUOTE
)) == NULL
) {
153 return (NULL
); /* no matching quote */
160 /* Allow only one '=' to be skipped */
165 /* Skip any extra whitespace after first token */
166 *s
+= strspn(*s
+ 1, WHITESPACE
) + 1;
167 if (*s
[0] == '=' && !wspace
)
168 *s
+= strspn(*s
+ 1, WHITESPACE
) + 1;
174 pwcopy(struct passwd
*pw
)
176 struct passwd
*copy
= xcalloc(1, sizeof(*copy
));
178 copy
->pw_name
= xstrdup(pw
->pw_name
);
179 copy
->pw_passwd
= xstrdup(pw
->pw_passwd
);
180 copy
->pw_gecos
= xstrdup(pw
->pw_gecos
);
181 copy
->pw_uid
= pw
->pw_uid
;
182 copy
->pw_gid
= pw
->pw_gid
;
183 #ifdef HAVE_PW_EXPIRE_IN_PASSWD
184 copy
->pw_expire
= pw
->pw_expire
;
186 #ifdef HAVE_PW_CHANGE_IN_PASSWD
187 copy
->pw_change
= pw
->pw_change
;
189 #ifdef HAVE_PW_CLASS_IN_PASSWD
190 copy
->pw_class
= xstrdup(pw
->pw_class
);
192 copy
->pw_dir
= xstrdup(pw
->pw_dir
);
193 copy
->pw_shell
= xstrdup(pw
->pw_shell
);
198 * Convert ASCII string to TCP/IP port number.
199 * Port must be >0 and <=65535.
200 * Return 0 if invalid.
203 a2port(const char *s
)
209 port
= strtol(s
, &endp
, 0);
210 if (s
== endp
|| *endp
!= '\0' ||
211 (errno
== ERANGE
&& (port
== LONG_MIN
|| port
== LONG_MAX
)) ||
212 port
<= 0 || port
> 65535)
219 a2tun(const char *s
, int *remote
)
221 const char *errstr
= NULL
;
225 if (remote
!= NULL
) {
226 *remote
= SSH_TUNID_ANY
;
228 if ((ep
= strchr(sp
, ':')) == NULL
) {
230 return (a2tun(s
, NULL
));
233 *remote
= a2tun(ep
, NULL
);
234 tun
= a2tun(sp
, NULL
);
236 return (*remote
== SSH_TUNID_ERR
? *remote
: tun
);
239 if (strcasecmp(s
, "any") == 0)
240 return (SSH_TUNID_ANY
);
242 tun
= strtonum(s
, 0, SSH_TUNID_MAX
, &errstr
);
244 return (SSH_TUNID_ERR
);
250 #define MINUTES (SECONDS * 60)
251 #define HOURS (MINUTES * 60)
252 #define DAYS (HOURS * 24)
253 #define WEEKS (DAYS * 7)
256 * Convert a time string into seconds; format is
260 * Valid time qualifiers are:
274 * Return -1 if time string is invalid.
277 convtime(const char *s
)
287 if (p
== NULL
|| *p
== '\0')
291 secs
= strtol(p
, &endp
, 10);
293 (errno
== ERANGE
&& (secs
== LONG_MIN
|| secs
== LONG_MAX
)) ||
333 * Search for next delimiter between hostnames/addresses and ports.
334 * Argument may be modified (for termination).
335 * Returns *cp if parsing succeeds.
336 * *cp is set to the start of the next delimiter, if one was found.
337 * If this is the last field, *cp is set to NULL.
344 if (cp
== NULL
|| *cp
== NULL
)
349 if ((s
= strchr(s
, ']')) == NULL
)
353 } else if ((s
= strpbrk(s
, ":/")) == NULL
)
354 s
= *cp
+ strlen(*cp
); /* skip to end (see first case below) */
358 *cp
= NULL
; /* no more fields*/
363 *s
= '\0'; /* terminate */
375 cleanhostname(char *host
)
377 if (*host
== '[' && host
[strlen(host
) - 1] == ']') {
378 host
[strlen(host
) - 1] = '\0';
389 if (*cp
== ':') /* Leading colon is part of file name. */
395 if (*cp
== '@' && *(cp
+1) == '[')
397 if (*cp
== ']' && *(cp
+1) == ':' && flag
)
399 if (*cp
== ':' && !flag
)
407 /* function to assist building execv() arguments */
409 addargs(arglist
*args
, char *fmt
, ...)
417 r
= vasprintf(&cp
, fmt
, ap
);
420 fatal("addargs: argument too long");
422 nalloc
= args
->nalloc
;
423 if (args
->list
== NULL
) {
426 } else if (args
->num
+2 >= nalloc
)
429 args
->list
= xrealloc(args
->list
, nalloc
, sizeof(char *));
430 args
->nalloc
= nalloc
;
431 args
->list
[args
->num
++] = cp
;
432 args
->list
[args
->num
] = NULL
;
436 replacearg(arglist
*args
, u_int which
, char *fmt
, ...)
443 r
= vasprintf(&cp
, fmt
, ap
);
446 fatal("replacearg: argument too long");
448 if (which
>= args
->num
)
449 fatal("replacearg: tried to replace invalid arg %d >= %d",
451 xfree(args
->list
[which
]);
452 args
->list
[which
] = cp
;
456 freeargs(arglist
*args
)
460 if (args
->list
!= NULL
) {
461 for (i
= 0; i
< args
->num
; i
++)
462 xfree(args
->list
[i
]);
464 args
->nalloc
= args
->num
= 0;
470 * Expands tildes in the file name. Returns data allocated by xmalloc.
471 * Warning: this calls getpw*.
474 tilde_expand_filename(const char *filename
, uid_t uid
)
477 char user
[128], ret
[MAXPATHLEN
];
481 if (*filename
!= '~')
482 return (xstrdup(filename
));
485 path
= strchr(filename
, '/');
486 if (path
!= NULL
&& path
> filename
) { /* ~user/path */
487 slash
= path
- filename
;
488 if (slash
> sizeof(user
) - 1)
489 fatal("tilde_expand_filename: ~username too long");
490 memcpy(user
, filename
, slash
);
492 if ((pw
= getpwnam(user
)) == NULL
)
493 fatal("tilde_expand_filename: No such user %s", user
);
494 } else if ((pw
= getpwuid(uid
)) == NULL
) /* ~/path */
495 fatal("tilde_expand_filename: No such uid %d", uid
);
497 if (strlcpy(ret
, pw
->pw_dir
, sizeof(ret
)) >= sizeof(ret
))
498 fatal("tilde_expand_filename: Path too long");
500 /* Make sure directory has a trailing '/' */
501 len
= strlen(pw
->pw_dir
);
502 if ((len
== 0 || pw
->pw_dir
[len
- 1] != '/') &&
503 strlcat(ret
, "/", sizeof(ret
)) >= sizeof(ret
))
504 fatal("tilde_expand_filename: Path too long");
506 /* Skip leading '/' from specified path */
509 if (strlcat(ret
, filename
, sizeof(ret
)) >= sizeof(ret
))
510 fatal("tilde_expand_filename: Path too long");
512 return (xstrdup(ret
));
516 * Expand a string with a set of %[char] escapes. A number of escapes may be
517 * specified as (char *escape_chars, char *replacement) pairs. The list must
518 * be terminated by a NULL escape_char. Returns replaced string in memory
519 * allocated by xmalloc.
522 percent_expand(const char *string
, ...)
524 #define EXPAND_MAX_KEYS 16
528 } keys
[EXPAND_MAX_KEYS
];
529 u_int num_keys
, i
, j
;
534 va_start(ap
, string
);
535 for (num_keys
= 0; num_keys
< EXPAND_MAX_KEYS
; num_keys
++) {
536 keys
[num_keys
].key
= va_arg(ap
, char *);
537 if (keys
[num_keys
].key
== NULL
)
539 keys
[num_keys
].repl
= va_arg(ap
, char *);
540 if (keys
[num_keys
].repl
== NULL
)
541 fatal("percent_expand: NULL replacement");
545 if (num_keys
>= EXPAND_MAX_KEYS
)
546 fatal("percent_expand: too many keys");
550 for (i
= 0; *string
!= '\0'; string
++) {
551 if (*string
!= '%') {
554 if (i
>= sizeof(buf
))
555 fatal("percent_expand: string too long");
562 for (j
= 0; j
< num_keys
; j
++) {
563 if (strchr(keys
[j
].key
, *string
) != NULL
) {
564 i
= strlcat(buf
, keys
[j
].repl
, sizeof(buf
));
565 if (i
>= sizeof(buf
))
566 fatal("percent_expand: string too long");
571 fatal("percent_expand: unknown key %%%c", *string
);
573 return (xstrdup(buf
));
574 #undef EXPAND_MAX_KEYS
578 * Read an entire line from a public key file into a static buffer, discarding
579 * lines that exceed the buffer size. Returns 0 on success, -1 on failure.
582 read_keyfile_line(FILE *f
, const char *filename
, char *buf
, size_t bufsz
,
585 while (fgets(buf
, bufsz
, f
) != NULL
) {
587 if (buf
[strlen(buf
) - 1] == '\n' || feof(f
)) {
590 debug("%s: %s line %lu exceeds size limit", __func__
,
592 /* discard remainder of line */
593 while (fgetc(f
) != '\n' && !feof(f
))
601 tun_open(int tun
, int mode
)
603 #if defined(CUSTOM_SYS_TUN_OPEN)
604 return (sys_tun_open(tun
, mode
));
605 #elif defined(SSH_TUN_OPENBSD)
610 /* Open the tunnel device */
611 if (tun
<= SSH_TUNID_MAX
) {
612 snprintf(name
, sizeof(name
), "/dev/tun%d", tun
);
613 fd
= open(name
, O_RDWR
);
614 } else if (tun
== SSH_TUNID_ANY
) {
615 for (tun
= 100; tun
>= 0; tun
--) {
616 snprintf(name
, sizeof(name
), "/dev/tun%d", tun
);
617 if ((fd
= open(name
, O_RDWR
)) >= 0)
621 debug("%s: invalid tunnel %u", __func__
, tun
);
626 debug("%s: %s open failed: %s", __func__
, name
, strerror(errno
));
630 debug("%s: %s mode %d fd %d", __func__
, name
, mode
, fd
);
632 /* Set the tunnel device operation mode */
633 snprintf(ifr
.ifr_name
, sizeof(ifr
.ifr_name
), "tun%d", tun
);
634 if ((sock
= socket(PF_UNIX
, SOCK_STREAM
, 0)) == -1)
637 if (ioctl(sock
, SIOCGIFFLAGS
, &ifr
) == -1)
640 /* Set interface mode */
641 ifr
.ifr_flags
&= ~IFF_UP
;
642 if (mode
== SSH_TUNMODE_ETHERNET
)
643 ifr
.ifr_flags
|= IFF_LINK0
;
645 ifr
.ifr_flags
&= ~IFF_LINK0
;
646 if (ioctl(sock
, SIOCSIFFLAGS
, &ifr
) == -1)
649 /* Bring interface up */
650 ifr
.ifr_flags
|= IFF_UP
;
651 if (ioctl(sock
, SIOCSIFFLAGS
, &ifr
) == -1)
662 debug("%s: failed to set %s mode %d: %s", __func__
, name
,
663 mode
, strerror(errno
));
666 error("Tunnel interfaces are not supported on this platform");
676 if ((nullfd
= dupfd
= open(_PATH_DEVNULL
, O_RDWR
)) == -1) {
677 fprintf(stderr
, "Couldn't open /dev/null: %s", strerror(errno
));
680 while (++dupfd
<= 2) {
681 /* Only clobber closed fds */
682 if (fcntl(dupfd
, F_GETFL
, 0) >= 0)
684 if (dup2(nullfd
, dupfd
) == -1) {
685 fprintf(stderr
, "dup2: %s", strerror(errno
));
694 tohex(const void *vp
, size_t l
)
696 const u_char
*p
= (const u_char
*)vp
;
701 return xstrdup("tohex: length > 65536");
705 for (i
= 0; i
< l
; i
++) {
706 snprintf(b
, sizeof(b
), "%02x", p
[i
]);
713 get_u64(const void *vp
)
715 const u_char
*p
= (const u_char
*)vp
;
718 v
= (u_int64_t
)p
[0] << 56;
719 v
|= (u_int64_t
)p
[1] << 48;
720 v
|= (u_int64_t
)p
[2] << 40;
721 v
|= (u_int64_t
)p
[3] << 32;
722 v
|= (u_int64_t
)p
[4] << 24;
723 v
|= (u_int64_t
)p
[5] << 16;
724 v
|= (u_int64_t
)p
[6] << 8;
725 v
|= (u_int64_t
)p
[7];
731 get_u32(const void *vp
)
733 const u_char
*p
= (const u_char
*)vp
;
736 v
= (u_int32_t
)p
[0] << 24;
737 v
|= (u_int32_t
)p
[1] << 16;
738 v
|= (u_int32_t
)p
[2] << 8;
739 v
|= (u_int32_t
)p
[3];
745 get_u16(const void *vp
)
747 const u_char
*p
= (const u_char
*)vp
;
750 v
= (u_int16_t
)p
[0] << 8;
751 v
|= (u_int16_t
)p
[1];
757 put_u64(void *vp
, u_int64_t v
)
759 u_char
*p
= (u_char
*)vp
;
761 p
[0] = (u_char
)(v
>> 56) & 0xff;
762 p
[1] = (u_char
)(v
>> 48) & 0xff;
763 p
[2] = (u_char
)(v
>> 40) & 0xff;
764 p
[3] = (u_char
)(v
>> 32) & 0xff;
765 p
[4] = (u_char
)(v
>> 24) & 0xff;
766 p
[5] = (u_char
)(v
>> 16) & 0xff;
767 p
[6] = (u_char
)(v
>> 8) & 0xff;
768 p
[7] = (u_char
)v
& 0xff;
772 put_u32(void *vp
, u_int32_t v
)
774 u_char
*p
= (u_char
*)vp
;
776 p
[0] = (u_char
)(v
>> 24) & 0xff;
777 p
[1] = (u_char
)(v
>> 16) & 0xff;
778 p
[2] = (u_char
)(v
>> 8) & 0xff;
779 p
[3] = (u_char
)v
& 0xff;
784 put_u16(void *vp
, u_int16_t v
)
786 u_char
*p
= (u_char
*)vp
;
788 p
[0] = (u_char
)(v
>> 8) & 0xff;
789 p
[1] = (u_char
)v
& 0xff;