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 !defined(INTMAX_MAX) && !defined(UINTMAX_MAX)
80 #define opt_imax opt_long
81 #define opt_umax opt_ulong
85 * Return the simple name of the program; removing various platform gunk.
87 #if defined(OPENSSL_SYS_WIN32) || defined(OPENSSL_SYS_NETWARE)
88 char *opt_progname(const char *argv0)
94 /* find the last '/', '\' or ':' */
95 for (p = argv0 + strlen(argv0); --p > argv0;)
96 if (*p == '/' || *p == '\\' || *p == ':') {
101 /* Strip off trailing nonsense. */
104 (strcmp(&p[n - 4], ".exe") == 0 || strcmp(&p[n - 4], ".EXE") == 0))
106 #if defined(OPENSSL_SYS_NETWARE)
108 (strcmp(&p[n - 4], ".nlm") == 0 || strcmp(&p[n - 4], ".NLM") == 0))
112 /* Copy over the name, in lowercase. */
113 if (n > sizeof prog - 1)
115 for (q = prog, i = 0; i < n; i++, p++)
116 *q++ = isupper(*p) ? tolower(*p) : *p;
121 #elif defined(OPENSSL_SYS_VMS)
123 char *opt_progname(const char *argv0)
127 /* Find last special charcter sys:[foo.bar]openssl */
128 for (p = argv0 + strlen(argv0); --p > argv0;)
129 if (*p == ':' || *p == ']' || *p == '>') {
135 strncpy(prog, p, sizeof prog - 1);
136 prog[sizeof prog - 1] = '\0';
137 if (q != NULL && q - p < sizeof prog)
144 char *opt_progname(const char *argv0)
148 /* Could use strchr, but this is like the ones above. */
149 for (p = argv0 + strlen(argv0); --p > argv0;)
154 strncpy(prog, p, sizeof prog - 1);
155 prog[sizeof prog - 1] = '\0';
160 char *opt_getprog(void)
165 /* Set up the arg parsing. */
166 char *opt_init(int ac, char **av, const OPTIONS *o)
176 for (; o->name; ++o) {
182 if (o->name == OPT_HELP_STR || o->name == OPT_MORE_STR)
187 /* Make sure options are legit. */
188 assert(o->name[0] != '-');
189 assert(o->retval > 0);
191 case 0: case '-': case '/': case '<': case '>': case 'F': case 'M':
192 case 'L': case 'U': case 'f': case 'n': case 'p': case 's': case 'u':
198 /* Make sure there are no duplicates. */
199 for (next = o + 1; next->name; ++next) {
201 * Some compilers inline strcmp and the assert string is too long.
203 duplicated = strcmp(o->name, next->name) == 0;
207 if (o->name[0] == '\0') {
208 assert(unknown == NULL);
210 assert(unknown->valtype == 0 || unknown->valtype == '-');
216 static OPT_PAIR formats[] = {
217 {"PEM/DER", OPT_FMT_PEMDER},
218 {"pkcs12", OPT_FMT_PKCS12},
219 {"smime", OPT_FMT_SMIME},
220 {"engine", OPT_FMT_ENGINE},
221 {"msblob", OPT_FMT_MSBLOB},
222 {"netscape", OPT_FMT_NETSCAPE},
223 {"nss", OPT_FMT_NSS},
224 {"text", OPT_FMT_TEXT},
225 {"http", OPT_FMT_HTTP},
226 {"pvk", OPT_FMT_PVK},
230 /* Print an error message about a failed format parse. */
231 int opt_format_error(const char *s, unsigned long flags)
235 if (flags == OPT_FMT_PEMDER)
236 BIO_printf(bio_err, "%s: Bad format \"%s\"; must be pem or der\n",
239 BIO_printf(bio_err, "%s: Bad format \"%s\"; must be one of:\n",
241 for (ap = formats; ap->name; ap++)
242 if (flags & ap->retval)
243 BIO_printf(bio_err, " %s\n", ap->name);
248 /* Parse a format string, put it into *result; return 0 on failure, else 1. */
249 int opt_format(const char *s, unsigned long flags, int *result)
256 if ((flags & OPT_FMT_PEMDER) == 0)
257 return opt_format_error(s, flags);
258 *result = FORMAT_ASN1;
262 if ((flags & OPT_FMT_TEXT) == 0)
263 return opt_format_error(s, flags);
264 *result = FORMAT_TEXT;
268 if ((flags & OPT_FMT_NSS) == 0)
269 return opt_format_error(s, flags);
270 if (strcmp(s, "NSS") != 0 && strcmp(s, "nss") != 0)
271 return opt_format_error(s, flags);
272 *result = FORMAT_NSS;
276 if ((flags & OPT_FMT_SMIME) == 0)
277 return opt_format_error(s, flags);
278 *result = FORMAT_SMIME;
282 if ((flags & OPT_FMT_MSBLOB) == 0)
283 return opt_format_error(s, flags);
284 *result = FORMAT_MSBLOB;
288 if ((flags & OPT_FMT_ENGINE) == 0)
289 return opt_format_error(s, flags);
290 *result = FORMAT_ENGINE;
294 if ((flags & OPT_FMT_HTTP) == 0)
295 return opt_format_error(s, flags);
296 *result = FORMAT_HTTP;
299 if ((flags & OPT_FMT_PKCS12) == 0)
300 return opt_format_error(s, flags);
301 *result = FORMAT_PKCS12;
305 if (s[1] == '\0' || strcmp(s, "PEM") == 0 || strcmp(s, "pem") == 0) {
306 if ((flags & OPT_FMT_PEMDER) == 0)
307 return opt_format_error(s, flags);
308 *result = FORMAT_PEM;
309 } else if (strcmp(s, "PVK") == 0 || strcmp(s, "pvk") == 0) {
310 if ((flags & OPT_FMT_PVK) == 0)
311 return opt_format_error(s, flags);
312 *result = FORMAT_PVK;
313 } else if (strcmp(s, "P12") == 0 || strcmp(s, "p12") == 0
314 || strcmp(s, "PKCS12") == 0 || strcmp(s, "pkcs12") == 0) {
315 if ((flags & OPT_FMT_PKCS12) == 0)
316 return opt_format_error(s, flags);
317 *result = FORMAT_PKCS12;
325 /* Parse a cipher name, put it in *EVP_CIPHER; return 0 on failure, else 1. */
326 int opt_cipher(const char *name, const EVP_CIPHER **cipherp)
328 *cipherp = EVP_get_cipherbyname(name);
331 BIO_printf(bio_err, "%s: Unknown cipher %s\n", prog, name);
336 * Parse message digest name, put it in *EVP_MD; return 0 on failure, else 1.
338 int opt_md(const char *name, const EVP_MD **mdp)
340 *mdp = EVP_get_digestbyname(name);
343 BIO_printf(bio_err, "%s: Unknown digest %s\n", prog, name);
347 /* Look through a list of name/value pairs. */
348 int opt_pair(const char *name, const OPT_PAIR* pairs, int *result)
352 for (pp = pairs; pp->name; pp++)
353 if (strcmp(pp->name, name) == 0) {
354 *result = pp->retval;
357 BIO_printf(bio_err, "%s: Value must be one of:\n", prog);
358 for (pp = pairs; pp->name; pp++)
359 BIO_printf(bio_err, "\t%s\n", pp->name);
363 /* Parse an int, put it into *result; return 0 on failure, else 1. */
364 int opt_int(const char *value, int *result)
368 if (!opt_long(value, &l))
372 BIO_printf(bio_err, "%s: Value \"%s\" outside integer range\n",
379 /* Parse a long, put it into *result; return 0 on failure, else 1. */
380 int opt_long(const char *value, long *result)
386 l = strtol(value, &endp, 0);
389 || ((l == LONG_MAX || l == LONG_MIN) && errno == ERANGE)
390 || (l == 0 && errno != 0)) {
391 BIO_printf(bio_err, "%s: Can't parse \"%s\" as a number\n",
401 #if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L && \
402 defined(INTMAX_MAX) && defined(UINTMAX_MAX)
404 /* Parse an intmax_t, put it into *result; return 0 on failure, else 1. */
405 int opt_imax(const char *value, intmax_t *result)
411 m = strtoimax(value, &endp, 0);
414 || ((m == INTMAX_MAX || m == INTMAX_MIN) && errno == ERANGE)
415 || (m == 0 && errno != 0)) {
416 BIO_printf(bio_err, "%s: Can't parse \"%s\" as a number\n",
426 /* Parse a uintmax_t, put it into *result; return 0 on failure, else 1. */
427 int opt_umax(const char *value, uintmax_t *result)
433 m = strtoumax(value, &endp, 0);
436 || (m == UINTMAX_MAX && errno == ERANGE)
437 || (m == 0 && errno != 0)) {
438 BIO_printf(bio_err, "%s: Can't parse \"%s\" as a number\n",
450 * Parse an unsigned long, put it into *result; return 0 on failure, else 1.
452 int opt_ulong(const char *value, unsigned long *result)
458 l = strtoul(value, &endptr, 0);
461 || ((l == ULONG_MAX) && errno == ERANGE)
462 || (l == 0 && errno != 0)) {
463 BIO_printf(bio_err, "%s: Can't parse \"%s\" as an unsigned number\n",
474 * We pass opt as an int but cast it to "enum range" so that all the
475 * items in the OPT_V_ENUM enumeration are caught; this makes -Wswitch
476 * in gcc do the right thing.
478 enum range { OPT_V_ENUM };
480 int opt_verify(int opt, X509_VERIFY_PARAM *vpm)
486 const X509_VERIFY_PARAM *vtmp;
489 assert(opt > OPT_V__FIRST);
490 assert(opt < OPT_V__LAST);
492 switch ((enum range)opt) {
497 otmp = OBJ_txt2obj(opt_arg(), 0);
499 BIO_printf(bio_err, "%s: Invalid Policy %s\n", prog, opt_arg());
502 X509_VERIFY_PARAM_add0_policy(vpm, otmp);
505 i = X509_PURPOSE_get_by_sname(opt_arg());
507 BIO_printf(bio_err, "%s: Invalid purpose %s\n", prog, opt_arg());
510 xptmp = X509_PURPOSE_get0(i);
511 i = X509_PURPOSE_get_id(xptmp);
512 X509_VERIFY_PARAM_set_purpose(vpm, i);
514 case OPT_V_VERIFY_NAME:
515 vtmp = X509_VERIFY_PARAM_lookup(opt_arg());
517 BIO_printf(bio_err, "%s: Invalid verify name %s\n",
521 X509_VERIFY_PARAM_set1(vpm, vtmp);
523 case OPT_V_VERIFY_DEPTH:
526 X509_VERIFY_PARAM_set_depth(vpm, i);
529 if (!opt_imax(opt_arg(), &t))
531 if (t != (time_t)t) {
532 BIO_printf(bio_err, "%s: epoch time out of range %s\n",
536 X509_VERIFY_PARAM_set_time(vpm, (time_t)t);
538 case OPT_V_VERIFY_HOSTNAME:
539 if (!X509_VERIFY_PARAM_set1_host(vpm, opt_arg(), 0))
542 case OPT_V_VERIFY_EMAIL:
543 if (!X509_VERIFY_PARAM_set1_email(vpm, opt_arg(), 0))
546 case OPT_V_VERIFY_IP:
547 if (!X509_VERIFY_PARAM_set1_ip_asc(vpm, opt_arg()))
550 case OPT_V_IGNORE_CRITICAL:
551 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_IGNORE_CRITICAL);
553 case OPT_V_ISSUER_CHECKS:
554 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_CB_ISSUER_CHECK);
556 case OPT_V_CRL_CHECK:
557 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_CRL_CHECK);
559 case OPT_V_CRL_CHECK_ALL:
560 X509_VERIFY_PARAM_set_flags(vpm,
561 X509_V_FLAG_CRL_CHECK |
562 X509_V_FLAG_CRL_CHECK_ALL);
564 case OPT_V_POLICY_CHECK:
565 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_POLICY_CHECK);
567 case OPT_V_EXPLICIT_POLICY:
568 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_EXPLICIT_POLICY);
570 case OPT_V_INHIBIT_ANY:
571 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_INHIBIT_ANY);
573 case OPT_V_INHIBIT_MAP:
574 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_INHIBIT_MAP);
576 case OPT_V_X509_STRICT:
577 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_X509_STRICT);
579 case OPT_V_EXTENDED_CRL:
580 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_EXTENDED_CRL_SUPPORT);
582 case OPT_V_USE_DELTAS:
583 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_USE_DELTAS);
585 case OPT_V_POLICY_PRINT:
586 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_NOTIFY_POLICY);
588 case OPT_V_CHECK_SS_SIG:
589 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_CHECK_SS_SIGNATURE);
591 case OPT_V_TRUSTED_FIRST:
592 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_TRUSTED_FIRST);
594 case OPT_V_SUITEB_128_ONLY:
595 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_SUITEB_128_LOS_ONLY);
597 case OPT_V_SUITEB_128:
598 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_SUITEB_128_LOS);
600 case OPT_V_SUITEB_192:
601 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_SUITEB_192_LOS);
603 case OPT_V_PARTIAL_CHAIN:
604 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_PARTIAL_CHAIN);
606 case OPT_V_NO_ALT_CHAINS:
607 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_NO_ALT_CHAINS);
609 case OPT_V_NO_CHECK_TIME:
610 X509_VERIFY_PARAM_set_flags(vpm, X509_V_FLAG_NO_CHECK_TIME);
618 * Parse the next flag (and value if specified), return 0 if done, -1 on
619 * error, otherwise the flag's retval.
629 ossl_uintmax_t umval;
631 /* Look at current arg; at end of the list? */
637 /* If word doesn't start with a -, we're done. */
641 /* Hit "--" ? We're done. */
643 if (strcmp(p, "--") == 0)
646 /* Allow -nnn and --nnn */
651 /* If we have --flag=foo, snip it off */
652 if ((arg = strchr(p, '=')) != NULL)
654 for (o = opts; o->name; ++o) {
655 /* If not this option, move on to the next one. */
656 if (strcmp(p, o->name) != 0)
659 /* If it doesn't take a value, make sure none was given. */
660 if (o->valtype == 0 || o->valtype == '-') {
663 "%s: Option -%s does not take a value\n", prog, p);
669 /* Want a value; get the next param if =foo not used. */
671 if (argv[opt_index] == NULL) {
673 "%s: Option -%s needs a value\n", prog, o->name);
676 arg = argv[opt_index++];
679 /* Syntax-check value. */
680 switch (o->valtype) {
686 if (app_isdir(arg) >= 0)
688 BIO_printf(bio_err, "%s: Not a directory: %s\n", prog, arg);
692 if (strcmp(arg, "-") == 0 || app_access(arg, R_OK) >= 0)
695 "%s: Cannot open input file %s, %s\n",
696 prog, arg, strerror(errno));
700 if (strcmp(arg, "-") == 0 || app_access(arg, W_OK) >= 0 || errno == ENOENT)
703 "%s: Cannot open output file %s, %s\n",
704 prog, arg, strerror(errno));
708 if (!opt_int(arg, &ival)
709 || (o->valtype == 'p' && ival <= 0)) {
711 "%s: Non-positive number \"%s\" for -%s\n",
717 if (!opt_imax(arg, &imval)) {
719 "%s: Invalid number \"%s\" for -%s\n",
725 if (!opt_umax(arg, &umval)) {
727 "%s: Invalid number \"%s\" for -%s\n",
733 if (!opt_long(arg, &lval)) {
735 "%s: Invalid number \"%s\" for -%s\n",
741 if (!opt_ulong(arg, &ulval)) {
743 "%s: Invalid number \"%s\" for -%s\n",
751 o->valtype == 'F' ? OPT_FMT_PEMDER
752 : OPT_FMT_ANY, &ival))
755 "%s: Invalid format \"%s\" for -%s\n",
760 /* Return the flag value. */
763 if (unknown != NULL) {
765 return unknown->retval;
767 BIO_printf(bio_err, "%s: Option unknown option -%s\n", prog, p);
771 /* Return the most recent flag parameter. */
777 /* Return the most recent flag. */
783 /* Return the unknown option. */
784 char *opt_unknown(void)
789 /* Return the rest of the arguments after parsing flags. */
790 char **opt_rest(void)
792 return &argv[opt_index];
795 /* How many items in remaining args? */
796 int opt_num_rest(void)
801 for (pp = opt_rest(); *pp; pp++, i++)
806 /* Return a string describing the parameter type. */
807 static const char *valtype2param(const OPTIONS *o)
809 switch (o->valtype) {
834 void opt_help(const OPTIONS *list)
844 /* Starts with its own help message? */
845 standard_prolog = list[0].name != OPT_HELP_STR;
847 /* Find the widest help. */
848 for (o = list; o->name; o++) {
849 if (o->name == OPT_MORE_STR)
851 i = 2 + (int)strlen(o->name);
852 if (o->valtype != '-')
853 i += 1 + strlen(valtype2param(o));
854 if (i < MAX_OPT_HELP_WIDTH && i > width)
856 assert(i < (int)sizeof start);
860 BIO_printf(bio_err, "Usage: %s [options]\nValid options are:\n",
863 /* Now let's print. */
864 for (o = list; o->name; o++) {
865 help = o->helpstr ? o->helpstr : "(No additional info)";
866 if (o->name == OPT_HELP_STR) {
867 BIO_printf(bio_err, help, prog);
872 memset(start, ' ', sizeof(start) - 1);
873 start[sizeof start - 1] = '\0';
875 if (o->name == OPT_MORE_STR) {
876 /* Continuation of previous line; padd and print. */
878 BIO_printf(bio_err, "%s %s\n", start, help);
882 /* Build up the "-flag [param]" part. */
887 p += strlen(strcpy(p, o->name));
890 if (o->valtype != '-') {
892 p += strlen(strcpy(p, valtype2param(o)));
895 if ((int)(p - start) >= MAX_OPT_HELP_WIDTH) {
897 BIO_printf(bio_err, "%s\n", start);
898 memset(start, ' ', sizeof(start));
901 BIO_printf(bio_err, "%s %s\n", start, help);
905 #ifdef COMPILE_STANDALONE_TEST_DRIVER
906 # include <sys/stat.h>
908 typedef enum OPTION_choice {
909 OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
910 OPT_IN, OPT_INFORM, OPT_OUT, OPT_COUNT, OPT_U, OPT_FLAG,
914 static OPTIONS options[] = {
915 {OPT_HELP_STR, 1, '-', "Usage: %s flags\n"},
916 {OPT_HELP_STR, 1, '-', "Valid options are:\n"},
917 {"help", OPT_HELP, '-', "Display this summary"},
918 {"in", OPT_IN, '<', "input file"},
919 {OPT_MORE_STR, 1, '-', "more detail about input"},
920 {"inform", OPT_INFORM, 'f', "input file format; defaults to pem"},
921 {"out", OPT_OUT, '>', "output file"},
922 {"count", OPT_COUNT, 'p', "a counter greater than zero"},
923 {"u", OPT_U, 'u', "an unsigned number"},
924 {"flag", OPT_FLAG, 0, "just some flag"},
925 {"str", OPT_STR, 's', "the magic word"},
926 {"areallyverylongoption", OPT_HELP, '-', "long way for help"},
932 int app_isdir(const char *name)
936 return name != NULL && stat(name, &sb) >= 0 && S_ISDIR(sb.st_mode);
939 int main(int ac, char **av)
945 bio_err = BIO_new_fp(stderr, BIO_NOCLOSE | BIO_FP_TEXT);
947 prog = opt_init(ac, av, options);
948 while ((o = opt_next()) != OPT_EOF) {
953 printf("%s: Usage error; try -help.\n", prog);
959 printf("in %s\n", opt_arg());
962 printf("inform %s\n", opt_arg());
965 printf("out %s\n", opt_arg());
968 printf("count %s\n", opt_arg());
971 printf("u %s\n", opt_arg());
977 printf("str %s\n", opt_arg());
981 argc = opt_num_rest();
984 printf("args = %d\n", argc);
987 printf(" %s\n", *argv++);