storeutl.c

Last change on this file was 108206, checked in by vboxsync, 3 months ago
openssl-3.3.2: Exported all files to OSE and removed .scm-settings bugref:10757
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 16.7 KB

Line
1	/*
2	* Copyright 2016-2022 The OpenSSL Project Authors. All Rights Reserved.
3	*
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
8	*/
9
10	#include <openssl/opensslconf.h>
11
12	#include "apps.h"
13	#include "progs.h"
14	#include <openssl/err.h>
15	#include <openssl/pem.h>
16	#include <openssl/store.h>
17	#include <openssl/x509v3.h> /* s2i_ASN1_INTEGER */
18
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);
23
24	typedef enum OPTION_choice {
25	OPT_COMMON,
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,
31	OPT_MD, OPT_PROV_ENUM
32	} OPTION_CHOICE;
33
34	const OPTIONS storeutl_options[] = {
35	{OPT_HELP_STR, 1, '-', "Usage: %s [options] uri\n"},
36
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"},
42	#endif
43
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"},
54
55	OPT_SECTION("Input"),
56	{"passin", OPT_PASSIN, 's', "Input file pass phrase source"},
57
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"},
62
63	OPT_PROV_OPTIONS,
64
65	OPT_PARAMETERS(),
66	{"uri", 0, 0, "URI of the store object"},
67	{NULL}
68	};
69
70	int storeutl_main(int argc, char *argv[])
71	{
72	int ret = 1, noout = 0, text = 0, recursive = 0;
73	char outfile = NULL, passin = NULL, *passinarg = NULL;
74	BIO *out = NULL;
75	ENGINE *e = NULL;
76	OPTION_CHOICE o;
77	char *prog;
78	PW_CB_DATA pw_cb_data;
79	int expected = 0;
80	int criterion = 0;
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();
89
90	opt_set_unknown_name("digest");
91	prog = opt_init(argc, argv, storeutl_options);
92	while ((o = opt_next()) != OPT_EOF) {
93	switch (o) {
94	case OPT_EOF:
95	case OPT_ERR:
96	opthelp:
97	BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
98	goto end;
99	case OPT_HELP:
100	opt_help(storeutl_options);
101	ret = 0;
102	goto end;
103	case OPT_OUT:
104	outfile = opt_arg();
105	break;
106	case OPT_PASSIN:
107	passinarg = opt_arg();
108	break;
109	case OPT_NOOUT:
110	noout = 1;
111	break;
112	case OPT_TEXT:
113	text = 1;
114	break;
115	case OPT_RECURSIVE:
116	recursive = 1;
117	break;
118	case OPT_SEARCHFOR_CERTS:
119	case OPT_SEARCHFOR_KEYS:
120	case OPT_SEARCHFOR_CRLS:
121	if (expected != 0) {
122	BIO_printf(bio_err, "%s: only one search type can be given.\n",
123	prog);
124	goto end;
125	}
126	{
127	static const struct {
128	enum OPTION_choice choice;
129	int type;
130	} map[] = {
131	{OPT_SEARCHFOR_CERTS, OSSL_STORE_INFO_CERT},
132	{OPT_SEARCHFOR_KEYS, OSSL_STORE_INFO_PKEY},
133	{OPT_SEARCHFOR_CRLS, OSSL_STORE_INFO_CRL},
134	};
135	size_t i;
136
137	for (i = 0; i < OSSL_NELEM(map); i++) {
138	if (o == map[i].choice) {
139	expected = map[i].type;
140	break;
141	}
142	}
143	/*
144	* If expected wasn't set at this point, it means the map
145	* isn't synchronised with the possible options leading here.
146	*/
147	OPENSSL_assert(expected != 0);
148	}
149	break;
150	case OPT_CRITERION_SUBJECT:
151	if (criterion != 0) {
152	BIO_printf(bio_err, "%s: criterion already given.\n",
153	prog);
154	goto end;
155	}
156	criterion = OSSL_STORE_SEARCH_BY_NAME;
157	if (subject != NULL) {
158	BIO_printf(bio_err, "%s: subject already given.\n",
159	prog);
160	goto end;
161	}
162	subject = parse_name(opt_arg(), MBSTRING_UTF8, 1, "subject");
163	if (subject == NULL)
164	goto end;
165	break;
166	case OPT_CRITERION_ISSUER:
167	if (criterion != 0
168	&& criterion != OSSL_STORE_SEARCH_BY_ISSUER_SERIAL) {
169	BIO_printf(bio_err, "%s: criterion already given.\n",
170	prog);
171	goto end;
172	}
173	criterion = OSSL_STORE_SEARCH_BY_ISSUER_SERIAL;
174	if (issuer != NULL) {
175	BIO_printf(bio_err, "%s: issuer already given.\n",
176	prog);
177	goto end;
178	}
179	issuer = parse_name(opt_arg(), MBSTRING_UTF8, 1, "issuer");
180	if (issuer == NULL)
181	goto end;
182	break;
183	case OPT_CRITERION_SERIAL:
184	if (criterion != 0
185	&& criterion != OSSL_STORE_SEARCH_BY_ISSUER_SERIAL) {
186	BIO_printf(bio_err, "%s: criterion already given.\n",
187	prog);
188	goto end;
189	}
190	criterion = OSSL_STORE_SEARCH_BY_ISSUER_SERIAL;
191	if (serial != NULL) {
192	BIO_printf(bio_err, "%s: serial number already given.\n",
193	prog);
194	goto end;
195	}
196	if ((serial = s2i_ASN1_INTEGER(NULL, opt_arg())) == NULL) {
197	BIO_printf(bio_err, "%s: can't parse serial number argument.\n",
198	prog);
199	goto end;
200	}
201	break;
202	case OPT_CRITERION_FINGERPRINT:
203	if (criterion != 0
204	\|\| (criterion == OSSL_STORE_SEARCH_BY_KEY_FINGERPRINT
205	&& fingerprint != NULL)) {
206	BIO_printf(bio_err, "%s: criterion already given.\n",
207	prog);
208	goto end;
209	}
210	criterion = OSSL_STORE_SEARCH_BY_KEY_FINGERPRINT;
211	if (fingerprint != NULL) {
212	BIO_printf(bio_err, "%s: fingerprint already given.\n",
213	prog);
214	goto end;
215	}
216	{
217	long tmplen = 0;
218
219	if ((fingerprint = OPENSSL_hexstr2buf(opt_arg(), &tmplen))
220	== NULL) {
221	BIO_printf(bio_err,
222	"%s: can't parse fingerprint argument.\n",
223	prog);
224	goto end;
225	}
226	fingerprintlen = (size_t)tmplen;
227	}
228	break;
229	case OPT_CRITERION_ALIAS:
230	if (criterion != 0) {
231	BIO_printf(bio_err, "%s: criterion already given.\n",
232	prog);
233	goto end;
234	}
235	criterion = OSSL_STORE_SEARCH_BY_ALIAS;
236	if (alias != NULL) {
237	BIO_printf(bio_err, "%s: alias already given.\n",
238	prog);
239	goto end;
240	}
241	if ((alias = OPENSSL_strdup(opt_arg())) == NULL) {
242	BIO_printf(bio_err, "%s: can't parse alias argument.\n",
243	prog);
244	goto end;
245	}
246	break;
247	case OPT_ENGINE:
248	e = setup_engine(opt_arg(), 0);
249	break;
250	case OPT_MD:
251	digestname = opt_unknown();
252	break;
253	case OPT_PROV_CASES:
254	if (!opt_provider(o))
255	goto end;
256	break;
257	}
258	}
259
260	/* One argument, the URI */
261	if (!opt_check_rest_arg("URI"))
262	goto opthelp;
263	argv = opt_rest();
264
265	if (!opt_md(digestname, &digest))
266	goto opthelp;
267
268	if (criterion != 0) {
269	switch (criterion) {
270	case OSSL_STORE_SEARCH_BY_NAME:
271	if ((search = OSSL_STORE_SEARCH_by_name(subject)) == NULL) {
272	ERR_print_errors(bio_err);
273	goto end;
274	}
275	break;
276	case OSSL_STORE_SEARCH_BY_ISSUER_SERIAL:
277	if (issuer == NULL \|\| serial == NULL) {
278	BIO_printf(bio_err,
279	"%s: both -issuer and -serial must be given.\n",
280	prog);
281	goto end;
282	}
283	if ((search = OSSL_STORE_SEARCH_by_issuer_serial(issuer, serial))
284	== NULL) {
285	ERR_print_errors(bio_err);
286	goto end;
287	}
288	break;
289	case OSSL_STORE_SEARCH_BY_KEY_FINGERPRINT:
290	if ((search = OSSL_STORE_SEARCH_by_key_fingerprint(digest,
291	fingerprint,
292	fingerprintlen))
293	== NULL) {
294	ERR_print_errors(bio_err);
295	goto end;
296	}
297	break;
298	case OSSL_STORE_SEARCH_BY_ALIAS:
299	if ((search = OSSL_STORE_SEARCH_by_alias(alias)) == NULL) {
300	ERR_print_errors(bio_err);
301	goto end;
302	}
303	break;
304	}
305	}
306
307	if (!app_passwd(passinarg, NULL, &passin, NULL)) {
308	BIO_printf(bio_err, "Error getting passwords\n");
309	goto end;
310	}
311	pw_cb_data.password = passin;
312	pw_cb_data.prompt_info = argv[0];
313
314	out = bio_open_default(outfile, 'w', FORMAT_TEXT);
315	if (out == NULL)
316	goto end;
317
318	ret = process(argv[0], get_ui_method(), &pw_cb_data,
319	expected, criterion, search,
320	text, noout, recursive, 0, out, prog, libctx);
321
322	end:
323	EVP_MD_free(digest);
324	OPENSSL_free(fingerprint);
325	OPENSSL_free(alias);
326	ASN1_INTEGER_free(serial);
327	X509_NAME_free(subject);
328	X509_NAME_free(issuer);
329	OSSL_STORE_SEARCH_free(search);
330	BIO_free_all(out);
331	OPENSSL_free(passin);
332	release_engine(e);
333	return ret;
334	}
335
336	static int indent_printf(int indent, BIO bio, const char format, ...)
337	{
338	va_list args;
339	int ret;
340
341	va_start(args, format);
342
343	ret = BIO_printf(bio, "%*s", indent, "") + BIO_vprintf(bio, format, args);
344
345	va_end(args);
346	return ret;
347	}
348
349	static int process(const char uri, const UI_METHOD uimeth, PW_CB_DATA *uidata,
350	int expected, int criterion, OSSL_STORE_SEARCH *search,
351	int text, int noout, int recursive, int indent, BIO *out,
352	const char prog, OSSL_LIB_CTX libctx)
353	{
354	OSSL_STORE_CTX *store_ctx = NULL;
355	int ret = 1, items = 0;
356
357	if ((store_ctx = OSSL_STORE_open_ex(uri, libctx, app_get0_propq(), uimeth, uidata,
358	NULL, NULL, NULL))
359	== NULL) {
360	BIO_printf(bio_err, "Couldn't open file or uri %s\n", uri);
361	ERR_print_errors(bio_err);
362	return ret;
363	}
364
365	if (expected != 0) {
366	if (!OSSL_STORE_expect(store_ctx, expected)) {
367	ERR_print_errors(bio_err);
368	goto end2;
369	}
370	}
371
372	if (criterion != 0) {
373	if (!OSSL_STORE_supports_search(store_ctx, criterion)) {
374	BIO_printf(bio_err,
375	"%s: the store scheme doesn't support the given search criteria.\n",
376	prog);
377	goto end2;
378	}
379
380	if (!OSSL_STORE_find(store_ctx, search)) {
381	ERR_print_errors(bio_err);
382	goto end2;
383	}
384	}
385
386	/* From here on, we count errors, and we'll return the count at the end */
387	ret = 0;
388
389	for (;;) {
390	OSSL_STORE_INFO *info = OSSL_STORE_load(store_ctx);
391	int type = info == NULL ? 0 : OSSL_STORE_INFO_get_type(info);
392	const char *infostr =
393	info == NULL ? NULL : OSSL_STORE_INFO_type_string(type);
394
395	if (info == NULL) {
396	if (OSSL_STORE_error(store_ctx)) {
397	if (recursive)
398	ERR_clear_error();
399	else
400	ERR_print_errors(bio_err);
401	if (OSSL_STORE_eof(store_ctx))
402	break;
403	ret++;
404	continue;
405	}
406
407	if (OSSL_STORE_eof(store_ctx))
408	break;
409
410	BIO_printf(bio_err,
411	"ERROR: OSSL_STORE_load() returned NULL without "
412	"eof or error indications\n");
413	BIO_printf(bio_err, " This is an error in the loader\n");
414	ERR_print_errors(bio_err);
415	ret++;
416	break;
417	}
418
419	if (type == OSSL_STORE_INFO_NAME) {
420	const char *name = OSSL_STORE_INFO_get0_NAME(info);
421	const char *desc = OSSL_STORE_INFO_get0_NAME_description(info);
422	indent_printf(indent, bio_out, "%d: %s: %s\n", items, infostr,
423	name);
424	if (desc != NULL)
425	indent_printf(indent, bio_out, "%s\n", desc);
426	} else {
427	indent_printf(indent, bio_out, "%d: %s\n", items, infostr);
428	}
429
430	/*
431	* Unfortunately, PEM_X509_INFO_write_bio() is sorely lacking in
432	* functionality, so we must figure out how exactly to write things
433	* ourselves...
434	*/
435	switch (type) {
436	case OSSL_STORE_INFO_NAME:
437	if (recursive) {
438	const char *suburi = OSSL_STORE_INFO_get0_NAME(info);
439	ret += process(suburi, uimeth, uidata,
440	expected, criterion, search,
441	text, noout, recursive, indent + 2, out, prog,
442	libctx);
443	}
444	break;
445	case OSSL_STORE_INFO_PARAMS:
446	if (text)
447	EVP_PKEY_print_params(out, OSSL_STORE_INFO_get0_PARAMS(info),
448	0, NULL);
449	if (!noout)
450	PEM_write_bio_Parameters(out,
451	OSSL_STORE_INFO_get0_PARAMS(info));
452	break;
453	case OSSL_STORE_INFO_PUBKEY:
454	if (text)
455	EVP_PKEY_print_public(out, OSSL_STORE_INFO_get0_PUBKEY(info),
456	0, NULL);
457	if (!noout)
458	PEM_write_bio_PUBKEY(out, OSSL_STORE_INFO_get0_PUBKEY(info));
459	break;
460	case OSSL_STORE_INFO_PKEY:
461	if (text)
462	EVP_PKEY_print_private(out, OSSL_STORE_INFO_get0_PKEY(info),
463	0, NULL);
464	if (!noout)
465	PEM_write_bio_PrivateKey(out, OSSL_STORE_INFO_get0_PKEY(info),
466	NULL, NULL, 0, NULL, NULL);
467	break;
468	case OSSL_STORE_INFO_CERT:
469	if (text)
470	X509_print(out, OSSL_STORE_INFO_get0_CERT(info));
471	if (!noout)
472	PEM_write_bio_X509(out, OSSL_STORE_INFO_get0_CERT(info));
473	break;
474	case OSSL_STORE_INFO_CRL:
475	if (text)
476	X509_CRL_print(out, OSSL_STORE_INFO_get0_CRL(info));
477	if (!noout)
478	PEM_write_bio_X509_CRL(out, OSSL_STORE_INFO_get0_CRL(info));
479	break;
480	default:
481	BIO_printf(bio_err, "!!! Unknown code\n");
482	ret++;
483	break;
484	}
485	items++;
486	OSSL_STORE_INFO_free(info);
487	}
488	indent_printf(indent, out, "Total found: %d\n", items);
489
490	end2:
491	if (!OSSL_STORE_close(store_ctx)) {
492	ERR_print_errors(bio_err);
493	ret++;
494	}
495
496	return ret;
497	}

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/libs/openssl-3.3.2/apps/storeutl.c

Download in other formats: