2 * Copyright 2015-2017 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
11 #if !defined(OPENSSL_SYS_MSDOS)
12 # include OPENSSL_UNISTD
19 #include <openssl/bio.h>
20 #include <openssl/x509v3.h>
22 #define MAX_OPT_HELP_WIDTH 30
23 const char OPT_HELP_STR[] = "--";
24 const char OPT_MORE_STR[] = "---";
33 static const OPTIONS *unknown;
34 static const OPTIONS *opts;
38 * Return the simple name of the program; removing various platform gunk.
40 #if defined(OPENSSL_SYS_WIN32)
41 char *opt_progname(const char *argv0)
47 /* find the last '/', '\' or ':' */
48 for (p = argv0 + strlen(argv0); --p > argv0;)
49 if (*p == '/' || *p == '\\' || *p == ':') {
54 /* Strip off trailing nonsense. */
57 (strcmp(&p[n - 4], ".exe") == 0 || strcmp(&p[n - 4], ".EXE") == 0))
60 /* Copy over the name, in lowercase. */
61 if (n > sizeof(prog) - 1)
63 for (q = prog, i = 0; i < n; i++, p++)
64 *q++ = tolower((unsigned char)*p);
69 #elif defined(OPENSSL_SYS_VMS)
71 char *opt_progname(const char *argv0)
75 /* Find last special character sys:[foo.bar]openssl */
76 for (p = argv0 + strlen(argv0); --p > argv0;)
77 if (*p == ':' || *p == ']' || *p == '>') {
83 strncpy(prog, p, sizeof(prog) - 1);
84 prog[sizeof(prog) - 1] = '\0';
85 if (q != NULL && q - p < sizeof(prog))
92 char *opt_progname(const char *argv0)
96 /* Could use strchr, but this is like the ones above. */
97 for (p = argv0 + strlen(argv0); --p > argv0;)
102 strncpy(prog, p, sizeof(prog) - 1);
103 prog[sizeof(prog) - 1] = '\0';
108 char *opt_getprog(void)
113 /* Set up the arg parsing. */
114 char *opt_init(int ac, char **av, const OPTIONS *o)
124 for (; o->name; ++o) {
130 if (o->name == OPT_HELP_STR || o->name == OPT_MORE_STR)
135 /* Make sure options are legit. */
136 assert(o->name[0] != '-');
137 assert(o->retval > 0);
139 case 0: case '-': case '/': case '<': case '>': case 'E': case 'F':
140 case 'M': case 'U': case 'f': case 'l': case 'n': case 'p': case 's':
147 /* Make sure there are no duplicates. */
148 for (next = o + 1; next->name; ++next) {
150 * Some compilers inline strcmp and the assert string is too long.
152 duplicated = strcmp(o->name, next->name) == 0;
156 if (o->name[0] == '\0') {
157 assert(unknown == NULL);
159 assert(unknown->valtype == 0 || unknown->valtype == '-');
165 static OPT_PAIR formats[] = {
166 {"PEM/DER", OPT_FMT_PEMDER},
167 {"pkcs12", OPT_FMT_PKCS12},
168 {"smime", OPT_FMT_SMIME},
169 {"engine", OPT_FMT_ENGINE},
170 {"msblob", OPT_FMT_MSBLOB},
171 {"netscape", OPT_FMT_NETSCAPE},
172 {"nss", OPT_FMT_NSS},
173 {"text", OPT_FMT_TEXT},
174 {"http", OPT_FMT_HTTP},
175 {"pvk", OPT_FMT_PVK},
179 /* Print an error message about a failed format parse. */
180 int opt_format_error(const char *s, unsigned long flags)
184 if (flags == OPT_FMT_PEMDER) {
185 BIO_printf(bio_err, "%s: Bad format \"%s\"; must be pem or der\n",
188 BIO_printf(bio_err, "%s: Bad format \"%s\"; must be one of:\n",
190 for (ap = formats; ap->name; ap++)
191 if (flags & ap->retval)
192 BIO_printf(bio_err, " %s\n", ap->name);
197 /* Parse a format string, put it into *result; return 0 on failure, else 1. */
198 int opt_format(const char *s, unsigned long flags, int *result)
205 if ((flags & OPT_FMT_PEMDER) == 0)
206 return opt_format_error(s, flags);
207 *result = FORMAT_ASN1;
211 if ((flags & OPT_FMT_TEXT) == 0)
212 return opt_format_error(s, flags);
213 *result = FORMAT_TEXT;
217 if ((flags & OPT_FMT_NSS) == 0)
218 return opt_format_error(s, flags);
219 if (strcmp(s, "NSS") != 0 && strcmp(s, "nss") != 0)
220 return opt_format_error(s, flags);
221 *result = FORMAT_NSS;
225 if ((flags & OPT_FMT_SMIME) == 0)
226 return opt_format_error(s, flags);
227 *result = FORMAT_SMIME;
231 if ((flags & OPT_FMT_MSBLOB) == 0)
232 return opt_format_error(s, flags);
233 *result = FORMAT_MSBLOB;
237 if ((flags & OPT_FMT_ENGINE) == 0)
238 return opt_format_error(s, flags);
239 *result = FORMAT_ENGINE;
243 if ((flags & OPT_FMT_HTTP) == 0)
244 return opt_format_error(s, flags);
245 *result = FORMAT_HTTP;
248 if ((flags & OPT_FMT_PKCS12) == 0)
249 return opt_format_error(s, flags);
250 *result = FORMAT_PKCS12;
254 if (s[1] == '\0' || strcmp(s, "PEM") == 0 || strcmp(s, "pem") == 0) {
255 if ((flags & OPT_FMT_PEMDER) == 0)
256 return opt_format_error(s, flags);
257 *result = FORMAT_PEM;
258 } else if (strcmp(s, "PVK") == 0 || strcmp(s, "pvk") == 0) {
259 if ((flags & OPT_FMT_PVK) == 0)
260 return opt_format_error(s, flags);
261 *result = FORMAT_PVK;
262 } else if (strcmp(s, "P12") == 0 || strcmp(s, "p12") == 0
263 || strcmp(s, "PKCS12") == 0 || strcmp(s, "pkcs12") == 0) {
264 if ((flags & OPT_FMT_PKCS12) == 0)
265 return opt_format_error(s, flags);
266 *result = FORMAT_PKCS12;
275 /* Parse a cipher name, put it in *EVP_CIPHER; return 0 on failure, else 1. */
276 int opt_cipher(const char *name, const EVP_CIPHER **cipherp)
278 *cipherp = EVP_get_cipherbyname(name);
279 if (*cipherp != NULL)
281 BIO_printf(bio_err, "%s: Unknown cipher %s\n", prog, name);
286 * Parse message digest name, put it in *EVP_MD; return 0 on failure, else 1.
288 int opt_md(const char *name, const EVP_MD **mdp)
290 *mdp = EVP_get_digestbyname(name);
293 BIO_printf(bio_err, "%s: Unknown digest %s\n", prog, name);
297 /* Look through a list of name/value pairs. */
298 int opt_pair(const char *name, const OPT_PAIR* pairs, int *result)
302 for (pp = pairs; pp->name; pp++)
303 if (strcmp(pp->name, name) == 0) {
304 *result = pp->retval;
307 BIO_printf(bio_err, "%s: Value must be one of:\n", prog);
308 for (pp = pairs; pp->name; pp++)
309 BIO_printf(bio_err, "\t%s\n", pp->name);
313 /* Parse an int, put it into *result; return 0 on failure, else 1. */
314 int opt_int(const char *value, int *result)
318 if (!opt_long(value, &l))
322 BIO_printf(bio_err, "%s: Value \"%s\" outside integer range\n",
329 static void opt_number_error(const char *v)
332 struct strstr_pair_st {
336 {"0x", "a hexadecimal"},
337 {"0X", "a hexadecimal"},
341 for (i = 0; i < OSSL_NELEM(b); i++) {
342 if (strncmp(v, b[i].prefix, strlen(b[i].prefix)) == 0) {
344 "%s: Can't parse \"%s\" as %s number\n",
349 BIO_printf(bio_err, "%s: Can't parse \"%s\" as a number\n", prog, v);
353 /* Parse a long, put it into *result; return 0 on failure, else 1. */
354 int opt_long(const char *value, long *result)
361 l = strtol(value, &endp, 0);
364 || ((l == LONG_MAX || l == LONG_MIN) && errno == ERANGE)
365 || (l == 0 && errno != 0)) {
366 opt_number_error(value);
375 #if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L && \
376 defined(INTMAX_MAX) && defined(UINTMAX_MAX)
378 /* Parse an intmax_t, put it into *result; return 0 on failure, else 1. */
379 int opt_imax(const char *value, intmax_t *result)
386 m = strtoimax(value, &endp, 0);
389 || ((m == INTMAX_MAX || m == INTMAX_MIN) && errno == ERANGE)
390 || (m == 0 && errno != 0)) {
391 opt_number_error(value);
400 /* Parse a uintmax_t, put it into *result; return 0 on failure, else 1. */
401 int opt_umax(const char *value, uintmax_t *result)
408 m = strtoumax(value, &endp, 0);
411 || (m == UINTMAX_MAX && errno == ERANGE)
412 || (m == 0 && errno != 0)) {
413 opt_number_error(value);
424 * Parse an unsigned long, put it into *result; return 0 on failure, else 1.
426 int opt_ulong(const char *value, unsigned long *result)
433 l = strtoul(value, &endptr, 0);
436 || ((l == ULONG_MAX) && errno == ERANGE)
437 || (l == 0 && errno != 0)) {
438 opt_number_error(value);
448 * We pass opt as an int but cast it to "enum range" so that all the
449 * items in the OPT_V_ENUM enumeration are caught; this makes -Wswitch
450 * in gcc do the right thing.
452 enum range { OPT_V_ENUM };
454 int opt_verify(int opt, X509_VERIFY_PARAM *vpm)
460 const X509_VERIFY_PARAM *vtmp;
463 assert(opt > OPT_V__FIRST);
464 assert(opt < OPT_V__LAST);
466 switch ((enum range)opt) {
471 otmp = OBJ_txt2obj(opt_arg(), 0);
473 BIO_printf(bio_err, "%s: Invalid Policy %s\n", prog, opt_arg());
476 X509_VERIFY_PARAM_add0_policy(vpm, otmp);
479 /* purpose name -> purpose index */
480 i = X509_PURPOSE_get_by_sname(opt_arg());
482 BIO_printf(bio_err, "%s: Invalid purpose %s\n", prog, opt_arg());
486 /* purpose index -> purpose object */
487 xptmp = X509_PURPOSE_get0(i);
489 /* purpose object -> purpose value */
490 i = X509_PURPOSE_get_id(xptmp);
492 if (!X509_VERIFY_PARAM_set_purpose(vpm, i)) {
494 "%s: Internal error setting purpose %s\n",
499 case OPT_V_VERIFY_NAME:
500 vtmp = X509_VERIFY_PARAM_lookup(opt_arg());
502 BIO_printf(bio_err, "%s: Invalid verify name %s\n",
506 X509_VERIFY_PARAM_set1(vpm, vtmp);
508 case OPT_V_VERIFY_DEPTH:
511 X509_VERIFY_PARAM_set_depth(vpm, i);
513 case OPT_V_VERIFY_AUTH_LEVEL:
516 X509_VERIFY_PARAM_set_auth_level(vpm, i);
519 if (!opt_imax(opt_arg(), &t))
521 if (t != (time_t)t) {
522 BIO_printf(bio_err, "%s: epoch time out of range %s\n",
526 X509_VERIFY_PARAM_set_time(vpm, (time_t)t);
528 case OPT_V_VERIFY_HOSTNAME:
529 if (!X509_VERIFY_PARAM_set1_host(vpm, opt_arg(), 0))
532 case OPT_V_VERIFY_EMAIL:
533 if (!X509_VERIFY_PARAM_set1_email(vpm, opt_arg(), 0))
536 case OPT_V_VERIFY_IP:
537 if (!X509_VERIFY_PARAM_set1_ip_asc(vpm, opt_arg()))
540 case OPT_V_IGNORE_CRITICAL:
541 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_IGNORE_CRITICAL);
543 case OPT_V_ISSUER_CHECKS:
544 /* NOP, deprecated */
546 case OPT_V_CRL_CHECK:
547 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_CRL_CHECK);
549 case OPT_V_CRL_CHECK_ALL:
550 X509_VERIFY_PARAM_set_flags(vpm,
551 X509_V_FLAG_CRL_CHECK |
552 X509_V_FLAG_CRL_CHECK_ALL);
554 case OPT_V_POLICY_CHECK:
555 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_POLICY_CHECK);
557 case OPT_V_EXPLICIT_POLICY:
558 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_EXPLICIT_POLICY);
560 case OPT_V_INHIBIT_ANY:
561 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_INHIBIT_ANY);
563 case OPT_V_INHIBIT_MAP:
564 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_INHIBIT_MAP);
566 case OPT_V_X509_STRICT:
567 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_X509_STRICT);
569 case OPT_V_EXTENDED_CRL:
570 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_EXTENDED_CRL_SUPPORT);
572 case OPT_V_USE_DELTAS:
573 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_USE_DELTAS);
575 case OPT_V_POLICY_PRINT:
576 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_NOTIFY_POLICY);
578 case OPT_V_CHECK_SS_SIG:
579 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_CHECK_SS_SIGNATURE);
581 case OPT_V_TRUSTED_FIRST:
582 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_TRUSTED_FIRST);
584 case OPT_V_SUITEB_128_ONLY:
585 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_SUITEB_128_LOS_ONLY);
587 case OPT_V_SUITEB_128:
588 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_SUITEB_128_LOS);
590 case OPT_V_SUITEB_192:
591 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_SUITEB_192_LOS);
593 case OPT_V_PARTIAL_CHAIN:
594 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_PARTIAL_CHAIN);
596 case OPT_V_NO_ALT_CHAINS:
597 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_NO_ALT_CHAINS);
599 case OPT_V_NO_CHECK_TIME:
600 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_NO_CHECK_TIME);
602 case OPT_V_ALLOW_PROXY_CERTS:
603 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_ALLOW_PROXY_CERTS);
611 * Parse the next flag (and value if specified), return 0 if done, -1 on
612 * error, otherwise the flag's retval.
622 ossl_uintmax_t umval;
624 /* Look at current arg; at end of the list? */
630 /* If word doesn't start with a -, we're done. */
634 /* Hit "--" ? We're done. */
636 if (strcmp(p, "--") == 0)
639 /* Allow -nnn and --nnn */
644 /* If we have --flag=foo, snip it off */
645 if ((arg = strchr(p, '=')) != NULL)
647 for (o = opts; o->name; ++o) {
648 /* If not this option, move on to the next one. */
649 if (strcmp(p, o->name) != 0)
652 /* If it doesn't take a value, make sure none was given. */
653 if (o->valtype == 0 || o->valtype == '-') {
656 "%s: Option -%s does not take a value\n", prog, p);
662 /* Want a value; get the next param if =foo not used. */
664 if (argv[opt_index] == NULL) {
666 "%s: Option -%s needs a value\n", prog, o->name);
669 arg = argv[opt_index++];
672 /* Syntax-check value. */
673 switch (o->valtype) {
679 if (app_isdir(arg) >= 0)
681 BIO_printf(bio_err, "%s: Not a directory: %s\n", prog, arg);
685 if (strcmp(arg, "-") == 0 || app_access(arg, R_OK) >= 0)
688 "%s: Cannot open input file %s, %s\n",
689 prog, arg, strerror(errno));
693 if (strcmp(arg, "-") == 0 || app_access(arg, W_OK) >= 0 || errno == ENOENT)
696 "%s: Cannot open output file %s, %s\n",
697 prog, arg, strerror(errno));
701 if (!opt_int(arg, &ival)
702 || (o->valtype == 'p' && ival <= 0)) {
704 "%s: Non-positive number \"%s\" for -%s\n",
710 if (!opt_imax(arg, &imval)) {
712 "%s: Invalid number \"%s\" for -%s\n",
718 if (!opt_umax(arg, &umval)) {
720 "%s: Invalid number \"%s\" for -%s\n",
726 if (!opt_long(arg, &lval)) {
728 "%s: Invalid number \"%s\" for -%s\n",
734 if (!opt_ulong(arg, &ulval)) {
736 "%s: Invalid number \"%s\" for -%s\n",
746 o->valtype == 'c' ? OPT_FMT_PDS :
747 o->valtype == 'E' ? OPT_FMT_PDE :
748 o->valtype == 'F' ? OPT_FMT_PEMDER
749 : OPT_FMT_ANY, &ival))
752 "%s: Invalid format \"%s\" for -%s\n",
757 /* Return the flag value. */
760 if (unknown != NULL) {
762 return unknown->retval;
764 BIO_printf(bio_err, "%s: Option unknown option -%s\n", prog, p);
768 /* Return the most recent flag parameter. */
774 /* Return the most recent flag. */
780 /* Return the unknown option. */
781 char *opt_unknown(void)
786 /* Return the rest of the arguments after parsing flags. */
787 char **opt_rest(void)
789 return &argv[opt_index];
792 /* How many items in remaining args? */
793 int opt_num_rest(void)
798 for (pp = opt_rest(); *pp; pp++, i++)
803 /* Return a string describing the parameter type. */
804 static const char *valtype2param(const OPTIONS *o)
806 switch (o->valtype) {
827 return "PEM|DER|ENGINE";
840 void opt_help(const OPTIONS *list)
850 /* Starts with its own help message? */
851 standard_prolog = list[0].name != OPT_HELP_STR;
853 /* Find the widest help. */
854 for (o = list; o->name; o++) {
855 if (o->name == OPT_MORE_STR)
857 i = 2 + (int)strlen(o->name);
858 if (o->valtype != '-')
859 i += 1 + strlen(valtype2param(o));
860 if (i < MAX_OPT_HELP_WIDTH && i > width)
862 assert(i < (int)sizeof(start));
866 BIO_printf(bio_err, "Usage: %s [options]\nValid options are:\n",
869 /* Now let's print. */
870 for (o = list; o->name; o++) {
871 help = o->helpstr ? o->helpstr : "(No additional info)";
872 if (o->name == OPT_HELP_STR) {
873 BIO_printf(bio_err, help, prog);
878 memset(start, ' ', sizeof(start) - 1);
879 start[sizeof(start) - 1] = '\0';
881 if (o->name == OPT_MORE_STR) {
882 /* Continuation of previous line; pad and print. */
884 BIO_printf(bio_err, "%s %s\n", start, help);
888 /* Build up the "-flag [param]" part. */
893 p += strlen(strcpy(p, o->name));
896 if (o->valtype != '-') {
898 p += strlen(strcpy(p, valtype2param(o)));
901 if ((int)(p - start) >= MAX_OPT_HELP_WIDTH) {
903 BIO_printf(bio_err, "%s\n", start);
904 memset(start, ' ', sizeof(start));
907 BIO_printf(bio_err, "%s %s\n", start, help);