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