1 /* apps/engine.c -*- mode: C; c-file-style: "eay" -*- */
2 /* Written by Richard Levitte <richard@levitte.org> for the OpenSSL
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).
62 #ifdef OPENSSL_NO_STDIO
66 #include <openssl/err.h>
67 #include <openssl/engine.h>
68 #include <openssl/ssl.h>
71 #define PROG engine_main
73 static char *engine_usage[]={
74 "usage: engine opts [engine ...]\n",
75 " -v[v[v[v]]] - verbose mode, for each engine, list its 'control commands'\n",
76 " -vv will additionally display each command's description\n",
77 " -vvv will also add the input flags for each command\n",
78 " -vvvv will also show internal input flags\n",
79 " -c - for each engine, also list the capabilities\n",
80 " -t - for each engine, check that they are really available\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(void *ptr)
97 static int append_buf(char **buf, const char *s, int *size, int step)
104 *buf = OPENSSL_malloc(*size);
113 if (strlen(*buf) + strlen(s) >= (unsigned int)*size)
116 *buf = OPENSSL_realloc(*buf, *size);
129 static int util_flags(BIO *bio_out, unsigned int flags, const char *indent)
131 int started = 0, err = 0;
132 /* Indent before displaying input flags */
133 BIO_printf(bio_out, "%s%s(input flags): ", indent, indent);
136 BIO_printf(bio_out, "<no flags>\n");
139 /* If the object is internal, mark it in a way that shows instead of
140 * having it part of all the other flags, even if it really is. */
141 if(flags & ENGINE_CMD_FLAG_INTERNAL)
143 BIO_printf(bio_out, "[Internal] ");
146 if(flags & ENGINE_CMD_FLAG_NUMERIC)
150 BIO_printf(bio_out, "|");
153 BIO_printf(bio_out, "NUMERIC");
156 /* Now we check that no combinations of the mutually exclusive NUMERIC,
157 * STRING, and NO_INPUT flags have been used. Future flags that can be
158 * OR'd together with these would need to added after these to preserve
159 * the testing logic. */
160 if(flags & ENGINE_CMD_FLAG_STRING)
164 BIO_printf(bio_out, "|");
167 BIO_printf(bio_out, "STRING");
170 if(flags & ENGINE_CMD_FLAG_NO_INPUT)
174 BIO_printf(bio_out, "|");
177 BIO_printf(bio_out, "NO_INPUT");
180 /* Check for unknown flags */
181 flags = flags & ~ENGINE_CMD_FLAG_NUMERIC &
182 ~ENGINE_CMD_FLAG_STRING &
183 ~ENGINE_CMD_FLAG_NO_INPUT &
184 ~ENGINE_CMD_FLAG_INTERNAL;
187 if(started) BIO_printf(bio_out, "|");
188 BIO_printf(bio_out, "<0x%04X>", flags);
191 BIO_printf(bio_out, " <illegal flags!>");
192 BIO_printf(bio_out, "\n");
196 static int util_verbose(ENGINE *e, int verbose, BIO *bio_out, const char *indent)
198 static const int line_wrap = 78;
206 if(!ENGINE_ctrl(e, ENGINE_CTRL_HAS_CTRL_FUNCTION, 0, NULL, NULL) ||
207 ((num = ENGINE_ctrl(e, ENGINE_CTRL_GET_FIRST_CMD_TYPE,
208 0, NULL, NULL)) <= 0))
211 BIO_printf(bio_out, "%s<no control commands>\n", indent);
216 cmds = sk_new_null();
222 /* Get the command input flags */
223 if((flags = ENGINE_ctrl(e, ENGINE_CTRL_GET_CMD_FLAGS, num,
226 if (!(flags & ENGINE_CMD_FLAG_INTERNAL) || verbose >= 4)
228 /* Get the command name */
229 if((len = ENGINE_ctrl(e, ENGINE_CTRL_GET_NAME_LEN_FROM_CMD, num,
232 if((name = OPENSSL_malloc(len + 1)) == NULL)
234 if(ENGINE_ctrl(e, ENGINE_CTRL_GET_NAME_FROM_CMD, num, name,
237 /* Get the command description */
238 if((len = ENGINE_ctrl(e, ENGINE_CTRL_GET_DESC_LEN_FROM_CMD, num,
243 if((desc = OPENSSL_malloc(len + 1)) == NULL)
245 if(ENGINE_ctrl(e, ENGINE_CTRL_GET_DESC_FROM_CMD, num, desc,
249 /* Now decide on the output */
252 xpos = BIO_printf(bio_out, indent);
254 /* Otherwise prepend a ", " */
255 xpos += BIO_printf(bio_out, ", ");
258 /* We're just listing names, comma-delimited */
259 if((xpos > (int)strlen(indent)) &&
260 (xpos + (int)strlen(name) > line_wrap))
262 BIO_printf(bio_out, "\n");
263 xpos = BIO_printf(bio_out, indent);
265 xpos += BIO_printf(bio_out, "%s", name);
269 /* We're listing names plus descriptions */
270 BIO_printf(bio_out, "%s: %s\n", name,
271 (desc == NULL) ? "<no description>" : desc);
272 /* ... and sometimes input flags */
273 if((verbose >= 3) && !util_flags(bio_out, flags,
279 OPENSSL_free(name); name = NULL;
280 if(desc) { OPENSSL_free(desc); desc = NULL; }
281 /* Move to the next command */
282 num = ENGINE_ctrl(e, ENGINE_CTRL_GET_NEXT_CMD_TYPE,
286 BIO_printf(bio_out, "\n");
289 if(cmds) sk_pop_free(cmds, identity);
290 if(name) OPENSSL_free(name);
291 if(desc) OPENSSL_free(desc);
295 static void util_do_cmds(ENGINE *e, STACK *cmds, BIO *bio_out, const char *indent)
297 int loop, res, num = sk_num(cmds);
300 BIO_printf(bio_out, "[Error]: internal stack error\n");
303 for(loop = 0; loop < num; loop++)
306 const char *cmd, *arg;
307 cmd = sk_value(cmds, loop);
308 res = 1; /* assume success */
309 /* Check if this command has no ":arg" */
310 if((arg = strstr(cmd, ":")) == NULL)
312 if(!ENGINE_ctrl_cmd_string(e, cmd, NULL, 0))
317 if((int)(arg - cmd) > 254)
319 BIO_printf(bio_out,"[Error]: command name too long\n");
322 memcpy(buf, cmd, (int)(arg - cmd));
324 arg++; /* Move past the ":" */
325 /* Call the command with the argument */
326 if(!ENGINE_ctrl_cmd_string(e, buf, arg, 0))
330 BIO_printf(bio_out, "[Success]: %s\n", cmd);
333 BIO_printf(bio_out, "[Failure]: %s\n", cmd);
334 ERR_print_errors(bio_out);
339 int MAIN(int, char **);
341 int MAIN(int argc, char **argv)
345 int verbose=0, list_cap=0, test_avail=0;
347 STACK *engines = sk_new_null();
348 STACK *pre_cmds = sk_new_null();
349 STACK *post_cmds = sk_new_null();
352 const char *indent = " ";
355 SSL_load_error_strings();
358 bio_err=BIO_new_fp(stderr,BIO_NOCLOSE);
360 if (!load_config(bio_err, NULL))
362 bio_out=BIO_new_fp(stdout,BIO_NOCLOSE);
363 #ifdef OPENSSL_SYS_VMS
365 BIO *tmpbio = BIO_new(BIO_f_linebuffer());
366 bio_out = BIO_push(tmpbio, bio_out);
374 if (strncmp(*argv,"-v",2) == 0)
376 if(strspn(*argv + 1, "v") < strlen(*argv + 1))
378 if((verbose=strlen(*argv + 1)) > 4)
381 else if (strcmp(*argv,"-c") == 0)
383 else if (strcmp(*argv,"-t") == 0)
385 else if (strcmp(*argv,"-pre") == 0)
388 sk_push(pre_cmds,*argv);
390 else if (strcmp(*argv,"-post") == 0)
393 sk_push(post_cmds,*argv);
395 else if ((strncmp(*argv,"-h",2) == 0) ||
396 (strcmp(*argv,"-?") == 0))
399 sk_push(engines,*argv);
403 /* Looks like everything went OK */
409 for (pp=engine_usage; (*pp != NULL); pp++)
410 BIO_printf(bio_err,"%s",*pp);
414 if (sk_num(engines) == 0)
416 for(e = ENGINE_get_first(); e != NULL; e = ENGINE_get_next(e))
418 sk_push(engines,(char *)ENGINE_get_id(e));
422 for (i=0; i<sk_num(engines); i++)
424 const char *id = sk_value(engines,i);
425 if ((e = ENGINE_by_id(id)) != NULL)
427 const char *name = ENGINE_get_name(e);
428 /* Do "id" first, then "name". Easier to auto-parse. */
429 BIO_printf(bio_out, "(%s) %s\n", id, name);
430 util_do_cmds(e, pre_cmds, bio_out, indent);
431 if (strcmp(ENGINE_get_id(e), id) != 0)
433 BIO_printf(bio_out, "Loaded: (%s) %s\n",
434 ENGINE_get_id(e), ENGINE_get_name(e));
439 char *cap_buf = NULL;
442 ENGINE_CIPHERS_PTR fn_c;
443 ENGINE_DIGESTS_PTR fn_d;
445 if (ENGINE_get_RSA(e) != NULL
446 && !append_buf(&cap_buf, "RSA",
449 if (ENGINE_get_DSA(e) != NULL
450 && !append_buf(&cap_buf, "DSA",
453 if (ENGINE_get_DH(e) != NULL
454 && !append_buf(&cap_buf, "DH",
457 if (ENGINE_get_RAND(e) != NULL
458 && !append_buf(&cap_buf, "RAND",
462 fn_c = ENGINE_get_ciphers(e);
463 if(!fn_c) goto skip_ciphers;
464 n = fn_c(e, NULL, &nids, 0);
465 for(k=0 ; k < n ; ++k)
466 if(!append_buf(&cap_buf,
472 fn_d = ENGINE_get_digests(e);
473 if(!fn_d) goto skip_digests;
474 n = fn_d(e, NULL, &nids, 0);
475 for(k=0 ; k < n ; ++k)
476 if(!append_buf(&cap_buf,
482 if (cap_buf && (*cap_buf != '\0'))
483 BIO_printf(bio_out, " [%s]\n", cap_buf);
485 OPENSSL_free(cap_buf);
489 BIO_printf(bio_out, "%s", indent);
492 BIO_printf(bio_out, "[ available ]\n");
493 util_do_cmds(e, post_cmds, bio_out, indent);
498 BIO_printf(bio_out, "[ unavailable ]\n");
499 ERR_print_errors_fp(stdout);
503 if((verbose > 0) && !util_verbose(e, verbose, bio_out, indent))
508 ERR_print_errors(bio_err);
513 ERR_print_errors(bio_err);
514 sk_pop_free(engines, identity);
515 sk_pop_free(pre_cmds, identity);
516 sk_pop_free(post_cmds, identity);
517 if (bio_out != NULL) BIO_free_all(bio_out);