0d1e003f84
Allow initial engine names as first parameters before flags. Also add engine param to help summary Wrote manpage Reviewed-by: Viktor Dukhovni <viktor@openssl.org>
492 lines
16 KiB
C
492 lines
16 KiB
C
/*
|
|
* Written by Richard Levitte <richard@levitte.org> for the OpenSSL project
|
|
* 2000.
|
|
*/
|
|
/* ====================================================================
|
|
* Copyright (c) 2000 The OpenSSL Project. All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
*
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
*
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in
|
|
* the documentation and/or other materials provided with the
|
|
* distribution.
|
|
*
|
|
* 3. All advertising materials mentioning features or use of this
|
|
* software must display the following acknowledgment:
|
|
* "This product includes software developed by the OpenSSL Project
|
|
* for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
|
|
*
|
|
* 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
|
|
* endorse or promote products derived from this software without
|
|
* prior written permission. For written permission, please contact
|
|
* licensing@OpenSSL.org.
|
|
*
|
|
* 5. Products derived from this software may not be called "OpenSSL"
|
|
* nor may "OpenSSL" appear in their names without prior written
|
|
* permission of the OpenSSL Project.
|
|
*
|
|
* 6. Redistributions of any form whatsoever must retain the following
|
|
* acknowledgment:
|
|
* "This product includes software developed by the OpenSSL Project
|
|
* for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
|
|
* EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
|
|
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
|
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
|
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
|
|
* OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
* ====================================================================
|
|
*
|
|
* This product includes cryptographic software written by Eric Young
|
|
* (eay@cryptsoft.com). This product includes software written by Tim
|
|
* Hudson (tjh@cryptsoft.com).
|
|
*
|
|
*/
|
|
|
|
#include <stdio.h>
|
|
#include <stdlib.h>
|
|
#include <string.h>
|
|
#include "apps.h"
|
|
#include <openssl/err.h>
|
|
#ifndef OPENSSL_NO_ENGINE
|
|
# include <openssl/engine.h>
|
|
# include <openssl/ssl.h>
|
|
|
|
typedef enum OPTION_choice {
|
|
OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
|
|
OPT_C, OPT_T, OPT_TT, OPT_PRE, OPT_POST,
|
|
OPT_V = 100, OPT_VV, OPT_VVV, OPT_VVVV
|
|
} OPTION_CHOICE;
|
|
|
|
OPTIONS engine_options[] = {
|
|
{OPT_HELP_STR, 1, '-', "Usage: %s [options] engine...\n"},
|
|
{OPT_HELP_STR, 1, '-',
|
|
" engine... Engines to load\n"},
|
|
{"help", OPT_HELP, '-', "Display this summary"},
|
|
{"v", OPT_V, '-', "List 'control commands' For each specified engine"},
|
|
{"vv", OPT_VV, '-', "Also display each command's description"},
|
|
{"vvv", OPT_VVV, '-', "Also add the input flags for each command"},
|
|
{"vvvv", OPT_VVVV, '-', "Also show internal input flags"},
|
|
{"c", OPT_C, '-', "List the capabilities of specified engine"},
|
|
{"t", OPT_T, '-', "Check that specified engine is available"},
|
|
{"tt", OPT_TT, '-', "Display error trace for unavailable engines"},
|
|
{"pre", OPT_PRE, 's', "Run command against the ENGINE before loading it"},
|
|
{"post", OPT_POST, 's', "Run command against the ENGINE after loading it"},
|
|
{OPT_MORE_STR, OPT_EOF, 1,
|
|
"Commands are like \"SO_PATH:/lib/libdriver.so\""},
|
|
{NULL}
|
|
};
|
|
|
|
static void identity(char *ptr)
|
|
{
|
|
}
|
|
|
|
static int append_buf(char **buf, int *size, const char *s)
|
|
{
|
|
if (*buf == NULL) {
|
|
*size = 256;
|
|
*buf = app_malloc(*size, "engine buffer");
|
|
**buf = '\0';
|
|
}
|
|
|
|
if (strlen(*buf) + strlen(s) >= (unsigned int)*size) {
|
|
*size += 256;
|
|
*buf = OPENSSL_realloc(*buf, *size);
|
|
}
|
|
|
|
if (*buf == NULL)
|
|
return 0;
|
|
|
|
if (**buf != '\0')
|
|
OPENSSL_strlcat(*buf, ", ", *size);
|
|
OPENSSL_strlcat(*buf, s, *size);
|
|
|
|
return 1;
|
|
}
|
|
|
|
static int util_flags(BIO *out, unsigned int flags, const char *indent)
|
|
{
|
|
int started = 0, err = 0;
|
|
/* Indent before displaying input flags */
|
|
BIO_printf(out, "%s%s(input flags): ", indent, indent);
|
|
if (flags == 0) {
|
|
BIO_printf(out, "<no flags>\n");
|
|
return 1;
|
|
}
|
|
/*
|
|
* If the object is internal, mark it in a way that shows instead of
|
|
* having it part of all the other flags, even if it really is.
|
|
*/
|
|
if (flags & ENGINE_CMD_FLAG_INTERNAL) {
|
|
BIO_printf(out, "[Internal] ");
|
|
}
|
|
|
|
if (flags & ENGINE_CMD_FLAG_NUMERIC) {
|
|
BIO_printf(out, "NUMERIC");
|
|
started = 1;
|
|
}
|
|
/*
|
|
* Now we check that no combinations of the mutually exclusive NUMERIC,
|
|
* STRING, and NO_INPUT flags have been used. Future flags that can be
|
|
* OR'd together with these would need to added after these to preserve
|
|
* the testing logic.
|
|
*/
|
|
if (flags & ENGINE_CMD_FLAG_STRING) {
|
|
if (started) {
|
|
BIO_printf(out, "|");
|
|
err = 1;
|
|
}
|
|
BIO_printf(out, "STRING");
|
|
started = 1;
|
|
}
|
|
if (flags & ENGINE_CMD_FLAG_NO_INPUT) {
|
|
if (started) {
|
|
BIO_printf(out, "|");
|
|
err = 1;
|
|
}
|
|
BIO_printf(out, "NO_INPUT");
|
|
started = 1;
|
|
}
|
|
/* Check for unknown flags */
|
|
flags = flags & ~ENGINE_CMD_FLAG_NUMERIC &
|
|
~ENGINE_CMD_FLAG_STRING &
|
|
~ENGINE_CMD_FLAG_NO_INPUT & ~ENGINE_CMD_FLAG_INTERNAL;
|
|
if (flags) {
|
|
if (started)
|
|
BIO_printf(out, "|");
|
|
BIO_printf(out, "<0x%04X>", flags);
|
|
}
|
|
if (err)
|
|
BIO_printf(out, " <illegal flags!>");
|
|
BIO_printf(out, "\n");
|
|
return 1;
|
|
}
|
|
|
|
static int util_verbose(ENGINE *e, int verbose, BIO *out, const char *indent)
|
|
{
|
|
static const int line_wrap = 78;
|
|
int num;
|
|
int ret = 0;
|
|
char *name = NULL;
|
|
char *desc = NULL;
|
|
int flags;
|
|
int xpos = 0;
|
|
STACK_OF(OPENSSL_STRING) *cmds = NULL;
|
|
if (!ENGINE_ctrl(e, ENGINE_CTRL_HAS_CTRL_FUNCTION, 0, NULL, NULL) ||
|
|
((num = ENGINE_ctrl(e, ENGINE_CTRL_GET_FIRST_CMD_TYPE,
|
|
0, NULL, NULL)) <= 0)) {
|
|
return 1;
|
|
}
|
|
|
|
cmds = sk_OPENSSL_STRING_new_null();
|
|
if (!cmds)
|
|
goto err;
|
|
|
|
do {
|
|
int len;
|
|
/* Get the command input flags */
|
|
if ((flags = ENGINE_ctrl(e, ENGINE_CTRL_GET_CMD_FLAGS, num,
|
|
NULL, NULL)) < 0)
|
|
goto err;
|
|
if (!(flags & ENGINE_CMD_FLAG_INTERNAL) || verbose >= 4) {
|
|
/* Get the command name */
|
|
if ((len = ENGINE_ctrl(e, ENGINE_CTRL_GET_NAME_LEN_FROM_CMD, num,
|
|
NULL, NULL)) <= 0)
|
|
goto err;
|
|
name = app_malloc(len + 1, "name buffer");
|
|
if (ENGINE_ctrl(e, ENGINE_CTRL_GET_NAME_FROM_CMD, num, name,
|
|
NULL) <= 0)
|
|
goto err;
|
|
/* Get the command description */
|
|
if ((len = ENGINE_ctrl(e, ENGINE_CTRL_GET_DESC_LEN_FROM_CMD, num,
|
|
NULL, NULL)) < 0)
|
|
goto err;
|
|
if (len > 0) {
|
|
desc = app_malloc(len + 1, "description buffer");
|
|
if (ENGINE_ctrl(e, ENGINE_CTRL_GET_DESC_FROM_CMD, num, desc,
|
|
NULL) <= 0)
|
|
goto err;
|
|
}
|
|
/* Now decide on the output */
|
|
if (xpos == 0)
|
|
/* Do an indent */
|
|
xpos = BIO_puts(out, indent);
|
|
else
|
|
/* Otherwise prepend a ", " */
|
|
xpos += BIO_printf(out, ", ");
|
|
if (verbose == 1) {
|
|
/*
|
|
* We're just listing names, comma-delimited
|
|
*/
|
|
if ((xpos > (int)strlen(indent)) &&
|
|
(xpos + (int)strlen(name) > line_wrap)) {
|
|
BIO_printf(out, "\n");
|
|
xpos = BIO_puts(out, indent);
|
|
}
|
|
xpos += BIO_printf(out, "%s", name);
|
|
} else {
|
|
/* We're listing names plus descriptions */
|
|
BIO_printf(out, "%s: %s\n", name,
|
|
(desc == NULL) ? "<no description>" : desc);
|
|
/* ... and sometimes input flags */
|
|
if ((verbose >= 3) && !util_flags(out, flags, indent))
|
|
goto err;
|
|
xpos = 0;
|
|
}
|
|
}
|
|
OPENSSL_free(name);
|
|
name = NULL;
|
|
OPENSSL_free(desc);
|
|
desc = NULL;
|
|
/* Move to the next command */
|
|
num = ENGINE_ctrl(e, ENGINE_CTRL_GET_NEXT_CMD_TYPE, num, NULL, NULL);
|
|
} while (num > 0);
|
|
if (xpos > 0)
|
|
BIO_printf(out, "\n");
|
|
ret = 1;
|
|
err:
|
|
sk_OPENSSL_STRING_pop_free(cmds, identity);
|
|
OPENSSL_free(name);
|
|
OPENSSL_free(desc);
|
|
return ret;
|
|
}
|
|
|
|
static void util_do_cmds(ENGINE *e, STACK_OF(OPENSSL_STRING) *cmds,
|
|
BIO *out, const char *indent)
|
|
{
|
|
int loop, res, num = sk_OPENSSL_STRING_num(cmds);
|
|
|
|
if (num < 0) {
|
|
BIO_printf(out, "[Error]: internal stack error\n");
|
|
return;
|
|
}
|
|
for (loop = 0; loop < num; loop++) {
|
|
char buf[256];
|
|
const char *cmd, *arg;
|
|
cmd = sk_OPENSSL_STRING_value(cmds, loop);
|
|
res = 1; /* assume success */
|
|
/* Check if this command has no ":arg" */
|
|
if ((arg = strstr(cmd, ":")) == NULL) {
|
|
if (!ENGINE_ctrl_cmd_string(e, cmd, NULL, 0))
|
|
res = 0;
|
|
} else {
|
|
if ((int)(arg - cmd) > 254) {
|
|
BIO_printf(out, "[Error]: command name too long\n");
|
|
return;
|
|
}
|
|
memcpy(buf, cmd, (int)(arg - cmd));
|
|
buf[arg - cmd] = '\0';
|
|
arg++; /* Move past the ":" */
|
|
/* Call the command with the argument */
|
|
if (!ENGINE_ctrl_cmd_string(e, buf, arg, 0))
|
|
res = 0;
|
|
}
|
|
if (res)
|
|
BIO_printf(out, "[Success]: %s\n", cmd);
|
|
else {
|
|
BIO_printf(out, "[Failure]: %s\n", cmd);
|
|
ERR_print_errors(out);
|
|
}
|
|
}
|
|
}
|
|
|
|
int engine_main(int argc, char **argv)
|
|
{
|
|
int ret = 1, i;
|
|
int verbose = 0, list_cap = 0, test_avail = 0, test_avail_noise = 0;
|
|
ENGINE *e;
|
|
STACK_OF(OPENSSL_STRING) *engines = sk_OPENSSL_STRING_new_null();
|
|
STACK_OF(OPENSSL_STRING) *pre_cmds = sk_OPENSSL_STRING_new_null();
|
|
STACK_OF(OPENSSL_STRING) *post_cmds = sk_OPENSSL_STRING_new_null();
|
|
BIO *out;
|
|
const char *indent = " ";
|
|
OPTION_CHOICE o;
|
|
char *prog;
|
|
char *argv1;
|
|
|
|
out = dup_bio_out(FORMAT_TEXT);
|
|
if (engines == NULL || pre_cmds == NULL || post_cmds == NULL)
|
|
goto end;
|
|
|
|
/* Remember the original command name, parse/skip any leading engine
|
|
* names, and then setup to parse the rest of the line as flags. */
|
|
prog = argv[0];
|
|
while ((argv1 = argv[1]) != NULL && *argv1 != '-') {
|
|
sk_OPENSSL_STRING_push(engines, argv1);
|
|
argc--;
|
|
argv++;
|
|
}
|
|
argv[0] = prog;
|
|
opt_init(argc, argv, engine_options);
|
|
|
|
while ((o = opt_next()) != OPT_EOF) {
|
|
switch (o) {
|
|
case OPT_EOF:
|
|
case OPT_ERR:
|
|
BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
|
|
goto end;
|
|
case OPT_HELP:
|
|
opt_help(engine_options);
|
|
ret = 0;
|
|
goto end;
|
|
case OPT_VVVV:
|
|
case OPT_VVV:
|
|
case OPT_VV:
|
|
case OPT_V:
|
|
/* Convert to an integer from one to four. */
|
|
i = (int)(o - OPT_V) + 1;
|
|
if (verbose < i)
|
|
verbose = i;
|
|
break;
|
|
case OPT_C:
|
|
list_cap = 1;
|
|
break;
|
|
case OPT_TT:
|
|
test_avail_noise++;
|
|
case OPT_T:
|
|
test_avail++;
|
|
break;
|
|
case OPT_PRE:
|
|
sk_OPENSSL_STRING_push(pre_cmds, opt_arg());
|
|
break;
|
|
case OPT_POST:
|
|
sk_OPENSSL_STRING_push(post_cmds, opt_arg());
|
|
break;
|
|
}
|
|
}
|
|
|
|
/* Allow any trailing parameters as engine names. */
|
|
argc = opt_num_rest();
|
|
argv = opt_rest();
|
|
for ( ; *argv; argv++) {
|
|
if (**argv == '-') {
|
|
BIO_printf(bio_err, "%s: Cannot mix flags and engine names.\n",
|
|
prog);
|
|
BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
|
|
goto end;
|
|
}
|
|
sk_OPENSSL_STRING_push(engines, *argv);
|
|
}
|
|
|
|
if (sk_OPENSSL_STRING_num(engines) == 0) {
|
|
for (e = ENGINE_get_first(); e != NULL; e = ENGINE_get_next(e)) {
|
|
sk_OPENSSL_STRING_push(engines, (char *)ENGINE_get_id(e));
|
|
}
|
|
}
|
|
|
|
for (i = 0; i < sk_OPENSSL_STRING_num(engines); i++) {
|
|
const char *id = sk_OPENSSL_STRING_value(engines, i);
|
|
if ((e = ENGINE_by_id(id)) != NULL) {
|
|
const char *name = ENGINE_get_name(e);
|
|
/*
|
|
* Do "id" first, then "name". Easier to auto-parse.
|
|
*/
|
|
BIO_printf(out, "(%s) %s\n", id, name);
|
|
util_do_cmds(e, pre_cmds, out, indent);
|
|
if (strcmp(ENGINE_get_id(e), id) != 0) {
|
|
BIO_printf(out, "Loaded: (%s) %s\n",
|
|
ENGINE_get_id(e), ENGINE_get_name(e));
|
|
}
|
|
if (list_cap) {
|
|
int cap_size = 256;
|
|
char *cap_buf = NULL;
|
|
int k, n;
|
|
const int *nids;
|
|
ENGINE_CIPHERS_PTR fn_c;
|
|
ENGINE_DIGESTS_PTR fn_d;
|
|
ENGINE_PKEY_METHS_PTR fn_pk;
|
|
|
|
if (ENGINE_get_RSA(e) != NULL
|
|
&& !append_buf(&cap_buf, &cap_size, "RSA"))
|
|
goto end;
|
|
if (ENGINE_get_DSA(e) != NULL
|
|
&& !append_buf(&cap_buf, &cap_size, "DSA"))
|
|
goto end;
|
|
if (ENGINE_get_DH(e) != NULL
|
|
&& !append_buf(&cap_buf, &cap_size, "DH"))
|
|
goto end;
|
|
if (ENGINE_get_RAND(e) != NULL
|
|
&& !append_buf(&cap_buf, &cap_size, "RAND"))
|
|
goto end;
|
|
|
|
fn_c = ENGINE_get_ciphers(e);
|
|
if (!fn_c)
|
|
goto skip_ciphers;
|
|
n = fn_c(e, NULL, &nids, 0);
|
|
for (k = 0; k < n; ++k)
|
|
if (!append_buf(&cap_buf, &cap_size, OBJ_nid2sn(nids[k])))
|
|
goto end;
|
|
|
|
skip_ciphers:
|
|
fn_d = ENGINE_get_digests(e);
|
|
if (!fn_d)
|
|
goto skip_digests;
|
|
n = fn_d(e, NULL, &nids, 0);
|
|
for (k = 0; k < n; ++k)
|
|
if (!append_buf(&cap_buf, &cap_size, OBJ_nid2sn(nids[k])))
|
|
goto end;
|
|
|
|
skip_digests:
|
|
fn_pk = ENGINE_get_pkey_meths(e);
|
|
if (!fn_pk)
|
|
goto skip_pmeths;
|
|
n = fn_pk(e, NULL, &nids, 0);
|
|
for (k = 0; k < n; ++k)
|
|
if (!append_buf(&cap_buf, &cap_size, OBJ_nid2sn(nids[k])))
|
|
goto end;
|
|
skip_pmeths:
|
|
if (cap_buf && (*cap_buf != '\0'))
|
|
BIO_printf(out, " [%s]\n", cap_buf);
|
|
|
|
OPENSSL_free(cap_buf);
|
|
}
|
|
if (test_avail) {
|
|
BIO_printf(out, "%s", indent);
|
|
if (ENGINE_init(e)) {
|
|
BIO_printf(out, "[ available ]\n");
|
|
util_do_cmds(e, post_cmds, out, indent);
|
|
ENGINE_finish(e);
|
|
} else {
|
|
BIO_printf(out, "[ unavailable ]\n");
|
|
if (test_avail_noise)
|
|
ERR_print_errors_fp(stdout);
|
|
ERR_clear_error();
|
|
}
|
|
}
|
|
if ((verbose > 0) && !util_verbose(e, verbose, out, indent))
|
|
goto end;
|
|
ENGINE_free(e);
|
|
} else
|
|
ERR_print_errors(bio_err);
|
|
}
|
|
|
|
ret = 0;
|
|
end:
|
|
|
|
ERR_print_errors(bio_err);
|
|
sk_OPENSSL_STRING_pop_free(engines, identity);
|
|
sk_OPENSSL_STRING_pop_free(pre_cmds, identity);
|
|
sk_OPENSSL_STRING_pop_free(post_cmds, identity);
|
|
BIO_free_all(out);
|
|
return (ret);
|
|
}
|
|
#else
|
|
|
|
# if PEDANTIC
|
|
static void *dummy = &dummy;
|
|
# endif
|
|
|
|
#endif
|