Unify s_client/s_server srtp profiles option handling
[openssl.git] / apps / engine.c
index 3b3464a..83f9588 100644 (file)
-/* apps/engine.c -*- mode: C; c-file-style: "eay" -*- */
-/* 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).
+/*
+ * 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
  */
 
-#ifndef OPENSSL_NO_ENGINE
-
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
-#ifdef OPENSSL_NO_STDIO
-#define APPS_WIN16
-#endif
-#include "apps.h"
-#include <openssl/err.h>
-#include <openssl/engine.h>
-#include <openssl/ssl.h>
-
-#undef PROG
-#define PROG   engine_main
-
-static char *engine_usage[]={
-"usage: engine opts [engine ...]\n",
-" -v[v[v[v]]] - verbose mode, for each engine, list its 'control commands'\n",
-"               -vv will additionally display each command's description\n",
-"               -vvv will also add the input flags for each command\n",
-"               -vvvv will also show internal input flags\n",
-" -c          - for each engine, also list the capabilities\n",
-" -t[t]       - for each engine, check that they are really available\n",
-"               -tt will display error trace for unavailable engines\n",
-" -pre <cmd>  - runs command 'cmd' against the ENGINE before any attempts\n",
-"               to load it (if -t is used)\n",
-" -post <cmd> - runs command 'cmd' against the ENGINE after loading it\n",
-"               (only used if -t is also provided)\n",
-" NB: -pre and -post will be applied to all ENGINEs supplied on the command\n",
-" line, or all supported ENGINEs if none are specified.\n",
-" Eg. '-pre \"SO_PATH:/lib/libdriver.so\"' calls command \"SO_PATH\" with\n",
-" argument \"/lib/libdriver.so\".\n",
-NULL
+#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 void identity(void *ptr)
-       {
-       return;
-       }
-
-static int append_buf(char **buf, const char *s, int *size, int step)
-       {
-       int l = strlen(s);
-
-       if (*buf == NULL)
-               {
-               *size = step;
-               *buf = OPENSSL_malloc(*size);
-               if (*buf == NULL)
-                       return 0;
-               **buf = '\0';
-               }
-
-       if (**buf != '\0')
-               l += 2;         /* ", " */
-
-       if (strlen(*buf) + strlen(s) >= (unsigned int)*size)
-               {
-               *size += step;
-               *buf = OPENSSL_realloc(*buf, *size);
-               }
-
-       if (*buf == NULL)
-               return 0;
-
-       if (**buf != '\0')
-               strcat(*buf, ", ");
-       strcat(*buf, s);
-
-       return 1;
-       }
-
-static int util_flags(BIO *bio_out, unsigned int flags, const char *indent)
-       {
-       int started = 0, err = 0;
-       /* Indent before displaying input flags */
-       BIO_printf(bio_out, "%s%s(input flags): ", indent, indent);
-       if(flags == 0)
-               {
-               BIO_printf(bio_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(bio_out, "[Internal] ");
-               }
-
-       if(flags & ENGINE_CMD_FLAG_NUMERIC)
-               {
-               if(started)
-                       {
-                       BIO_printf(bio_out, "|");
-                       err = 1;
-                       }
-               BIO_printf(bio_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(bio_out, "|");
-                       err = 1;
-                       }
-               BIO_printf(bio_out, "STRING");
-               started = 1;
-               }
-       if(flags & ENGINE_CMD_FLAG_NO_INPUT)
-               {
-               if(started)
-                       {
-                       BIO_printf(bio_out, "|");
-                       err = 1;
-                       }
-               BIO_printf(bio_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(bio_out, "|");
-               BIO_printf(bio_out, "<0x%04X>", flags);
-               }
-       if(err)
-               BIO_printf(bio_out, "  <illegal flags!>");
-       BIO_printf(bio_out, "\n");
-       return 1;
-       }
-
-static int util_verbose(ENGINE *e, int verbose, BIO *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 *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))
-               {
-#if 0
-               BIO_printf(bio_out, "%s<no control commands>\n", indent);
-#endif
-               return 1;
-               }
-
-       cmds = sk_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;
-                        if((name = OPENSSL_malloc(len + 1)) == NULL)
-                                goto err;
-                        if(ENGINE_ctrl(e, ENGINE_CTRL_GET_NAME_FROM_CMD, num, name,
+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;
-                        /* 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)
-                                {
-                                if((desc = OPENSSL_malloc(len + 1)) == NULL)
-                                        goto err;
-                                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_printf(bio_out, indent);
-                        else
-                                /* Otherwise prepend a ", " */
-                                xpos += BIO_printf(bio_out, ", ");
-                        if(verbose == 1)
-                                {
-                                /* We're just listing names, comma-delimited */
-                                if((xpos > (int)strlen(indent)) &&
-                                       (xpos + (int)strlen(name) > line_wrap))
-                                        {
-                                        BIO_printf(bio_out, "\n");
-                                        xpos = BIO_printf(bio_out, indent);
-                                        }
-                                xpos += BIO_printf(bio_out, "%s", name);
-                                }
-                        else
-                                {
-                                /* We're listing names plus descriptions */
-                                BIO_printf(bio_out, "%s: %s\n", name,
-                                        (desc == NULL) ? "<no description>" : desc);
-                                /* ... and sometimes input flags */
-                                if((verbose >= 3) && !util_flags(bio_out, flags,
-                                        indent))
-                                        goto err;
-                                xpos = 0;
-                                }
-                        }
-               OPENSSL_free(name); name = NULL;
-               if(desc) { 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(bio_out, "\n");
-       ret = 1;
-err:
-       if(cmds) sk_pop_free(cmds, identity);
-       if(name) OPENSSL_free(name);
-       if(desc) OPENSSL_free(desc);
-       return ret;
-       }
-
-static void util_do_cmds(ENGINE *e, STACK *cmds, BIO *bio_out, const char *indent)
-       {
-       int loop, res, num = sk_num(cmds);
-       if(num < 0)
-               {
-               BIO_printf(bio_out, "[Error]: internal stack error\n");
-               return;
-               }
-       for(loop = 0; loop < num; loop++)
-               {
-               char buf[256];
-               const char *cmd, *arg;
-               cmd = sk_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(bio_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(bio_out, "[Success]: %s\n", cmd);
-               else
-                       {
-                       BIO_printf(bio_out, "[Failure]: %s\n", cmd);
-                       ERR_print_errors(bio_out);
-                       }
-               }
-       }
-
-int MAIN(int, char **);
-
-int MAIN(int argc, char **argv)
-       {
-       int ret=1,i;
-       char **pp;
-       int verbose=0, list_cap=0, test_avail=0, test_avail_noise = 0;
-       ENGINE *e;
-       STACK *engines = sk_new_null();
-       STACK *pre_cmds = sk_new_null();
-       STACK *post_cmds = sk_new_null();
-       int badops=1;
-       BIO *bio_out=NULL;
-       const char *indent = "     ";
-
-       apps_startup();
-       SSL_load_error_strings();
-
-       if (bio_err == NULL)
-               bio_err=BIO_new_fp(stderr,BIO_NOCLOSE);
-
-       if (!load_config(bio_err, NULL))
-               goto end;
-       bio_out=BIO_new_fp(stdout,BIO_NOCLOSE);
-#ifdef OPENSSL_SYS_VMS
-       {
-       BIO *tmpbio = BIO_new(BIO_f_linebuffer());
-       bio_out = BIO_push(tmpbio, bio_out);
-       }
-#endif
-
-       argc--;
-       argv++;
-       while (argc >= 1)
-               {
-               if (strncmp(*argv,"-v",2) == 0)
-                       {
-                       if(strspn(*argv + 1, "v") < strlen(*argv + 1))
-                               goto skip_arg_loop;
-                       if((verbose=strlen(*argv + 1)) > 4)
-                               goto skip_arg_loop;
-                       }
-               else if (strcmp(*argv,"-c") == 0)
-                       list_cap=1;
-               else if (strncmp(*argv,"-t",2) == 0)
-                       {
-                       test_avail=1;
-                       if(strspn(*argv + 1, "t") < strlen(*argv + 1))
-                               goto skip_arg_loop;
-                       if((test_avail_noise = strlen(*argv + 1) - 1) > 1)
-                               goto skip_arg_loop;
-                       }
-               else if (strcmp(*argv,"-pre") == 0)
-                       {
-                       argc--; argv++;
-                       sk_push(pre_cmds,*argv);
-                       }
-               else if (strcmp(*argv,"-post") == 0)
-                       {
-                       argc--; argv++;
-                       sk_push(post_cmds,*argv);
-                       }
-               else if ((strncmp(*argv,"-h",2) == 0) ||
-                               (strcmp(*argv,"-?") == 0))
-                       goto skip_arg_loop;
-               else
-                       sk_push(engines,*argv);
-               argc--;
-               argv++;
-               }
-       /* Looks like everything went OK */
-       badops = 0;
-skip_arg_loop:
-
-       if (badops)
-               {
-               for (pp=engine_usage; (*pp != NULL); pp++)
-                       BIO_printf(bio_err,"%s",*pp);
-               goto end;
-               }
-
-       if (sk_num(engines) == 0)
-               {
-               for(e = ENGINE_get_first(); e != NULL; e = ENGINE_get_next(e))
-                       {
-                       sk_push(engines,(char *)ENGINE_get_id(e));
-                       }
-               }
-
-       for (i=0; i<sk_num(engines); i++)
-               {
-               const char *id = sk_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(bio_out, "(%s) %s\n", id, name);
-                       util_do_cmds(e, pre_cmds, bio_out, indent);
-                       if (strcmp(ENGINE_get_id(e), id) != 0)
-                               {
-                               BIO_printf(bio_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;
-
-                               if (ENGINE_get_RSA(e) != NULL
-                                       && !append_buf(&cap_buf, "RSA",
-                                               &cap_size, 256))
-                                       goto end;
-                               if (ENGINE_get_DSA(e) != NULL
-                                       && !append_buf(&cap_buf, "DSA",
-                                               &cap_size, 256))
-                                       goto end;
-                               if (ENGINE_get_DH(e) != NULL
-                                       && !append_buf(&cap_buf, "DH",
-                                               &cap_size, 256))
-                                       goto end;
-                               if (ENGINE_get_RAND(e) != NULL
-                                       && !append_buf(&cap_buf, "RAND",
-                                               &cap_size, 256))
-                                       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,
-                                                      OBJ_nid2sn(nids[k]),
-                                                      &cap_size, 256))
-                                               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,
-                                                      OBJ_nid2sn(nids[k]),
-                                                      &cap_size, 256))
-                                               goto end;
-
-skip_digests:
-                               if (cap_buf && (*cap_buf != '\0'))
-                                       BIO_printf(bio_out, " [%s]\n", cap_buf);
-
-                               OPENSSL_free(cap_buf);
-                               }
-                       if(test_avail)
-                               {
-                               BIO_printf(bio_out, "%s", indent);
-                               if (ENGINE_init(e))
-                                       {
-                                       BIO_printf(bio_out, "[ available ]\n");
-                                       util_do_cmds(e, post_cmds, bio_out, indent);
-                                       ENGINE_finish(e);
-                                       }
-                               else
-                                       {
-                                       BIO_printf(bio_out, "[ unavailable ]\n");
-                                       if(test_avail_noise)
-                                               ERR_print_errors_fp(stdout);
-                                       ERR_clear_error();
-                                       }
-                               }
-                       if((verbose > 0) && !util_verbose(e, verbose, bio_out, indent))
-                               goto end;
-                       ENGINE_free(e);
-                       }
-               else
-                       ERR_print_errors(bio_err);
-               }
-
-       ret=0;
-end:
-       ERR_print_errors(bio_err);
-       sk_pop_free(engines, identity);
-       sk_pop_free(pre_cmds, identity);
-       sk_pop_free(post_cmds, identity);
-       if (bio_out != NULL) BIO_free_all(bio_out);
-       apps_shutdown();
-       OPENSSL_EXIT(ret);
-       }
+                    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