1 /* $OpenBSD: misc.c,v 1.131 2018/07/27 05:13:02 dtucker 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>
33 #include <sys/sysctl.h>
50 #include <netinet/in.h>
51 #include <netinet/in_systm.h>
52 #include <netinet/ip.h>
53 #include <netinet/tcp.h>
63 #ifdef SSH_TUN_OPENBSD
75 /* remove newline at end of string */
81 if (*t == '\n' || *t == '\r') {
91 /* set/unset filedescriptor to non-blocking */
97 val = fcntl(fd, F_GETFL);
99 error("fcntl(%d, F_GETFL): %s", fd, strerror(errno));
102 if (val & O_NONBLOCK) {
103 debug3("fd %d is O_NONBLOCK", fd);
106 debug2("fd %d setting O_NONBLOCK", fd);
108 if (fcntl(fd, F_SETFL, val) == -1) {
109 debug("fcntl(%d, F_SETFL, O_NONBLOCK): %s", fd,
117 unset_nonblock(int fd)
121 val = fcntl(fd, F_GETFL);
123 error("fcntl(%d, F_GETFL): %s", fd, strerror(errno));
126 if (!(val & O_NONBLOCK)) {
127 debug3("fd %d is not O_NONBLOCK", fd);
130 debug("fd %d clearing O_NONBLOCK", fd);
132 if (fcntl(fd, F_SETFL, val) == -1) {
133 debug("fcntl(%d, F_SETFL, ~O_NONBLOCK): %s",
134 fd, strerror(errno));
141 ssh_gai_strerror(int gaierr)
143 if (gaierr == EAI_SYSTEM && errno != 0)
144 return strerror(errno);
145 return gai_strerror(gaierr);
148 /* disable nagle on socket */
156 if (getsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &opt, &optlen) == -1) {
157 debug("getsockopt TCP_NODELAY: %.100s", strerror(errno));
161 debug2("fd %d is TCP_NODELAY", fd);
165 debug2("fd %d setting TCP_NODELAY", fd);
166 if (setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &opt, sizeof opt) == -1)
167 error("setsockopt TCP_NODELAY: %.100s", strerror(errno));
170 /* Allow local port reuse in TIME_WAIT */
172 set_reuseaddr(int fd)
176 if (setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &on, sizeof(on)) == -1) {
177 error("setsockopt SO_REUSEADDR fd %d: %s", fd, strerror(errno));
183 /* Get/set routing domain */
187 #if defined(HAVE_SYS_GET_RDOMAIN)
188 return sys_get_rdomain(fd);
189 #elif defined(__OpenBSD__)
192 socklen_t len = sizeof(rtable);
194 if (getsockopt(fd, SOL_SOCKET, SO_RTABLE, &rtable, &len) == -1) {
195 error("Failed to get routing domain for fd %d: %s",
196 fd, strerror(errno));
199 xasprintf(&ret, "%d", rtable);
201 #else /* defined(__OpenBSD__) */
207 set_rdomain(int fd, const char *name)
209 #if defined(HAVE_SYS_SET_RDOMAIN)
210 return sys_set_rdomain(fd, name);
211 #elif defined(__OpenBSD__)
216 return 0; /* default table */
218 rtable = (int)strtonum(name, 0, 255, &errstr);
219 if (errstr != NULL) {
220 /* Shouldn't happen */
221 error("Invalid routing domain \"%s\": %s", name, errstr);
224 if (setsockopt(fd, SOL_SOCKET, SO_RTABLE,
225 &rtable, sizeof(rtable)) == -1) {
226 error("Failed to set routing domain %d on fd %d: %s",
227 rtable, fd, strerror(errno));
231 #else /* defined(__OpenBSD__) */
232 error("Setting routing domain is not supported on this platform");
237 /* Characters considered whitespace in strsep calls. */
238 #define WHITESPACE " \t\r\n"
241 /* return next token in configuration line */
243 strdelim_internal(char **s, int split_equals)
254 split_equals ? WHITESPACE QUOTE "=" : WHITESPACE QUOTE);
259 memmove(*s, *s + 1, strlen(*s)); /* move nul too */
260 /* Find matching quote */
261 if ((*s = strpbrk(*s, QUOTE)) == NULL) {
262 return (NULL); /* no matching quote */
265 *s += strspn(*s + 1, WHITESPACE) + 1;
270 /* Allow only one '=' to be skipped */
271 if (split_equals && *s[0] == '=')
275 /* Skip any extra whitespace after first token */
276 *s += strspn(*s + 1, WHITESPACE) + 1;
277 if (split_equals && *s[0] == '=' && !wspace)
278 *s += strspn(*s + 1, WHITESPACE) + 1;
284 * Return next token in configuration line; splts on whitespace or a
285 * single '=' character.
290 return strdelim_internal(s, 1);
294 * Return next token in configuration line; splts on whitespace only.
299 return strdelim_internal(s, 0);
303 pwcopy(struct passwd *pw)
305 struct passwd *copy = xcalloc(1, sizeof(*copy));
307 copy->pw_name = xstrdup(pw->pw_name);
308 copy->pw_passwd = xstrdup(pw->pw_passwd);
309 #ifdef HAVE_STRUCT_PASSWD_PW_GECOS
310 copy->pw_gecos = xstrdup(pw->pw_gecos);
312 copy->pw_uid = pw->pw_uid;
313 copy->pw_gid = pw->pw_gid;
314 #ifdef HAVE_STRUCT_PASSWD_PW_EXPIRE
315 copy->pw_expire = pw->pw_expire;
317 #ifdef HAVE_STRUCT_PASSWD_PW_CHANGE
318 copy->pw_change = pw->pw_change;
320 #ifdef HAVE_STRUCT_PASSWD_PW_CLASS
321 copy->pw_class = xstrdup(pw->pw_class);
323 copy->pw_dir = xstrdup(pw->pw_dir);
324 copy->pw_shell = xstrdup(pw->pw_shell);
329 * Convert ASCII string to TCP/IP port number.
330 * Port must be >=0 and <=65535.
331 * Return -1 if invalid.
334 a2port(const char *s)
339 port = strtonum(s, 0, 65535, &errstr);
346 a2tun(const char *s, int *remote)
348 const char *errstr = NULL;
352 if (remote != NULL) {
353 *remote = SSH_TUNID_ANY;
355 if ((ep = strchr(sp, ':')) == NULL) {
357 return (a2tun(s, NULL));
360 *remote = a2tun(ep, NULL);
361 tun = a2tun(sp, NULL);
363 return (*remote == SSH_TUNID_ERR ? *remote : tun);
366 if (strcasecmp(s, "any") == 0)
367 return (SSH_TUNID_ANY);
369 tun = strtonum(s, 0, SSH_TUNID_MAX, &errstr);
371 return (SSH_TUNID_ERR);
377 #define MINUTES (SECONDS * 60)
378 #define HOURS (MINUTES * 60)
379 #define DAYS (HOURS * 24)
380 #define WEEKS (DAYS * 7)
383 * Convert a time string into seconds; format is
387 * Valid time qualifiers are:
401 * Return -1 if time string is invalid.
404 convtime(const char *s)
406 long total, secs, multiplier = 1;
414 if (p == NULL || *p == '\0')
418 secs = strtol(p, &endp, 10);
420 (errno == ERANGE && (secs == LONG_MIN || secs == LONG_MAX)) ||
433 multiplier = MINUTES;
450 if (secs >= LONG_MAX / multiplier)
453 if (total >= LONG_MAX - secs)
465 * Returns a standardized host+port identifier string.
466 * Caller must free returned string.
469 put_host_port(const char *host, u_short port)
473 if (port == 0 || port == SSH_DEFAULT_PORT)
474 return(xstrdup(host));
475 if (asprintf(&hoststr, "[%s]:%d", host, (int)port) < 0)
476 fatal("put_host_port: asprintf: %s", strerror(errno));
477 debug3("put_host_port: %s", hoststr);
482 * Search for next delimiter between hostnames/addresses and ports.
483 * Argument may be modified (for termination).
484 * Returns *cp if parsing succeeds.
485 * *cp is set to the start of the next field, if one was found.
486 * The delimiter char, if present, is stored in delim.
487 * If this is the last field, *cp is set to NULL.
490 hpdelim2(char **cp, char *delim)
494 if (cp == NULL || *cp == NULL)
499 if ((s = strchr(s, ']')) == NULL)
503 } else if ((s = strpbrk(s, ":/")) == NULL)
504 s = *cp + strlen(*cp); /* skip to end (see first case below) */
508 *cp = NULL; /* no more fields*/
515 *s = '\0'; /* terminate */
529 return hpdelim2(cp, NULL);
533 cleanhostname(char *host)
535 if (*host == '[' && host[strlen(host) - 1] == ']') {
536 host[strlen(host) - 1] = '\0';
547 if (*cp == ':') /* Leading colon is part of file name. */
553 if (*cp == '@' && *(cp+1) == '[')
555 if (*cp == ']' && *(cp+1) == ':' && flag)
557 if (*cp == ':' && !flag)
566 * Parse a [user@]host:[path] string.
567 * Caller must free returned user, host and path.
568 * Any of the pointer return arguments may be NULL (useful for syntax checking).
569 * If user was not specified then *userp will be set to NULL.
570 * If host was not specified then *hostp will be set to NULL.
571 * If path was not specified then *pathp will be set to ".".
572 * Returns 0 on success, -1 on failure.
575 parse_user_host_path(const char *s, char **userp, char **hostp, char **pathp)
577 char *user = NULL, *host = NULL, *path = NULL;
590 /* Check for remote syntax: [user@]host:[path] */
591 if ((tmp = colon(sdup)) == NULL)
594 /* Extract optional path */
600 /* Extract optional user and mandatory host */
601 tmp = strrchr(sdup, '@');
604 host = xstrdup(cleanhostname(tmp));
606 user = xstrdup(sdup);
608 host = xstrdup(cleanhostname(sdup));
635 * Parse a [user@]host[:port] string.
636 * Caller must free returned user and host.
637 * Any of the pointer return arguments may be NULL (useful for syntax checking).
638 * If user was not specified then *userp will be set to NULL.
639 * If port was not specified then *portp will be -1.
640 * Returns 0 on success, -1 on failure.
643 parse_user_host_port(const char *s, char **userp, char **hostp, int *portp)
645 char *sdup, *cp, *tmp;
646 char *user = NULL, *host = NULL;
647 int port = -1, ret = -1;
656 if ((sdup = tmp = strdup(s)) == NULL)
658 /* Extract optional username */
659 if ((cp = strrchr(tmp, '@')) != NULL) {
663 if ((user = strdup(tmp)) == NULL)
667 /* Extract mandatory hostname */
668 if ((cp = hpdelim(&tmp)) == NULL || *cp == '\0')
670 host = xstrdup(cleanhostname(cp));
671 /* Convert and verify optional port */
672 if (tmp != NULL && *tmp != '\0') {
673 if ((port = a2port(tmp)) <= 0)
696 * Converts a two-byte hex string to decimal.
697 * Returns the decimal value or -1 for invalid input.
700 hexchar(const char *s)
702 unsigned char result[2];
705 for (i = 0; i < 2; i++) {
706 if (s[i] >= '0' && s[i] <= '9')
707 result[i] = (unsigned char)(s[i] - '0');
708 else if (s[i] >= 'a' && s[i] <= 'f')
709 result[i] = (unsigned char)(s[i] - 'a') + 10;
710 else if (s[i] >= 'A' && s[i] <= 'F')
711 result[i] = (unsigned char)(s[i] - 'A') + 10;
715 return (result[0] << 4) | result[1];
719 * Decode an url-encoded string.
720 * Returns a newly allocated string on success or NULL on failure.
723 urldecode(const char *src)
728 ret = xmalloc(strlen(src) + 1);
729 for (dst = ret; *src != '\0'; src++) {
735 if (!isxdigit((unsigned char)src[1]) ||
736 !isxdigit((unsigned char)src[2]) ||
737 (ch = hexchar(src + 1)) == -1) {
755 * Parse an (scp|ssh|sftp)://[user@]host[:port][/path] URI.
756 * See https://tools.ietf.org/html/draft-ietf-secsh-scp-sftp-ssh-uri-04
757 * Either user or path may be url-encoded (but not host or port).
758 * Caller must free returned user, host and path.
759 * Any of the pointer return arguments may be NULL (useful for syntax checking)
760 * but the scheme must always be specified.
761 * If user was not specified then *userp will be set to NULL.
762 * If port was not specified then *portp will be -1.
763 * If path was not specified then *pathp will be set to NULL.
764 * Returns 0 on success, 1 if non-uri/wrong scheme, -1 on error/invalid uri.
767 parse_uri(const char *scheme, const char *uri, char **userp, char **hostp,
768 int *portp, char **pathp)
770 char *uridup, *cp, *tmp, ch;
771 char *user = NULL, *host = NULL, *path = NULL;
772 int port = -1, ret = -1;
775 len = strlen(scheme);
776 if (strncmp(uri, scheme, len) != 0 || strncmp(uri + len, "://", 3) != 0)
789 uridup = tmp = xstrdup(uri);
791 /* Extract optional ssh-info (username + connection params) */
792 if ((cp = strchr(tmp, '@')) != NULL) {
796 /* Extract username and connection params */
797 if ((delim = strchr(tmp, ';')) != NULL) {
798 /* Just ignore connection params for now */
805 if ((user = urldecode(tmp)) == NULL)
810 /* Extract mandatory hostname */
811 if ((cp = hpdelim2(&tmp, &ch)) == NULL || *cp == '\0')
813 host = xstrdup(cleanhostname(cp));
814 if (!valid_domain(host, 0, NULL))
817 if (tmp != NULL && *tmp != '\0') {
819 /* Convert and verify port. */
820 if ((cp = strchr(tmp, '/')) != NULL)
822 if ((port = a2port(tmp)) <= 0)
824 tmp = cp ? cp + 1 : NULL;
826 if (tmp != NULL && *tmp != '\0') {
827 /* Extract optional path */
828 if ((path = urldecode(tmp)) == NULL)
857 /* function to assist building execv() arguments */
859 addargs(arglist *args, char *fmt, ...)
867 r = vasprintf(&cp, fmt, ap);
870 fatal("addargs: argument too long");
872 nalloc = args->nalloc;
873 if (args->list == NULL) {
876 } else if (args->num+2 >= nalloc)
879 args->list = xrecallocarray(args->list, args->nalloc, nalloc, sizeof(char *));
880 args->nalloc = nalloc;
881 args->list[args->num++] = cp;
882 args->list[args->num] = NULL;
886 replacearg(arglist *args, u_int which, char *fmt, ...)
893 r = vasprintf(&cp, fmt, ap);
896 fatal("replacearg: argument too long");
898 if (which >= args->num)
899 fatal("replacearg: tried to replace invalid arg %d >= %d",
901 free(args->list[which]);
902 args->list[which] = cp;
906 freeargs(arglist *args)
910 if (args->list != NULL) {
911 for (i = 0; i < args->num; i++)
914 args->nalloc = args->num = 0;
920 * Expands tildes in the file name. Returns data allocated by xmalloc.
921 * Warning: this calls getpw*.
924 tilde_expand_filename(const char *filename, uid_t uid)
926 const char *path, *sep;
927 char user[128], *ret;
931 if (*filename != '~')
932 return (xstrdup(filename));
935 path = strchr(filename, '/');
936 if (path != NULL && path > filename) { /* ~user/path */
937 slash = path - filename;
938 if (slash > sizeof(user) - 1)
939 fatal("tilde_expand_filename: ~username too long");
940 memcpy(user, filename, slash);
942 if ((pw = getpwnam(user)) == NULL)
943 fatal("tilde_expand_filename: No such user %s", user);
944 } else if ((pw = getpwuid(uid)) == NULL) /* ~/path */
945 fatal("tilde_expand_filename: No such uid %ld", (long)uid);
947 /* Make sure directory has a trailing '/' */
948 len = strlen(pw->pw_dir);
949 if (len == 0 || pw->pw_dir[len - 1] != '/')
954 /* Skip leading '/' from specified path */
958 if (xasprintf(&ret, "%s%s%s", pw->pw_dir, sep, filename) >= PATH_MAX)
959 fatal("tilde_expand_filename: Path too long");
965 * Expand a string with a set of %[char] escapes. A number of escapes may be
966 * specified as (char *escape_chars, char *replacement) pairs. The list must
967 * be terminated by a NULL escape_char. Returns replaced string in memory
968 * allocated by xmalloc.
971 percent_expand(const char *string, ...)
973 #define EXPAND_MAX_KEYS 16
974 u_int num_keys, i, j;
978 } keys[EXPAND_MAX_KEYS];
983 va_start(ap, string);
984 for (num_keys = 0; num_keys < EXPAND_MAX_KEYS; num_keys++) {
985 keys[num_keys].key = va_arg(ap, char *);
986 if (keys[num_keys].key == NULL)
988 keys[num_keys].repl = va_arg(ap, char *);
989 if (keys[num_keys].repl == NULL)
990 fatal("%s: NULL replacement", __func__);
992 if (num_keys == EXPAND_MAX_KEYS && va_arg(ap, char *) != NULL)
993 fatal("%s: too many keys", __func__);
998 for (i = 0; *string != '\0'; string++) {
999 if (*string != '%') {
1002 if (i >= sizeof(buf))
1003 fatal("%s: string too long", __func__);
1011 if (*string == '\0')
1012 fatal("%s: invalid format", __func__);
1013 for (j = 0; j < num_keys; j++) {
1014 if (strchr(keys[j].key, *string) != NULL) {
1015 i = strlcat(buf, keys[j].repl, sizeof(buf));
1016 if (i >= sizeof(buf))
1017 fatal("%s: string too long", __func__);
1022 fatal("%s: unknown key %%%c", __func__, *string);
1024 return (xstrdup(buf));
1025 #undef EXPAND_MAX_KEYS
1029 tun_open(int tun, int mode, char **ifname)
1031 #if defined(CUSTOM_SYS_TUN_OPEN)
1032 return (sys_tun_open(tun, mode, ifname));
1033 #elif defined(SSH_TUN_OPENBSD)
1037 const char *tunbase = "tun";
1042 if (mode == SSH_TUNMODE_ETHERNET)
1045 /* Open the tunnel device */
1046 if (tun <= SSH_TUNID_MAX) {
1047 snprintf(name, sizeof(name), "/dev/%s%d", tunbase, tun);
1048 fd = open(name, O_RDWR);
1049 } else if (tun == SSH_TUNID_ANY) {
1050 for (tun = 100; tun >= 0; tun--) {
1051 snprintf(name, sizeof(name), "/dev/%s%d",
1053 if ((fd = open(name, O_RDWR)) >= 0)
1057 debug("%s: invalid tunnel %u", __func__, tun);
1062 debug("%s: %s open: %s", __func__, name, strerror(errno));
1066 debug("%s: %s mode %d fd %d", __func__, name, mode, fd);
1068 /* Bring interface up if it is not already */
1069 snprintf(ifr.ifr_name, sizeof(ifr.ifr_name), "%s%d", tunbase, tun);
1070 if ((sock = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
1073 if (ioctl(sock, SIOCGIFFLAGS, &ifr) == -1) {
1074 debug("%s: get interface %s flags: %s", __func__,
1075 ifr.ifr_name, strerror(errno));
1079 if (!(ifr.ifr_flags & IFF_UP)) {
1080 ifr.ifr_flags |= IFF_UP;
1081 if (ioctl(sock, SIOCSIFFLAGS, &ifr) == -1) {
1082 debug("%s: activate interface %s: %s", __func__,
1083 ifr.ifr_name, strerror(errno));
1089 *ifname = xstrdup(ifr.ifr_name);
1101 error("Tunnel interfaces are not supported on this platform");
1107 sanitise_stdfd(void)
1111 if ((nullfd = dupfd = open(_PATH_DEVNULL, O_RDWR)) == -1) {
1112 fprintf(stderr, "Couldn't open /dev/null: %s\n",
1116 while (++dupfd <= STDERR_FILENO) {
1117 /* Only populate closed fds. */
1118 if (fcntl(dupfd, F_GETFL) == -1 && errno == EBADF) {
1119 if (dup2(nullfd, dupfd) == -1) {
1120 fprintf(stderr, "dup2: %s\n", strerror(errno));
1125 if (nullfd > STDERR_FILENO)
1130 tohex(const void *vp, size_t l)
1132 const u_char *p = (const u_char *)vp;
1137 return xstrdup("tohex: length > 65536");
1141 for (i = 0; i < l; i++) {
1142 snprintf(b, sizeof(b), "%02x", p[i]);
1149 get_u64(const void *vp)
1151 const u_char *p = (const u_char *)vp;
1154 v = (u_int64_t)p[0] << 56;
1155 v |= (u_int64_t)p[1] << 48;
1156 v |= (u_int64_t)p[2] << 40;
1157 v |= (u_int64_t)p[3] << 32;
1158 v |= (u_int64_t)p[4] << 24;
1159 v |= (u_int64_t)p[5] << 16;
1160 v |= (u_int64_t)p[6] << 8;
1161 v |= (u_int64_t)p[7];
1167 get_u32(const void *vp)
1169 const u_char *p = (const u_char *)vp;
1172 v = (u_int32_t)p[0] << 24;
1173 v |= (u_int32_t)p[1] << 16;
1174 v |= (u_int32_t)p[2] << 8;
1175 v |= (u_int32_t)p[3];
1181 get_u32_le(const void *vp)
1183 const u_char *p = (const u_char *)vp;
1186 v = (u_int32_t)p[0];
1187 v |= (u_int32_t)p[1] << 8;
1188 v |= (u_int32_t)p[2] << 16;
1189 v |= (u_int32_t)p[3] << 24;
1195 get_u16(const void *vp)
1197 const u_char *p = (const u_char *)vp;
1200 v = (u_int16_t)p[0] << 8;
1201 v |= (u_int16_t)p[1];
1207 put_u64(void *vp, u_int64_t v)
1209 u_char *p = (u_char *)vp;
1211 p[0] = (u_char)(v >> 56) & 0xff;
1212 p[1] = (u_char)(v >> 48) & 0xff;
1213 p[2] = (u_char)(v >> 40) & 0xff;
1214 p[3] = (u_char)(v >> 32) & 0xff;
1215 p[4] = (u_char)(v >> 24) & 0xff;
1216 p[5] = (u_char)(v >> 16) & 0xff;
1217 p[6] = (u_char)(v >> 8) & 0xff;
1218 p[7] = (u_char)v & 0xff;
1222 put_u32(void *vp, u_int32_t v)
1224 u_char *p = (u_char *)vp;
1226 p[0] = (u_char)(v >> 24) & 0xff;
1227 p[1] = (u_char)(v >> 16) & 0xff;
1228 p[2] = (u_char)(v >> 8) & 0xff;
1229 p[3] = (u_char)v & 0xff;
1233 put_u32_le(void *vp, u_int32_t v)
1235 u_char *p = (u_char *)vp;
1237 p[0] = (u_char)v & 0xff;
1238 p[1] = (u_char)(v >> 8) & 0xff;
1239 p[2] = (u_char)(v >> 16) & 0xff;
1240 p[3] = (u_char)(v >> 24) & 0xff;
1244 put_u16(void *vp, u_int16_t v)
1246 u_char *p = (u_char *)vp;
1248 p[0] = (u_char)(v >> 8) & 0xff;
1249 p[1] = (u_char)v & 0xff;
1253 ms_subtract_diff(struct timeval *start, int *ms)
1255 struct timeval diff, finish;
1257 monotime_tv(&finish);
1258 timersub(&finish, start, &diff);
1259 *ms -= (diff.tv_sec * 1000) + (diff.tv_usec / 1000);
1263 ms_to_timeval(struct timeval *tv, int ms)
1267 tv->tv_sec = ms / 1000;
1268 tv->tv_usec = (ms % 1000) * 1000;
1272 monotime_ts(struct timespec *ts)
1275 #if defined(HAVE_CLOCK_GETTIME) && (defined(CLOCK_BOOTTIME) || \
1276 defined(CLOCK_MONOTONIC) || defined(CLOCK_REALTIME))
1277 static int gettime_failed = 0;
1279 if (!gettime_failed) {
1280 # ifdef CLOCK_BOOTTIME
1281 if (clock_gettime(CLOCK_BOOTTIME, ts) == 0)
1283 # endif /* CLOCK_BOOTTIME */
1284 # ifdef CLOCK_MONOTONIC
1285 if (clock_gettime(CLOCK_MONOTONIC, ts) == 0)
1287 # endif /* CLOCK_MONOTONIC */
1288 # ifdef CLOCK_REALTIME
1289 /* Not monotonic, but we're almost out of options here. */
1290 if (clock_gettime(CLOCK_REALTIME, ts) == 0)
1292 # endif /* CLOCK_REALTIME */
1293 debug3("clock_gettime: %s", strerror(errno));
1296 #endif /* HAVE_CLOCK_GETTIME && (BOOTTIME || MONOTONIC || REALTIME) */
1297 gettimeofday(&tv, NULL);
1298 ts->tv_sec = tv.tv_sec;
1299 ts->tv_nsec = (long)tv.tv_usec * 1000;
1303 monotime_tv(struct timeval *tv)
1308 tv->tv_sec = ts.tv_sec;
1309 tv->tv_usec = ts.tv_nsec / 1000;
1322 monotime_double(void)
1327 return ts.tv_sec + ((double)ts.tv_nsec / 1000000000);
1331 bandwidth_limit_init(struct bwlimit *bw, u_int64_t kbps, size_t buflen)
1333 bw->buflen = buflen;
1335 bw->thresh = bw->rate;
1337 timerclear(&bw->bwstart);
1338 timerclear(&bw->bwend);
1341 /* Callback from read/write loop to insert bandwidth-limiting delays */
1343 bandwidth_limit(struct bwlimit *bw, size_t read_len)
1346 struct timespec ts, rm;
1348 if (!timerisset(&bw->bwstart)) {
1349 monotime_tv(&bw->bwstart);
1353 bw->lamt += read_len;
1354 if (bw->lamt < bw->thresh)
1357 monotime_tv(&bw->bwend);
1358 timersub(&bw->bwend, &bw->bwstart, &bw->bwend);
1359 if (!timerisset(&bw->bwend))
1363 waitlen = (double)1000000L * bw->lamt / bw->rate;
1365 bw->bwstart.tv_sec = waitlen / 1000000L;
1366 bw->bwstart.tv_usec = waitlen % 1000000L;
1368 if (timercmp(&bw->bwstart, &bw->bwend, >)) {
1369 timersub(&bw->bwstart, &bw->bwend, &bw->bwend);
1371 /* Adjust the wait time */
1372 if (bw->bwend.tv_sec) {
1374 if (bw->thresh < bw->buflen / 4)
1375 bw->thresh = bw->buflen / 4;
1376 } else if (bw->bwend.tv_usec < 10000) {
1378 if (bw->thresh > bw->buflen * 8)
1379 bw->thresh = bw->buflen * 8;
1382 TIMEVAL_TO_TIMESPEC(&bw->bwend, &ts);
1383 while (nanosleep(&ts, &rm) == -1) {
1391 monotime_tv(&bw->bwstart);
1394 /* Make a template filename for mk[sd]temp() */
1396 mktemp_proto(char *s, size_t len)
1401 if ((tmpdir = getenv("TMPDIR")) != NULL) {
1402 r = snprintf(s, len, "%s/ssh-XXXXXXXXXXXX", tmpdir);
1403 if (r > 0 && (size_t)r < len)
1406 r = snprintf(s, len, "/tmp/ssh-XXXXXXXXXXXX");
1407 if (r < 0 || (size_t)r >= len)
1408 fatal("%s: template string too short", __func__);
1411 static const struct {
1415 { "none", INT_MAX }, /* can't use 0 here; that's CS0 */
1416 { "af11", IPTOS_DSCP_AF11 },
1417 { "af12", IPTOS_DSCP_AF12 },
1418 { "af13", IPTOS_DSCP_AF13 },
1419 { "af21", IPTOS_DSCP_AF21 },
1420 { "af22", IPTOS_DSCP_AF22 },
1421 { "af23", IPTOS_DSCP_AF23 },
1422 { "af31", IPTOS_DSCP_AF31 },
1423 { "af32", IPTOS_DSCP_AF32 },
1424 { "af33", IPTOS_DSCP_AF33 },
1425 { "af41", IPTOS_DSCP_AF41 },
1426 { "af42", IPTOS_DSCP_AF42 },
1427 { "af43", IPTOS_DSCP_AF43 },
1428 { "cs0", IPTOS_DSCP_CS0 },
1429 { "cs1", IPTOS_DSCP_CS1 },
1430 { "cs2", IPTOS_DSCP_CS2 },
1431 { "cs3", IPTOS_DSCP_CS3 },
1432 { "cs4", IPTOS_DSCP_CS4 },
1433 { "cs5", IPTOS_DSCP_CS5 },
1434 { "cs6", IPTOS_DSCP_CS6 },
1435 { "cs7", IPTOS_DSCP_CS7 },
1436 { "ef", IPTOS_DSCP_EF },
1437 { "lowdelay", IPTOS_LOWDELAY },
1438 { "throughput", IPTOS_THROUGHPUT },
1439 { "reliability", IPTOS_RELIABILITY },
1444 parse_ipqos(const char *cp)
1452 for (i = 0; ipqos[i].name != NULL; i++) {
1453 if (strcasecmp(cp, ipqos[i].name) == 0)
1454 return ipqos[i].value;
1456 /* Try parsing as an integer */
1457 val = strtol(cp, &ep, 0);
1458 if (*cp == '\0' || *ep != '\0' || val < 0 || val > 255)
1464 iptos2str(int iptos)
1467 static char iptos_str[sizeof "0xff"];
1469 for (i = 0; ipqos[i].name != NULL; i++) {
1470 if (ipqos[i].value == iptos)
1471 return ipqos[i].name;
1473 snprintf(iptos_str, sizeof iptos_str, "0x%02x", iptos);
1481 *s = tolower((u_char)*s);
1485 unix_listener(const char *path, int backlog, int unlink_first)
1487 struct sockaddr_un sunaddr;
1488 int saved_errno, sock;
1490 memset(&sunaddr, 0, sizeof(sunaddr));
1491 sunaddr.sun_family = AF_UNIX;
1492 if (strlcpy(sunaddr.sun_path, path,
1493 sizeof(sunaddr.sun_path)) >= sizeof(sunaddr.sun_path)) {
1494 error("%s: path \"%s\" too long for Unix domain socket",
1496 errno = ENAMETOOLONG;
1500 sock = socket(PF_UNIX, SOCK_STREAM, 0);
1502 saved_errno = errno;
1503 error("%s: socket: %.100s", __func__, strerror(errno));
1504 errno = saved_errno;
1507 if (unlink_first == 1) {
1508 if (unlink(path) != 0 && errno != ENOENT)
1509 error("unlink(%s): %.100s", path, strerror(errno));
1511 if (bind(sock, (struct sockaddr *)&sunaddr, sizeof(sunaddr)) < 0) {
1512 saved_errno = errno;
1513 error("%s: cannot bind to path %s: %s",
1514 __func__, path, strerror(errno));
1516 errno = saved_errno;
1519 if (listen(sock, backlog) < 0) {
1520 saved_errno = errno;
1521 error("%s: cannot listen on path %s: %s",
1522 __func__, path, strerror(errno));
1525 errno = saved_errno;
1532 sock_set_v6only(int s)
1534 #if defined(IPV6_V6ONLY) && !defined(__OpenBSD__)
1537 debug3("%s: set socket %d IPV6_V6ONLY", __func__, s);
1538 if (setsockopt(s, IPPROTO_IPV6, IPV6_V6ONLY, &on, sizeof(on)) == -1)
1539 error("setsockopt IPV6_V6ONLY: %s", strerror(errno));
1544 * Compares two strings that maybe be NULL. Returns non-zero if strings
1545 * are both NULL or are identical, returns zero otherwise.
1548 strcmp_maybe_null(const char *a, const char *b)
1550 if ((a == NULL && b != NULL) || (a != NULL && b == NULL))
1552 if (a != NULL && strcmp(a, b) != 0)
1558 * Compare two forwards, returning non-zero if they are identical or
1562 forward_equals(const struct Forward *a, const struct Forward *b)
1564 if (strcmp_maybe_null(a->listen_host, b->listen_host) == 0)
1566 if (a->listen_port != b->listen_port)
1568 if (strcmp_maybe_null(a->listen_path, b->listen_path) == 0)
1570 if (strcmp_maybe_null(a->connect_host, b->connect_host) == 0)
1572 if (a->connect_port != b->connect_port)
1574 if (strcmp_maybe_null(a->connect_path, b->connect_path) == 0)
1576 /* allocated_port and handle are not checked */
1580 /* returns 1 if process is already daemonized, 0 otherwise */
1586 if ((fd = open(_PATH_TTY, O_RDONLY | O_NOCTTY)) >= 0) {
1588 return 0; /* have controlling terminal */
1591 return 0; /* parent is not init */
1592 if (getsid(0) != getpid())
1593 return 0; /* not session leader */
1594 debug3("already daemonized");
1600 * Splits 's' into an argument vector. Handles quoted string and basic
1601 * escape characters (\\, \", \'). Caller must free the argument vector
1605 argv_split(const char *s, int *argcp, char ***argvp)
1607 int r = SSH_ERR_INTERNAL_ERROR;
1608 int argc = 0, quote, i, j;
1609 char *arg, **argv = xcalloc(1, sizeof(*argv));
1614 for (i = 0; s[i] != '\0'; i++) {
1615 /* Skip leading whitespace */
1616 if (s[i] == ' ' || s[i] == '\t')
1619 /* Start of a token */
1622 (s[i + 1] == '\'' || s[i + 1] == '\"' || s[i + 1] == '\\'))
1624 else if (s[i] == '\'' || s[i] == '"')
1627 argv = xreallocarray(argv, (argc + 2), sizeof(*argv));
1628 arg = argv[argc++] = xcalloc(1, strlen(s + i) + 1);
1631 /* Copy the token in, removing escapes */
1632 for (j = 0; s[i] != '\0'; i++) {
1634 if (s[i + 1] == '\'' ||
1640 /* Unrecognised escape */
1643 } else if (quote == 0 && (s[i] == ' ' || s[i] == '\t'))
1645 else if (quote != 0 && s[i] == quote)
1652 /* Ran out of string looking for close quote */
1653 r = SSH_ERR_INVALID_FORMAT;
1666 if (argc != 0 && argv != NULL) {
1667 for (i = 0; i < argc; i++)
1675 * Reassemble an argument vector into a string, quoting and escaping as
1676 * necessary. Caller must free returned string.
1679 argv_assemble(int argc, char **argv)
1683 struct sshbuf *buf, *arg;
1685 if ((buf = sshbuf_new()) == NULL || (arg = sshbuf_new()) == NULL)
1686 fatal("%s: sshbuf_new failed", __func__);
1688 for (i = 0; i < argc; i++) {
1691 for (j = 0; argv[i][j] != '\0'; j++) {
1698 r = sshbuf_put_u8(arg, c);
1703 if ((r = sshbuf_put_u8(arg, '\\')) != 0)
1707 r = sshbuf_put_u8(arg, c);
1711 fatal("%s: sshbuf_put_u8: %s",
1712 __func__, ssh_err(r));
1714 if ((i != 0 && (r = sshbuf_put_u8(buf, ' ')) != 0) ||
1715 (ws != 0 && (r = sshbuf_put_u8(buf, '"')) != 0) ||
1716 (r = sshbuf_putb(buf, arg)) != 0 ||
1717 (ws != 0 && (r = sshbuf_put_u8(buf, '"')) != 0))
1718 fatal("%s: buffer error: %s", __func__, ssh_err(r));
1720 if ((ret = malloc(sshbuf_len(buf) + 1)) == NULL)
1721 fatal("%s: malloc failed", __func__);
1722 memcpy(ret, sshbuf_ptr(buf), sshbuf_len(buf));
1723 ret[sshbuf_len(buf)] = '\0';
1729 /* Returns 0 if pid exited cleanly, non-zero otherwise */
1731 exited_cleanly(pid_t pid, const char *tag, const char *cmd, int quiet)
1735 while (waitpid(pid, &status, 0) == -1) {
1736 if (errno != EINTR) {
1737 error("%s: waitpid: %s", tag, strerror(errno));
1741 if (WIFSIGNALED(status)) {
1742 error("%s %s exited on signal %d", tag, cmd, WTERMSIG(status));
1744 } else if (WEXITSTATUS(status) != 0) {
1745 do_log2(quiet ? SYSLOG_LEVEL_DEBUG1 : SYSLOG_LEVEL_INFO,
1746 "%s %s failed, status %d", tag, cmd, WEXITSTATUS(status));
1753 * Check a given path for security. This is defined as all components
1754 * of the path to the file must be owned by either the owner of
1755 * of the file or root and no directories must be group or world writable.
1757 * XXX Should any specific check be done for sym links ?
1759 * Takes a file name, its stat information (preferably from fstat() to
1760 * avoid races), the uid of the expected owner, their home directory and an
1761 * error buffer plus max size as arguments.
1763 * Returns 0 on success and -1 on failure
1766 safe_path(const char *name, struct stat *stp, const char *pw_dir,
1767 uid_t uid, char *err, size_t errlen)
1769 char buf[PATH_MAX], homedir[PATH_MAX];
1771 int comparehome = 0;
1774 if (realpath(name, buf) == NULL) {
1775 snprintf(err, errlen, "realpath %s failed: %s", name,
1779 if (pw_dir != NULL && realpath(pw_dir, homedir) != NULL)
1782 if (!S_ISREG(stp->st_mode)) {
1783 snprintf(err, errlen, "%s is not a regular file", buf);
1786 if ((!platform_sys_dir_uid(stp->st_uid) && stp->st_uid != uid) ||
1787 (stp->st_mode & 022) != 0) {
1788 snprintf(err, errlen, "bad ownership or modes for file %s",
1793 /* for each component of the canonical path, walking upwards */
1795 if ((cp = dirname(buf)) == NULL) {
1796 snprintf(err, errlen, "dirname() failed");
1799 strlcpy(buf, cp, sizeof(buf));
1801 if (stat(buf, &st) < 0 ||
1802 (!platform_sys_dir_uid(st.st_uid) && st.st_uid != uid) ||
1803 (st.st_mode & 022) != 0) {
1804 snprintf(err, errlen,
1805 "bad ownership or modes for directory %s", buf);
1809 /* If are past the homedir then we can stop */
1810 if (comparehome && strcmp(homedir, buf) == 0)
1814 * dirname should always complete with a "/" path,
1815 * but we can be paranoid and check for "." too
1817 if ((strcmp("/", buf) == 0) || (strcmp(".", buf) == 0))
1824 * Version of safe_path() that accepts an open file descriptor to
1827 * Returns 0 on success and -1 on failure
1830 safe_path_fd(int fd, const char *file, struct passwd *pw,
1831 char *err, size_t errlen)
1835 /* check the open file to avoid races */
1836 if (fstat(fd, &st) < 0) {
1837 snprintf(err, errlen, "cannot stat file %s: %s",
1838 file, strerror(errno));
1841 return safe_path(file, &st, pw->pw_dir, pw->pw_uid, err, errlen);
1845 * Sets the value of the given variable in the environment. If the variable
1846 * already exists, its value is overridden.
1849 child_set_env(char ***envp, u_int *envsizep, const char *name,
1856 if (strchr(name, '=') != NULL) {
1857 error("Invalid environment variable \"%.100s\"", name);
1862 * If we're passed an uninitialized list, allocate a single null
1863 * entry before continuing.
1865 if (*envp == NULL && *envsizep == 0) {
1866 *envp = xmalloc(sizeof(char *));
1872 * Find the slot where the value should be stored. If the variable
1873 * already exists, we reuse the slot; otherwise we append a new slot
1874 * at the end of the array, expanding if necessary.
1877 namelen = strlen(name);
1878 for (i = 0; env[i]; i++)
1879 if (strncmp(env[i], name, namelen) == 0 && env[i][namelen] == '=')
1882 /* Reuse the slot. */
1885 /* New variable. Expand if necessary. */
1886 envsize = *envsizep;
1887 if (i >= envsize - 1) {
1888 if (envsize >= 1000)
1889 fatal("child_set_env: too many env vars");
1891 env = (*envp) = xreallocarray(env, envsize, sizeof(char *));
1892 *envsizep = envsize;
1894 /* Need to set the NULL pointer at end of array beyond the new slot. */
1898 /* Allocate space and format the variable in the appropriate slot. */
1900 env[i] = xmalloc(strlen(name) + 1 + strlen(value) + 1);
1901 snprintf(env[i], strlen(name) + 1 + strlen(value) + 1, "%s=%s", name, value);
1905 * Check and optionally lowercase a domain name, also removes trailing '.'
1906 * Returns 1 on success and 0 on failure, storing an error message in errstr.
1909 valid_domain(char *name, int makelower, const char **errstr)
1911 size_t i, l = strlen(name);
1912 u_char c, last = '\0';
1913 static char errbuf[256];
1916 strlcpy(errbuf, "empty domain name", sizeof(errbuf));
1919 if (!isalpha((u_char)name[0]) && !isdigit((u_char)name[0])) {
1920 snprintf(errbuf, sizeof(errbuf), "domain name \"%.100s\" "
1921 "starts with invalid character", name);
1924 for (i = 0; i < l; i++) {
1925 c = tolower((u_char)name[i]);
1928 if (last == '.' && c == '.') {
1929 snprintf(errbuf, sizeof(errbuf), "domain name "
1930 "\"%.100s\" contains consecutive separators", name);
1933 if (c != '.' && c != '-' && !isalnum(c) &&
1934 c != '_') /* technically invalid, but common */ {
1935 snprintf(errbuf, sizeof(errbuf), "domain name "
1936 "\"%.100s\" contains invalid characters", name);
1941 if (name[l - 1] == '.')
1953 atoi_err(const char *nptr, int *val)
1955 const char *errstr = NULL;
1958 if (nptr == NULL || *nptr == '\0')
1960 num = strtonum(nptr, 0, INT_MAX, &errstr);
1967 parse_absolute_time(const char *s, uint64_t *tp)
1976 * POSIX strptime says "The application shall ensure that there
1977 * is white-space or other non-alphanumeric characters between
1978 * any two conversion specifications" so arrange things this way.
1980 switch (strlen(s)) {
1981 case 8: /* YYYYMMDD */
1983 snprintf(buf, sizeof(buf), "%.4s-%.2s-%.2s", s, s + 4, s + 6);
1985 case 12: /* YYYYMMDDHHMM */
1986 fmt = "%Y-%m-%dT%H:%M";
1987 snprintf(buf, sizeof(buf), "%.4s-%.2s-%.2sT%.2s:%.2s",
1988 s, s + 4, s + 6, s + 8, s + 10);
1990 case 14: /* YYYYMMDDHHMMSS */
1991 fmt = "%Y-%m-%dT%H:%M:%S";
1992 snprintf(buf, sizeof(buf), "%.4s-%.2s-%.2sT%.2s:%.2s:%.2s",
1993 s, s + 4, s + 6, s + 8, s + 10, s + 12);
1996 return SSH_ERR_INVALID_FORMAT;
1999 memset(&tm, 0, sizeof(tm));
2000 if (strptime(buf, fmt, &tm) == NULL)
2001 return SSH_ERR_INVALID_FORMAT;
2002 if ((tt = mktime(&tm)) < 0)
2003 return SSH_ERR_INVALID_FORMAT;
2010 format_absolute_time(uint64_t t, char *buf, size_t len)
2012 time_t tt = t > INT_MAX ? INT_MAX : t; /* XXX revisit in 2038 :P */
2015 localtime_r(&tt, &tm);
2016 strftime(buf, len, "%Y-%m-%dT%H:%M:%S", &tm);