[thirdparty/openssl.git] / apps / engine.c

/*
 * Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.
 *
 * Licensed under the OpenSSL license (the "License").  You may not use
 * this file except in compliance with the License.  You can obtain a copy
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
 */

#include <openssl/opensslconf.h>
#ifdef OPENSSL_NO_ENGINE
NON_EMPTY_TRANSLATION_UNIT
#else

# include "apps.h"
# include "progs.h"
# include <stdio.h>
# include <stdlib.h>
# include <string.h>
# include <openssl/err.h>
# include <openssl/engine.h>
# include <openssl/ssl.h>
# include <openssl/store.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;

const 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 int append_buf(char **buf, int *size, const char *s)
{
    const int expand = 256;
    int len = strlen(s) + 1;
    char *p = *buf;

    if (p == NULL) {
        *size = ((len + expand - 1) / expand) * expand;
        p = *buf = app_malloc(*size, "engine buffer");
    } else {
        const int blen = strlen(p);

        if (blen > 0)
            len += 2 + blen;

        if (len > *size) {
            *size = ((len + expand - 1) / expand) * expand;
            p = OPENSSL_realloc(p, *size);
            if (p == NULL) {
                OPENSSL_free(*buf);
                *buf = NULL;
                return 0;
            }
            *buf = p;
        }

        if (blen > 0) {
            p += blen;
            *p++ = ',';
            *p++ = ' ';
        }
    }

    strcpy(p, s);
    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 == NULL)
        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_free(cmds);
    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);
        }
    }
}

struct util_store_cap_data {
    ENGINE *engine;
    char **cap_buf;
    int *cap_size;
    int ok;
};
static void util_store_cap(const OSSL_STORE_LOADER *loader, void *arg)
{
    struct util_store_cap_data *ctx = arg;

    if (OSSL_STORE_LOADER_get0_engine(loader) == ctx->engine) {
        char buf[256];
        BIO_snprintf(buf, sizeof(buf), "STORE(%s)",
                     OSSL_STORE_LOADER_get0_scheme(loader));
        if (!append_buf(ctx->cap_buf, ctx->cap_size, buf))
            ctx->ok = 0;
    }
}

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_CSTRING) *engines = sk_OPENSSL_CSTRING_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_CSTRING_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++;
            /* fall thru */
        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_CSTRING_push(engines, *argv);
    }

    if (sk_OPENSSL_CSTRING_num(engines) == 0) {
        for (e = ENGINE_get_first(); e != NULL; e = ENGINE_get_next(e)) {
            sk_OPENSSL_CSTRING_push(engines, ENGINE_get_id(e));
        }
    }

    ret = 0;
    for (i = 0; i < sk_OPENSSL_CSTRING_num(engines); i++) {
        const char *id = sk_OPENSSL_CSTRING_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 == NULL)
                    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 == NULL)
                    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 == NULL)
                    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:
                {
                    struct util_store_cap_data store_ctx;

                    store_ctx.engine = e;
                    store_ctx.cap_buf = &cap_buf;
                    store_ctx.cap_size = &cap_size;
                    store_ctx.ok = 1;

                    OSSL_STORE_do_all_loaders(util_store_cap, &store_ctx);
                    if (!store_ctx.ok)
                        goto end;
                }
                if (cap_buf != NULL && (*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);
            /* because exit codes above 127 have special meaning on Unix */
            if (++ret > 127)
                ret = 127;
        }
    }

 end:

    ERR_print_errors(bio_err);
    sk_OPENSSL_CSTRING_free(engines);
    sk_OPENSSL_STRING_free(pre_cmds);
    sk_OPENSSL_STRING_free(post_cmds);
    BIO_free_all(out);
    return ret;
}
#endif
Commit	Line	Data
0f113f3e	1	/*
6738bf14	2	* Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.
14c6d27d	3	*
846e33c7 RS	4	* Licensed under the OpenSSL license (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
14c6d27d RL	8	*/
14c6d27d RL	9
effaf4de RS	10	#include <openssl/opensslconf.h>
	11	#ifdef OPENSSL_NO_ENGINE
	12	NON_EMPTY_TRANSLATION_UNIT
	13	#else
	14
	15	# include "apps.h"
