Add "sections" to -help output
[openssl.git] / apps / version.c
1 /*
2  * Copyright 1995-2018 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 <stdlib.h>
12 #include <string.h>
13 #include "apps.h"
14 #include "progs.h"
15 #include <openssl/evp.h>
16 #include <openssl/crypto.h>
17 #include <openssl/bn.h>
18 #ifndef OPENSSL_NO_MD2
19 # include <openssl/md2.h>
20 #endif
21 #ifndef OPENSSL_NO_RC4
22 # include <openssl/rc4.h>
23 #endif
24 #ifndef OPENSSL_NO_DES
25 # include <openssl/des.h>
26 #endif
27 #ifndef OPENSSL_NO_IDEA
28 # include <openssl/idea.h>
29 #endif
30 #ifndef OPENSSL_NO_BF
31 # include <openssl/blowfish.h>
32 #endif
33
34 typedef enum OPTION_choice {
35     OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
36     OPT_B, OPT_D, OPT_E, OPT_M, OPT_F, OPT_O, OPT_P, OPT_V, OPT_A, OPT_R, OPT_C
37 } OPTION_CHOICE;
38
39 const OPTIONS version_options[] = {
40     OPT_SECTION("General"),
41     {"help", OPT_HELP, '-', "Display this summary"},
42
43     OPT_SECTION("Output"),
44     {"a", OPT_A, '-', "Show all data"},
45     {"b", OPT_B, '-', "Show build date"},
46     {"d", OPT_D, '-', "Show configuration directory"},
47     {"e", OPT_E, '-', "Show engines directory"},
48     {"m", OPT_M, '-', "Show modules directory"},
49     {"f", OPT_F, '-', "Show compiler flags used"},
50     {"o", OPT_O, '-', "Show some internal datatype options"},
51     {"p", OPT_P, '-', "Show target build platform"},
52     {"r", OPT_R, '-', "Show random seeding options"},
53     {"v", OPT_V, '-', "Show library version"},
54     {"c", OPT_C, '-', "Show CPU settings info"},
55     {NULL}
56 };
57
58 int version_main(int argc, char **argv)
59 {
60     int ret = 1, dirty = 0, seed = 0;
61     int cflags = 0, version = 0, date = 0, options = 0, platform = 0, dir = 0;
62     int engdir = 0, moddir = 0, cpuinfo = 0;
63     char *prog;
64     OPTION_CHOICE o;
65
66     prog = opt_init(argc, argv, version_options);
67     while ((o = opt_next()) != OPT_EOF) {
68         switch (o) {
69         case OPT_EOF:
70         case OPT_ERR:
71 opthelp:
72             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
73             goto end;
74         case OPT_HELP:
75             opt_help(version_options);
76             ret = 0;
77             goto end;
78         case OPT_B:
79             dirty = date = 1;
80             break;
81         case OPT_D:
82             dirty = dir = 1;
83             break;
84         case OPT_E:
85             dirty = engdir = 1;
86             break;
87         case OPT_M:
88             dirty = moddir = 1;
89             break;
90         case OPT_F:
91             dirty = cflags = 1;
92             break;
93         case OPT_O:
94             dirty = options = 1;
95             break;
96         case OPT_P:
97             dirty = platform = 1;
98             break;
99         case OPT_R:
100             dirty = seed = 1;
101             break;
102         case OPT_V:
103             dirty = version = 1;
104             break;
105         case OPT_C:
106             dirty = cpuinfo = 1;
107             break;
108         case OPT_A:
109             seed = options = cflags = version = date = platform
110                 = dir = engdir = moddir = cpuinfo
111                 = 1;
112             break;
113         }
114     }
115     if (opt_num_rest() != 0) {
116         BIO_printf(bio_err, "Extra parameters given.\n");
117         goto opthelp;
118     }
119     if (!dirty)
120         version = 1;
121
122     if (version)
123         printf("%s (Library: %s)\n",
124                OPENSSL_VERSION_TEXT, OpenSSL_version(OPENSSL_VERSION));
125     if (date)
126         printf("%s\n", OpenSSL_version(OPENSSL_BUILT_ON));
127     if (platform)
128         printf("%s\n", OpenSSL_version(OPENSSL_PLATFORM));
129     if (options) {
130         printf("options: ");
131         printf(" %s", BN_options());
132 #ifndef OPENSSL_NO_MD2
133         printf(" %s", MD2_options());
134 #endif
135 #ifndef OPENSSL_NO_RC4
136         printf(" %s", RC4_options());
137 #endif
138 #ifndef OPENSSL_NO_DES
139         printf(" %s", DES_options());
140 #endif
141 #ifndef OPENSSL_NO_IDEA
142         printf(" %s", IDEA_options());
143 #endif
144 #ifndef OPENSSL_NO_BF
145         printf(" %s", BF_options());
146 #endif
147         printf("\n");
148     }
149     if (cflags)
150         printf("%s\n", OpenSSL_version(OPENSSL_CFLAGS));
151     if (dir)
152         printf("%s\n", OpenSSL_version(OPENSSL_DIR));
153     if (engdir)
154         printf("%s\n", OpenSSL_version(OPENSSL_ENGINES_DIR));
155     if (moddir)
156         printf("%s\n", OpenSSL_version(OPENSSL_MODULES_DIR));
157     if (seed) {
158         const char *src = OPENSSL_info(OPENSSL_INFO_SEED_SOURCE);
159         printf("Seeding source: %s\n", src ? src : "N/A");
160     }
161     if (cpuinfo)
162         printf("%s\n", OpenSSL_version(OPENSSL_CPU_INFO));
163     ret = 0;
164  end:
165     return ret;
166 }