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
60 #include <openssl/bio.h>
62 #define MAX_OPT_HELP_WIDTH 30
63 const char OPT_HELP_STR[] = "--";
64 const char OPT_MORE_STR[] = "---";
73 static const OPTIONS *unknown;
74 static const OPTIONS *opts;
78 * Return the simple name of the program; removing various platform gunk.
80 #if defined(OPENSSL_SYS_WIN32) || defined(OPENSSL_SYS_NETWARE)
81 char *opt_progname(const char *argv0)
87 /* find the last '/', '\' or ':' */
88 for (p = argv0 + strlen(argv0); --p > argv0;)
89 if (*p == '/' || *p == '\\' || *p == ':') {
94 /* Strip off trailing nonsense. */
97 (strcmp(&p[n - 4], ".exe") == 0 || strcmp(&p[n - 4], ".EXE") == 0))
99 #if defined(OPENSSL_SYS_NETWARE)
101 (strcmp(&p[n - 4], ".nlm") == 0 || strcmp(&p[n - 4], ".NLM") == 0))
105 /* Copy over the name, in lowercase. */
106 if (n > sizeof prog - 1)
108 for (q = prog, i = 0; i < n; i++, p++)
109 *q++ = isupper(*p) ? tolower(*p) : *p;
114 #elif defined(OPENSSL_SYS_VMS)
116 char *opt_progname(const char *argv0)
120 /* Find last special charcter sys:[foo.bar]openssl */
121 for (p = argv0 + strlen(argv0); --p > argv0;)
122 if (*p == ':' || *p == ']' || *p == '>') {
128 strncpy(prog, p, sizeof prog - 1);
129 prog[sizeof prog - 1] = '\0';
130 if (q == NULL || q - p >= sizeof prog)
137 char *opt_progname(const char *argv0)
141 /* Could use strchr, but this is like the ones above. */
142 for (p = argv0 + strlen(argv0); --p > argv0;)
147 strncpy(prog, p, sizeof prog - 1);
148 prog[sizeof prog - 1] = '\0';
153 char *opt_getprog(void)
158 /* Set up the arg parsing. */
159 char *opt_init(int ac, char **av, const OPTIONS *o)
169 for (; o->name; ++o) {
175 if (o->name == OPT_HELP_STR || o->name == OPT_MORE_STR)
180 /* Make sure options are legit. */
181 assert(o->name[0] != '-');
182 assert(o->retval > 0);
183 assert(i == 0 || i == '-'
184 || i == 'n' || i == 'p' || i == 'u'
185 || i == 's' || i == '<' || i == '>' || i == '/'
186 || i == 'f' || i == 'F');
188 /* Make sure there are no duplicates. */
189 for (next = o + 1; next->name; ++next) {
191 * Some compilers inline strcmp and the assert string is too long.
193 duplicated = strcmp(o->name, next->name) == 0;
197 if (o->name[0] == '\0') {
198 assert(unknown == NULL);
200 assert(unknown->valtype == 0 || unknown->valtype == '-');
206 static OPT_PAIR formats[] = {
207 {"PEM/DER", OPT_FMT_PEMDER},
208 {"pkcs12", OPT_FMT_PKCS12},
209 {"smime", OPT_FMT_SMIME},
210 {"engine", OPT_FMT_ENGINE},
211 {"msblob", OPT_FMT_MSBLOB},
212 {"netscape", OPT_FMT_NETSCAPE},
213 {"nss", OPT_FMT_NSS},
214 {"text", OPT_FMT_TEXT},
215 {"http", OPT_FMT_HTTP},
216 {"pvk", OPT_FMT_PVK},
220 /* Print an error message about a failed format parse. */
221 int opt_format_error(const char *s, unsigned long flags)
225 if (flags == OPT_FMT_PEMDER)
226 BIO_printf(bio_err, "%s: Bad format \"%s\"; must be pem or der\n",
229 BIO_printf(bio_err, "%s: Bad format \"%s\"; must be one of:\n",
231 for (ap = formats; ap->name; ap++)
232 if (flags & ap->retval)
233 BIO_printf(bio_err, " %s\n", ap->name);
238 /* Parse a format string, put it into *result; return 0 on failure, else 1. */
239 int opt_format(const char *s, unsigned long flags, int *result)
246 if ((flags & OPT_FMT_PEMDER) == 0)
247 return opt_format_error(s, flags);
248 *result = FORMAT_ASN1;
252 if ((flags & OPT_FMT_TEXT) == 0)
253 return opt_format_error(s, flags);
254 *result = FORMAT_TEXT;
258 if ((flags & OPT_FMT_NSS) == 0)
259 return opt_format_error(s, flags);
260 if (strcmp(s, "NSS") != 0 && strcmp(s, "nss") != 0)
261 return opt_format_error(s, flags);
262 *result = FORMAT_NSS;
266 if ((flags & OPT_FMT_SMIME) == 0)
267 return opt_format_error(s, flags);
268 *result = FORMAT_SMIME;
272 if ((flags & OPT_FMT_MSBLOB) == 0)
273 return opt_format_error(s, flags);
274 *result = FORMAT_MSBLOB;
278 if ((flags & OPT_FMT_ENGINE) == 0)
279 return opt_format_error(s, flags);
280 *result = FORMAT_ENGINE;
284 if ((flags & OPT_FMT_HTTP) == 0)
285 return opt_format_error(s, flags);
286 *result = FORMAT_HTTP;
289 if ((flags & OPT_FMT_PKCS12) == 0)
290 return opt_format_error(s, flags);
291 *result = FORMAT_PKCS12;
295 if (s[1] == '\0' || strcmp(s, "PEM") == 0 || strcmp(s, "pem") == 0) {
296 if ((flags & OPT_FMT_PEMDER) == 0)
297 return opt_format_error(s, flags);
298 *result = FORMAT_PEM;
299 } else if (strcmp(s, "PVK") == 0 || strcmp(s, "pvk") == 0) {
300 if ((flags & OPT_FMT_PVK) == 0)
301 return opt_format_error(s, flags);
302 *result = FORMAT_PVK;
303 } else if (strcmp(s, "P12") == 0 || strcmp(s, "p12") == 0
304 || strcmp(s, "PKCS12") == 0 || strcmp(s, "pkcs12") == 0) {
305 if ((flags & OPT_FMT_PKCS12) == 0)
306 return opt_format_error(s, flags);
307 *result = FORMAT_PKCS12;
315 /* Parse a cipher name, put it in *EVP_CIPHER; return 0 on failure, else 1. */
316 int opt_cipher(const char *name, const EVP_CIPHER **cipherp)
318 *cipherp = EVP_get_cipherbyname(name);
321 BIO_printf(bio_err, "%s: Unknown cipher %s\n", prog, name);
326 * Parse message digest name, put it in *EVP_MD; return 0 on failure, else 1.
328 int opt_md(const char *name, const EVP_MD **mdp)
330 *mdp = EVP_get_digestbyname(name);
333 BIO_printf(bio_err, "%s: Unknown digest %s\n", prog, name);
337 /* Look through a list of name/value pairs. */
338 int opt_pair(const char *name, const OPT_PAIR* pairs, int *result)
342 for (pp = pairs; pp->name; pp++)
343 if (strcmp(pp->name, name) == 0) {
344 *result = pp->retval;
347 BIO_printf(bio_err, "%s: Value must be one of:\n", prog);
348 for (pp = pairs; pp->name; pp++)
349 BIO_printf(bio_err, "\t%s\n", pp->name);
353 /* See if cp looks like a hex number, in case user left off the 0x */
354 static int scanforhex(const char *cp)
356 if (*cp == '0' && (cp[1] == 'x' || cp[1] == 'X'))
359 /* Look for a hex digit that isn't a regular digit. */
360 if (isxdigit(*cp) && !isdigit(*cp))
365 /* Parse an int, put it into *result; return 0 on failure, else 1. */
366 int opt_int(const char *value, int *result)
368 const char *fmt = "%d";
369 int base = scanforhex(value);
373 else if (*value == '0')
375 if (sscanf(value, fmt, result) != 1) {
376 BIO_printf(bio_err, "%s: Can't parse \"%s\" as a number\n",
383 /* Parse a long, put it into *result; return 0 on failure, else 1. */
384 int opt_long(const char *value, long *result)
387 int base = scanforhex(value);
389 *result = strtol(value, &endptr, base);
392 "%s: Bad char %c in number %s\n", prog, *endptr, value);
399 * Parse an unsigned long, put it into *result; return 0 on failure, else 1.
401 int opt_ulong(const char *value, unsigned long *result)
404 int base = scanforhex(value);
406 *result = strtoul(value, &endptr, base);
409 "%s: Bad char %c in number %s\n", prog, *endptr, value);
416 * We pass opt as an int but cast it to "enum range" so that all the
417 * items in the OPT_V_ENUM enumeration are caught; this makes -Wswitch
418 * in gcc do the right thing.
420 enum range { OPT_V_ENUM };
422 int opt_verify(int opt, X509_VERIFY_PARAM *vpm)
428 const X509_VERIFY_PARAM *vtmp;
431 assert(opt > OPT_V__FIRST);
432 assert(opt < OPT_V__LAST);
434 switch ((enum range)opt) {
439 otmp = OBJ_txt2obj(opt_arg(), 0);
441 BIO_printf(bio_err, "%s: Invalid Policy %s\n", prog, opt_arg());
444 X509_VERIFY_PARAM_add0_policy(vpm, otmp);
447 i = X509_PURPOSE_get_by_sname(opt_arg());
449 BIO_printf(bio_err, "%s: Invalid purpose %s\n", prog, opt_arg());
452 xptmp = X509_PURPOSE_get0(i);
453 i = X509_PURPOSE_get_id(xptmp);
454 X509_VERIFY_PARAM_set_purpose(vpm, i);
456 case OPT_V_VERIFY_NAME:
457 vtmp = X509_VERIFY_PARAM_lookup(opt_arg());
459 BIO_printf(bio_err, "%s: Invalid verify name %s\n",
463 X509_VERIFY_PARAM_set1(vpm, vtmp);
465 case OPT_V_VERIFY_DEPTH:
468 X509_VERIFY_PARAM_set_depth(vpm, i);
471 opt_ulong(opt_arg(), &ul);
473 X509_VERIFY_PARAM_set_time(vpm, (time_t)ul);
475 case OPT_V_VERIFY_HOSTNAME:
476 if (!X509_VERIFY_PARAM_set1_host(vpm, opt_arg(), 0))
479 case OPT_V_VERIFY_EMAIL:
480 if (!X509_VERIFY_PARAM_set1_email(vpm, opt_arg(), 0))
483 case OPT_V_VERIFY_IP:
484 if (!X509_VERIFY_PARAM_set1_ip_asc(vpm, opt_arg()))
487 case OPT_V_IGNORE_CRITICAL:
488 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_IGNORE_CRITICAL);
490 case OPT_V_ISSUER_CHECKS:
491 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_CB_ISSUER_CHECK);
493 case OPT_V_CRL_CHECK:
494 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_CRL_CHECK);
496 case OPT_V_CRL_CHECK_ALL:
497 X509_VERIFY_PARAM_set_flags(vpm,
498 X509_V_FLAG_CRL_CHECK |
499 X509_V_FLAG_CRL_CHECK_ALL);
501 case OPT_V_POLICY_CHECK:
502 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_POLICY_CHECK);
504 case OPT_V_EXPLICIT_POLICY:
505 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_EXPLICIT_POLICY);
507 case OPT_V_INHIBIT_ANY:
508 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_INHIBIT_ANY);
510 case OPT_V_INHIBIT_MAP:
511 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_INHIBIT_MAP);
513 case OPT_V_X509_STRICT:
514 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_X509_STRICT);
516 case OPT_V_EXTENDED_CRL:
517 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_EXTENDED_CRL_SUPPORT);
519 case OPT_V_USE_DELTAS:
520 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_USE_DELTAS);
522 case OPT_V_POLICY_PRINT:
523 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_NOTIFY_POLICY);
525 case OPT_V_CHECK_SS_SIG:
526 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_CHECK_SS_SIGNATURE);
528 case OPT_V_TRUSTED_FIRST:
529 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_TRUSTED_FIRST);
531 case OPT_V_SUITEB_128_ONLY:
532 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_SUITEB_128_LOS_ONLY);
534 case OPT_V_SUITEB_128:
535 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_SUITEB_128_LOS);
537 case OPT_V_SUITEB_192:
538 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_SUITEB_192_LOS);
540 case OPT_V_PARTIAL_CHAIN:
541 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_PARTIAL_CHAIN);
543 case OPT_V_NO_ALT_CHAINS:
544 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_NO_ALT_CHAINS);
546 case OPT_V_NO_CHECK_TIME:
547 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_NO_CHECK_TIME);
555 * Parse the next flag (and value if specified), return 0 if done, -1 on
556 * error, otherwise the flag's retval.
567 /* Look at current arg; at end of the list? */
573 /* If word doesn't start with a -, we're done. */
577 /* Hit "--" ? We're done. */
579 if (strcmp(p, "--") == 0)
582 /* Allow -nnn and --nnn */
587 /* If we have --flag=foo, snip it off */
588 if ((arg = strchr(p, '=')) != NULL)
590 for (o = opts; o->name; ++o) {
591 /* If not this option, move on to the next one. */
592 if (strcmp(p, o->name) != 0)
595 /* If it doesn't take a value, make sure none was given. */
596 if (o->valtype == 0 || o->valtype == '-') {
599 "%s: Option -%s does not take a value\n", prog, p);
605 /* Want a value; get the next param if =foo not used. */
607 if (argv[opt_index] == NULL) {
609 "%s: Option -%s needs a value\n", prog, o->name);
612 arg = argv[opt_index++];
615 /* Syntax-check value. */
617 * Do some basic syntax-checking on the value. These tests aren't
618 * perfect (ignore range overflow) but they catch common failures.
620 switch (o->valtype) {
626 if (app_isdir(arg) >= 0)
628 BIO_printf(bio_err, "%s: Not a directory: %s\n", prog, arg);
632 if (strcmp(arg, "-") == 0 || app_access(arg, R_OK) >= 0)
635 "%s: Cannot open input file %s, %s\n",
636 prog, arg, strerror(errno));
640 if (strcmp(arg, "-") == 0 || app_access(arg, W_OK) >= 0 || errno == ENOENT)
643 "%s: Cannot open output file %s, %s\n",
644 prog, arg, strerror(errno));
648 base = scanforhex(arg);
649 val = strtol(arg, &endptr, base);
650 if (*endptr == '\0') {
651 if (o->valtype == 'p' && val <= 0) {
653 "%s: Non-positive number \"%s\" for -%s\n",
660 "%s: Invalid number \"%s\" for -%s\n",
664 base = scanforhex(arg);
665 strtoul(arg, &endptr, base);
669 "%s: Invalid number \"%s\" for -%s\n",
675 o->valtype == 'F' ? OPT_FMT_PEMDER
676 : OPT_FMT_ANY, &dummy))
679 "%s: Invalid format \"%s\" for -%s\n",
684 /* Return the flag value. */
687 if (unknown != NULL) {
689 return unknown->retval;
691 BIO_printf(bio_err, "%s: Option unknown option -%s\n", prog, p);
695 /* Return the most recent flag parameter. */
701 /* Return the most recent flag. */
707 /* Return the unknown option. */
708 char *opt_unknown(void)
713 /* Return the rest of the arguments after parsing flags. */
714 char **opt_rest(void)
716 return &argv[opt_index];
719 /* How many items in remaining args? */
720 int opt_num_rest(void)
725 for (pp = opt_rest(); *pp; pp++, i++)
730 /* Return a string describing the parameter type. */
731 static const char *valtype2param(const OPTIONS *o)
733 switch (o->valtype) {
758 void opt_help(const OPTIONS *list)
768 /* Starts with its own help message? */
769 standard_prolog = list[0].name != OPT_HELP_STR;
771 /* Find the widest help. */
772 for (o = list; o->name; o++) {
773 if (o->name == OPT_MORE_STR)
775 i = 2 + (int)strlen(o->name);
776 if (o->valtype != '-')
777 i += 1 + strlen(valtype2param(o));
778 if (i < MAX_OPT_HELP_WIDTH && i > width)
780 assert(i < (int)sizeof start);
784 BIO_printf(bio_err, "Usage: %s [options]\nValid options are:\n",
787 /* Now let's print. */
788 for (o = list; o->name; o++) {
789 help = o->helpstr ? o->helpstr : "(No additional info)";
790 if (o->name == OPT_HELP_STR) {
791 BIO_printf(bio_err, help, prog);
796 memset(start, ' ', sizeof(start) - 1);
797 start[sizeof start - 1] = '\0';
799 if (o->name == OPT_MORE_STR) {
800 /* Continuation of previous line; padd and print. */
802 BIO_printf(bio_err, "%s %s\n", start, help);
806 /* Build up the "-flag [param]" part. */
811 p += strlen(strcpy(p, o->name));
814 if (o->valtype != '-') {
816 p += strlen(strcpy(p, valtype2param(o)));
819 if ((int)(p - start) >= MAX_OPT_HELP_WIDTH) {
821 BIO_printf(bio_err, "%s\n", start);
822 memset(start, ' ', sizeof(start));
825 BIO_printf(bio_err, "%s %s\n", start, help);
829 #ifdef COMPILE_STANDALONE_TEST_DRIVER
830 # include <sys/stat.h>
832 typedef enum OPTION_choice {
833 OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
834 OPT_IN, OPT_INFORM, OPT_OUT, OPT_COUNT, OPT_U, OPT_FLAG,
838 static OPTIONS options[] = {
839 {OPT_HELP_STR, 1, '-', "Usage: %s flags\n"},
840 {OPT_HELP_STR, 1, '-', "Valid options are:\n"},
841 {"help", OPT_HELP, '-', "Display this summary"},
842 {"in", OPT_IN, '<', "input file"},
843 {OPT_MORE_STR, 1, '-', "more detail about input"},
844 {"inform", OPT_INFORM, 'f', "input file format; defaults to pem"},
845 {"out", OPT_OUT, '>', "output file"},
846 {"count", OPT_COUNT, 'p', "a counter greater than zero"},
847 {"u", OPT_U, 'u', "an unsigned number"},
848 {"flag", OPT_FLAG, 0, "just some flag"},
849 {"str", OPT_STR, 's', "the magic word"},
850 {"areallyverylongoption", OPT_HELP, '-', "long way for help"},
856 int app_isdir(const char *name)
860 return name != NULL && stat(name, &sb) >= 0 && S_ISDIR(sb.st_mode);
863 int main(int ac, char **av)
869 bio_err = BIO_new_fp(stderr, BIO_NOCLOSE | BIO_FP_TEXT);
871 prog = opt_init(ac, av, options);
872 while ((o = opt_next()) != OPT_EOF) {
877 printf("%s: Usage error; try -help.\n", prog);
883 printf("in %s\n", opt_arg());
886 printf("inform %s\n", opt_arg());
889 printf("out %s\n", opt_arg());
892 printf("count %s\n", opt_arg());
895 printf("u %s\n", opt_arg());
901 printf("str %s\n", opt_arg());
905 argc = opt_num_rest();
908 printf("args = %d\n", argc);
911 printf(" %s\n", *argv++);