2 * Copyright 2016-2021 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (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,
22 const char *prog, OSSL_LIB_CTX *libctx);
24 typedef enum OPTION_choice {
26 OPT_ENGINE, OPT_OUT, OPT_PASSIN,
27 OPT_NOOUT, OPT_TEXT, OPT_RECURSIVE,
28 OPT_SEARCHFOR_CERTS, OPT_SEARCHFOR_KEYS, OPT_SEARCHFOR_CRLS,
29 OPT_CRITERION_SUBJECT, OPT_CRITERION_ISSUER, OPT_CRITERION_SERIAL,
30 OPT_CRITERION_FINGERPRINT, OPT_CRITERION_ALIAS,
34 const OPTIONS storeutl_options[] = {
35 {OPT_HELP_STR, 1, '-', "Usage: %s [options] uri\n"},
37 OPT_SECTION("General"),
38 {"help", OPT_HELP, '-', "Display this summary"},
39 {"", OPT_MD, '-', "Any supported digest"},
40 #ifndef OPENSSL_NO_ENGINE
41 {"engine", OPT_ENGINE, 's', "Use engine, possibly a hardware device"},
44 OPT_SECTION("Search"),
45 {"certs", OPT_SEARCHFOR_CERTS, '-', "Search for certificates only"},
46 {"keys", OPT_SEARCHFOR_KEYS, '-', "Search for keys only"},
47 {"crls", OPT_SEARCHFOR_CRLS, '-', "Search for CRLs only"},
48 {"subject", OPT_CRITERION_SUBJECT, 's', "Search by subject"},
49 {"issuer", OPT_CRITERION_ISSUER, 's', "Search by issuer and serial, issuer name"},
50 {"serial", OPT_CRITERION_SERIAL, 's', "Search by issuer and serial, serial number"},
51 {"fingerprint", OPT_CRITERION_FINGERPRINT, 's', "Search by public key fingerprint, given in hex"},
52 {"alias", OPT_CRITERION_ALIAS, 's', "Search by alias"},
53 {"r", OPT_RECURSIVE, '-', "Recurse through names"},
56 {"passin", OPT_PASSIN, 's', "Input file pass phrase source"},
58 OPT_SECTION("Output"),
59 {"out", OPT_OUT, '>', "Output file - default stdout"},
60 {"text", OPT_TEXT, '-', "Print a text form of the objects"},
61 {"noout", OPT_NOOUT, '-', "No PEM output, just status"},
66 {"uri", 0, 0, "URI of the store object"},
70 int storeutl_main(int argc, char *argv[])
72 int ret = 1, noout = 0, text = 0, recursive = 0;
73 char *outfile = NULL, *passin = NULL, *passinarg = NULL;
77 char *prog = opt_init(argc, argv, storeutl_options);
78 PW_CB_DATA pw_cb_data;
81 X509_NAME *subject = NULL, *issuer = NULL;
82 ASN1_INTEGER *serial = NULL;
83 unsigned char *fingerprint = NULL;
84 size_t fingerprintlen = 0;
85 char *alias = NULL, *digestname = NULL;
86 OSSL_STORE_SEARCH *search = NULL;
87 EVP_MD *digest = NULL;
88 OSSL_LIB_CTX *libctx = app_get0_libctx();
90 while ((o = opt_next()) != OPT_EOF) {
95 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
98 opt_help(storeutl_options);
105 passinarg = opt_arg();
116 case OPT_SEARCHFOR_CERTS:
117 case OPT_SEARCHFOR_KEYS:
118 case OPT_SEARCHFOR_CRLS:
120 BIO_printf(bio_err, "%s: only one search type can be given.\n",
125 static const struct {
126 enum OPTION_choice choice;
129 {OPT_SEARCHFOR_CERTS, OSSL_STORE_INFO_CERT},
130 {OPT_SEARCHFOR_KEYS, OSSL_STORE_INFO_PKEY},
131 {OPT_SEARCHFOR_CRLS, OSSL_STORE_INFO_CRL},
135 for (i = 0; i < OSSL_NELEM(map); i++) {
136 if (o == map[i].choice) {
137 expected = map[i].type;
142 * If expected wasn't set at this point, it means the map
143 * isn't synchronised with the possible options leading here.
145 OPENSSL_assert(expected != 0);
148 case OPT_CRITERION_SUBJECT:
149 if (criterion != 0) {
150 BIO_printf(bio_err, "%s: criterion already given.\n",
154 criterion = OSSL_STORE_SEARCH_BY_NAME;
155 if (subject != NULL) {
156 BIO_printf(bio_err, "%s: subject already given.\n",
160 subject = parse_name(opt_arg(), MBSTRING_UTF8, 1, "subject");
164 case OPT_CRITERION_ISSUER:
166 || (criterion == OSSL_STORE_SEARCH_BY_ISSUER_SERIAL
167 && issuer != NULL)) {
168 BIO_printf(bio_err, "%s: criterion already given.\n",
172 criterion = OSSL_STORE_SEARCH_BY_ISSUER_SERIAL;
173 if (issuer != NULL) {
174 BIO_printf(bio_err, "%s: issuer already given.\n",
178 issuer = parse_name(opt_arg(), MBSTRING_UTF8, 1, "issuer");
182 case OPT_CRITERION_SERIAL:
184 || (criterion == OSSL_STORE_SEARCH_BY_ISSUER_SERIAL
185 && serial != NULL)) {
186 BIO_printf(bio_err, "%s: criterion already given.\n",
190 criterion = OSSL_STORE_SEARCH_BY_ISSUER_SERIAL;
191 if (serial != NULL) {
192 BIO_printf(bio_err, "%s: serial number already given.\n",
196 if ((serial = s2i_ASN1_INTEGER(NULL, opt_arg())) == NULL) {
197 BIO_printf(bio_err, "%s: can't parse serial number argument.\n",
202 case OPT_CRITERION_FINGERPRINT:
204 || (criterion == OSSL_STORE_SEARCH_BY_KEY_FINGERPRINT
205 && fingerprint != NULL)) {
206 BIO_printf(bio_err, "%s: criterion already given.\n",
210 criterion = OSSL_STORE_SEARCH_BY_KEY_FINGERPRINT;
211 if (fingerprint != NULL) {
212 BIO_printf(bio_err, "%s: fingerprint already given.\n",
219 if ((fingerprint = OPENSSL_hexstr2buf(opt_arg(), &tmplen))
222 "%s: can't parse fingerprint argument.\n",
226 fingerprintlen = (size_t)tmplen;
229 case OPT_CRITERION_ALIAS:
230 if (criterion != 0) {
231 BIO_printf(bio_err, "%s: criterion already given.\n",
235 criterion = OSSL_STORE_SEARCH_BY_ALIAS;
237 BIO_printf(bio_err, "%s: alias already given.\n",
241 if ((alias = OPENSSL_strdup(opt_arg())) == NULL) {
242 BIO_printf(bio_err, "%s: can't parse alias argument.\n",
248 e = setup_engine(opt_arg(), 0);
251 digestname = opt_unknown();
254 if (!opt_provider(o))
260 /* One argument, the URI */
261 argc = opt_num_rest();
266 if (digestname != NULL) {
267 if (!opt_md(digestname, &digest))
271 if (criterion != 0) {
273 case OSSL_STORE_SEARCH_BY_NAME:
274 if ((search = OSSL_STORE_SEARCH_by_name(subject)) == NULL) {
275 ERR_print_errors(bio_err);
279 case OSSL_STORE_SEARCH_BY_ISSUER_SERIAL:
280 if (issuer == NULL || serial == NULL) {
282 "%s: both -issuer and -serial must be given.\n",
286 if ((search = OSSL_STORE_SEARCH_by_issuer_serial(issuer, serial))
288 ERR_print_errors(bio_err);
292 case OSSL_STORE_SEARCH_BY_KEY_FINGERPRINT:
293 if ((search = OSSL_STORE_SEARCH_by_key_fingerprint(digest,
297 ERR_print_errors(bio_err);
301 case OSSL_STORE_SEARCH_BY_ALIAS:
302 if ((search = OSSL_STORE_SEARCH_by_alias(alias)) == NULL) {
303 ERR_print_errors(bio_err);
310 if (!app_passwd(passinarg, NULL, &passin, NULL)) {
311 BIO_printf(bio_err, "Error getting passwords\n");
314 pw_cb_data.password = passin;
315 pw_cb_data.prompt_info = argv[0];
317 out = bio_open_default(outfile, 'w', FORMAT_TEXT);
321 ret = process(argv[0], get_ui_method(), &pw_cb_data,
322 expected, criterion, search,
323 text, noout, recursive, 0, out, prog, libctx);
327 OPENSSL_free(fingerprint);
329 ASN1_INTEGER_free(serial);
330 X509_NAME_free(subject);
331 X509_NAME_free(issuer);
332 OSSL_STORE_SEARCH_free(search);
334 OPENSSL_free(passin);
339 static int indent_printf(int indent, BIO *bio, const char *format, ...)
344 va_start(args, format);
346 ret = BIO_printf(bio, "%*s", indent, "") + BIO_vprintf(bio, format, args);
352 static int process(const char *uri, const UI_METHOD *uimeth, PW_CB_DATA *uidata,
353 int expected, int criterion, OSSL_STORE_SEARCH *search,
354 int text, int noout, int recursive, int indent, BIO *out,
355 const char *prog, OSSL_LIB_CTX *libctx)
357 OSSL_STORE_CTX *store_ctx = NULL;
358 int ret = 1, items = 0;
360 if ((store_ctx = OSSL_STORE_open_ex(uri, libctx, app_get0_propq(), uimeth, uidata,
363 BIO_printf(bio_err, "Couldn't open file or uri %s\n", uri);
364 ERR_print_errors(bio_err);
369 if (!OSSL_STORE_expect(store_ctx, expected)) {
370 ERR_print_errors(bio_err);
375 if (criterion != 0) {
376 if (!OSSL_STORE_supports_search(store_ctx, criterion)) {
378 "%s: the store scheme doesn't support the given search criteria.\n",
383 if (!OSSL_STORE_find(store_ctx, search)) {
384 ERR_print_errors(bio_err);
389 /* From here on, we count errors, and we'll return the count at the end */
393 OSSL_STORE_INFO *info = OSSL_STORE_load(store_ctx);
394 int type = info == NULL ? 0 : OSSL_STORE_INFO_get_type(info);
395 const char *infostr =
396 info == NULL ? NULL : OSSL_STORE_INFO_type_string(type);
399 if (OSSL_STORE_error(store_ctx)) {
403 ERR_print_errors(bio_err);
404 if (OSSL_STORE_eof(store_ctx))
410 if (OSSL_STORE_eof(store_ctx))
414 "ERROR: OSSL_STORE_load() returned NULL without "
415 "eof or error indications\n");
416 BIO_printf(bio_err, " This is an error in the loader\n");
417 ERR_print_errors(bio_err);
422 if (type == OSSL_STORE_INFO_NAME) {
423 const char *name = OSSL_STORE_INFO_get0_NAME(info);
424 const char *desc = OSSL_STORE_INFO_get0_NAME_description(info);
425 indent_printf(indent, bio_out, "%d: %s: %s\n", items, infostr,
428 indent_printf(indent, bio_out, "%s\n", desc);
430 indent_printf(indent, bio_out, "%d: %s\n", items, infostr);
434 * Unfortunately, PEM_X509_INFO_write_bio() is sorely lacking in
435 * functionality, so we must figure out how exactly to write things
439 case OSSL_STORE_INFO_NAME:
441 const char *suburi = OSSL_STORE_INFO_get0_NAME(info);
442 ret += process(suburi, uimeth, uidata,
443 expected, criterion, search,
444 text, noout, recursive, indent + 2, out, prog,
448 case OSSL_STORE_INFO_PARAMS:
450 EVP_PKEY_print_params(out, OSSL_STORE_INFO_get0_PARAMS(info),
453 PEM_write_bio_Parameters(out,
454 OSSL_STORE_INFO_get0_PARAMS(info));
456 case OSSL_STORE_INFO_PUBKEY:
458 EVP_PKEY_print_public(out, OSSL_STORE_INFO_get0_PUBKEY(info),
461 PEM_write_bio_PUBKEY(out, OSSL_STORE_INFO_get0_PUBKEY(info));
463 case OSSL_STORE_INFO_PKEY:
465 EVP_PKEY_print_private(out, OSSL_STORE_INFO_get0_PKEY(info),
468 PEM_write_bio_PrivateKey(out, OSSL_STORE_INFO_get0_PKEY(info),
469 NULL, NULL, 0, NULL, NULL);
471 case OSSL_STORE_INFO_CERT:
473 X509_print(out, OSSL_STORE_INFO_get0_CERT(info));
475 PEM_write_bio_X509(out, OSSL_STORE_INFO_get0_CERT(info));
477 case OSSL_STORE_INFO_CRL:
479 X509_CRL_print(out, OSSL_STORE_INFO_get0_CRL(info));
481 PEM_write_bio_X509_CRL(out, OSSL_STORE_INFO_get0_CRL(info));
484 BIO_printf(bio_err, "!!! Unknown code\n");
489 OSSL_STORE_INFO_free(info);
491 indent_printf(indent, out, "Total found: %d\n", items);
494 if (!OSSL_STORE_close(store_ctx)) {
495 ERR_print_errors(bio_err);