dab2cd68	16	# include "progs.h"
effaf4de RS	17	# include <stdio.h>
	18	# include <stdlib.h>
	19	# include <string.h>
	20	# include <openssl/err.h>
0f113f3e MC	21	# include <openssl/engine.h>
0f113f3e MC	22	# include <openssl/ssl.h>
fa66949c	23	# include <openssl/store.h>
0f113f3e	24
7e1b7485 RS	25	typedef enum OPTION_choice {
	26	OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
	27	OPT_C, OPT_T, OPT_TT, OPT_PRE, OPT_POST,
	28	OPT_V = 100, OPT_VV, OPT_VVV, OPT_VVVV
	29	} OPTION_CHOICE;
	30
44c83ebd	31	const OPTIONS engine_options[] = {
0d1e003f RS	32	{OPT_HELP_STR, 1, '-', "Usage: %s [options] engine...\n"},
	33	{OPT_HELP_STR, 1, '-',
	34	" engine... Engines to load\n"},
7e1b7485	35	{"help", OPT_HELP, '-', "Display this summary"},
0d1e003f	36	{"v", OPT_V, '-', "List 'control commands' For each specified engine"},
7e1b7485	37	{"vv", OPT_VV, '-', "Also display each command's description"},
0d1e003f RS	38	{"vvv", OPT_VVV, '-', "Also add the input flags for each command"},
	39	{"vvvv", OPT_VVVV, '-', "Also show internal input flags"},
	40	{"c", OPT_C, '-', "List the capabilities of specified engine"},
	41	{"t", OPT_T, '-', "Check that specified engine is available"},
7e1b7485 RS	42	{"tt", OPT_TT, '-', "Display error trace for unavailable engines"},
	43	{"pre", OPT_PRE, 's', "Run command against the ENGINE before loading it"},
	44	{"post", OPT_POST, 's', "Run command against the ENGINE after loading it"},
	45	{OPT_MORE_STR, OPT_EOF, 1,
	46	"Commands are like \"SO_PATH:/lib/libdriver.so\""},
	47	{NULL}
14c6d27d RL	48	};
14c6d27d RL	49
0d1e003f	50	static int append_buf(char *buf, int size, const char *s)
0f113f3e	51	{
b2ac85ad P	52	const int expand = 256;
	53	int len = strlen(s) + 1;
	54	char p = buf;
	55
	56	if (p == NULL) {
	57	size = ((len + expand - 1) / expand) expand;
	58	p = buf = app_malloc(size, "engine buffer");
	59	} else {
	60	const int blen = strlen(p);
	61
	62	if (blen > 0)
	63	len += 2 + blen;
69e7805f	64
b2ac85ad P	65	if (len > *size) {
	66	size = ((len + expand - 1) / expand) expand;
	67	p = OPENSSL_realloc(p, *size);
	68	if (p == NULL) {
	69	OPENSSL_free(*buf);
	70	*buf = NULL;
	71	return 0;
	72	}
	73	*buf = p;
7c0ef843	74	}
69e7805f	75
b2ac85ad P	76	if (blen > 0) {
	77	p += blen;
	78	*p++ = ',';
	79	*p++ = ' ';
	80	}
	81	}
69e7805f	82
b2ac85ad	83	strcpy(p, s);
0f113f3e MC	84	return 1;
0f113f3e MC	85	}
69e7805f	86
7e1b7485	87	static int util_flags(BIO out, unsigned int flags, const char indent)
0f113f3e MC	88	{
	89	int started = 0, err = 0;
	90	/* Indent before displaying input flags */
7e1b7485	91	BIO_printf(out, "%s%s(input flags): ", indent, indent);
0f113f3e	92	if (flags == 0) {
7e1b7485	93	BIO_printf(out, "<no flags>\n");
0f113f3e MC	94	return 1;
	95	}
	96	/*
	97	* If the object is internal, mark it in a way that shows instead of
	98	* having it part of all the other flags, even if it really is.
	99	*/
	100	if (flags & ENGINE_CMD_FLAG_INTERNAL) {
7e1b7485	101	BIO_printf(out, "[Internal] ");
0f113f3e MC	102	}
	103
	104	if (flags & ENGINE_CMD_FLAG_NUMERIC) {
7e1b7485	105	BIO_printf(out, "NUMERIC");
0f113f3e MC	106	started = 1;
	107	}
	108	/*
	109	* Now we check that no combinations of the mutually exclusive NUMERIC,
	110	* STRING, and NO_INPUT flags have been used. Future flags that can be
	111	* OR'd together with these would need to added after these to preserve
	112	* the testing logic.
	113	*/
	114	if (flags & ENGINE_CMD_FLAG_STRING) {
	115	if (started) {
7e1b7485	116	BIO_printf(out, "\|");
0f113f3e MC	117	err = 1;
0f113f3e MC	118	}
7e1b7485	119	BIO_printf(out, "STRING");
0f113f3e MC	120	started = 1;
	121	}
	122	if (flags & ENGINE_CMD_FLAG_NO_INPUT) {
	123	if (started) {
7e1b7485	124	BIO_printf(out, "\|");
0f113f3e MC	125	err = 1;
0f113f3e MC	126	}
7e1b7485	127	BIO_printf(out, "NO_INPUT");
0f113f3e MC	128	started = 1;
	129	}
	130	/* Check for unknown flags */
	131	flags = flags & ~ENGINE_CMD_FLAG_NUMERIC &
	132	~ENGINE_CMD_FLAG_STRING &
	133	~ENGINE_CMD_FLAG_NO_INPUT & ~ENGINE_CMD_FLAG_INTERNAL;
	134	if (flags) {
	135	if (started)
7e1b7485 RS	136	BIO_printf(out, "\|");
7e1b7485 RS	137	BIO_printf(out, "<0x%04X>", flags);
0f113f3e MC	138	}
0f113f3e MC	139	if (err)
7e1b7485 RS	140	BIO_printf(out, " <illegal flags!>");
7e1b7485 RS	141	BIO_printf(out, "\n");
0f113f3e MC	142	return 1;
	143	}
	144
