apps/openssl.c: UTF-y Windows argv.
[openssl.git] / apps / openssl.c
1 /*
2  * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (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/lhash.h>
16 #include <openssl/conf.h>
17 #include <openssl/x509.h>
18 #include <openssl/pem.h>
19 #include <openssl/ssl.h>
20 #ifndef OPENSSL_NO_ENGINE
21 # include <openssl/engine.h>
22 #endif
23 #include <openssl/err.h>
24 #ifdef OPENSSL_FIPS
25 # include <openssl/fips.h>
26 #endif
27 #define USE_SOCKETS /* needed for the _O_BINARY defs in the MS world */
28 #include "s_apps.h"
29 /* Needed to get the other O_xxx flags. */
30 #ifdef OPENSSL_SYS_VMS
31 # include <unixio.h>
32 #endif
33 #define INCLUDE_FUNCTION_TABLE
34 #include "apps.h"
35
36
37 #ifdef OPENSSL_NO_CAMELLIA
38 # define FORMAT "%-15s"
39 # define COLUMNS 5
40 #else
41 # define FORMAT "%-18s"
42 # define COLUMNS 4
43 #endif
44
45 /* Special sentinel to exit the program. */
46 #define EXIT_THE_PROGRAM (-1)
47
48 /*
49  * The LHASH callbacks ("hash" & "cmp") have been replaced by functions with
50  * the base prototypes (we cast each variable inside the function to the
51  * required type of "FUNCTION*"). This removes the necessity for
52  * macro-generated wrapper functions.
53  */
54 static LHASH_OF(FUNCTION) *prog_init(void);
55 static int do_cmd(LHASH_OF(FUNCTION) *prog, int argc, char *argv[]);
56 static void list_pkey(void);
57 static void list_type(FUNC_TYPE ft);
58 static void list_disabled(void);
59 char *default_config_file = NULL;
60
61 static CONF *config = NULL;
62 BIO *bio_in = NULL;
63 BIO *bio_out = NULL;
64 BIO *bio_err = NULL;
65
66 static int apps_startup()
67 {
68 #ifdef SIGPIPE
69     signal(SIGPIPE, SIG_IGN);
70 #endif
71
72     /* Set non-default library initialisation settings */
73     if (!OPENSSL_init_crypto(OPENSSL_INIT_ENGINE_ALL_BUILTIN
74                              | OPENSSL_INIT_LOAD_CONFIG, NULL))
75         return 0;
76
77 #ifndef OPENSSL_NO_UI
78     setup_ui_method();
79 #endif
80
81     return 1;
82 }
83
84 static void apps_shutdown()
85 {
86 #ifndef OPENSSL_NO_UI
87     destroy_ui_method();
88 #endif
89 }
90
91 static char *make_config_name()
92 {
93     const char *t;
94     size_t len;
95     char *p;
96
97     if ((t = getenv("OPENSSL_CONF")) != NULL)
98         return OPENSSL_strdup(t);
99
100     t = X509_get_default_cert_area();
101     len = strlen(t) + 1 + strlen(OPENSSL_CONF) + 1;
102     p = app_malloc(len, "config filename buffer");
103     strcpy(p, t);
104 #ifndef OPENSSL_SYS_VMS
105     strcat(p, "/");
106 #endif
107     strcat(p, OPENSSL_CONF);
108
109     return p;
110 }
111
112 int main(int argc, char *argv[])
113 {
114     FUNCTION f, *fp;
115     LHASH_OF(FUNCTION) *prog = NULL;
116     char **copied_argv = NULL;
117     char *p, *pname;
118     char buf[1024];
119     const char *prompt;
120     ARGS arg;
121     int first, n, i, ret = 0;
122
123     arg.argv = NULL;
124     arg.size = 0;
125
126     /* Set up some of the environment. */
127     default_config_file = make_config_name();
128     bio_in = dup_bio_in(FORMAT_TEXT);
129     bio_out = dup_bio_out(FORMAT_TEXT);
130     bio_err = dup_bio_err(FORMAT_TEXT);
131
132 #if defined(OPENSSL_SYS_VMS) && defined(__DECC)
133     copied_argv = argv = copy_argv(&argc, argv);
134 #elif defined(_WIN32)
135     /*
136      * Replace argv[] with UTF-8 encoded strings.
137      */
138     win32_utf8argv(&argc, &argv);
139 #endif
140
141     p = getenv("OPENSSL_DEBUG_MEMORY");
142     if (p != NULL && strcmp(p, "on") == 0)
143         CRYPTO_set_mem_debug(1);
144     CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON);
145
146     if (getenv("OPENSSL_FIPS")) {
147 #ifdef OPENSSL_FIPS
148         if (!FIPS_mode_set(1)) {
149             ERR_print_errors(bio_err);
150             return 1;
151         }
152 #else
153         BIO_printf(bio_err, "FIPS mode not supported.\n");
154         return 1;
155 #endif
156     }
157
158     if (!apps_startup())
159         goto end;
160
161     prog = prog_init();
162     pname = opt_progname(argv[0]);
163
164     /* first check the program name */
165     f.name = pname;
166     fp = lh_FUNCTION_retrieve(prog, &f);
167     if (fp != NULL) {
168         argv[0] = pname;
169         ret = fp->func(argc, argv);
170         goto end;
171     }
172
173     /* If there is stuff on the command line, run with that. */
174     if (argc != 1) {
175         argc--;
176         argv++;
177         ret = do_cmd(prog, argc, argv);
178         if (ret < 0)
179             ret = 0;
180         goto end;
181     }
182
183     /* ok, lets enter interactive mode */
184     for (;;) {
185         ret = 0;
186         /* Read a line, continue reading if line ends with \ */
187         for (p = buf, n = sizeof buf, i = 0, first = 1; n > 0; first = 0) {
188             prompt = first ? "OpenSSL> " : "> ";
189             p[0] = '\0';
190 #ifndef READLINE
191             fputs(prompt, stdout);
192             fflush(stdout);
193             if (!fgets(p, n, stdin))
194                 goto end;
195             if (p[0] == '\0')
196                 goto end;
197             i = strlen(p);
198             if (i <= 1)
199                 break;
200             if (p[i - 2] != '\\')
201                 break;
202             i -= 2;
203             p += i;
204             n -= i;
205 #else
206             {
207                 extern char *readline(const char *);
208                 extern void add_history(const char *cp);
209                 char *text;
210
211                 text = readline(prompt);
212                 if (text == NULL)
213                     goto end;
214                 i = strlen(text);
215                 if (i == 0 || i > n)
216                     break;
217                 if (text[i - 1] != '\\') {
218                     p += strlen(strcpy(p, text));
219                     free(text);
220                     add_history(buf);
221                     break;
222                 }
223
224                 text[i - 1] = '\0';
225                 p += strlen(strcpy(p, text));
226                 free(text);
227                 n -= i;
228             }
229 #endif
230         }
231
232         if (!chopup_args(&arg, buf)) {
233             BIO_printf(bio_err, "Can't parse (no memory?)\n");
234             break;
235         }
236
237         ret = do_cmd(prog, arg.argc, arg.argv);
238         if (ret == EXIT_THE_PROGRAM) {
239             ret = 0;
240             goto end;
241         }
242         if (ret != 0)
243             BIO_printf(bio_err, "error in %s\n", arg.argv[0]);
244         (void)BIO_flush(bio_out);
245         (void)BIO_flush(bio_err);
246     }
247     ret = 1;
248  end:
249     OPENSSL_free(copied_argv);
250     OPENSSL_free(default_config_file);
251     NCONF_free(config);
252     config = NULL;
253     lh_FUNCTION_free(prog);
254     OPENSSL_free(arg.argv);
255
256     BIO_free(bio_in);
257     BIO_free_all(bio_out);
258     apps_shutdown();
259 #ifndef OPENSSL_NO_CRYPTO_MDEBUG
260     if (CRYPTO_mem_leaks(bio_err) <= 0)
261         ret = 1;
262 #endif
263     BIO_free(bio_err);
264     EXIT(ret);
265 }
266
267 OPTIONS exit_options[] = {
268     {NULL}
269 };
270
271 static void list_cipher_fn(const EVP_CIPHER *c,
272                            const char *from, const char *to, void *arg)
273 {
274     if (c)
275         BIO_printf(arg, "%s\n", EVP_CIPHER_name(c));
276     else {
277         if (!from)
278             from = "<undefined>";
279         if (!to)
280             to = "<undefined>";
281         BIO_printf(arg, "%s => %s\n", from, to);
282     }
283 }
284
285 static void list_md_fn(const EVP_MD *m,
286                        const char *from, const char *to, void *arg)
287 {
288     if (m)
289         BIO_printf(arg, "%s\n", EVP_MD_name(m));
290     else {
291         if (!from)
292             from = "<undefined>";
293         if (!to)
294             to = "<undefined>";
295         BIO_printf((BIO *)arg, "%s => %s\n", from, to);
296     }
297 }
298
299 /* Unified enum for help and list commands. */
300 typedef enum HELPLIST_CHOICE {
301     OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
302     OPT_COMMANDS, OPT_DIGEST_COMMANDS,
303     OPT_DIGEST_ALGORITHMS, OPT_CIPHER_COMMANDS, OPT_CIPHER_ALGORITHMS,
304     OPT_PK_ALGORITHMS, OPT_DISABLED
305 } HELPLIST_CHOICE;
306
307 OPTIONS list_options[] = {
308     {"help", OPT_HELP, '-', "Display this summary"},
309     {"commands", OPT_COMMANDS, '-', "List of standard commands"},
310     {"digest-commands", OPT_DIGEST_COMMANDS, '-',
311      "List of message digest commands"},
312     {"digest-algorithms", OPT_DIGEST_ALGORITHMS, '-',
313      "List of message digest algorithms"},
314     {"cipher-commands", OPT_CIPHER_COMMANDS, '-', "List of cipher commands"},
315     {"cipher-algorithms", OPT_CIPHER_ALGORITHMS, '-',
316      "List of cipher algorithms"},
317     {"public-key-algorithms", OPT_PK_ALGORITHMS, '-',
318      "List of public key algorithms"},
319     {"disabled", OPT_DISABLED, '-',
320      "List of disabled features"},
321     {NULL}
322 };
323
324 int list_main(int argc, char **argv)
325 {
326     char *prog;
327     HELPLIST_CHOICE o;
328     int done = 0;
329
330     prog = opt_init(argc, argv, list_options);
331     while ((o = opt_next()) != OPT_EOF) {
332         switch (o) {
333         case OPT_EOF:  /* Never hit, but suppresses warning */
334         case OPT_ERR:
335             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
336             return 1;
337         case OPT_HELP:
338             opt_help(list_options);
339             break;
340         case OPT_COMMANDS:
341             list_type(FT_general);
342             break;
343         case OPT_DIGEST_COMMANDS:
344             list_type(FT_md);
345             break;
346         case OPT_DIGEST_ALGORITHMS:
347             EVP_MD_do_all_sorted(list_md_fn, bio_out);
348             break;
349         case OPT_CIPHER_COMMANDS:
350             list_type(FT_cipher);
351             break;
352         case OPT_CIPHER_ALGORITHMS:
353             EVP_CIPHER_do_all_sorted(list_cipher_fn, bio_out);
354             break;
355         case OPT_PK_ALGORITHMS:
356             list_pkey();
357             break;
358         case OPT_DISABLED:
359             list_disabled();
360             break;
361         }
362         done = 1;
363     }
364
365     if (!done) {
366         BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
367         return 1;
368     }
369
370     return 0;
371 }
372
373 OPTIONS help_options[] = {
374     {"help", OPT_HELP, '-', "Display this summary"},
375     {NULL}
376 };
377
378 int help_main(int argc, char **argv)
379 {
380     FUNCTION *fp;
381     int i, nl;
382     FUNC_TYPE tp;
383     char *prog;
384     HELPLIST_CHOICE o;
385
386     prog = opt_init(argc, argv, help_options);
387     while ((o = opt_next()) != OPT_EOF) {
388         switch (o) {
389         default:
390             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
391             return 1;
392         case OPT_HELP:
393             opt_help(help_options);
394             return 0;
395         }
396     }
397
398     if (opt_num_rest() != 0) {
399         BIO_printf(bio_err, "Usage: %s\n", prog);
400         return 1;
401     }
402
403     BIO_printf(bio_err, "\nStandard commands");
404     i = 0;
405     tp = FT_none;
406     for (fp = functions; fp->name != NULL; fp++) {
407         nl = 0;
408         if (((i++) % COLUMNS) == 0) {
409             BIO_printf(bio_err, "\n");
410             nl = 1;
411         }
412         if (fp->type != tp) {
413             tp = fp->type;
414             if (!nl)
415                 BIO_printf(bio_err, "\n");
416             if (tp == FT_md) {
417                 i = 1;
418                 BIO_printf(bio_err,
419                            "\nMessage Digest commands (see the `dgst' command for more details)\n");
420             } else if (tp == FT_cipher) {
421                 i = 1;
422                 BIO_printf(bio_err,
423                            "\nCipher commands (see the `enc' command for more details)\n");
424             }
425         }
426         BIO_printf(bio_err, FORMAT, fp->name);
427     }
428     BIO_printf(bio_err, "\n\n");
429     return 0;
430 }
431
432 int exit_main(int argc, char **argv)
433 {
434     return EXIT_THE_PROGRAM;
435 }
436
437 static void list_type(FUNC_TYPE ft)
438 {
439     FUNCTION *fp;
440     int i = 0;
441
442     for (fp = functions; fp->name != NULL; fp++)
443         if (fp->type == ft) {
444             if ((i++ % COLUMNS) == 0)
445                 BIO_printf(bio_out, "\n");
446             BIO_printf(bio_out, FORMAT, fp->name);
447         }
448     BIO_printf(bio_out, "\n");
449 }
450
451 static int do_cmd(LHASH_OF(FUNCTION) *prog, int argc, char *argv[])
452 {
453     FUNCTION f, *fp;
454
455     if (argc <= 0 || argv[0] == NULL)
456         return (0);
457     f.name = argv[0];
458     fp = lh_FUNCTION_retrieve(prog, &f);
459     if (fp == NULL) {
460         if (EVP_get_digestbyname(argv[0])) {
461             f.type = FT_md;
462             f.func = dgst_main;
463             fp = &f;
464         } else if (EVP_get_cipherbyname(argv[0])) {
465             f.type = FT_cipher;
466             f.func = enc_main;
467             fp = &f;
468         }
469     }
470     if (fp != NULL) {
471         return (fp->func(argc, argv));
472     }
473     if ((strncmp(argv[0], "no-", 3)) == 0) {
474         /*
475          * User is asking if foo is unsupported, by trying to "run" the
476          * no-foo command.  Strange.
477          */
478         f.name = argv[0] + 3;
479         if (lh_FUNCTION_retrieve(prog, &f) == NULL) {
480             BIO_printf(bio_out, "%s\n", argv[0]);
481             return (0);
482         }
483         BIO_printf(bio_out, "%s\n", argv[0] + 3);
484         return 1;
485     }
486     if (strcmp(argv[0], "quit") == 0 || strcmp(argv[0], "q") == 0 ||
487         strcmp(argv[0], "exit") == 0 || strcmp(argv[0], "bye") == 0)
488         /* Special value to mean "exit the program. */
489         return EXIT_THE_PROGRAM;
490
491     BIO_printf(bio_err, "Invalid command '%s'; type \"help\" for a list.\n",
492                argv[0]);
493     return (1);
494 }
495
496 static void list_pkey(void)
497 {
498     int i;
499
500     for (i = 0; i < EVP_PKEY_asn1_get_count(); i++) {
501         const EVP_PKEY_ASN1_METHOD *ameth;
502         int pkey_id, pkey_base_id, pkey_flags;
503         const char *pinfo, *pem_str;
504         ameth = EVP_PKEY_asn1_get0(i);
505         EVP_PKEY_asn1_get0_info(&pkey_id, &pkey_base_id, &pkey_flags,
506                                 &pinfo, &pem_str, ameth);
507         if (pkey_flags & ASN1_PKEY_ALIAS) {
508             BIO_printf(bio_out, "Name: %s\n", OBJ_nid2ln(pkey_id));
509             BIO_printf(bio_out, "\tAlias for: %s\n",
510                        OBJ_nid2ln(pkey_base_id));
511         } else {
512             BIO_printf(bio_out, "Name: %s\n", pinfo);
513             BIO_printf(bio_out, "\tType: %s Algorithm\n",
514                        pkey_flags & ASN1_PKEY_DYNAMIC ?
515                        "External" : "Builtin");
516             BIO_printf(bio_out, "\tOID: %s\n", OBJ_nid2ln(pkey_id));
517             if (pem_str == NULL)
518                 pem_str = "(none)";
519             BIO_printf(bio_out, "\tPEM string: %s\n", pem_str);
520         }
521
522     }
523 }
524
525 static int function_cmp(const FUNCTION * a, const FUNCTION * b)
526 {
527     return strncmp(a->name, b->name, 8);
528 }
529
530 static unsigned long function_hash(const FUNCTION * a)
531 {
532     return OPENSSL_LH_strhash(a->name);
533 }
534
535 static int SortFnByName(const void *_f1, const void *_f2)
536 {
537     const FUNCTION *f1 = _f1;
538     const FUNCTION *f2 = _f2;
539
540     if (f1->type != f2->type)
541         return f1->type - f2->type;
542     return strcmp(f1->name, f2->name);
543 }
544
545 static void list_disabled(void)
546 {
547     BIO_puts(bio_out, "Disabled algorithms:\n");
548 #ifdef OPENSSL_NO_BF
549     BIO_puts(bio_out, "BF\n");
550 #endif
551 #ifndef OPENSSL_NO_BLAKE2
552     BIO_puts(bio_out, "BLAKE2\n");
553 #endif
554 #ifdef OPENSSL_NO_CAMELLIA
555     BIO_puts(bio_out, "CAMELLIA\n");
556 #endif
557 #ifdef OPENSSL_NO_CAST
558     BIO_puts(bio_out, "CAST\n");
559 #endif
560 #ifdef OPENSSL_NO_CMAC
561     BIO_puts(bio_out, "CMAC\n");
562 #endif
563 #ifdef OPENSSL_NO_CMS
564     BIO_puts(bio_out, "CMS\n");
565 #endif
566 #ifdef OPENSSL_NO_COMP
567     BIO_puts(bio_out, "COMP\n");
568 #endif
569 #ifdef OPENSSL_NO_DES
570     BIO_puts(bio_out, "DES\n");
571 #endif
572 #ifdef OPENSSL_NO_DGRAM
573     BIO_puts(bio_out, "DGRAM\n");
574 #endif
575 #ifdef OPENSSL_NO_DH
576     BIO_puts(bio_out, "DH\n");
577 #endif
578 #ifdef OPENSSL_NO_DSA
579     BIO_puts(bio_out, "DSA\n");
580 #endif
581 #if defined(OPENSSL_NO_DTLS)
582     BIO_puts(bio_out, "DTLS\n");
583 #endif
584 #if defined(OPENSSL_NO_DTLS1)
585     BIO_puts(bio_out, "DTLS1\n");
586 #endif
587 #if defined(OPENSSL_NO_DTLS1_2)
588     BIO_puts(bio_out, "DTLS1_2\n");
589 #endif
590 #ifdef OPENSSL_NO_EC
591     BIO_puts(bio_out, "EC\n");
592 #endif
593 #ifdef OPENSSL_NO_EC2M
594     BIO_puts(bio_out, "EC2M\n");
595 #endif
596 #ifdef OPENSSL_NO_ENGINE
597     BIO_puts(bio_out, "ENGINE\n");
598 #endif
599 #ifdef OPENSSL_NO_GOST
600     BIO_puts(bio_out, "GOST\n");
601 #endif
602 #ifdef OPENSSL_NO_HEARTBEATS
603     BIO_puts(bio_out, "HEARTBEATS\n");
604 #endif
605 #ifdef OPENSSL_NO_IDEA
606     BIO_puts(bio_out, "IDEA\n");
607 #endif
608 #ifdef OPENSSL_NO_MD2
609     BIO_puts(bio_out, "MD2\n");
610 #endif
611 #ifdef OPENSSL_NO_MD4
612     BIO_puts(bio_out, "MD4\n");
613 #endif
614 #ifdef OPENSSL_NO_MD5
615     BIO_puts(bio_out, "MD5\n");
616 #endif
617 #ifdef OPENSSL_NO_MDC2
618     BIO_puts(bio_out, "MDC2\n");
619 #endif
620 #ifdef OPENSSL_NO_OCB
621     BIO_puts(bio_out, "OCB\n");
622 #endif
623 #ifdef OPENSSL_NO_OCSP
624     BIO_puts(bio_out, "OCSP\n");
625 #endif
626 #ifdef OPENSSL_NO_PSK
627     BIO_puts(bio_out, "PSK\n");
628 #endif
629 #ifdef OPENSSL_NO_RC2
630     BIO_puts(bio_out, "RC2\n");
631 #endif
632 #ifdef OPENSSL_NO_RC4
633     BIO_puts(bio_out, "RC4\n");
634 #endif
635 #ifdef OPENSSL_NO_RC5
636     BIO_puts(bio_out, "RC5\n");
637 #endif
638 #ifdef OPENSSL_NO_RMD160
639     BIO_puts(bio_out, "RMD160\n");
640 #endif
641 #ifdef OPENSSL_NO_RSA
642     BIO_puts(bio_out, "RSA\n");
643 #endif
644 #ifdef OPENSSL_NO_SCRYPT
645     BIO_puts(bio_out, "SCRYPT\n");
646 #endif
647 #ifdef OPENSSL_NO_SCTP
648     BIO_puts(bio_out, "SCTP\n");
649 #endif
650 #ifdef OPENSSL_NO_SEED
651     BIO_puts(bio_out, "SEED\n");
652 #endif
653 #ifdef OPENSSL_NO_SOCK
654     BIO_puts(bio_out, "SOCK\n");
655 #endif
656 #ifdef OPENSSL_NO_SRP
657     BIO_puts(bio_out, "SRP\n");
658 #endif
659 #ifdef OPENSSL_NO_SRTP
660     BIO_puts(bio_out, "SRTP\n");
661 #endif
662 #ifdef OPENSSL_NO_SSL3
663     BIO_puts(bio_out, "SSL3\n");
664 #endif
665 #ifdef OPENSSL_NO_TLS1
666     BIO_puts(bio_out, "TLS1\n");
667 #endif
668 #ifdef OPENSSL_NO_TLS1_1
669     BIO_puts(bio_out, "TLS1_1\n");
670 #endif
671 #ifdef OPENSSL_NO_TLS1_2
672     BIO_puts(bio_out, "TLS1_2\n");
673 #endif
674 #ifdef OPENSSL_NO_WHIRLPOOL
675     BIO_puts(bio_out, "WHIRLPOOL\n");
676 #endif
677 #ifndef ZLIB
678     BIO_puts(bio_out, "ZLIB\n");
679 #endif
680 }
681
682 static LHASH_OF(FUNCTION) *prog_init(void)
683 {
684     LHASH_OF(FUNCTION) *ret;
685     FUNCTION *f;
686     size_t i;
687
688     /* Sort alphabetically within category. For nicer help displays. */
689     for (i = 0, f = functions; f->name != NULL; ++f, ++i) ;
690     qsort(functions, i, sizeof(*functions), SortFnByName);
691
692     if ((ret = lh_FUNCTION_new(function_hash, function_cmp)) == NULL)
693         return (NULL);
694
695     for (f = functions; f->name != NULL; f++)
696         (void)lh_FUNCTION_insert(ret, f);
697     return (ret);
698 }