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