2 * Copyright 1995-2023 The OpenSSL Project Authors. All Rights Reserved.
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
12 #include "internal/common.h"
13 #include <openssl/bio.h>
14 #include <openssl/crypto.h>
15 #include <openssl/trace.h>
16 #include <openssl/lhash.h>
17 #include <openssl/conf.h>
18 #include <openssl/x509.h>
19 #include <openssl/pem.h>
20 #include <openssl/ssl.h>
21 #ifndef OPENSSL_NO_ENGINE
22 # include <openssl/engine.h>
24 #include <openssl/err.h>
25 /* Needed to get the other O_xxx flags. */
26 #ifdef OPENSSL_SYS_VMS
33 * The LHASH callbacks ("hash" & "cmp") have been replaced by functions with
34 * the base prototypes (we cast each variable inside the function to the
35 * required type of "FUNCTION*"). This removes the necessity for
36 * macro-generated wrapper functions.
38 static LHASH_OF(FUNCTION) *prog_init(void);
39 static int do_cmd(LHASH_OF(FUNCTION) *prog, int argc, char *argv[]);
40 char *default_config_file = NULL;
46 static void warn_deprecated(const FUNCTION *fp)
48 if (fp->deprecated_version != NULL)
49 BIO_printf(bio_err, "The command %s was deprecated in version %s.",
50 fp->name, fp->deprecated_version);
52 BIO_printf(bio_err, "The command %s is deprecated.", fp->name);
53 if (strcmp(fp->deprecated_alternative, DEPRECATED_NO_ALTERNATIVE) != 0)
54 BIO_printf(bio_err, " Use '%s' instead.", fp->deprecated_alternative);
55 BIO_printf(bio_err, "\n");
58 static int apps_startup(void)
60 const char *use_libctx = NULL;
62 signal(SIGPIPE, SIG_IGN);
65 /* Set non-default library initialisation settings */
66 if (!OPENSSL_init_ssl(OPENSSL_INIT_ENGINE_ALL_BUILTIN
67 | OPENSSL_INIT_LOAD_CONFIG, NULL))
70 (void)setup_ui_method();
71 (void)setup_engine_loader();
74 * NOTE: This is an undocumented feature required for testing only.
75 * There are no guarantees that it will exist in future builds.
77 use_libctx = getenv("OPENSSL_TEST_LIBCTX");
78 if (use_libctx != NULL) {
79 /* Set this to "1" to create a global libctx */
80 if (strcmp(use_libctx, "1") == 0) {
81 if (app_create_libctx() == NULL)
89 static void apps_shutdown(void)
91 app_providers_cleanup();
92 OSSL_LIB_CTX_free(app_get0_libctx());
93 destroy_engine_loader();
98 #ifndef OPENSSL_NO_TRACE
99 typedef struct tracedata_st {
101 unsigned int ingroup:1;
104 static size_t internal_trace_cb(const char *buf, size_t cnt,
105 int category, int cmd, void *vdata)
108 tracedata *trace_data = vdata;
109 char buffer[256], *hex;
110 CRYPTO_THREAD_ID tid;
113 case OSSL_TRACE_CTRL_BEGIN:
114 if (trace_data->ingroup) {
115 BIO_printf(bio_err, "ERROR: tracing already started\n");
118 trace_data->ingroup = 1;
120 tid = CRYPTO_THREAD_get_current_id();
121 hex = OPENSSL_buf2hexstr((const unsigned char *)&tid, sizeof(tid));
122 BIO_snprintf(buffer, sizeof(buffer), "TRACE[%s]:%s: ",
123 hex == NULL ? "<null>" : hex,
124 OSSL_trace_get_category_name(category));
126 BIO_set_prefix(trace_data->bio, buffer);
128 case OSSL_TRACE_CTRL_WRITE:
129 if (!trace_data->ingroup) {
130 BIO_printf(bio_err, "ERROR: writing when tracing not started\n");
134 ret = BIO_write(trace_data->bio, buf, cnt);
136 case OSSL_TRACE_CTRL_END:
137 if (!trace_data->ingroup) {
138 BIO_printf(bio_err, "ERROR: finishing when tracing not started\n");
141 trace_data->ingroup = 0;
143 BIO_set_prefix(trace_data->bio, NULL);
148 return ret < 0 ? 0 : ret;
151 DEFINE_STACK_OF(tracedata)
152 static STACK_OF(tracedata) *trace_data_stack;
154 static void tracedata_free(tracedata *data)
156 BIO_free_all(data->bio);
160 static void cleanup_trace(void)
162 sk_tracedata_pop_free(trace_data_stack, tracedata_free);
165 static void setup_trace_category(int category)
168 tracedata *trace_data;
171 if (OSSL_trace_enabled(category))
174 bio = BIO_new(BIO_f_prefix());
175 channel = BIO_push(bio, dup_bio_err(FORMAT_TEXT));
176 trace_data = OPENSSL_zalloc(sizeof(*trace_data));
178 if (trace_data == NULL
180 || (trace_data->bio = channel) == NULL
181 || OSSL_trace_set_callback(category, internal_trace_cb,
183 || sk_tracedata_push(trace_data_stack, trace_data) == 0) {
186 "warning: unable to setup trace callback for category '%s'.\n",
187 OSSL_trace_get_category_name(category));
189 OSSL_trace_set_callback(category, NULL, NULL);
190 BIO_free_all(channel);
194 static void setup_trace(const char *str)
199 * We add this handler as early as possible to ensure it's executed
200 * as late as possible, i.e. after the TRACE code has done its cleanup
201 * (which happens last in OPENSSL_cleanup).
203 atexit(cleanup_trace);
205 trace_data_stack = sk_tracedata_new_null();
206 val = OPENSSL_strdup(str);
212 for (valp = val; (item = strtok(valp, ",")) != NULL; valp = NULL) {
213 int category = OSSL_trace_get_category_num(item);
215 if (category == OSSL_TRACE_CATEGORY_ALL) {
216 while (++category < OSSL_TRACE_CATEGORY_NUM)
217 setup_trace_category(category);
219 } else if (category > 0) {
220 setup_trace_category(category);
223 "warning: unknown trace category: '%s'.\n", item);
230 #endif /* OPENSSL_NO_TRACE */
232 static char *help_argv[] = { "help", NULL };
233 static char *version_argv[] = { "version", NULL };
235 int main(int argc, char *argv[])
238 LHASH_OF(FUNCTION) *prog = NULL;
243 int global_version = 0;
249 /* Set up some of the environment. */
250 bio_in = dup_bio_in(FORMAT_TEXT);
251 bio_out = dup_bio_out(FORMAT_TEXT);
252 bio_err = dup_bio_err(FORMAT_TEXT);
254 #if defined(OPENSSL_SYS_VMS) && defined(__DECC)
255 argv = copy_argv(&argc, argv);
256 #elif defined(_WIN32)
257 /* Replace argv[] with UTF-8 encoded strings. */
258 win32_utf8argv(&argc, &argv);
261 #ifndef OPENSSL_NO_TRACE
262 setup_trace(getenv("OPENSSL_TRACE"));
265 if ((fname = "apps_startup", !apps_startup())
266 || (fname = "prog_init", (prog = prog_init()) == NULL)) {
268 "FATAL: Startup failure (dev note: %s()) for %s\n",
270 ERR_print_errors(bio_err);
274 pname = opt_progname(argv[0]);
276 default_config_file = CONF_get1_default_config_file();
277 if (default_config_file == NULL)
278 app_bail_out("%s: could not get default config file\n", pname);
280 /* first check the program name */
282 fp = lh_FUNCTION_retrieve(prog, &f);
284 /* We assume we've been called as 'openssl ...' */
285 global_help = argc > 1
286 && (strcmp(argv[1], "-help") == 0 || strcmp(argv[1], "--help") == 0
287 || strcmp(argv[1], "-h") == 0 || strcmp(argv[1], "--h") == 0);
288 global_version = argc > 1
289 && (strcmp(argv[1], "-version") == 0 || strcmp(argv[1], "--version") == 0
290 || strcmp(argv[1], "-v") == 0 || strcmp(argv[1], "--v") == 0);
294 opt_appname(argc == 1 || global_help ? "help" : global_version ? "version" : argv[0]);
300 * If there's no command, assume "help". If there's an override for help
301 * or version run those, otherwise run the command given.
303 ret = (argc == 0) || global_help
304 ? do_cmd(prog, 1, help_argv)
306 ? do_cmd(prog, 1, version_argv)
307 : do_cmd(prog, argc, argv);
310 OPENSSL_free(default_config_file);
311 lh_FUNCTION_free(prog);
312 OPENSSL_free(arg.argv);
313 if (!app_RAND_write())
317 BIO_free_all(bio_out);
319 BIO_free_all(bio_err);
323 typedef enum HELP_CHOICE {
324 OPT_hERR = -1, OPT_hEOF = 0, OPT_hHELP
327 const OPTIONS help_options[] = {
328 {OPT_HELP_STR, 1, '-', "Usage: help [options] [command]\n"},
330 OPT_SECTION("General"),
331 {"help", OPT_hHELP, '-', "Display this summary"},
334 {"command", 0, 0, "Name of command to display help (optional)"},
338 int help_main(int argc, char **argv)
348 prog = opt_init(argc, argv, help_options);
349 while ((o = opt_next()) != OPT_hEOF) {
353 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
356 opt_help(help_options);
361 /* One optional argument, the command to get help for. */
362 if (opt_num_rest() == 1) {
363 new_argv[0] = opt_rest()[0];
364 new_argv[1] = "--help";
366 return do_cmd(prog_init(), 2, new_argv);
368 if (!opt_check_rest_arg(NULL)) {
369 BIO_printf(bio_err, "Usage: %s\n", prog);
373 calculate_columns(functions, &dc);
374 BIO_printf(bio_err, "%s:\n\nStandard commands", prog);
377 for (fp = functions; fp->name != NULL; fp++) {
379 if (i++ % dc.columns == 0) {
380 BIO_printf(bio_err, "\n");
383 if (fp->type != tp) {
386 BIO_printf(bio_err, "\n");
390 "\nMessage Digest commands (see the `dgst' command for more details)\n");
391 } else if (tp == FT_cipher) {
394 "\nCipher commands (see the `enc' command for more details)\n");
397 BIO_printf(bio_err, "%-*s", dc.width, fp->name);
399 BIO_printf(bio_err, "\n\n");
403 static int do_cmd(LHASH_OF(FUNCTION) *prog, int argc, char *argv[])
407 if (argc <= 0 || argv[0] == NULL)
409 memset(&f, 0, sizeof(f));
411 fp = lh_FUNCTION_retrieve(prog, &f);
413 if (EVP_get_digestbyname(argv[0])) {
417 } else if (EVP_get_cipherbyname(argv[0])) {
424 if (fp->deprecated_alternative != NULL)
426 return fp->func(argc, argv);
429 if (CHECK_AND_SKIP_PREFIX(f.name, "no-")) {
431 * User is asking if foo is unsupported, by trying to "run" the
432 * no-foo command. Strange.
434 if (lh_FUNCTION_retrieve(prog, &f) == NULL) {
435 BIO_printf(bio_out, "%s\n", argv[0]);
438 BIO_printf(bio_out, "%s\n", argv[0] + 3);
442 BIO_printf(bio_err, "Invalid command '%s'; type \"help\" for a list.\n",
447 static int function_cmp(const FUNCTION *a, const FUNCTION *b)
449 return strncmp(a->name, b->name, 8);
452 static unsigned long function_hash(const FUNCTION *a)
454 return OPENSSL_LH_strhash(a->name);
457 static int SortFnByName(const void *_f1, const void *_f2)
459 const FUNCTION *f1 = _f1;
460 const FUNCTION *f2 = _f2;
462 if (f1->type != f2->type)
463 return f1->type - f2->type;
464 return strcmp(f1->name, f2->name);
467 static LHASH_OF(FUNCTION) *prog_init(void)
469 static LHASH_OF(FUNCTION) *ret = NULL;
470 static int prog_inited = 0;
479 /* Sort alphabetically within category. For nicer help displays. */
480 for (i = 0, f = functions; f->name != NULL; ++f, ++i)
482 qsort(functions, i, sizeof(*functions), SortFnByName);
484 if ((ret = lh_FUNCTION_new(function_hash, function_cmp)) == NULL)
487 for (f = functions; f->name != NULL; f++)
488 (void)lh_FUNCTION_insert(ret, f);