1 /* apps/engine.c -*- mode: C; c-file-style: "eay" -*- */
3 * Written by Richard Levitte <richard@levitte.org> for the OpenSSL project
6 /* ====================================================================
7 * Copyright (c) 2000 The OpenSSL Project. All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
21 * 3. All advertising materials mentioning features or use of this
22 * software must display the following acknowledgment:
23 * "This product includes software developed by the OpenSSL Project
24 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
26 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27 * endorse or promote products derived from this software without
28 * prior written permission. For written permission, please contact
29 * licensing@OpenSSL.org.
31 * 5. Products derived from this software may not be called "OpenSSL"
32 * nor may "OpenSSL" appear in their names without prior written
33 * permission of the OpenSSL Project.
35 * 6. Redistributions of any form whatsoever must retain the following
37 * "This product includes software developed by the OpenSSL Project
38 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
40 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
44 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51 * OF THE POSSIBILITY OF SUCH DAMAGE.
52 * ====================================================================
54 * This product includes cryptographic software written by Eric Young
55 * (eay@cryptsoft.com). This product includes software written by Tim
56 * Hudson (tjh@cryptsoft.com).
64 #include <openssl/err.h>
65 #ifndef OPENSSL_NO_ENGINE
66 # include <openssl/engine.h>
67 # include <openssl/ssl.h>
70 # define PROG engine_main
72 static const char *engine_usage[] = {
73 "usage: engine opts [engine ...]\n",
74 " -v[v[v[v]]] - verbose mode, for each engine, list its 'control commands'\n",
75 " -vv will additionally display each command's description\n",
76 " -vvv will also add the input flags for each command\n",
77 " -vvvv will also show internal input flags\n",
78 " -c - for each engine, also list the capabilities\n",
79 " -t[t] - for each engine, check that they are really available\n",
80 " -tt will display error trace for unavailable engines\n",
81 " -pre <cmd> - runs command 'cmd' against the ENGINE before any attempts\n",
82 " to load it (if -t is used)\n",
83 " -post <cmd> - runs command 'cmd' against the ENGINE after loading it\n",
84 " (only used if -t is also provided)\n",
85 " NB: -pre and -post will be applied to all ENGINEs supplied on the command\n",
86 " line, or all supported ENGINEs if none are specified.\n",
87 " Eg. '-pre \"SO_PATH:/lib/libdriver.so\"' calls command \"SO_PATH\" with\n",
88 " argument \"/lib/libdriver.so\".\n",
92 static void identity(char *ptr)
97 static int append_buf(char **buf, const char *s, int *size, int step)
103 *buf = OPENSSL_malloc(*size);
112 if (strlen(*buf) + strlen(s) >= (unsigned int)*size) {
114 *buf = OPENSSL_realloc(*buf, *size);
121 BUF_strlcat(*buf, ", ", *size);
122 BUF_strlcat(*buf, s, *size);
127 static int util_flags(BIO *bio_out, unsigned int flags, const char *indent)
129 int started = 0, err = 0;
130 /* Indent before displaying input flags */
131 BIO_printf(bio_out, "%s%s(input flags): ", indent, indent);
133 BIO_printf(bio_out, "<no flags>\n");
137 * If the object is internal, mark it in a way that shows instead of
138 * having it part of all the other flags, even if it really is.
140 if (flags & ENGINE_CMD_FLAG_INTERNAL) {
141 BIO_printf(bio_out, "[Internal] ");
144 if (flags & ENGINE_CMD_FLAG_NUMERIC) {
145 BIO_printf(bio_out, "NUMERIC");
149 * Now we check that no combinations of the mutually exclusive NUMERIC,
150 * STRING, and NO_INPUT flags have been used. Future flags that can be
151 * OR'd together with these would need to added after these to preserve
154 if (flags & ENGINE_CMD_FLAG_STRING) {
156 BIO_printf(bio_out, "|");
159 BIO_printf(bio_out, "STRING");
162 if (flags & ENGINE_CMD_FLAG_NO_INPUT) {
164 BIO_printf(bio_out, "|");
167 BIO_printf(bio_out, "NO_INPUT");
170 /* Check for unknown flags */
171 flags = flags & ~ENGINE_CMD_FLAG_NUMERIC &
172 ~ENGINE_CMD_FLAG_STRING &
173 ~ENGINE_CMD_FLAG_NO_INPUT & ~ENGINE_CMD_FLAG_INTERNAL;
176 BIO_printf(bio_out, "|");
177 BIO_printf(bio_out, "<0x%04X>", flags);
180 BIO_printf(bio_out, " <illegal flags!>");
181 BIO_printf(bio_out, "\n");
185 static int util_verbose(ENGINE *e, int verbose, BIO *bio_out,
188 static const int line_wrap = 78;
195 STACK_OF(OPENSSL_STRING) *cmds = NULL;
196 if (!ENGINE_ctrl(e, ENGINE_CTRL_HAS_CTRL_FUNCTION, 0, NULL, NULL) ||
197 ((num = ENGINE_ctrl(e, ENGINE_CTRL_GET_FIRST_CMD_TYPE,
198 0, NULL, NULL)) <= 0)) {
202 cmds = sk_OPENSSL_STRING_new_null();
208 /* Get the command input flags */
209 if ((flags = ENGINE_ctrl(e, ENGINE_CTRL_GET_CMD_FLAGS, num,
212 if (!(flags & ENGINE_CMD_FLAG_INTERNAL) || verbose >= 4) {
213 /* Get the command name */
214 if ((len = ENGINE_ctrl(e, ENGINE_CTRL_GET_NAME_LEN_FROM_CMD, num,
217 if ((name = OPENSSL_malloc(len + 1)) == NULL)
219 if (ENGINE_ctrl(e, ENGINE_CTRL_GET_NAME_FROM_CMD, num, name,
222 /* Get the command description */
223 if ((len = ENGINE_ctrl(e, ENGINE_CTRL_GET_DESC_LEN_FROM_CMD, num,
227 if ((desc = OPENSSL_malloc(len + 1)) == NULL)
229 if (ENGINE_ctrl(e, ENGINE_CTRL_GET_DESC_FROM_CMD, num, desc,
233 /* Now decide on the output */
236 xpos = BIO_puts(bio_out, indent);
238 /* Otherwise prepend a ", " */
239 xpos += BIO_printf(bio_out, ", ");
242 * We're just listing names, comma-delimited
244 if ((xpos > (int)strlen(indent)) &&
245 (xpos + (int)strlen(name) > line_wrap)) {
246 BIO_printf(bio_out, "\n");
247 xpos = BIO_puts(bio_out, indent);
249 xpos += BIO_printf(bio_out, "%s", name);
251 /* We're listing names plus descriptions */
252 BIO_printf(bio_out, "%s: %s\n", name,
253 (desc == NULL) ? "<no description>" : desc);
254 /* ... and sometimes input flags */
255 if ((verbose >= 3) && !util_flags(bio_out, flags, indent))
266 /* Move to the next command */
267 num = ENGINE_ctrl(e, ENGINE_CTRL_GET_NEXT_CMD_TYPE, num, NULL, NULL);
270 BIO_printf(bio_out, "\n");
274 sk_OPENSSL_STRING_pop_free(cmds, identity);
282 static void util_do_cmds(ENGINE *e, STACK_OF(OPENSSL_STRING) *cmds,
283 BIO *bio_out, const char *indent)
285 int loop, res, num = sk_OPENSSL_STRING_num(cmds);
288 BIO_printf(bio_out, "[Error]: internal stack error\n");
291 for (loop = 0; loop < num; loop++) {
293 const char *cmd, *arg;
294 cmd = sk_OPENSSL_STRING_value(cmds, loop);
295 res = 1; /* assume success */
296 /* Check if this command has no ":arg" */
297 if ((arg = strstr(cmd, ":")) == NULL) {
298 if (!ENGINE_ctrl_cmd_string(e, cmd, NULL, 0))
301 if ((int)(arg - cmd) > 254) {
302 BIO_printf(bio_out, "[Error]: command name too long\n");
305 memcpy(buf, cmd, (int)(arg - cmd));
306 buf[arg - cmd] = '\0';
307 arg++; /* Move past the ":" */
308 /* Call the command with the argument */
309 if (!ENGINE_ctrl_cmd_string(e, buf, arg, 0))
313 BIO_printf(bio_out, "[Success]: %s\n", cmd);
315 BIO_printf(bio_out, "[Failure]: %s\n", cmd);
316 ERR_print_errors(bio_out);
321 int MAIN(int, char **);
323 int MAIN(int argc, char **argv)
327 int verbose = 0, list_cap = 0, test_avail = 0, test_avail_noise = 0;
329 STACK_OF(OPENSSL_STRING) *engines = sk_OPENSSL_STRING_new_null();
330 STACK_OF(OPENSSL_STRING) *pre_cmds = sk_OPENSSL_STRING_new_null();
331 STACK_OF(OPENSSL_STRING) *post_cmds = sk_OPENSSL_STRING_new_null();
334 const char *indent = " ";
337 SSL_load_error_strings();
340 bio_err = BIO_new_fp(stderr, BIO_NOCLOSE);
342 if (!load_config(bio_err, NULL))
344 bio_out = BIO_new_fp(stdout, BIO_NOCLOSE);
345 # ifdef OPENSSL_SYS_VMS
347 BIO *tmpbio = BIO_new(BIO_f_linebuffer());
348 bio_out = BIO_push(tmpbio, bio_out);
355 if (strncmp(*argv, "-v", 2) == 0) {
356 if (strspn(*argv + 1, "v") < strlen(*argv + 1))
358 if ((verbose = strlen(*argv + 1)) > 4)
360 } else if (strcmp(*argv, "-c") == 0)
362 else if (strncmp(*argv, "-t", 2) == 0) {
364 if (strspn(*argv + 1, "t") < strlen(*argv + 1))
366 if ((test_avail_noise = strlen(*argv + 1) - 1) > 1)
368 } else if (strcmp(*argv, "-pre") == 0) {
373 sk_OPENSSL_STRING_push(pre_cmds, *argv);
374 } else if (strcmp(*argv, "-post") == 0) {
379 sk_OPENSSL_STRING_push(post_cmds, *argv);
380 } else if ((strncmp(*argv, "-h", 2) == 0) ||
381 (strcmp(*argv, "-?") == 0))
384 sk_OPENSSL_STRING_push(engines, *argv);
388 /* Looks like everything went OK */
393 for (pp = engine_usage; (*pp != NULL); pp++)
394 BIO_printf(bio_err, "%s", *pp);
398 if (sk_OPENSSL_STRING_num(engines) == 0) {
399 for (e = ENGINE_get_first(); e != NULL; e = ENGINE_get_next(e)) {
400 sk_OPENSSL_STRING_push(engines, (char *)ENGINE_get_id(e));
404 for (i = 0; i < sk_OPENSSL_STRING_num(engines); i++) {
405 const char *id = sk_OPENSSL_STRING_value(engines, i);
406 if ((e = ENGINE_by_id(id)) != NULL) {
407 const char *name = ENGINE_get_name(e);
409 * Do "id" first, then "name". Easier to auto-parse.
411 BIO_printf(bio_out, "(%s) %s\n", id, name);
412 util_do_cmds(e, pre_cmds, bio_out, indent);
413 if (strcmp(ENGINE_get_id(e), id) != 0) {
414 BIO_printf(bio_out, "Loaded: (%s) %s\n",
415 ENGINE_get_id(e), ENGINE_get_name(e));
419 char *cap_buf = NULL;
422 ENGINE_CIPHERS_PTR fn_c;
423 ENGINE_DIGESTS_PTR fn_d;
424 ENGINE_PKEY_METHS_PTR fn_pk;
426 if (ENGINE_get_RSA(e) != NULL
427 && !append_buf(&cap_buf, "RSA", &cap_size, 256))
429 if (ENGINE_get_DSA(e) != NULL
430 && !append_buf(&cap_buf, "DSA", &cap_size, 256))
432 if (ENGINE_get_DH(e) != NULL
433 && !append_buf(&cap_buf, "DH", &cap_size, 256))
435 if (ENGINE_get_RAND(e) != NULL
436 && !append_buf(&cap_buf, "RAND", &cap_size, 256))
439 fn_c = ENGINE_get_ciphers(e);
442 n = fn_c(e, NULL, &nids, 0);
443 for (k = 0; k < n; ++k)
444 if (!append_buf(&cap_buf,
445 OBJ_nid2sn(nids[k]), &cap_size, 256))
449 fn_d = ENGINE_get_digests(e);
452 n = fn_d(e, NULL, &nids, 0);
453 for (k = 0; k < n; ++k)
454 if (!append_buf(&cap_buf,
455 OBJ_nid2sn(nids[k]), &cap_size, 256))
459 fn_pk = ENGINE_get_pkey_meths(e);
462 n = fn_pk(e, NULL, &nids, 0);
463 for (k = 0; k < n; ++k)
464 if (!append_buf(&cap_buf,
465 OBJ_nid2sn(nids[k]), &cap_size, 256))
468 if (cap_buf && (*cap_buf != '\0'))
469 BIO_printf(bio_out, " [%s]\n", cap_buf);
471 OPENSSL_free(cap_buf);
474 BIO_printf(bio_out, "%s", indent);
475 if (ENGINE_init(e)) {
476 BIO_printf(bio_out, "[ available ]\n");
477 util_do_cmds(e, post_cmds, bio_out, indent);
480 BIO_printf(bio_out, "[ unavailable ]\n");
481 if (test_avail_noise)
482 ERR_print_errors_fp(stdout);
486 if ((verbose > 0) && !util_verbose(e, verbose, bio_out, indent))
490 ERR_print_errors(bio_err);
496 ERR_print_errors(bio_err);
497 sk_OPENSSL_STRING_pop_free(engines, identity);
498 sk_OPENSSL_STRING_pop_free(pre_cmds, identity);
499 sk_OPENSSL_STRING_pop_free(post_cmds, identity);
500 BIO_free_all(bio_out);
507 static void *dummy = &dummy;