2 * Copyright 2015-2018 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (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 * This file is also used by the test suite. Do not #include "apps.h".
15 #include "internal/nelem.h"
17 #if !defined(OPENSSL_SYS_MSDOS)
25 #include <openssl/bio.h>
26 #include <openssl/x509v3.h>
28 #define MAX_OPT_HELP_WIDTH 30
29 const char OPT_HELP_STR[] = "-H";
30 const char OPT_MORE_STR[] = "-M";
31 const char OPT_SECTION_STR[] = "-S";
32 const char OPT_PARAM_STR[] = "-P";
41 static const OPTIONS *unknown;
42 static const OPTIONS *opts;
46 * Return the simple name of the program; removing various platform gunk.
48 #if defined(OPENSSL_SYS_WIN32)
49 char *opt_progname(const char *argv0)
55 /* find the last '/', '\' or ':' */
56 for (p = argv0 + strlen(argv0); --p > argv0;)
57 if (*p == '/' || *p == '\\' || *p == ':') {
62 /* Strip off trailing nonsense. */
65 (strcmp(&p[n - 4], ".exe") == 0 || strcmp(&p[n - 4], ".EXE") == 0))
68 /* Copy over the name, in lowercase. */
69 if (n > sizeof(prog) - 1)
71 for (q = prog, i = 0; i < n; i++, p++)
72 *q++ = tolower((unsigned char)*p);
77 #elif defined(OPENSSL_SYS_VMS)
79 char *opt_progname(const char *argv0)
83 /* Find last special character sys:[foo.bar]openssl */
84 for (p = argv0 + strlen(argv0); --p > argv0;)
85 if (*p == ':' || *p == ']' || *p == '>') {
91 strncpy(prog, p, sizeof(prog) - 1);
92 prog[sizeof(prog) - 1] = '\0';
93 if (q != NULL && q - p < sizeof(prog))
100 char *opt_progname(const char *argv0)
104 /* Could use strchr, but this is like the ones above. */
105 for (p = argv0 + strlen(argv0); --p > argv0;)
110 strncpy(prog, p, sizeof(prog) - 1);
111 prog[sizeof(prog) - 1] = '\0';
116 char *opt_getprog(void)
121 /* Set up the arg parsing. */
122 char *opt_init(int ac, char **av, const OPTIONS *o)
132 /* Check all options up until the PARAM marker (if present) */
133 for (; o->name != NULL && o->name != OPT_PARAM_STR; ++o) {
139 if (o->name == OPT_HELP_STR
140 || o->name == OPT_MORE_STR
141 || o->name == OPT_SECTION_STR)
146 /* Make sure options are legit. */
147 OPENSSL_assert(o->name[0] != '-');
148 OPENSSL_assert(o->retval > 0);
150 case 0: case '-': case '/': case '<': case '>': case 'E': case 'F':
151 case 'M': case 'U': case 'f': case 'l': case 'n': case 'p': case 's':
152 case 'u': case 'c': case ':':
158 /* Make sure there are no duplicates. */
159 for (next = o + 1; next->name; ++next) {
161 * Some compilers inline strcmp and the assert string is too long.
163 duplicated = strcmp(o->name, next->name) == 0;
164 OPENSSL_assert(!duplicated);
167 if (o->name[0] == '\0') {
168 OPENSSL_assert(unknown == NULL);
170 OPENSSL_assert(unknown->valtype == 0 || unknown->valtype == '-');
176 static OPT_PAIR formats[] = {
177 {"PEM/DER", OPT_FMT_PEMDER},
178 {"pkcs12", OPT_FMT_PKCS12},
179 {"smime", OPT_FMT_SMIME},
180 {"engine", OPT_FMT_ENGINE},
181 {"msblob", OPT_FMT_MSBLOB},
182 {"nss", OPT_FMT_NSS},
183 {"text", OPT_FMT_TEXT},
184 {"http", OPT_FMT_HTTP},
185 {"pvk", OPT_FMT_PVK},
189 /* Print an error message about a failed format parse. */
190 int opt_format_error(const char *s, unsigned long flags)
194 if (flags == OPT_FMT_PEMDER) {
195 opt_printf_stderr("%s: Bad format \"%s\"; must be pem or der\n",
198 opt_printf_stderr("%s: Bad format \"%s\"; must be one of:\n",
200 for (ap = formats; ap->name; ap++)
201 if (flags & ap->retval)
202 opt_printf_stderr(" %s\n", ap->name);
207 /* Parse a format string, put it into *result; return 0 on failure, else 1. */
208 int opt_format(const char *s, unsigned long flags, int *result)
215 if ((flags & OPT_FMT_PEMDER) == 0)
216 return opt_format_error(s, flags);
217 *result = FORMAT_ASN1;
221 if ((flags & OPT_FMT_TEXT) == 0)
222 return opt_format_error(s, flags);
223 *result = FORMAT_TEXT;
227 if ((flags & OPT_FMT_NSS) == 0)
228 return opt_format_error(s, flags);
229 if (strcmp(s, "NSS") != 0 && strcmp(s, "nss") != 0)
230 return opt_format_error(s, flags);
231 *result = FORMAT_NSS;
235 if ((flags & OPT_FMT_SMIME) == 0)
236 return opt_format_error(s, flags);
237 *result = FORMAT_SMIME;
241 if ((flags & OPT_FMT_MSBLOB) == 0)
242 return opt_format_error(s, flags);
243 *result = FORMAT_MSBLOB;
247 if ((flags & OPT_FMT_ENGINE) == 0)
248 return opt_format_error(s, flags);
249 *result = FORMAT_ENGINE;
253 if ((flags & OPT_FMT_HTTP) == 0)
254 return opt_format_error(s, flags);
255 *result = FORMAT_HTTP;
258 if ((flags & OPT_FMT_PKCS12) == 0)
259 return opt_format_error(s, flags);
260 *result = FORMAT_PKCS12;
264 if (s[1] == '\0' || strcmp(s, "PEM") == 0 || strcmp(s, "pem") == 0) {
265 if ((flags & OPT_FMT_PEMDER) == 0)
266 return opt_format_error(s, flags);
267 *result = FORMAT_PEM;
268 } else if (strcmp(s, "PVK") == 0 || strcmp(s, "pvk") == 0) {
269 if ((flags & OPT_FMT_PVK) == 0)
270 return opt_format_error(s, flags);
271 *result = FORMAT_PVK;
272 } else if (strcmp(s, "P12") == 0 || strcmp(s, "p12") == 0
273 || strcmp(s, "PKCS12") == 0 || strcmp(s, "pkcs12") == 0) {
274 if ((flags & OPT_FMT_PKCS12) == 0)
275 return opt_format_error(s, flags);
276 *result = FORMAT_PKCS12;
285 /* Parse a cipher name, put it in *EVP_CIPHER; return 0 on failure, else 1. */
286 int opt_cipher(const char *name, const EVP_CIPHER **cipherp)
288 *cipherp = EVP_get_cipherbyname(name);
289 if (*cipherp != NULL)
291 opt_printf_stderr("%s: Unknown cipher: %s\n", prog, name);
296 * Parse message digest name, put it in *EVP_MD; return 0 on failure, else 1.
298 int opt_md(const char *name, const EVP_MD **mdp)
300 *mdp = EVP_get_digestbyname(name);
303 opt_printf_stderr("%s: Unknown message digest: %s\n", prog, name);
307 /* Look through a list of name/value pairs. */
308 int opt_pair(const char *name, const OPT_PAIR* pairs, int *result)
312 for (pp = pairs; pp->name; pp++)
313 if (strcmp(pp->name, name) == 0) {
314 *result = pp->retval;
317 opt_printf_stderr("%s: Value must be one of:\n", prog);
318 for (pp = pairs; pp->name; pp++)
319 opt_printf_stderr("\t%s\n", pp->name);
323 /* Parse an int, put it into *result; return 0 on failure, else 1. */
324 int opt_int(const char *value, int *result)
328 if (!opt_long(value, &l))
332 opt_printf_stderr("%s: Value \"%s\" outside integer range\n",
339 static void opt_number_error(const char *v)
342 struct strstr_pair_st {
346 {"0x", "a hexadecimal"},
347 {"0X", "a hexadecimal"},
351 for (i = 0; i < OSSL_NELEM(b); i++) {
352 if (strncmp(v, b[i].prefix, strlen(b[i].prefix)) == 0) {
353 opt_printf_stderr("%s: Can't parse \"%s\" as %s number\n",
358 opt_printf_stderr("%s: Can't parse \"%s\" as a number\n", prog, v);
362 /* Parse a long, put it into *result; return 0 on failure, else 1. */
363 int opt_long(const char *value, long *result)
370 l = strtol(value, &endp, 0);
373 || ((l == LONG_MAX || l == LONG_MIN) && errno == ERANGE)
374 || (l == 0 && errno != 0)) {
375 opt_number_error(value);
384 #if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L && \
385 defined(INTMAX_MAX) && defined(UINTMAX_MAX) && \
386 !defined(OPENSSL_NO_INTTYPES_H)
388 /* Parse an intmax_t, put it into *result; return 0 on failure, else 1. */
389 int opt_imax(const char *value, intmax_t *result)
396 m = strtoimax(value, &endp, 0);
399 || ((m == INTMAX_MAX || m == INTMAX_MIN) && errno == ERANGE)
400 || (m == 0 && errno != 0)) {
401 opt_number_error(value);
410 /* Parse a uintmax_t, put it into *result; return 0 on failure, else 1. */
411 int opt_umax(const char *value, uintmax_t *result)
418 m = strtoumax(value, &endp, 0);
421 || (m == UINTMAX_MAX && errno == ERANGE)
422 || (m == 0 && errno != 0)) {
423 opt_number_error(value);
434 * Parse an unsigned long, put it into *result; return 0 on failure, else 1.
436 int opt_ulong(const char *value, unsigned long *result)
443 l = strtoul(value, &endptr, 0);
446 || ((l == ULONG_MAX) && errno == ERANGE)
447 || (l == 0 && errno != 0)) {
448 opt_number_error(value);
458 * We pass opt as an int but cast it to "enum range" so that all the
459 * items in the OPT_V_ENUM enumeration are caught; this makes -Wswitch
460 * in gcc do the right thing.
462 enum range { OPT_V_ENUM };
464 int opt_verify(int opt, X509_VERIFY_PARAM *vpm)
470 const X509_VERIFY_PARAM *vtmp;
472 OPENSSL_assert(vpm != NULL);
473 OPENSSL_assert(opt > OPT_V__FIRST);
474 OPENSSL_assert(opt < OPT_V__LAST);
476 switch ((enum range)opt) {
481 otmp = OBJ_txt2obj(opt_arg(), 0);
483 opt_printf_stderr("%s: Invalid Policy %s\n", prog, opt_arg());
486 X509_VERIFY_PARAM_add0_policy(vpm, otmp);
489 /* purpose name -> purpose index */
490 i = X509_PURPOSE_get_by_sname(opt_arg());
492 opt_printf_stderr("%s: Invalid purpose %s\n", prog, opt_arg());
496 /* purpose index -> purpose object */
497 xptmp = X509_PURPOSE_get0(i);
499 /* purpose object -> purpose value */
500 i = X509_PURPOSE_get_id(xptmp);
502 if (!X509_VERIFY_PARAM_set_purpose(vpm, i)) {
503 opt_printf_stderr("%s: Internal error setting purpose %s\n",
508 case OPT_V_VERIFY_NAME:
509 vtmp = X509_VERIFY_PARAM_lookup(opt_arg());
511 opt_printf_stderr("%s: Invalid verify name %s\n",
515 X509_VERIFY_PARAM_set1(vpm, vtmp);
517 case OPT_V_VERIFY_DEPTH:
520 X509_VERIFY_PARAM_set_depth(vpm, i);
522 case OPT_V_VERIFY_AUTH_LEVEL:
525 X509_VERIFY_PARAM_set_auth_level(vpm, i);
528 if (!opt_imax(opt_arg(), &t))
530 if (t != (time_t)t) {
531 opt_printf_stderr("%s: epoch time out of range %s\n",
535 X509_VERIFY_PARAM_set_time(vpm, (time_t)t);
537 case OPT_V_VERIFY_HOSTNAME:
538 if (!X509_VERIFY_PARAM_set1_host(vpm, opt_arg(), 0))
541 case OPT_V_VERIFY_EMAIL:
542 if (!X509_VERIFY_PARAM_set1_email(vpm, opt_arg(), 0))
545 case OPT_V_VERIFY_IP:
546 if (!X509_VERIFY_PARAM_set1_ip_asc(vpm, opt_arg()))
549 case OPT_V_IGNORE_CRITICAL:
550 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_IGNORE_CRITICAL);
552 case OPT_V_ISSUER_CHECKS:
553 /* NOP, deprecated */
555 case OPT_V_CRL_CHECK:
556 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_CRL_CHECK);
558 case OPT_V_CRL_CHECK_ALL:
559 X509_VERIFY_PARAM_set_flags(vpm,
560 X509_V_FLAG_CRL_CHECK |
561 X509_V_FLAG_CRL_CHECK_ALL);
563 case OPT_V_POLICY_CHECK:
564 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_POLICY_CHECK);
566 case OPT_V_EXPLICIT_POLICY:
567 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_EXPLICIT_POLICY);
569 case OPT_V_INHIBIT_ANY:
570 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_INHIBIT_ANY);
572 case OPT_V_INHIBIT_MAP:
573 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_INHIBIT_MAP);
575 case OPT_V_X509_STRICT:
576 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_X509_STRICT);
578 case OPT_V_EXTENDED_CRL:
579 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_EXTENDED_CRL_SUPPORT);
581 case OPT_V_USE_DELTAS:
582 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_USE_DELTAS);
584 case OPT_V_POLICY_PRINT:
585 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_NOTIFY_POLICY);
587 case OPT_V_CHECK_SS_SIG:
588 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_CHECK_SS_SIGNATURE);
590 case OPT_V_TRUSTED_FIRST:
591 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_TRUSTED_FIRST);
593 case OPT_V_SUITEB_128_ONLY:
594 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_SUITEB_128_LOS_ONLY);
596 case OPT_V_SUITEB_128:
597 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_SUITEB_128_LOS);
599 case OPT_V_SUITEB_192:
600 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_SUITEB_192_LOS);
602 case OPT_V_PARTIAL_CHAIN:
603 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_PARTIAL_CHAIN);
605 case OPT_V_NO_ALT_CHAINS:
606 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_NO_ALT_CHAINS);
608 case OPT_V_NO_CHECK_TIME:
609 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_NO_CHECK_TIME);
611 case OPT_V_ALLOW_PROXY_CERTS:
612 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_ALLOW_PROXY_CERTS);
627 * Parse the next flag (and value if specified), return 0 if done, -1 on
628 * error, otherwise the flag's retval.
638 ossl_uintmax_t umval;
640 /* Look at current arg; at end of the list? */
646 /* If word doesn't start with a -, we're done. */
650 /* Hit "--" ? We're done. */
652 if (strcmp(p, "--") == 0)
655 /* Allow -nnn and --nnn */
660 /* If we have --flag=foo, snip it off */
661 if ((arg = strchr(p, '=')) != NULL)
663 for (o = opts; o->name; ++o) {
664 /* If not this option, move on to the next one. */
665 if (strcmp(p, o->name) != 0)
668 /* If it doesn't take a value, make sure none was given. */
669 if (o->valtype == 0 || o->valtype == '-') {
671 opt_printf_stderr("%s: Option -%s does not take a value\n",
678 /* Want a value; get the next param if =foo not used. */
680 if (argv[opt_index] == NULL) {
681 opt_printf_stderr("%s: Option -%s needs a value\n",
685 arg = argv[opt_index++];
688 /* Syntax-check value. */
689 switch (o->valtype) {
696 if (opt_isdir(arg) > 0)
698 opt_printf_stderr("%s: Not a directory: %s\n", prog, arg);
708 if (!opt_int(arg, &ival)
709 || (o->valtype == 'p' && ival <= 0)) {
710 opt_printf_stderr("%s: Non-positive number \"%s\" for -%s\n",
716 if (!opt_imax(arg, &imval)) {
717 opt_printf_stderr("%s: Invalid number \"%s\" for -%s\n",
723 if (!opt_umax(arg, &umval)) {
724 opt_printf_stderr("%s: Invalid number \"%s\" for -%s\n",
730 if (!opt_long(arg, &lval)) {
731 opt_printf_stderr("%s: Invalid number \"%s\" for -%s\n",
737 if (!opt_ulong(arg, &ulval)) {
738 opt_printf_stderr("%s: Invalid number \"%s\" for -%s\n",
748 o->valtype == 'c' ? OPT_FMT_PDS :
749 o->valtype == 'E' ? OPT_FMT_PDE :
750 o->valtype == 'F' ? OPT_FMT_PEMDER
751 : OPT_FMT_ANY, &ival))
753 opt_printf_stderr("%s: Invalid format \"%s\" for -%s\n",
758 /* Return the flag value. */
761 if (unknown != NULL) {
763 return unknown->retval;
765 opt_printf_stderr("%s: Unknown option: -%s\n", prog, p);
769 /* Return the most recent flag parameter. */
775 /* Return the most recent flag. */
781 /* Return the unknown option. */
782 char *opt_unknown(void)
787 /* Return the rest of the arguments after parsing flags. */
788 char **opt_rest(void)
790 return &argv[opt_index];
793 /* How many items in remaining args? */
794 int opt_num_rest(void)
799 for (pp = opt_rest(); *pp; pp++, i++)
804 /* Return a string describing the parameter type. */
805 static const char *valtype2param(const OPTIONS *o)
807 switch (o->valtype) {
830 return "PEM|DER|ENGINE";
843 void opt_print(const OPTIONS *o, int doingparams, int width)
849 help = o->helpstr ? o->helpstr : "(No additional info)";
850 if (o->name == OPT_HELP_STR) {
851 opt_printf_stderr(help, prog);
854 if (o->name == OPT_SECTION_STR) {
855 opt_printf_stderr("\n");
856 opt_printf_stderr(help, prog);
859 if (o->name == OPT_PARAM_STR) {
860 opt_printf_stderr("\nParameters:\n");
865 memset(start, ' ', sizeof(start) - 1);
866 start[sizeof(start) - 1] = '\0';
868 if (o->name == OPT_MORE_STR) {
869 /* Continuation of previous line; pad and print. */
871 opt_printf_stderr("%s %s\n", start, help);
875 /* Build up the "-flag [param]" part. */
881 p += strlen(strcpy(p, o->name));
884 if (o->valtype != '-') {
886 p += strlen(strcpy(p, valtype2param(o)));
889 if ((int)(p - start) >= MAX_OPT_HELP_WIDTH) {
891 opt_printf_stderr("%s\n", start);
892 memset(start, ' ', sizeof(start));
895 opt_printf_stderr("%s %s\n", start, help);
898 void opt_help(const OPTIONS *list)
901 int i, sawparams = 0, width = 5;
905 /* Starts with its own help message? */
906 standard_prolog = list[0].name != OPT_HELP_STR;
908 /* Find the widest help. */
909 for (o = list; o->name; o++) {
910 if (o->name == OPT_MORE_STR)
912 i = 2 + (int)strlen(o->name);
913 if (o->valtype != '-')
914 i += 1 + strlen(valtype2param(o));
915 if (i < MAX_OPT_HELP_WIDTH && i > width)
917 OPENSSL_assert(i < (int)sizeof(start));
920 if (standard_prolog) {
921 opt_printf_stderr("Usage: %s [options]\n", prog);
922 if (list[0].name != OPT_SECTION_STR)
923 opt_printf_stderr("Valid options are:\n", prog);
926 /* Now let's print. */
927 for (o = list; o->name; o++) {
928 if (o->name == OPT_PARAM_STR)
930 opt_print(o, sawparams, width);
934 /* opt_isdir section */
936 # include <windows.h>
937 int opt_isdir(const char *name)
940 # if defined(UNICODE) || defined(_UNICODE)
941 size_t i, len_0 = strlen(name) + 1;
942 WCHAR tempname[MAX_PATH];
944 if (len_0 > MAX_PATH)
947 # if !defined(_WIN32_WCE) || _WIN32_WCE>=101
948 if (!MultiByteToWideChar(CP_ACP, 0, name, len_0, tempname, MAX_PATH))
950 for (i = 0; i < len_0; i++)
951 tempname[i] = (WCHAR)name[i];
953 attr = GetFileAttributes(tempname);
955 attr = GetFileAttributes(name);
957 if (attr == INVALID_FILE_ATTRIBUTES)
959 return ((attr & FILE_ATTRIBUTE_DIRECTORY) != 0);
962 # include <sys/stat.h>
964 # if defined(_S_IFMT) && defined(_S_IFDIR)
965 # define S_ISDIR(a) (((a) & _S_IFMT) == _S_IFDIR)
967 # define S_ISDIR(a) (((a) & S_IFMT) == S_IFDIR)
971 int opt_isdir(const char *name)
973 # if defined(S_ISDIR)
976 if (stat(name, &st) == 0)
977 return S_ISDIR(st.st_mode);