1 /* ====================================================================
2 * Copyright (c) 2015 The OpenSSL Project. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
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
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/)"
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.
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.
30 * 6. Redistributions of any form whatsoever must retain the following
32 * "This product includes software developed by the OpenSSL Project
33 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
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 * ====================================================================
50 /* #define COMPILE_STANDALONE_TEST_DRIVER */
53 #if !defined(OPENSSL_SYS_MSDOS)
54 # include OPENSSL_UNISTD
61 #include <openssl/bio.h>
63 #define MAX_OPT_HELP_WIDTH 30
64 const char OPT_HELP_STR[] = "--";
65 const char OPT_MORE_STR[] = "---";
74 static const OPTIONS *unknown;
75 static const OPTIONS *opts;
78 #if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 199901L
79 #define opt_imax opt_long
80 #define opt_umax opt_ulong
84 * Return the simple name of the program; removing various platform gunk.
86 #if defined(OPENSSL_SYS_WIN32) || defined(OPENSSL_SYS_NETWARE)
87 char *opt_progname(const char *argv0)
93 /* find the last '/', '\' or ':' */
94 for (p = argv0 + strlen(argv0); --p > argv0;)
95 if (*p == '/' || *p == '\\' || *p == ':') {
100 /* Strip off trailing nonsense. */
103 (strcmp(&p[n - 4], ".exe") == 0 || strcmp(&p[n - 4], ".EXE") == 0))
105 #if defined(OPENSSL_SYS_NETWARE)
107 (strcmp(&p[n - 4], ".nlm") == 0 || strcmp(&p[n - 4], ".NLM") == 0))
111 /* Copy over the name, in lowercase. */
112 if (n > sizeof prog - 1)
114 for (q = prog, i = 0; i < n; i++, p++)
115 *q++ = isupper(*p) ? tolower(*p) : *p;
120 #elif defined(OPENSSL_SYS_VMS)
122 char *opt_progname(const char *argv0)
126 /* Find last special charcter sys:[foo.bar]openssl */
127 for (p = argv0 + strlen(argv0); --p > argv0;)
128 if (*p == ':' || *p == ']' || *p == '>') {
134 strncpy(prog, p, sizeof prog - 1);
135 prog[sizeof prog - 1] = '\0';
136 if (q != NULL && q - p < sizeof prog)
143 char *opt_progname(const char *argv0)
147 /* Could use strchr, but this is like the ones above. */
148 for (p = argv0 + strlen(argv0); --p > argv0;)
153 strncpy(prog, p, sizeof prog - 1);
154 prog[sizeof prog - 1] = '\0';
159 char *opt_getprog(void)
164 /* Set up the arg parsing. */
165 char *opt_init(int ac, char **av, const OPTIONS *o)
175 for (; o->name; ++o) {
181 if (o->name == OPT_HELP_STR || o->name == OPT_MORE_STR)
186 /* Make sure options are legit. */
187 assert(o->name[0] != '-');
188 assert(o->retval > 0);
190 case 0: case '-': case '/': case '<': case '>': case 'F': case 'M':
191 case 'L': case 'U': case 'f': case 'n': case 'p': case 's': case 'u':
197 /* Make sure there are no duplicates. */
198 for (next = o + 1; next->name; ++next) {
200 * Some compilers inline strcmp and the assert string is too long.
202 duplicated = strcmp(o->name, next->name) == 0;
206 if (o->name[0] == '\0') {
207 assert(unknown == NULL);
209 assert(unknown->valtype == 0 || unknown->valtype == '-');
215 static OPT_PAIR formats[] = {
216 {"PEM/DER", OPT_FMT_PEMDER},
217 {"pkcs12", OPT_FMT_PKCS12},
218 {"smime", OPT_FMT_SMIME},
219 {"engine", OPT_FMT_ENGINE},
220 {"msblob", OPT_FMT_MSBLOB},
221 {"netscape", OPT_FMT_NETSCAPE},
222 {"nss", OPT_FMT_NSS},
223 {"text", OPT_FMT_TEXT},
224 {"http", OPT_FMT_HTTP},
225 {"pvk", OPT_FMT_PVK},
229 /* Print an error message about a failed format parse. */
230 int opt_format_error(const char *s, unsigned long flags)
234 if (flags == OPT_FMT_PEMDER)
235 BIO_printf(bio_err, "%s: Bad format \"%s\"; must be pem or der\n",
238 BIO_printf(bio_err, "%s: Bad format \"%s\"; must be one of:\n",
240 for (ap = formats; ap->name; ap++)
241 if (flags & ap->retval)
242 BIO_printf(bio_err, " %s\n", ap->name);
247 /* Parse a format string, put it into *result; return 0 on failure, else 1. */
248 int opt_format(const char *s, unsigned long flags, int *result)
255 if ((flags & OPT_FMT_PEMDER) == 0)
256 return opt_format_error(s, flags);
257 *result = FORMAT_ASN1;
261 if ((flags & OPT_FMT_TEXT) == 0)
262 return opt_format_error(s, flags);
263 *result = FORMAT_TEXT;
267 if ((flags & OPT_FMT_NSS) == 0)
268 return opt_format_error(s, flags);
269 if (strcmp(s, "NSS") != 0 && strcmp(s, "nss") != 0)
270 return opt_format_error(s, flags);
271 *result = FORMAT_NSS;
275 if ((flags & OPT_FMT_SMIME) == 0)
276 return opt_format_error(s, flags);
277 *result = FORMAT_SMIME;
281 if ((flags & OPT_FMT_MSBLOB) == 0)
282 return opt_format_error(s, flags);
283 *result = FORMAT_MSBLOB;
287 if ((flags & OPT_FMT_ENGINE) == 0)
288 return opt_format_error(s, flags);
289 *result = FORMAT_ENGINE;
293 if ((flags & OPT_FMT_HTTP) == 0)
294 return opt_format_error(s, flags);
295 *result = FORMAT_HTTP;
298 if ((flags & OPT_FMT_PKCS12) == 0)
299 return opt_format_error(s, flags);
300 *result = FORMAT_PKCS12;
304 if (s[1] == '\0' || strcmp(s, "PEM") == 0 || strcmp(s, "pem") == 0) {
305 if ((flags & OPT_FMT_PEMDER) == 0)
306 return opt_format_error(s, flags);
307 *result = FORMAT_PEM;
308 } else if (strcmp(s, "PVK") == 0 || strcmp(s, "pvk") == 0) {
309 if ((flags & OPT_FMT_PVK) == 0)
310 return opt_format_error(s, flags);
311 *result = FORMAT_PVK;
312 } else if (strcmp(s, "P12") == 0 || strcmp(s, "p12") == 0
313 || strcmp(s, "PKCS12") == 0 || strcmp(s, "pkcs12") == 0) {
314 if ((flags & OPT_FMT_PKCS12) == 0)
315 return opt_format_error(s, flags);
316 *result = FORMAT_PKCS12;
324 /* Parse a cipher name, put it in *EVP_CIPHER; return 0 on failure, else 1. */
325 int opt_cipher(const char *name, const EVP_CIPHER **cipherp)
327 *cipherp = EVP_get_cipherbyname(name);
330 BIO_printf(bio_err, "%s: Unknown cipher %s\n", prog, name);
335 * Parse message digest name, put it in *EVP_MD; return 0 on failure, else 1.
337 int opt_md(const char *name, const EVP_MD **mdp)
339 *mdp = EVP_get_digestbyname(name);
342 BIO_printf(bio_err, "%s: Unknown digest %s\n", prog, name);
346 /* Look through a list of name/value pairs. */
347 int opt_pair(const char *name, const OPT_PAIR* pairs, int *result)
351 for (pp = pairs; pp->name; pp++)
352 if (strcmp(pp->name, name) == 0) {
353 *result = pp->retval;
356 BIO_printf(bio_err, "%s: Value must be one of:\n", prog);
357 for (pp = pairs; pp->name; pp++)
358 BIO_printf(bio_err, "\t%s\n", pp->name);
362 /* Parse an int, put it into *result; return 0 on failure, else 1. */
363 int opt_int(const char *value, int *result)
367 if (!opt_long(value, &l))
371 BIO_printf(bio_err, "%s: Value \"%s\" outside integer range\n",
378 /* Parse a long, put it into *result; return 0 on failure, else 1. */
379 int opt_long(const char *value, long *result)
385 l = strtol(value, &endp, 0);
388 || ((l == LONG_MAX || l == LONG_MIN) && errno == ERANGE)
389 || (l == 0 && errno != 0)) {
390 BIO_printf(bio_err, "%s: Can't parse \"%s\" as a number\n",
400 #if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L
402 /* Parse an intmax_t, put it into *result; return 0 on failure, else 1. */
403 int opt_imax(const char *value, intmax_t *result)
409 m = strtoimax(value, &endp, 0);
412 || ((m == INTMAX_MAX || m == INTMAX_MIN) && errno == ERANGE)
413 || (m == 0 && errno != 0)) {
414 BIO_printf(bio_err, "%s: Can't parse \"%s\" as a number\n",
424 /* Parse a uintmax_t, put it into *result; return 0 on failure, else 1. */
425 int opt_umax(const char *value, uintmax_t *result)
431 m = strtoumax(value, &endp, 0);
434 || (m == UINTMAX_MAX && errno == ERANGE)
435 || (m == 0 && errno != 0)) {
436 BIO_printf(bio_err, "%s: Can't parse \"%s\" as a number\n",
448 * Parse an unsigned long, put it into *result; return 0 on failure, else 1.
450 int opt_ulong(const char *value, unsigned long *result)
456 l = strtoul(value, &endptr, 0);
459 || ((l == ULONG_MAX) && errno == ERANGE)
460 || (l == 0 && errno != 0)) {
461 BIO_printf(bio_err, "%s: Can't parse \"%s\" as an unsigned number\n",
472 * We pass opt as an int but cast it to "enum range" so that all the
473 * items in the OPT_V_ENUM enumeration are caught; this makes -Wswitch
474 * in gcc do the right thing.
476 enum range { OPT_V_ENUM };
478 int opt_verify(int opt, X509_VERIFY_PARAM *vpm)
484 const X509_VERIFY_PARAM *vtmp;
487 assert(opt > OPT_V__FIRST);
488 assert(opt < OPT_V__LAST);
490 switch ((enum range)opt) {
495 otmp = OBJ_txt2obj(opt_arg(), 0);
497 BIO_printf(bio_err, "%s: Invalid Policy %s\n", prog, opt_arg());
500 X509_VERIFY_PARAM_add0_policy(vpm, otmp);
503 i = X509_PURPOSE_get_by_sname(opt_arg());
505 BIO_printf(bio_err, "%s: Invalid purpose %s\n", prog, opt_arg());
508 xptmp = X509_PURPOSE_get0(i);
509 i = X509_PURPOSE_get_id(xptmp);
510 X509_VERIFY_PARAM_set_purpose(vpm, i);
512 case OPT_V_VERIFY_NAME:
513 vtmp = X509_VERIFY_PARAM_lookup(opt_arg());
515 BIO_printf(bio_err, "%s: Invalid verify name %s\n",
519 X509_VERIFY_PARAM_set1(vpm, vtmp);
521 case OPT_V_VERIFY_DEPTH:
524 X509_VERIFY_PARAM_set_depth(vpm, i);
527 if (!opt_imax(opt_arg(), &t))
529 if (t != (time_t)t) {
530 BIO_printf(bio_err, "%s: epoch time out of range %s\n",
534 X509_VERIFY_PARAM_set_time(vpm, (time_t)t);
536 case OPT_V_VERIFY_HOSTNAME:
537 if (!X509_VERIFY_PARAM_set1_host(vpm, opt_arg(), 0))
540 case OPT_V_VERIFY_EMAIL:
541 if (!X509_VERIFY_PARAM_set1_email(vpm, opt_arg(), 0))
544 case OPT_V_VERIFY_IP:
545 if (!X509_VERIFY_PARAM_set1_ip_asc(vpm, opt_arg()))
548 case OPT_V_IGNORE_CRITICAL:
549 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_IGNORE_CRITICAL);
551 case OPT_V_ISSUER_CHECKS:
552 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_CB_ISSUER_CHECK);
554 case OPT_V_CRL_CHECK:
555 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_CRL_CHECK);
557 case OPT_V_CRL_CHECK_ALL:
558 X509_VERIFY_PARAM_set_flags(vpm,
559 X509_V_FLAG_CRL_CHECK |
560 X509_V_FLAG_CRL_CHECK_ALL);
562 case OPT_V_POLICY_CHECK:
563 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_POLICY_CHECK);
565 case OPT_V_EXPLICIT_POLICY:
566 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_EXPLICIT_POLICY);
568 case OPT_V_INHIBIT_ANY:
569 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_INHIBIT_ANY);
571 case OPT_V_INHIBIT_MAP:
572 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_INHIBIT_MAP);
574 case OPT_V_X509_STRICT:
575 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_X509_STRICT);
577 case OPT_V_EXTENDED_CRL:
578 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_EXTENDED_CRL_SUPPORT);
580 case OPT_V_USE_DELTAS:
581 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_USE_DELTAS);
583 case OPT_V_POLICY_PRINT:
584 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_NOTIFY_POLICY);
586 case OPT_V_CHECK_SS_SIG:
587 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_CHECK_SS_SIGNATURE);
589 case OPT_V_TRUSTED_FIRST:
590 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_TRUSTED_FIRST);
592 case OPT_V_SUITEB_128_ONLY:
593 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_SUITEB_128_LOS_ONLY);
595 case OPT_V_SUITEB_128:
596 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_SUITEB_128_LOS);
598 case OPT_V_SUITEB_192:
599 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_SUITEB_192_LOS);
601 case OPT_V_PARTIAL_CHAIN:
602 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_PARTIAL_CHAIN);
604 case OPT_V_NO_ALT_CHAINS:
605 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_NO_ALT_CHAINS);
607 case OPT_V_NO_CHECK_TIME:
608 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_NO_CHECK_TIME);
616 * Parse the next flag (and value if specified), return 0 if done, -1 on
617 * error, otherwise the flag's retval.
627 ossl_uintmax_t umval;
629 /* Look at current arg; at end of the list? */
635 /* If word doesn't start with a -, we're done. */
639 /* Hit "--" ? We're done. */
641 if (strcmp(p, "--") == 0)
644 /* Allow -nnn and --nnn */
649 /* If we have --flag=foo, snip it off */
650 if ((arg = strchr(p, '=')) != NULL)
652 for (o = opts; o->name; ++o) {
653 /* If not this option, move on to the next one. */
654 if (strcmp(p, o->name) != 0)
657 /* If it doesn't take a value, make sure none was given. */
658 if (o->valtype == 0 || o->valtype == '-') {
661 "%s: Option -%s does not take a value\n", prog, p);
667 /* Want a value; get the next param if =foo not used. */
669 if (argv[opt_index] == NULL) {
671 "%s: Option -%s needs a value\n", prog, o->name);
674 arg = argv[opt_index++];
677 /* Syntax-check value. */
678 switch (o->valtype) {
684 if (app_isdir(arg) >= 0)
686 BIO_printf(bio_err, "%s: Not a directory: %s\n", prog, arg);
690 if (strcmp(arg, "-") == 0 || app_access(arg, R_OK) >= 0)
693 "%s: Cannot open input file %s, %s\n",
694 prog, arg, strerror(errno));
698 if (strcmp(arg, "-") == 0 || app_access(arg, W_OK) >= 0 || errno == ENOENT)
701 "%s: Cannot open output file %s, %s\n",
702 prog, arg, strerror(errno));
706 if (!opt_int(arg, &ival)
707 || (o->valtype == 'p' && ival <= 0)) {
709 "%s: Non-positive number \"%s\" for -%s\n",
715 if (!opt_imax(arg, &imval)) {
717 "%s: Invalid number \"%s\" for -%s\n",
723 if (!opt_umax(arg, &umval)) {
725 "%s: Invalid number \"%s\" for -%s\n",
731 if (!opt_long(arg, &lval)) {
733 "%s: Invalid number \"%s\" for -%s\n",
739 if (!opt_ulong(arg, &ulval)) {
741 "%s: Invalid number \"%s\" for -%s\n",
749 o->valtype == 'F' ? OPT_FMT_PEMDER
750 : OPT_FMT_ANY, &ival))
753 "%s: Invalid format \"%s\" for -%s\n",
758 /* Return the flag value. */
761 if (unknown != NULL) {
763 return unknown->retval;
765 BIO_printf(bio_err, "%s: Option 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) {
832 void opt_help(const OPTIONS *list)
842 /* Starts with its own help message? */
843 standard_prolog = list[0].name != OPT_HELP_STR;
845 /* Find the widest help. */
846 for (o = list; o->name; o++) {
847 if (o->name == OPT_MORE_STR)
849 i = 2 + (int)strlen(o->name);
850 if (o->valtype != '-')
851 i += 1 + strlen(valtype2param(o));
852 if (i < MAX_OPT_HELP_WIDTH && i > width)
854 assert(i < (int)sizeof start);
858 BIO_printf(bio_err, "Usage: %s [options]\nValid options are:\n",
861 /* Now let's print. */
862 for (o = list; o->name; o++) {
863 help = o->helpstr ? o->helpstr : "(No additional info)";
864 if (o->name == OPT_HELP_STR) {
865 BIO_printf(bio_err, help, prog);
870 memset(start, ' ', sizeof(start) - 1);
871 start[sizeof start - 1] = '\0';
873 if (o->name == OPT_MORE_STR) {
874 /* Continuation of previous line; padd and print. */
876 BIO_printf(bio_err, "%s %s\n", start, help);
880 /* Build up the "-flag [param]" part. */
885 p += strlen(strcpy(p, o->name));
888 if (o->valtype != '-') {
890 p += strlen(strcpy(p, valtype2param(o)));
893 if ((int)(p - start) >= MAX_OPT_HELP_WIDTH) {
895 BIO_printf(bio_err, "%s\n", start);
896 memset(start, ' ', sizeof(start));
899 BIO_printf(bio_err, "%s %s\n", start, help);
903 #ifdef COMPILE_STANDALONE_TEST_DRIVER
904 # include <sys/stat.h>
906 typedef enum OPTION_choice {
907 OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
908 OPT_IN, OPT_INFORM, OPT_OUT, OPT_COUNT, OPT_U, OPT_FLAG,
912 static OPTIONS options[] = {
913 {OPT_HELP_STR, 1, '-', "Usage: %s flags\n"},
914 {OPT_HELP_STR, 1, '-', "Valid options are:\n"},
915 {"help", OPT_HELP, '-', "Display this summary"},
916 {"in", OPT_IN, '<', "input file"},
917 {OPT_MORE_STR, 1, '-', "more detail about input"},
918 {"inform", OPT_INFORM, 'f', "input file format; defaults to pem"},
919 {"out", OPT_OUT, '>', "output file"},
920 {"count", OPT_COUNT, 'p', "a counter greater than zero"},
921 {"u", OPT_U, 'u', "an unsigned number"},
922 {"flag", OPT_FLAG, 0, "just some flag"},
923 {"str", OPT_STR, 's', "the magic word"},
924 {"areallyverylongoption", OPT_HELP, '-', "long way for help"},
930 int app_isdir(const char *name)
934 return name != NULL && stat(name, &sb) >= 0 && S_ISDIR(sb.st_mode);
937 int main(int ac, char **av)
943 bio_err = BIO_new_fp(stderr, BIO_NOCLOSE | BIO_FP_TEXT);
945 prog = opt_init(ac, av, options);
946 while ((o = opt_next()) != OPT_EOF) {
951 printf("%s: Usage error; try -help.\n", prog);
957 printf("in %s\n", opt_arg());
960 printf("inform %s\n", opt_arg());
963 printf("out %s\n", opt_arg());
966 printf("count %s\n", opt_arg());
969 printf("u %s\n", opt_arg());
975 printf("str %s\n", opt_arg());
979 argc = opt_num_rest();
982 printf("args = %d\n", argc);
985 printf(" %s\n", *argv++);