misc.c

   1 /*
   2  * Copyright (c) 2000 Markus Friedl.  All rights reserved.
   3  * Copyright (c) 2005 Damien Miller.  All rights reserved.
   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
  26 #include "includes.h"
  27 RCSID("$OpenBSD: misc.c,v 1.44 2006/02/08 12:32:49 stevesk Exp $");
  28
  29 #include <netinet/tcp.h>
  30 #ifdef HAVE_PATHS_H
  31 # include <paths.h>
  32 #endif
  33 #ifdef SSH_TUN_OPENBSD
  34 #include <net/if.h>
  35 #endif
  36
  37 #include "misc.h"
  38 #include "log.h"
  39 #include "xmalloc.h"
  40
  41 /* remove newline at end of string */
  42 char *
  43 chop(char *s)
  44 {
  45         char *t = s;
  46         while (*t) {
  47                 if (*t == '\n' || *t == '\r') {
  48                         *t = '\0';
  49                         return s;
  50                 }
  51                 t++;
  52         }
  53         return s;
  54
  55 }
  56
  57 /* set/unset filedescriptor to non-blocking */
  58 int
  59 set_nonblock(int fd)
  60 {
  61         int val;
  62
  63         val = fcntl(fd, F_GETFL, 0);
  64         if (val < 0) {
  65                 error("fcntl(%d, F_GETFL, 0): %s", fd, strerror(errno));
  66                 return (-1);
  67         }
  68         if (val & O_NONBLOCK) {
  69                 debug3("fd %d is O_NONBLOCK", fd);
  70                 return (0);
  71         }
  72         debug2("fd %d setting O_NONBLOCK", fd);
  73         val |= O_NONBLOCK;
  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);
  80 }
  81
  82 int
  83 unset_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));
  90                 return (-1);
  91         }
  92         if (!(val & O_NONBLOCK)) {
  93                 debug3("fd %d is not O_NONBLOCK", fd);
  94                 return (0);
  95         }
  96         debug("fd %d clearing O_NONBLOCK", fd);
  97         val &= ~O_NONBLOCK;
  98         if (fcntl(fd, F_SETFL, val) == -1) {
  99                 debug("fcntl(%d, F_SETFL, ~O_NONBLOCK): %s",
 100                     fd, strerror(errno));
 101                 return (-1);
 102         }
 103         return (0);
 104 }
 105
 106 /* disable nagle on socket */
 107 void
 108 set_nodelay(int fd)
 109 {
 110         int opt;
 111         socklen_t optlen;
 112
 113         optlen = sizeof opt;
 114         if (getsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &opt, &optlen) == -1) {
 115                 debug("getsockopt TCP_NODELAY: %.100s", strerror(errno));
 116                 return;
 117         }
 118         if (opt == 1) {
 119                 debug2("fd %d is TCP_NODELAY", fd);
 120                 return;
 121         }
 122         opt = 1;
 123         debug2("fd %d setting TCP_NODELAY", fd);
 124         if (setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &opt, sizeof opt) == -1)
 125                 error("setsockopt TCP_NODELAY: %.100s", strerror(errno));
 126 }
 127
 128 /* Characters considered whitespace in strsep calls. */
 129 #define WHITESPACE " \t\r\n"
 130
 131 /* return next token in configuration line */
 132 char *
 133 strdelim(char **s)
 134 {
 135         char *old;
 136         int wspace = 0;
 137
 138         if (*s == NULL)
 139                 return NULL;
 140
 141         old = *s;
 142
 143         *s = strpbrk(*s, WHITESPACE "=");
 144         if (*s == NULL)
 145                 return (old);
 146
 147         /* Allow only one '=' to be skipped */
 148         if (*s[0] == '=')
 149                 wspace = 1;
 150         *s[0] = '\0';
 151
 152         *s += strspn(*s + 1, WHITESPACE) + 1;
 153         if (*s[0] == '=' && !wspace)
 154                 *s += strspn(*s + 1, WHITESPACE) + 1;
 155
 156         return (old);
 157 }
 158
 159 struct passwd *
 160 pwcopy(struct passwd *pw)
 161 {
 162         struct passwd *copy = xmalloc(sizeof(*copy));
 163
 164         memset(copy, 0, sizeof(*copy));
 165         copy->pw_name = xstrdup(pw->pw_name);
 166         copy->pw_passwd = xstrdup(pw->pw_passwd);
 167         copy->pw_gecos = xstrdup(pw->pw_gecos);
 168         copy->pw_uid = pw->pw_uid;
 169         copy->pw_gid = pw->pw_gid;
 170 #ifdef HAVE_PW_EXPIRE_IN_PASSWD
 171         copy->pw_expire = pw->pw_expire;
 172 #endif
 173 #ifdef HAVE_PW_CHANGE_IN_PASSWD
 174         copy->pw_change = pw->pw_change;
 175 #endif
 176 #ifdef HAVE_PW_CLASS_IN_PASSWD
 177         copy->pw_class = xstrdup(pw->pw_class);
 178 #endif
 179         copy->pw_dir = xstrdup(pw->pw_dir);
 180         copy->pw_shell = xstrdup(pw->pw_shell);
 181         return copy;
 182 }
 183
 184 /*
 185  * Convert ASCII string to TCP/IP port number.
 186  * Port must be >0 and <=65535.
 187  * Return 0 if invalid.
 188  */
 189 int
 190 a2port(const char *s)
 191 {
 192         long port;
 193         char *endp;
 194
 195         errno = 0;
 196         port = strtol(s, &endp, 0);
 197         if (s == endp || *endp != '\0' ||
 198             (errno == ERANGE && (port == LONG_MIN || port == LONG_MAX)) ||
 199             port <= 0 || port > 65535)
 200                 return 0;
 201
 202         return port;
 203 }
 204
 205 int
 206 a2tun(const char *s, int *remote)
 207 {
 208         const char *errstr = NULL;
 209         char *sp, *ep;
 210         int tun;
 211
 212         if (remote != NULL) {
 213                 *remote = SSH_TUNID_ANY;
 214                 sp = xstrdup(s);
 215                 if ((ep = strchr(sp, ':')) == NULL) {
 216                         xfree(sp);
 217                         return (a2tun(s, NULL));
 218                 }
 219                 ep[0] = '\0'; ep++;
 220                 *remote = a2tun(ep, NULL);
 221                 tun = a2tun(sp, NULL);
 222                 xfree(sp);
 223                 return (*remote == SSH_TUNID_ERR ? *remote : tun);
 224         }
 225
 226         if (strcasecmp(s, "any") == 0)
 227                 return (SSH_TUNID_ANY);
 228
 229         tun = strtonum(s, 0, SSH_TUNID_MAX, &errstr);
 230         if (errstr != NULL)
 231                 return (SSH_TUNID_ERR);
 232
 233         return (tun);
 234 }
 235
 236 #define SECONDS         1
 237 #define MINUTES         (SECONDS * 60)
 238 #define HOURS           (MINUTES * 60)
 239 #define DAYS            (HOURS * 24)
 240 #define WEEKS           (DAYS * 7)
 241
 242 /*
 243  * Convert a time string into seconds; format is
 244  * a sequence of:
 245  *      time[qualifier]
 246  *
 247  * Valid time qualifiers are:
 248  *      <none>  seconds
 249  *      s|S     seconds
 250  *      m|M     minutes
 251  *      h|H     hours
 252  *      d|D     days
 253  *      w|W     weeks
 254  *
 255  * Examples:
 256  *      90m     90 minutes
 257  *      1h30m   90 minutes
 258  *      2d      2 days
 259  *      1w      1 week
 260  *
 261  * Return -1 if time string is invalid.
 262  */
 263 long
 264 convtime(const char *s)
 265 {
 266         long total, secs;
 267         const char *p;
 268         char *endp;
 269
 270         errno = 0;
 271         total = 0;
 272         p = s;
 273
 274         if (p == NULL || *p == '\0')
 275                 return -1;
 276
 277         while (*p) {
 278                 secs = strtol(p, &endp, 10);
 279                 if (p == endp ||
 280                     (errno == ERANGE && (secs == LONG_MIN || secs == LONG_MAX)) ||
 281                     secs < 0)
 282                         return -1;
 283
 284                 switch (*endp++) {
 285                 case '\0':
 286                         endp--;
 287                 case 's':
 288                 case 'S':
 289                         break;
 290                 case 'm':
 291                 case 'M':
 292                         secs *= MINUTES;
 293                         break;
 294                 case 'h':
 295                 case 'H':
 296                         secs *= HOURS;
 297                         break;
 298                 case 'd':
 299                 case 'D':
 300                         secs *= DAYS;
 301                         break;
 302                 case 'w':
 303                 case 'W':
 304                         secs *= WEEKS;
 305                         break;
 306                 default:
 307                         return -1;
 308                 }
 309                 total += secs;
 310                 if (total < 0)
 311                         return -1;
 312                 p = endp;
 313         }
 314
 315         return total;
 316 }
 317
 318 /*
 319  * Search for next delimiter between hostnames/addresses and ports.
 320  * Argument may be modified (for termination).
 321  * Returns *cp if parsing succeeds.
 322  * *cp is set to the start of the next delimiter, if one was found.
 323  * If this is the last field, *cp is set to NULL.
 324  */
 325 char *
 326 hpdelim(char **cp)
 327 {
 328         char *s, *old;
 329
 330         if (cp == NULL || *cp == NULL)
 331                 return NULL;
 332
 333         old = s = *cp;
 334         if (*s == '[') {
 335                 if ((s = strchr(s, ']')) == NULL)
 336                         return NULL;
 337                 else
 338                         s++;
 339         } else if ((s = strpbrk(s, ":/")) == NULL)
 340                 s = *cp + strlen(*cp); /* skip to end (see first case below) */
 341
 342         switch (*s) {
 343         case '\0':
 344                 *cp = NULL;     /* no more fields*/
 345                 break;
 346
 347         case ':':
 348         case '/':
 349                 *s = '\0';      /* terminate */
 350                 *cp = s + 1;
 351                 break;
 352
 353         default:
 354                 return NULL;
 355         }
 356
 357         return old;
 358 }
 359
 360 char *
 361 cleanhostname(char *host)
 362 {
 363         if (*host == '[' && host[strlen(host) - 1] == ']') {
 364                 host[strlen(host) - 1] = '\0';
 365                 return (host + 1);
 366         } else
 367                 return host;
 368 }
 369
 370 char *
 371 colon(char *cp)
 372 {
 373         int flag = 0;
 374
 375         if (*cp == ':')         /* Leading colon is part of file name. */
 376                 return (0);
 377         if (*cp == '[')
 378                 flag = 1;
 379
 380         for (; *cp; ++cp) {
 381                 if (*cp == '@' && *(cp+1) == '[')
 382                         flag = 1;
 383                 if (*cp == ']' && *(cp+1) == ':' && flag)
 384                         return (cp+1);
 385                 if (*cp == ':' && !flag)
 386                         return (cp);
 387                 if (*cp == '/')
 388                         return (0);
 389         }
 390         return (0);
 391 }
 392
 393 /* function to assist building execv() arguments */
 394 void
 395 addargs(arglist *args, char *fmt, ...)
 396 {
 397         va_list ap;
 398         char *cp;
 399         u_int nalloc;
 400         int r;
 401
 402         va_start(ap, fmt);
 403         r = vasprintf(&cp, fmt, ap);
 404         va_end(ap);
 405         if (r == -1)
 406                 fatal("addargs: argument too long");
 407
 408         nalloc = args->nalloc;
 409         if (args->list == NULL) {
 410                 nalloc = 32;
 411                 args->num = 0;
 412         } else if (args->num+2 >= nalloc)
 413                 nalloc *= 2;
 414
 415         args->list = xrealloc(args->list, nalloc * sizeof(char *));
 416         args->nalloc = nalloc;
 417         args->list[args->num++] = cp;
 418         args->list[args->num] = NULL;
 419 }
 420
 421 void
 422 replacearg(arglist *args, u_int which, char *fmt, ...)
 423 {
 424         va_list ap;
 425         char *cp;
 426         int r;
 427
 428         va_start(ap, fmt);
 429         r = vasprintf(&cp, fmt, ap);
 430         va_end(ap);
 431         if (r == -1)
 432                 fatal("replacearg: argument too long");
 433
 434         if (which >= args->num)
 435                 fatal("replacearg: tried to replace invalid arg %d >= %d",
 436                     which, args->num);
 437         xfree(args->list[which]);
 438         args->list[which] = cp;
 439 }
 440
 441 void
 442 freeargs(arglist *args)
 443 {
 444         u_int i;
 445
 446         if (args->list != NULL) {
 447                 for (i = 0; i < args->num; i++)
 448                         xfree(args->list[i]);
 449                 xfree(args->list);
 450                 args->nalloc = args->num = 0;
 451                 args->list = NULL;
 452         }
 453 }
 454
 455 /*
 456  * Expands tildes in the file name.  Returns data allocated by xmalloc.
 457  * Warning: this calls getpw*.
 458  */
 459 char *
 460 tilde_expand_filename(const char *filename, uid_t uid)
 461 {
 462         const char *path;
 463         char user[128], ret[MAXPATHLEN];
 464         struct passwd *pw;
 465         u_int len, slash;
 466
 467         if (*filename != '~')
 468                 return (xstrdup(filename));
 469         filename++;
 470
 471         path = strchr(filename, '/');
 472         if (path != NULL && path > filename) {          /* ~user/path */
 473                 slash = path - filename;
 474                 if (slash > sizeof(user) - 1)
 475                         fatal("tilde_expand_filename: ~username too long");
 476                 memcpy(user, filename, slash);
 477                 user[slash] = '\0';
 478                 if ((pw = getpwnam(user)) == NULL)
 479                         fatal("tilde_expand_filename: No such user %s", user);
 480         } else if ((pw = getpwuid(uid)) == NULL)        /* ~/path */
 481                 fatal("tilde_expand_filename: No such uid %d", uid);
 482
 483         if (strlcpy(ret, pw->pw_dir, sizeof(ret)) >= sizeof(ret))
 484                 fatal("tilde_expand_filename: Path too long");
 485
 486         /* Make sure directory has a trailing '/' */
 487         len = strlen(pw->pw_dir);
 488         if ((len == 0 || pw->pw_dir[len - 1] != '/') &&
 489             strlcat(ret, "/", sizeof(ret)) >= sizeof(ret))
 490                 fatal("tilde_expand_filename: Path too long");
 491
 492         /* Skip leading '/' from specified path */
 493         if (path != NULL)
 494                 filename = path + 1;
 495         if (strlcat(ret, filename, sizeof(ret)) >= sizeof(ret))
 496                 fatal("tilde_expand_filename: Path too long");
 497
 498         return (xstrdup(ret));
 499 }
 500
 501 /*
 502  * Expand a string with a set of %[char] escapes. A number of escapes may be
 503  * specified as (char *escape_chars, char *replacement) pairs. The list must
 504  * be terminated by a NULL escape_char. Returns replaced string in memory
 505  * allocated by xmalloc.
 506  */
 507 char *
 508 percent_expand(const char *string, ...)
 509 {
 510 #define EXPAND_MAX_KEYS 16
 511         struct {
 512                 const char *key;
 513                 const char *repl;
 514         } keys[EXPAND_MAX_KEYS];
 515         u_int num_keys, i, j;
 516         char buf[4096];
 517         va_list ap;
 518
 519         /* Gather keys */
 520         va_start(ap, string);
 521         for (num_keys = 0; num_keys < EXPAND_MAX_KEYS; num_keys++) {
 522                 keys[num_keys].key = va_arg(ap, char *);
 523                 if (keys[num_keys].key == NULL)
 524                         break;
 525                 keys[num_keys].repl = va_arg(ap, char *);
 526                 if (keys[num_keys].repl == NULL)
 527                         fatal("percent_expand: NULL replacement");
 528         }
 529         va_end(ap);
 530
 531         if (num_keys >= EXPAND_MAX_KEYS)
 532                 fatal("percent_expand: too many keys");
 533
 534         /* Expand string */
 535         *buf = '\0';
 536         for (i = 0; *string != '\0'; string++) {
 537                 if (*string != '%') {
 538  append:
 539                         buf[i++] = *string;
 540                         if (i >= sizeof(buf))
 541                                 fatal("percent_expand: string too long");
 542                         buf[i] = '\0';
 543                         continue;
 544                 }
 545                 string++;
 546                 if (*string == '%')
 547                         goto append;
 548                 for (j = 0; j < num_keys; j++) {
 549                         if (strchr(keys[j].key, *string) != NULL) {
 550                                 i = strlcat(buf, keys[j].repl, sizeof(buf));
 551                                 if (i >= sizeof(buf))
 552                                         fatal("percent_expand: string too long");
 553                                 break;
 554                         }
 555                 }
 556                 if (j >= num_keys)
 557                         fatal("percent_expand: unknown key %%%c", *string);
 558         }
 559         return (xstrdup(buf));
 560 #undef EXPAND_MAX_KEYS
 561 }
 562
 563 /*
 564  * Read an entire line from a public key file into a static buffer, discarding
 565  * lines that exceed the buffer size.  Returns 0 on success, -1 on failure.
 566  */
 567 int
 568 read_keyfile_line(FILE *f, const char *filename, char *buf, size_t bufsz,
 569    u_long *lineno)
 570 {
 571         while (fgets(buf, bufsz, f) != NULL) {
 572                 (*lineno)++;
 573                 if (buf[strlen(buf) - 1] == '\n' || feof(f)) {
 574                         return 0;
 575                 } else {
 576                         debug("%s: %s line %lu exceeds size limit", __func__,
 577                             filename, *lineno);
 578                         /* discard remainder of line */
 579                         while (fgetc(f) != '\n' && !feof(f))
 580                                 ;       /* nothing */
 581                 }
 582         }
 583         return -1;
 584 }
 585
 586 int
 587 tun_open(int tun, int mode)
 588 {
 589 #if defined(CUSTOM_SYS_TUN_OPEN)
 590         return (sys_tun_open(tun, mode));
 591 #elif defined(SSH_TUN_OPENBSD)
 592         struct ifreq ifr;
 593         char name[100];
 594         int fd = -1, sock;
 595
 596         /* Open the tunnel device */
 597         if (tun <= SSH_TUNID_MAX) {
 598                 snprintf(name, sizeof(name), "/dev/tun%d", tun);
 599                 fd = open(name, O_RDWR);
 600         } else if (tun == SSH_TUNID_ANY) {
 601                 for (tun = 100; tun >= 0; tun--) {
 602                         snprintf(name, sizeof(name), "/dev/tun%d", tun);
 603                         if ((fd = open(name, O_RDWR)) >= 0)
 604                                 break;
 605                 }
 606         } else {
 607                 debug("%s: invalid tunnel %u", __func__, tun);
 608                 return (-1);
 609         }
 610
 611         if (fd < 0) {
 612                 debug("%s: %s open failed: %s", __func__, name, strerror(errno));
 613                 return (-1);
 614         }
 615
 616         debug("%s: %s mode %d fd %d", __func__, name, mode, fd);
 617
 618         /* Set the tunnel device operation mode */
 619         snprintf(ifr.ifr_name, sizeof(ifr.ifr_name), "tun%d", tun);
 620         if ((sock = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
 621                 goto failed;
 622
 623         if (ioctl(sock, SIOCGIFFLAGS, &ifr) == -1)
 624                 goto failed;
 625
 626         /* Set interface mode */
 627         ifr.ifr_flags &= ~IFF_UP;
 628         if (mode == SSH_TUNMODE_ETHERNET)
 629                 ifr.ifr_flags |= IFF_LINK0;
 630         else
 631                 ifr.ifr_flags &= ~IFF_LINK0;
 632         if (ioctl(sock, SIOCSIFFLAGS, &ifr) == -1)
 633                 goto failed;
 634
 635         /* Bring interface up */
 636         ifr.ifr_flags |= IFF_UP;
 637         if (ioctl(sock, SIOCSIFFLAGS, &ifr) == -1)
 638                 goto failed;
 639
 640         close(sock);
 641         return (fd);
 642
 643  failed:
 644         if (fd >= 0)
 645                 close(fd);
 646         if (sock >= 0)
 647                 close(sock);
 648         debug("%s: failed to set %s mode %d: %s", __func__, name,
 649             mode, strerror(errno));
 650         return (-1);
 651 #else
 652         error("Tunnel interfaces are not supported on this platform");
 653         return (-1);
 654 #endif
 655 }
 656
 657 void
 658 sanitise_stdfd(void)
 659 {
 660         int nullfd, dupfd;
 661
 662         if ((nullfd = dupfd = open(_PATH_DEVNULL, O_RDWR)) == -1) {
 663                 fprintf(stderr, "Couldn't open /dev/null: %s", strerror(errno));
 664                 exit(1);
 665         }
 666         while (++dupfd <= 2) {
 667                 /* Only clobber closed fds */
 668                 if (fcntl(dupfd, F_GETFL, 0) >= 0)
 669                         continue;
 670                 if (dup2(nullfd, dupfd) == -1) {
 671                         fprintf(stderr, "dup2: %s", strerror(errno));
 672                         exit(1);
 673                 }
 674         }
 675         if (nullfd > 2)
 676                 close(nullfd);
 677 }
 678
 679 char *
 680 tohex(const u_char *d, u_int l)
 681 {
 682         char b[3], *r;
 683         u_int i, hl;
 684
 685         hl = l * 2 + 1;
 686         r = xmalloc(hl);
 687         *r = '\0';
 688         for (i = 0; i < l; i++) {
 689                 snprintf(b, sizeof(b), "%02x", d[i]);
 690                 strlcat(r, b, hl);
 691         }
 692         return (r);
 693 }
 694