update FAQ
[openssl.git] / apps / engine.c
index faeeb7e2000ddc884f397cb43e068ab3c62a1466..9a0294398e83a1f554019b002647d6c485832256 100644 (file)
@@ -56,6 +56,7 @@
  *
  */
 
+
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 #endif
 #include "apps.h"
 #include <openssl/err.h>
+#ifndef OPENSSL_NO_ENGINE
 #include <openssl/engine.h>
 #include <openssl/ssl.h>
 
 #undef PROG
 #define PROG   engine_main
 
-static char *engine_usage[]={
+static const char *engine_usage[]={
 "usage: engine opts [engine ...]\n",
-" -v[v[v]]    - verbose mode, for each engine, list its 'control commands'\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          - for each engine, check that they are really available\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",
@@ -88,12 +92,12 @@ static char *engine_usage[]={
 NULL
 };
 
-static void identity(void *ptr)
+static void identity(char *ptr)
        {
        return;
        }
 
-static int append_buf(char **buf, char *s, int *size, int step)
+static int append_buf(char **buf, const char *s, int *size, int step)
        {
        int l = strlen(s);
 
@@ -119,8 +123,8 @@ static int append_buf(char **buf, char *s, int *size, int step)
                return 0;
 
        if (**buf != '\0')
-               strcat(*buf, ", ");
-       strcat(*buf, s);
+               BUF_strlcat(*buf, ", ", *size);
+       BUF_strlcat(*buf, s, *size);
 
        return 1;
        }
@@ -135,6 +139,13 @@ static int util_flags(BIO *bio_out, unsigned int flags, const char *indent)
                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)
                {
                BIO_printf(bio_out, "NUMERIC");
@@ -167,7 +178,8 @@ static int util_flags(BIO *bio_out, unsigned int flags, const char *indent)
        /* Check for unknown flags */
        flags = flags & ~ENGINE_CMD_FLAG_NUMERIC &
                        ~ENGINE_CMD_FLAG_STRING &
-                       ~ENGINE_CMD_FLAG_NO_INPUT;
+                       ~ENGINE_CMD_FLAG_NO_INPUT &
+                       ~ENGINE_CMD_FLAG_INTERNAL;
        if(flags)
                {
                if(started) BIO_printf(bio_out, "|");
@@ -188,7 +200,7 @@ static int util_verbose(ENGINE *e, int verbose, BIO *bio_out, const char *indent
        char *desc = NULL;
        int flags;
        int xpos = 0;
-       STACK *cmds = NULL;
+       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))
@@ -199,66 +211,69 @@ static int util_verbose(ENGINE *e, int verbose, BIO *bio_out, const char *indent
                return 1;
                }
 
-       cmds = sk_new_null();
+       cmds = sk_OPENSSL_STRING_new_null();
 
        if(!cmds)
                goto err;
        do {
                int len;
-               /* 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,
-                                       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;
-                       }
                /* Get the command input flags */
                if((flags = ENGINE_ctrl(e, ENGINE_CTRL_GET_CMD_FLAGS, num,
                                        NULL, 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)) &&
+                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,
+                                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_puts(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;
-                       }
+                                        {
+                                        BIO_printf(bio_out, "\n");
+                                        xpos = BIO_puts(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 */
@@ -269,15 +284,17 @@ static int util_verbose(ENGINE *e, int verbose, BIO *bio_out, const char *indent
                BIO_printf(bio_out, "\n");
        ret = 1;
 err:
-       if(cmds) sk_pop_free(cmds, identity);
+       if(cmds) sk_OPENSSL_STRING_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)
+static void util_do_cmds(ENGINE *e, STACK_OF(OPENSSL_STRING) *cmds,
+                       BIO *bio_out, const char *indent)
        {
-       int loop, res, num = sk_num(cmds);
+       int loop, res, num = sk_OPENSSL_STRING_num(cmds);
+
        if(num < 0)
                {
                BIO_printf(bio_out, "[Error]: internal stack error\n");
@@ -287,7 +304,7 @@ static void util_do_cmds(ENGINE *e, STACK *cmds, BIO *bio_out, const char *inden
                {
                char buf[256];
                const char *cmd, *arg;
-               cmd = sk_value(cmds, loop);
+               cmd = sk_OPENSSL_STRING_value(cmds, loop);
                res = 1; /* assume success */
                /* Check if this command has no ":arg" */
                if((arg = strstr(cmd, ":")) == NULL)
@@ -324,12 +341,12 @@ 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;
+       const 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();
+       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();
        int badops=1;
        BIO *bio_out=NULL;
        const char *indent = "     ";
@@ -339,6 +356,9 @@ int MAIN(int argc, char **argv)
 
        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
        {
@@ -355,28 +375,38 @@ int MAIN(int argc, char **argv)
                        {
                        if(strspn(*argv + 1, "v") < strlen(*argv + 1))
                                goto skip_arg_loop;
-                       if((verbose=strlen(*argv + 1)) > 3)
+                       if((verbose=strlen(*argv + 1)) > 4)
                                goto skip_arg_loop;
                        }
                else if (strcmp(*argv,"-c") == 0)
                        list_cap=1;
-               else if (strcmp(*argv,"-t") == 0)
+               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);
+                       if (argc == 0)
+                               goto skip_arg_loop;
+                       sk_OPENSSL_STRING_push(pre_cmds,*argv);
                        }
                else if (strcmp(*argv,"-post") == 0)
                        {
                        argc--; argv++;
-                       sk_push(post_cmds,*argv);
+                       if (argc == 0)
+                               goto skip_arg_loop;
+                       sk_OPENSSL_STRING_push(post_cmds,*argv);
                        }
                else if ((strncmp(*argv,"-h",2) == 0) ||
                                (strcmp(*argv,"-?") == 0))
                        goto skip_arg_loop;
                else
-                       sk_push(engines,*argv);
+                       sk_OPENSSL_STRING_push(engines,*argv);
                argc--;
                argv++;
                }
@@ -391,28 +421,37 @@ skip_arg_loop:
                goto end;
                }
 
-       if (sk_num(engines) == 0)
+       if (sk_OPENSSL_STRING_num(engines) == 0)
                {
                for(e = ENGINE_get_first(); e != NULL; e = ENGINE_get_next(e))
                        {
-                       sk_push(engines,(char *)ENGINE_get_id(e));
+                       sk_OPENSSL_STRING_push(engines,(char *)ENGINE_get_id(e));
                        }
                }
 
-       for (i=0; i<sk_num(engines); i++)
+       for (i=0; i<sk_OPENSSL_STRING_num(engines); i++)
                {
-               const char *id = sk_value(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(bio_out, "(%s) %s", id, name);
-                       if (list_cap)
-                               BIO_printf(bio_out, ":");
+                       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;
+                               ENGINE_PKEY_METHS_PTR fn_pk;
 
                                if (ENGINE_get_RSA(e) != NULL
                                        && !append_buf(&cap_buf, "RSA",
@@ -431,13 +470,40 @@ skip_arg_loop:
                                                &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:
+                               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,
+                                                      OBJ_nid2sn(nids[k]),
+                                                      &cap_size, 256))
+                                               goto end;
+skip_pmeths:
                                if (cap_buf && (*cap_buf != '\0'))
-                                       BIO_printf(bio_out, " [%s]", cap_buf);
+                                       BIO_printf(bio_out, " [%s]\n", cap_buf);
 
                                OPENSSL_free(cap_buf);
                                }
-                       BIO_printf(bio_out, "\n");
-                       util_do_cmds(e, pre_cmds, bio_out, indent);
                        if(test_avail)
                                {
                                BIO_printf(bio_out, "%s", indent);
@@ -450,7 +516,8 @@ skip_arg_loop:
                                else
                                        {
                                        BIO_printf(bio_out, "[ unavailable ]\n");
-                                       ERR_print_errors_fp(stdout);
+                                       if(test_avail_noise)
+                                               ERR_print_errors_fp(stdout);
                                        ERR_clear_error();
                                        }
                                }
@@ -464,10 +531,19 @@ skip_arg_loop:
 
        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);
+       sk_OPENSSL_STRING_pop_free(engines, identity);
+       sk_OPENSSL_STRING_pop_free(pre_cmds, identity);
+       sk_OPENSSL_STRING_pop_free(post_cmds, identity);
        if (bio_out != NULL) BIO_free_all(bio_out);
-       EXIT(ret);
+       apps_shutdown();
+       OPENSSL_EXIT(ret);
        }
+#else
+
+# if PEDANTIC
+static void *dummy=&dummy;
+# endif
+
+#endif