5 OPENSSL_VERSION_MAJOR, OPENSSL_VERSION_MINOR, OPENSSL_VERSION_PATCH,
6 OPENSSL_VERSION_PRE_RELEASE, OPENSSL_VERSION_BUILD_METADATA,
8 OPENSSL_version_major, OPENSSL_version_minor, OPENSSL_version_patch,
9 OPENSSL_version_pre_release, OPENSSL_version_build_metadata, OpenSSL_version,
10 OPENSSL_VERSION_NUMBER, OpenSSL_version_num, OPENSSL_info
11 - get OpenSSL version number and other information
15 #include <openssl/opensslv.h>
17 #define OPENSSL_VERSION_MAJOR x
18 #define OPENSSL_VERSION_MINOR y
19 #define OPENSSL_VERSION_PATCH z
21 /* The definitions here are typical release values */
22 #define OPENSSL_VERSION_PRE_RELEASE ""
23 #define OPENSSL_VERSION_BUILD_METADATA ""
25 #define OPENSSL_VERSION_TEXT "OpenSSL x.y.z xx XXX xxxx"
27 #include <openssl/crypto.h>
29 unsigned int OPENSSL_version_major(void);
30 unsigned int OPENSSL_version_minor(void);
31 unsigned int OPENSSL_version_patch(void);
32 const char *OPENSSL_version_pre_release(void);
33 const char *OPENSSL_version_build_metadata(void);
35 const char *OpenSSL_version(int t);
37 const char *OPENSSL_info(int t);
41 /* from openssl/opensslv.h */
42 #define OPENSSL_VERSION_NUMBER 0xnnnnnnnnnL
44 /* from openssl/crypto.h */
45 unsigned long OpenSSL_version_num();
51 The three macros B<OPENSSL_VERSION_MAJOR>, B<OPENSSL_VERSION_MINOR> and
52 B<OPENSSL_VERSION_PATCH> represent the three parts of a version
53 identifier, B<I<MAJOR>.I<MINOR>.I<PATCH>>.
55 The macro B<OPENSSL_VERSION_PRE_RELEASE> is an added bit of text that
56 indicates that this is a pre-release version, such as C<"-dev"> for an
57 ongoing development snapshot or C<"-alpha3"> for an alpha release.
58 The value must be a string.
60 The macro B<OPENSSL_VERSION_BUILD_METADATA> is extra information, reserved
61 for other parties, such as C<"+fips">, or C<"+vendor.1">).
62 The OpenSSL project will not touch this macro (will leave it an empty string).
63 The value must be a string.
65 B<OPENSSL_VERSION_STR> is a convenience macro to get the short version
66 identifier string, C<"I<MAJOR>.I<MINOR>.I<PATCH>">.
68 B<OPENSSL_FULL_VERSION_STR> is a convenience macro to get the longer
69 version identifier string, which combines B<OPENSSL_VERSION_STR>,
70 B<OPENSSL_VERSION_PRE_RELEASE> and B<OPENSSL_VERSION_BUILD_METADATA>.
72 B<OPENSSL_VERSION_TEXT> is a convenience macro to get a full descriptive
73 version text, which includes B<OPENSSL_FULL_VERSION_STR> and the release
78 OPENSSL_version_major(), OPENSSL_version_minor(), OPENSSL_version_patch(),
79 OPENSSL_version_pre_release(), and OPENSSL_version_build_metadata() return
80 the values of the macros above for the build of the library, respectively.
82 OpenSSL_version() returns different strings depending on I<t>:
88 The value of B<OPENSSL_VERSION_TEXT>
90 =item OPENSSL_VERSION_STRING
92 The value of B<OPENSSL_VERSION_STR>
94 =item OPENSSL_FULL_VERSION_STRING
96 The value of B<OPENSSL_FULL_VERSION_STR>
100 The compiler flags set for the compilation process in the form
101 C<compiler: ...> if available, or C<compiler: information not available>
104 =item OPENSSL_BUILT_ON
106 The date of the build process in the form C<built on: ...> if available
107 or C<built on: date not available> otherwise.
108 The date would not be available in a reproducible build, for example.
110 =item OPENSSL_PLATFORM
112 The "Configure" target of the library build in the form C<platform: ...>
113 if available, or C<platform: information not available> otherwise.
117 The B<OPENSSLDIR> setting of the library build in the form C<OPENSSLDIR: "...">
118 if available, or C<OPENSSLDIR: N/A> otherwise.
120 =item OPENSSL_ENGINES_DIR
122 The B<ENGINESDIR> setting of the library build in the form C<ENGINESDIR: "...">
123 if available, or C<ENGINESDIR: N/A> otherwise.
125 =item OPENSSL_MODULES_DIR
127 The B<MODULESDIR> setting of the library build in the form C<MODULESDIR: "...">
128 if available, or C<MODULESDIR: N/A> otherwise.
130 =item OPENSSL_CPU_INFO
132 The current OpenSSL cpu settings.
133 This is the current setting of the cpu capability flags. It is usually
134 automatically configured but may be set via an environment variable.
135 The value has the same syntax as the environment variable.
136 For x86 the string looks like C<CPUINFO: OPENSSL_ia32cap=0x123:0x456>
137 or C<CPUINFO: N/A> if not available.
141 For an unknown I<t>, the text C<not available> is returned.
143 OPENSSL_info() also returns different strings depending on I<t>:
147 =item OPENSSL_INFO_CONFIG_DIR
149 The configured C<OPENSSLDIR>, which is the default location for
150 OpenSSL configuration files.
152 =item OPENSSL_INFO_ENGINES_DIR
154 The configured C<ENGINESDIR>, which is the default location for
157 =item OPENSSL_INFO_MODULES_DIR
159 The configured C<MODULESDIR>, which is the default location for
160 dynamically loadable OpenSSL modules other than engines.
162 =item OPENSSL_INFO_DSO_EXTENSION
164 The configured dynamically loadable module extension.
166 =item OPENSSL_INFO_DIR_FILENAME_SEPARATOR
168 The separator between a directory specification and a filename.
169 Note that on some operating systems, this is not the same as the
170 separator between directory elements.
172 =item OPENSSL_INFO_LIST_SEPARATOR
174 The OpenSSL list separator.
175 This is typically used in strings that are lists of items, such as the
176 value of the environment variable C<$PATH> on Unix (where the
177 separator is C<:>) or C<%PATH%> on Windows (where the separator is
180 =item OPENSSL_INFO_CPU_SETTINGS
182 The current OpenSSL cpu settings.
183 This is the current setting of the cpu capability flags. It is usually
184 automatically configured but may be set via an environment variable.
185 The value has the same syntax as the environment variable.
186 For x86 the string looks like C<OPENSSL_ia32cap=0x123:0x456>.
190 For an unknown I<t>, NULL is returned.
192 =head1 BACKWARD COMPATIBILITY
194 For compatibility, some older macros and functions are retained or
196 They are all considered deprecated.
200 B<OPENSSL_VERSION_NUMBER> is a combination of the major, minor and
201 patch version into a single integer 0xMNN00PP0L, where:
207 is the number from B<OPENSSL_VERSION_MAJOR>, in hexadecimal notation
211 is the number from B<OPENSSL_VERSION_MINOR>, in hexadecimal notation
215 is the number from B<OPENSSL_VERSION_PATCH>, in hexadecimal notation
221 OpenSSL_version_num() returns the value of B<OPENSSL_VERSION_NUMBER>.
225 OPENSSL_version_major(), OPENSSL_version_minor() and OPENSSL_version_patch()
226 return the version number parts as integers.
228 OPENSSL_version_pre_release() and OPENSSL_version_build_metadata() return
229 the values of B<OPENSSL_VERSION_PRE_RELEASE> and
230 B<OPENSSL_VERSION_BUILD_METADATA> respectively as constant strings.
231 For any of them that is undefined, the empty string is returned.
233 OpenSSL_version() returns constant strings.
241 The macros and functions described here were added in OpenSSL 3.0,
242 with the exception of the L</BACKWARD COMPATIBILITY> ones.
246 Copyright 2018-2019 The OpenSSL Project Authors. All Rights Reserved.
248 Licensed under the Apache License 2.0 (the "License"). You may not use
249 this file except in compliance with the License. You can obtain a copy
250 in the file LICENSE in the source distribution or at
251 L<https://www.openssl.org/source/license.html>.