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 */
54 #if !defined(OPENSSL_SYS_MSDOS)
55 # 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;
79 * Return the simple name of the program; removing various platform gunk.
81 #if defined(OPENSSL_SYS_WIN32) || defined(OPENSSL_SYS_NETWARE)
82 char *opt_progname(const char *argv0)
89 /* find the last '/', '\' or ':' */
90 for (p = argv0 + strlen(argv0); --p > argv0;)
91 if (*p == '/' || *p == '\\' || *p == ':') {
96 /* Strip off trailing nonsense. */
99 (strcmp(&p[n - 4], ".exe") == 0 || strcmp(&p[n - 4], ".EXE") == 0))
101 #if defined(OPENSSL_SYS_NETWARE)
103 (strcmp(&p[n - 4], ".nlm") == 0 || strcmp(&p[n - 4], ".NLM") == 0))
107 /* Copy over the name, in lowercase. */
108 if (n > sizeof prog - 1)
110 for (q = prog, i = 0; i < n; i++, p++)
111 *q++ = isupper(*p) ? tolower(*p) : *p;
116 #elif defined(OPENSSL_SYS_VMS)
118 char *opt_progname(const char *argv0)
122 /* Find last special charcter sys:[foo.bar]openssl */
123 for (p = argv0 + strlen(argv0); --p > argv0;)
124 if (*p == ':' || *p == ']' || *p == '>') {
130 strncpy(prog, p, sizeof prog - 1);
131 prog[sizeof prog - 1] = '\0';
132 if (q == NULL || q - p >= sizeof prog)
139 char *opt_progname(const char *argv0)
143 /* Could use strchr, but this is like the ones above. */
144 for (p = argv0 + strlen(argv0); --p > argv0;)
149 strncpy(prog, p, sizeof prog - 1);
150 prog[sizeof prog - 1] = '\0';
155 char *opt_getprog(void)
160 /* Set up the arg parsing. */
161 char *opt_init(int ac, char **av, const OPTIONS *o)
171 for (; o->name; ++o) {
177 if (o->name == OPT_HELP_STR || o->name == OPT_MORE_STR)
182 /* Make sure options are legit. */
183 assert(o->name[0] != '-');
184 assert(o->retval > 0);
185 assert(i == 0 || i == '-'
186 || i == 'n' || i == 'p' || i == 'u'
187 || i == 's' || i == '<' || i == '>' || i == '/'
188 || i == 'f' || i == 'F');
190 /* Make sure there are no duplicates. */
191 for (next = o + 1; next->name; ++next) {
193 * Some compilers inline strcmp and the assert string is too long.
195 duplicated = strcmp(o->name, next->name) == 0;
199 if (o->name[0] == '\0') {
200 assert(unknown == NULL);
202 assert(unknown->valtype == 0 || unknown->valtype == '-');
208 static OPT_PAIR formats[] = {
209 {"PEM/DER", OPT_FMT_PEMDER},
210 {"pkcs12", OPT_FMT_PKCS12},
211 {"smime", OPT_FMT_SMIME},
212 {"engine", OPT_FMT_ENGINE},
213 {"msblob", OPT_FMT_MSBLOB},
214 {"netscape", OPT_FMT_NETSCAPE},
215 {"nss", OPT_FMT_NSS},
216 {"text", OPT_FMT_TEXT},
217 {"http", OPT_FMT_HTTP},
218 {"pvk", OPT_FMT_PVK},
222 /* Print an error message about a failed format parse. */
223 int opt_format_error(const char *s, unsigned long flags)
227 if (flags == OPT_FMT_PEMDER)
228 BIO_printf(bio_err, "%s: Bad format \"%s\"; must be pem or der\n",
231 BIO_printf(bio_err, "%s: Bad format \"%s\"; must be one of:\n",
233 for (ap = formats; ap->name; ap++)
234 if (flags & ap->retval)
235 BIO_printf(bio_err, " %s\n", ap->name);
240 /* Parse a format string, put it into *result; return 0 on failure, else 1. */
241 int opt_format(const char *s, unsigned long flags, int *result)
248 if ((flags & OPT_FMT_PEMDER) == 0)
249 return opt_format_error(s, flags);
250 *result = FORMAT_ASN1;
254 if ((flags & OPT_FMT_TEXT) == 0)
255 return opt_format_error(s, flags);
256 *result = FORMAT_TEXT;
260 if (strcmp(s, "NSS") == 0 || strcmp(s, "nss") == 0) {
261 if ((flags & OPT_FMT_NSS) == 0)
262 return opt_format_error(s, flags);
263 *result = FORMAT_NSS;
265 if ((flags & OPT_FMT_NETSCAPE) == 0)
266 return opt_format_error(s, flags);
267 *result = FORMAT_NETSCAPE;
272 if ((flags & OPT_FMT_SMIME) == 0)
273 return opt_format_error(s, flags);
274 *result = FORMAT_SMIME;
278 if ((flags & OPT_FMT_MSBLOB) == 0)
279 return opt_format_error(s, flags);
280 *result = FORMAT_MSBLOB;
284 if ((flags & OPT_FMT_ENGINE) == 0)
285 return opt_format_error(s, flags);
286 *result = FORMAT_ENGINE;
290 if ((flags & OPT_FMT_HTTP) == 0)
291 return opt_format_error(s, flags);
292 *result = FORMAT_HTTP;
295 if ((flags & OPT_FMT_PKCS12) == 0)
296 return opt_format_error(s, flags);
297 *result = FORMAT_PKCS12;
301 if (s[1] == '\0' || strcmp(s, "PEM") == 0 || strcmp(s, "pem") == 0) {
302 if ((flags & OPT_FMT_PEMDER) == 0)
303 return opt_format_error(s, flags);
304 *result = FORMAT_PEM;
305 } else if (strcmp(s, "PVK") == 0 || strcmp(s, "pvk") == 0) {
306 if ((flags & OPT_FMT_PVK) == 0)
307 return opt_format_error(s, flags);
308 *result = FORMAT_PVK;
309 } else if (strcmp(s, "P12") == 0 || strcmp(s, "p12") == 0
310 || strcmp(s, "PKCS12") == 0 || strcmp(s, "pkcs12") == 0) {
311 if ((flags & OPT_FMT_PKCS12) == 0)
312 return opt_format_error(s, flags);
313 *result = FORMAT_PKCS12;
321 /* Parse a cipher name, put it in *EVP_CIPHER; return 0 on failure, else 1. */
322 int opt_cipher(const char *name, const EVP_CIPHER **cipherp)
324 *cipherp = EVP_get_cipherbyname(name);
327 BIO_printf(bio_err, "%s: Unknown cipher %s\n", prog, name);
332 * Parse message digest name, put it in *EVP_MD; return 0 on failure, else 1.
334 int opt_md(const char *name, const EVP_MD **mdp)
336 *mdp = EVP_get_digestbyname(name);
339 BIO_printf(bio_err, "%s: Unknown digest %s\n", prog, name);
343 /* Look through a list of name/value pairs. */
344 int opt_pair(const char *name, const OPT_PAIR* pairs, int *result)
348 for (pp = pairs; pp->name; pp++)
349 if (strcmp(pp->name, name) == 0) {
350 *result = pp->retval;
353 BIO_printf(bio_err, "%s: Value must be one of:\n", prog);
354 for (pp = pairs; pp->name; pp++)
355 BIO_printf(bio_err, "\t%s\n", pp->name);
359 /* See if cp looks like a hex number, in case user left off the 0x */
360 static int scanforhex(const char *cp)
362 if (*cp == '0' && (cp[1] == 'x' || cp[1] == 'X'))
365 /* Look for a hex digit that isn't a regular digit. */
366 if (isxdigit(*cp) && !isdigit(*cp))
371 /* Parse an int, put it into *result; return 0 on failure, else 1. */
372 int opt_int(const char *value, int *result)
374 const char *fmt = "%d";
375 int base = scanforhex(value);
379 else if (*value == '0')
381 if (sscanf(value, fmt, result) != 1) {
382 BIO_printf(bio_err, "%s: Can't parse \"%s\" as a number\n",
389 /* Parse a long, put it into *result; return 0 on failure, else 1. */
390 int opt_long(const char *value, long *result)
393 int base = scanforhex(value);
395 *result = strtol(value, &endptr, base);
398 "%s: Bad char %c in number %s\n", prog, *endptr, value);
405 * Parse an unsigned long, put it into *result; return 0 on failure, else 1.
407 int opt_ulong(const char *value, unsigned long *result)
410 int base = scanforhex(value);
412 *result = strtoul(value, &endptr, base);
415 "%s: Bad char %c in number %s\n", prog, *endptr, value);
422 * We pass opt as an int but cast it to "enum range" so that all the
423 * items in the OPT_V_ENUM enumeration are caught; this makes -Wswitch
424 * in gcc do the right thing.
426 enum range { OPT_V_ENUM };
428 int opt_verify(int opt, X509_VERIFY_PARAM *vpm)
434 const X509_VERIFY_PARAM *vtmp;
437 assert(opt > OPT_V__FIRST);
438 assert(opt < OPT_V__LAST);
440 switch ((enum range)opt) {
445 otmp = OBJ_txt2obj(opt_arg(), 0);
447 BIO_printf(bio_err, "%s: Invalid Policy %s\n", prog, opt_arg());
450 X509_VERIFY_PARAM_add0_policy(vpm, otmp);
453 i = X509_PURPOSE_get_by_sname(opt_arg());
455 BIO_printf(bio_err, "%s: Invalid purpose %s\n", prog, opt_arg());
458 xptmp = X509_PURPOSE_get0(i);
459 i = X509_PURPOSE_get_id(xptmp);
460 X509_VERIFY_PARAM_set_purpose(vpm, i);
462 case OPT_V_VERIFY_NAME:
463 vtmp = X509_VERIFY_PARAM_lookup(opt_arg());
465 BIO_printf(bio_err, "%s: Invalid verify name %s\n",
469 X509_VERIFY_PARAM_set1(vpm, vtmp);
471 case OPT_V_VERIFY_DEPTH:
474 X509_VERIFY_PARAM_set_depth(vpm, i);
477 opt_ulong(opt_arg(), &ul);
479 X509_VERIFY_PARAM_set_time(vpm, (time_t)ul);
481 case OPT_V_VERIFY_HOSTNAME:
482 if (!X509_VERIFY_PARAM_set1_host(vpm, opt_arg(), 0))
485 case OPT_V_VERIFY_EMAIL:
486 if (!X509_VERIFY_PARAM_set1_email(vpm, opt_arg(), 0))
489 case OPT_V_VERIFY_IP:
490 if (!X509_VERIFY_PARAM_set1_ip_asc(vpm, opt_arg()))
493 case OPT_V_IGNORE_CRITICAL:
494 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_IGNORE_CRITICAL);
496 case OPT_V_ISSUER_CHECKS:
497 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_CB_ISSUER_CHECK);
499 case OPT_V_CRL_CHECK:
500 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_CRL_CHECK);
502 case OPT_V_CRL_CHECK_ALL:
503 X509_VERIFY_PARAM_set_flags(vpm,
504 X509_V_FLAG_CRL_CHECK |
505 X509_V_FLAG_CRL_CHECK_ALL);
507 case OPT_V_POLICY_CHECK:
508 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_POLICY_CHECK);
510 case OPT_V_EXPLICIT_POLICY:
511 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_EXPLICIT_POLICY);
513 case OPT_V_INHIBIT_ANY:
514 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_INHIBIT_ANY);
516 case OPT_V_INHIBIT_MAP:
517 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_INHIBIT_MAP);
519 case OPT_V_X509_STRICT:
520 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_X509_STRICT);
522 case OPT_V_EXTENDED_CRL:
523 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_EXTENDED_CRL_SUPPORT);
525 case OPT_V_USE_DELTAS:
526 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_USE_DELTAS);
528 case OPT_V_POLICY_PRINT:
529 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_NOTIFY_POLICY);
531 case OPT_V_CHECK_SS_SIG:
532 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_CHECK_SS_SIGNATURE);
534 case OPT_V_TRUSTED_FIRST:
535 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_TRUSTED_FIRST);
537 case OPT_V_SUITEB_128_ONLY:
538 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_SUITEB_128_LOS_ONLY);
540 case OPT_V_SUITEB_128:
541 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_SUITEB_128_LOS);
543 case OPT_V_SUITEB_192:
544 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_SUITEB_192_LOS);
546 case OPT_V_PARTIAL_CHAIN:
547 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_PARTIAL_CHAIN);
549 case OPT_V_NO_ALT_CHAINS:
550 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_NO_ALT_CHAINS);
557 * Parse the next flag (and value if specified), return 0 if done, -1 on
558 * error, otherwise the flag's retval.
569 /* Look at current arg; at end of the list? */
575 /* If word doesn't start with a -, we're done. */
579 /* Hit "--" ? We're done. */
581 if (strcmp(p, "--") == 0)
584 /* Allow -nnn and --nnn */
589 /* If we have --flag=foo, snip it off */
590 if ((arg = strchr(p, '=')) != NULL)
592 for (o = opts; o->name; ++o) {
593 /* If not this option, move on to the next one. */
594 if (strcmp(p, o->name) != 0)
597 /* If it doesn't take a value, make sure none was given. */
598 if (o->valtype == 0 || o->valtype == '-') {
601 "%s: Option -%s does not take a value\n", prog, p);
607 /* Want a value; get the next param if =foo not used. */
609 if (argv[opt_index] == NULL) {
611 "%s: Option -%s needs a value\n", prog, o->name);
614 arg = argv[opt_index++];
617 /* Syntax-check value. */
619 * Do some basic syntax-checking on the value. These tests aren't
620 * perfect (ignore range overflow) but they catch common failures.
622 switch (o->valtype) {
628 if (app_isdir(arg) >= 0)
630 BIO_printf(bio_err, "%s: Not a directory: %s\n", prog, arg);
634 if (strcmp(arg, "-") == 0 || app_access(arg, R_OK) >= 0)
637 "%s: Cannot open input file %s, %s\n",
638 prog, arg, strerror(errno));
642 if (strcmp(arg, "-") == 0 || app_access(arg, W_OK) >= 0 || errno == ENOENT)
645 "%s: Cannot open output file %s, %s\n",
646 prog, arg, strerror(errno));
650 base = scanforhex(arg);
651 val = strtol(arg, &endptr, base);
652 if (*endptr == '\0') {
653 if (o->valtype == 'p' && val <= 0) {
655 "%s: Non-positive number \"%s\" for -%s\n",
662 "%s: Invalid number \"%s\" for -%s\n",
666 base = scanforhex(arg);
667 strtoul(arg, &endptr, base);
671 "%s: Invalid number \"%s\" for -%s\n",
677 o->valtype == 'F' ? OPT_FMT_PEMDER
678 : OPT_FMT_ANY, &dummy))
681 "%s: Invalid format \"%s\" for -%s\n",
686 /* Return the flag value. */
689 if (unknown != NULL) {
691 return unknown->retval;
693 BIO_printf(bio_err, "%s: Option unknown option -%s\n", prog, p);
697 /* Return the most recent flag parameter. */
703 /* Return the most recent flag. */
709 /* Return the unknown option. */
710 char *opt_unknown(void)
715 /* Return the rest of the arguments after parsing flags. */
716 char **opt_rest(void)
718 return &argv[opt_index];
721 /* How many items in remaining args? */
722 int opt_num_rest(void)
727 for (pp = opt_rest(); *pp; pp++, i++)
732 /* Return a string describing the parameter type. */
733 static const char *valtype2param(const OPTIONS *o)
735 switch (o->valtype) {
760 void opt_help(const OPTIONS *list)
770 /* Starts with its own help message? */
771 standard_prolog = list[0].name != OPT_HELP_STR;
773 /* Find the widest help. */
774 for (o = list; o->name; o++) {
775 if (o->name == OPT_MORE_STR)
777 i = 2 + (int)strlen(o->name);
778 if (o->valtype != '-')
779 i += 1 + strlen(valtype2param(o));
780 if (i < MAX_OPT_HELP_WIDTH && i > width)
782 assert(i < (int)sizeof start);
786 BIO_printf(bio_err, "Usage: %s [options]\nValid options are:\n",
789 /* Now let's print. */
790 for (o = list; o->name; o++) {
791 help = o->helpstr ? o->helpstr : "(No additional info)";
792 if (o->name == OPT_HELP_STR) {
793 BIO_printf(bio_err, help, prog);
798 memset(start, ' ', sizeof start - 1);
799 start[sizeof start - 1] = '\0';
801 if (o->name == OPT_MORE_STR) {
802 /* Continuation of previous line; padd and print. */
804 BIO_printf(bio_err, "%s %s\n", start, help);
808 /* Build up the "-flag [param]" part. */
813 p += strlen(strcpy(p, o->name));
816 if (o->valtype != '-') {
818 p += strlen(strcpy(p, valtype2param(o)));
821 if ((int)(p - start) >= MAX_OPT_HELP_WIDTH) {
823 BIO_printf(bio_err, "%s\n", start);
824 memset(start, ' ', sizeof start);
827 BIO_printf(bio_err, "%s %s\n", start, help);
831 #ifdef COMPILE_STANDALONE_TEST_DRIVER
832 # include <sys/stat.h>
834 typedef enum OPTION_choice {
835 OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
836 OPT_IN, OPT_INFORM, OPT_OUT, OPT_COUNT, OPT_U, OPT_FLAG,
840 static OPTIONS options[] = {
841 {OPT_HELP_STR, 1, '-', "Usage: %s flags\n"},
842 {OPT_HELP_STR, 1, '-', "Valid options are:\n"},
843 {"help", OPT_HELP, '-', "Display this summary"},
844 {"in", OPT_IN, '<', "input file"},
845 {OPT_MORE_STR, 1, '-', "more detail about input"},
846 {"inform", OPT_INFORM, 'f', "input file format; defaults to pem"},
847 {"out", OPT_OUT, '>', "output file"},
848 {"count", OPT_COUNT, 'p', "a counter greater than zero"},
849 {"u", OPT_U, 'u', "an unsigned number"},
850 {"flag", OPT_FLAG, 0, "just some flag"},
851 {"str", OPT_STR, 's', "the magic word"},
852 {"areallyverylongoption", OPT_HELP, '-', "long way for help"},
858 int app_isdir(const char *name)
862 return name != NULL && stat(name, &sb) >= 0 && S_ISDIR(sb.st_mode);
865 int main(int ac, char **av)
871 bio_err = BIO_new_fp(stderr, BIO_NOCLOSE | BIO_FP_TEXT);
873 prog = opt_init(ac, av, options);
874 while ((o = opt_next()) != OPT_EOF) {
879 printf("%s: Usage error; try -help.\n", prog);
885 printf("in %s\n", opt_arg());
888 printf("inform %s\n", opt_arg());
891 printf("out %s\n", opt_arg());
894 printf("count %s\n", opt_arg());
897 printf("u %s\n", opt_arg());
903 printf("str %s\n", opt_arg());
907 argc = opt_num_rest();
910 printf("args = %d\n", argc);
913 printf(" %s\n", *argv++);