apps/opt.c

   1 /* ====================================================================
   2  * Copyright (c) 2015 The OpenSSL Project.  All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  *
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  *
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in
  13  *    the documentation and/or other materials provided with the
  14  *    distribution.
  15  *
  16  * 3. All advertising materials mentioning features or use of this
  17  *    software must display the following acknowledgment:
  18  *    "This product includes software developed by the OpenSSL Project
  19  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
  20  *
  21  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  22  *    endorse or promote products derived from this software without
  23  *    prior written permission. For written permission, please contact
  24  *    licensing@OpenSSL.org.
  25  *
  26  * 5. Products derived from this software may not be called "OpenSSL"
  27  *    nor may "OpenSSL" appear in their names without prior written
  28  *    permission of the OpenSSL Project.
  29  *
  30  * 6. Redistributions of any form whatsoever must retain the following
  31  *    acknowledgment:
  32  *    "This product includes software developed by the OpenSSL Project
  33  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
  34  *
  35  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  36  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  37  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  38  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  41  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  42  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  43  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  44  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  45  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  46  * OF THE POSSIBILITY OF SUCH DAMAGE.
  47  * ====================================================================
  48  */
  49
  50 /* #define COMPILE_STANDALONE_TEST_DRIVER  */
  51 #include "apps.h"
  52 #include <string.h>
  53 #if !defined(OPENSSL_SYS_MSDOS)
  54 # include OPENSSL_UNISTD
  55 #endif
  56
  57 #include <stdlib.h>
  58 #include <errno.h>
  59 #include <ctype.h>
  60 #include <limits.h>
  61 #include <openssl/bio.h>
  62
  63 #define MAX_OPT_HELP_WIDTH 30
  64 const char OPT_HELP_STR[] = "--";
  65 const char OPT_MORE_STR[] = "---";
  66
  67 /* Our state */
  68 static char **argv;
  69 static int argc;
  70 static int opt_index;
  71 static char *arg;
  72 static char *flag;
  73 static char *dunno;
  74 static const OPTIONS *unknown;
  75 static const OPTIONS *opts;
  76 static char prog[40];
  77
  78 /*
  79  * Return the simple name of the program; removing various platform gunk.
  80  */
  81 #if defined(OPENSSL_SYS_WIN32) || defined(OPENSSL_SYS_NETWARE)
  82 char *opt_progname(const char *argv0)
  83 {
  84     size_t i, n;
  85     const char *p;
  86     char *q;
  87
  88     /* find the last '/', '\' or ':' */
  89     for (p = argv0 + strlen(argv0); --p > argv0;)
  90         if (*p == '/' || *p == '\\' || *p == ':') {
  91             p++;
  92             break;
  93         }
  94
  95     /* Strip off trailing nonsense. */
  96     n = strlen(p);
  97     if (n > 4 &&
  98         (strcmp(&p[n - 4], ".exe") == 0 || strcmp(&p[n - 4], ".EXE") == 0))
  99         n -= 4;
 100 #if defined(OPENSSL_SYS_NETWARE)
 101     if (n > 4 &&
 102         (strcmp(&p[n - 4], ".nlm") == 0 || strcmp(&p[n - 4], ".NLM") == 0))
 103         n -= 4;
 104 #endif
 105
 106     /* Copy over the name, in lowercase. */
 107     if (n > sizeof prog - 1)
 108         n = sizeof prog - 1;
 109     for (q = prog, i = 0; i < n; i++, p++)
 110         *q++ = isupper(*p) ? tolower(*p) : *p;
 111     *q = '\0';
 112     return prog;
 113 }
 114
 115 #elif defined(OPENSSL_SYS_VMS)
 116
 117 char *opt_progname(const char *argv0)
 118 {
 119     const char *p, *q;
 120
 121     /* Find last special charcter sys:[foo.bar]openssl */
 122     for (p = argv0 + strlen(argv0); --p > argv0;)
 123         if (*p == ':' || *p == ']' || *p == '>') {
 124             p++;
 125             break;
 126         }
 127
 128     q = strrchr(p, '.');
 129     strncpy(prog, p, sizeof prog - 1);
 130     prog[sizeof prog - 1] = '\0';
 131     if (q != NULL && q - p < sizeof prog)
 132         prog[q - p] = '\0';
 133     return prog;
 134 }
 135
 136 #else
 137
 138 char *opt_progname(const char *argv0)
 139 {
 140     const char *p;
 141
 142     /* Could use strchr, but this is like the ones above. */
 143     for (p = argv0 + strlen(argv0); --p > argv0;)
 144         if (*p == '/') {
 145             p++;
 146             break;
 147         }
 148     strncpy(prog, p, sizeof prog - 1);
 149     prog[sizeof prog - 1] = '\0';
 150     return prog;
 151 }
 152 #endif
 153
 154 char *opt_getprog(void)
 155 {
 156     return prog;
 157 }
 158
 159 /* Set up the arg parsing. */
 160 char *opt_init(int ac, char **av, const OPTIONS *o)
 161 {
 162     /* Store state. */
 163     argc = ac;
 164     argv = av;
 165     opt_index = 1;
 166     opts = o;
 167     opt_progname(av[0]);
 168     unknown = NULL;
 169
 170     for (; o->name; ++o) {
 171         const OPTIONS *next;
 172 #ifndef NDEBUG
 173         int duplicated, i;
 174 #endif
 175
 176         if (o->name == OPT_HELP_STR || o->name == OPT_MORE_STR)
 177             continue;
 178 #ifndef NDEBUG
 179         i = o->valtype;
 180
 181         /* Make sure options are legit. */
 182         assert(o->name[0] != '-');
 183         assert(o->retval > 0);
 184         switch (i) {
 185         case   0: case '-': case '/': case '<': case '>': case 'F': case 'M':
 186         case 'L': case 'U': case 'f': case 'n': case 'p': case 's': case 'u':
 187             break;
 188         default:
 189             assert(0);
 190         }
 191
 192         /* Make sure there are no duplicates. */
 193         for (next = o + 1; next->name; ++next) {
 194             /*
 195              * Some compilers inline strcmp and the assert string is too long.
 196              */
 197             duplicated = strcmp(o->name, next->name) == 0;
 198             assert(!duplicated);
 199         }
 200 #endif
 201         if (o->name[0] == '\0') {
 202             assert(unknown == NULL);
 203             unknown = o;
 204             assert(unknown->valtype == 0 || unknown->valtype == '-');
 205         }
 206     }
 207     return prog;
 208 }
 209
 210 static OPT_PAIR formats[] = {
 211     {"PEM/DER", OPT_FMT_PEMDER},
 212     {"pkcs12", OPT_FMT_PKCS12},
 213     {"smime", OPT_FMT_SMIME},
 214     {"engine", OPT_FMT_ENGINE},
 215     {"msblob", OPT_FMT_MSBLOB},
 216     {"netscape", OPT_FMT_NETSCAPE},
 217     {"nss", OPT_FMT_NSS},
 218     {"text", OPT_FMT_TEXT},
 219     {"http", OPT_FMT_HTTP},
 220     {"pvk", OPT_FMT_PVK},
 221     {NULL}
 222 };
 223
 224 /* Print an error message about a failed format parse. */
 225 int opt_format_error(const char *s, unsigned long flags)
 226 {
 227     OPT_PAIR *ap;
 228
 229     if (flags == OPT_FMT_PEMDER)
 230         BIO_printf(bio_err, "%s: Bad format \"%s\"; must be pem or der\n",
 231                    prog, s);
 232     else {
 233         BIO_printf(bio_err, "%s: Bad format \"%s\"; must be one of:\n",
 234                    prog, s);
 235         for (ap = formats; ap->name; ap++)
 236             if (flags & ap->retval)
 237                 BIO_printf(bio_err, "   %s\n", ap->name);
 238     }
 239     return 0;
 240 }
 241
 242 /* Parse a format string, put it into *result; return 0 on failure, else 1. */
 243 int opt_format(const char *s, unsigned long flags, int *result)
 244 {
 245     switch (*s) {
 246     default:
 247         return 0;
 248     case 'D':
 249     case 'd':
 250         if ((flags & OPT_FMT_PEMDER) == 0)
 251             return opt_format_error(s, flags);
 252         *result = FORMAT_ASN1;
 253         break;
 254     case 'T':
 255     case 't':
 256         if ((flags & OPT_FMT_TEXT) == 0)
 257             return opt_format_error(s, flags);
 258         *result = FORMAT_TEXT;
 259         break;
 260     case 'N':
 261     case 'n':
 262         if ((flags & OPT_FMT_NSS) == 0)
 263             return opt_format_error(s, flags);
 264         if (strcmp(s, "NSS") != 0 && strcmp(s, "nss") != 0)
 265             return opt_format_error(s, flags);
 266         *result = FORMAT_NSS;
 267         break;
 268     case 'S':
 269     case 's':
 270         if ((flags & OPT_FMT_SMIME) == 0)
 271             return opt_format_error(s, flags);
 272         *result = FORMAT_SMIME;
 273         break;
 274     case 'M':
 275     case 'm':
 276         if ((flags & OPT_FMT_MSBLOB) == 0)
 277             return opt_format_error(s, flags);
 278         *result = FORMAT_MSBLOB;
 279         break;
 280     case 'E':
 281     case 'e':
 282         if ((flags & OPT_FMT_ENGINE) == 0)
 283             return opt_format_error(s, flags);
 284         *result = FORMAT_ENGINE;
 285         break;
 286     case 'H':
 287     case 'h':
 288         if ((flags & OPT_FMT_HTTP) == 0)
 289             return opt_format_error(s, flags);
 290         *result = FORMAT_HTTP;
 291         break;
 292     case '1':
 293         if ((flags & OPT_FMT_PKCS12) == 0)
 294             return opt_format_error(s, flags);
 295         *result = FORMAT_PKCS12;
 296         break;
 297     case 'P':
 298     case 'p':
 299         if (s[1] == '\0' || strcmp(s, "PEM") == 0 || strcmp(s, "pem") == 0) {
 300             if ((flags & OPT_FMT_PEMDER) == 0)
 301                 return opt_format_error(s, flags);
 302             *result = FORMAT_PEM;
 303         } else if (strcmp(s, "PVK") == 0 || strcmp(s, "pvk") == 0) {
 304             if ((flags & OPT_FMT_PVK) == 0)
 305                 return opt_format_error(s, flags);
 306             *result = FORMAT_PVK;
 307         } else if (strcmp(s, "P12") == 0 || strcmp(s, "p12") == 0
 308                    || strcmp(s, "PKCS12") == 0 || strcmp(s, "pkcs12") == 0) {
 309             if ((flags & OPT_FMT_PKCS12) == 0)
 310                 return opt_format_error(s, flags);
 311             *result = FORMAT_PKCS12;
 312         } else
 313             return 0;
 314         break;
 315     }
 316     return 1;
 317 }
 318
 319 /* Parse a cipher name, put it in *EVP_CIPHER; return 0 on failure, else 1. */
 320 int opt_cipher(const char *name, const EVP_CIPHER **cipherp)
 321 {
 322     *cipherp = EVP_get_cipherbyname(name);
 323     if (*cipherp)
 324         return 1;
 325     BIO_printf(bio_err, "%s: Unknown cipher %s\n", prog, name);
 326     return 0;
 327 }
 328
 329 /*
 330  * Parse message digest name, put it in *EVP_MD; return 0 on failure, else 1.
 331  */
 332 int opt_md(const char *name, const EVP_MD **mdp)
 333 {
 334     *mdp = EVP_get_digestbyname(name);
 335     if (*mdp)
 336         return 1;
 337     BIO_printf(bio_err, "%s: Unknown digest %s\n", prog, name);
 338     return 0;
 339 }
 340
 341 /* Look through a list of name/value pairs. */
 342 int opt_pair(const char *name, const OPT_PAIR* pairs, int *result)
 343 {
 344     const OPT_PAIR *pp;
 345
 346     for (pp = pairs; pp->name; pp++)
 347         if (strcmp(pp->name, name) == 0) {
 348             *result = pp->retval;
 349             return 1;
 350         }
 351     BIO_printf(bio_err, "%s: Value must be one of:\n", prog);
 352     for (pp = pairs; pp->name; pp++)
 353         BIO_printf(bio_err, "\t%s\n", pp->name);
 354     return 0;
 355 }
 356
 357 /* Parse an int, put it into *result; return 0 on failure, else 1. */
 358 int opt_int(const char *value, int *result)
 359 {
 360     long l;
 361
 362     if (!opt_long(value, &l))
 363         return 0;
 364     *result = (int)l;
 365     if (*result != l) {
 366         BIO_printf(bio_err, "%s: Value \"%s\" outside integer range\n",
 367                    prog, value);
 368         return 0;
 369     }
 370     return 1;
 371 }
 372
 373 /* Parse a long, put it into *result; return 0 on failure, else 1. */
 374 int opt_long(const char *value, long *result)
 375 {
 376     int oerrno = errno;
 377     long l;
 378     char *endp;
 379
 380     l = strtol(value, &endp, 0);
 381     if (*endp
 382             || endp == value
 383             || ((l == LONG_MAX || l == LONG_MIN) && errno == ERANGE)
 384             || (l == 0 && errno != 0)) {
 385         BIO_printf(bio_err, "%s: Can't parse \"%s\" as a number\n",
 386                    prog, value);
 387         errno = oerrno;
 388         return 0;
 389     }
 390     *result = l;
 391     errno = oerrno;
 392     return 1;
 393 }
 394
 395 #if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L && \
 396     defined(INTMAX_MAX) && defined(UINTMAX_MAX)
 397
 398 /* Parse an intmax_t, put it into *result; return 0 on failure, else 1. */
 399 int opt_imax(const char *value, intmax_t *result)
 400 {
 401     int oerrno = errno;
 402     intmax_t m;
 403     char *endp;
 404
 405     m = strtoimax(value, &endp, 0);
 406     if (*endp
 407             || endp == value
 408             || ((m == INTMAX_MAX || m == INTMAX_MIN) && errno == ERANGE)
 409             || (m == 0 && errno != 0)) {
 410         BIO_printf(bio_err, "%s: Can't parse \"%s\" as a number\n",
 411                    prog, value);
 412         errno = oerrno;
 413         return 0;
 414     }
 415     *result = m;
 416     errno = oerrno;
 417     return 1;
 418 }
 419
 420 /* Parse a uintmax_t, put it into *result; return 0 on failure, else 1. */
 421 int opt_umax(const char *value, uintmax_t *result)
 422 {
 423     int oerrno = errno;
 424     uintmax_t m;
 425     char *endp;
 426
 427     m = strtoumax(value, &endp, 0);
 428     if (*endp
 429             || endp == value
 430             || (m == UINTMAX_MAX && errno == ERANGE)
 431             || (m == 0 && errno != 0)) {
 432         BIO_printf(bio_err, "%s: Can't parse \"%s\" as a number\n",
 433                    prog, value);
 434         errno = oerrno;
 435         return 0;
 436     }
 437     *result = m;
 438     errno = oerrno;
 439     return 1;
 440 }
 441 #endif
 442
 443 /*
 444  * Parse an unsigned long, put it into *result; return 0 on failure, else 1.
 445  */
 446 int opt_ulong(const char *value, unsigned long *result)
 447 {
 448     int oerrno = errno;
 449     char *endptr;
 450     unsigned long l;
 451
 452     l = strtoul(value, &endptr, 0);
 453     if (*endptr
 454             || endptr == value
 455             || ((l == ULONG_MAX) && errno == ERANGE)
 456             || (l == 0 && errno != 0)) {
 457         BIO_printf(bio_err, "%s: Can't parse \"%s\" as an unsigned number\n",
 458                    prog, value);
 459         errno = oerrno;
 460         return 0;
 461     }
 462     *result = l;
 463     errno = oerrno;
 464     return 1;
 465 }
 466
 467 /*
 468  * We pass opt as an int but cast it to "enum range" so that all the
 469  * items in the OPT_V_ENUM enumeration are caught; this makes -Wswitch
 470  * in gcc do the right thing.
 471  */
 472 enum range { OPT_V_ENUM };
 473
 474 int opt_verify(int opt, X509_VERIFY_PARAM *vpm)
 475 {
 476     int i;
 477     ossl_intmax_t t = 0;
 478     ASN1_OBJECT *otmp;
 479     X509_PURPOSE *xptmp;
 480     const X509_VERIFY_PARAM *vtmp;
 481
 482     assert(vpm != NULL);
 483     assert(opt > OPT_V__FIRST);
 484     assert(opt < OPT_V__LAST);
 485
 486     switch ((enum range)opt) {
 487     case OPT_V__FIRST:
 488     case OPT_V__LAST:
 489         return 0;
 490     case OPT_V_POLICY:
 491         otmp = OBJ_txt2obj(opt_arg(), 0);
 492         if (otmp == NULL) {
 493             BIO_printf(bio_err, "%s: Invalid Policy %s\n", prog, opt_arg());
 494             return 0;
 495         }
 496         X509_VERIFY_PARAM_add0_policy(vpm, otmp);
 497         break;
 498     case OPT_V_PURPOSE:
 499         i = X509_PURPOSE_get_by_sname(opt_arg());
 500         if (i < 0) {
 501             BIO_printf(bio_err, "%s: Invalid purpose %s\n", prog, opt_arg());
 502             return 0;
 503         }
 504         xptmp = X509_PURPOSE_get0(i);
 505         i = X509_PURPOSE_get_id(xptmp);
 506         X509_VERIFY_PARAM_set_purpose(vpm, i);
 507         break;
 508     case OPT_V_VERIFY_NAME:
 509         vtmp = X509_VERIFY_PARAM_lookup(opt_arg());
 510         if (vtmp == NULL) {
 511             BIO_printf(bio_err, "%s: Invalid verify name %s\n",
 512                        prog, opt_arg());
 513             return 0;
 514         }
 515         X509_VERIFY_PARAM_set1(vpm, vtmp);
 516         break;
 517     case OPT_V_VERIFY_DEPTH:
 518         i = atoi(opt_arg());
 519         if (i >= 0)
 520             X509_VERIFY_PARAM_set_depth(vpm, i);
 521         break;
 522     case OPT_V_ATTIME:
 523         if (!opt_imax(opt_arg(), &t))
 524             return 0;
 525         if (t != (time_t)t) {
 526             BIO_printf(bio_err, "%s: epoch time out of range %s\n",
 527                        prog, opt_arg());
 528             return 0;
 529         }
 530         X509_VERIFY_PARAM_set_time(vpm, (time_t)t);
 531         break;
 532     case OPT_V_VERIFY_HOSTNAME:
 533         if (!X509_VERIFY_PARAM_set1_host(vpm, opt_arg(), 0))
 534             return 0;
 535         break;
 536     case OPT_V_VERIFY_EMAIL:
 537         if (!X509_VERIFY_PARAM_set1_email(vpm, opt_arg(), 0))
 538             return 0;
 539         break;
 540     case OPT_V_VERIFY_IP:
 541         if (!X509_VERIFY_PARAM_set1_ip_asc(vpm, opt_arg()))
 542             return 0;
 543         break;
 544     case OPT_V_IGNORE_CRITICAL:
 545         X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_IGNORE_CRITICAL);
 546         break;
 547     case OPT_V_ISSUER_CHECKS:
 548         X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_CB_ISSUER_CHECK);
 549         break;
 550     case OPT_V_CRL_CHECK:
 551         X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_CRL_CHECK);
 552         break;
 553     case OPT_V_CRL_CHECK_ALL:
 554         X509_VERIFY_PARAM_set_flags(vpm,
 555                                     X509_V_FLAG_CRL_CHECK |
 556                                     X509_V_FLAG_CRL_CHECK_ALL);
 557         break;
 558     case OPT_V_POLICY_CHECK:
 559         X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_POLICY_CHECK);
 560         break;
 561     case OPT_V_EXPLICIT_POLICY:
 562         X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_EXPLICIT_POLICY);
 563         break;
 564     case OPT_V_INHIBIT_ANY:
 565         X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_INHIBIT_ANY);
 566         break;
 567     case OPT_V_INHIBIT_MAP:
 568         X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_INHIBIT_MAP);
 569         break;
 570     case OPT_V_X509_STRICT:
 571         X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_X509_STRICT);
 572         break;
 573     case OPT_V_EXTENDED_CRL:
 574         X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_EXTENDED_CRL_SUPPORT);
 575         break;
 576     case OPT_V_USE_DELTAS:
 577         X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_USE_DELTAS);
 578         break;
 579     case OPT_V_POLICY_PRINT:
 580         X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_NOTIFY_POLICY);
 581         break;
 582     case OPT_V_CHECK_SS_SIG:
 583         X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_CHECK_SS_SIGNATURE);
 584         break;
 585     case OPT_V_TRUSTED_FIRST:
 586         X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_TRUSTED_FIRST);
 587         break;
 588     case OPT_V_SUITEB_128_ONLY:
 589         X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_SUITEB_128_LOS_ONLY);
 590         break;
 591     case OPT_V_SUITEB_128:
 592         X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_SUITEB_128_LOS);
 593         break;
 594     case OPT_V_SUITEB_192:
 595         X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_SUITEB_192_LOS);
 596         break;
 597     case OPT_V_PARTIAL_CHAIN:
 598         X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_PARTIAL_CHAIN);
 599         break;
 600     case OPT_V_NO_ALT_CHAINS:
 601         X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_NO_ALT_CHAINS);
 602         break;
 603     case OPT_V_NO_CHECK_TIME:
 604         X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_NO_CHECK_TIME);
 605         break;
 606     }
 607     return 1;
 608
 609 }
 610
 611 /*
 612  * Parse the next flag (and value if specified), return 0 if done, -1 on
 613  * error, otherwise the flag's retval.
 614  */
 615 int opt_next(void)
 616 {
 617     char *p;
 618     const OPTIONS *o;
 619     int ival;
 620     long lval;
 621     unsigned long ulval;
 622     ossl_intmax_t imval;
 623     ossl_uintmax_t umval;
 624
 625     /* Look at current arg; at end of the list? */
 626     arg = NULL;
 627     p = argv[opt_index];
 628     if (p == NULL)
 629         return 0;
 630
 631     /* If word doesn't start with a -, we're done. */
 632     if (*p != '-')
 633         return 0;
 634
 635     /* Hit "--" ? We're done. */
 636     opt_index++;
 637     if (strcmp(p, "--") == 0)
 638         return 0;
 639
 640     /* Allow -nnn and --nnn */
 641     if (*++p == '-')
 642         p++;
 643     flag = p - 1;
 644
 645     /* If we have --flag=foo, snip it off */
 646     if ((arg = strchr(p, '=')) != NULL)
 647         *arg++ = '\0';
 648     for (o = opts; o->name; ++o) {
 649         /* If not this option, move on to the next one. */
 650         if (strcmp(p, o->name) != 0)
 651             continue;
 652
 653         /* If it doesn't take a value, make sure none was given. */
 654         if (o->valtype == 0 || o->valtype == '-') {
 655             if (arg) {
 656                 BIO_printf(bio_err,
 657                            "%s: Option -%s does not take a value\n", prog, p);
 658                 return -1;
 659             }
 660             return o->retval;
 661         }
 662
 663         /* Want a value; get the next param if =foo not used. */
 664         if (arg == NULL) {
 665             if (argv[opt_index] == NULL) {
 666                 BIO_printf(bio_err,
 667                            "%s: Option -%s needs a value\n", prog, o->name);
 668                 return -1;
 669             }
 670             arg = argv[opt_index++];
 671         }
 672
 673         /* Syntax-check value. */
 674         switch (o->valtype) {
 675         default:
 676         case 's':
 677             /* Just a string. */
 678             break;
 679         case '/':
 680             if (app_isdir(arg) >= 0)
 681                 break;
 682             BIO_printf(bio_err, "%s: Not a directory: %s\n", prog, arg);
 683             return -1;
 684         case '<':
 685             /* Input file. */
 686             if (strcmp(arg, "-") == 0 || app_access(arg, R_OK) >= 0)
 687                 break;
 688             BIO_printf(bio_err,
 689                        "%s: Cannot open input file %s, %s\n",
 690                        prog, arg, strerror(errno));
 691             return -1;
 692         case '>':
 693             /* Output file. */
 694             if (strcmp(arg, "-") == 0 || app_access(arg, W_OK) >= 0 || errno == ENOENT)
 695                 break;
 696             BIO_printf(bio_err,
 697                        "%s: Cannot open output file %s, %s\n",
 698                        prog, arg, strerror(errno));
 699             return -1;
 700         case 'p':
 701         case 'n':
 702             if (!opt_int(arg, &ival)
 703                     || (o->valtype == 'p' && ival <= 0)) {
 704                 BIO_printf(bio_err,
 705                            "%s: Non-positive number \"%s\" for -%s\n",
 706                            prog, arg, o->name);
 707                 return -1;
 708             }
 709             break;
 710         case 'M':
 711             if (!opt_imax(arg, &imval)) {
 712                 BIO_printf(bio_err,
 713                            "%s: Invalid number \"%s\" for -%s\n",
 714                            prog, arg, o->name);
 715                 return -1;
 716             }
 717             break;
 718         case 'U':
 719             if (!opt_umax(arg, &umval)) {
 720                 BIO_printf(bio_err,
 721                            "%s: Invalid number \"%s\" for -%s\n",
 722                            prog, arg, o->name);
 723                 return -1;
 724             }
 725             break;
 726         case 'L':
 727             if (!opt_long(arg, &lval)) {
 728                 BIO_printf(bio_err,
 729                            "%s: Invalid number \"%s\" for -%s\n",
 730                            prog, arg, o->name);
 731                 return -1;
 732             }
 733             break;
 734         case 'u':
 735             if (!opt_ulong(arg, &ulval)) {
 736                 BIO_printf(bio_err,
 737                            "%s: Invalid number \"%s\" for -%s\n",
 738                            prog, arg, o->name);
 739                 return -1;
 740             }
 741             break;
 742         case 'f':
 743         case 'F':
 744             if (opt_format(arg,
 745                            o->valtype == 'F' ? OPT_FMT_PEMDER
 746                            : OPT_FMT_ANY, &ival))
 747                 break;
 748             BIO_printf(bio_err,
 749                        "%s: Invalid format \"%s\" for -%s\n",
 750                        prog, arg, o->name);
 751             return -1;
 752         }
 753
 754         /* Return the flag value. */
 755         return o->retval;
 756     }
 757     if (unknown != NULL) {
 758         dunno = p;
 759         return unknown->retval;
 760     }
 761     BIO_printf(bio_err, "%s: Option unknown option -%s\n", prog, p);
 762     return -1;
 763 }
 764
 765 /* Return the most recent flag parameter. */
 766 char *opt_arg(void)
 767 {
 768     return arg;
 769 }
 770
 771 /* Return the most recent flag. */
 772 char *opt_flag(void)
 773 {
 774     return flag;
 775 }
 776
 777 /* Return the unknown option. */
 778 char *opt_unknown(void)
 779 {
 780     return dunno;
 781 }
 782
 783 /* Return the rest of the arguments after parsing flags. */
 784 char **opt_rest(void)
 785 {
 786     return &argv[opt_index];
 787 }
 788
 789 /* How many items in remaining args? */
 790 int opt_num_rest(void)
 791 {
 792     int i = 0;
 793     char **pp;
 794
 795     for (pp = opt_rest(); *pp; pp++, i++)
 796         continue;
 797     return i;
 798 }
 799
 800 /* Return a string describing the parameter type. */
 801 static const char *valtype2param(const OPTIONS *o)
 802 {
 803     switch (o->valtype) {
 804     case '-':
 805         return "";
 806     case 's':
 807         return "val";
 808     case '/':
 809         return "dir";
 810     case '<':
 811         return "infile";
 812     case '>':
 813         return "outfile";
 814     case 'p':
 815         return "pnum";
 816     case 'n':
 817         return "num";
 818     case 'u':
 819         return "unum";
 820     case 'F':
 821         return "der/pem";
 822     case 'f':
 823         return "format";
 824     }
 825     return "parm";
 826 }
 827
 828 void opt_help(const OPTIONS *list)
 829 {
 830     const OPTIONS *o;
 831     int i;
 832     int standard_prolog;
 833     int width = 5;
 834     char start[80 + 1];
 835     char *p;
 836     const char *help;
 837
 838     /* Starts with its own help message? */
 839     standard_prolog = list[0].name != OPT_HELP_STR;
 840
 841     /* Find the widest help. */
 842     for (o = list; o->name; o++) {
 843         if (o->name == OPT_MORE_STR)
 844             continue;
 845         i = 2 + (int)strlen(o->name);
 846         if (o->valtype != '-')
 847             i += 1 + strlen(valtype2param(o));
 848         if (i < MAX_OPT_HELP_WIDTH && i > width)
 849             width = i;
 850         assert(i < (int)sizeof start);
 851     }
 852
 853     if (standard_prolog)
 854         BIO_printf(bio_err, "Usage: %s [options]\nValid options are:\n",
 855                    prog);
 856
 857     /* Now let's print. */
 858     for (o = list; o->name; o++) {
 859         help = o->helpstr ? o->helpstr : "(No additional info)";
 860         if (o->name == OPT_HELP_STR) {
 861             BIO_printf(bio_err, help, prog);
 862             continue;
 863         }
 864
 865         /* Pad out prefix */
 866         memset(start, ' ', sizeof(start) - 1);
 867         start[sizeof start - 1] = '\0';
 868
 869         if (o->name == OPT_MORE_STR) {
 870             /* Continuation of previous line; padd and print. */
 871             start[width] = '\0';
 872             BIO_printf(bio_err, "%s  %s\n", start, help);
 873             continue;
 874         }
 875
 876         /* Build up the "-flag [param]" part. */
 877         p = start;
 878         *p++ = ' ';
 879         *p++ = '-';
 880         if (o->name[0])
 881             p += strlen(strcpy(p, o->name));
 882         else
 883             *p++ = '*';
 884         if (o->valtype != '-') {
 885             *p++ = ' ';
 886             p += strlen(strcpy(p, valtype2param(o)));
 887         }
 888         *p = ' ';
 889         if ((int)(p - start) >= MAX_OPT_HELP_WIDTH) {
 890             *p = '\0';
 891             BIO_printf(bio_err, "%s\n", start);
 892             memset(start, ' ', sizeof(start));
 893         }
 894         start[width] = '\0';
 895         BIO_printf(bio_err, "%s  %s\n", start, help);
 896     }
 897 }
 898
 899 #ifdef COMPILE_STANDALONE_TEST_DRIVER
 900 # include <sys/stat.h>
 901
 902 typedef enum OPTION_choice {
 903     OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
 904     OPT_IN, OPT_INFORM, OPT_OUT, OPT_COUNT, OPT_U, OPT_FLAG,
 905     OPT_STR, OPT_NOTUSED
 906 } OPTION_CHOICE;
 907
 908 static OPTIONS options[] = {
 909     {OPT_HELP_STR, 1, '-', "Usage: %s flags\n"},
 910     {OPT_HELP_STR, 1, '-', "Valid options are:\n"},
 911     {"help", OPT_HELP, '-', "Display this summary"},
 912     {"in", OPT_IN, '<', "input file"},
 913     {OPT_MORE_STR, 1, '-', "more detail about input"},
 914     {"inform", OPT_INFORM, 'f', "input file format; defaults to pem"},
 915     {"out", OPT_OUT, '>', "output file"},
 916     {"count", OPT_COUNT, 'p', "a counter greater than zero"},
 917     {"u", OPT_U, 'u', "an unsigned number"},
 918     {"flag", OPT_FLAG, 0, "just some flag"},
 919     {"str", OPT_STR, 's', "the magic word"},
 920     {"areallyverylongoption", OPT_HELP, '-', "long way for help"},
 921     {NULL}
 922 };
 923
 924 BIO *bio_err;
 925
 926 int app_isdir(const char *name)
 927 {
 928     struct stat sb;
 929
 930     return name != NULL && stat(name, &sb) >= 0 && S_ISDIR(sb.st_mode);
 931 }
 932
 933 int main(int ac, char **av)
 934 {
 935     OPTION_CHOICE o;
 936     char **rest;
 937     char *prog;
 938
 939     bio_err = BIO_new_fp(stderr, BIO_NOCLOSE | BIO_FP_TEXT);
 940
 941     prog = opt_init(ac, av, options);
 942     while ((o = opt_next()) != OPT_EOF) {
 943         switch (c) {
 944         case OPT_NOTUSED:
 945         case OPT_EOF:
 946         case OPT_ERR:
 947             printf("%s: Usage error; try -help.\n", prog);
 948             return 1;
 949         case OPT_HELP:
 950             opt_help(options);
 951             return 0;
 952         case OPT_IN:
 953             printf("in %s\n", opt_arg());
 954             break;
 955         case OPT_INFORM:
 956             printf("inform %s\n", opt_arg());
 957             break;
 958         case OPT_OUT:
 959             printf("out %s\n", opt_arg());
 960             break;
 961         case OPT_COUNT:
 962             printf("count %s\n", opt_arg());
 963             break;
 964         case OPT_U:
 965             printf("u %s\n", opt_arg());
 966             break;
 967         case OPT_FLAG:
 968             printf("flag\n");
 969             break;
 970         case OPT_STR:
 971             printf("str %s\n", opt_arg());
 972             break;
 973         }
 974     }
 975     argc = opt_num_rest();
 976     argv = opt_rest();
 977
 978     printf("args = %d\n", argc);
 979     if (argc)
 980         while (*argv)
 981             printf("  %s\n", *argv++);
 982     return 0;
 983 }
 984 #endif