1 /*
2 * Copyright 1995-2022 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 <stdio.h>
11 #include <string.h>
12 #include <stdlib.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>
23 #endif
24 #include <openssl/err.h>
25 /* Needed to get the other O_xxx flags. */
26 #ifdef OPENSSL_SYS_VMS
27 # include <unixio.h>
28 #endif
29 #include "apps.h"
30 #include "progs.h"
31
32 /*
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.
37 */
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;
41
42 BIO *bio_in = NULL;
43 BIO *bio_out = NULL;
44 BIO *bio_err = NULL;
45
warn_deprecated(const FUNCTION * fp)46 static void warn_deprecated(const FUNCTION *fp)
47 {
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);
51 else
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");
56 }
57
apps_startup(void)58 static int apps_startup(void)
59 {
60 const char *use_libctx = NULL;
61 #ifdef SIGPIPE
62 signal(SIGPIPE, SIG_IGN);
63 #endif
64
65 /* Set non-default library initialisation settings */
66 if (!OPENSSL_init_ssl(OPENSSL_INIT_ENGINE_ALL_BUILTIN
67 | OPENSSL_INIT_LOAD_CONFIG, NULL))
68 return 0;
69
70 (void)setup_ui_method();
71 (void)setup_engine_loader();
72
73 /*
74 * NOTE: This is an undocumented feature required for testing only.
75 * There are no guarantees that it will exist in future builds.
76 */
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)
82 return 0;
83 }
84 }
85
86 return 1;
87 }
88
apps_shutdown(void)89 static void apps_shutdown(void)
90 {
91 app_providers_cleanup();
92 OSSL_LIB_CTX_free(app_get0_libctx());
93 destroy_engine_loader();
94 destroy_ui_method();
95 }
96
97
98 #ifndef OPENSSL_NO_TRACE
99 typedef struct tracedata_st {
100 BIO *bio;
101 unsigned int ingroup:1;
102 } tracedata;
103
internal_trace_cb(const char * buf,size_t cnt,int category,int cmd,void * vdata)104 static size_t internal_trace_cb(const char *buf, size_t cnt,
105 int category, int cmd, void *vdata)
106 {
107 int ret = 0;
108 tracedata *trace_data = vdata;
109 char buffer[256], *hex;
110 CRYPTO_THREAD_ID tid;
111
112 switch (cmd) {
113 case OSSL_TRACE_CTRL_BEGIN:
114 if (trace_data->ingroup) {
115 BIO_printf(bio_err, "ERROR: tracing already started\n");
116 return 0;
117 }
118 trace_data->ingroup = 1;
119
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));
125 OPENSSL_free(hex);
126 BIO_set_prefix(trace_data->bio, buffer);
127 break;
128 case OSSL_TRACE_CTRL_WRITE:
129 if (!trace_data->ingroup) {
130 BIO_printf(bio_err, "ERROR: writing when tracing not started\n");
131 return 0;
132 }
133
134 ret = BIO_write(trace_data->bio, buf, cnt);
135 break;
136 case OSSL_TRACE_CTRL_END:
137 if (!trace_data->ingroup) {
138 BIO_printf(bio_err, "ERROR: finishing when tracing not started\n");
139 return 0;
140 }
141 trace_data->ingroup = 0;
142
143 BIO_set_prefix(trace_data->bio, NULL);
144
145 break;
146 }
147
148 return ret < 0 ? 0 : ret;
149 }
150
151 DEFINE_STACK_OF(tracedata)
152 static STACK_OF(tracedata) *trace_data_stack;
153
tracedata_free(tracedata * data)154 static void tracedata_free(tracedata *data)
155 {
156 BIO_free_all(data->bio);
157 OPENSSL_free(data);
158 }
159
STACK_OF(tracedata)160 static STACK_OF(tracedata) *trace_data_stack;
161
162 static void cleanup_trace(void)
163 {
164 sk_tracedata_pop_free(trace_data_stack, tracedata_free);
165 }
166
setup_trace_category(int category)167 static void setup_trace_category(int category)
168 {
169 BIO *channel;
170 tracedata *trace_data;
171 BIO *bio = NULL;
172
173 if (OSSL_trace_enabled(category))
174 return;
175
176 bio = BIO_new(BIO_f_prefix());
177 channel = BIO_push(bio, dup_bio_err(FORMAT_TEXT));
178 trace_data = OPENSSL_zalloc(sizeof(*trace_data));
179
180 if (trace_data == NULL
181 || bio == NULL
182 || (trace_data->bio = channel) == NULL
183 || OSSL_trace_set_callback(category, internal_trace_cb,
184 trace_data) == 0
185 || sk_tracedata_push(trace_data_stack, trace_data) == 0) {
186
187 fprintf(stderr,
188 "warning: unable to setup trace callback for category '%s'.\n",
189 OSSL_trace_get_category_name(category));
190
191 OSSL_trace_set_callback(category, NULL, NULL);
192 BIO_free_all(channel);
193 }
194 }
195
setup_trace(const char * str)196 static void setup_trace(const char *str)
197 {
198 char *val;
199
200 /*
201 * We add this handler as early as possible to ensure it's executed
202 * as late as possible, i.e. after the TRACE code has done its cleanup
203 * (which happens last in OPENSSL_cleanup).
204 */
205 atexit(cleanup_trace);
206
207 trace_data_stack = sk_tracedata_new_null();
208 val = OPENSSL_strdup(str);
209
210 if (val != NULL) {
211 char *valp = val;
212 char *item;
213
214 for (valp = val; (item = strtok(valp, ",")) != NULL; valp = NULL) {
215 int category = OSSL_trace_get_category_num(item);
216
217 if (category == OSSL_TRACE_CATEGORY_ALL) {
218 while (++category < OSSL_TRACE_CATEGORY_NUM)
219 setup_trace_category(category);
220 break;
221 } else if (category > 0) {
222 setup_trace_category(category);
223 } else {
224 fprintf(stderr,
225 "warning: unknown trace category: '%s'.\n", item);
226 }
227 }
228 }
229
230 OPENSSL_free(val);
231 }
232 #endif /* OPENSSL_NO_TRACE */
233
234 static char *help_argv[] = { "help", NULL };
235
main(int argc,char * argv[])236 int main(int argc, char *argv[])
237 {
238 FUNCTION f, *fp;
239 LHASH_OF(FUNCTION) *prog = NULL;
240 char *pname;
241 const char *fname;
242 ARGS arg;
243 int global_help = 0;
244 int ret = 0;
245
246 arg.argv = NULL;
247 arg.size = 0;
248
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);
253
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);
259 #endif
260
261 #ifndef OPENSSL_NO_TRACE
262 setup_trace(getenv("OPENSSL_TRACE"));
263 #endif
264
265 if ((fname = "apps_startup", !apps_startup())
266 || (fname = "prog_init", (prog = prog_init()) == NULL)) {
267 BIO_printf(bio_err,
268 "FATAL: Startup failure (dev note: %s()) for %s\n",
269 fname, argv[0]);
270 ERR_print_errors(bio_err);
271 ret = 1;
272 goto end;
273 }
274 pname = opt_progname(argv[0]);
275
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);
279
280 /* first check the program name */
281 f.name = pname;
282 fp = lh_FUNCTION_retrieve(prog, &f);
283 if (fp == NULL) {
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 argc--;
289 argv++;
290 opt_appname(argc == 1 || global_help ? "help" : argv[0]);
291 } else {
292 argv[0] = pname;
293 }
294
295 /* If there's a command, run with that, otherwise "help". */
296 ret = argc == 0 || global_help
297 ? do_cmd(prog, 1, help_argv)
298 : do_cmd(prog, argc, argv);
299
300 end:
301 OPENSSL_free(default_config_file);
302 lh_FUNCTION_free(prog);
303 OPENSSL_free(arg.argv);
304 if (!app_RAND_write())
305 ret = EXIT_FAILURE;
306
307 BIO_free(bio_in);
308 BIO_free_all(bio_out);
309 apps_shutdown();
310 BIO_free_all(bio_err);
311 EXIT(ret);
312 }
313
314 typedef enum HELP_CHOICE {
315 OPT_hERR = -1, OPT_hEOF = 0, OPT_hHELP
316 } HELP_CHOICE;
317
318 const OPTIONS help_options[] = {
319 {OPT_HELP_STR, 1, '-', "Usage: help [options] [command]\n"},
320
321 OPT_SECTION("General"),
322 {"help", OPT_hHELP, '-', "Display this summary"},
323
324 OPT_PARAMETERS(),
325 {"command", 0, 0, "Name of command to display help (optional)"},
326 {NULL}
327 };
328
329
help_main(int argc,char ** argv)330 int help_main(int argc, char **argv)
331 {
332 FUNCTION *fp;
333 int i, nl;
334 FUNC_TYPE tp;
335 char *prog;
336 HELP_CHOICE o;
337 DISPLAY_COLUMNS dc;
338 char *new_argv[3];
339
340 prog = opt_init(argc, argv, help_options);
341 while ((o = opt_next()) != OPT_hEOF) {
342 switch (o) {
343 case OPT_hERR:
344 case OPT_hEOF:
345 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
346 return 1;
347 case OPT_hHELP:
348 opt_help(help_options);
349 return 0;
350 }
351 }
352
353 /* One optional argument, the command to get help for. */
354 if (opt_num_rest() == 1) {
355 new_argv[0] = opt_rest()[0];
356 new_argv[1] = "--help";
357 new_argv[2] = NULL;
358 return do_cmd(prog_init(), 2, new_argv);
359 }
360 if (opt_num_rest() != 0) {
361 BIO_printf(bio_err, "Usage: %s\n", prog);
362 return 1;
363 }
364
365 calculate_columns(functions, &dc);
366 BIO_printf(bio_err, "%s:\n\nStandard commands", prog);
367 i = 0;
368 tp = FT_none;
369 for (fp = functions; fp->name != NULL; fp++) {
370 nl = 0;
371 if (i++ % dc.columns == 0) {
372 BIO_printf(bio_err, "\n");
373 nl = 1;
374 }
375 if (fp->type != tp) {
376 tp = fp->type;
377 if (!nl)
378 BIO_printf(bio_err, "\n");
379 if (tp == FT_md) {
380 i = 1;
381 BIO_printf(bio_err,
382 "\nMessage Digest commands (see the `dgst' command for more details)\n");
383 } else if (tp == FT_cipher) {
384 i = 1;
385 BIO_printf(bio_err,
386 "\nCipher commands (see the `enc' command for more details)\n");
387 }
388 }
389 BIO_printf(bio_err, "%-*s", dc.width, fp->name);
390 }
391 BIO_printf(bio_err, "\n\n");
392 return 0;
393 }
394
do_cmd(LHASH_OF (FUNCTION)* prog,int argc,char * argv[])395 static int do_cmd(LHASH_OF(FUNCTION) *prog, int argc, char *argv[])
396 {
397 FUNCTION f, *fp;
398
399 if (argc <= 0 || argv[0] == NULL)
400 return 0;
401 memset(&f, 0, sizeof(f));
402 f.name = argv[0];
403 fp = lh_FUNCTION_retrieve(prog, &f);
404 if (fp == NULL) {
405 if (EVP_get_digestbyname(argv[0])) {
406 f.type = FT_md;
407 f.func = dgst_main;
408 fp = &f;
409 } else if (EVP_get_cipherbyname(argv[0])) {
410 f.type = FT_cipher;
411 f.func = enc_main;
412 fp = &f;
413 }
414 }
415 if (fp != NULL) {
416 if (fp->deprecated_alternative != NULL)
417 warn_deprecated(fp);
418 return fp->func(argc, argv);
419 }
420 if ((strncmp(argv[0], "no-", 3)) == 0) {
421 /*
422 * User is asking if foo is unsupported, by trying to "run" the
423 * no-foo command. Strange.
424 */
425 f.name = argv[0] + 3;
426 if (lh_FUNCTION_retrieve(prog, &f) == NULL) {
427 BIO_printf(bio_out, "%s\n", argv[0]);
428 return 0;
429 }
430 BIO_printf(bio_out, "%s\n", argv[0] + 3);
431 return 1;
432 }
433
434 BIO_printf(bio_err, "Invalid command '%s'; type \"help\" for a list.\n",
435 argv[0]);
436 return 1;
437 }
438
function_cmp(const FUNCTION * a,const FUNCTION * b)439 static int function_cmp(const FUNCTION * a, const FUNCTION * b)
440 {
441 return strncmp(a->name, b->name, 8);
442 }
443
function_hash(const FUNCTION * a)444 static unsigned long function_hash(const FUNCTION * a)
445 {
446 return OPENSSL_LH_strhash(a->name);
447 }
448
SortFnByName(const void * _f1,const void * _f2)449 static int SortFnByName(const void *_f1, const void *_f2)
450 {
451 const FUNCTION *f1 = _f1;
452 const FUNCTION *f2 = _f2;
453
454 if (f1->type != f2->type)
455 return f1->type - f2->type;
456 return strcmp(f1->name, f2->name);
457 }
458
LHASH_OF(FUNCTION)459 static LHASH_OF(FUNCTION) *prog_init(void)
460 {
461 static LHASH_OF(FUNCTION) *ret = NULL;
462 static int prog_inited = 0;
463 FUNCTION *f;
464 size_t i;
465
466 if (prog_inited)
467 return ret;
468
469 prog_inited = 1;
470
471 /* Sort alphabetically within category. For nicer help displays. */
472 for (i = 0, f = functions; f->name != NULL; ++f, ++i)
473 ;
474 qsort(functions, i, sizeof(*functions), SortFnByName);
475
476 if ((ret = lh_FUNCTION_new(function_hash, function_cmp)) == NULL)
477 return NULL;
478
479 for (f = functions; f->name != NULL; f++)
480 (void)lh_FUNCTION_insert(ret, f);
481 return ret;
482 }
483