7e1b7485	145	static int util_verbose(ENGINE e, int verbose, BIO out, const char *indent)
0f113f3e MC	146	{
	147	static const int line_wrap = 78;
	148	int num;
	149	int ret = 0;
	150	char *name = NULL;
	151	char *desc = NULL;
	152	int flags;
	153	int xpos = 0;
	154	STACK_OF(OPENSSL_STRING) *cmds = NULL;
	155	if (!ENGINE_ctrl(e, ENGINE_CTRL_HAS_CTRL_FUNCTION, 0, NULL, NULL) \|\|
	156	((num = ENGINE_ctrl(e, ENGINE_CTRL_GET_FIRST_CMD_TYPE,
	157	0, NULL, NULL)) <= 0)) {
0f113f3e MC	158	return 1;
	159	}
	160
	161	cmds = sk_OPENSSL_STRING_new_null();
2234212c	162	if (cmds == NULL)
0f113f3e	163	goto err;
7e1b7485	164
0f113f3e MC	165	do {
	166	int len;
	167	/* Get the command input flags */
	168	if ((flags = ENGINE_ctrl(e, ENGINE_CTRL_GET_CMD_FLAGS, num,
	169	NULL, NULL)) < 0)
	170	goto err;
	171	if (!(flags & ENGINE_CMD_FLAG_INTERNAL) \|\| verbose >= 4) {
	172	/* Get the command name */
	173	if ((len = ENGINE_ctrl(e, ENGINE_CTRL_GET_NAME_LEN_FROM_CMD, num,
	174	NULL, NULL)) <= 0)
	175	goto err;
68dc6824	176	name = app_malloc(len + 1, "name buffer");
0f113f3e MC	177	if (ENGINE_ctrl(e, ENGINE_CTRL_GET_NAME_FROM_CMD, num, name,
	178	NULL) <= 0)
	179	goto err;
	180	/* Get the command description */
	181	if ((len = ENGINE_ctrl(e, ENGINE_CTRL_GET_DESC_LEN_FROM_CMD, num,
	182	NULL, NULL)) < 0)
	183	goto err;
	184	if (len > 0) {
68dc6824	185	desc = app_malloc(len + 1, "description buffer");
0f113f3e	186	if (ENGINE_ctrl(e, ENGINE_CTRL_GET_DESC_FROM_CMD, num, desc,
2cd3ad9b	187	NULL) <= 0)
0f113f3e MC	188	goto err;
	189	}
	190	/* Now decide on the output */
	191	if (xpos == 0)
	192	/* Do an indent */
7e1b7485	193	xpos = BIO_puts(out, indent);
0f113f3e MC	194	else
0f113f3e MC	195	/* Otherwise prepend a ", " */
7e1b7485	196	xpos += BIO_printf(out, ", ");
0f113f3e MC	197	if (verbose == 1) {
	198	/*
	199	* We're just listing names, comma-delimited
	200	*/
	201	if ((xpos > (int)strlen(indent)) &&
	202	(xpos + (int)strlen(name) > line_wrap)) {
7e1b7485 RS	203	BIO_printf(out, "\n");
7e1b7485 RS	204	xpos = BIO_puts(out, indent);
0f113f3e	205	}
7e1b7485	206	xpos += BIO_printf(out, "%s", name);
0f113f3e MC	207	} else {
0f113f3e MC	208	/* We're listing names plus descriptions */
7e1b7485	209	BIO_printf(out, "%s: %s\n", name,
0f113f3e MC	210	(desc == NULL) ? "<no description>" : desc);
0f113f3e MC	211	/* ... and sometimes input flags */
7e1b7485	212	if ((verbose >= 3) && !util_flags(out, flags, indent))
0f113f3e MC	213	goto err;
	214	xpos = 0;
	215	}
	216	}
	217	OPENSSL_free(name);
	218	name = NULL;
b548a1f1 RS	219	OPENSSL_free(desc);
b548a1f1 RS	220	desc = NULL;
0f113f3e MC	221	/* Move to the next command */
	222	num = ENGINE_ctrl(e, ENGINE_CTRL_GET_NEXT_CMD_TYPE, num, NULL, NULL);
	223	} while (num > 0);
	224	if (xpos > 0)
7e1b7485	225	BIO_printf(out, "\n");
0f113f3e MC	226	ret = 1;
0f113f3e MC	227	err:
1dcb8ca2	228	sk_OPENSSL_STRING_free(cmds);
b548a1f1 RS	229	OPENSSL_free(name);
b548a1f1 RS	230	OPENSSL_free(desc);
0f113f3e MC	231	return ret;
0f113f3e MC	232	}
f11bc840	233
c869da88	234	static void util_do_cmds(ENGINE e, STACK_OF(OPENSSL_STRING) cmds,
7e1b7485	235	BIO out, const char indent)
0f113f3e MC	236	{
	237	int loop, res, num = sk_OPENSSL_STRING_num(cmds);
	238
	239	if (num < 0) {
7e1b7485	240	BIO_printf(out, "[Error]: internal stack error\n");
0f113f3e MC	241	return;
	242	}
	243	for (loop = 0; loop < num; loop++) {
	244	char buf[256];
	245	const char cmd, arg;
	246	cmd = sk_OPENSSL_STRING_value(cmds, loop);
	247	res = 1; /* assume success */
	248	/* Check if this command has no ":arg" */
	249	if ((arg = strstr(cmd, ":")) == NULL) {
	250	if (!ENGINE_ctrl_cmd_string(e, cmd, NULL, 0))
	251	res = 0;
	252	} else {
	253	if ((int)(arg - cmd) > 254) {
7e1b7485	254	BIO_printf(out, "[Error]: command name too long\n");
0f113f3e MC	255	return;
	256	}
	257	memcpy(buf, cmd, (int)(arg - cmd));
	258	buf[arg - cmd] = '\0';
	259	arg++; /* Move past the ":" */
	260	/* Call the command with the argument */
	261	if (!ENGINE_ctrl_cmd_string(e, buf, arg, 0))
	262	res = 0;
	263	}
2234212c	264	if (res) {
7e1b7485	265	BIO_printf(out, "[Success]: %s\n", cmd);
2234212c	266	} else {
7e1b7485 RS	267	BIO_printf(out, "[Failure]: %s\n", cmd);
7e1b7485 RS	268	ERR_print_errors(out);
0f113f3e MC	269	}
	270	}
	271	}
