2 * Copyright 2015-2018 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 {"nss", OPT_FMT_NSS},
172 {"text", OPT_FMT_TEXT},
173 {"http", OPT_FMT_HTTP},
174 {"pvk", OPT_FMT_PVK},
178 /* Print an error message about a failed format parse. */
179 int opt_format_error(const char *s, unsigned long flags)
183 if (flags == OPT_FMT_PEMDER) {
184 BIO_printf(bio_err, "%s: Bad format \"%s\"; must be pem or der\n",
187 BIO_printf(bio_err, "%s: Bad format \"%s\"; must be one of:\n",
189 for (ap = formats; ap->name; ap++)
190 if (flags & ap->retval)
191 BIO_printf(bio_err, " %s\n", ap->name);
196 /* Parse a format string, put it into *result; return 0 on failure, else 1. */
197 int opt_format(const char *s, unsigned long flags, int *result)
204 if ((flags & OPT_FMT_PEMDER) == 0)
205 return opt_format_error(s, flags);
206 *result = FORMAT_ASN1;
210 if ((flags & OPT_FMT_TEXT) == 0)
211 return opt_format_error(s, flags);
212 *result = FORMAT_TEXT;
216 if ((flags & OPT_FMT_NSS) == 0)
217 return opt_format_error(s, flags);
218 if (strcmp(s, "NSS") != 0 && strcmp(s, "nss") != 0)
219 return opt_format_error(s, flags);
220 *result = FORMAT_NSS;
224 if ((flags & OPT_FMT_SMIME) == 0)
225 return opt_format_error(s, flags);
226 *result = FORMAT_SMIME;
230 if ((flags & OPT_FMT_MSBLOB) == 0)
231 return opt_format_error(s, flags);
232 *result = FORMAT_MSBLOB;
236 if ((flags & OPT_FMT_ENGINE) == 0)
237 return opt_format_error(s, flags);
238 *result = FORMAT_ENGINE;
242 if ((flags & OPT_FMT_HTTP) == 0)
243 return opt_format_error(s, flags);
244 *result = FORMAT_HTTP;
247 if ((flags & OPT_FMT_PKCS12) == 0)
248 return opt_format_error(s, flags);
249 *result = FORMAT_PKCS12;
253 if (s[1] == '\0' || strcmp(s, "PEM") == 0 || strcmp(s, "pem") == 0) {
254 if ((flags & OPT_FMT_PEMDER) == 0)
255 return opt_format_error(s, flags);
256 *result = FORMAT_PEM;
257 } else if (strcmp(s, "PVK") == 0 || strcmp(s, "pvk") == 0) {
258 if ((flags & OPT_FMT_PVK) == 0)
259 return opt_format_error(s, flags);
260 *result = FORMAT_PVK;
261 } else if (strcmp(s, "P12") == 0 || strcmp(s, "p12") == 0
262 || strcmp(s, "PKCS12") == 0 || strcmp(s, "pkcs12") == 0) {
263 if ((flags & OPT_FMT_PKCS12) == 0)
264 return opt_format_error(s, flags);
265 *result = FORMAT_PKCS12;
274 /* Parse a cipher name, put it in *EVP_CIPHER; return 0 on failure, else 1. */
275 int opt_cipher(const char *name, const EVP_CIPHER **cipherp)
277 *cipherp = EVP_get_cipherbyname(name);
278 if (*cipherp != NULL)
280 BIO_printf(bio_err, "%s: Unrecognized flag %s\n", prog, name);
285 * Parse message digest name, put it in *EVP_MD; return 0 on failure, else 1.
287 int opt_md(const char *name, const EVP_MD **mdp)
289 *mdp = EVP_get_digestbyname(name);
292 BIO_printf(bio_err, "%s: Unrecognized flag %s\n", prog, name);
296 /* Look through a list of name/value pairs. */
297 int opt_pair(const char *name, const OPT_PAIR* pairs, int *result)
301 for (pp = pairs; pp->name; pp++)
302 if (strcmp(pp->name, name) == 0) {
303 *result = pp->retval;
306 BIO_printf(bio_err, "%s: Value must be one of:\n", prog);
307 for (pp = pairs; pp->name; pp++)
308 BIO_printf(bio_err, "\t%s\n", pp->name);
312 /* Parse an int, put it into *result; return 0 on failure, else 1. */
313 int opt_int(const char *value, int *result)
317 if (!opt_long(value, &l))
321 BIO_printf(bio_err, "%s: Value \"%s\" outside integer range\n",
328 static void opt_number_error(const char *v)
331 struct strstr_pair_st {
335 {"0x", "a hexadecimal"},
336 {"0X", "a hexadecimal"},
340 for (i = 0; i < OSSL_NELEM(b); i++) {
341 if (strncmp(v, b[i].prefix, strlen(b[i].prefix)) == 0) {
343 "%s: Can't parse \"%s\" as %s number\n",
348 BIO_printf(bio_err, "%s: Can't parse \"%s\" as a number\n", prog, v);
352 /* Parse a long, put it into *result; return 0 on failure, else 1. */
353 int opt_long(const char *value, long *result)
360 l = strtol(value, &endp, 0);
363 || ((l == LONG_MAX || l == LONG_MIN) && errno == ERANGE)
364 || (l == 0 && errno != 0)) {
365 opt_number_error(value);
374 #if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L && \
375 defined(INTMAX_MAX) && defined(UINTMAX_MAX)
377 /* Parse an intmax_t, put it into *result; return 0 on failure, else 1. */
378 int opt_imax(const char *value, intmax_t *result)
385 m = strtoimax(value, &endp, 0);
388 || ((m == INTMAX_MAX || m == INTMAX_MIN) && errno == ERANGE)
389 || (m == 0 && errno != 0)) {
390 opt_number_error(value);
399 /* Parse a uintmax_t, put it into *result; return 0 on failure, else 1. */
400 int opt_umax(const char *value, uintmax_t *result)
407 m = strtoumax(value, &endp, 0);
410 || (m == UINTMAX_MAX && errno == ERANGE)
411 || (m == 0 && errno != 0)) {
412 opt_number_error(value);
423 * Parse an unsigned long, put it into *result; return 0 on failure, else 1.
425 int opt_ulong(const char *value, unsigned long *result)
432 l = strtoul(value, &endptr, 0);
435 || ((l == ULONG_MAX) && errno == ERANGE)
436 || (l == 0 && errno != 0)) {
437 opt_number_error(value);
447 * We pass opt as an int but cast it to "enum range" so that all the
448 * items in the OPT_V_ENUM enumeration are caught; this makes -Wswitch
449 * in gcc do the right thing.
451 enum range { OPT_V_ENUM };
453 int opt_verify(int opt, X509_VERIFY_PARAM *vpm)
459 const X509_VERIFY_PARAM *vtmp;
462 assert(opt > OPT_V__FIRST);
463 assert(opt < OPT_V__LAST);
465 switch ((enum range)opt) {
470 otmp = OBJ_txt2obj(opt_arg(), 0);
472 BIO_printf(bio_err, "%s: Invalid Policy %s\n", prog, opt_arg());
475 X509_VERIFY_PARAM_add0_policy(vpm, otmp);
478 /* purpose name -> purpose index */
479 i = X509_PURPOSE_get_by_sname(opt_arg());
481 BIO_printf(bio_err, "%s: Invalid purpose %s\n", prog, opt_arg());
485 /* purpose index -> purpose object */
486 xptmp = X509_PURPOSE_get0(i);
488 /* purpose object -> purpose value */
489 i = X509_PURPOSE_get_id(xptmp);
491 if (!X509_VERIFY_PARAM_set_purpose(vpm, i)) {
493 "%s: Internal error setting purpose %s\n",
498 case OPT_V_VERIFY_NAME:
499 vtmp = X509_VERIFY_PARAM_lookup(opt_arg());
501 BIO_printf(bio_err, "%s: Invalid verify name %s\n",
505 X509_VERIFY_PARAM_set1(vpm, vtmp);
507 case OPT_V_VERIFY_DEPTH:
510 X509_VERIFY_PARAM_set_depth(vpm, i);
512 case OPT_V_VERIFY_AUTH_LEVEL:
515 X509_VERIFY_PARAM_set_auth_level(vpm, i);
518 if (!opt_imax(opt_arg(), &t))
520 if (t != (time_t)t) {
521 BIO_printf(bio_err, "%s: epoch time out of range %s\n",
525 X509_VERIFY_PARAM_set_time(vpm, (time_t)t);
527 case OPT_V_VERIFY_HOSTNAME:
528 if (!X509_VERIFY_PARAM_set1_host(vpm, opt_arg(), 0))
531 case OPT_V_VERIFY_EMAIL:
532 if (!X509_VERIFY_PARAM_set1_email(vpm, opt_arg(), 0))
535 case OPT_V_VERIFY_IP:
536 if (!X509_VERIFY_PARAM_set1_ip_asc(vpm, opt_arg()))
539 case OPT_V_IGNORE_CRITICAL:
540 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_IGNORE_CRITICAL);
542 case OPT_V_ISSUER_CHECKS:
543 /* NOP, deprecated */
545 case OPT_V_CRL_CHECK:
546 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_CRL_CHECK);
548 case OPT_V_CRL_CHECK_ALL:
549 X509_VERIFY_PARAM_set_flags(vpm,
550 X509_V_FLAG_CRL_CHECK |
551 X509_V_FLAG_CRL_CHECK_ALL);
553 case OPT_V_POLICY_CHECK:
554 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_POLICY_CHECK);
556 case OPT_V_EXPLICIT_POLICY:
557 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_EXPLICIT_POLICY);
559 case OPT_V_INHIBIT_ANY:
560 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_INHIBIT_ANY);
562 case OPT_V_INHIBIT_MAP:
563 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_INHIBIT_MAP);
565 case OPT_V_X509_STRICT:
566 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_X509_STRICT);
568 case OPT_V_EXTENDED_CRL:
569 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_EXTENDED_CRL_SUPPORT);
571 case OPT_V_USE_DELTAS:
572 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_USE_DELTAS);
574 case OPT_V_POLICY_PRINT:
575 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_NOTIFY_POLICY);
577 case OPT_V_CHECK_SS_SIG:
578 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_CHECK_SS_SIGNATURE);
580 case OPT_V_TRUSTED_FIRST:
581 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_TRUSTED_FIRST);
583 case OPT_V_SUITEB_128_ONLY:
584 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_SUITEB_128_LOS_ONLY);
586 case OPT_V_SUITEB_128:
587 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_SUITEB_128_LOS);
589 case OPT_V_SUITEB_192:
590 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_SUITEB_192_LOS);
592 case OPT_V_PARTIAL_CHAIN:
593 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_PARTIAL_CHAIN);
595 case OPT_V_NO_ALT_CHAINS:
596 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_NO_ALT_CHAINS);
598 case OPT_V_NO_CHECK_TIME:
599 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_NO_CHECK_TIME);
601 case OPT_V_ALLOW_PROXY_CERTS:
602 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_ALLOW_PROXY_CERTS);
610 * Parse the next flag (and value if specified), return 0 if done, -1 on
611 * error, otherwise the flag's retval.
621 ossl_uintmax_t umval;
623 /* Look at current arg; at end of the list? */
629 /* If word doesn't start with a -, we're done. */
633 /* Hit "--" ? We're done. */
635 if (strcmp(p, "--") == 0)
638 /* Allow -nnn and --nnn */
643 /* If we have --flag=foo, snip it off */
644 if ((arg = strchr(p, '=')) != NULL)
646 for (o = opts; o->name; ++o) {
647 /* If not this option, move on to the next one. */
648 if (strcmp(p, o->name) != 0)
651 /* If it doesn't take a value, make sure none was given. */
652 if (o->valtype == 0 || o->valtype == '-') {
655 "%s: Option -%s does not take a value\n", prog, p);
661 /* Want a value; get the next param if =foo not used. */
663 if (argv[opt_index] == NULL) {
665 "%s: Option -%s needs a value\n", prog, o->name);
668 arg = argv[opt_index++];
671 /* Syntax-check value. */
672 switch (o->valtype) {
678 if (app_isdir(arg) > 0)
680 BIO_printf(bio_err, "%s: Not a directory: %s\n", prog, arg);
690 if (!opt_int(arg, &ival)
691 || (o->valtype == 'p' && ival <= 0)) {
693 "%s: Non-positive number \"%s\" for -%s\n",
699 if (!opt_imax(arg, &imval)) {
701 "%s: Invalid number \"%s\" for -%s\n",
707 if (!opt_umax(arg, &umval)) {
709 "%s: Invalid number \"%s\" for -%s\n",
715 if (!opt_long(arg, &lval)) {
717 "%s: Invalid number \"%s\" for -%s\n",
723 if (!opt_ulong(arg, &ulval)) {
725 "%s: Invalid number \"%s\" for -%s\n",
735 o->valtype == 'c' ? OPT_FMT_PDS :
736 o->valtype == 'E' ? OPT_FMT_PDE :
737 o->valtype == 'F' ? OPT_FMT_PEMDER
738 : OPT_FMT_ANY, &ival))
741 "%s: Invalid format \"%s\" for -%s\n",
746 /* Return the flag value. */
749 if (unknown != NULL) {
751 return unknown->retval;
753 BIO_printf(bio_err, "%s: Option unknown option -%s\n", prog, p);
757 /* Return the most recent flag parameter. */
763 /* Return the most recent flag. */
769 /* Return the unknown option. */
770 char *opt_unknown(void)
775 /* Return the rest of the arguments after parsing flags. */
776 char **opt_rest(void)
778 return &argv[opt_index];
781 /* How many items in remaining args? */
782 int opt_num_rest(void)
787 for (pp = opt_rest(); *pp; pp++, i++)
792 /* Return a string describing the parameter type. */
793 static const char *valtype2param(const OPTIONS *o)
795 switch (o->valtype) {
816 return "PEM|DER|ENGINE";
829 void opt_help(const OPTIONS *list)
839 /* Starts with its own help message? */
840 standard_prolog = list[0].name != OPT_HELP_STR;
842 /* Find the widest help. */
843 for (o = list; o->name; o++) {
844 if (o->name == OPT_MORE_STR)
846 i = 2 + (int)strlen(o->name);
847 if (o->valtype != '-')
848 i += 1 + strlen(valtype2param(o));
849 if (i < MAX_OPT_HELP_WIDTH && i > width)
851 assert(i < (int)sizeof(start));
855 BIO_printf(bio_err, "Usage: %s [options]\nValid options are:\n",
858 /* Now let's print. */
859 for (o = list; o->name; o++) {
860 help = o->helpstr ? o->helpstr : "(No additional info)";
861 if (o->name == OPT_HELP_STR) {
862 BIO_printf(bio_err, help, prog);
867 memset(start, ' ', sizeof(start) - 1);
868 start[sizeof(start) - 1] = '\0';
870 if (o->name == OPT_MORE_STR) {
871 /* Continuation of previous line; pad and print. */
873 BIO_printf(bio_err, "%s %s\n", start, help);
877 /* Build up the "-flag [param]" part. */
882 p += strlen(strcpy(p, o->name));
885 if (o->valtype != '-') {
887 p += strlen(strcpy(p, valtype2param(o)));
890 if ((int)(p - start) >= MAX_OPT_HELP_WIDTH) {
892 BIO_printf(bio_err, "%s\n", start);
893 memset(start, ' ', sizeof(start));
896 BIO_printf(bio_err, "%s %s\n", start, help);