]> andersk Git - openssh.git/blame - misc.c
- djm@cvs.openbsd.org 2006/03/22 21:27:15
[openssh.git] / misc.c
CommitLineData
bcbf86ec 1/*
2 * Copyright (c) 2000 Markus Friedl. All rights reserved.
a980cbd7 3 * Copyright (c) 2005 Damien Miller. All rights reserved.
bcbf86ec 4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
6d24277f 26#include "includes.h"
bd7c69ea 27
28#include <sys/ioctl.h>
6425cf65 29#include <netinet/tcp.h>
a75f5360 30#ifdef HAVE_PATHS_H
6f61e0ec 31# include <paths.h>
a75f5360 32#endif
1f1fbbd8 33#ifdef SSH_TUN_OPENBSD
34#include <net/if.h>
35#endif
6d24277f 36
1aa00dcb 37#include "misc.h"
42f11eb2 38#include "log.h"
4ab21f86 39#include "xmalloc.h"
6d24277f 40
255cabd9 41/* remove newline at end of string */
6d24277f 42char *
43chop(char *s)
44{
45 char *t = s;
46 while (*t) {
6aacefa7 47 if (*t == '\n' || *t == '\r') {
6d24277f 48 *t = '\0';
49 return s;
50 }
51 t++;
52 }
53 return s;
54
55}
56
255cabd9 57/* set/unset filedescriptor to non-blocking */
170694d7 58int
6d24277f 59set_nonblock(int fd)
60{
61 int val;
89aa792b 62
6d24277f 63 val = fcntl(fd, F_GETFL, 0);
64 if (val < 0) {
65 error("fcntl(%d, F_GETFL, 0): %s", fd, strerror(errno));
170694d7 66 return (-1);
6d24277f 67 }
a22aff1f 68 if (val & O_NONBLOCK) {
170694d7 69 debug3("fd %d is O_NONBLOCK", fd);
70 return (0);
a22aff1f 71 }
45c42d58 72 debug2("fd %d setting O_NONBLOCK", fd);
6d24277f 73 val |= O_NONBLOCK;
170694d7 74 if (fcntl(fd, F_SETFL, val) == -1) {
75 debug("fcntl(%d, F_SETFL, O_NONBLOCK): %s", fd,
76 strerror(errno));
77 return (-1);
78 }
79 return (0);
6d24277f 80}
81
170694d7 82int
89aa792b 83unset_nonblock(int fd)
84{
85 int val;
86
87 val = fcntl(fd, F_GETFL, 0);
88 if (val < 0) {
89 error("fcntl(%d, F_GETFL, 0): %s", fd, strerror(errno));
170694d7 90 return (-1);
89aa792b 91 }
92 if (!(val & O_NONBLOCK)) {
170694d7 93 debug3("fd %d is not O_NONBLOCK", fd);
94 return (0);
89aa792b 95 }
e04e7a19 96 debug("fd %d clearing O_NONBLOCK", fd);
89aa792b 97 val &= ~O_NONBLOCK;
170694d7 98 if (fcntl(fd, F_SETFL, val) == -1) {
99 debug("fcntl(%d, F_SETFL, ~O_NONBLOCK): %s",
c92ec40b 100 fd, strerror(errno));
170694d7 101 return (-1);
102 }
103 return (0);
89aa792b 104}
105
bcc0381e 106/* disable nagle on socket */
107void
108set_nodelay(int fd)
109{
3c05447a 110 int opt;
111 socklen_t optlen;
bcc0381e 112
811a6342 113 optlen = sizeof opt;
114 if (getsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &opt, &optlen) == -1) {
f7fb35fe 115 debug("getsockopt TCP_NODELAY: %.100s", strerror(errno));
811a6342 116 return;
117 }
118 if (opt == 1) {
119 debug2("fd %d is TCP_NODELAY", fd);
120 return;
121 }
122 opt = 1;
6226a8f8 123 debug2("fd %d setting TCP_NODELAY", fd);
811a6342 124 if (setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &opt, sizeof opt) == -1)
bcc0381e 125 error("setsockopt TCP_NODELAY: %.100s", strerror(errno));
126}
127
6d24277f 128/* Characters considered whitespace in strsep calls. */
129#define WHITESPACE " \t\r\n"
533b9133 130#define QUOTE "\""
6d24277f 131
255cabd9 132/* return next token in configuration line */
6d24277f 133char *
134strdelim(char **s)
135{
136 char *old;
137 int wspace = 0;
138
139 if (*s == NULL)
140 return NULL;
141
142 old = *s;
143
533b9133 144 *s = strpbrk(*s, WHITESPACE QUOTE "=");
6d24277f 145 if (*s == NULL)
146 return (old);
147
533b9133 148 if (*s[0] == '\"') {
149 memmove(*s, *s + 1, strlen(*s)); /* move nul too */
150 /* Find matching quote */
151 if ((*s = strpbrk(*s, QUOTE)) == NULL) {
152 return (NULL); /* no matching quote */
153 } else {
154 *s[0] = '\0';
155 return (old);
156 }
157 }
158
6d24277f 159 /* Allow only one '=' to be skipped */
160 if (*s[0] == '=')
161 wspace = 1;
162 *s[0] = '\0';
163
533b9133 164 /* Skip any extra whitespace after first token */
6d24277f 165 *s += strspn(*s + 1, WHITESPACE) + 1;
166 if (*s[0] == '=' && !wspace)
167 *s += strspn(*s + 1, WHITESPACE) + 1;
168
169 return (old);
170}
1aa00dcb 171
3b1a83df 172struct passwd *
173pwcopy(struct passwd *pw)
174{
175 struct passwd *copy = xmalloc(sizeof(*copy));
5649fbbe 176
3b1a83df 177 memset(copy, 0, sizeof(*copy));
178 copy->pw_name = xstrdup(pw->pw_name);
179 copy->pw_passwd = xstrdup(pw->pw_passwd);
5649fbbe 180 copy->pw_gecos = xstrdup(pw->pw_gecos);
3b1a83df 181 copy->pw_uid = pw->pw_uid;
182 copy->pw_gid = pw->pw_gid;
7751d4eb 183#ifdef HAVE_PW_EXPIRE_IN_PASSWD
c4d49b85 184 copy->pw_expire = pw->pw_expire;
7751d4eb 185#endif
186#ifdef HAVE_PW_CHANGE_IN_PASSWD
c4d49b85 187 copy->pw_change = pw->pw_change;
7751d4eb 188#endif
2605addd 189#ifdef HAVE_PW_CLASS_IN_PASSWD
3b1a83df 190 copy->pw_class = xstrdup(pw->pw_class);
2605addd 191#endif
3b1a83df 192 copy->pw_dir = xstrdup(pw->pw_dir);
193 copy->pw_shell = xstrdup(pw->pw_shell);
194 return copy;
195}
196
255cabd9 197/*
198 * Convert ASCII string to TCP/IP port number.
199 * Port must be >0 and <=65535.
200 * Return 0 if invalid.
201 */
202int
203a2port(const char *s)
2d2a2c65 204{
205 long port;
206 char *endp;
207
208 errno = 0;
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)
213 return 0;
214
215 return port;
216}
217
d20f3c9e 218int
219a2tun(const char *s, int *remote)
220{
221 const char *errstr = NULL;
222 char *sp, *ep;
223 int tun;
224
225 if (remote != NULL) {
a4f24bf8 226 *remote = SSH_TUNID_ANY;
d20f3c9e 227 sp = xstrdup(s);
228 if ((ep = strchr(sp, ':')) == NULL) {
229 xfree(sp);
230 return (a2tun(s, NULL));
231 }
232 ep[0] = '\0'; ep++;
233 *remote = a2tun(ep, NULL);
234 tun = a2tun(sp, NULL);
235 xfree(sp);
a4f24bf8 236 return (*remote == SSH_TUNID_ERR ? *remote : tun);
d20f3c9e 237 }
238
239 if (strcasecmp(s, "any") == 0)
a4f24bf8 240 return (SSH_TUNID_ANY);
d20f3c9e 241
a4f24bf8 242 tun = strtonum(s, 0, SSH_TUNID_MAX, &errstr);
243 if (errstr != NULL)
244 return (SSH_TUNID_ERR);
d20f3c9e 245
246 return (tun);
247}
248
e2b1fb42 249#define SECONDS 1
250#define MINUTES (SECONDS * 60)
251#define HOURS (MINUTES * 60)
252#define DAYS (HOURS * 24)
253#define WEEKS (DAYS * 7)
254
255cabd9 255/*
256 * Convert a time string into seconds; format is
257 * a sequence of:
258 * time[qualifier]
259 *
260 * Valid time qualifiers are:
261 * <none> seconds
262 * s|S seconds
263 * m|M minutes
264 * h|H hours
265 * d|D days
266 * w|W weeks
267 *
268 * Examples:
269 * 90m 90 minutes
270 * 1h30m 90 minutes
271 * 2d 2 days
272 * 1w 1 week
273 *
274 * Return -1 if time string is invalid.
275 */
276long
277convtime(const char *s)
e2b1fb42 278{
279 long total, secs;
280 const char *p;
281 char *endp;
282
283 errno = 0;
284 total = 0;
285 p = s;
286
287 if (p == NULL || *p == '\0')
288 return -1;
289
290 while (*p) {
291 secs = strtol(p, &endp, 10);
292 if (p == endp ||
293 (errno == ERANGE && (secs == LONG_MIN || secs == LONG_MAX)) ||
294 secs < 0)
295 return -1;
296
297 switch (*endp++) {
298 case '\0':
299 endp--;
5ef36928 300 break;
e2b1fb42 301 case 's':
302 case 'S':
303 break;
304 case 'm':
305 case 'M':
306 secs *= MINUTES;
307 break;
308 case 'h':
309 case 'H':
310 secs *= HOURS;
311 break;
312 case 'd':
313 case 'D':
314 secs *= DAYS;
315 break;
316 case 'w':
317 case 'W':
318 secs *= WEEKS;
319 break;
320 default:
321 return -1;
322 }
323 total += secs;
324 if (total < 0)
325 return -1;
326 p = endp;
327 }
328
329 return total;
330}
331
3867aa0a 332/*
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.
338 */
339char *
340hpdelim(char **cp)
341{
342 char *s, *old;
343
344 if (cp == NULL || *cp == NULL)
345 return NULL;
346
347 old = s = *cp;
348 if (*s == '[') {
349 if ((s = strchr(s, ']')) == NULL)
350 return NULL;
351 else
352 s++;
353 } else if ((s = strpbrk(s, ":/")) == NULL)
354 s = *cp + strlen(*cp); /* skip to end (see first case below) */
355
356 switch (*s) {
357 case '\0':
358 *cp = NULL; /* no more fields*/
359 break;
f8cc7664 360
3867aa0a 361 case ':':
362 case '/':
363 *s = '\0'; /* terminate */
364 *cp = s + 1;
365 break;
f8cc7664 366
3867aa0a 367 default:
368 return NULL;
369 }
370
371 return old;
372}
373
1fcde3fe 374char *
375cleanhostname(char *host)
376{
377 if (*host == '[' && host[strlen(host) - 1] == ']') {
378 host[strlen(host) - 1] = '\0';
379 return (host + 1);
380 } else
381 return host;
382}
383
384char *
385colon(char *cp)
386{
387 int flag = 0;
388
389 if (*cp == ':') /* Leading colon is part of file name. */
390 return (0);
391 if (*cp == '[')
392 flag = 1;
393
394 for (; *cp; ++cp) {
395 if (*cp == '@' && *(cp+1) == '[')
396 flag = 1;
397 if (*cp == ']' && *(cp+1) == ':' && flag)
398 return (cp+1);
399 if (*cp == ':' && !flag)
400 return (cp);
401 if (*cp == '/')
402 return (0);
403 }
404 return (0);
405}
406
255cabd9 407/* function to assist building execv() arguments */
8a624ebf 408void
409addargs(arglist *args, char *fmt, ...)
410{
411 va_list ap;
4116f5c0 412 char *cp;
9a995072 413 u_int nalloc;
4116f5c0 414 int r;
8a624ebf 415
416 va_start(ap, fmt);
4116f5c0 417 r = vasprintf(&cp, fmt, ap);
8a624ebf 418 va_end(ap);
4116f5c0 419 if (r == -1)
420 fatal("addargs: argument too long");
8a624ebf 421
c46e584f 422 nalloc = args->nalloc;
8a624ebf 423 if (args->list == NULL) {
c46e584f 424 nalloc = 32;
8a624ebf 425 args->num = 0;
c46e584f 426 } else if (args->num+2 >= nalloc)
427 nalloc *= 2;
8a624ebf 428
c46e584f 429 args->list = xrealloc(args->list, nalloc * sizeof(char *));
430 args->nalloc = nalloc;
4116f5c0 431 args->list[args->num++] = cp;
8a624ebf 432 args->list[args->num] = NULL;
433}
ea067773 434
4116f5c0 435void
436replacearg(arglist *args, u_int which, char *fmt, ...)
437{
438 va_list ap;
439 char *cp;
440 int r;
441
442 va_start(ap, fmt);
443 r = vasprintf(&cp, fmt, ap);
444 va_end(ap);
445 if (r == -1)
446 fatal("replacearg: argument too long");
447
448 if (which >= args->num)
449 fatal("replacearg: tried to replace invalid arg %d >= %d",
450 which, args->num);
451 xfree(args->list[which]);
452 args->list[which] = cp;
453}
454
455void
456freeargs(arglist *args)
457{
458 u_int i;
459
460 if (args->list != NULL) {
461 for (i = 0; i < args->num; i++)
462 xfree(args->list[i]);
463 xfree(args->list);
464 args->nalloc = args->num = 0;
465 args->list = NULL;
466 }
467}
468
49e71137 469/*
470 * Expands tildes in the file name. Returns data allocated by xmalloc.
471 * Warning: this calls getpw*.
472 */
473char *
474tilde_expand_filename(const char *filename, uid_t uid)
475{
476 const char *path;
477 char user[128], ret[MAXPATHLEN];
478 struct passwd *pw;
2ceb8101 479 u_int len, slash;
49e71137 480
481 if (*filename != '~')
482 return (xstrdup(filename));
483 filename++;
484
485 path = strchr(filename, '/');
486 if (path != NULL && path > filename) { /* ~user/path */
2ceb8101 487 slash = path - filename;
488 if (slash > sizeof(user) - 1)
49e71137 489 fatal("tilde_expand_filename: ~username too long");
2ceb8101 490 memcpy(user, filename, slash);
491 user[slash] = '\0';
49e71137 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);
496
497 if (strlcpy(ret, pw->pw_dir, sizeof(ret)) >= sizeof(ret))
498 fatal("tilde_expand_filename: Path too long");
499
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");
505
506 /* Skip leading '/' from specified path */
507 if (path != NULL)
508 filename = path + 1;
509 if (strlcat(ret, filename, sizeof(ret)) >= sizeof(ret))
510 fatal("tilde_expand_filename: Path too long");
511
512 return (xstrdup(ret));
513}
514
a980cbd7 515/*
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
6381acf0 518 * be terminated by a NULL escape_char. Returns replaced string in memory
a980cbd7 519 * allocated by xmalloc.
520 */
521char *
522percent_expand(const char *string, ...)
523{
524#define EXPAND_MAX_KEYS 16
525 struct {
526 const char *key;
527 const char *repl;
528 } keys[EXPAND_MAX_KEYS];
2ceb8101 529 u_int num_keys, i, j;
a980cbd7 530 char buf[4096];
531 va_list ap;
532
533 /* Gather keys */
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)
538 break;
539 keys[num_keys].repl = va_arg(ap, char *);
540 if (keys[num_keys].repl == NULL)
541 fatal("percent_expand: NULL replacement");
542 }
543 va_end(ap);
544
545 if (num_keys >= EXPAND_MAX_KEYS)
546 fatal("percent_expand: too many keys");
547
548 /* Expand string */
549 *buf = '\0';
550 for (i = 0; *string != '\0'; string++) {
551 if (*string != '%') {
552 append:
553 buf[i++] = *string;
554 if (i >= sizeof(buf))
555 fatal("percent_expand: string too long");
556 buf[i] = '\0';
557 continue;
558 }
559 string++;
560 if (*string == '%')
561 goto append;
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");
567 break;
568 }
569 }
570 if (j >= num_keys)
571 fatal("percent_expand: unknown key %%%c", *string);
572 }
573 return (xstrdup(buf));
574#undef EXPAND_MAX_KEYS
575}
576
ea067773 577/*
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.
580 */
581int
582read_keyfile_line(FILE *f, const char *filename, char *buf, size_t bufsz,
41feb690 583 u_long *lineno)
ea067773 584{
585 while (fgets(buf, bufsz, f) != NULL) {
586 (*lineno)++;
587 if (buf[strlen(buf) - 1] == '\n' || feof(f)) {
588 return 0;
589 } else {
41feb690 590 debug("%s: %s line %lu exceeds size limit", __func__,
591 filename, *lineno);
ea067773 592 /* discard remainder of line */
f8cc7664 593 while (fgetc(f) != '\n' && !feof(f))
ea067773 594 ; /* nothing */
595 }
596 }
597 return -1;
598}
ef07103c 599
d20f3c9e 600int
a4f24bf8 601tun_open(int tun, int mode)
d20f3c9e 602{
6306853a 603#if defined(CUSTOM_SYS_TUN_OPEN)
604 return (sys_tun_open(tun, mode));
0f6cb079 605#elif defined(SSH_TUN_OPENBSD)
a4f24bf8 606 struct ifreq ifr;
d20f3c9e 607 char name[100];
a4f24bf8 608 int fd = -1, sock;
d20f3c9e 609
a4f24bf8 610 /* Open the tunnel device */
611 if (tun <= SSH_TUNID_MAX) {
d20f3c9e 612 snprintf(name, sizeof(name), "/dev/tun%d", tun);
a4f24bf8 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)
618 break;
d20f3c9e 619 }
620 } else {
81c042a3 621 debug("%s: invalid tunnel %u", __func__, tun);
a4f24bf8 622 return (-1);
623 }
624
625 if (fd < 0) {
626 debug("%s: %s open failed: %s", __func__, name, strerror(errno));
627 return (-1);
628 }
629
630 debug("%s: %s mode %d fd %d", __func__, name, mode, fd);
631
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)
635 goto failed;
636
637 if (ioctl(sock, SIOCGIFFLAGS, &ifr) == -1)
638 goto failed;
b1b65311 639
640 /* Set interface mode */
641 ifr.ifr_flags &= ~IFF_UP;
642 if (mode == SSH_TUNMODE_ETHERNET)
a4f24bf8 643 ifr.ifr_flags |= IFF_LINK0;
b1b65311 644 else
645 ifr.ifr_flags &= ~IFF_LINK0;
646 if (ioctl(sock, SIOCSIFFLAGS, &ifr) == -1)
647 goto failed;
648
649 /* Bring interface up */
a4f24bf8 650 ifr.ifr_flags |= IFF_UP;
651 if (ioctl(sock, SIOCSIFFLAGS, &ifr) == -1)
652 goto failed;
653
654 close(sock);
655 return (fd);
656
657 failed:
658 if (fd >= 0)
659 close(fd);
660 if (sock >= 0)
661 close(sock);
662 debug("%s: failed to set %s mode %d: %s", __func__, name,
663 mode, strerror(errno));
d20f3c9e 664 return (-1);
6306853a 665#else
666 error("Tunnel interfaces are not supported on this platform");
667 return (-1);
668#endif
d20f3c9e 669}
670
fd6168c1 671void
672sanitise_stdfd(void)
673{
db382686 674 int nullfd, dupfd;
fd6168c1 675
db382686 676 if ((nullfd = dupfd = open(_PATH_DEVNULL, O_RDWR)) == -1) {
fd6168c1 677 fprintf(stderr, "Couldn't open /dev/null: %s", strerror(errno));
678 exit(1);
679 }
db382686 680 while (++dupfd <= 2) {
681 /* Only clobber closed fds */
682 if (fcntl(dupfd, F_GETFL, 0) >= 0)
683 continue;
684 if (dup2(nullfd, dupfd) == -1) {
fd6168c1 685 fprintf(stderr, "dup2: %s", strerror(errno));
686 exit(1);
687 }
fd6168c1 688 }
689 if (nullfd > 2)
690 close(nullfd);
691}
692
ef07103c 693char *
694tohex(const u_char *d, u_int l)
695{
696 char b[3], *r;
697 u_int i, hl;
698
699 hl = l * 2 + 1;
700 r = xmalloc(hl);
701 *r = '\0';
702 for (i = 0; i < l; i++) {
703 snprintf(b, sizeof(b), "%02x", d[i]);
704 strlcat(r, b, hl);
705 }
706 return (r);
707}
708
This page took 0.392855 seconds and 5 git commands to generate.