]>
Commit | Line | Data |
---|---|---|
6ede7d73 DMSP |
1 | Build and Install |
2 | ================= | |
3 | ||
4 | This document describes installation on all supported operating | |
5 | systems (the Unix/Linux family, including macOS), OpenVMS, | |
6 | and Windows). | |
7 | ||
8 | Table of Contents | |
9 | ================= | |
10 | ||
11 | - [Prerequisites](#prerequisites) | |
12 | - [Notational Conventions](#notational-conventions) | |
13 | - [Quick Installation Guide](#quick-installation-guide) | |
257e9d03 RS |
14 | - [Building OpenSSL](#building-openssl) |
15 | - [Installing OpenSSL](#installing-openssl) | |
6ede7d73 | 16 | - [Configuration Options](#configuration-options) |
257e9d03 RS |
17 | - [API Level](#api-level) |
18 | - [Cross Compile Prefix](#cross-compile-prefix) | |
19 | - [Build Type](#build-type) | |
20 | - [Directories](#directories) | |
21 | - [Compiler Warnings](#compiler-warnings) | |
22 | - [ZLib Flags](#zlib-flags) | |
23 | - [Seeding the Random Generator](#seeding-the-random-generator) | |
31214258 | 24 | - [Setting the FIPS HMAC key](#setting-the-FIPS-HMAC-key) |
257e9d03 RS |
25 | - [Enable and Disable Features](#enable-and-disable-features) |
26 | - [Displaying configuration data](#displaying-configuration-data) | |
6ede7d73 | 27 | - [Installation Steps in Detail](#installation-steps-in-detail) |
257e9d03 RS |
28 | - [Configure](#configure-openssl) |
29 | - [Build](#build-openssl) | |
30 | - [Test](#test-openssl) | |
31 | - [Install](#install-openssl) | |
6ede7d73 | 32 | - [Advanced Build Options](#advanced-build-options) |
257e9d03 RS |
33 | - [Environment Variables](#environment-variables) |
34 | - [Makefile Targets](#makefile-targets) | |
35 | - [Running Selected Tests](#running-selected-tests) | |
6ede7d73 | 36 | - [Troubleshooting](#troubleshooting) |
257e9d03 RS |
37 | - [Configuration Problems](#configuration-problems) |
38 | - [Build Failures](#build-failures) | |
39 | - [Test Failures](#test-failures) | |
6ede7d73 | 40 | - [Notes](#notes) |
257e9d03 RS |
41 | - [Notes on multi-threading](#notes-on-multi-threading) |
42 | - [Notes on shared libraries](#notes-on-shared-libraries) | |
43 | - [Notes on random number generation](#notes-on-random-number-generation) | |
203c18f1 | 44 | - [Notes on assembler modules compilation](#notes-on-assembler-modules-compilation) |
79e259e3 | 45 | |
6ede7d73 DMSP |
46 | Prerequisites |
47 | ============= | |
2acd8ec7 | 48 | |
6ede7d73 | 49 | To install OpenSSL, you will need: |
2acd8ec7 | 50 | |
3a0b3cc9 | 51 | * A "make" implementation |
9f1fe6a9 DMSP |
52 | * Perl 5 with core modules (please read [NOTES-PERL.md](NOTES-PERL.md)) |
53 | * The Perl module `Text::Template` (please read [NOTES-PERL.md](NOTES-PERL.md)) | |
6ede7d73 DMSP |
54 | * an ANSI C compiler |
55 | * a development environment in the form of development libraries and C | |
56 | header files | |
57 | * a supported operating system | |
79e259e3 | 58 | |
6ede7d73 DMSP |
59 | For additional platform specific requirements, solutions to specific |
60 | issues and other details, please read one of these: | |
ea24fe29 | 61 | |
4148581e DMSP |
62 | * [Notes for UNIX-like platforms](NOTES-UNIX.md) |
63 | * [Notes for Android platforms](NOTES-ANDROID.md) | |
64 | * [Notes for Windows platforms](NOTES-WINDOWS.md) | |
65 | * [Notes for the DOS platform with DJGPP](NOTES-DJGPP.md) | |
66 | * [Notes for the OpenVMS platform](NOTES-VMS.md) | |
67 | * [Notes on Perl](NOTES-PERL.md) | |
68 | * [Notes on Valgrind](NOTES-VALGRIND.md) | |
ea24fe29 | 69 | |
6ede7d73 DMSP |
70 | Notational conventions |
71 | ====================== | |
ea24fe29 | 72 | |
6ede7d73 | 73 | Throughout this document, we use the following conventions. |
ea24fe29 | 74 | |
6ede7d73 DMSP |
75 | Commands |
76 | -------- | |
ea24fe29 | 77 | |
6ede7d73 | 78 | Any line starting with a dollar sign is a command line. |
ea24fe29 | 79 | |
6ede7d73 | 80 | $ command |
ea24fe29 | 81 | |
6ede7d73 DMSP |
82 | The dollar sign indicates the shell prompt and is not to be entered as |
83 | part of the command. | |
ea24fe29 | 84 | |
6ede7d73 DMSP |
85 | Choices |
86 | ------- | |
ea24fe29 | 87 | |
6ede7d73 DMSP |
88 | Several words in curly braces separated by pipe characters indicate a |
89 | **mandatory choice**, to be replaced with one of the given words. | |
90 | For example, the line | |
ea24fe29 | 91 | |
6ede7d73 | 92 | $ echo { WORD1 | WORD2 | WORD3 } |
ea24fe29 | 93 | |
6ede7d73 | 94 | represents one of the following three commands |
ea24fe29 | 95 | |
6ede7d73 DMSP |
96 | $ echo WORD1 |
97 | - or - | |
98 | $ echo WORD2 | |
99 | - or - | |
100 | $ echo WORD3 | |
ea24fe29 | 101 | |
6ede7d73 DMSP |
102 | One or several words in square brackets separated by pipe characters |
103 | denote an **optional choice**. It is similar to the mandatory choice, | |
104 | but it can also be omitted entirely. | |
79e259e3 | 105 | |
6ede7d73 | 106 | So the line |
79e259e3 | 107 | |
6ede7d73 DMSP |
108 | $ echo [ WORD1 | WORD2 | WORD3 ] |
109 | ||
110 | represents one of the four commands | |
111 | ||
112 | $ echo WORD1 | |
113 | - or - | |
114 | $ echo WORD2 | |
115 | - or - | |
116 | $ echo WORD3 | |
117 | - or - | |
118 | $ echo | |
119 | ||
120 | Arguments | |
121 | --------- | |
122 | ||
123 | **Mandatory arguments** are enclosed in double curly braces. | |
124 | A simple example would be | |
125 | ||
126 | $ type {{ filename }} | |
127 | ||
128 | which is to be understood to use the command `type` on some file name | |
129 | determined by the user. | |
130 | ||
6ede7d73 DMSP |
131 | **Optional Arguments** are enclosed in double square brackets. |
132 | ||
133 | [[ options ]] | |
134 | ||
9afbb681 DDO |
135 | Note that the notation assumes spaces around `{`, `}`, `[`, `]`, `{{`, `}}` and |
136 | `[[`, `]]`. This is to differentiate from OpenVMS directory | |
6ede7d73 DMSP |
137 | specifications, which also use [ and ], but without spaces. |
138 | ||
6ede7d73 DMSP |
139 | Quick Installation Guide |
140 | ======================== | |
141 | ||
142 | If you just want to get OpenSSL installed without bothering too much | |
143 | about the details, here is the short version of how to build and install | |
144 | OpenSSL. If any of the following steps fails, please consult the | |
bf4cdd4a | 145 | [Installation in Detail](#installation-steps-in-detail) section below. |
6ede7d73 DMSP |
146 | |
147 | Building OpenSSL | |
148 | ---------------- | |
149 | ||
150 | Use the following commands to configure, build and test OpenSSL. | |
151 | The testing is optional, but recommended if you intend to install | |
152 | OpenSSL for production use. | |
153 | ||
257e9d03 | 154 | ### Unix / Linux / macOS |
2acd8ec7 | 155 | |
16b0e0fc | 156 | $ ./Configure |
2acd8ec7 RL |
157 | $ make |
158 | $ make test | |
2acd8ec7 | 159 | |
257e9d03 | 160 | ### OpenVMS |
6ede7d73 DMSP |
161 | |
162 | Use the following commands to build OpenSSL: | |
2acd8ec7 | 163 | |
16b0e0fc | 164 | $ perl Configure |
2acd8ec7 RL |
165 | $ mms |
166 | $ mms test | |
79e259e3 | 167 | |
257e9d03 | 168 | ### Windows |
6ede7d73 DMSP |
169 | |
170 | If you are using Visual Studio, open a Developer Command Prompt and | |
8c1cbc72 | 171 | issue the following commands to build OpenSSL. |
b32b8961 | 172 | |
16b0e0fc | 173 | $ perl Configure |
b32b8961 RL |
174 | $ nmake |
175 | $ nmake test | |
6ede7d73 DMSP |
176 | |
177 | As mentioned in the [Choices](#choices) section, you need to pick one | |
178 | of the four Configure targets in the first command. | |
179 | ||
9afbb681 DDO |
180 | Most likely you will be using the `VC-WIN64A` target for 64bit Windows |
181 | binaries (AMD64) or `VC-WIN32` for 32bit Windows binaries (X86). | |
182 | The other two options are `VC-WIN64I` (Intel IA64, Itanium) and | |
183 | `VC-CE` (Windows CE) are rather uncommon nowadays. | |
6ede7d73 DMSP |
184 | |
185 | Installing OpenSSL | |
186 | ------------------ | |
187 | ||
188 | The following commands will install OpenSSL to a default system location. | |
189 | ||
190 | **Danger Zone:** even if you are impatient, please read the following two | |
191 | paragraphs carefully before you install OpenSSL. | |
192 | ||
193 | For security reasons the default system location is by default not writable | |
194 | for unprivileged users. So for the final installation step administrative | |
195 | privileges are required. The default system location and the procedure to | |
8c1cbc72 | 196 | obtain administrative privileges depends on the operating system. |
6ede7d73 DMSP |
197 | It is recommended to compile and test OpenSSL with normal user privileges |
198 | and use administrative privileges only for the final installation step. | |
199 | ||
200 | On some platforms OpenSSL is preinstalled as part of the Operating System. | |
201 | In this case it is highly recommended not to overwrite the system versions, | |
202 | because other applications or libraries might depend on it. | |
203 | To avoid breaking other applications, install your copy of OpenSSL to a | |
204 | [different location](#installing-to-a-different-location) which is not in | |
205 | the global search path for system libraries. | |
206 | ||
41149648 RL |
207 | Finally, if you plan on using the FIPS module, you need to read the |
208 | [Post-installation Notes](#post-installation-notes) further down. | |
209 | ||
257e9d03 | 210 | ### Unix / Linux / macOS |
6ede7d73 DMSP |
211 | |
212 | Depending on your distribution, you need to run the following command as | |
213 | root user or prepend `sudo` to the command: | |
214 | ||
215 | $ make install | |
216 | ||
217 | By default, OpenSSL will be installed to | |
218 | ||
219 | /usr/local | |
220 | ||
221 | More precisely, the files will be installed into the subdirectories | |
222 | ||
223 | /usr/local/bin | |
224 | /usr/local/lib | |
225 | /usr/local/include | |
226 | ... | |
227 | ||
228 | depending on the file type, as it is custom on Unix-like operating systems. | |
229 | ||
257e9d03 | 230 | ### OpenVMS |
6ede7d73 DMSP |
231 | |
232 | Use the following command to install OpenSSL. | |
233 | ||
234 | $ mms install | |
235 | ||
236 | By default, OpenSSL will be installed to | |
237 | ||
d8c1cafb | 238 | SYS$COMMON:[OPENSSL] |
6ede7d73 | 239 | |
257e9d03 | 240 | ### Windows |
6ede7d73 DMSP |
241 | |
242 | If you are using Visual Studio, open the Developer Command Prompt _elevated_ | |
243 | and issue the following command. | |
244 | ||
8c16829e | 245 | $ nmake install |
b32b8961 | 246 | |
6ede7d73 DMSP |
247 | The easiest way to elevate the Command Prompt is to press and hold down |
248 | the both the `<CTRL>` and `<SHIFT>` key while clicking the menu item in the | |
249 | task menu. | |
250 | ||
251 | The default installation location is | |
252 | ||
253 | C:\Program Files\OpenSSL | |
7c03bb9f | 254 | |
6ede7d73 | 255 | for native binaries, or |
b1fe6b43 | 256 | |
6ede7d73 | 257 | C:\Program Files (x86)\OpenSSL |
2acd8ec7 | 258 | |
6ede7d73 | 259 | for 32bit binaries on 64bit Windows (WOW64). |
2acd8ec7 | 260 | |
257e9d03 | 261 | #### Installing to a different location |
79e259e3 | 262 | |
6ede7d73 | 263 | To install OpenSSL to a different location (for example into your home |
9afbb681 | 264 | directory for testing purposes) run `Configure` as shown in the following |
43a70f02 | 265 | examples. |
6ede7d73 | 266 | |
d8c1cafb RL |
267 | The options `--prefix` and `--openssldir` are explained in further detail in |
268 | [Directories](#directories) below, and the values used here are mere examples. | |
269 | ||
43a70f02 | 270 | On Unix: |
2acd8ec7 | 271 | |
16b0e0fc | 272 | $ ./Configure --prefix=/opt/openssl --openssldir=/usr/local/ssl |
2acd8ec7 | 273 | |
43a70f02 | 274 | On OpenVMS: |
2acd8ec7 | 275 | |
16b0e0fc | 276 | $ perl Configure --prefix=PROGRAM:[INSTALLS] --openssldir=SYS$MANAGER:[OPENSSL] |
79e259e3 | 277 | |
6ede7d73 | 278 | Note: if you do add options to the configuration command, please make sure |
1dc1ea18 | 279 | you've read more than just this Quick Start, such as relevant `NOTES-*` files, |
6ede7d73 DMSP |
280 | the options outline below, as configuration options may change the outcome |
281 | in otherwise unexpected ways. | |
282 | ||
6ede7d73 DMSP |
283 | Configuration Options |
284 | ===================== | |
285 | ||
9afbb681 DDO |
286 | There are several options to `./Configure` to customize the build (note that |
287 | for Windows, the defaults for `--prefix` and `--openssldir` depend on what | |
16b0e0fc | 288 | configuration is used and what Windows implementation OpenSSL is built on. |
9f1fe6a9 | 289 | For more information, see the [Notes for Windows platforms](NOTES-WINDOWS.md). |
6ede7d73 DMSP |
290 | |
291 | API Level | |
292 | --------- | |
293 | ||
294 | --api=x.y[.z] | |
295 | ||
296 | Build the OpenSSL libraries to support the API for the specified version. | |
297 | If [no-deprecated](#no-deprecated) is also given, don't build with support | |
298 | for deprecated APIs in or below the specified version number. For example, | |
299 | addding | |
300 | ||
301 | --api=1.1.0 no-deprecated | |
302 | ||
303 | will remove support for all APIs that were deprecated in OpenSSL version | |
304 | 1.1.0 or below. This is a rather specialized option for developers. | |
305 | If you just intend to remove all deprecated APIs up to the current version | |
306 | entirely, just specify [no-deprecated](#no-deprecated). | |
307 | If `--api` isn't given, it defaults to the current (minor) OpenSSL version. | |
308 | ||
6ede7d73 DMSP |
309 | Cross Compile Prefix |
310 | -------------------- | |
311 | ||
9afbb681 | 312 | --cross-compile-prefix=<PREFIX> |
6ede7d73 | 313 | |
9afbb681 | 314 | The `<PREFIX>` to include in front of commands for your toolchain. |
6ede7d73 | 315 | |
9afbb681 DDO |
316 | It is likely to have to end with dash, e.g. `a-b-c-` would invoke GNU compiler |
317 | as `a-b-c-gcc`, etc. Unfortunately cross-compiling is too case-specific to put | |
6ede7d73 | 318 | together one-size-fits-all instructions. You might have to pass more flags or |
16b0e0fc RL |
319 | set up environment variables to actually make it work. Android and iOS cases |
320 | are discussed in corresponding `Configurations/15-*.conf` files. But there are | |
321 | cases when this option alone is sufficient. For example to build the mingw64 | |
322 | target on Linux `--cross-compile-prefix=x86_64-w64-mingw32-` works. Naturally | |
323 | provided that mingw packages are installed. Today Debian and Ubuntu users | |
324 | have option to install a number of prepackaged cross-compilers along with | |
325 | corresponding run-time and development packages for "alien" hardware. To give | |
326 | another example `--cross-compile-prefix=mipsel-linux-gnu-` suffices in such | |
327 | case. | |
328 | ||
329 | For cross compilation, you must [configure manually](#manual-configuration). | |
330 | Also, note that `--openssldir` refers to target's file system, not one you are | |
331 | building on. | |
6ede7d73 | 332 | |
6ede7d73 DMSP |
333 | Build Type |
334 | ---------- | |
335 | ||
336 | --debug | |
337 | ||
338 | Build OpenSSL with debugging symbols and zero optimization level. | |
339 | ||
340 | --release | |
341 | ||
342 | Build OpenSSL without debugging symbols. This is the default. | |
343 | ||
6ede7d73 DMSP |
344 | Directories |
345 | ----------- | |
346 | ||
257e9d03 | 347 | ### libdir |
6ede7d73 DMSP |
348 | |
349 | --libdir=DIR | |
350 | ||
351 | The name of the directory under the top of the installation directory tree | |
352 | (see the `--prefix` option) where libraries will be installed. By default | |
9afbb681 | 353 | this is `lib/`. Note that on Windows only static libraries (`*.lib`) will |
6ede7d73 | 354 | be stored in this location. Shared libraries (`*.dll`) will always be |
9afbb681 | 355 | installed to the `bin/` directory. |
6ede7d73 | 356 | |
257e9d03 | 357 | ### openssldir |
6ede7d73 DMSP |
358 | |
359 | --openssldir=DIR | |
360 | ||
361 | Directory for OpenSSL configuration files, and also the default certificate | |
362 | and key store. Defaults are: | |
363 | ||
364 | Unix: /usr/local/ssl | |
365 | Windows: C:\Program Files\Common Files\SSL | |
366 | OpenVMS: SYS$COMMON:[OPENSSL-COMMON] | |
367 | ||
368 | For 32bit Windows applications on Windows 64bit (WOW64), always replace | |
369 | `C:\Program Files` by `C:\Program Files (x86)`. | |
370 | ||
257e9d03 | 371 | ### prefix |
6ede7d73 DMSP |
372 | |
373 | --prefix=DIR | |
374 | ||
375 | The top of the installation directory tree. Defaults are: | |
376 | ||
377 | Unix: /usr/local | |
378 | Windows: C:\Program Files\OpenSSL | |
d8c1cafb | 379 | OpenVMS: SYS$COMMON:[OPENSSL] |
6ede7d73 | 380 | |
6ede7d73 DMSP |
381 | Compiler Warnings |
382 | ----------------- | |
383 | ||
384 | --strict-warnings | |
385 | ||
386 | This is a developer flag that switches on various compiler options recommended | |
387 | for OpenSSL development. It only works when using gcc or clang as the compiler. | |
388 | If you are developing a patch for OpenSSL then it is recommended that you use | |
389 | this option where possible. | |
390 | ||
391 | ZLib Flags | |
392 | ---------- | |
393 | ||
257e9d03 | 394 | ### with-zlib-include |
6ede7d73 DMSP |
395 | |
396 | --with-zlib-include=DIR | |
397 | ||
398 | The directory for the location of the zlib include file. This option is only | |
bf4cdd4a | 399 | necessary if [zlib](#zlib) is used and the include file is not |
6ede7d73 DMSP |
400 | already on the system include path. |
401 | ||
257e9d03 | 402 | ### with-zlib-lib |
6ede7d73 DMSP |
403 | |
404 | --with-zlib-lib=LIB | |
405 | ||
406 | **On Unix**: this is the directory containing the zlib library. | |
407 | If not provided the system library path will be used. | |
408 | ||
409 | **On Windows:** this is the filename of the zlib library (with or | |
410 | without a path). This flag must be provided if the | |
9afbb681 DDO |
411 | [zlib-dynamic](#zlib-dynamic) option is not also used. If `zlib-dynamic` is used |
412 | then this flag is optional and defaults to `ZLIB1` if not provided. | |
6ede7d73 DMSP |
413 | |
414 | **On VMS:** this is the filename of the zlib library (with or without a path). | |
9afbb681 DDO |
415 | This flag is optional and if not provided then `GNV$LIBZSHR`, `GNV$LIBZSHR32` |
416 | or `GNV$LIBZSHR64` is used by default depending on the pointer size chosen. | |
6ede7d73 | 417 | |
6ede7d73 DMSP |
418 | Seeding the Random Generator |
419 | ---------------------------- | |
420 | ||
421 | --with-rand-seed=seed1[,seed2,...] | |
422 | ||
423 | A comma separated list of seeding methods which will be tried by OpenSSL | |
424 | in order to obtain random input (a.k.a "entropy") for seeding its | |
425 | cryptographically secure random number generator (CSPRNG). | |
426 | The current seeding methods are: | |
427 | ||
257e9d03 | 428 | ### os |
6ede7d73 DMSP |
429 | |
430 | Use a trusted operating system entropy source. | |
431 | This is the default method if such an entropy source exists. | |
432 | ||
257e9d03 | 433 | ### getrandom |
6ede7d73 DMSP |
434 | |
435 | Use the [getrandom(2)][man-getrandom] or equivalent system call. | |
436 | ||
437 | [man-getrandom]: http://man7.org/linux/man-pages/man2/getrandom.2.html | |
438 | ||
257e9d03 | 439 | ### devrandom |
6ede7d73 | 440 | |
9afbb681 DDO |
441 | Use the first device from the `DEVRANDOM` list which can be opened to read |
442 | random bytes. The `DEVRANDOM` preprocessor constant expands to | |
6ede7d73 DMSP |
443 | |
444 | "/dev/urandom","/dev/random","/dev/srandom" | |
445 | ||
446 | on most unix-ish operating systems. | |
447 | ||
257e9d03 | 448 | ### egd |
6ede7d73 DMSP |
449 | |
450 | Check for an entropy generating daemon. | |
b99c463d | 451 | This source is ignored by the FIPS provider. |
6ede7d73 | 452 | |
257e9d03 | 453 | ### rdcpu |
6ede7d73 | 454 | |
9afbb681 | 455 | Use the `RDSEED` or `RDRAND` command if provided by the CPU. |
6ede7d73 | 456 | |
257e9d03 | 457 | ### librandom |
6ede7d73 DMSP |
458 | |
459 | Use librandom (not implemented yet). | |
b99c463d | 460 | This source is ignored by the FIPS provider. |
6ede7d73 | 461 | |
257e9d03 | 462 | ### none |
6ede7d73 DMSP |
463 | |
464 | Disable automatic seeding. This is the default on some operating systems where | |
465 | no suitable entropy source exists, or no support for it is implemented yet. | |
b99c463d | 466 | This option is ignored by the FIPS provider. |
6ede7d73 DMSP |
467 | |
468 | For more information, see the section [Notes on random number generation][rng] | |
469 | at the end of this document. | |
470 | ||
471 | [rng]: #notes-on-random-number-generation | |
472 | ||
31214258 RS |
473 | Setting the FIPS HMAC key |
474 | ------------------------- | |
475 | ||
476 | --fips-key=value | |
477 | ||
478 | As part of its self-test validation, the FIPS module must verify itself | |
479 | by performing a SHA-256 HMAC computation on itself. The default key is | |
480 | the SHA256 value of "the holy handgrenade of antioch" and is sufficient | |
481 | for meeting the FIPS requirements. | |
482 | ||
483 | To change the key to a different value, use this flag. The value should | |
484 | be a hex string no more than 64 characters. | |
485 | ||
6ede7d73 DMSP |
486 | Enable and Disable Features |
487 | --------------------------- | |
488 | ||
8c1cbc72 GN |
489 | Feature options always come in pairs, an option to enable feature |
490 | `xxxx`, and an option to disable it: | |
6ede7d73 DMSP |
491 | |
492 | [ enable-xxxx | no-xxxx ] | |
493 | ||
494 | Whether a feature is enabled or disabled by default, depends on the feature. | |
495 | In the following list, always the non-default variant is documented: if | |
9afbb681 DDO |
496 | feature `xxxx` is disabled by default then `enable-xxxx` is documented and |
497 | if feature `xxxx` is enabled by default then `no-xxxx` is documented. | |
6ede7d73 | 498 | |
257e9d03 | 499 | ### no-afalgeng |
6ede7d73 DMSP |
500 | |
501 | Don't build the AFALG engine. | |
502 | ||
503 | This option will be forced on a platform that does not support AFALG. | |
504 | ||
257e9d03 | 505 | ### enable-ktls |
6ede7d73 DMSP |
506 | |
507 | Build with Kernel TLS support. | |
508 | ||
509 | This option will enable the use of the Kernel TLS data-path, which can improve | |
510 | performance and allow for the use of sendfile and splice system calls on | |
511 | TLS sockets. The Kernel may use TLS accelerators if any are available on the | |
512 | system. This option will be forced off on systems that do not support the | |
513 | Kernel TLS data-path. | |
514 | ||
257e9d03 | 515 | ### enable-asan |
6ede7d73 DMSP |
516 | |
517 | Build with the Address sanitiser. | |
518 | ||
519 | This is a developer option only. It may not work on all platforms and should | |
520 | never be used in production environments. It will only work when used with | |
521 | gcc or clang and should be used in conjunction with the [no-shared](#no-shared) | |
522 | option. | |
523 | ||
d1a77041 | 524 | ### enable-acvp-tests |
4f2271d5 | 525 | |
d1a77041 | 526 | Build support for Automated Cryptographic Validation Protocol (ACVP) |
4f2271d5 SL |
527 | tests. |
528 | ||
529 | This is required for FIPS validation purposes. Certain ACVP tests require | |
530 | access to algorithm internals that are not normally accessible. | |
531 | Additional information related to ACVP can be found at | |
532 | <https://github.com/usnistgov/ACVP>. | |
533 | ||
257e9d03 | 534 | ### no-asm |
6ede7d73 DMSP |
535 | |
536 | Do not use assembler code. | |
537 | ||
538 | This should be viewed as debugging/troubleshooting option rather than for | |
539 | production use. On some platforms a small amount of assembler code may still | |
540 | be used even with this option. | |
541 | ||
257e9d03 | 542 | ### no-async |
6ede7d73 DMSP |
543 | |
544 | Do not build support for async operations. | |
545 | ||
257e9d03 | 546 | ### no-autoalginit |
6ede7d73 DMSP |
547 | |
548 | Don't automatically load all supported ciphers and digests. | |
549 | ||
550 | Typically OpenSSL will make available all of its supported ciphers and digests. | |
551 | For a statically linked application this may be undesirable if small executable | |
552 | size is an objective. This only affects libcrypto. Ciphers and digests will | |
9afbb681 DDO |
553 | have to be loaded manually using `EVP_add_cipher()` and `EVP_add_digest()` |
554 | if this option is used. This option will force a non-shared build. | |
6ede7d73 | 555 | |
257e9d03 | 556 | ### no-autoerrinit |
6ede7d73 DMSP |
557 | |
558 | Don't automatically load all libcrypto/libssl error strings. | |
559 | ||
560 | Typically OpenSSL will automatically load human readable error strings. For a | |
561 | statically linked application this may be undesirable if small executable size | |
562 | is an objective. | |
563 | ||
257e9d03 | 564 | ### no-autoload-config |
6ede7d73 | 565 | |
9afbb681 | 566 | Don't automatically load the default `openssl.cnf` file. |
6ede7d73 DMSP |
567 | |
568 | Typically OpenSSL will automatically load a system config file which configures | |
569 | default SSL options. | |
570 | ||
257e9d03 | 571 | ### enable-buildtest-c++ |
6ede7d73 DMSP |
572 | |
573 | While testing, generate C++ buildtest files that simply check that the public | |
574 | OpenSSL header files are usable standalone with C++. | |
575 | ||
576 | Enabling this option demands extra care. For any compiler flag given directly | |
577 | as configuration option, you must ensure that it's valid for both the C and | |
578 | the C++ compiler. If not, the C++ build test will most likely break. As an | |
9afbb681 | 579 | alternative, you can use the language specific variables, `CFLAGS` and `CXXFLAGS`. |
6ede7d73 | 580 | |
d0364dcc RS |
581 | ### --banner=text |
582 | ||
583 | Use the specified text instead of the default banner at the end of | |
584 | configuration. | |
585 | ||
06f81af8 DDO |
586 | ### no-bulk |
587 | ||
588 | Build only some minimal set of features. | |
589 | This is a developer option used internally for CI build tests of the project. | |
590 | ||
1eaf1fc3 P |
591 | ### no-cached-fetch |
592 | ||
593 | Never cache algorithms when they are fetched from a provider. Normally, a | |
594 | provider indicates if the algorithms it supplies can be cached or not. Using | |
595 | this option will reduce run-time memory usage but it also introduces a | |
596 | significant performance penalty. This option is primarily designed to help | |
597 | with detecting incorrect reference counting. | |
598 | ||
257e9d03 | 599 | ### no-capieng |
6ede7d73 DMSP |
600 | |
601 | Don't build the CAPI engine. | |
602 | ||
603 | This option will be forced if on a platform that does not support CAPI. | |
604 | ||
257e9d03 | 605 | ### no-cmp |
6ede7d73 | 606 | |
9afbb681 DDO |
607 | Don't build support for Certificate Management Protocol (CMP) |
608 | and Certificate Request Message Format (CRMF). | |
6ede7d73 | 609 | |
257e9d03 | 610 | ### no-cms |
6ede7d73 DMSP |
611 | |
612 | Don't build support for Cryptographic Message Syntax (CMS). | |
613 | ||
257e9d03 | 614 | ### no-comp |
6ede7d73 DMSP |
615 | |
616 | Don't build support for SSL/TLS compression. | |
617 | ||
618 | If this option is enabled (the default), then compression will only work if | |
9afbb681 | 619 | the zlib or `zlib-dynamic` options are also chosen. |
6ede7d73 | 620 | |
257e9d03 | 621 | ### enable-crypto-mdebug |
6ede7d73 | 622 | |
9afbb681 | 623 | This now only enables the `failed-malloc` feature. |
6ede7d73 | 624 | |
257e9d03 | 625 | ### enable-crypto-mdebug-backtrace |
6ede7d73 DMSP |
626 | |
627 | This is a no-op; the project uses the compiler's address/leak sanitizer instead. | |
628 | ||
257e9d03 | 629 | ### no-ct |
6ede7d73 DMSP |
630 | |
631 | Don't build support for Certificate Transparency (CT). | |
632 | ||
257e9d03 | 633 | ### no-deprecated |
6ede7d73 DMSP |
634 | |
635 | Don't build with support for deprecated APIs up until and including the version | |
636 | given with `--api` (or the current version, if `--api` wasn't specified). | |
637 | ||
257e9d03 | 638 | ### no-dgram |
6ede7d73 DMSP |
639 | |
640 | Don't build support for datagram based BIOs. | |
641 | ||
642 | Selecting this option will also force the disabling of DTLS. | |
643 | ||
257e9d03 | 644 | ### no-dso |
6ede7d73 DMSP |
645 | |
646 | Don't build support for loading Dynamic Shared Objects (DSO) | |
647 | ||
257e9d03 | 648 | ### enable-devcryptoeng |
6ede7d73 DMSP |
649 | |
650 | Build the `/dev/crypto` engine. | |
651 | ||
652 | This option is automatically selected on the BSD platform, in which case it can | |
9afbb681 | 653 | be disabled with `no-devcryptoeng`. |
6ede7d73 | 654 | |
257e9d03 | 655 | ### no-dynamic-engine |
6ede7d73 DMSP |
656 | |
657 | Don't build the dynamically loaded engines. | |
658 | ||
659 | This only has an effect in a shared build. | |
660 | ||
257e9d03 | 661 | ### no-ec |
6ede7d73 DMSP |
662 | |
663 | Don't build support for Elliptic Curves. | |
664 | ||
257e9d03 | 665 | ### no-ec2m |
6ede7d73 DMSP |
666 | |
667 | Don't build support for binary Elliptic Curves | |
668 | ||
257e9d03 | 669 | ### enable-ec_nistp_64_gcc_128 |
6ede7d73 DMSP |
670 | |
671 | Enable support for optimised implementations of some commonly used NIST | |
672 | elliptic curves. | |
673 | ||
674 | This option is only supported on platforms: | |
675 | ||
676 | - with little-endian storage of non-byte types | |
677 | - that tolerate misaligned memory references | |
678 | - where the compiler: | |
679 | - supports the non-standard type `__uint128_t` | |
680 | - defines the built-in macro `__SIZEOF_INT128__` | |
681 | ||
257e9d03 | 682 | ### enable-egd |
6ede7d73 DMSP |
683 | |
684 | Build support for gathering entropy from the Entropy Gathering Daemon (EGD). | |
685 | ||
257e9d03 | 686 | ### no-engine |
6ede7d73 DMSP |
687 | |
688 | Don't build support for loading engines. | |
689 | ||
257e9d03 | 690 | ### no-err |
6ede7d73 DMSP |
691 | |
692 | Don't compile in any error strings. | |
693 | ||
257e9d03 | 694 | ### enable-external-tests |
6ede7d73 DMSP |
695 | |
696 | Enable building of integration with external test suites. | |
697 | ||
698 | This is a developer option and may not work on all platforms. The following | |
699 | external test suites are currently supported: | |
700 | ||
cede07dc | 701 | - GOST engine test suite |
6ede7d73 DMSP |
702 | - Python PYCA/Cryptography test suite |
703 | - krb5 test suite | |
704 | ||
036cbb6b DDO |
705 | See the file [test/README-external.md](test/README-external.md) |
706 | for further details. | |
6ede7d73 | 707 | |
257e9d03 | 708 | ### no-filenames |
6ede7d73 DMSP |
709 | |
710 | Don't compile in filename and line number information (e.g. for errors and | |
711 | memory allocation). | |
712 | ||
f2ea01d9 | 713 | ### enable-fips |
6ede7d73 | 714 | |
f2ea01d9 | 715 | Build (and install) the FIPS provider |
6ede7d73 | 716 | |
991a6bb5 SL |
717 | ### no-fips-securitychecks |
718 | ||
719 | Don't perform FIPS module run-time checks related to enforcement of security | |
720 | parameters such as minimum security strength of keys. | |
721 | ||
257e9d03 | 722 | ### enable-fuzz-libfuzzer, enable-fuzz-afl |
6ede7d73 DMSP |
723 | |
724 | Build with support for fuzzing using either libfuzzer or AFL. | |
725 | ||
726 | These are developer options only. They may not work on all platforms and | |
727 | should never be used in production environments. | |
728 | ||
729 | See the file [fuzz/README.md](fuzz/README.md) for further details. | |
730 | ||
257e9d03 | 731 | ### no-gost |
6ede7d73 DMSP |
732 | |
733 | Don't build support for GOST based ciphersuites. | |
734 | ||
735 | Note that if this feature is enabled then GOST ciphersuites are only available | |
736 | if the GOST algorithms are also available through loading an externally supplied | |
737 | engine. | |
738 | ||
257e9d03 | 739 | ### no-legacy |
6ede7d73 DMSP |
740 | |
741 | Don't build the legacy provider. | |
742 | ||
743 | Disabling this also disables the legacy algorithms: MD2 (already disabled by default). | |
744 | ||
257e9d03 | 745 | ### no-makedepend |
6ede7d73 DMSP |
746 | |
747 | Don't generate dependencies. | |
748 | ||
257e9d03 | 749 | ### no-module |
79e259e3 | 750 | |
6ede7d73 | 751 | Don't build any dynamically loadable engines. |
917a1b2e | 752 | |
9afbb681 | 753 | This also implies `no-dynamic-engine`. |
917a1b2e | 754 | |
257e9d03 | 755 | ### no-multiblock |
917a1b2e | 756 | |
6ede7d73 | 757 | Don't build support for writing multiple records in one go in libssl |
917a1b2e | 758 | |
6ede7d73 | 759 | Note: this is a different capability to the pipelining functionality. |
917a1b2e | 760 | |
257e9d03 | 761 | ### no-nextprotoneg |
917a1b2e | 762 | |
6ede7d73 | 763 | Don't build support for the Next Protocol Negotiation (NPN) TLS extension. |
c9f06e7f | 764 | |
257e9d03 | 765 | ### no-ocsp |
c9f06e7f | 766 | |
6ede7d73 | 767 | Don't build support for Online Certificate Status Protocol (OCSP). |
b32b8961 | 768 | |
257e9d03 | 769 | ### no-padlockeng |
2acd8ec7 | 770 | |
6ede7d73 | 771 | Don't build the padlock engine. |
2acd8ec7 | 772 | |
257e9d03 | 773 | ### no-hw-padlock |
c9f06e7f | 774 | |
9afbb681 | 775 | As synonym for `no-padlockeng`. Deprecated and should not be used. |
c9f06e7f | 776 | |
257e9d03 | 777 | ### no-pic |
b1fe6b43 | 778 | |
6ede7d73 | 779 | Don't build with support for Position Independent Code. |
b1fe6b43 | 780 | |
257e9d03 | 781 | ### no-pinshared |
79e259e3 | 782 | |
6ede7d73 | 783 | Don't pin the shared libraries. |
79e259e3 | 784 | |
6ede7d73 DMSP |
785 | By default OpenSSL will attempt to stay in memory until the process exits. |
786 | This is so that libcrypto and libssl can be properly cleaned up automatically | |
9afbb681 DDO |
787 | via an `atexit()` handler. The handler is registered by libcrypto and cleans |
788 | up both libraries. On some platforms the `atexit()` handler will run on unload of | |
6ede7d73 DMSP |
789 | libcrypto (if it has been dynamically loaded) rather than at process exit. This |
790 | option can be used to stop OpenSSL from attempting to stay in memory until the | |
791 | process exits. This could lead to crashes if either libcrypto or libssl have | |
792 | already been unloaded at the point that the atexit handler is invoked, e.g. on a | |
9afbb681 | 793 | platform which calls `atexit()` on unload of the library, and libssl is unloaded |
6ede7d73 | 794 | before libcrypto then a crash is likely to happen. Applications can suppress |
9afbb681 DDO |
795 | running of the `atexit()` handler at run time by using the |
796 | `OPENSSL_INIT_NO_ATEXIT` option to `OPENSSL_init_crypto()`. | |
797 | See the man page for it for further details. | |
2acd8ec7 | 798 | |
257e9d03 | 799 | ### no-posix-io |
2acd8ec7 | 800 | |
6ede7d73 | 801 | Don't use POSIX IO capabilities. |
2acd8ec7 | 802 | |
257e9d03 | 803 | ### no-psk |
79e259e3 | 804 | |
6ede7d73 | 805 | Don't build support for Pre-Shared Key based ciphersuites. |
79e259e3 | 806 | |
257e9d03 | 807 | ### no-rdrand |
79e259e3 | 808 | |
6ede7d73 | 809 | Don't use hardware RDRAND capabilities. |
79e259e3 | 810 | |
257e9d03 | 811 | ### no-rfc3779 |
5bb9e2b4 | 812 | |
6ede7d73 DMSP |
813 | Don't build support for RFC3779, "X.509 Extensions for IP Addresses and |
814 | AS Identifiers". | |
79e259e3 | 815 | |
257e9d03 | 816 | ### sctp |
2acd8ec7 | 817 | |
6ede7d73 | 818 | Build support for Stream Control Transmission Protocol (SCTP). |
2acd8ec7 | 819 | |
257e9d03 | 820 | ### no-shared |
2acd8ec7 | 821 | |
6ede7d73 | 822 | Do not create shared libraries, only static ones. |
2acd8ec7 | 823 | |
6ede7d73 | 824 | See [Notes on shared libraries](#notes-on-shared-libraries) below. |
2acd8ec7 | 825 | |
257e9d03 | 826 | ### no-sock |
2acd8ec7 | 827 | |
6ede7d73 | 828 | Don't build support for socket BIOs. |
2acd8ec7 | 829 | |
257e9d03 | 830 | ### no-srp |
2acd8ec7 | 831 | |
6ede7d73 DMSP |
832 | Don't build support for Secure Remote Password (SRP) protocol or |
833 | SRP based ciphersuites. | |
2acd8ec7 | 834 | |
257e9d03 | 835 | ### no-srtp |
b32b8961 | 836 | |
6ede7d73 | 837 | Don't build Secure Real-Time Transport Protocol (SRTP) support. |
b32b8961 | 838 | |
257e9d03 | 839 | ### no-sse2 |
2acd8ec7 | 840 | |
6ede7d73 | 841 | Exclude SSE2 code paths from 32-bit x86 assembly modules. |
79e259e3 | 842 | |
6ede7d73 DMSP |
843 | Normally SSE2 extension is detected at run-time, but the decision whether or not |
844 | the machine code will be executed is taken solely on CPU capability vector. This | |
845 | means that if you happen to run OS kernel which does not support SSE2 extension | |
846 | on Intel P4 processor, then your application might be exposed to "illegal | |
847 | instruction" exception. There might be a way to enable support in kernel, e.g. | |
9afbb681 | 848 | FreeBSD kernel can be compiled with `CPU_ENABLE_SSE`, and there is a way to |
6ede7d73 | 849 | disengage SSE2 code paths upon application start-up, but if you aim for wider |
9afbb681 DDO |
850 | "audience" running such kernel, consider `no-sse2`. Both the `386` and `no-asm` |
851 | options imply `no-sse2`. | |
79e259e3 | 852 | |
726f92e0 | 853 | ### no-ssl-trace |
79e259e3 | 854 | |
726f92e0 | 855 | Don't build with SSL Trace capabilities. |
1af66bb7 | 856 | |
726f92e0 ACB |
857 | This removes the `-trace` option from `s_client` and `s_server`, and omits the |
858 | `SSL_trace()` function from libssl. | |
859 | ||
860 | Disabling `ssl-trace` may provide a small reduction in libssl binary size. | |
1af66bb7 | 861 | |
257e9d03 | 862 | ### no-static-engine |
1af66bb7 | 863 | |
6ede7d73 | 864 | Don't build the statically linked engines. |
1af66bb7 | 865 | |
6ede7d73 | 866 | This only has an impact when not built "shared". |
1af66bb7 | 867 | |
257e9d03 | 868 | ### no-stdio |
1af66bb7 | 869 | |
3a0b3cc9 | 870 | Don't use anything from the C header file `stdio.h` that makes use of the `FILE` |
6ede7d73 DMSP |
871 | type. Only libcrypto and libssl can be built in this way. Using this option will |
872 | suppress building the command line applications. Additionally, since the OpenSSL | |
873 | tests also use the command line applications, the tests will also be skipped. | |
b1fe6b43 | 874 | |
257e9d03 | 875 | ### no-tests |
79e259e3 | 876 | |
6ede7d73 | 877 | Don't build test programs or run any tests. |
79e259e3 | 878 | |
257e9d03 | 879 | ### no-threads |
6616429d | 880 | |
6ede7d73 | 881 | Don't build with support for multi-threaded applications. |
2e996acf | 882 | |
257e9d03 | 883 | ### threads |
2acd8ec7 | 884 | |
6ede7d73 | 885 | Build with support for multi-threaded applications. Most platforms will enable |
8c1cbc72 | 886 | this by default. However, if on a platform where this is not the case then this |
6ede7d73 | 887 | will usually require additional system-dependent options! |
2e996acf | 888 | |
6ede7d73 | 889 | See [Notes on multi-threading](#notes-on-multi-threading) below. |
e3d9a6b5 | 890 | |
257e9d03 | 891 | ### enable-trace |
b32b8961 | 892 | |
6ede7d73 | 893 | Build with support for the integrated tracing api. |
2e996acf | 894 | |
6ede7d73 | 895 | See manual pages OSSL_trace_set_channel(3) and OSSL_trace_enabled(3) for details. |
2e996acf | 896 | |
257e9d03 | 897 | ### no-ts |
a73d990e | 898 | |
6ede7d73 | 899 | Don't build Time Stamping (TS) Authority support. |
2e996acf | 900 | |
257e9d03 | 901 | ### enable-ubsan |
2e996acf | 902 | |
6ede7d73 | 903 | Build with the Undefined Behaviour sanitiser (UBSAN). |
2e996acf | 904 | |
6ede7d73 | 905 | This is a developer option only. It may not work on all platforms and should |
9afbb681 DDO |
906 | never be used in production environments. It will only work when used with |
907 | gcc or clang and should be used in conjunction with the `-DPEDANTIC` option | |
6ede7d73 | 908 | (or the `--strict-warnings` option). |
d40b0622 | 909 | |
257e9d03 | 910 | ### no-ui-console |
2e996acf | 911 | |
301ea192 | 912 | Don't build with the User Interface (UI) console method |
b1fe6b43 | 913 | |
301ea192 | 914 | The User Interface console method enables text based console prompts. |
b3e718e2 | 915 | |
257e9d03 | 916 | ### enable-unit-test |
79e259e3 | 917 | |
6ede7d73 | 918 | Enable additional unit test APIs. |
2acd8ec7 | 919 | |
6ede7d73 | 920 | This should not typically be used in production deployments. |
7c03bb9f | 921 | |
257e9d03 | 922 | ### no-uplink |
2acd8ec7 | 923 | |
6ede7d73 | 924 | Don't build support for UPLINK interface. |
2acd8ec7 | 925 | |
257e9d03 | 926 | ### enable-weak-ssl-ciphers |
b0940b33 | 927 | |
6ede7d73 | 928 | Build support for SSL/TLS ciphers that are considered "weak" |
fa28bfd6 | 929 | |
6ede7d73 | 930 | Enabling this includes for example the RC4 based ciphersuites. |
fa28bfd6 | 931 | |
257e9d03 | 932 | ### zlib |
fa28bfd6 | 933 | |
6ede7d73 | 934 | Build with support for zlib compression/decompression. |
fa28bfd6 | 935 | |
257e9d03 | 936 | ### zlib-dynamic |
fa28bfd6 | 937 | |
6ede7d73 DMSP |
938 | Like the zlib option, but has OpenSSL load the zlib library dynamically |
939 | when needed. | |
fa28bfd6 | 940 | |
6ede7d73 | 941 | This is only supported on systems where loading of shared libraries is supported. |
fa28bfd6 | 942 | |
257e9d03 | 943 | ### 386 |
fa28bfd6 | 944 | |
6ede7d73 | 945 | In 32-bit x86 builds, use the 80386 instruction set only in assembly modules |
fa28bfd6 | 946 | |
6ede7d73 DMSP |
947 | The default x86 code is more efficient, but requires at least an 486 processor. |
948 | Note: This doesn't affect compiler generated code, so this option needs to be | |
949 | accompanied by a corresponding compiler-specific option. | |
fa28bfd6 | 950 | |
257e9d03 | 951 | ### no-{protocol} |
bf01fbbf | 952 | |
6ede7d73 | 953 | no-{ssl|ssl3|tls|tls1|tls1_1|tls1_2|tls1_3|dtls|dtls1|dtls1_2} |
4fd53220 | 954 | |
6ede7d73 | 955 | Don't build support for negotiating the specified SSL/TLS protocol. |
b3e718e2 | 956 | |
9afbb681 DDO |
957 | If `no-tls` is selected then all of `tls1`, `tls1_1`, `tls1_2` and `tls1_3` |
958 | are disabled. | |
959 | Similarly `no-dtls` will disable `dtls1` and `dtls1_2`. The `no-ssl` option is | |
960 | synonymous with `no-ssl3`. Note this only affects version negotiation. | |
6ede7d73 DMSP |
961 | OpenSSL will still provide the methods for applications to explicitly select |
962 | the individual protocol versions. | |
b3e718e2 | 963 | |
257e9d03 | 964 | ### no-{protocol}-method |
b3e718e2 | 965 | |
6ede7d73 | 966 | no-{ssl|ssl3|tls|tls1|tls1_1|tls1_2|tls1_3|dtls|dtls1|dtls1_2}-method |
b3e718e2 | 967 | |
9afbb681 | 968 | Analogous to `no-{protocol}` but in addition do not build the methods for |
6ede7d73 | 969 | applications to explicitly select individual protocol versions. Note that there |
9afbb681 | 970 | is no `no-tls1_3-method` option because there is no application method for |
6ede7d73 | 971 | TLSv1.3. |
b3e718e2 | 972 | |
6ede7d73 | 973 | Using individual protocol methods directly is deprecated. Applications should |
9afbb681 | 974 | use `TLS_method()` instead. |
b3e718e2 | 975 | |
257e9d03 | 976 | ### enable-{algorithm} |
b3e718e2 | 977 | |
6ede7d73 | 978 | enable-{md2|rc5} |
b3e718e2 | 979 | |
6ede7d73 | 980 | Build with support for the specified algorithm. |
b3e718e2 | 981 | |
257e9d03 | 982 | ### no-{algorithm} |
b3e718e2 | 983 | |
6ede7d73 DMSP |
984 | no-{aria|bf|blake2|camellia|cast|chacha|cmac| |
985 | des|dh|dsa|ecdh|ecdsa|idea|md4|mdc2|ocb| | |
986 | poly1305|rc2|rc4|rmd160|scrypt|seed| | |
987 | siphash|siv|sm2|sm3|sm4|whirlpool} | |
d0631327 | 988 | |
6ede7d73 | 989 | Build without support for the specified algorithm. |
d0631327 | 990 | |
9afbb681 | 991 | The `ripemd` algorithm is deprecated and if used is synonymous with `rmd160`. |
d0631327 | 992 | |
257e9d03 | 993 | ### Compiler-specific options |
d0631327 | 994 | |
6ede7d73 | 995 | -Dxxx, -Ixxx, -Wp, -lxxx, -Lxxx, -Wl, -rpath, -R, -framework, -static |
d0631327 | 996 | |
6ede7d73 DMSP |
997 | These system specific options will be recognised and passed through to the |
998 | compiler to allow you to define preprocessor symbols, specify additional | |
999 | libraries, library directories or other compiler options. It might be worth | |
1000 | noting that some compilers generate code specifically for processor the | |
1001 | compiler currently executes on. This is not necessarily what you might have | |
1002 | in mind, since it might be unsuitable for execution on other, typically older, | |
1003 | processor. Consult your compiler documentation. | |
1004 | ||
1005 | Take note of the [Environment Variables](#environment-variables) documentation | |
1006 | below and how these flags interact with those variables. | |
1007 | ||
1008 | -xxx, +xxx, /xxx | |
1009 | ||
1010 | Additional options that are not otherwise recognised are passed through as | |
1011 | they are to the compiler as well. Unix-style options beginning with a | |
9afbb681 | 1012 | `-` or `+` and Windows-style options beginning with a `/` are recognized. |
6ede7d73 DMSP |
1013 | Again, consult your compiler documentation. |
1014 | ||
1015 | If the option contains arguments separated by spaces, then the URL-style | |
9afbb681 DDO |
1016 | notation `%20` can be used for the space character in order to avoid having |
1017 | to quote the option. For example, `-opt%20arg` gets expanded to `-opt arg`. | |
6ede7d73 DMSP |
1018 | In fact, any ASCII character can be encoded as %xx using its hexadecimal |
1019 | encoding. | |
1020 | ||
1021 | Take note of the [Environment Variables](#environment-variables) documentation | |
1022 | below and how these flags interact with those variables. | |
1023 | ||
257e9d03 | 1024 | ### Environment Variables |
6ede7d73 DMSP |
1025 | |
1026 | VAR=value | |
1027 | ||
9afbb681 | 1028 | Assign the given value to the environment variable `VAR` for `Configure`. |
6ede7d73 DMSP |
1029 | |
1030 | These work just like normal environment variable assignments, but are supported | |
1031 | on all platforms and are confined to the configuration scripts only. | |
1032 | These assignments override the corresponding value in the inherited environment, | |
1033 | if there is one. | |
1034 | ||
3a0b3cc9 | 1035 | The following variables are used as "`make` variables" and can be used as an |
6ede7d73 DMSP |
1036 | alternative to giving preprocessor, compiler and linker options directly as |
1037 | configuration. The following variables are supported: | |
1038 | ||
1039 | AR The static library archiver. | |
1040 | ARFLAGS Flags for the static library archiver. | |
1041 | AS The assembler compiler. | |
1042 | ASFLAGS Flags for the assembler compiler. | |
1043 | CC The C compiler. | |
1044 | CFLAGS Flags for the C compiler. | |
1045 | CXX The C++ compiler. | |
1046 | CXXFLAGS Flags for the C++ compiler. | |
1047 | CPP The C/C++ preprocessor. | |
1048 | CPPFLAGS Flags for the C/C++ preprocessor. | |
1049 | CPPDEFINES List of CPP macro definitions, separated | |
1050 | by a platform specific character (':' or | |
1051 | space for Unix, ';' for Windows, ',' for | |
1052 | VMS). This can be used instead of using | |
1053 | -D (or what corresponds to that on your | |
1054 | compiler) in CPPFLAGS. | |
1055 | CPPINCLUDES List of CPP inclusion directories, separated | |
1056 | the same way as for CPPDEFINES. This can | |
1057 | be used instead of -I (or what corresponds | |
1058 | to that on your compiler) in CPPFLAGS. | |
1059 | HASHBANGPERL Perl invocation to be inserted after '#!' | |
1060 | in public perl scripts (only relevant on | |
1061 | Unix). | |
1062 | LD The program linker (not used on Unix, $(CC) | |
1063 | is used there). | |
1064 | LDFLAGS Flags for the shared library, DSO and | |
1065 | program linker. | |
1066 | LDLIBS Extra libraries to use when linking. | |
1067 | Takes the form of a space separated list | |
1068 | of library specifications on Unix and | |
1069 | Windows, and as a comma separated list of | |
1070 | libraries on VMS. | |
1071 | RANLIB The library archive indexer. | |
1072 | RC The Windows resource compiler. | |
1073 | RCFLAGS Flags for the Windows resource compiler. | |
1074 | RM The command to remove files and directories. | |
1075 | ||
1076 | These cannot be mixed with compiling/linking flags given on the command line. | |
1077 | In other words, something like this isn't permitted. | |
1078 | ||
16b0e0fc | 1079 | $ ./Configure -DFOO CPPFLAGS=-DBAR -DCOOKIE |
6ede7d73 DMSP |
1080 | |
1081 | Backward compatibility note: | |
1082 | ||
1083 | To be compatible with older configuration scripts, the environment variables | |
1084 | are ignored if compiling/linking flags are given on the command line, except | |
1085 | for the following: | |
1086 | ||
1087 | AR, CC, CXX, CROSS_COMPILE, HASHBANGPERL, PERL, RANLIB, RC, and WINDRES | |
1088 | ||
9afbb681 | 1089 | For example, the following command will not see `-DBAR`: |
6ede7d73 | 1090 | |
16b0e0fc | 1091 | $ CPPFLAGS=-DBAR ./Configure -DCOOKIE |
6ede7d73 DMSP |
1092 | |
1093 | However, the following will see both set variables: | |
1094 | ||
16b0e0fc | 1095 | $ CC=gcc CROSS_COMPILE=x86_64-w64-mingw32- ./Configure -DCOOKIE |
6ede7d73 | 1096 | |
9afbb681 | 1097 | If `CC` is set, it is advisable to also set `CXX` to ensure both the C and C++ |
6ede7d73 | 1098 | compiler are in the same "family". This becomes relevant with |
9afbb681 | 1099 | `enable-external-tests` and `enable-buildtest-c++`. |
6ede7d73 | 1100 | |
257e9d03 | 1101 | ### Reconfigure |
6ede7d73 DMSP |
1102 | |
1103 | reconf | |
1104 | reconfigure | |
1105 | ||
1106 | Reconfigure from earlier data. | |
1107 | ||
16b0e0fc | 1108 | This fetches the previous command line options and environment from data |
9afbb681 | 1109 | saved in `configdata.pm` and runs the configuration process again, using |
16b0e0fc | 1110 | these options and environment. Note: NO other option is permitted together |
9afbb681 | 1111 | with `reconf`. Note: The original configuration saves away values for ALL |
16b0e0fc RL |
1112 | environment variables that were used, and if they weren't defined, they are |
1113 | still saved away with information that they weren't originally defined. | |
1114 | This information takes precedence over environment variables that are | |
1115 | defined when reconfiguring. | |
6ede7d73 DMSP |
1116 | |
1117 | Displaying configuration data | |
1118 | ----------------------------- | |
1119 | ||
1120 | The configuration script itself will say very little, and finishes by | |
9afbb681 | 1121 | creating `configdata.pm`. This perl module can be loaded by other scripts |
6ede7d73 DMSP |
1122 | to find all the configuration data, and it can also be used as a script to |
1123 | display all sorts of configuration data in a human readable form. | |
1124 | ||
1125 | For more information, please do: | |
1126 | ||
1127 | $ ./configdata.pm --help # Unix | |
1128 | ||
1129 | or | |
1130 | ||
1131 | $ perl configdata.pm --help # Windows and VMS | |
1132 | ||
1133 | Installation Steps in Detail | |
1134 | ============================ | |
1135 | ||
1136 | Configure OpenSSL | |
1137 | ----------------- | |
1138 | ||
257e9d03 | 1139 | ### Automatic Configuration |
6ede7d73 DMSP |
1140 | |
1141 | On some platform a `config` script is available which attempts to guess | |
1142 | your operating system (and compiler, if necessary) and calls the `Configure` | |
1143 | Perl script with appropriate target based on its guess. Further options can | |
1144 | be supplied to the `config` script, which will be passed on to the `Configure` | |
1145 | script. | |
1146 | ||
257e9d03 | 1147 | #### Unix / Linux / macOS |
6ede7d73 | 1148 | |
16b0e0fc | 1149 | $ ./Configure [[ options ]] |
6ede7d73 | 1150 | |
257e9d03 | 1151 | #### OpenVMS |
6ede7d73 | 1152 | |
16b0e0fc | 1153 | $ perl Configure [[ options ]] |
6ede7d73 | 1154 | |
257e9d03 | 1155 | #### Windows |
6ede7d73 | 1156 | |
16b0e0fc | 1157 | $ perl Configure [[ options ]] |
6ede7d73 | 1158 | |
257e9d03 | 1159 | ### Manual Configuration |
6ede7d73 DMSP |
1160 | |
1161 | OpenSSL knows about a range of different operating system, hardware and | |
1162 | compiler combinations. To see the ones it knows about, run | |
1163 | ||
16b0e0fc | 1164 | $ ./Configure LIST # Unix |
6ede7d73 DMSP |
1165 | |
1166 | or | |
1167 | ||
16b0e0fc | 1168 | $ perl Configure LIST # All other platforms |
6ede7d73 DMSP |
1169 | |
1170 | For the remainder of this text, the Unix form will be used in all examples. | |
1171 | Please use the appropriate form for your platform. | |
1172 | ||
1173 | Pick a suitable name from the list that matches your system. For most | |
9afbb681 | 1174 | operating systems there is a choice between using cc or gcc. |
6ede7d73 | 1175 | When you have identified your system (and if necessary compiler) use this |
9afbb681 | 1176 | name as the argument to `Configure`. For example, a `linux-elf` user would |
6ede7d73 DMSP |
1177 | run: |
1178 | ||
1179 | $ ./Configure linux-elf [[ options ]] | |
1180 | ||
257e9d03 | 1181 | ### Creating your own Configuration |
6ede7d73 DMSP |
1182 | |
1183 | If your system isn't listed, you will have to create a configuration | |
9afbb681 | 1184 | file named `Configurations/{{ something }}.conf` and add the correct |
6ede7d73 | 1185 | configuration for your system. See the available configs as examples |
036cbb6b DDO |
1186 | and read [Configurations/README.md](Configurations/README.md) and |
1187 | [Configurations/README-design.md](Configurations/README-design.md) | |
3a0b3cc9 | 1188 | for more information. |
6ede7d73 | 1189 | |
9afbb681 | 1190 | The generic configurations `cc` or `gcc` should usually work on 32 bit |
6ede7d73 DMSP |
1191 | Unix-like systems. |
1192 | ||
9afbb681 DDO |
1193 | `Configure` creates a build file (`Makefile` on Unix, `makefile` on Windows |
1194 | and `descrip.mms` on OpenVMS) from a suitable template in `Configurations/`, | |
1195 | and defines various macros in `include/openssl/configuration.h` (generated | |
1196 | from `include/openssl/configuration.h.in`. | |
6ede7d73 | 1197 | |
257e9d03 | 1198 | ### Out of Tree Builds |
6ede7d73 DMSP |
1199 | |
1200 | OpenSSL can be configured to build in a build directory separate from the | |
1201 | source code directory. It's done by placing yourself in some other | |
1202 | directory and invoking the configuration commands from there. | |
1203 | ||
257e9d03 | 1204 | #### Unix example |
6ede7d73 DMSP |
1205 | |
1206 | $ mkdir /var/tmp/openssl-build | |
1207 | $ cd /var/tmp/openssl-build | |
16b0e0fc | 1208 | $ /PATH/TO/OPENSSL/SOURCE/Configure [[ options ]] |
6ede7d73 | 1209 | |
257e9d03 | 1210 | #### OpenVMS example |
6ede7d73 DMSP |
1211 | |
1212 | $ set default sys$login: | |
1213 | $ create/dir [.tmp.openssl-build] | |
1214 | $ set default [.tmp.openssl-build] | |
16b0e0fc | 1215 | $ perl D:[PATH.TO.OPENSSL.SOURCE]Configure [[ options ]] |
6ede7d73 | 1216 | |
257e9d03 | 1217 | #### Windows example |
6ede7d73 DMSP |
1218 | |
1219 | $ C: | |
1220 | $ mkdir \temp-openssl | |
1221 | $ cd \temp-openssl | |
16b0e0fc | 1222 | $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure [[ options ]] |
6ede7d73 | 1223 | |
9afbb681 | 1224 | Paths can be relative just as well as absolute. `Configure` will do its best |
6ede7d73 DMSP |
1225 | to translate them to relative paths whenever possible. |
1226 | ||
6ede7d73 DMSP |
1227 | Build OpenSSL |
1228 | ------------- | |
1229 | ||
1230 | Build OpenSSL by running: | |
1231 | ||
1232 | $ make # Unix | |
1233 | $ mms ! (or mmk) OpenVMS | |
1234 | $ nmake # Windows | |
1235 | ||
9afbb681 | 1236 | This will build the OpenSSL libraries (`libcrypto.a` and `libssl.a` on |
6ede7d73 | 1237 | Unix, corresponding on other platforms) and the OpenSSL binary |
9afbb681 DDO |
1238 | (`openssl`). The libraries will be built in the top-level directory, |
1239 | and the binary will be in the `apps/` subdirectory. | |
6ede7d73 DMSP |
1240 | |
1241 | If the build fails, take a look at the [Build Failures](#build-failures) | |
1242 | subsection of the [Troubleshooting](#troubleshooting) section. | |
1243 | ||
1244 | Test OpenSSL | |
1245 | ------------ | |
1246 | ||
1247 | After a successful build, and before installing, the libraries should | |
1248 | be tested. Run: | |
1249 | ||
1250 | $ make test # Unix | |
1251 | $ mms test ! OpenVMS | |
1252 | $ nmake test # Windows | |
1253 | ||
1254 | **Warning:** you MUST run the tests from an unprivileged account (or disable | |
1255 | your privileges temporarily if your platform allows it). | |
1256 | ||
036cbb6b DDO |
1257 | See [test/README.md](test/README.md) for further details how run tests. |
1258 | ||
1259 | See [test/README-dev.md](test/README-dev.md) for guidelines on adding tests. | |
6ede7d73 | 1260 | |
6ede7d73 DMSP |
1261 | Install OpenSSL |
1262 | --------------- | |
1263 | ||
1264 | If everything tests ok, install OpenSSL with | |
1265 | ||
1266 | $ make install # Unix | |
1267 | $ mms install ! OpenVMS | |
1268 | $ nmake install # Windows | |
1269 | ||
1270 | Note that in order to perform the install step above you need to have | |
1271 | appropriate permissions to write to the installation directory. | |
1272 | ||
1273 | The above commands will install all the software components in this | |
9afbb681 | 1274 | directory tree under `<PREFIX>` (the directory given with `--prefix` or |
6ede7d73 DMSP |
1275 | its default): |
1276 | ||
257e9d03 | 1277 | ### Unix / Linux / macOS |
6ede7d73 DMSP |
1278 | |
1279 | bin/ Contains the openssl binary and a few other | |
1280 | utility scripts. | |
1281 | include/openssl | |
1282 | Contains the header files needed if you want | |
1283 | to build your own programs that use libcrypto | |
1284 | or libssl. | |
1285 | lib Contains the OpenSSL library files. | |
1286 | lib/engines Contains the OpenSSL dynamically loadable engines. | |
1287 | ||
1288 | share/man/man1 Contains the OpenSSL command line man-pages. | |
1289 | share/man/man3 Contains the OpenSSL library calls man-pages. | |
1290 | share/man/man5 Contains the OpenSSL configuration format man-pages. | |
1291 | share/man/man7 Contains the OpenSSL other misc man-pages. | |
1292 | ||
1293 | share/doc/openssl/html/man1 | |
1294 | share/doc/openssl/html/man3 | |
1295 | share/doc/openssl/html/man5 | |
1296 | share/doc/openssl/html/man7 | |
1297 | Contains the HTML rendition of the man-pages. | |
1298 | ||
257e9d03 | 1299 | ### OpenVMS |
6ede7d73 | 1300 | |
d8c1cafb | 1301 | 'arch' is replaced with the architecture name, `ALPHA` or `IA64`, |
9afbb681 | 1302 | 'sover' is replaced with the shared library version (`0101` for 1.1), and |
6ede7d73 DMSP |
1303 | 'pz' is replaced with the pointer size OpenSSL was built with: |
1304 | ||
1305 | [.EXE.'arch'] Contains the openssl binary. | |
1306 | [.EXE] Contains a few utility scripts. | |
1307 | [.include.openssl] | |
1308 | Contains the header files needed if you want | |
1309 | to build your own programs that use libcrypto | |
1310 | or libssl. | |
1311 | [.LIB.'arch'] Contains the OpenSSL library files. | |
1312 | [.ENGINES'sover''pz'.'arch'] | |
1313 | Contains the OpenSSL dynamically loadable engines. | |
1314 | [.SYS$STARTUP] Contains startup, login and shutdown scripts. | |
1315 | These define appropriate logical names and | |
1316 | command symbols. | |
1317 | [.SYSTEST] Contains the installation verification procedure. | |
1318 | [.HTML] Contains the HTML rendition of the manual pages. | |
1319 | ||
257e9d03 | 1320 | ### Additional Directories |
6ede7d73 DMSP |
1321 | |
1322 | Additionally, install will add the following directories under | |
1323 | OPENSSLDIR (the directory given with `--openssldir` or its default) | |
1324 | for you convenience: | |
1325 | ||
1326 | certs Initially empty, this is the default location | |
1327 | for certificate files. | |
1328 | private Initially empty, this is the default location | |
1329 | for private key files. | |
1330 | misc Various scripts. | |
1331 | ||
1332 | The installation directory should be appropriately protected to ensure | |
1333 | unprivileged users cannot make changes to OpenSSL binaries or files, or | |
1334 | install engines. If you already have a pre-installed version of OpenSSL as | |
1335 | part of your Operating System it is recommended that you do not overwrite | |
1336 | the system version and instead install to somewhere else. | |
1337 | ||
1338 | Package builders who want to configure the library for standard locations, | |
1339 | but have the package installed somewhere else so that it can easily be | |
1340 | packaged, can use | |
1341 | ||
3a0b3cc9 DDO |
1342 | $ make DESTDIR=/tmp/package-root install # Unix |
1343 | $ mms/macro="DESTDIR=TMP:[PACKAGE-ROOT]" install ! OpenVMS | |
6ede7d73 DMSP |
1344 | |
1345 | The specified destination directory will be prepended to all installation | |
1346 | target paths. | |
1347 | ||
257e9d03 RS |
1348 | Compatibility issues with previous OpenSSL versions |
1349 | --------------------------------------------------- | |
6ede7d73 | 1350 | |
257e9d03 | 1351 | ### COMPILING existing applications |
6ede7d73 DMSP |
1352 | |
1353 | Starting with version 1.1.0, OpenSSL hides a number of structures that were | |
1354 | previously open. This includes all internal libssl structures and a number | |
1355 | of EVP types. Accessor functions have been added to allow controlled access | |
1356 | to the structures' data. | |
1357 | ||
1358 | This means that some software needs to be rewritten to adapt to the new ways | |
1359 | of doing things. This often amounts to allocating an instance of a structure | |
1360 | explicitly where you could previously allocate them on the stack as automatic | |
1361 | variables, and using the provided accessor functions where you would previously | |
1362 | access a structure's field directly. | |
1363 | ||
1364 | Some APIs have changed as well. However, older APIs have been preserved when | |
1365 | possible. | |
1366 | ||
41149648 RL |
1367 | Post-installation Notes |
1368 | ----------------------- | |
1369 | ||
1370 | With the default OpenSSL installation comes a FIPS provider module, which | |
1371 | needs some post-installation attention, without which it will not be usable. | |
1372 | This involves using the following command: | |
1373 | ||
270540fd | 1374 | $ openssl fipsinstall |
41149648 RL |
1375 | |
1376 | See the openssl-fipsinstall(1) manual for details and examples. | |
1377 | ||
6ede7d73 DMSP |
1378 | Advanced Build Options |
1379 | ====================== | |
1380 | ||
6ede7d73 DMSP |
1381 | Environment Variables |
1382 | --------------------- | |
1383 | ||
1384 | A number of environment variables can be used to provide additional control | |
1385 | over the build process. Typically these should be defined prior to running | |
9afbb681 | 1386 | `Configure`. Not all environment variables are relevant to all platforms. |
6ede7d73 DMSP |
1387 | |
1388 | AR | |
1389 | The name of the ar executable to use. | |
1390 | ||
1391 | BUILDFILE | |
1392 | Use a different build file name than the platform default | |
1393 | ("Makefile" on Unix-like platforms, "makefile" on native Windows, | |
1394 | "descrip.mms" on OpenVMS). This requires that there is a | |
036cbb6b DDO |
1395 | corresponding build file template. |
1396 | See [Configurations/README.md](Configurations/README.md) | |
6ede7d73 DMSP |
1397 | for further information. |
1398 | ||
1399 | CC | |
1400 | The compiler to use. Configure will attempt to pick a default | |
1401 | compiler for your platform but this choice can be overridden | |
1402 | using this variable. Set it to the compiler executable you wish | |
9afbb681 | 1403 | to use, e.g. gcc or clang. |
6ede7d73 DMSP |
1404 | |
1405 | CROSS_COMPILE | |
1406 | This environment variable has the same meaning as for the | |
1407 | "--cross-compile-prefix" Configure flag described above. If both | |
1408 | are set then the Configure flag takes precedence. | |
1409 | ||
1410 | NM | |
1411 | The name of the nm executable to use. | |
1412 | ||
1413 | OPENSSL_LOCAL_CONFIG_DIR | |
1414 | OpenSSL comes with a database of information about how it | |
1415 | should be built on different platforms as well as build file | |
1416 | templates for those platforms. The database is comprised of | |
1417 | ".conf" files in the Configurations directory. The build | |
1418 | file templates reside there as well as ".tmpl" files. See the | |
036cbb6b DDO |
1419 | file [Configurations/README.md](Configurations/README.md) |
1420 | for further information about the format of ".conf" files | |
1421 | as well as information on the ".tmpl" files. | |
6ede7d73 | 1422 | In addition to the standard ".conf" and ".tmpl" files, it is |
036cbb6b DDO |
1423 | possible to create your own ".conf" and ".tmpl" files and |
1424 | store them locally, outside the OpenSSL source tree. | |
1425 | This environment variable can be set to the directory where | |
1426 | these files are held and will be considered by Configure | |
1427 | before it looks in the standard directories. | |
6ede7d73 DMSP |
1428 | |
1429 | PERL | |
1430 | The name of the Perl executable to use when building OpenSSL. | |
16b0e0fc RL |
1431 | Only needed if builing should use a different Perl executable |
1432 | than what is used to run the Configure script. | |
6ede7d73 DMSP |
1433 | |
1434 | HASHBANGPERL | |
1435 | The command string for the Perl executable to insert in the | |
1436 | #! line of perl scripts that will be publicly installed. | |
1437 | Default: /usr/bin/env perl | |
1438 | Note: the value of this variable is added to the same scripts | |
1439 | on all platforms, but it's only relevant on Unix-like platforms. | |
1440 | ||
1441 | RC | |
1442 | The name of the rc executable to use. The default will be as | |
1443 | defined for the target platform in the ".conf" file. If not | |
1444 | defined then "windres" will be used. The WINDRES environment | |
1445 | variable is synonymous to this. If both are defined then RC | |
1446 | takes precedence. | |
1447 | ||
1448 | RANLIB | |
1449 | The name of the ranlib executable to use. | |
1450 | ||
1451 | WINDRES | |
1452 | See RC. | |
1453 | ||
6ede7d73 DMSP |
1454 | Makefile Targets |
1455 | ---------------- | |
1456 | ||
9afbb681 | 1457 | The `Configure` script generates a Makefile in a format relevant to the specific |
6ede7d73 DMSP |
1458 | platform. The Makefiles provide a number of targets that can be used. Not all |
1459 | targets may be available on all platforms. Only the most common targets are | |
1460 | described here. Examine the Makefiles themselves for the full list. | |
1461 | ||
1462 | all | |
1463 | The target to build all the software components and | |
1464 | documentation. | |
1465 | ||
1466 | build_sw | |
1467 | Build all the software components. | |
1468 | THIS IS THE DEFAULT TARGET. | |
1469 | ||
1470 | build_docs | |
1471 | Build all documentation components. | |
1472 | ||
1473 | clean | |
1474 | Remove all build artefacts and return the directory to a "clean" | |
1475 | state. | |
1476 | ||
1477 | depend | |
1478 | Rebuild the dependencies in the Makefiles. This is a legacy | |
1479 | option that no longer needs to be used since OpenSSL 1.1.0. | |
1480 | ||
1481 | install | |
1482 | Install all OpenSSL components. | |
1483 | ||
1484 | install_sw | |
1485 | Only install the OpenSSL software components. | |
1486 | ||
1487 | install_docs | |
1488 | Only install the OpenSSL documentation components. | |
1489 | ||
1490 | install_man_docs | |
1491 | Only install the OpenSSL man pages (Unix only). | |
1492 | ||
1493 | install_html_docs | |
8c1cbc72 | 1494 | Only install the OpenSSL HTML documentation. |
cad80959 | 1495 | |
b19b9830 RL |
1496 | install_fips |
1497 | Install the FIPS provider module configuration file. | |
6ede7d73 DMSP |
1498 | |
1499 | list-tests | |
1500 | Prints a list of all the self test names. | |
1501 | ||
1502 | test | |
1503 | Build and run the OpenSSL self tests. | |
1504 | ||
1505 | uninstall | |
1506 | Uninstall all OpenSSL components. | |
1507 | ||
1508 | reconfigure | |
1509 | reconf | |
1510 | Re-run the configuration process, as exactly as the last time | |
1511 | as possible. | |
1512 | ||
1513 | update | |
1514 | This is a developer option. If you are developing a patch for | |
1515 | OpenSSL you may need to use this if you want to update | |
1516 | automatically generated files; add new error codes or add new | |
1517 | (or change the visibility of) public API functions. (Unix only). | |
1518 | ||
1519 | Running Selected Tests | |
1520 | ---------------------- | |
1521 | ||
3a0b3cc9 DDO |
1522 | You can specify a set of tests to be performed |
1523 | using the `make` variable `TESTS`. | |
6ede7d73 | 1524 | |
3a0b3cc9 DDO |
1525 | See the section [Running Selected Tests of |
1526 | test/README.md](test/README.md#running-selected-tests). | |
6ede7d73 DMSP |
1527 | |
1528 | Troubleshooting | |
1529 | =============== | |
1530 | ||
1531 | Configuration Problems | |
1532 | ---------------------- | |
1533 | ||
257e9d03 | 1534 | ### Selecting the correct target |
6ede7d73 | 1535 | |
16b0e0fc | 1536 | The `./Configure` script tries hard to guess your operating system, but in some |
6ede7d73 DMSP |
1537 | cases it does not succeed. You will see a message like the following: |
1538 | ||
16b0e0fc | 1539 | $ ./Configure |
6ede7d73 | 1540 | Operating system: x86-whatever-minix |
1dc1ea18 | 1541 | This system (minix) is not supported. See file INSTALL.md for details. |
6ede7d73 | 1542 | |
9afbb681 DDO |
1543 | Even if the automatic target selection by the `./Configure` script fails, |
1544 | chances are that you still might find a suitable target in the `Configurations` | |
1545 | directory, which you can supply to the `./Configure` command, | |
1546 | possibly after some adjustment. | |
6ede7d73 | 1547 | |
9afbb681 | 1548 | The `Configurations/` directory contains a lot of examples of such targets. |
6c8149df | 1549 | The main configuration file is [10-main.conf], which contains all targets that |
6ede7d73 DMSP |
1550 | are officially supported by the OpenSSL team. Other configuration files contain |
1551 | targets contributed by other OpenSSL users. The list of targets can be found in | |
1552 | a Perl list `my %targets = ( ... )`. | |
1553 | ||
1554 | my %targets = ( | |
1555 | ... | |
1556 | "target-name" => { | |
1557 | inherit_from => [ "base-target" ], | |
1558 | CC => "...", | |
1559 | cflags => add("..."), | |
1560 | asm_arch => '...', | |
1561 | perlasm_scheme => "...", | |
1562 | }, | |
1563 | ... | |
1564 | ) | |
1565 | ||
16b0e0fc | 1566 | If you call `./Configure` without arguments, it will give you a list of all |
6ede7d73 | 1567 | known targets. Using `grep`, you can lookup the target definition in the |
9afbb681 DDO |
1568 | `Configurations/` directory. For example the `android-x86_64` can be found in |
1569 | [Configurations/15-android.conf](Configurations/15-android.conf). | |
6ede7d73 DMSP |
1570 | |
1571 | The directory contains two README files, which explain the general syntax and | |
9afbb681 | 1572 | design of the configuration files. |
6ede7d73 | 1573 | |
036cbb6b DDO |
1574 | - [Configurations/README.md](Configurations/README.md) |
1575 | - [Configurations/README-design.md](Configurations/README-design.md) | |
6ede7d73 | 1576 | |
6c8149df DMSP |
1577 | If you need further help, try to search the [openssl-users] mailing list |
1578 | or the [GitHub Issues] for existing solutions. If you don't find anything, | |
1579 | you can [raise an issue] to ask a question yourself. | |
6ede7d73 | 1580 | |
6c8149df | 1581 | More about our support resources can be found in the [SUPPORT] file. |
6ede7d73 | 1582 | |
257e9d03 | 1583 | ### Configuration Errors |
6ede7d73 | 1584 | |
16b0e0fc | 1585 | If the `./Configure` or `./Configure` command fails with an error message, |
6ede7d73 DMSP |
1586 | read the error message carefully and try to figure out whether you made |
1587 | a mistake (e.g., by providing a wrong option), or whether the script is | |
1588 | working incorrectly. If you think you encountered a bug, please | |
6c8149df | 1589 | [raise an issue] on GitHub to file a bug report. |
6ede7d73 DMSP |
1590 | |
1591 | Along with a short description of the bug, please provide the complete | |
1592 | configure command line and the relevant output including the error message. | |
1593 | ||
1594 | Note: To make the output readable, pleace add a 'code fence' (three backquotes | |
1595 | ` ``` ` on a separate line) before and after your output: | |
1596 | ||
1597 | ``` | |
b0d5c1cb | 1598 | ./Configure [your arguments...] |
6ede7d73 DMSP |
1599 | |
1600 | [output...] | |
1601 | ||
1602 | ``` | |
1603 | ||
6ede7d73 DMSP |
1604 | Build Failures |
1605 | -------------- | |
1606 | ||
1607 | If the build fails, look carefully at the output. Try to locate and understand | |
1608 | the error message. It might be that the compiler is already telling you | |
1609 | exactly what you need to do to fix your problem. | |
1610 | ||
1611 | There may be reasons for the failure that aren't problems in OpenSSL itself, | |
1612 | for example if the compiler reports missing standard or third party headers. | |
1613 | ||
1614 | If the build succeeded previously, but fails after a source or configuration | |
1615 | change, it might be helpful to clean the build tree before attempting another | |
1616 | build. Use this command: | |
1617 | ||
270540fd RL |
1618 | $ make clean # Unix |
1619 | $ mms clean ! (or mmk) OpenVMS | |
1620 | $ nmake clean # Windows | |
6ede7d73 | 1621 | |
203c18f1 AM |
1622 | Assembler error messages can sometimes be sidestepped by using the `no-asm` |
1623 | configuration option. See also [notes](#notes-on-assembler-modules-compilation). | |
6ede7d73 DMSP |
1624 | |
1625 | Compiling parts of OpenSSL with gcc and others with the system compiler will | |
1626 | result in unresolved symbols on some systems. | |
1627 | ||
6c8149df DMSP |
1628 | If you are still having problems, try to search the [openssl-users] mailing |
1629 | list or the [GitHub Issues] for existing solutions. If you think you | |
1630 | encountered an OpenSSL bug, please [raise an issue] to file a bug report. | |
6ede7d73 DMSP |
1631 | Please take the time to review the existing issues first; maybe the bug was |
1632 | already reported or has already been fixed. | |
1633 | ||
6ede7d73 DMSP |
1634 | Test Failures |
1635 | ------------- | |
1636 | ||
1637 | If some tests fail, look at the output. There may be reasons for the failure | |
b0d5c1cb | 1638 | that isn't a problem in OpenSSL itself (like an OS malfunction or a Perl issue). |
6ede7d73 | 1639 | |
3a0b3cc9 DDO |
1640 | You may want increased verbosity, that can be accomplished as described in |
1641 | section [Test Failures of test/README.md](test/README.md#test-failures). | |
6ede7d73 | 1642 | |
e4522e10 DDO |
1643 | You may also want to selectively specify which test(s) to perform. This can be |
1644 | done using the `make` variable `TESTS` as described in section [Running | |
1645 | Selected Tests of test/README.md](test/README.md#running-selected-tests). | |
6ede7d73 DMSP |
1646 | |
1647 | If you find a problem with OpenSSL itself, try removing any | |
3a0b3cc9 DDO |
1648 | compiler optimization flags from the `CFLAGS` line in the Makefile and |
1649 | run `make clean; make` or corresponding. | |
6ede7d73 DMSP |
1650 | |
1651 | To report a bug please open an issue on GitHub, at | |
257e9d03 | 1652 | <https://github.com/openssl/openssl/issues>. |
6ede7d73 | 1653 | |
6ede7d73 DMSP |
1654 | Notes |
1655 | ===== | |
1656 | ||
1657 | Notes on multi-threading | |
1658 | ------------------------ | |
1659 | ||
9afbb681 | 1660 | For some systems, the OpenSSL `Configure` script knows what compiler options |
6ede7d73 DMSP |
1661 | are needed to generate a library that is suitable for multi-threaded |
1662 | applications. On these systems, support for multi-threading is enabled | |
9afbb681 | 1663 | by default; use the `no-threads` option to disable (this should never be |
6ede7d73 DMSP |
1664 | necessary). |
1665 | ||
1666 | On other systems, to enable support for multi-threading, you will have | |
9afbb681 DDO |
1667 | to specify at least two options: `threads`, and a system-dependent option. |
1668 | (The latter is `-D_REENTRANT` on various systems.) The default in this | |
6ede7d73 | 1669 | case, obviously, is not to include support for multi-threading (but |
9afbb681 DDO |
1670 | you can still use `no-threads` to suppress an annoying warning message |
1671 | from the `Configure` script.) | |
6ede7d73 DMSP |
1672 | |
1673 | OpenSSL provides built-in support for two threading models: pthreads (found on | |
1674 | most UNIX/Linux systems), and Windows threads. No other threading models are | |
1675 | supported. If your platform does not provide pthreads or Windows threads then | |
9afbb681 | 1676 | you should use `Configure` with the `no-threads` option. |
6ede7d73 | 1677 | |
3d8905f8 RS |
1678 | For pthreads, all locks are non-recursive. In addition, in a debug build, |
1679 | the mutex attribute `PTHREAD_MUTEX_ERRORCHECK` is used. If this is not | |
1680 | available on your platform, you might have to add | |
1681 | `-DOPENSSL_NO_MUTEX_ERRORCHECK` to your `Configure` invocation. | |
1682 | (On Linux `PTHREAD_MUTEX_ERRORCHECK` is an enum value, so a built-in | |
1683 | ifdef test cannot be used.) | |
1684 | ||
6ede7d73 DMSP |
1685 | Notes on shared libraries |
1686 | ------------------------- | |
1687 | ||
9afbb681 | 1688 | For most systems the OpenSSL `Configure` script knows what is needed to |
6ede7d73 DMSP |
1689 | build shared libraries for libcrypto and libssl. On these systems |
1690 | the shared libraries will be created by default. This can be suppressed and | |
9afbb681 DDO |
1691 | only static libraries created by using the `no-shared` option. On systems |
1692 | where OpenSSL does not know how to build shared libraries the `no-shared` | |
6ede7d73 DMSP |
1693 | option will be forced and only static libraries will be created. |
1694 | ||
1695 | Shared libraries are named a little differently on different platforms. | |
1696 | One way or another, they all have the major OpenSSL version number as | |
9afbb681 | 1697 | part of the file name, i.e. for OpenSSL 1.1.x, `1.1` is somehow part of |
6ede7d73 DMSP |
1698 | the name. |
1699 | ||
9afbb681 DDO |
1700 | On most POSIX platforms, shared libraries are named `libcrypto.so.1.1` |
1701 | and `libssl.so.1.1`. | |
6ede7d73 | 1702 | |
9afbb681 DDO |
1703 | on Cygwin, shared libraries are named `cygcrypto-1.1.dll` and `cygssl-1.1.dll` |
1704 | with import libraries `libcrypto.dll.a` and `libssl.dll.a`. | |
6ede7d73 DMSP |
1705 | |
1706 | On Windows build with MSVC or using MingW, shared libraries are named | |
9afbb681 DDO |
1707 | `libcrypto-1_1.dll` and `libssl-1_1.dll` for 32-bit Windows, |
1708 | `libcrypto-1_1-x64.dll` and `libssl-1_1-x64.dll` for 64-bit x86_64 Windows, | |
1709 | and `libcrypto-1_1-ia64.dll` and `libssl-1_1-ia64.dll` for IA64 Windows. | |
1710 | With MSVC, the import libraries are named `libcrypto.lib` and `libssl.lib`, | |
1711 | while with MingW, they are named `libcrypto.dll.a` and `libssl.dll.a`. | |
6ede7d73 DMSP |
1712 | |
1713 | On VMS, shareable images (VMS speak for shared libraries) are named | |
9afbb681 | 1714 | `ossl$libcrypto0101_shr.exe` and `ossl$libssl0101_shr.exe`. However, when |
6ede7d73 | 1715 | OpenSSL is specifically built for 32-bit pointers, the shareable images |
9afbb681 | 1716 | are named `ossl$libcrypto0101_shr32.exe` and `ossl$libssl0101_shr32.exe` |
6ede7d73 | 1717 | instead, and when built for 64-bit pointers, they are named |
9afbb681 | 1718 | `ossl$libcrypto0101_shr64.exe` and `ossl$libssl0101_shr64.exe`. |
6ede7d73 DMSP |
1719 | |
1720 | Notes on random number generation | |
1721 | --------------------------------- | |
1722 | ||
1723 | Availability of cryptographically secure random numbers is required for | |
1724 | secret key generation. OpenSSL provides several options to seed the | |
1725 | internal CSPRNG. If not properly seeded, the internal CSPRNG will refuse | |
1726 | to deliver random bytes and a "PRNG not seeded error" will occur. | |
1727 | ||
1728 | The seeding method can be configured using the `--with-rand-seed` option, | |
1729 | which can be used to specify a comma separated list of seed methods. | |
8c1cbc72 | 1730 | However, in most cases OpenSSL will choose a suitable default method, |
6ede7d73 | 1731 | so it is not necessary to explicitly provide this option. Note also |
b99c463d P |
1732 | that not all methods are available on all platforms. The FIPS provider will |
1733 | silently ignore seed sources that were not validated. | |
6ede7d73 DMSP |
1734 | |
1735 | I) On operating systems which provide a suitable randomness source (in | |
1736 | form of a system call or system device), OpenSSL will use the optimal | |
1737 | available method to seed the CSPRNG from the operating system's | |
1738 | randomness sources. This corresponds to the option `--with-rand-seed=os`. | |
1739 | ||
1740 | II) On systems without such a suitable randomness source, automatic seeding | |
9afbb681 | 1741 | and reseeding is disabled (`--with-rand-seed=none`) and it may be necessary |
6ede7d73 | 1742 | to install additional support software to obtain a random seed and reseed |
9afbb681 DDO |
1743 | the CSPRNG manually. Please check out the manual pages for `RAND_add()`, |
1744 | `RAND_bytes()`, `RAND_egd()`, and the FAQ for more information. | |
6ede7d73 | 1745 | |
203c18f1 AM |
1746 | Notes on assembler modules compilation |
1747 | -------------------------------------- | |
1748 | ||
1749 | Compilation of some code paths in assembler modules might depend on whether the | |
1750 | current assembler version supports certain ISA extensions or not. Code paths | |
1751 | that use the AES-NI, PCLMULQDQ, SSSE3, and SHA extensions are always assembled. | |
1752 | Apart from that, the minimum requirements for the assembler versions are shown | |
1753 | in the table below: | |
1754 | ||
1755 | | ISA extension | GNU as | nasm | llvm | | |
1756 | |---------------|--------|--------|---------| | |
1757 | | AVX | 2.19 | 2.09 | 3.0 | | |
1758 | | AVX2 | 2.22 | 2.10 | 3.1 | | |
1759 | | ADCX/ADOX | 2.23 | 2.10 | 3.3 | | |
1760 | | AVX512 | 2.25 | 2.11.8 | 3.6 (*) | | |
1761 | | AVX512IFMA | 2.26 | 2.11.8 | 6.0 (*) | | |
1762 | | VAES | 2.30 | 2.13.3 | 6.0 (*) | | |
1763 | ||
1764 | --- | |
1765 | ||
1766 | (*) Even though AVX512 support was implemented in llvm 3.6, prior to version 7.0 | |
1767 | an explicit -march flag was apparently required to compile assembly modules. But | |
1768 | then the compiler generates processor-specific code, which in turn contradicts | |
1769 | the idea of performing dispatch at run-time, which is facilitated by the special | |
1770 | variable `OPENSSL_ia32cap`. For versions older than 7.0, it is possible to work | |
1771 | around the problem by forcing the build procedure to use the following script: | |
1772 | ||
1773 | #!/bin/sh | |
1774 | exec clang -no-integrated-as "$@" | |
1775 | ||
1776 | instead of the real clang. In which case it doesn't matter what clang version | |
1777 | is used, as it is the version of the GNU assembler that will be checked. | |
1778 | ||
1779 | --- | |
1780 | ||
6ede7d73 DMSP |
1781 | <!-- Links --> |
1782 | ||
1783 | [openssl-users]: | |
257e9d03 | 1784 | <https://mta.openssl.org/mailman/listinfo/openssl-users> |
6ede7d73 DMSP |
1785 | |
1786 | [SUPPORT]: | |
1787 | ./SUPPORT.md | |
1788 | ||
1789 | [GitHub Issues]: | |
257e9d03 | 1790 | <https://github.com/openssl/openssl/issues> |
6ede7d73 DMSP |
1791 | |
1792 | [raise an issue]: | |
257e9d03 | 1793 | <https://github.com/openssl/openssl/issues/new/choose> |
6ede7d73 DMSP |
1794 | |
1795 | [10-main.conf]: | |
1796 | Configurations/10-main.conf |