2 * Written by Richard Levitte <richard@levitte.org> for the OpenSSL project
5 /* ====================================================================
6 * Copyright (c) 2000 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
20 * 3. All advertising materials mentioning features or use of this
21 * software must display the following acknowledgment:
22 * "This product includes software developed by the OpenSSL Project
23 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26 * endorse or promote products derived from this software without
27 * prior written permission. For written permission, please contact
28 * licensing@OpenSSL.org.
30 * 5. Products derived from this software may not be called "OpenSSL"
31 * nor may "OpenSSL" appear in their names without prior written
32 * permission of the OpenSSL Project.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
43 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50 * OF THE POSSIBILITY OF SUCH DAMAGE.
51 * ====================================================================
53 * This product includes cryptographic software written by Eric Young
54 * (eay@cryptsoft.com). This product includes software written by Tim
55 * Hudson (tjh@cryptsoft.com).
59 #include <openssl/opensslconf.h>
60 #ifdef OPENSSL_NO_ENGINE
61 NON_EMPTY_TRANSLATION_UNIT
68 # include <openssl/err.h>
69 # include <openssl/engine.h>
70 # include <openssl/ssl.h>
72 typedef enum OPTION_choice {
73 OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
74 OPT_C, OPT_T, OPT_TT, OPT_PRE, OPT_POST,
75 OPT_V = 100, OPT_VV, OPT_VVV, OPT_VVVV
78 OPTIONS engine_options[] = {
79 {OPT_HELP_STR, 1, '-', "Usage: %s [options] engine...\n"},
80 {OPT_HELP_STR, 1, '-',
81 " engine... Engines to load\n"},
82 {"help", OPT_HELP, '-', "Display this summary"},
83 {"v", OPT_V, '-', "List 'control commands' For each specified engine"},
84 {"vv", OPT_VV, '-', "Also display each command's description"},
85 {"vvv", OPT_VVV, '-', "Also add the input flags for each command"},
86 {"vvvv", OPT_VVVV, '-', "Also show internal input flags"},
87 {"c", OPT_C, '-', "List the capabilities of specified engine"},
88 {"t", OPT_T, '-', "Check that specified engine is available"},
89 {"tt", OPT_TT, '-', "Display error trace for unavailable engines"},
90 {"pre", OPT_PRE, 's', "Run command against the ENGINE before loading it"},
91 {"post", OPT_POST, 's', "Run command against the ENGINE after loading it"},
92 {OPT_MORE_STR, OPT_EOF, 1,
93 "Commands are like \"SO_PATH:/lib/libdriver.so\""},
97 static void identity(char *ptr)
101 static int append_buf(char **buf, int *size, const char *s)
105 *buf = app_malloc(*size, "engine buffer");
109 if (strlen(*buf) + strlen(s) >= (unsigned int)*size) {
111 *buf = OPENSSL_realloc(*buf, *size);
118 OPENSSL_strlcat(*buf, ", ", *size);
119 OPENSSL_strlcat(*buf, s, *size);
124 static int util_flags(BIO *out, unsigned int flags, const char *indent)
126 int started = 0, err = 0;
127 /* Indent before displaying input flags */
128 BIO_printf(out, "%s%s(input flags): ", indent, indent);
130 BIO_printf(out, "<no flags>\n");
134 * If the object is internal, mark it in a way that shows instead of
135 * having it part of all the other flags, even if it really is.
137 if (flags & ENGINE_CMD_FLAG_INTERNAL) {
138 BIO_printf(out, "[Internal] ");
141 if (flags & ENGINE_CMD_FLAG_NUMERIC) {
142 BIO_printf(out, "NUMERIC");
146 * Now we check that no combinations of the mutually exclusive NUMERIC,
147 * STRING, and NO_INPUT flags have been used. Future flags that can be
148 * OR'd together with these would need to added after these to preserve
151 if (flags & ENGINE_CMD_FLAG_STRING) {
153 BIO_printf(out, "|");
156 BIO_printf(out, "STRING");
159 if (flags & ENGINE_CMD_FLAG_NO_INPUT) {
161 BIO_printf(out, "|");
164 BIO_printf(out, "NO_INPUT");
167 /* Check for unknown flags */
168 flags = flags & ~ENGINE_CMD_FLAG_NUMERIC &
169 ~ENGINE_CMD_FLAG_STRING &
170 ~ENGINE_CMD_FLAG_NO_INPUT & ~ENGINE_CMD_FLAG_INTERNAL;
173 BIO_printf(out, "|");
174 BIO_printf(out, "<0x%04X>", flags);
177 BIO_printf(out, " <illegal flags!>");
178 BIO_printf(out, "\n");
182 static int util_verbose(ENGINE *e, int verbose, BIO *out, const char *indent)
184 static const int line_wrap = 78;
191 STACK_OF(OPENSSL_STRING) *cmds = NULL;
192 if (!ENGINE_ctrl(e, ENGINE_CTRL_HAS_CTRL_FUNCTION, 0, NULL, NULL) ||
193 ((num = ENGINE_ctrl(e, ENGINE_CTRL_GET_FIRST_CMD_TYPE,
194 0, NULL, NULL)) <= 0)) {
198 cmds = sk_OPENSSL_STRING_new_null();
204 /* Get the command input flags */
205 if ((flags = ENGINE_ctrl(e, ENGINE_CTRL_GET_CMD_FLAGS, num,
208 if (!(flags & ENGINE_CMD_FLAG_INTERNAL) || verbose >= 4) {
209 /* Get the command name */
210 if ((len = ENGINE_ctrl(e, ENGINE_CTRL_GET_NAME_LEN_FROM_CMD, num,
213 name = app_malloc(len + 1, "name buffer");
214 if (ENGINE_ctrl(e, ENGINE_CTRL_GET_NAME_FROM_CMD, num, name,
217 /* Get the command description */
218 if ((len = ENGINE_ctrl(e, ENGINE_CTRL_GET_DESC_LEN_FROM_CMD, num,
222 desc = app_malloc(len + 1, "description buffer");
223 if (ENGINE_ctrl(e, ENGINE_CTRL_GET_DESC_FROM_CMD, num, desc,
227 /* Now decide on the output */
230 xpos = BIO_puts(out, indent);
232 /* Otherwise prepend a ", " */
233 xpos += BIO_printf(out, ", ");
236 * We're just listing names, comma-delimited
238 if ((xpos > (int)strlen(indent)) &&
239 (xpos + (int)strlen(name) > line_wrap)) {
240 BIO_printf(out, "\n");
241 xpos = BIO_puts(out, indent);
243 xpos += BIO_printf(out, "%s", name);
245 /* We're listing names plus descriptions */
246 BIO_printf(out, "%s: %s\n", name,
247 (desc == NULL) ? "<no description>" : desc);
248 /* ... and sometimes input flags */
249 if ((verbose >= 3) && !util_flags(out, flags, indent))
258 /* Move to the next command */
259 num = ENGINE_ctrl(e, ENGINE_CTRL_GET_NEXT_CMD_TYPE, num, NULL, NULL);
262 BIO_printf(out, "\n");
265 sk_OPENSSL_STRING_pop_free(cmds, identity);
271 static void util_do_cmds(ENGINE *e, STACK_OF(OPENSSL_STRING) *cmds,
272 BIO *out, const char *indent)
274 int loop, res, num = sk_OPENSSL_STRING_num(cmds);
277 BIO_printf(out, "[Error]: internal stack error\n");
280 for (loop = 0; loop < num; loop++) {
282 const char *cmd, *arg;
283 cmd = sk_OPENSSL_STRING_value(cmds, loop);
284 res = 1; /* assume success */
285 /* Check if this command has no ":arg" */
286 if ((arg = strstr(cmd, ":")) == NULL) {
287 if (!ENGINE_ctrl_cmd_string(e, cmd, NULL, 0))
290 if ((int)(arg - cmd) > 254) {
291 BIO_printf(out, "[Error]: command name too long\n");
294 memcpy(buf, cmd, (int)(arg - cmd));
295 buf[arg - cmd] = '\0';
296 arg++; /* Move past the ":" */
297 /* Call the command with the argument */
298 if (!ENGINE_ctrl_cmd_string(e, buf, arg, 0))
302 BIO_printf(out, "[Success]: %s\n", cmd);
304 BIO_printf(out, "[Failure]: %s\n", cmd);
305 ERR_print_errors(out);
310 int engine_main(int argc, char **argv)
313 int verbose = 0, list_cap = 0, test_avail = 0, test_avail_noise = 0;
315 STACK_OF(OPENSSL_STRING) *engines = sk_OPENSSL_STRING_new_null();
316 STACK_OF(OPENSSL_STRING) *pre_cmds = sk_OPENSSL_STRING_new_null();
317 STACK_OF(OPENSSL_STRING) *post_cmds = sk_OPENSSL_STRING_new_null();
319 const char *indent = " ";
324 out = dup_bio_out(FORMAT_TEXT);
325 if (engines == NULL || pre_cmds == NULL || post_cmds == NULL)
328 /* Remember the original command name, parse/skip any leading engine
329 * names, and then setup to parse the rest of the line as flags. */
331 while ((argv1 = argv[1]) != NULL && *argv1 != '-') {
332 sk_OPENSSL_STRING_push(engines, argv1);
337 opt_init(argc, argv, engine_options);
339 while ((o = opt_next()) != OPT_EOF) {
343 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
346 opt_help(engine_options);
353 /* Convert to an integer from one to four. */
354 i = (int)(o - OPT_V) + 1;
367 sk_OPENSSL_STRING_push(pre_cmds, opt_arg());
370 sk_OPENSSL_STRING_push(post_cmds, opt_arg());
375 /* Allow any trailing parameters as engine names. */
376 argc = opt_num_rest();
378 for ( ; *argv; argv++) {
380 BIO_printf(bio_err, "%s: Cannot mix flags and engine names.\n",
382 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
385 sk_OPENSSL_STRING_push(engines, *argv);
388 if (sk_OPENSSL_STRING_num(engines) == 0) {
389 for (e = ENGINE_get_first(); e != NULL; e = ENGINE_get_next(e)) {
390 sk_OPENSSL_STRING_push(engines, (char *)ENGINE_get_id(e));
394 for (i = 0; i < sk_OPENSSL_STRING_num(engines); i++) {
395 const char *id = sk_OPENSSL_STRING_value(engines, i);
396 if ((e = ENGINE_by_id(id)) != NULL) {
397 const char *name = ENGINE_get_name(e);
399 * Do "id" first, then "name". Easier to auto-parse.
401 BIO_printf(out, "(%s) %s\n", id, name);
402 util_do_cmds(e, pre_cmds, out, indent);
403 if (strcmp(ENGINE_get_id(e), id) != 0) {
404 BIO_printf(out, "Loaded: (%s) %s\n",
405 ENGINE_get_id(e), ENGINE_get_name(e));
409 char *cap_buf = NULL;
412 ENGINE_CIPHERS_PTR fn_c;
413 ENGINE_DIGESTS_PTR fn_d;
414 ENGINE_PKEY_METHS_PTR fn_pk;
416 if (ENGINE_get_RSA(e) != NULL
417 && !append_buf(&cap_buf, &cap_size, "RSA"))
419 if (ENGINE_get_DSA(e) != NULL
420 && !append_buf(&cap_buf, &cap_size, "DSA"))
422 if (ENGINE_get_DH(e) != NULL
423 && !append_buf(&cap_buf, &cap_size, "DH"))
425 if (ENGINE_get_RAND(e) != NULL
426 && !append_buf(&cap_buf, &cap_size, "RAND"))
429 fn_c = ENGINE_get_ciphers(e);
432 n = fn_c(e, NULL, &nids, 0);
433 for (k = 0; k < n; ++k)
434 if (!append_buf(&cap_buf, &cap_size, OBJ_nid2sn(nids[k])))
438 fn_d = ENGINE_get_digests(e);
441 n = fn_d(e, NULL, &nids, 0);
442 for (k = 0; k < n; ++k)
443 if (!append_buf(&cap_buf, &cap_size, OBJ_nid2sn(nids[k])))
447 fn_pk = ENGINE_get_pkey_meths(e);
450 n = fn_pk(e, NULL, &nids, 0);
451 for (k = 0; k < n; ++k)
452 if (!append_buf(&cap_buf, &cap_size, OBJ_nid2sn(nids[k])))
455 if (cap_buf && (*cap_buf != '\0'))
456 BIO_printf(out, " [%s]\n", cap_buf);
458 OPENSSL_free(cap_buf);
461 BIO_printf(out, "%s", indent);
462 if (ENGINE_init(e)) {
463 BIO_printf(out, "[ available ]\n");
464 util_do_cmds(e, post_cmds, out, indent);
467 BIO_printf(out, "[ unavailable ]\n");
468 if (test_avail_noise)
469 ERR_print_errors_fp(stdout);
473 if ((verbose > 0) && !util_verbose(e, verbose, out, indent))
477 ERR_print_errors(bio_err);
483 ERR_print_errors(bio_err);
484 sk_OPENSSL_STRING_pop_free(engines, identity);
485 sk_OPENSSL_STRING_pop_free(pre_cmds, identity);
486 sk_OPENSSL_STRING_pop_free(post_cmds, identity);