apps/engine.c

   1 /* apps/engine.c -*- mode: C; c-file-style: "eay" -*- */
   2 /*
   3  * Written by Richard Levitte <richard@levitte.org> for the OpenSSL project
   4  * 2000.
   5  */
   6 /* ====================================================================
   7  * Copyright (c) 2000 The OpenSSL Project.  All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  *
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  *
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in
  18  *    the documentation and/or other materials provided with the
  19  *    distribution.
  20  *
  21  * 3. All advertising materials mentioning features or use of this
  22  *    software must display the following acknowledgment:
  23  *    "This product includes software developed by the OpenSSL Project
  24  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
  25  *
  26  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  27  *    endorse or promote products derived from this software without
  28  *    prior written permission. For written permission, please contact
  29  *    licensing@OpenSSL.org.
  30  *
  31  * 5. Products derived from this software may not be called "OpenSSL"
  32  *    nor may "OpenSSL" appear in their names without prior written
  33  *    permission of the OpenSSL Project.
  34  *
  35  * 6. Redistributions of any form whatsoever must retain the following
  36  *    acknowledgment:
  37  *    "This product includes software developed by the OpenSSL Project
  38  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
  39  *
  40  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  41  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  43  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  44  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  45  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  46  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  47  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  49  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  50  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  51  * OF THE POSSIBILITY OF SUCH DAMAGE.
  52  * ====================================================================
  53  *
  54  * This product includes cryptographic software written by Eric Young
  55  * (eay@cryptsoft.com).  This product includes software written by Tim
  56  * Hudson (tjh@cryptsoft.com).
  57  *
  58  */
  59
  60 #include <stdio.h>
  61 #include <stdlib.h>
  62 #include <string.h>
  63 #include "apps.h"
  64 #include <openssl/err.h>
  65 #ifndef OPENSSL_NO_ENGINE
  66 # include <openssl/engine.h>
  67 # include <openssl/ssl.h>
  68
  69 # undef PROG
  70 # define PROG    engine_main
  71
  72 static const char *engine_usage[] = {
  73     "usage: engine opts [engine ...]\n",
  74     " -v[v[v[v]]] - verbose mode, for each engine, list its 'control commands'\n",
  75     "               -vv will additionally display each command's description\n",
  76     "               -vvv will also add the input flags for each command\n",
  77     "               -vvvv will also show internal input flags\n",
  78     " -c          - for each engine, also list the capabilities\n",
  79     " -t[t]       - for each engine, check that they are really available\n",
  80     "               -tt will display error trace for unavailable engines\n",
  81     " -pre <cmd>  - runs command 'cmd' against the ENGINE before any attempts\n",
  82     "               to load it (if -t is used)\n",
  83     " -post <cmd> - runs command 'cmd' against the ENGINE after loading it\n",
  84     "               (only used if -t is also provided)\n",
  85     " NB: -pre and -post will be applied to all ENGINEs supplied on the command\n",
  86     " line, or all supported ENGINEs if none are specified.\n",
  87     " Eg. '-pre \"SO_PATH:/lib/libdriver.so\"' calls command \"SO_PATH\" with\n",
  88     " argument \"/lib/libdriver.so\".\n",
  89     NULL
  90 };
  91
  92 static void identity(char *ptr)
  93 {
  94     return;
  95 }
  96
  97 static int append_buf(char **buf, const char *s, int *size, int step)
  98 {
  99     int l = strlen(s);
 100
 101     if (*buf == NULL) {
 102         *size = step;
 103         *buf = OPENSSL_malloc(*size);
 104         if (*buf == NULL)
 105             return 0;
 106         **buf = '\0';
 107     }
 108
 109     if (**buf != '\0')
 110         l += 2;                 /* ", " */
 111
 112     if (strlen(*buf) + strlen(s) >= (unsigned int)*size) {
 113         *size += step;
 114         *buf = OPENSSL_realloc(*buf, *size);
 115     }
 116
 117     if (*buf == NULL)
 118         return 0;
 119
 120     if (**buf != '\0')
 121         BUF_strlcat(*buf, ", ", *size);
 122     BUF_strlcat(*buf, s, *size);
 123
 124     return 1;
 125 }
 126
 127 static int util_flags(BIO *bio_out, unsigned int flags, const char *indent)
 128 {
 129     int started = 0, err = 0;
 130     /* Indent before displaying input flags */
 131     BIO_printf(bio_out, "%s%s(input flags): ", indent, indent);
 132     if (flags == 0) {
 133         BIO_printf(bio_out, "<no flags>\n");
 134         return 1;
 135     }
 136     /*
 137      * If the object is internal, mark it in a way that shows instead of
 138      * having it part of all the other flags, even if it really is.
 139      */
 140     if (flags & ENGINE_CMD_FLAG_INTERNAL) {
 141         BIO_printf(bio_out, "[Internal] ");
 142     }
 143
 144     if (flags & ENGINE_CMD_FLAG_NUMERIC) {
 145         BIO_printf(bio_out, "NUMERIC");
 146         started = 1;
 147     }
 148     /*
 149      * Now we check that no combinations of the mutually exclusive NUMERIC,
 150      * STRING, and NO_INPUT flags have been used. Future flags that can be
 151      * OR'd together with these would need to added after these to preserve
 152      * the testing logic.
 153      */
 154     if (flags & ENGINE_CMD_FLAG_STRING) {
 155         if (started) {
 156             BIO_printf(bio_out, "|");
 157             err = 1;
 158         }
 159         BIO_printf(bio_out, "STRING");
 160         started = 1;
 161     }
 162     if (flags & ENGINE_CMD_FLAG_NO_INPUT) {
 163         if (started) {
 164             BIO_printf(bio_out, "|");
 165             err = 1;
 166         }
 167         BIO_printf(bio_out, "NO_INPUT");
 168         started = 1;
 169     }
 170     /* Check for unknown flags */
 171     flags = flags & ~ENGINE_CMD_FLAG_NUMERIC &
 172         ~ENGINE_CMD_FLAG_STRING &
 173         ~ENGINE_CMD_FLAG_NO_INPUT & ~ENGINE_CMD_FLAG_INTERNAL;
 174     if (flags) {
 175         if (started)
 176             BIO_printf(bio_out, "|");
 177         BIO_printf(bio_out, "<0x%04X>", flags);
 178     }
 179     if (err)
 180         BIO_printf(bio_out, "  <illegal flags!>");
 181     BIO_printf(bio_out, "\n");
 182     return 1;
 183 }
 184
 185 static int util_verbose(ENGINE *e, int verbose, BIO *bio_out,
 186                         const char *indent)
 187 {
 188     static const int line_wrap = 78;
 189     int num;
 190     int ret = 0;
 191     char *name = NULL;
 192     char *desc = NULL;
 193     int flags;
 194     int xpos = 0;
 195     STACK_OF(OPENSSL_STRING) *cmds = NULL;
 196     if (!ENGINE_ctrl(e, ENGINE_CTRL_HAS_CTRL_FUNCTION, 0, NULL, NULL) ||
 197         ((num = ENGINE_ctrl(e, ENGINE_CTRL_GET_FIRST_CMD_TYPE,
 198                             0, NULL, NULL)) <= 0)) {
 199         return 1;
 200     }
 201
 202     cmds = sk_OPENSSL_STRING_new_null();
 203
 204     if (!cmds)
 205         goto err;
 206     do {
 207         int len;
 208         /* Get the command input flags */
 209         if ((flags = ENGINE_ctrl(e, ENGINE_CTRL_GET_CMD_FLAGS, num,
 210                                  NULL, NULL)) < 0)
 211             goto err;
 212         if (!(flags & ENGINE_CMD_FLAG_INTERNAL) || verbose >= 4) {
 213             /* Get the command name */
 214             if ((len = ENGINE_ctrl(e, ENGINE_CTRL_GET_NAME_LEN_FROM_CMD, num,
 215                                    NULL, NULL)) <= 0)
 216                 goto err;
 217             if ((name = OPENSSL_malloc(len + 1)) == NULL)
 218                 goto err;
 219             if (ENGINE_ctrl(e, ENGINE_CTRL_GET_NAME_FROM_CMD, num, name,
 220                             NULL) <= 0)
 221                 goto err;
 222             /* Get the command description */
 223             if ((len = ENGINE_ctrl(e, ENGINE_CTRL_GET_DESC_LEN_FROM_CMD, num,
 224                                    NULL, NULL)) < 0)
 225                 goto err;
 226             if (len > 0) {
 227                 if ((desc = OPENSSL_malloc(len + 1)) == NULL)
 228                     goto err;
 229                 if (ENGINE_ctrl(e, ENGINE_CTRL_GET_DESC_FROM_CMD, num, desc,
 230                                 NULL) <= 0)
 231                     goto err;
 232             }
 233             /* Now decide on the output */
 234             if (xpos == 0)
 235                 /* Do an indent */
 236                 xpos = BIO_puts(bio_out, indent);
 237             else
 238                 /* Otherwise prepend a ", " */
 239                 xpos += BIO_printf(bio_out, ", ");
 240             if (verbose == 1) {
 241                 /*
 242                  * We're just listing names, comma-delimited
 243                  */
 244                 if ((xpos > (int)strlen(indent)) &&
 245                     (xpos + (int)strlen(name) > line_wrap)) {
 246                     BIO_printf(bio_out, "\n");
 247                     xpos = BIO_puts(bio_out, indent);
 248                 }
 249                 xpos += BIO_printf(bio_out, "%s", name);
 250             } else {
 251                 /* We're listing names plus descriptions */
 252                 BIO_printf(bio_out, "%s: %s\n", name,
 253                            (desc == NULL) ? "<no description>" : desc);
 254                 /* ... and sometimes input flags */
 255                 if ((verbose >= 3) && !util_flags(bio_out, flags, indent))
 256                     goto err;
 257                 xpos = 0;
 258             }
 259         }
 260         OPENSSL_free(name);
 261         name = NULL;
 262         if (desc) {
 263             OPENSSL_free(desc);
 264             desc = NULL;
 265         }
 266         /* Move to the next command */
 267         num = ENGINE_ctrl(e, ENGINE_CTRL_GET_NEXT_CMD_TYPE, num, NULL, NULL);
 268     } while (num > 0);
 269     if (xpos > 0)
 270         BIO_printf(bio_out, "\n");
 271     ret = 1;
 272  err:
 273     if (cmds)
 274         sk_OPENSSL_STRING_pop_free(cmds, identity);
 275     if (name)
 276         OPENSSL_free(name);
 277     if (desc)
 278         OPENSSL_free(desc);
 279     return ret;
 280 }
 281
 282 static void util_do_cmds(ENGINE *e, STACK_OF(OPENSSL_STRING) *cmds,
 283                          BIO *bio_out, const char *indent)
 284 {
 285     int loop, res, num = sk_OPENSSL_STRING_num(cmds);
 286
 287     if (num < 0) {
 288         BIO_printf(bio_out, "[Error]: internal stack error\n");
 289         return;
 290     }
 291     for (loop = 0; loop < num; loop++) {
 292         char buf[256];
 293         const char *cmd, *arg;
 294         cmd = sk_OPENSSL_STRING_value(cmds, loop);
 295         res = 1;                /* assume success */
 296         /* Check if this command has no ":arg" */
 297         if ((arg = strstr(cmd, ":")) == NULL) {
 298             if (!ENGINE_ctrl_cmd_string(e, cmd, NULL, 0))
 299                 res = 0;
 300         } else {
 301             if ((int)(arg - cmd) > 254) {
 302                 BIO_printf(bio_out, "[Error]: command name too long\n");
 303                 return;
 304             }
 305             memcpy(buf, cmd, (int)(arg - cmd));
 306             buf[arg - cmd] = '\0';
 307             arg++;              /* Move past the ":" */
 308             /* Call the command with the argument */
 309             if (!ENGINE_ctrl_cmd_string(e, buf, arg, 0))
 310                 res = 0;
 311         }
 312         if (res)
 313             BIO_printf(bio_out, "[Success]: %s\n", cmd);
 314         else {
 315             BIO_printf(bio_out, "[Failure]: %s\n", cmd);
 316             ERR_print_errors(bio_out);
 317         }
 318     }
 319 }
 320
 321 int MAIN(int, char **);
 322
 323 int MAIN(int argc, char **argv)
 324 {
 325     int ret = 1, i;
 326     const char **pp;
 327     int verbose = 0, list_cap = 0, test_avail = 0, test_avail_noise = 0;
 328     ENGINE *e;
 329     STACK_OF(OPENSSL_STRING) *engines = sk_OPENSSL_STRING_new_null();
 330     STACK_OF(OPENSSL_STRING) *pre_cmds = sk_OPENSSL_STRING_new_null();
 331     STACK_OF(OPENSSL_STRING) *post_cmds = sk_OPENSSL_STRING_new_null();
 332     int badops = 1;
 333     BIO *bio_out = NULL;
 334     const char *indent = "     ";
 335
 336     apps_startup();
 337     SSL_load_error_strings();
 338
 339     if (bio_err == NULL)
 340         bio_err = BIO_new_fp(stderr, BIO_NOCLOSE);
 341
 342     if (!load_config(bio_err, NULL))
 343         goto end;
 344     bio_out = BIO_new_fp(stdout, BIO_NOCLOSE);
 345 # ifdef OPENSSL_SYS_VMS
 346     {
 347         BIO *tmpbio = BIO_new(BIO_f_linebuffer());
 348         bio_out = BIO_push(tmpbio, bio_out);
 349     }
 350 # endif
 351
 352     argc--;
 353     argv++;
 354     while (argc >= 1) {
 355         if (strncmp(*argv, "-v", 2) == 0) {
 356             if (strspn(*argv + 1, "v") < strlen(*argv + 1))
 357                 goto skip_arg_loop;
 358             if ((verbose = strlen(*argv + 1)) > 4)
 359                 goto skip_arg_loop;
 360         } else if (strcmp(*argv, "-c") == 0)
 361             list_cap = 1;
 362         else if (strncmp(*argv, "-t", 2) == 0) {
 363             test_avail = 1;
 364             if (strspn(*argv + 1, "t") < strlen(*argv + 1))
 365                 goto skip_arg_loop;
 366             if ((test_avail_noise = strlen(*argv + 1) - 1) > 1)
 367                 goto skip_arg_loop;
 368         } else if (strcmp(*argv, "-pre") == 0) {
 369             argc--;
 370             argv++;
 371             if (argc == 0)
 372                 goto skip_arg_loop;
 373             sk_OPENSSL_STRING_push(pre_cmds, *argv);
 374         } else if (strcmp(*argv, "-post") == 0) {
 375             argc--;
 376             argv++;
 377             if (argc == 0)
 378                 goto skip_arg_loop;
 379             sk_OPENSSL_STRING_push(post_cmds, *argv);
 380         } else if ((strncmp(*argv, "-h", 2) == 0) ||
 381                    (strcmp(*argv, "-?") == 0))
 382             goto skip_arg_loop;
 383         else
 384             sk_OPENSSL_STRING_push(engines, *argv);
 385         argc--;
 386         argv++;
 387     }
 388     /* Looks like everything went OK */
 389     badops = 0;
 390  skip_arg_loop:
 391
 392     if (badops) {
 393         for (pp = engine_usage; (*pp != NULL); pp++)
 394             BIO_printf(bio_err, "%s", *pp);
 395         goto end;
 396     }
 397
 398     if (sk_OPENSSL_STRING_num(engines) == 0) {
 399         for (e = ENGINE_get_first(); e != NULL; e = ENGINE_get_next(e)) {
 400             sk_OPENSSL_STRING_push(engines, (char *)ENGINE_get_id(e));
 401         }
 402     }
 403
 404     for (i = 0; i < sk_OPENSSL_STRING_num(engines); i++) {
 405         const char *id = sk_OPENSSL_STRING_value(engines, i);
 406         if ((e = ENGINE_by_id(id)) != NULL) {
 407             const char *name = ENGINE_get_name(e);
 408             /*
 409              * Do "id" first, then "name". Easier to auto-parse.
 410              */
 411             BIO_printf(bio_out, "(%s) %s\n", id, name);
 412             util_do_cmds(e, pre_cmds, bio_out, indent);
 413             if (strcmp(ENGINE_get_id(e), id) != 0) {
 414                 BIO_printf(bio_out, "Loaded: (%s) %s\n",
 415                            ENGINE_get_id(e), ENGINE_get_name(e));
 416             }
 417             if (list_cap) {
 418                 int cap_size = 256;
 419                 char *cap_buf = NULL;
 420                 int k, n;
 421                 const int *nids;
 422                 ENGINE_CIPHERS_PTR fn_c;
 423                 ENGINE_DIGESTS_PTR fn_d;
 424                 ENGINE_PKEY_METHS_PTR fn_pk;
 425
 426                 if (ENGINE_get_RSA(e) != NULL
 427                     && !append_buf(&cap_buf, "RSA", &cap_size, 256))
 428                     goto end;
 429                 if (ENGINE_get_DSA(e) != NULL
 430                     && !append_buf(&cap_buf, "DSA", &cap_size, 256))
 431                     goto end;
 432                 if (ENGINE_get_DH(e) != NULL
 433                     && !append_buf(&cap_buf, "DH", &cap_size, 256))
 434                     goto end;
 435                 if (ENGINE_get_RAND(e) != NULL
 436                     && !append_buf(&cap_buf, "RAND", &cap_size, 256))
 437                     goto end;
 438
 439                 fn_c = ENGINE_get_ciphers(e);
 440                 if (!fn_c)
 441                     goto skip_ciphers;
 442                 n = fn_c(e, NULL, &nids, 0);
 443                 for (k = 0; k < n; ++k)
 444                     if (!append_buf(&cap_buf,
 445                                     OBJ_nid2sn(nids[k]), &cap_size, 256))
 446                         goto end;
 447
 448  skip_ciphers:
 449                 fn_d = ENGINE_get_digests(e);
 450                 if (!fn_d)
 451                     goto skip_digests;
 452                 n = fn_d(e, NULL, &nids, 0);
 453                 for (k = 0; k < n; ++k)
 454                     if (!append_buf(&cap_buf,
 455                                     OBJ_nid2sn(nids[k]), &cap_size, 256))
 456                         goto end;
 457
 458  skip_digests:
 459                 fn_pk = ENGINE_get_pkey_meths(e);
 460                 if (!fn_pk)
 461                     goto skip_pmeths;
 462                 n = fn_pk(e, NULL, &nids, 0);
 463                 for (k = 0; k < n; ++k)
 464                     if (!append_buf(&cap_buf,
 465                                     OBJ_nid2sn(nids[k]), &cap_size, 256))
 466                         goto end;
 467  skip_pmeths:
 468                 if (cap_buf && (*cap_buf != '\0'))
 469                     BIO_printf(bio_out, " [%s]\n", cap_buf);
 470
 471                 OPENSSL_free(cap_buf);
 472             }
 473             if (test_avail) {
 474                 BIO_printf(bio_out, "%s", indent);
 475                 if (ENGINE_init(e)) {
 476                     BIO_printf(bio_out, "[ available ]\n");
 477                     util_do_cmds(e, post_cmds, bio_out, indent);
 478                     ENGINE_finish(e);
 479                 } else {
 480                     BIO_printf(bio_out, "[ unavailable ]\n");
 481                     if (test_avail_noise)
 482                         ERR_print_errors_fp(stdout);
 483                     ERR_clear_error();
 484                 }
 485             }
 486             if ((verbose > 0) && !util_verbose(e, verbose, bio_out, indent))
 487                 goto end;
 488             ENGINE_free(e);
 489         } else
 490             ERR_print_errors(bio_err);
 491     }
 492
 493     ret = 0;
 494  end:
 495
 496     ERR_print_errors(bio_err);
 497     sk_OPENSSL_STRING_pop_free(engines, identity);
 498     sk_OPENSSL_STRING_pop_free(pre_cmds, identity);
 499     sk_OPENSSL_STRING_pop_free(post_cmds, identity);
 500     BIO_free_all(bio_out);
 501     apps_shutdown();
 502     OPENSSL_EXIT(ret);
 503 }
 504 #else
 505
 506 # if PEDANTIC
 507 static void *dummy = &dummy;
 508 # endif
 509
 510 #endif