2 * Copyright 2016-2019 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
10 #include <openssl/opensslconf.h>
14 #include <openssl/err.h>
15 #include <openssl/pem.h>
16 #include <openssl/store.h>
17 #include <openssl/x509v3.h> /* s2i_ASN1_INTEGER */
19 static int process(const char *uri
, const UI_METHOD
*uimeth
, PW_CB_DATA
*uidata
,
20 int expected
, int criterion
, OSSL_STORE_SEARCH
*search
,
21 int text
, int noout
, int recursive
, int indent
, BIO
*out
,
24 typedef enum OPTION_choice
{
25 OPT_ERR
= -1, OPT_EOF
= 0, OPT_HELP
, OPT_ENGINE
, OPT_OUT
, OPT_PASSIN
,
26 OPT_NOOUT
, OPT_TEXT
, OPT_RECURSIVE
,
27 OPT_SEARCHFOR_CERTS
, OPT_SEARCHFOR_KEYS
, OPT_SEARCHFOR_CRLS
,
28 OPT_CRITERION_SUBJECT
, OPT_CRITERION_ISSUER
, OPT_CRITERION_SERIAL
,
29 OPT_CRITERION_FINGERPRINT
, OPT_CRITERION_ALIAS
,
33 const OPTIONS storeutl_options
[] = {
34 {OPT_HELP_STR
, 1, '-', "Usage: %s [options] uri\nValid options are:\n"},
35 {"help", OPT_HELP
, '-', "Display this summary"},
36 {"out", OPT_OUT
, '>', "Output file - default stdout"},
37 {"passin", OPT_PASSIN
, 's', "Input file pass phrase source"},
38 {"text", OPT_TEXT
, '-', "Print a text form of the objects"},
39 {"noout", OPT_NOOUT
, '-', "No PEM output, just status"},
40 {"certs", OPT_SEARCHFOR_CERTS
, '-', "Search for certificates only"},
41 {"keys", OPT_SEARCHFOR_KEYS
, '-', "Search for keys only"},
42 {"crls", OPT_SEARCHFOR_CRLS
, '-', "Search for CRLs only"},
43 {"subject", OPT_CRITERION_SUBJECT
, 's', "Search by subject"},
44 {"issuer", OPT_CRITERION_ISSUER
, 's', "Search by issuer and serial, issuer name"},
45 {"serial", OPT_CRITERION_SERIAL
, 's', "Search by issuer and serial, serial number"},
46 {"fingerprint", OPT_CRITERION_FINGERPRINT
, 's', "Search by public key fingerprint, given in hex"},
47 {"alias", OPT_CRITERION_ALIAS
, 's', "Search by alias"},
48 {"", OPT_MD
, '-', "Any supported digest"},
49 #ifndef OPENSSL_NO_ENGINE
50 {"engine", OPT_ENGINE
, 's', "Use engine, possibly a hardware device"},
52 {"r", OPT_RECURSIVE
, '-', "Recurse through names"},
56 int storeutl_main(int argc
, char *argv
[])
58 int ret
= 1, noout
= 0, text
= 0, recursive
= 0;
59 char *outfile
= NULL
, *passin
= NULL
, *passinarg
= NULL
;
63 char *prog
= opt_init(argc
, argv
, storeutl_options
);
64 PW_CB_DATA pw_cb_data
;
67 X509_NAME
*subject
= NULL
, *issuer
= NULL
;
68 ASN1_INTEGER
*serial
= NULL
;
69 unsigned char *fingerprint
= NULL
;
70 size_t fingerprintlen
= 0;
72 OSSL_STORE_SEARCH
*search
= NULL
;
73 const EVP_MD
*digest
= NULL
;
75 while ((o
= opt_next()) != OPT_EOF
) {
80 BIO_printf(bio_err
, "%s: Use -help for summary.\n", prog
);
83 opt_help(storeutl_options
);
90 passinarg
= opt_arg();
101 case OPT_SEARCHFOR_CERTS
:
102 case OPT_SEARCHFOR_KEYS
:
103 case OPT_SEARCHFOR_CRLS
:
105 BIO_printf(bio_err
, "%s: only one search type can be given.\n",
110 static const struct {
111 enum OPTION_choice choice
;
114 {OPT_SEARCHFOR_CERTS
, OSSL_STORE_INFO_CERT
},
115 {OPT_SEARCHFOR_KEYS
, OSSL_STORE_INFO_PKEY
},
116 {OPT_SEARCHFOR_CRLS
, OSSL_STORE_INFO_CRL
},
120 for (i
= 0; i
< OSSL_NELEM(map
); i
++) {
121 if (o
== map
[i
].choice
) {
122 expected
= map
[i
].type
;
127 * If expected wasn't set at this point, it means the map
128 * isn't synchronised with the possible options leading here.
130 OPENSSL_assert(expected
!= 0);
133 case OPT_CRITERION_SUBJECT
:
134 if (criterion
!= 0) {
135 BIO_printf(bio_err
, "%s: criterion already given.\n",
139 criterion
= OSSL_STORE_SEARCH_BY_NAME
;
140 if (subject
!= NULL
) {
141 BIO_printf(bio_err
, "%s: subject already given.\n",
145 if ((subject
= parse_name(opt_arg(), MBSTRING_UTF8
, 1)) == NULL
) {
146 BIO_printf(bio_err
, "%s: can't parse subject argument.\n",
151 case OPT_CRITERION_ISSUER
:
153 || (criterion
== OSSL_STORE_SEARCH_BY_ISSUER_SERIAL
154 && issuer
!= NULL
)) {
155 BIO_printf(bio_err
, "%s: criterion already given.\n",
159 criterion
= OSSL_STORE_SEARCH_BY_ISSUER_SERIAL
;
160 if (issuer
!= NULL
) {
161 BIO_printf(bio_err
, "%s: issuer already given.\n",
165 if ((issuer
= parse_name(opt_arg(), MBSTRING_UTF8
, 1)) == NULL
) {
166 BIO_printf(bio_err
, "%s: can't parse issuer argument.\n",
171 case OPT_CRITERION_SERIAL
:
173 || (criterion
== OSSL_STORE_SEARCH_BY_ISSUER_SERIAL
174 && serial
!= NULL
)) {
175 BIO_printf(bio_err
, "%s: criterion already given.\n",
179 criterion
= OSSL_STORE_SEARCH_BY_ISSUER_SERIAL
;
180 if (serial
!= NULL
) {
181 BIO_printf(bio_err
, "%s: serial number already given.\n",
185 if ((serial
= s2i_ASN1_INTEGER(NULL
, opt_arg())) == NULL
) {
186 BIO_printf(bio_err
, "%s: can't parse serial number argument.\n",
191 case OPT_CRITERION_FINGERPRINT
:
193 || (criterion
== OSSL_STORE_SEARCH_BY_KEY_FINGERPRINT
194 && fingerprint
!= NULL
)) {
195 BIO_printf(bio_err
, "%s: criterion already given.\n",
199 criterion
= OSSL_STORE_SEARCH_BY_KEY_FINGERPRINT
;
200 if (fingerprint
!= NULL
) {
201 BIO_printf(bio_err
, "%s: fingerprint already given.\n",
208 if ((fingerprint
= OPENSSL_hexstr2buf(opt_arg(), &tmplen
))
211 "%s: can't parse fingerprint argument.\n",
215 fingerprintlen
= (size_t)tmplen
;
218 case OPT_CRITERION_ALIAS
:
219 if (criterion
!= 0) {
220 BIO_printf(bio_err
, "%s: criterion already given.\n",
224 criterion
= OSSL_STORE_SEARCH_BY_ALIAS
;
226 BIO_printf(bio_err
, "%s: alias already given.\n",
230 if ((alias
= OPENSSL_strdup(opt_arg())) == NULL
) {
231 BIO_printf(bio_err
, "%s: can't parse alias argument.\n",
237 e
= setup_engine(opt_arg(), 0);
240 if (!opt_md(opt_unknown(), &digest
))
244 argc
= opt_num_rest();
248 BIO_printf(bio_err
, "%s: No URI given, nothing to do...\n", prog
);
252 BIO_printf(bio_err
, "%s: Unknown extra parameters after URI\n", prog
);
256 if (criterion
!= 0) {
258 case OSSL_STORE_SEARCH_BY_NAME
:
259 if ((search
= OSSL_STORE_SEARCH_by_name(subject
)) == NULL
) {
260 ERR_print_errors(bio_err
);
264 case OSSL_STORE_SEARCH_BY_ISSUER_SERIAL
:
265 if (issuer
== NULL
|| serial
== NULL
) {
267 "%s: both -issuer and -serial must be given.\n",
271 if ((search
= OSSL_STORE_SEARCH_by_issuer_serial(issuer
, serial
))
273 ERR_print_errors(bio_err
);
277 case OSSL_STORE_SEARCH_BY_KEY_FINGERPRINT
:
278 if ((search
= OSSL_STORE_SEARCH_by_key_fingerprint(digest
,
282 ERR_print_errors(bio_err
);
286 case OSSL_STORE_SEARCH_BY_ALIAS
:
287 if ((search
= OSSL_STORE_SEARCH_by_alias(alias
)) == NULL
) {
288 ERR_print_errors(bio_err
);
295 if (!app_passwd(passinarg
, NULL
, &passin
, NULL
)) {
296 BIO_printf(bio_err
, "Error getting passwords\n");
299 pw_cb_data
.password
= passin
;
300 pw_cb_data
.prompt_info
= argv
[0];
302 out
= bio_open_default(outfile
, 'w', FORMAT_TEXT
);
306 ret
= process(argv
[0], get_ui_method(), &pw_cb_data
,
307 expected
, criterion
, search
,
308 text
, noout
, recursive
, 0, out
, prog
);
311 OPENSSL_free(fingerprint
);
313 ASN1_INTEGER_free(serial
);
314 X509_NAME_free(subject
);
315 X509_NAME_free(issuer
);
316 OSSL_STORE_SEARCH_free(search
);
318 OPENSSL_free(passin
);
323 static int indent_printf(int indent
, BIO
*bio
, const char *format
, ...)
328 va_start(args
, format
);
330 ret
= BIO_printf(bio
, "%*s", indent
, "") + BIO_vprintf(bio
, format
, args
);
336 static int process(const char *uri
, const UI_METHOD
*uimeth
, PW_CB_DATA
*uidata
,
337 int expected
, int criterion
, OSSL_STORE_SEARCH
*search
,
338 int text
, int noout
, int recursive
, int indent
, BIO
*out
,
341 OSSL_STORE_CTX
*store_ctx
= NULL
;
342 int ret
= 1, items
= 0;
344 if ((store_ctx
= OSSL_STORE_open(uri
, uimeth
, uidata
, NULL
, NULL
))
346 BIO_printf(bio_err
, "Couldn't open file or uri %s\n", uri
);
347 ERR_print_errors(bio_err
);
352 if (!OSSL_STORE_expect(store_ctx
, expected
)) {
353 ERR_print_errors(bio_err
);
358 if (criterion
!= 0) {
359 if (!OSSL_STORE_supports_search(store_ctx
, criterion
)) {
361 "%s: the store scheme doesn't support the given search criteria.\n",
366 if (!OSSL_STORE_find(store_ctx
, search
)) {
367 ERR_print_errors(bio_err
);
372 /* From here on, we count errors, and we'll return the count at the end */
376 OSSL_STORE_INFO
*info
= OSSL_STORE_load(store_ctx
);
377 int type
= info
== NULL
? 0 : OSSL_STORE_INFO_get_type(info
);
378 const char *infostr
=
379 info
== NULL
? NULL
: OSSL_STORE_INFO_type_string(type
);
382 if (OSSL_STORE_eof(store_ctx
))
385 if (OSSL_STORE_error(store_ctx
)) {
389 ERR_print_errors(bio_err
);
395 "ERROR: OSSL_STORE_load() returned NULL without "
396 "eof or error indications\n");
397 BIO_printf(bio_err
, " This is an error in the loader\n");
398 ERR_print_errors(bio_err
);
403 if (type
== OSSL_STORE_INFO_NAME
) {
404 const char *name
= OSSL_STORE_INFO_get0_NAME(info
);
405 const char *desc
= OSSL_STORE_INFO_get0_NAME_description(info
);
406 indent_printf(indent
, bio_out
, "%d: %s: %s\n", items
, infostr
,
409 indent_printf(indent
, bio_out
, "%s\n", desc
);
411 indent_printf(indent
, bio_out
, "%d: %s\n", items
, infostr
);
415 * Unfortunately, PEM_X509_INFO_write_bio() is sorely lacking in
416 * functionality, so we must figure out how exactly to write things
420 case OSSL_STORE_INFO_NAME
:
422 const char *suburi
= OSSL_STORE_INFO_get0_NAME(info
);
423 ret
+= process(suburi
, uimeth
, uidata
,
424 expected
, criterion
, search
,
425 text
, noout
, recursive
, indent
+ 2, out
, prog
);
428 case OSSL_STORE_INFO_PARAMS
:
430 EVP_PKEY_print_params(out
, OSSL_STORE_INFO_get0_PARAMS(info
),
433 PEM_write_bio_Parameters(out
,
434 OSSL_STORE_INFO_get0_PARAMS(info
));
436 case OSSL_STORE_INFO_PKEY
:
438 EVP_PKEY_print_private(out
, OSSL_STORE_INFO_get0_PKEY(info
),
441 PEM_write_bio_PrivateKey(out
, OSSL_STORE_INFO_get0_PKEY(info
),
442 NULL
, NULL
, 0, NULL
, NULL
);
444 case OSSL_STORE_INFO_CERT
:
446 X509_print(out
, OSSL_STORE_INFO_get0_CERT(info
));
448 PEM_write_bio_X509(out
, OSSL_STORE_INFO_get0_CERT(info
));
450 case OSSL_STORE_INFO_CRL
:
452 X509_CRL_print(out
, OSSL_STORE_INFO_get0_CRL(info
));
454 PEM_write_bio_X509_CRL(out
, OSSL_STORE_INFO_get0_CRL(info
));
457 BIO_printf(bio_err
, "!!! Unknown code\n");
462 OSSL_STORE_INFO_free(info
);
464 indent_printf(indent
, out
, "Total found: %d\n", items
);
467 if (!OSSL_STORE_close(store_ctx
)) {
468 ERR_print_errors(bio_err
);