f11bc840	272
fa66949c RL	273	struct util_store_cap_data {
	274	ENGINE *engine;
	275	char **cap_buf;
	276	int *cap_size;
	277	int ok;
	278	};
	279	static void util_store_cap(const OSSL_STORE_LOADER loader, void arg)
	280	{
	281	struct util_store_cap_data *ctx = arg;
	282
	283	if (OSSL_STORE_LOADER_get0_engine(loader) == ctx->engine) {
	284	char buf[256];
	285	BIO_snprintf(buf, sizeof(buf), "STORE(%s)",
	286	OSSL_STORE_LOADER_get0_scheme(loader));
	287	if (!append_buf(ctx->cap_buf, ctx->cap_size, buf))
	288	ctx->ok = 0;
	289	}
	290	}
	291
7e1b7485	292	int engine_main(int argc, char **argv)
0f113f3e MC	293	{
0f113f3e MC	294	int ret = 1, i;
0f113f3e MC	295	int verbose = 0, list_cap = 0, test_avail = 0, test_avail_noise = 0;
0f113f3e MC	296	ENGINE *e;
1dcb8ca2	297	STACK_OF(OPENSSL_CSTRING) *engines = sk_OPENSSL_CSTRING_new_null();
0f113f3e MC	298	STACK_OF(OPENSSL_STRING) *pre_cmds = sk_OPENSSL_STRING_new_null();
0f113f3e MC	299	STACK_OF(OPENSSL_STRING) *post_cmds = sk_OPENSSL_STRING_new_null();
7e1b7485	300	BIO *out;
0f113f3e	301	const char *indent = " ";
7e1b7485 RS	302	OPTION_CHOICE o;
7e1b7485 RS	303	char *prog;
0d1e003f	304	char *argv1;
0f113f3e	305
a60994df	306	out = dup_bio_out(FORMAT_TEXT);
0d1e003f	307	if (engines == NULL \|\| pre_cmds == NULL \|\| post_cmds == NULL)
0f113f3e	308	goto end;
0d1e003f RS	309
	310	/* Remember the original command name, parse/skip any leading engine
	311	* names, and then setup to parse the rest of the line as flags. */
	312	prog = argv[0];
	313	while ((argv1 = argv[1]) != NULL && *argv1 != '-') {
1dcb8ca2	314	sk_OPENSSL_CSTRING_push(engines, argv1);
0d1e003f RS	315	argc--;
	316	argv++;
	317	}
	318	argv[0] = prog;
	319	opt_init(argc, argv, engine_options);
	320
7e1b7485 RS	321	while ((o = opt_next()) != OPT_EOF) {
	322	switch (o) {
	323	case OPT_EOF:
	324	case OPT_ERR:
	325	BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
	326	goto end;
	327	case OPT_HELP:
	328	opt_help(engine_options);
	329	ret = 0;
	330	goto end;
	331	case OPT_VVVV:
	332	case OPT_VVV:
	333	case OPT_VV:
	334	case OPT_V:
	335	/* Convert to an integer from one to four. */
	336	i = (int)(o - OPT_V) + 1;
	337	if (verbose < i)
	338	verbose = i;
	339	break;
	340	case OPT_C:
0f113f3e	341	list_cap = 1;
7e1b7485 RS	342	break;
	343	case OPT_TT:
	344	test_avail_noise++;
018fcbec	345	/* fall thru */
7e1b7485 RS	346	case OPT_T:
	347	test_avail++;
	348	break;
	349	case OPT_PRE:
	350	sk_OPENSSL_STRING_push(pre_cmds, opt_arg());
	351	break;
	352	case OPT_POST:
	353	sk_OPENSSL_STRING_push(post_cmds, opt_arg());
	354	break;
	355	}
0f113f3e	356	}
0d1e003f RS	357
0d1e003f RS	358	/* Allow any trailing parameters as engine names. */
7e1b7485 RS	359	argc = opt_num_rest();
7e1b7485 RS	360	argv = opt_rest();
0d1e003f RS	361	for ( ; *argv; argv++) {
	362	if (**argv == '-') {
	363	BIO_printf(bio_err, "%s: Cannot mix flags and engine names.\n",
	364	prog);
	365	BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
	366	goto end;
	367	}
1dcb8ca2	368	sk_OPENSSL_CSTRING_push(engines, *argv);
0d1e003f	369	}
0f113f3e	370
1dcb8ca2	371	if (sk_OPENSSL_CSTRING_num(engines) == 0) {
0f113f3e	372	for (e = ENGINE_get_first(); e != NULL; e = ENGINE_get_next(e)) {
1dcb8ca2	373	sk_OPENSSL_CSTRING_push(engines, ENGINE_get_id(e));
0f113f3e MC	374	}
	375	}
	376
9e64457d	377	ret = 0;
1dcb8ca2 MC	378	for (i = 0; i < sk_OPENSSL_CSTRING_num(engines); i++) {
1dcb8ca2 MC	379	const char *id = sk_OPENSSL_CSTRING_value(engines, i);
0f113f3e MC	380	if ((e = ENGINE_by_id(id)) != NULL) {
	381	const char *name = ENGINE_get_name(e);
	382	/*
	383	* Do "id" first, then "name". Easier to auto-parse.
	384	*/
7e1b7485 RS	385	BIO_printf(out, "(%s) %s\n", id, name);
7e1b7485 RS	386	util_do_cmds(e, pre_cmds, out, indent);
0f113f3e	387	if (strcmp(ENGINE_get_id(e), id) != 0) {
7e1b7485	388	BIO_printf(out, "Loaded: (%s) %s\n",
0f113f3e MC	389	ENGINE_get_id(e), ENGINE_get_name(e));
	390	}
	391	if (list_cap) {
	392	int cap_size = 256;
	393	char *cap_buf = NULL;
	394	int k, n;
	395	const int *nids;
	396	ENGINE_CIPHERS_PTR fn_c;
	397	ENGINE_DIGESTS_PTR fn_d;
	398	ENGINE_PKEY_METHS_PTR fn_pk;
	399
	400	if (ENGINE_get_RSA(e) != NULL
0d1e003f	401	&& !append_buf(&cap_buf, &cap_size, "RSA"))
0f113f3e MC	402	goto end;
0f113f3e MC	403	if (ENGINE_get_DSA(e) != NULL
0d1e003f	404	&& !append_buf(&cap_buf, &cap_size, "DSA"))
0f113f3e MC	405	goto end;
0f113f3e MC	406	if (ENGINE_get_DH(e) != NULL
0d1e003f	407	&& !append_buf(&cap_buf, &cap_size, "DH"))
0f113f3e MC	408	goto end;
0f113f3e MC	409	if (ENGINE_get_RAND(e) != NULL
0d1e003f	410	&& !append_buf(&cap_buf, &cap_size, "RAND"))
0f113f3e MC	411	goto end;
	412
	413	fn_c = ENGINE_get_ciphers(e);
2234212c	414	if (fn_c == NULL)
0f113f3e MC	415	goto skip_ciphers;
	416	n = fn_c(e, NULL, &nids, 0);
	417	for (k = 0; k < n; ++k)
0d1e003f	418	if (!append_buf(&cap_buf, &cap_size, OBJ_nid2sn(nids[k])))
0f113f3e MC	419	goto end;
	420
	421	skip_ciphers:
	422	fn_d = ENGINE_get_digests(e);
2234212c	423	if (fn_d == NULL)
0f113f3e MC	424	goto skip_digests;
	425	n = fn_d(e, NULL, &nids, 0);
	426	for (k = 0; k < n; ++k)
0d1e003f	427	if (!append_buf(&cap_buf, &cap_size, OBJ_nid2sn(nids[k])))
0f113f3e MC	428	goto end;
	429
	430	skip_digests:
	431	fn_pk = ENGINE_get_pkey_meths(e);
2234212c	432	if (fn_pk == NULL)
0f113f3e MC	433	goto skip_pmeths;
	434	n = fn_pk(e, NULL, &nids, 0);
	435	for (k = 0; k < n; ++k)
0d1e003f	436	if (!append_buf(&cap_buf, &cap_size, OBJ_nid2sn(nids[k])))
0f113f3e MC	437	goto end;
0f113f3e MC	438	skip_pmeths:
fa66949c RL	439	{
	440	struct util_store_cap_data store_ctx;
	441
	442	store_ctx.engine = e;
	443	store_ctx.cap_buf = &cap_buf;
	444	store_ctx.cap_size = &cap_size;
	445	store_ctx.ok = 1;
	446
	447	OSSL_STORE_do_all_loaders(util_store_cap, &store_ctx);
	448	if (!store_ctx.ok)
	449	goto end;
	450	}
2234212c	451	if (cap_buf != NULL && (*cap_buf != '\0'))
7e1b7485	452	BIO_printf(out, " [%s]\n", cap_buf);
0f113f3e MC	453
	454	OPENSSL_free(cap_buf);
	455	}
	456	if (test_avail) {
7e1b7485	457	BIO_printf(out, "%s", indent);
0f113f3e	458	if (ENGINE_init(e)) {
7e1b7485 RS	459	BIO_printf(out, "[ available ]\n");
7e1b7485 RS	460	util_do_cmds(e, post_cmds, out, indent);
0f113f3e MC	461	ENGINE_finish(e);
0f113f3e MC	462	} else {
7e1b7485	463	BIO_printf(out, "[ unavailable ]\n");
0f113f3e MC	464	if (test_avail_noise)
	465	ERR_print_errors_fp(stdout);
	466	ERR_clear_error();
	467	}
	468	}
7e1b7485	469	if ((verbose > 0) && !util_verbose(e, verbose, out, indent))
0f113f3e MC	470	goto end;
0f113f3e MC	471	ENGINE_free(e);
9e64457d	472	} else {
0f113f3e	473	ERR_print_errors(bio_err);
9e64457d RL	474	/* because exit codes above 127 have special meaning on Unix */
	475	if (++ret > 127)
	476	ret = 127;
	477	}
0f113f3e MC	478	}
0f113f3e MC	479
0f113f3e MC	480	end:
	481
	482	ERR_print_errors(bio_err);
1dcb8ca2 MC	483	sk_OPENSSL_CSTRING_free(engines);
	484	sk_OPENSSL_STRING_free(pre_cmds);
	485	sk_OPENSSL_STRING_free(post_cmds);
7e1b7485	486	BIO_free_all(out);
26a7d938	487	return ret;
0f113f3e	488	}
0b13e9f0	489	#endif