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)
88 /* find the last '/', '\' or ':' */
89 for (p = argv0 + strlen(argv0); --p > argv0;)
90 if (*p == '/' || *p == '\\' || *p == ':') {
95 /* Strip off trailing nonsense. */
98 (strcmp(&p[n - 4], ".exe") == 0 || strcmp(&p[n - 4], ".EXE") == 0))
100 #if defined(OPENSSL_SYS_NETWARE)
102 (strcmp(&p[n - 4], ".nlm") == 0 || strcmp(&p[n - 4], ".NLM") == 0))
106 /* Copy over the name, in lowercase. */
107 if (n > sizeof prog - 1)
109 for (q = prog, i = 0; i < n; i++, p++)
110 *q++ = isupper(*p) ? tolower(*p) : *p;
115 #elif defined(OPENSSL_SYS_VMS)
117 char *opt_progname(const char *argv0)
121 /* Find last special charcter sys:[foo.bar]openssl */
122 for (p = argv0 + strlen(argv0); --p > argv0;)
123 if (*p == ':' || *p == ']' || *p == '>') {
129 strncpy(prog, p, sizeof prog - 1);
130 prog[sizeof prog - 1] = '\0';
131 if (q == NULL || q - p >= sizeof prog)
138 char *opt_progname(const char *argv0)
142 /* Could use strchr, but this is like the ones above. */
143 for (p = argv0 + strlen(argv0); --p > argv0;)
148 strncpy(prog, p, sizeof prog - 1);
149 prog[sizeof prog - 1] = '\0';
154 char *opt_getprog(void)
159 /* Set up the arg parsing. */
160 char *opt_init(int ac, char **av, const OPTIONS *o)
170 for (; o->name; ++o) {
176 if (o->name == OPT_HELP_STR || o->name == OPT_MORE_STR)
181 /* Make sure options are legit. */
182 assert(o->name[0] != '-');
183 assert(o->retval > 0);
184 assert(i == 0 || i == '-'
185 || i == 'n' || i == 'p' || i == 'u'
186 || i == 's' || i == '<' || i == '>' || i == '/'
187 || i == 'f' || i == 'F');
189 /* Make sure there are no duplicates. */
190 for (next = o + 1; next->name; ++next) {
192 * Some compilers inline strcmp and the assert string is too long.
194 duplicated = strcmp(o->name, next->name) == 0;
198 if (o->name[0] == '\0') {
199 assert(unknown == NULL);
201 assert(unknown->valtype == 0 || unknown->valtype == '-');
207 static OPT_PAIR formats[] = {
208 {"PEM/DER", OPT_FMT_PEMDER},
209 {"pkcs12", OPT_FMT_PKCS12},
210 {"smime", OPT_FMT_SMIME},
211 {"engine", OPT_FMT_ENGINE},
212 {"msblob", OPT_FMT_MSBLOB},
213 {"netscape", OPT_FMT_NETSCAPE},
214 {"nss", OPT_FMT_NSS},
215 {"text", OPT_FMT_TEXT},
216 {"http", OPT_FMT_HTTP},
217 {"pvk", OPT_FMT_PVK},
221 /* Print an error message about a failed format parse. */
222 int opt_format_error(const char *s, unsigned long flags)
226 if (flags == OPT_FMT_PEMDER)
227 BIO_printf(bio_err, "%s: Bad format \"%s\"; must be pem or der\n",
230 BIO_printf(bio_err, "%s: Bad format \"%s\"; must be one of:\n",
232 for (ap = formats; ap->name; ap++)
233 if (flags & ap->retval)
234 BIO_printf(bio_err, " %s\n", ap->name);
239 /* Parse a format string, put it into *result; return 0 on failure, else 1. */
240 int opt_format(const char *s, unsigned long flags, int *result)
247 if ((flags & OPT_FMT_PEMDER) == 0)
248 return opt_format_error(s, flags);
249 *result = FORMAT_ASN1;
253 if ((flags & OPT_FMT_TEXT) == 0)
254 return opt_format_error(s, flags);
255 *result = FORMAT_TEXT;
259 if ((flags & OPT_FMT_NSS) == 0)
260 return opt_format_error(s, flags);
261 if (strcmp(s, "NSS") != 0 && strcmp(s, "nss") != 0)
262 return opt_format_error(s, flags);
263 *result = FORMAT_NSS;
267 if ((flags & OPT_FMT_SMIME) == 0)
268 return opt_format_error(s, flags);
269 *result = FORMAT_SMIME;
273 if ((flags & OPT_FMT_MSBLOB) == 0)
274 return opt_format_error(s, flags);
275 *result = FORMAT_MSBLOB;
279 if ((flags & OPT_FMT_ENGINE) == 0)
280 return opt_format_error(s, flags);
281 *result = FORMAT_ENGINE;
285 if ((flags & OPT_FMT_HTTP) == 0)
286 return opt_format_error(s, flags);
287 *result = FORMAT_HTTP;
290 if ((flags & OPT_FMT_PKCS12) == 0)
291 return opt_format_error(s, flags);
292 *result = FORMAT_PKCS12;
296 if (s[1] == '\0' || strcmp(s, "PEM") == 0 || strcmp(s, "pem") == 0) {
297 if ((flags & OPT_FMT_PEMDER) == 0)
298 return opt_format_error(s, flags);
299 *result = FORMAT_PEM;
300 } else if (strcmp(s, "PVK") == 0 || strcmp(s, "pvk") == 0) {
301 if ((flags & OPT_FMT_PVK) == 0)
302 return opt_format_error(s, flags);
303 *result = FORMAT_PVK;
304 } else if (strcmp(s, "P12") == 0 || strcmp(s, "p12") == 0
305 || strcmp(s, "PKCS12") == 0 || strcmp(s, "pkcs12") == 0) {
306 if ((flags & OPT_FMT_PKCS12) == 0)
307 return opt_format_error(s, flags);
308 *result = FORMAT_PKCS12;
316 /* Parse a cipher name, put it in *EVP_CIPHER; return 0 on failure, else 1. */
317 int opt_cipher(const char *name, const EVP_CIPHER **cipherp)
319 *cipherp = EVP_get_cipherbyname(name);
322 BIO_printf(bio_err, "%s: Unknown cipher %s\n", prog, name);
327 * Parse message digest name, put it in *EVP_MD; return 0 on failure, else 1.
329 int opt_md(const char *name, const EVP_MD **mdp)
331 *mdp = EVP_get_digestbyname(name);
334 BIO_printf(bio_err, "%s: Unknown digest %s\n", prog, name);
338 /* Look through a list of name/value pairs. */
339 int opt_pair(const char *name, const OPT_PAIR* pairs, int *result)
343 for (pp = pairs; pp->name; pp++)
344 if (strcmp(pp->name, name) == 0) {
345 *result = pp->retval;
348 BIO_printf(bio_err, "%s: Value must be one of:\n", prog);
349 for (pp = pairs; pp->name; pp++)
350 BIO_printf(bio_err, "\t%s\n", pp->name);
354 /* See if cp looks like a hex number, in case user left off the 0x */
355 static int scanforhex(const char *cp)
357 if (*cp == '0' && (cp[1] == 'x' || cp[1] == 'X'))
360 /* Look for a hex digit that isn't a regular digit. */
361 if (isxdigit(*cp) && !isdigit(*cp))
366 /* Parse an int, put it into *result; return 0 on failure, else 1. */
367 int opt_int(const char *value, int *result)
369 const char *fmt = "%d";
370 int base = scanforhex(value);
374 else if (*value == '0')
376 if (sscanf(value, fmt, result) != 1) {
377 BIO_printf(bio_err, "%s: Can't parse \"%s\" as a number\n",
384 /* Parse a long, put it into *result; return 0 on failure, else 1. */
385 int opt_long(const char *value, long *result)
388 int base = scanforhex(value);
390 *result = strtol(value, &endptr, base);
393 "%s: Bad char %c in number %s\n", prog, *endptr, value);
400 * Parse an unsigned long, put it into *result; return 0 on failure, else 1.
402 int opt_ulong(const char *value, unsigned long *result)
405 int base = scanforhex(value);
407 *result = strtoul(value, &endptr, base);
410 "%s: Bad char %c in number %s\n", prog, *endptr, value);
417 * We pass opt as an int but cast it to "enum range" so that all the
418 * items in the OPT_V_ENUM enumeration are caught; this makes -Wswitch
419 * in gcc do the right thing.
421 enum range { OPT_V_ENUM };
423 int opt_verify(int opt, X509_VERIFY_PARAM *vpm)
429 const X509_VERIFY_PARAM *vtmp;
432 assert(opt > OPT_V__FIRST);
433 assert(opt < OPT_V__LAST);
435 switch ((enum range)opt) {
440 otmp = OBJ_txt2obj(opt_arg(), 0);
442 BIO_printf(bio_err, "%s: Invalid Policy %s\n", prog, opt_arg());
445 X509_VERIFY_PARAM_add0_policy(vpm, otmp);
448 i = X509_PURPOSE_get_by_sname(opt_arg());
450 BIO_printf(bio_err, "%s: Invalid purpose %s\n", prog, opt_arg());
453 xptmp = X509_PURPOSE_get0(i);
454 i = X509_PURPOSE_get_id(xptmp);
455 X509_VERIFY_PARAM_set_purpose(vpm, i);
457 case OPT_V_VERIFY_NAME:
458 vtmp = X509_VERIFY_PARAM_lookup(opt_arg());
460 BIO_printf(bio_err, "%s: Invalid verify name %s\n",
464 X509_VERIFY_PARAM_set1(vpm, vtmp);
466 case OPT_V_VERIFY_DEPTH:
469 X509_VERIFY_PARAM_set_depth(vpm, i);
472 opt_ulong(opt_arg(), &ul);
474 X509_VERIFY_PARAM_set_time(vpm, (time_t)ul);
476 case OPT_V_VERIFY_HOSTNAME:
477 if (!X509_VERIFY_PARAM_set1_host(vpm, opt_arg(), 0))
480 case OPT_V_VERIFY_EMAIL:
481 if (!X509_VERIFY_PARAM_set1_email(vpm, opt_arg(), 0))
484 case OPT_V_VERIFY_IP:
485 if (!X509_VERIFY_PARAM_set1_ip_asc(vpm, opt_arg()))
488 case OPT_V_IGNORE_CRITICAL:
489 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_IGNORE_CRITICAL);
491 case OPT_V_ISSUER_CHECKS:
492 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_CB_ISSUER_CHECK);
494 case OPT_V_CRL_CHECK:
495 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_CRL_CHECK);
497 case OPT_V_CRL_CHECK_ALL:
498 X509_VERIFY_PARAM_set_flags(vpm,
499 X509_V_FLAG_CRL_CHECK |
500 X509_V_FLAG_CRL_CHECK_ALL);
502 case OPT_V_POLICY_CHECK:
503 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_POLICY_CHECK);
505 case OPT_V_EXPLICIT_POLICY:
506 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_EXPLICIT_POLICY);
508 case OPT_V_INHIBIT_ANY:
509 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_INHIBIT_ANY);
511 case OPT_V_INHIBIT_MAP:
512 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_INHIBIT_MAP);
514 case OPT_V_X509_STRICT:
515 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_X509_STRICT);
517 case OPT_V_EXTENDED_CRL:
518 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_EXTENDED_CRL_SUPPORT);
520 case OPT_V_USE_DELTAS:
521 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_USE_DELTAS);
523 case OPT_V_POLICY_PRINT:
524 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_NOTIFY_POLICY);
526 case OPT_V_CHECK_SS_SIG:
527 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_CHECK_SS_SIGNATURE);
529 case OPT_V_TRUSTED_FIRST:
530 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_TRUSTED_FIRST);
532 case OPT_V_SUITEB_128_ONLY:
533 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_SUITEB_128_LOS_ONLY);
535 case OPT_V_SUITEB_128:
536 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_SUITEB_128_LOS);
538 case OPT_V_SUITEB_192:
539 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_SUITEB_192_LOS);
541 case OPT_V_PARTIAL_CHAIN:
542 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_PARTIAL_CHAIN);
544 case OPT_V_NO_ALT_CHAINS:
545 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_NO_ALT_CHAINS);
547 case OPT_V_NO_CHECK_TIME:
548 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_NO_CHECK_TIME);
556 * Parse the next flag (and value if specified), return 0 if done, -1 on
557 * error, otherwise the flag's retval.
568 /* Look at current arg; at end of the list? */
574 /* If word doesn't start with a -, we're done. */
578 /* Hit "--" ? We're done. */
580 if (strcmp(p, "--") == 0)
583 /* Allow -nnn and --nnn */
588 /* If we have --flag=foo, snip it off */
589 if ((arg = strchr(p, '=')) != NULL)
591 for (o = opts; o->name; ++o) {
592 /* If not this option, move on to the next one. */
593 if (strcmp(p, o->name) != 0)
596 /* If it doesn't take a value, make sure none was given. */
597 if (o->valtype == 0 || o->valtype == '-') {
600 "%s: Option -%s does not take a value\n", prog, p);
606 /* Want a value; get the next param if =foo not used. */
608 if (argv[opt_index] == NULL) {
610 "%s: Option -%s needs a value\n", prog, o->name);
613 arg = argv[opt_index++];
616 /* Syntax-check value. */
618 * Do some basic syntax-checking on the value. These tests aren't
619 * perfect (ignore range overflow) but they catch common failures.
621 switch (o->valtype) {
627 if (app_isdir(arg) >= 0)
629 BIO_printf(bio_err, "%s: Not a directory: %s\n", prog, arg);
633 if (strcmp(arg, "-") == 0 || app_access(arg, R_OK) >= 0)
636 "%s: Cannot open input file %s, %s\n",
637 prog, arg, strerror(errno));
641 if (strcmp(arg, "-") == 0 || app_access(arg, W_OK) >= 0 || errno == ENOENT)
644 "%s: Cannot open output file %s, %s\n",
645 prog, arg, strerror(errno));
649 base = scanforhex(arg);
650 val = strtol(arg, &endptr, base);
651 if (*endptr == '\0') {
652 if (o->valtype == 'p' && val <= 0) {
654 "%s: Non-positive number \"%s\" for -%s\n",
661 "%s: Invalid number \"%s\" for -%s\n",
665 base = scanforhex(arg);
666 strtoul(arg, &endptr, base);
670 "%s: Invalid number \"%s\" for -%s\n",
676 o->valtype == 'F' ? OPT_FMT_PEMDER
677 : OPT_FMT_ANY, &dummy))
680 "%s: Invalid format \"%s\" for -%s\n",
685 /* Return the flag value. */
688 if (unknown != NULL) {
690 return unknown->retval;
692 BIO_printf(bio_err, "%s: Option unknown option -%s\n", prog, p);
696 /* Return the most recent flag parameter. */
702 /* Return the most recent flag. */
708 /* Return the unknown option. */
709 char *opt_unknown(void)
714 /* Return the rest of the arguments after parsing flags. */
715 char **opt_rest(void)
717 return &argv[opt_index];
720 /* How many items in remaining args? */
721 int opt_num_rest(void)
726 for (pp = opt_rest(); *pp; pp++, i++)
731 /* Return a string describing the parameter type. */
732 static const char *valtype2param(const OPTIONS *o)
734 switch (o->valtype) {
759 void opt_help(const OPTIONS *list)
769 /* Starts with its own help message? */
770 standard_prolog = list[0].name != OPT_HELP_STR;
772 /* Find the widest help. */
773 for (o = list; o->name; o++) {
774 if (o->name == OPT_MORE_STR)
776 i = 2 + (int)strlen(o->name);
777 if (o->valtype != '-')
778 i += 1 + strlen(valtype2param(o));
779 if (i < MAX_OPT_HELP_WIDTH && i > width)
781 assert(i < (int)sizeof start);
785 BIO_printf(bio_err, "Usage: %s [options]\nValid options are:\n",
788 /* Now let's print. */
789 for (o = list; o->name; o++) {
790 help = o->helpstr ? o->helpstr : "(No additional info)";
791 if (o->name == OPT_HELP_STR) {
792 BIO_printf(bio_err, help, prog);
797 memset(start, ' ', sizeof(start) - 1);
798 start[sizeof start - 1] = '\0';
800 if (o->name == OPT_MORE_STR) {
801 /* Continuation of previous line; padd and print. */
803 BIO_printf(bio_err, "%s %s\n", start, help);
807 /* Build up the "-flag [param]" part. */
812 p += strlen(strcpy(p, o->name));
815 if (o->valtype != '-') {
817 p += strlen(strcpy(p, valtype2param(o)));
820 if ((int)(p - start) >= MAX_OPT_HELP_WIDTH) {
822 BIO_printf(bio_err, "%s\n", start);
823 memset(start, ' ', sizeof(start));
826 BIO_printf(bio_err, "%s %s\n", start, help);
830 #ifdef COMPILE_STANDALONE_TEST_DRIVER
831 # include <sys/stat.h>
833 typedef enum OPTION_choice {
834 OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
835 OPT_IN, OPT_INFORM, OPT_OUT, OPT_COUNT, OPT_U, OPT_FLAG,
839 static OPTIONS options[] = {
840 {OPT_HELP_STR, 1, '-', "Usage: %s flags\n"},
841 {OPT_HELP_STR, 1, '-', "Valid options are:\n"},
842 {"help", OPT_HELP, '-', "Display this summary"},
843 {"in", OPT_IN, '<', "input file"},
844 {OPT_MORE_STR, 1, '-', "more detail about input"},
845 {"inform", OPT_INFORM, 'f', "input file format; defaults to pem"},
846 {"out", OPT_OUT, '>', "output file"},
847 {"count", OPT_COUNT, 'p', "a counter greater than zero"},
848 {"u", OPT_U, 'u', "an unsigned number"},
849 {"flag", OPT_FLAG, 0, "just some flag"},
850 {"str", OPT_STR, 's', "the magic word"},
851 {"areallyverylongoption", OPT_HELP, '-', "long way for help"},
857 int app_isdir(const char *name)
861 return name != NULL && stat(name, &sb) >= 0 && S_ISDIR(sb.st_mode);
864 int main(int ac, char **av)
870 bio_err = BIO_new_fp(stderr, BIO_NOCLOSE | BIO_FP_TEXT);
872 prog = opt_init(ac, av, options);
873 while ((o = opt_next()) != OPT_EOF) {
878 printf("%s: Usage error; try -help.\n", prog);
884 printf("in %s\n", opt_arg());
887 printf("inform %s\n", opt_arg());
890 printf("out %s\n", opt_arg());
893 printf("count %s\n", opt_arg());
896 printf("u %s\n", opt_arg());
902 printf("str %s\n", opt_arg());
906 argc = opt_num_rest();
909 printf("args = %d\n", argc);
912 printf(" %s\n", *argv++);