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
;
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
)
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 /* Parse an int, put it into *result; return 0 on failure, else 1. */
355 int opt_int(const char *value
, int *result
)
359 if (!opt_long(value
, &l
))
363 BIO_printf(bio_err
, "%s: Value \"%s\" outside integer range\n",
370 /* Parse a long, put it into *result; return 0 on failure, else 1. */
371 int opt_long(const char *value
, long *result
)
377 l
= strtol(value
, &endp
, 0);
380 || ((l
== LONG_MAX
|| l
== LONG_MIN
) && errno
== ERANGE
)
381 || (l
== 0 && errno
!= 0)) {
382 BIO_printf(bio_err
, "%s: Can't parse \"%s\" as a number\n",
393 * Parse an unsigned long, put it into *result; return 0 on failure, else 1.
395 int opt_ulong(const char *value
, unsigned long *result
)
401 l
= strtoul(value
, &endptr
, 0);
404 || ((l
== ULONG_MAX
) && errno
== ERANGE
)
405 || (l
== 0 && errno
!= 0)) {
406 BIO_printf(bio_err
, "%s: Can't parse \"%s\" as an unsigned number\n",
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 /* If we have C99 we could use intmax_t for all time_t values */
473 opt_long(opt_arg(), &l
);
475 X509_VERIFY_PARAM_set_time(vpm
, (time_t)l
);
477 case OPT_V_VERIFY_HOSTNAME
:
478 if (!X509_VERIFY_PARAM_set1_host(vpm
, opt_arg(), 0))
481 case OPT_V_VERIFY_EMAIL
:
482 if (!X509_VERIFY_PARAM_set1_email(vpm
, opt_arg(), 0))
485 case OPT_V_VERIFY_IP
:
486 if (!X509_VERIFY_PARAM_set1_ip_asc(vpm
, opt_arg()))
489 case OPT_V_IGNORE_CRITICAL
:
490 X509_VERIFY_PARAM_set_flags(vpm
, X509_V_FLAG_IGNORE_CRITICAL
);
492 case OPT_V_ISSUER_CHECKS
:
493 X509_VERIFY_PARAM_set_flags(vpm
, X509_V_FLAG_CB_ISSUER_CHECK
);
495 case OPT_V_CRL_CHECK
:
496 X509_VERIFY_PARAM_set_flags(vpm
, X509_V_FLAG_CRL_CHECK
);
498 case OPT_V_CRL_CHECK_ALL
:
499 X509_VERIFY_PARAM_set_flags(vpm
,
500 X509_V_FLAG_CRL_CHECK
|
501 X509_V_FLAG_CRL_CHECK_ALL
);
503 case OPT_V_POLICY_CHECK
:
504 X509_VERIFY_PARAM_set_flags(vpm
, X509_V_FLAG_POLICY_CHECK
);
506 case OPT_V_EXPLICIT_POLICY
:
507 X509_VERIFY_PARAM_set_flags(vpm
, X509_V_FLAG_EXPLICIT_POLICY
);
509 case OPT_V_INHIBIT_ANY
:
510 X509_VERIFY_PARAM_set_flags(vpm
, X509_V_FLAG_INHIBIT_ANY
);
512 case OPT_V_INHIBIT_MAP
:
513 X509_VERIFY_PARAM_set_flags(vpm
, X509_V_FLAG_INHIBIT_MAP
);
515 case OPT_V_X509_STRICT
:
516 X509_VERIFY_PARAM_set_flags(vpm
, X509_V_FLAG_X509_STRICT
);
518 case OPT_V_EXTENDED_CRL
:
519 X509_VERIFY_PARAM_set_flags(vpm
, X509_V_FLAG_EXTENDED_CRL_SUPPORT
);
521 case OPT_V_USE_DELTAS
:
522 X509_VERIFY_PARAM_set_flags(vpm
, X509_V_FLAG_USE_DELTAS
);
524 case OPT_V_POLICY_PRINT
:
525 X509_VERIFY_PARAM_set_flags(vpm
, X509_V_FLAG_NOTIFY_POLICY
);
527 case OPT_V_CHECK_SS_SIG
:
528 X509_VERIFY_PARAM_set_flags(vpm
, X509_V_FLAG_CHECK_SS_SIGNATURE
);
530 case OPT_V_TRUSTED_FIRST
:
531 X509_VERIFY_PARAM_set_flags(vpm
, X509_V_FLAG_TRUSTED_FIRST
);
533 case OPT_V_SUITEB_128_ONLY
:
534 X509_VERIFY_PARAM_set_flags(vpm
, X509_V_FLAG_SUITEB_128_LOS_ONLY
);
536 case OPT_V_SUITEB_128
:
537 X509_VERIFY_PARAM_set_flags(vpm
, X509_V_FLAG_SUITEB_128_LOS
);
539 case OPT_V_SUITEB_192
:
540 X509_VERIFY_PARAM_set_flags(vpm
, X509_V_FLAG_SUITEB_192_LOS
);
542 case OPT_V_PARTIAL_CHAIN
:
543 X509_VERIFY_PARAM_set_flags(vpm
, X509_V_FLAG_PARTIAL_CHAIN
);
545 case OPT_V_NO_ALT_CHAINS
:
546 X509_VERIFY_PARAM_set_flags(vpm
, X509_V_FLAG_NO_ALT_CHAINS
);
548 case OPT_V_NO_CHECK_TIME
:
549 X509_VERIFY_PARAM_set_flags(vpm
, X509_V_FLAG_NO_CHECK_TIME
);
557 * Parse the next flag (and value if specified), return 0 if done, -1 on
558 * 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. */
616 switch (o
->valtype
) {
622 if (app_isdir(arg
) >= 0)
624 BIO_printf(bio_err
, "%s: Not a directory: %s\n", prog
, arg
);
628 if (strcmp(arg
, "-") == 0 || app_access(arg
, R_OK
) >= 0)
631 "%s: Cannot open input file %s, %s\n",
632 prog
, arg
, strerror(errno
));
636 if (strcmp(arg
, "-") == 0 || app_access(arg
, W_OK
) >= 0 || errno
== ENOENT
)
639 "%s: Cannot open output file %s, %s\n",
640 prog
, arg
, strerror(errno
));
644 if (!opt_int(arg
, &ival
)
645 || (o
->valtype
== 'p' && ival
<= 0)) {
647 "%s: Non-positive number \"%s\" for -%s\n",
653 if (!opt_ulong(arg
, &uval
)) {
655 "%s: Invalid number \"%s\" for -%s\n",
663 o
->valtype
== 'F' ? OPT_FMT_PEMDER
664 : OPT_FMT_ANY
, &ival
))
667 "%s: Invalid format \"%s\" for -%s\n",
672 /* Return the flag value. */
675 if (unknown
!= NULL
) {
677 return unknown
->retval
;
679 BIO_printf(bio_err
, "%s: Option unknown option -%s\n", prog
, p
);
683 /* Return the most recent flag parameter. */
689 /* Return the most recent flag. */
695 /* Return the unknown option. */
696 char *opt_unknown(void)
701 /* Return the rest of the arguments after parsing flags. */
702 char **opt_rest(void)
704 return &argv
[opt_index
];
707 /* How many items in remaining args? */
708 int opt_num_rest(void)
713 for (pp
= opt_rest(); *pp
; pp
++, i
++)
718 /* Return a string describing the parameter type. */
719 static const char *valtype2param(const OPTIONS
*o
)
721 switch (o
->valtype
) {
746 void opt_help(const OPTIONS
*list
)
756 /* Starts with its own help message? */
757 standard_prolog
= list
[0].name
!= OPT_HELP_STR
;
759 /* Find the widest help. */
760 for (o
= list
; o
->name
; o
++) {
761 if (o
->name
== OPT_MORE_STR
)
763 i
= 2 + (int)strlen(o
->name
);
764 if (o
->valtype
!= '-')
765 i
+= 1 + strlen(valtype2param(o
));
766 if (i
< MAX_OPT_HELP_WIDTH
&& i
> width
)
768 assert(i
< (int)sizeof start
);
772 BIO_printf(bio_err
, "Usage: %s [options]\nValid options are:\n",
775 /* Now let's print. */
776 for (o
= list
; o
->name
; o
++) {
777 help
= o
->helpstr
? o
->helpstr
: "(No additional info)";
778 if (o
->name
== OPT_HELP_STR
) {
779 BIO_printf(bio_err
, help
, prog
);
784 memset(start
, ' ', sizeof(start
) - 1);
785 start
[sizeof start
- 1] = '\0';
787 if (o
->name
== OPT_MORE_STR
) {
788 /* Continuation of previous line; padd and print. */
790 BIO_printf(bio_err
, "%s %s\n", start
, help
);
794 /* Build up the "-flag [param]" part. */
799 p
+= strlen(strcpy(p
, o
->name
));
802 if (o
->valtype
!= '-') {
804 p
+= strlen(strcpy(p
, valtype2param(o
)));
807 if ((int)(p
- start
) >= MAX_OPT_HELP_WIDTH
) {
809 BIO_printf(bio_err
, "%s\n", start
);
810 memset(start
, ' ', sizeof(start
));
813 BIO_printf(bio_err
, "%s %s\n", start
, help
);
817 #ifdef COMPILE_STANDALONE_TEST_DRIVER
818 # include <sys/stat.h>
820 typedef enum OPTION_choice
{
821 OPT_ERR
= -1, OPT_EOF
= 0, OPT_HELP
,
822 OPT_IN
, OPT_INFORM
, OPT_OUT
, OPT_COUNT
, OPT_U
, OPT_FLAG
,
826 static OPTIONS options
[] = {
827 {OPT_HELP_STR
, 1, '-', "Usage: %s flags\n"},
828 {OPT_HELP_STR
, 1, '-', "Valid options are:\n"},
829 {"help", OPT_HELP
, '-', "Display this summary"},
830 {"in", OPT_IN
, '<', "input file"},
831 {OPT_MORE_STR
, 1, '-', "more detail about input"},
832 {"inform", OPT_INFORM
, 'f', "input file format; defaults to pem"},
833 {"out", OPT_OUT
, '>', "output file"},
834 {"count", OPT_COUNT
, 'p', "a counter greater than zero"},
835 {"u", OPT_U
, 'u', "an unsigned number"},
836 {"flag", OPT_FLAG
, 0, "just some flag"},
837 {"str", OPT_STR
, 's', "the magic word"},
838 {"areallyverylongoption", OPT_HELP
, '-', "long way for help"},
844 int app_isdir(const char *name
)
848 return name
!= NULL
&& stat(name
, &sb
) >= 0 && S_ISDIR(sb
.st_mode
);
851 int main(int ac
, char **av
)
857 bio_err
= BIO_new_fp(stderr
, BIO_NOCLOSE
| BIO_FP_TEXT
);
859 prog
= opt_init(ac
, av
, options
);
860 while ((o
= opt_next()) != OPT_EOF
) {
865 printf("%s: Usage error; try -help.\n", prog
);
871 printf("in %s\n", opt_arg());
874 printf("inform %s\n", opt_arg());
877 printf("out %s\n", opt_arg());
880 printf("count %s\n", opt_arg());
883 printf("u %s\n", opt_arg());
889 printf("str %s\n", opt_arg());
893 argc
= opt_num_rest();
896 printf("args = %d\n", argc
);
899 printf(" %s\n", *argv
++);