2 * Copyright 2016-2018 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,
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\n"},
36 OPT_SECTION("General"),
37 {"help", OPT_HELP, '-', "Display this summary"},
38 {"", OPT_MD, '-', "Any supported digest"},
39 #ifndef OPENSSL_NO_ENGINE
40 {"engine", OPT_ENGINE, 's', "Use engine, possibly a hardware device"},
43 OPT_SECTION("Search"),
44 {"certs", OPT_SEARCHFOR_CERTS, '-', "Search for certificates only"},
45 {"keys", OPT_SEARCHFOR_KEYS, '-', "Search for keys only"},
46 {"crls", OPT_SEARCHFOR_CRLS, '-', "Search for CRLs only"},
47 {"subject", OPT_CRITERION_SUBJECT, 's', "Search by subject"},
48 {"issuer", OPT_CRITERION_ISSUER, 's', "Search by issuer and serial, issuer name"},
49 {"serial", OPT_CRITERION_SERIAL, 's', "Search by issuer and serial, serial number"},
50 {"fingerprint", OPT_CRITERION_FINGERPRINT, 's', "Search by public key fingerprint, given in hex"},
51 {"alias", OPT_CRITERION_ALIAS, 's', "Search by alias"},
52 {"r", OPT_RECURSIVE, '-', "Recurse through names"},
55 {"passin", OPT_PASSIN, 's', "Input file pass phrase source"},
57 OPT_SECTION("Output"),
58 {"out", OPT_OUT, '>', "Output file - default stdout"},
59 {"text", OPT_TEXT, '-', "Print a text form of the objects"},
60 {"noout", OPT_NOOUT, '-', "No PEM output, just status"},
63 {"uri", 0, 0, "URI of the store object"},
67 int storeutl_main(int argc, char *argv[])
69 int ret = 1, noout = 0, text = 0, recursive = 0;
70 char *outfile = NULL, *passin = NULL, *passinarg = NULL;
74 char *prog = opt_init(argc, argv, storeutl_options);
75 PW_CB_DATA pw_cb_data;
78 X509_NAME *subject = NULL, *issuer = NULL;
79 ASN1_INTEGER *serial = NULL;
80 unsigned char *fingerprint = NULL;
81 size_t fingerprintlen = 0;
83 OSSL_STORE_SEARCH *search = NULL;
84 const EVP_MD *digest = NULL;
86 while ((o = opt_next()) != OPT_EOF) {
91 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
94 opt_help(storeutl_options);
101 passinarg = opt_arg();
112 case OPT_SEARCHFOR_CERTS:
113 case OPT_SEARCHFOR_KEYS:
114 case OPT_SEARCHFOR_CRLS:
116 BIO_printf(bio_err, "%s: only one search type can be given.\n",
121 static const struct {
122 enum OPTION_choice choice;
125 {OPT_SEARCHFOR_CERTS, OSSL_STORE_INFO_CERT},
126 {OPT_SEARCHFOR_KEYS, OSSL_STORE_INFO_PKEY},
127 {OPT_SEARCHFOR_CRLS, OSSL_STORE_INFO_CRL},
131 for (i = 0; i < OSSL_NELEM(map); i++) {
132 if (o == map[i].choice) {
133 expected = map[i].type;
138 * If expected wasn't set at this point, it means the map
139 * isn't synchronised with the possible options leading here.
141 OPENSSL_assert(expected != 0);
144 case OPT_CRITERION_SUBJECT:
145 if (criterion != 0) {
146 BIO_printf(bio_err, "%s: criterion already given.\n",
150 criterion = OSSL_STORE_SEARCH_BY_NAME;
151 if (subject != NULL) {
152 BIO_printf(bio_err, "%s: subject already given.\n",
156 if ((subject = parse_name(opt_arg(), MBSTRING_UTF8, 1)) == NULL) {
157 BIO_printf(bio_err, "%s: can't parse subject argument.\n",
162 case OPT_CRITERION_ISSUER:
164 || (criterion == OSSL_STORE_SEARCH_BY_ISSUER_SERIAL
165 && issuer != NULL)) {
166 BIO_printf(bio_err, "%s: criterion already given.\n",
170 criterion = OSSL_STORE_SEARCH_BY_ISSUER_SERIAL;
171 if (issuer != NULL) {
172 BIO_printf(bio_err, "%s: issuer already given.\n",
176 if ((issuer = parse_name(opt_arg(), MBSTRING_UTF8, 1)) == NULL) {
177 BIO_printf(bio_err, "%s: can't parse issuer argument.\n",
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 if (!opt_md(opt_unknown(), &digest))
255 argc = opt_num_rest();
259 BIO_printf(bio_err, "%s: No URI given, nothing to do...\n", prog);
263 BIO_printf(bio_err, "%s: Unknown extra parameters after URI\n", prog);
267 if (criterion != 0) {
269 case OSSL_STORE_SEARCH_BY_NAME:
270 if ((search = OSSL_STORE_SEARCH_by_name(subject)) == NULL) {
271 ERR_print_errors(bio_err);
275 case OSSL_STORE_SEARCH_BY_ISSUER_SERIAL:
276 if (issuer == NULL || serial == NULL) {
278 "%s: both -issuer and -serial must be given.\n",
282 if ((search = OSSL_STORE_SEARCH_by_issuer_serial(issuer, serial))
284 ERR_print_errors(bio_err);
288 case OSSL_STORE_SEARCH_BY_KEY_FINGERPRINT:
289 if ((search = OSSL_STORE_SEARCH_by_key_fingerprint(digest,
293 ERR_print_errors(bio_err);
297 case OSSL_STORE_SEARCH_BY_ALIAS:
298 if ((search = OSSL_STORE_SEARCH_by_alias(alias)) == NULL) {
299 ERR_print_errors(bio_err);
306 if (!app_passwd(passinarg, NULL, &passin, NULL)) {
307 BIO_printf(bio_err, "Error getting passwords\n");
310 pw_cb_data.password = passin;
311 pw_cb_data.prompt_info = argv[0];
313 out = bio_open_default(outfile, 'w', FORMAT_TEXT);
317 ret = process(argv[0], get_ui_method(), &pw_cb_data,
318 expected, criterion, search,
319 text, noout, recursive, 0, out, prog);
322 OPENSSL_free(fingerprint);
324 ASN1_INTEGER_free(serial);
325 X509_NAME_free(subject);
326 X509_NAME_free(issuer);
327 OSSL_STORE_SEARCH_free(search);
329 OPENSSL_free(passin);
334 static int indent_printf(int indent, BIO *bio, const char *format, ...)
339 va_start(args, format);
341 ret = BIO_printf(bio, "%*s", indent, "") + BIO_vprintf(bio, format, args);
347 static int process(const char *uri, const UI_METHOD *uimeth, PW_CB_DATA *uidata,
348 int expected, int criterion, OSSL_STORE_SEARCH *search,
349 int text, int noout, int recursive, int indent, BIO *out,
352 OSSL_STORE_CTX *store_ctx = NULL;
353 int ret = 1, items = 0;
355 if ((store_ctx = OSSL_STORE_open(uri, uimeth, uidata, NULL, NULL))
357 BIO_printf(bio_err, "Couldn't open file or uri %s\n", uri);
358 ERR_print_errors(bio_err);
363 if (!OSSL_STORE_expect(store_ctx, expected)) {
364 ERR_print_errors(bio_err);
369 if (criterion != 0) {
370 if (!OSSL_STORE_supports_search(store_ctx, criterion)) {
372 "%s: the store scheme doesn't support the given search criteria.\n",
377 if (!OSSL_STORE_find(store_ctx, search)) {
378 ERR_print_errors(bio_err);
383 /* From here on, we count errors, and we'll return the count at the end */
387 OSSL_STORE_INFO *info = OSSL_STORE_load(store_ctx);
388 int type = info == NULL ? 0 : OSSL_STORE_INFO_get_type(info);
389 const char *infostr =
390 info == NULL ? NULL : OSSL_STORE_INFO_type_string(type);
393 if (OSSL_STORE_eof(store_ctx))
396 if (OSSL_STORE_error(store_ctx)) {
400 ERR_print_errors(bio_err);
406 "ERROR: OSSL_STORE_load() returned NULL without "
407 "eof or error indications\n");
408 BIO_printf(bio_err, " This is an error in the loader\n");
409 ERR_print_errors(bio_err);
414 if (type == OSSL_STORE_INFO_NAME) {
415 const char *name = OSSL_STORE_INFO_get0_NAME(info);
416 const char *desc = OSSL_STORE_INFO_get0_NAME_description(info);
417 indent_printf(indent, bio_out, "%d: %s: %s\n", items, infostr,
420 indent_printf(indent, bio_out, "%s\n", desc);
422 indent_printf(indent, bio_out, "%d: %s\n", items, infostr);
426 * Unfortunately, PEM_X509_INFO_write_bio() is sorely lacking in
427 * functionality, so we must figure out how exactly to write things
431 case OSSL_STORE_INFO_NAME:
433 const char *suburi = OSSL_STORE_INFO_get0_NAME(info);
434 ret += process(suburi, uimeth, uidata,
435 expected, criterion, search,
436 text, noout, recursive, indent + 2, out, prog);
439 case OSSL_STORE_INFO_PARAMS:
441 EVP_PKEY_print_params(out, OSSL_STORE_INFO_get0_PARAMS(info),
444 PEM_write_bio_Parameters(out,
445 OSSL_STORE_INFO_get0_PARAMS(info));
447 case OSSL_STORE_INFO_PKEY:
449 EVP_PKEY_print_private(out, OSSL_STORE_INFO_get0_PKEY(info),
452 PEM_write_bio_PrivateKey(out, OSSL_STORE_INFO_get0_PKEY(info),
453 NULL, NULL, 0, NULL, NULL);
455 case OSSL_STORE_INFO_CERT:
457 X509_print(out, OSSL_STORE_INFO_get0_CERT(info));
459 PEM_write_bio_X509(out, OSSL_STORE_INFO_get0_CERT(info));
461 case OSSL_STORE_INFO_CRL:
463 X509_CRL_print(out, OSSL_STORE_INFO_get0_CRL(info));
465 PEM_write_bio_X509_CRL(out, OSSL_STORE_INFO_get0_CRL(info));
468 BIO_printf(bio_err, "!!! Unknown code\n");
473 OSSL_STORE_INFO_free(info);
475 indent_printf(indent, out, "Total found: %d\n", items);
478 if (!OSSL_STORE_close(store_ctx)) {
479 ERR_print_errors(bio_err);