apps/openssl.c

   1 /*
   2  * Copyright 1995-2019 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (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
   8  */
   9
  10 #include <internal/cryptlib.h>
  11 #include <stdio.h>
  12 #include <string.h>
  13 #include <stdlib.h>
  14 #include <openssl/bio.h>
  15 #include <openssl/crypto.h>
  16 #include <openssl/trace.h>
  17 #include <openssl/lhash.h>
  18 #include <openssl/conf.h>
  19 #include <openssl/x509.h>
  20 #include <openssl/pem.h>
  21 #include <openssl/ssl.h>
  22 #ifndef OPENSSL_NO_ENGINE
  23 # include <openssl/engine.h>
  24 #endif
  25 #include <openssl/err.h>
  26 #include "s_apps.h"
  27 /* Needed to get the other O_xxx flags. */
  28 #ifdef OPENSSL_SYS_VMS
  29 # include <unixio.h>
  30 #endif
  31 #include "apps.h"
  32 #include "progs.h"
  33
  34 /* Special sentinel to exit the program. */
  35 #define EXIT_THE_PROGRAM (-1)
  36
  37 /*
  38  * The LHASH callbacks ("hash" & "cmp") have been replaced by functions with
  39  * the base prototypes (we cast each variable inside the function to the
  40  * required type of "FUNCTION*"). This removes the necessity for
  41  * macro-generated wrapper functions.
  42  */
  43 static LHASH_OF(FUNCTION) *prog_init(void);
  44 static int do_cmd(LHASH_OF(FUNCTION) *prog, int argc, char *argv[]);
  45 char *default_config_file = NULL;
  46
  47 BIO *bio_in = NULL;
  48 BIO *bio_out = NULL;
  49 BIO *bio_err = NULL;
  50
  51 static int apps_startup(void)
  52 {
  53 #ifdef SIGPIPE
  54     signal(SIGPIPE, SIG_IGN);
  55 #endif
  56
  57     /* Set non-default library initialisation settings */
  58     if (!OPENSSL_init_ssl(OPENSSL_INIT_ENGINE_ALL_BUILTIN
  59                           | OPENSSL_INIT_LOAD_CONFIG, NULL))
  60         return 0;
  61
  62     setup_ui_method();
  63
  64     return 1;
  65 }
  66
  67 static void apps_shutdown(void)
  68 {
  69     destroy_ui_method();
  70 }
  71
  72 static char *make_config_name(void)
  73 {
  74     const char *t;
  75     size_t len;
  76     char *p;
  77
  78     if ((t = getenv("OPENSSL_CONF")) != NULL)
  79         return OPENSSL_strdup(t);
  80
  81     t = X509_get_default_cert_area();
  82     len = strlen(t) + 1 + strlen(OPENSSL_CONF) + 1;
  83     p = app_malloc(len, "config filename buffer");
  84     strcpy(p, t);
  85 #ifndef OPENSSL_SYS_VMS
  86     strcat(p, "/");
  87 #endif
  88     strcat(p, OPENSSL_CONF);
  89
  90     return p;
  91 }
  92
  93
  94 #ifndef OPENSSL_NO_TRACE
  95 typedef struct tracedata_st {
  96     BIO *bio;
  97     unsigned int ingroup:1;
  98 } tracedata;
  99
 100 static size_t internal_trace_cb(const char *buf, size_t cnt,
 101                                 int category, int cmd, void *vdata)
 102 {
 103     int ret = 0;
 104     tracedata *trace_data = vdata;
 105     char buffer[256], *hex;
 106     CRYPTO_THREAD_ID tid;
 107
 108     switch (cmd) {
 109     case OSSL_TRACE_CTRL_BEGIN:
 110         if (!ossl_assert(!trace_data->ingroup))
 111             return 0;
 112         trace_data->ingroup = 1;
 113
 114         tid = CRYPTO_THREAD_get_current_id();
 115         hex = OPENSSL_buf2hexstr((const unsigned char *)&tid, sizeof(tid));
 116         BIO_snprintf(buffer, sizeof(buffer), "TRACE[%s]:%s: ",
 117                      hex, OSSL_trace_get_category_name(category));
 118         OPENSSL_free(hex);
 119         BIO_ctrl(trace_data->bio, PREFIX_CTRL_SET_PREFIX,
 120                  strlen(buffer), buffer);
 121         break;
 122     case OSSL_TRACE_CTRL_WRITE:
 123         if (!ossl_assert(trace_data->ingroup))
 124             return 0;
 125
 126         ret = BIO_write(trace_data->bio, buf, cnt);
 127         break;
 128     case OSSL_TRACE_CTRL_END:
 129         if (!ossl_assert(trace_data->ingroup))
 130             return 0;
 131         trace_data->ingroup = 0;
 132
 133         BIO_ctrl(trace_data->bio, PREFIX_CTRL_SET_PREFIX, 0, NULL);
 134
 135         break;
 136     }
 137
 138     return ret < 0 ? 0 : ret;
 139 }
 140
 141 DEFINE_STACK_OF(tracedata)
 142 static STACK_OF(tracedata) *trace_data_stack;
 143
 144 static void tracedata_free(tracedata *data)
 145 {
 146     BIO_free_all(data->bio);
 147     OPENSSL_free(data);
 148 }
 149
 150 static STACK_OF(tracedata) *trace_data_stack;
 151
 152 static void cleanup_trace(void)
 153 {
 154     sk_tracedata_pop_free(trace_data_stack, tracedata_free);
 155 }
 156
 157 static void setup_trace_category(int category)
 158 {
 159     BIO *channel;
 160     tracedata *trace_data;
 161
 162     if (OSSL_trace_enabled(category))
 163         return;
 164
 165     channel = BIO_push(BIO_new(apps_bf_prefix()),
 166                        dup_bio_err(FORMAT_TEXT));
 167     trace_data = OPENSSL_zalloc(sizeof(*trace_data));
 168
 169     if (trace_data == NULL
 170         || (trace_data->bio = channel) == NULL
 171         || OSSL_trace_set_callback(category, internal_trace_cb,
 172                                    trace_data) == 0
 173         || sk_tracedata_push(trace_data_stack, trace_data) == 0) {
 174
 175         fprintf(stderr,
 176                 "warning: unable to setup trace callback for category '%s'.\n",
 177                 OSSL_trace_get_category_name(category));
 178
 179         OSSL_trace_set_callback(category, NULL, NULL);
 180         BIO_free_all(channel);
 181     }
 182 }
 183
 184 static void setup_trace(const char *str)
 185 {
 186     char *val;
 187
 188     /*
 189      * We add this handler as early as possible to ensure it's executed
 190      * as late as possible, i.e. after the TRACE code has done its cleanup
 191      * (which happens last in OPENSSL_cleanup).
 192      */
 193     atexit(cleanup_trace);
 194
 195     trace_data_stack = sk_tracedata_new_null();
 196     val = OPENSSL_strdup(str);
 197
 198     if (val != NULL) {
 199         char *valp = val;
 200         char *item;
 201
 202         for (valp = val; (item = strtok(valp, ",")) != NULL; valp = NULL) {
 203             int category = OSSL_trace_get_category_num(item);
 204
 205             if (category == OSSL_TRACE_CATEGORY_ALL) {
 206                 while (++category < OSSL_TRACE_CATEGORY_NUM)
 207                     setup_trace_category(category);
 208                 break;
 209             } else if (category > 0) {
 210                 setup_trace_category(category);
 211             } else {
 212                 fprintf(stderr,
 213                         "warning: unknown trace category: '%s'.\n", item);
 214             }
 215         }
 216     }
 217
 218     OPENSSL_free(val);
 219 }
 220 #endif /* OPENSSL_NO_TRACE */
 221
 222 int main(int argc, char *argv[])
 223 {
 224     FUNCTION f, *fp;
 225     LHASH_OF(FUNCTION) *prog = NULL;
 226     char *p, *pname;
 227     char buf[1024];
 228     const char *prompt;
 229     ARGS arg;
 230     int first, n, i, ret = 0;
 231
 232     arg.argv = NULL;
 233     arg.size = 0;
 234
 235     /* Set up some of the environment. */
 236     default_config_file = make_config_name();
 237     bio_in = dup_bio_in(FORMAT_TEXT);
 238     bio_out = dup_bio_out(FORMAT_TEXT);
 239     bio_err = dup_bio_err(FORMAT_TEXT);
 240
 241 #if defined(OPENSSL_SYS_VMS) && defined(__DECC)
 242     argv = copy_argv(&argc, argv);
 243 #elif defined(_WIN32)
 244     /*
 245      * Replace argv[] with UTF-8 encoded strings.
 246      */
 247     win32_utf8argv(&argc, &argv);
 248 #endif
 249
 250     /*
 251      * We use the prefix method to get the trace output we want.  Since some
 252      * trace outputs happen with OPENSSL_cleanup(), which is run automatically
 253      * after exit(), we need to destroy the prefix method as late as possible.
 254      */
 255     atexit(destroy_prefix_method);
 256
 257 #ifndef OPENSSL_NO_TRACE
 258     setup_trace(getenv("OPENSSL_TRACE"));
 259 #endif
 260
 261     p = getenv("OPENSSL_DEBUG_MEMORY");
 262     if (p != NULL && strcmp(p, "on") == 0)
 263         CRYPTO_set_mem_debug(1);
 264     CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON);
 265
 266     if (getenv("OPENSSL_FIPS")) {
 267         BIO_printf(bio_err, "FIPS mode not supported.\n");
 268         return 1;
 269     }
 270
 271     if (!apps_startup()) {
 272         BIO_printf(bio_err,
 273                    "FATAL: Startup failure (dev note: apps_startup() failed)\n");
 274         ERR_print_errors(bio_err);
 275         ret = 1;
 276         goto end;
 277     }
 278
 279     prog = prog_init();
 280     pname = opt_progname(argv[0]);
 281
 282     /* first check the program name */
 283     f.name = pname;
 284     fp = lh_FUNCTION_retrieve(prog, &f);
 285     if (fp != NULL) {
 286         argv[0] = pname;
 287         ret = fp->func(argc, argv);
 288         goto end;
 289     }
 290
 291     /* If there is stuff on the command line, run with that. */
 292     if (argc != 1) {
 293         argc--;
 294         argv++;
 295         ret = do_cmd(prog, argc, argv);
 296         if (ret < 0)
 297             ret = 0;
 298         goto end;
 299     }
 300
 301     /* ok, lets enter interactive mode */
 302     for (;;) {
 303         ret = 0;
 304         /* Read a line, continue reading if line ends with \ */
 305         for (p = buf, n = sizeof(buf), i = 0, first = 1; n > 0; first = 0) {
 306             prompt = first ? "OpenSSL> " : "> ";
 307             p[0] = '\0';
 308 #ifndef READLINE
 309             fputs(prompt, stdout);
 310             fflush(stdout);
 311             if (!fgets(p, n, stdin))
 312                 goto end;
 313             if (p[0] == '\0')
 314                 goto end;
 315             i = strlen(p);
 316             if (i <= 1)
 317                 break;
 318             if (p[i - 2] != '\\')
 319                 break;
 320             i -= 2;
 321             p += i;
 322             n -= i;
 323 #else
 324             {
 325                 extern char *readline(const char *);
 326                 extern void add_history(const char *cp);
 327                 char *text;
 328
 329                 text = readline(prompt);
 330                 if (text == NULL)
 331                     goto end;
 332                 i = strlen(text);
 333                 if (i == 0 || i > n)
 334                     break;
 335                 if (text[i - 1] != '\\') {
 336                     p += strlen(strcpy(p, text));
 337                     free(text);
 338                     add_history(buf);
 339                     break;
 340                 }
 341
 342                 text[i - 1] = '\0';
 343                 p += strlen(strcpy(p, text));
 344                 free(text);
 345                 n -= i;
 346             }
 347 #endif
 348         }
 349
 350         if (!chopup_args(&arg, buf)) {
 351             BIO_printf(bio_err, "Can't parse (no memory?)\n");
 352             break;
 353         }
 354
 355         ret = do_cmd(prog, arg.argc, arg.argv);
 356         if (ret == EXIT_THE_PROGRAM) {
 357             ret = 0;
 358             goto end;
 359         }
 360         if (ret != 0)
 361             BIO_printf(bio_err, "error in %s\n", arg.argv[0]);
 362         (void)BIO_flush(bio_out);
 363         (void)BIO_flush(bio_err);
 364     }
 365     ret = 1;
 366  end:
 367     OPENSSL_free(default_config_file);
 368     lh_FUNCTION_free(prog);
 369     OPENSSL_free(arg.argv);
 370     app_RAND_write();
 371
 372     BIO_free(bio_in);
 373     BIO_free_all(bio_out);
 374     apps_shutdown();
 375 #ifndef OPENSSL_NO_CRYPTO_MDEBUG
 376     if (CRYPTO_mem_leaks(bio_err) <= 0)
 377         ret = 1;
 378 #endif
 379     BIO_free(bio_err);
 380     EXIT(ret);
 381 }
 382
 383 typedef enum HELP_CHOICE {
 384     OPT_hERR = -1, OPT_hEOF = 0, OPT_hHELP
 385 } HELP_CHOICE;
 386
 387 const OPTIONS help_options[] = {
 388     {OPT_HELP_STR, 1, '-', "Usage: help [options]\n"},
 389     {OPT_HELP_STR, 1, '-', "       help [command]\n"},
 390     {"help", OPT_hHELP, '-', "Display this summary"},
 391     {NULL}
 392 };
 393
 394
 395 int help_main(int argc, char **argv)
 396 {
 397     FUNCTION *fp;
 398     int i, nl;
 399     FUNC_TYPE tp;
 400     char *prog;
 401     HELP_CHOICE o;
 402     DISPLAY_COLUMNS dc;
 403
 404     prog = opt_init(argc, argv, help_options);
 405     while ((o = opt_next()) != OPT_hEOF) {
 406         switch (o) {
 407         case OPT_hERR:
 408         case OPT_hEOF:
 409             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
 410             return 1;
 411         case OPT_hHELP:
 412             opt_help(help_options);
 413             return 0;
 414         }
 415     }
 416
 417     if (opt_num_rest() == 1) {
 418         char *new_argv[3];
 419
 420         new_argv[0] = opt_rest()[0];
 421         new_argv[1] = "--help";
 422         new_argv[2] = NULL;
 423         return do_cmd(prog_init(), 2, new_argv);
 424     }
 425     if (opt_num_rest() != 0) {
 426         BIO_printf(bio_err, "Usage: %s\n", prog);
 427         return 1;
 428     }
 429
 430     calculate_columns(functions, &dc);
 431     BIO_printf(bio_err, "Standard commands");
 432     i = 0;
 433     tp = FT_none;
 434     for (fp = functions; fp->name != NULL; fp++) {
 435         nl = 0;
 436         if (i++ % dc.columns == 0) {
 437             BIO_printf(bio_err, "\n");
 438             nl = 1;
 439         }
 440         if (fp->type != tp) {
 441             tp = fp->type;
 442             if (!nl)
 443                 BIO_printf(bio_err, "\n");
 444             if (tp == FT_md) {
 445                 i = 1;
 446                 BIO_printf(bio_err,
 447                            "\nMessage Digest commands (see the `dgst' command for more details)\n");
 448             } else if (tp == FT_cipher) {
 449                 i = 1;
 450                 BIO_printf(bio_err,
 451                            "\nCipher commands (see the `enc' command for more details)\n");
 452             }
 453         }
 454         BIO_printf(bio_err, "%-*s", dc.width, fp->name);
 455     }
 456     BIO_printf(bio_err, "\n\n");
 457     return 0;
 458 }
 459
 460 static int do_cmd(LHASH_OF(FUNCTION) *prog, int argc, char *argv[])
 461 {
 462     FUNCTION f, *fp;
 463
 464     if (argc <= 0 || argv[0] == NULL)
 465         return 0;
 466     f.name = argv[0];
 467     fp = lh_FUNCTION_retrieve(prog, &f);
 468     if (fp == NULL) {
 469         if (EVP_get_digestbyname(argv[0])) {
 470             f.type = FT_md;
 471             f.func = dgst_main;
 472             fp = &f;
 473         } else if (EVP_get_cipherbyname(argv[0])) {
 474             f.type = FT_cipher;
 475             f.func = enc_main;
 476             fp = &f;
 477         }
 478     }
 479     if (fp != NULL) {
 480         return fp->func(argc, argv);
 481     }
 482     if ((strncmp(argv[0], "no-", 3)) == 0) {
 483         /*
 484          * User is asking if foo is unsupported, by trying to "run" the
 485          * no-foo command.  Strange.
 486          */
 487         f.name = argv[0] + 3;
 488         if (lh_FUNCTION_retrieve(prog, &f) == NULL) {
 489             BIO_printf(bio_out, "%s\n", argv[0]);
 490             return 0;
 491         }
 492         BIO_printf(bio_out, "%s\n", argv[0] + 3);
 493         return 1;
 494     }
 495     if (strcmp(argv[0], "quit") == 0 || strcmp(argv[0], "q") == 0 ||
 496         strcmp(argv[0], "exit") == 0 || strcmp(argv[0], "bye") == 0)
 497         /* Special value to mean "exit the program. */
 498         return EXIT_THE_PROGRAM;
 499
 500     BIO_printf(bio_err, "Invalid command '%s'; type \"help\" for a list.\n",
 501                argv[0]);
 502     return 1;
 503 }
 504
 505 static int function_cmp(const FUNCTION * a, const FUNCTION * b)
 506 {
 507     return strncmp(a->name, b->name, 8);
 508 }
 509
 510 static unsigned long function_hash(const FUNCTION * a)
 511 {
 512     return OPENSSL_LH_strhash(a->name);
 513 }
 514
 515 static int SortFnByName(const void *_f1, const void *_f2)
 516 {
 517     const FUNCTION *f1 = _f1;
 518     const FUNCTION *f2 = _f2;
 519
 520     if (f1->type != f2->type)
 521         return f1->type - f2->type;
 522     return strcmp(f1->name, f2->name);
 523 }
 524
 525 static LHASH_OF(FUNCTION) *prog_init(void)
 526 {
 527     static LHASH_OF(FUNCTION) *ret = NULL;
 528     static int prog_inited = 0;
 529     FUNCTION *f;
 530     size_t i;
 531
 532     if (prog_inited)
 533         return ret;
 534
 535     prog_inited = 1;
 536
 537     /* Sort alphabetically within category. For nicer help displays. */
 538     for (i = 0, f = functions; f->name != NULL; ++f, ++i)
 539         ;
 540     qsort(functions, i, sizeof(*functions), SortFnByName);
 541
 542     if ((ret = lh_FUNCTION_new(function_hash, function_cmp)) == NULL)
 543         return NULL;
 544
 545     for (f = functions; f->name != NULL; f++)
 546         (void)lh_FUNCTION_insert(ret, f);
 547     return ret;
 548 }