4 This document describes installation on all supported operating
5 systems: the Unix/Linux family (including macOS), OpenVMS,
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 - [Compression Algorithm Flags](#compression-algorithm-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)
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)
49 To install OpenSSL, you will need:
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))
55 * a development environment in the form of development libraries and C
57 * a supported operating system
59 For additional platform specific requirements, solutions to specific
60 issues and other details, please read one of these:
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 for the HPE NonStop platform](NOTES-NONSTOP.md)
68 * [Notes on Perl](NOTES-PERL.md)
69 * [Notes on Valgrind](NOTES-VALGRIND.md)
71 Notational conventions
72 ======================
74 Throughout this document, we use the following conventions.
79 Any line starting with a dollar sign is a command line.
83 The dollar sign indicates the shell prompt and is not to be entered as
89 Several words in curly braces separated by pipe characters indicate a
90 **mandatory choice**, to be replaced with one of the given words.
93 $ echo { WORD1 | WORD2 | WORD3 }
95 represents one of the following three commands
103 One or several words in square brackets separated by pipe characters
104 denote an **optional choice**. It is similar to the mandatory choice,
105 but it can also be omitted entirely.
109 $ echo [ WORD1 | WORD2 | WORD3 ]
111 represents one of the four commands
124 **Optional Arguments** are enclosed in square brackets.
128 A trailing ellipsis means that more than one could be specified.
130 Quick Installation Guide
131 ========================
133 If you just want to get OpenSSL installed without bothering too much
134 about the details, here is the short version of how to build and install
135 OpenSSL. If any of the following steps fails, please consult the
136 [Installation in Detail](#installation-steps-in-detail) section below.
141 Use the following commands to configure, build and test OpenSSL.
142 The testing is optional, but recommended if you intend to install
143 OpenSSL for production use.
145 ### Unix / Linux / macOS / NonStop
153 Use the following commands to build OpenSSL:
161 If you are using Visual Studio, open a Developer Command Prompt and
162 issue the following commands to build OpenSSL.
168 As mentioned in the [Choices](#choices) section, you need to pick one
169 of the four Configure targets in the first command.
171 Most likely you will be using the `VC-WIN64A`/`VC-WIN64A-HYBRIDCRT` target for
172 64bit Windows binaries (AMD64) or `VC-WIN32`/`VC-WIN32-HYBRIDCRT` for 32bit
173 Windows binaries (X86).
174 The other two options are `VC-WIN64I` (Intel IA64, Itanium) and
175 `VC-CE` (Windows CE) are rather uncommon nowadays.
180 The following commands will install OpenSSL to a default system location.
182 **Danger Zone:** even if you are impatient, please read the following two
183 paragraphs carefully before you install OpenSSL.
185 For security reasons the default system location is by default not writable
186 for unprivileged users. So for the final installation step administrative
187 privileges are required. The default system location and the procedure to
188 obtain administrative privileges depends on the operating system.
189 It is recommended to compile and test OpenSSL with normal user privileges
190 and use administrative privileges only for the final installation step.
192 On some platforms OpenSSL is preinstalled as part of the Operating System.
193 In this case it is highly recommended not to overwrite the system versions,
194 because other applications or libraries might depend on it.
195 To avoid breaking other applications, install your copy of OpenSSL to a
196 [different location](#installing-to-a-different-location) which is not in
197 the global search path for system libraries.
199 Finally, if you plan on using the FIPS module, you need to read the
200 [Post-installation Notes](#post-installation-notes) further down.
202 ### Unix / Linux / macOS / NonStop
204 Depending on your distribution, you need to run the following command as
205 root user or prepend `sudo` to the command:
209 By default, OpenSSL will be installed to
213 More precisely, the files will be installed into the subdirectories
220 depending on the file type, as it is custom on Unix-like operating systems.
224 Use the following command to install OpenSSL.
228 By default, OpenSSL will be installed to
234 If you are using Visual Studio, open the Developer Command Prompt _elevated_
235 and issue the following command.
239 The easiest way to elevate the Command Prompt is to press and hold down both
240 the `<CTRL>` and `<SHIFT>` keys while clicking the menu item in the task menu.
242 The default installation location is
244 C:\Program Files\OpenSSL
246 for native binaries, or
248 C:\Program Files (x86)\OpenSSL
250 for 32bit binaries on 64bit Windows (WOW64).
252 #### Installing to a different location
254 To install OpenSSL to a different location (for example into your home
255 directory for testing purposes) run `Configure` as shown in the following
258 The options `--prefix` and `--openssldir` are explained in further detail in
259 [Directories](#directories) below, and the values used here are mere examples.
263 $ ./Configure --prefix=/opt/openssl --openssldir=/usr/local/ssl
267 $ perl Configure --prefix=PROGRAM:[INSTALLS] --openssldir=SYS$MANAGER:[OPENSSL]
269 Note: if you do add options to the configuration command, please make sure
270 you've read more than just this Quick Start, such as relevant `NOTES-*` files,
271 the options outline below, as configuration options may change the outcome
272 in otherwise unexpected ways.
274 Configuration Options
275 =====================
277 There are several options to `./Configure` to customize the build (note that
278 for Windows, the defaults for `--prefix` and `--openssldir` depend on what
279 configuration is used and what Windows implementation OpenSSL is built on.
280 For more information, see the [Notes for Windows platforms](NOTES-WINDOWS.md).
287 Build the OpenSSL libraries to support the API for the specified version.
288 If [no-deprecated](#no-deprecated) is also given, don't build with support
289 for deprecated APIs in or below the specified version number. For example,
292 --api=1.1.0 no-deprecated
294 will remove support for all APIs that were deprecated in OpenSSL version
295 1.1.0 or below. This is a rather specialized option for developers.
296 If you just intend to remove all deprecated APIs up to the current version
297 entirely, just specify [no-deprecated](#no-deprecated).
298 If `--api` isn't given, it defaults to the current (minor) OpenSSL version.
303 --cross-compile-prefix=<PREFIX>
305 The `<PREFIX>` to include in front of commands for your toolchain.
307 It is likely to have to end with dash, e.g. `a-b-c-` would invoke GNU compiler
308 as `a-b-c-gcc`, etc. Unfortunately cross-compiling is too case-specific to put
309 together one-size-fits-all instructions. You might have to pass more flags or
310 set up environment variables to actually make it work. Android and iOS cases
311 are discussed in corresponding `Configurations/15-*.conf` files. But there are
312 cases when this option alone is sufficient. For example to build the mingw64
313 target on Linux `--cross-compile-prefix=x86_64-w64-mingw32-` works. Naturally
314 provided that mingw packages are installed. Today Debian and Ubuntu users
315 have option to install a number of prepackaged cross-compilers along with
316 corresponding run-time and development packages for "alien" hardware. To give
317 another example `--cross-compile-prefix=mipsel-linux-gnu-` suffices in such
320 For cross compilation, you must [configure manually](#manual-configuration).
321 Also, note that `--openssldir` refers to target's file system, not one you are
329 Build OpenSSL with debugging symbols and zero optimization level.
333 Build OpenSSL without debugging symbols. This is the default.
342 The name of the directory under the top of the installation directory tree
343 (see the `--prefix` option) where libraries will be installed. By default
344 this is `lib`. Note that on Windows only static libraries (`*.lib`) will
345 be stored in this location. Shared libraries (`*.dll`) will always be
346 installed to the `bin` directory.
348 Some build targets have a multilib postfix set in the build configuration.
349 For these targets the default libdir is `lib<multilib-postfix>`. Please use
350 `--libdir=lib` to override the libdir if adding the postfix is undesirable.
356 Directory for OpenSSL configuration files, and also the default certificate
357 and key store. Defaults are:
360 Windows: C:\Program Files\Common Files\SSL
361 OpenVMS: SYS$COMMON:[OPENSSL-COMMON]
363 For 32bit Windows applications on Windows 64bit (WOW64), always replace
364 `C:\Program Files` by `C:\Program Files (x86)`.
370 The top of the installation directory tree. Defaults are:
373 Windows: C:\Program Files\OpenSSL
374 OpenVMS: SYS$COMMON:[OPENSSL]
381 This is a developer flag that switches on various compiler options recommended
382 for OpenSSL development. It only works when using gcc or clang as the compiler.
383 If you are developing a patch for OpenSSL then it is recommended that you use
384 this option where possible.
386 Compression Algorithm Flags
387 ---------------------------
389 ### with-brotli-include
391 --with-brotli-include=DIR
393 The directory for the location of the brotli include files (i.e. the location
394 of the **brotli** include directory). This option is only necessary if
395 [enable-brotli](#enable-brotli) is used and the include files are not already
396 on the system include path.
400 --with-brotli-lib=LIB
402 **On Unix**: this is the directory containing the brotli libraries.
403 If not provided, the system library path will be used.
405 The names of the libraries are:
407 * libbrotlicommon.a or libbrotlicommon.so
408 * libbrotlidec.a or libbrotlidec.so
409 * libbrotlienc.a or libbrotlienc.so
411 **On Windows:** this is the directory containing the brotli libraries.
412 If not provided, the system library path will be used.
414 The names of the libraries are:
420 ### with-zlib-include
422 --with-zlib-include=DIR
424 The directory for the location of the zlib include file. This option is only
425 necessary if [zlib](#zlib) is used and the include file is not
426 already on the system include path.
432 **On Unix**: this is the directory containing the zlib library.
433 If not provided the system library path will be used.
435 **On Windows:** this is the filename of the zlib library (with or
436 without a path). This flag must be provided if the
437 [zlib-dynamic](#zlib-dynamic) option is not also used. If `zlib-dynamic` is used
438 then this flag is optional and defaults to `ZLIB1` if not provided.
440 **On VMS:** this is the filename of the zlib library (with or without a path).
441 This flag is optional and if not provided then `GNV$LIBZSHR`, `GNV$LIBZSHR32`
442 or `GNV$LIBZSHR64` is used by default depending on the pointer size chosen.
444 ### with-zstd-include
446 --with-zstd-include=DIR
448 The directory for the location of the Zstd include file. This option is only
449 necessary if [enable-std](#enable-zstd) is used and the include file is not
450 already on the system include path.
452 OpenSSL requires Zstd 1.4 or greater. The Linux kernel source contains a
453 *zstd.h* file that is not compatible with the 1.4.x Zstd distribution, the
454 compilation will generate an error if the Linux *zstd.h* is included before
455 (or instead of) the Zstd distribution header.
461 **On Unix**: this is the directory containing the Zstd library.
462 If not provided the system library path will be used.
464 **On Windows:** this is the filename of the Zstd library (with or
465 without a path). This flag must be provided if the
466 [enable-zstd-dynamic](#enable-zstd-dynamic) option is not also used.
467 If `zstd-dynamic` is used then this flag is optional and defaults
468 to `LIBZSTD` if not provided.
470 Seeding the Random Generator
471 ----------------------------
473 --with-rand-seed=seed1[,seed2,...]
475 A comma separated list of seeding methods which will be tried by OpenSSL
476 in order to obtain random input (a.k.a "entropy") for seeding its
477 cryptographically secure random number generator (CSPRNG).
478 The current seeding methods are:
482 Use a trusted operating system entropy source.
483 This is the default method if such an entropy source exists.
487 Use the [getrandom(2)][man-getrandom] or equivalent system call.
489 [man-getrandom]: http://man7.org/linux/man-pages/man2/getrandom.2.html
493 Use the first device from the `DEVRANDOM` list which can be opened to read
494 random bytes. The `DEVRANDOM` preprocessor constant expands to
496 "/dev/urandom","/dev/random","/dev/srandom"
498 on most unix-ish operating systems.
502 Check for an entropy generating daemon.
503 This source is ignored by the FIPS provider.
507 Use the `RDSEED` or `RDRAND` command on x86 or `RNDRRS` command on aarch64
508 if provided by the CPU.
512 Use librandom (not implemented yet).
513 This source is ignored by the FIPS provider.
517 Disable automatic seeding. This is the default on some operating systems where
518 no suitable entropy source exists, or no support for it is implemented yet.
519 This option is ignored by the FIPS provider.
521 For more information, see the section [Notes on random number generation][rng]
522 at the end of this document.
524 [rng]: #notes-on-random-number-generation
526 Setting the FIPS HMAC key
527 -------------------------
531 As part of its self-test validation, the FIPS module must verify itself
532 by performing a SHA-256 HMAC computation on itself. The default key is
533 the SHA256 value of "the holy handgrenade of antioch" and is sufficient
534 for meeting the FIPS requirements.
536 To change the key to a different value, use this flag. The value should
537 be a hex string no more than 64 characters.
539 Enable and Disable Features
540 ---------------------------
542 Feature options always come in pairs, an option to enable feature
543 `xxxx`, and an option to disable it:
545 [ enable-xxxx | no-xxxx ]
547 Whether a feature is enabled or disabled by default, depends on the feature.
548 In the following list, always the non-default variant is documented: if
549 feature `xxxx` is disabled by default then `enable-xxxx` is documented and
550 if feature `xxxx` is enabled by default then `no-xxxx` is documented.
554 Don't build the AFALG engine.
556 This option will be forced on a platform that does not support AFALG.
560 Build with Kernel TLS support.
562 This option will enable the use of the Kernel TLS data-path, which can improve
563 performance and allow for the use of sendfile and splice system calls on
564 TLS sockets. The Kernel may use TLS accelerators if any are available on the
565 system. This option will be forced off on systems that do not support the
566 Kernel TLS data-path.
570 Build with the Address sanitiser.
572 This is a developer option only. It may not work on all platforms and should
573 never be used in production environments. It will only work when used with
574 gcc or clang and should be used in conjunction with the [no-shared](#no-shared)
577 ### enable-acvp-tests
579 Build support for Automated Cryptographic Validation Protocol (ACVP)
582 This is required for FIPS validation purposes. Certain ACVP tests require
583 access to algorithm internals that are not normally accessible.
584 Additional information related to ACVP can be found at
585 <https://github.com/usnistgov/ACVP>.
589 Do not build apps, e.g. the openssl program. This is handy for minimization.
590 This option also disables tests.
594 Do not use assembler code.
596 This should be viewed as debugging/troubleshooting option rather than for
597 production use. On some platforms a small amount of assembler code may still
598 be used even with this option.
602 Do not build support for async operations.
606 Do not use `atexit()` in libcrypto builds.
608 `atexit()` has varied semantics between platforms and can cause SIGSEGV in some
609 circumstances. This options disables the atexit registration of OPENSSL_cleanup.
610 By default, NonStop configurations use `no-atexit`.
614 Don't automatically load all supported ciphers and digests.
616 Typically OpenSSL will make available all of its supported ciphers and digests.
617 For a statically linked application this may be undesirable if small executable
618 size is an objective. This only affects libcrypto. Ciphers and digests will
619 have to be loaded manually using `EVP_add_cipher()` and `EVP_add_digest()`
620 if this option is used. This option will force a non-shared build.
624 Don't automatically load all libcrypto/libssl error strings.
626 Typically OpenSSL will automatically load human readable error strings. For a
627 statically linked application this may be undesirable if small executable size
632 Build with support for brotli compression/decompression.
634 ### enable-brotli-dynamic
636 Like the enable-brotli option, but has OpenSSL load the brotli library dynamically
639 This is only supported on systems where loading of shared libraries is supported.
641 ### no-autoload-config
643 Don't automatically load the default `openssl.cnf` file.
645 Typically OpenSSL will automatically load a system config file which configures
648 ### enable-buildtest-c++
650 While testing, generate C++ buildtest files that simply check that the public
651 OpenSSL header files are usable standalone with C++.
653 Enabling this option demands extra care. For any compiler flag given directly
654 as configuration option, you must ensure that it's valid for both the C and
655 the C++ compiler. If not, the C++ build test will most likely break. As an
656 alternative, you can use the language specific variables, `CFLAGS` and `CXXFLAGS`.
660 Use the specified text instead of the default banner at the end of
665 On platforms where the choice of 32-bit or 64-bit architecture
666 is not explicitly specified, `Configure` will print a warning
667 message and wait for a few seconds to let you interrupt the
668 configuration. Using this flag skips the wait.
672 Build only some minimal set of features.
673 This is a developer option used internally for CI build tests of the project.
677 Never cache algorithms when they are fetched from a provider. Normally, a
678 provider indicates if the algorithms it supplies can be cached or not. Using
679 this option will reduce run-time memory usage but it also introduces a
680 significant performance penalty. This option is primarily designed to help
681 with detecting incorrect reference counting.
685 Don't build the CAPI engine.
687 This option will be forced if on a platform that does not support CAPI.
691 Don't build support for Certificate Management Protocol (CMP)
692 and Certificate Request Message Format (CRMF).
696 Don't build support for Cryptographic Message Syntax (CMS).
700 Don't build support for SSL/TLS compression.
702 If this option is enabled (the default), then compression will only work if
703 the zlib or `zlib-dynamic` options are also chosen.
705 ### enable-crypto-mdebug
707 This now only enables the `failed-malloc` feature.
709 ### enable-crypto-mdebug-backtrace
711 This is a no-op; the project uses the compiler's address/leak sanitizer instead.
715 Don't build support for Certificate Transparency (CT).
719 Don't build with support for deprecated APIs up until and including the version
720 given with `--api` (or the current version, if `--api` wasn't specified).
724 Don't build support for datagram based BIOs.
726 Selecting this option will also force the disabling of DTLS.
730 Don't build and install documentation, i.e. manual pages in various forms.
734 Don't build support for loading Dynamic Shared Objects (DSO)
736 ### enable-devcryptoeng
738 Build the `/dev/crypto` engine.
740 This option is automatically selected on the BSD platform, in which case it can
741 be disabled with `no-devcryptoeng`.
743 ### no-dynamic-engine
745 Don't build the dynamically loaded engines.
747 This only has an effect in a shared build.
751 Don't build support for Elliptic Curves.
755 Don't build support for binary Elliptic Curves
757 ### enable-ec_nistp_64_gcc_128
759 Enable support for optimised implementations of some commonly used NIST
762 This option is only supported on platforms:
764 - with little-endian storage of non-byte types
765 - that tolerate misaligned memory references
766 - where the compiler:
767 - supports the non-standard type `__uint128_t`
768 - defines the built-in macro `__SIZEOF_INT128__`
772 Build support for gathering entropy from the Entropy Gathering Daemon (EGD).
776 Don't build support for loading engines.
780 Don't compile in any error strings.
782 ### enable-external-tests
784 Enable building of integration with external test suites.
786 This is a developer option and may not work on all platforms. The following
787 external test suites are currently supported:
789 - GOST engine test suite
790 - Python PYCA/Cryptography test suite
793 See the file [test/README-external.md](test/README-external.md)
798 Don't compile in filename and line number information (e.g. for errors and
803 Build (and install) the FIPS provider
805 ### no-fips-securitychecks
807 Don't perform FIPS module run-time checks related to enforcement of security
808 parameters such as minimum security strength of keys.
810 ### enable-fuzz-libfuzzer, enable-fuzz-afl
812 Build with support for fuzzing using either libfuzzer or AFL.
814 These are developer options only. They may not work on all platforms and
815 should never be used in production environments.
817 See the file [fuzz/README.md](fuzz/README.md) for further details.
821 Don't build support for GOST based ciphersuites.
823 Note that if this feature is enabled then GOST ciphersuites are only available
824 if the GOST algorithms are also available through loading an externally supplied
829 Disable HTTP support.
833 Don't build the legacy provider.
835 Disabling this also disables the legacy algorithms: MD2 (already disabled by default).
839 Don't generate dependencies.
843 Don't build any dynamically loadable engines.
845 This also implies `no-dynamic-engine`.
849 Don't build support for writing multiple records in one go in libssl
851 Note: this is a different capability to the pipelining functionality.
855 Don't build support for the Next Protocol Negotiation (NPN) TLS extension.
859 Don't build support for Online Certificate Status Protocol (OCSP).
863 Don't build the padlock engine.
867 As synonym for `no-padlockeng`. Deprecated and should not be used.
871 Don't build with support for Position Independent Code.
875 Don't pin the shared libraries.
877 By default OpenSSL will attempt to stay in memory until the process exits.
878 This is so that libcrypto and libssl can be properly cleaned up automatically
879 via an `atexit()` handler. The handler is registered by libcrypto and cleans
880 up both libraries. On some platforms the `atexit()` handler will run on unload of
881 libcrypto (if it has been dynamically loaded) rather than at process exit.
883 This option can be used to stop OpenSSL from attempting to stay in memory until the
884 process exits. This could lead to crashes if either libcrypto or libssl have
885 already been unloaded at the point that the atexit handler is invoked, e.g. on a
886 platform which calls `atexit()` on unload of the library, and libssl is unloaded
887 before libcrypto then a crash is likely to happen.
889 Note that shared library pinning is not automatically disabled for static builds,
890 i.e., `no-shared` does not imply `no-pinshared`. This may come as a surprise when
891 linking libcrypto statically into a shared third-party library, because in this
892 case the shared library will be pinned. To prevent this behaviour, you need to
893 configure the static build using `no-shared` and `no-pinshared` together.
895 Applications can suppress running of the `atexit()` handler at run time by
896 using the `OPENSSL_INIT_NO_ATEXIT` option to `OPENSSL_init_crypto()`.
897 See the man page for it for further details.
901 Don't use POSIX IO capabilities.
905 Don't build support for Pre-Shared Key based ciphersuites.
909 Don't use hardware RDRAND capabilities.
913 Don't build support for RFC3779, "X.509 Extensions for IP Addresses and
918 Build support for Stream Control Transmission Protocol (SCTP).
922 Do not create shared libraries, only static ones.
924 See [Notes on shared libraries](#notes-on-shared-libraries) below.
928 Disable using the SM2 precomputed table on aarch64 to make the library smaller.
932 Don't build support for socket BIOs.
936 Don't build support for Secure Remote Password (SRP) protocol or
937 SRP based ciphersuites.
941 Don't build Secure Real-Time Transport Protocol (SRTP) support.
945 Exclude SSE2 code paths from 32-bit x86 assembly modules.
947 Normally SSE2 extension is detected at run-time, but the decision whether or not
948 the machine code will be executed is taken solely on CPU capability vector. This
949 means that if you happen to run OS kernel which does not support SSE2 extension
950 on Intel P4 processor, then your application might be exposed to "illegal
951 instruction" exception. There might be a way to enable support in kernel, e.g.
952 FreeBSD kernel can be compiled with `CPU_ENABLE_SSE`, and there is a way to
953 disengage SSE2 code paths upon application start-up, but if you aim for wider
954 "audience" running such kernel, consider `no-sse2`. Both the `386` and `no-asm`
955 options imply `no-sse2`.
959 Don't build with SSL Trace capabilities.
961 This removes the `-trace` option from `s_client` and `s_server`, and omits the
962 `SSL_trace()` function from libssl.
964 Disabling `ssl-trace` may provide a small reduction in libssl binary size.
968 Don't build the statically linked engines.
970 This only has an impact when not built "shared".
974 Don't use anything from the C header file `stdio.h` that makes use of the `FILE`
975 type. Only libcrypto and libssl can be built in this way. Using this option will
976 suppress building the command line applications. Additionally, since the OpenSSL
977 tests also use the command line applications, the tests will also be skipped.
981 Don't build test programs or run any tests.
985 Build with support for TCP Fast Open (RFC7413). Supported on Linux, macOS and FreeBSD.
989 Don't build with QUIC support.
993 Don't build with support for multi-threaded applications.
997 Build with support for multi-threaded applications. Most platforms will enable
998 this by default. However, if on a platform where this is not the case then this
999 will usually require additional system-dependent options!
1001 See [Notes on multi-threading](#notes-on-multi-threading) below.
1005 Don't build with support for thread pool functionality.
1009 Build with thread pool functionality. If enabled, OpenSSL algorithms may
1010 use the thread pool to perform parallel computation. This option in itself
1011 does not enable OpenSSL to spawn new threads. Currently the only supported
1012 thread pool mechanism is the default thread pool.
1014 ### no-default-thread-pool
1016 Don't build with support for default thread pool functionality.
1018 ### default-thread-pool
1020 Build with default thread pool functionality. If enabled, OpenSSL may create
1021 and manage threads up to a maximum number of threads authorized by the
1022 application. Supported on POSIX compliant platforms and Windows.
1026 Build with support for the integrated tracing api.
1028 See manual pages OSSL_trace_set_channel(3) and OSSL_trace_enabled(3) for details.
1032 Don't build Time Stamping (TS) Authority support.
1036 Build with the Undefined Behaviour sanitiser (UBSAN).
1038 This is a developer option only. It may not work on all platforms and should
1039 never be used in production environments. It will only work when used with
1040 gcc or clang and should be used in conjunction with the `-DPEDANTIC` option
1041 (or the `--strict-warnings` option).
1045 Don't build with the User Interface (UI) console method
1047 The User Interface console method enables text based console prompts.
1049 ### enable-unit-test
1051 Enable additional unit test APIs.
1053 This should not typically be used in production deployments.
1057 Don't build support for UPLINK interface.
1059 ### enable-weak-ssl-ciphers
1061 Build support for SSL/TLS ciphers that are considered "weak"
1063 Enabling this includes for example the RC4 based ciphersuites.
1067 Build with support for zlib compression/decompression.
1071 Like the zlib option, but has OpenSSL load the zlib library dynamically
1074 This is only supported on systems where loading of shared libraries is supported.
1078 Build with support for Zstd compression/decompression.
1080 ### enable-zstd-dynamic
1082 Like the enable-zstd option, but has OpenSSL load the Zstd library dynamically
1085 This is only supported on systems where loading of shared libraries is supported.
1089 In 32-bit x86 builds, use the 80386 instruction set only in assembly modules
1091 The default x86 code is more efficient, but requires at least an 486 processor.
1092 Note: This doesn't affect compiler generated code, so this option needs to be
1093 accompanied by a corresponding compiler-specific option.
1097 no-{ssl|ssl3|tls|tls1|tls1_1|tls1_2|tls1_3|dtls|dtls1|dtls1_2}
1099 Don't build support for negotiating the specified SSL/TLS protocol.
1101 If `no-tls` is selected then all of `tls1`, `tls1_1`, `tls1_2` and `tls1_3`
1103 Similarly `no-dtls` will disable `dtls1` and `dtls1_2`. The `no-ssl` option is
1104 synonymous with `no-ssl3`. Note this only affects version negotiation.
1105 OpenSSL will still provide the methods for applications to explicitly select
1106 the individual protocol versions.
1108 ### no-{protocol}-method
1110 no-{ssl3|tls1|tls1_1|tls1_2|dtls1|dtls1_2}-method
1112 Analogous to `no-{protocol}` but in addition do not build the methods for
1113 applications to explicitly select individual protocol versions. Note that there
1114 is no `no-tls1_3-method` option because there is no application method for
1117 Using individual protocol methods directly is deprecated. Applications should
1118 use `TLS_method()` instead.
1120 ### enable-{algorithm}
1124 Build with support for the specified algorithm.
1128 no-{aria|bf|blake2|camellia|cast|chacha|cmac|
1129 des|dh|dsa|ecdh|ecdsa|idea|md4|mdc2|ocb|
1130 poly1305|rc2|rc4|rmd160|scrypt|seed|
1131 siphash|siv|sm2|sm3|sm4|whirlpool}
1133 Build without support for the specified algorithm.
1135 The `ripemd` algorithm is deprecated and if used is synonymous with `rmd160`.
1137 ### Compiler-specific options
1139 -Dxxx, -Ixxx, -Wp, -lxxx, -Lxxx, -Wl, -rpath, -R, -framework, -static
1141 These system specific options will be recognised and passed through to the
1142 compiler to allow you to define preprocessor symbols, specify additional
1143 libraries, library directories or other compiler options. It might be worth
1144 noting that some compilers generate code specifically for processor the
1145 compiler currently executes on. This is not necessarily what you might have
1146 in mind, since it might be unsuitable for execution on other, typically older,
1147 processor. Consult your compiler documentation.
1149 Take note of the [Environment Variables](#environment-variables) documentation
1150 below and how these flags interact with those variables.
1154 Additional options that are not otherwise recognised are passed through as
1155 they are to the compiler as well. Unix-style options beginning with a
1156 `-` or `+` and Windows-style options beginning with a `/` are recognised.
1157 Again, consult your compiler documentation.
1159 If the option contains arguments separated by spaces, then the URL-style
1160 notation `%20` can be used for the space character in order to avoid having
1161 to quote the option. For example, `-opt%20arg` gets expanded to `-opt arg`.
1162 In fact, any ASCII character can be encoded as %xx using its hexadecimal
1165 Take note of the [Environment Variables](#environment-variables) documentation
1166 below and how these flags interact with those variables.
1168 ### Environment Variables
1172 Assign the given value to the environment variable `VAR` for `Configure`.
1174 These work just like normal environment variable assignments, but are supported
1175 on all platforms and are confined to the configuration scripts only.
1176 These assignments override the corresponding value in the inherited environment,
1179 The following variables are used as "`make` variables" and can be used as an
1180 alternative to giving preprocessor, compiler and linker options directly as
1181 configuration. The following variables are supported:
1183 AR The static library archiver.
1184 ARFLAGS Flags for the static library archiver.
1185 AS The assembler compiler.
1186 ASFLAGS Flags for the assembler compiler.
1188 CFLAGS Flags for the C compiler.
1189 CXX The C++ compiler.
1190 CXXFLAGS Flags for the C++ compiler.
1191 CPP The C/C++ preprocessor.
1192 CPPFLAGS Flags for the C/C++ preprocessor.
1193 CPPDEFINES List of CPP macro definitions, separated
1194 by a platform specific character (':' or
1195 space for Unix, ';' for Windows, ',' for
1196 VMS). This can be used instead of using
1197 -D (or what corresponds to that on your
1198 compiler) in CPPFLAGS.
1199 CPPINCLUDES List of CPP inclusion directories, separated
1200 the same way as for CPPDEFINES. This can
1201 be used instead of -I (or what corresponds
1202 to that on your compiler) in CPPFLAGS.
1203 HASHBANGPERL Perl invocation to be inserted after '#!'
1204 in public perl scripts (only relevant on
1206 LD The program linker (not used on Unix, $(CC)
1208 LDFLAGS Flags for the shared library, DSO and
1210 LDLIBS Extra libraries to use when linking.
1211 Takes the form of a space separated list
1212 of library specifications on Unix and
1213 Windows, and as a comma separated list of
1215 RANLIB The library archive indexer.
1216 RC The Windows resource compiler.
1217 RCFLAGS Flags for the Windows resource compiler.
1218 RM The command to remove files and directories.
1220 These cannot be mixed with compiling/linking flags given on the command line.
1221 In other words, something like this isn't permitted.
1223 $ ./Configure -DFOO CPPFLAGS=-DBAR -DCOOKIE
1225 Backward compatibility note:
1227 To be compatible with older configuration scripts, the environment variables
1228 are ignored if compiling/linking flags are given on the command line, except
1231 AR, CC, CXX, CROSS_COMPILE, HASHBANGPERL, PERL, RANLIB, RC, and WINDRES
1233 For example, the following command will not see `-DBAR`:
1235 $ CPPFLAGS=-DBAR ./Configure -DCOOKIE
1237 However, the following will see both set variables:
1239 $ CC=gcc CROSS_COMPILE=x86_64-w64-mingw32- ./Configure -DCOOKIE
1241 If `CC` is set, it is advisable to also set `CXX` to ensure both the C and C++
1242 compiler are in the same "family". This becomes relevant with
1243 `enable-external-tests` and `enable-buildtest-c++`.
1250 Reconfigure from earlier data.
1252 This fetches the previous command line options and environment from data
1253 saved in `configdata.pm` and runs the configuration process again, using
1254 these options and environment. Note: NO other option is permitted together
1255 with `reconf`. Note: The original configuration saves away values for ALL
1256 environment variables that were used, and if they weren't defined, they are
1257 still saved away with information that they weren't originally defined.
1258 This information takes precedence over environment variables that are
1259 defined when reconfiguring.
1261 Displaying configuration data
1262 -----------------------------
1264 The configuration script itself will say very little, and finishes by
1265 creating `configdata.pm`. This perl module can be loaded by other scripts
1266 to find all the configuration data, and it can also be used as a script to
1267 display all sorts of configuration data in a human readable form.
1269 For more information, please do:
1271 $ ./configdata.pm --help # Unix
1275 $ perl configdata.pm --help # Windows and VMS
1277 Installation Steps in Detail
1278 ============================
1283 ### Automatic Configuration
1285 In previous version, the `config` script determined the platform type and
1286 compiler and then called `Configure`. Starting with this release, they are
1289 #### Unix / Linux / macOS
1291 $ ./Configure [options...]
1295 $ perl Configure [options...]
1299 $ perl Configure [options...]
1301 ### Manual Configuration
1303 OpenSSL knows about a range of different operating system, hardware and
1304 compiler combinations. To see the ones it knows about, run
1306 $ ./Configure LIST # Unix
1310 $ perl Configure LIST # All other platforms
1312 For the remainder of this text, the Unix form will be used in all examples.
1313 Please use the appropriate form for your platform.
1315 Pick a suitable name from the list that matches your system. For most
1316 operating systems there is a choice between using cc or gcc.
1317 When you have identified your system (and if necessary compiler) use this
1318 name as the argument to `Configure`. For example, a `linux-elf` user would
1321 $ ./Configure linux-elf [options...]
1323 ### Creating your own Configuration
1325 If your system isn't listed, you will have to create a configuration
1326 file named `Configurations/YOURFILENAME.conf` (replace `YOURFILENAME`
1327 with a filename of your choosing) and add the correct
1328 configuration for your system. See the available configs as examples
1329 and read [Configurations/README.md](Configurations/README.md) and
1330 [Configurations/README-design.md](Configurations/README-design.md)
1331 for more information.
1333 The generic configurations `cc` or `gcc` should usually work on 32 bit
1336 `Configure` creates a build file (`Makefile` on Unix, `makefile` on Windows
1337 and `descrip.mms` on OpenVMS) from a suitable template in `Configurations/`,
1338 and defines various macros in `include/openssl/configuration.h` (generated
1339 from `include/openssl/configuration.h.in`.
1341 If none of the generated build files suit your purpose, it's possible to
1342 write your own build file template and give its name through the environment
1343 variable `BUILDFILE`. For example, Ninja build files could be supported by
1344 writing `Configurations/build.ninja.tmpl` and then configure with `BUILDFILE`
1345 set like this (Unix syntax shown, you'll have to adapt for other platforms):
1347 $ BUILDFILE=build.ninja perl Configure [options...]
1349 ### Out of Tree Builds
1351 OpenSSL can be configured to build in a build directory separate from the
1352 source code directory. It's done by placing yourself in some other
1353 directory and invoking the configuration commands from there.
1357 $ mkdir /var/tmp/openssl-build
1358 $ cd /var/tmp/openssl-build
1359 $ /PATH/TO/OPENSSL/SOURCE/Configure [options...]
1361 #### OpenVMS example
1363 $ set default sys$login:
1364 $ create/dir [.tmp.openssl-build]
1365 $ set default [.tmp.openssl-build]
1366 $ perl D:[PATH.TO.OPENSSL.SOURCE]Configure [options...]
1368 #### Windows example
1371 $ mkdir \temp-openssl
1373 $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure [options...]
1375 Paths can be relative just as well as absolute. `Configure` will do its best
1376 to translate them to relative paths whenever possible.
1381 Build OpenSSL by running:
1384 $ mms ! (or mmk) OpenVMS
1387 This will build the OpenSSL libraries (`libcrypto.a` and `libssl.a` on
1388 Unix, corresponding on other platforms) and the OpenSSL binary
1389 (`openssl`). The libraries will be built in the top-level directory,
1390 and the binary will be in the `apps/` subdirectory.
1392 If the build fails, take a look at the [Build Failures](#build-failures)
1393 subsection of the [Troubleshooting](#troubleshooting) section.
1398 After a successful build, and before installing, the libraries should
1402 $ mms test ! OpenVMS
1403 $ nmake test # Windows
1405 **Warning:** you MUST run the tests from an unprivileged account (or disable
1406 your privileges temporarily if your platform allows it).
1408 See [test/README.md](test/README.md) for further details how run tests.
1410 See [test/README-dev.md](test/README-dev.md) for guidelines on adding tests.
1415 If everything tests ok, install OpenSSL with
1417 $ make install # Unix
1418 $ mms install ! OpenVMS
1419 $ nmake install # Windows
1421 Note that in order to perform the install step above you need to have
1422 appropriate permissions to write to the installation directory.
1424 The above commands will install all the software components in this
1425 directory tree under `<PREFIX>` (the directory given with `--prefix` or
1428 ### Unix / Linux / macOS
1430 bin/ Contains the openssl binary and a few other
1433 Contains the header files needed if you want
1434 to build your own programs that use libcrypto
1436 lib Contains the OpenSSL library files.
1437 lib/engines Contains the OpenSSL dynamically loadable engines.
1439 share/man/man1 Contains the OpenSSL command line man-pages.
1440 share/man/man3 Contains the OpenSSL library calls man-pages.
1441 share/man/man5 Contains the OpenSSL configuration format man-pages.
1442 share/man/man7 Contains the OpenSSL other misc man-pages.
1444 share/doc/openssl/html/man1
1445 share/doc/openssl/html/man3
1446 share/doc/openssl/html/man5
1447 share/doc/openssl/html/man7
1448 Contains the HTML rendition of the man-pages.
1452 'arch' is replaced with the architecture name, `ALPHA` or `IA64`,
1453 'sover' is replaced with the shared library version (`0101` for 1.1), and
1454 'pz' is replaced with the pointer size OpenSSL was built with:
1456 [.EXE.'arch'] Contains the openssl binary.
1457 [.EXE] Contains a few utility scripts.
1459 Contains the header files needed if you want
1460 to build your own programs that use libcrypto
1462 [.LIB.'arch'] Contains the OpenSSL library files.
1463 [.ENGINES'sover''pz'.'arch']
1464 Contains the OpenSSL dynamically loadable engines.
1465 [.SYS$STARTUP] Contains startup, login and shutdown scripts.
1466 These define appropriate logical names and
1468 [.SYSTEST] Contains the installation verification procedure.
1469 [.HTML] Contains the HTML rendition of the manual pages.
1471 ### Additional Directories
1473 Additionally, install will add the following directories under
1474 OPENSSLDIR (the directory given with `--openssldir` or its default)
1475 for you convenience:
1477 certs Initially empty, this is the default location
1478 for certificate files.
1479 private Initially empty, this is the default location
1480 for private key files.
1481 misc Various scripts.
1483 The installation directory should be appropriately protected to ensure
1484 unprivileged users cannot make changes to OpenSSL binaries or files, or
1485 install engines. If you already have a pre-installed version of OpenSSL as
1486 part of your Operating System it is recommended that you do not overwrite
1487 the system version and instead install to somewhere else.
1489 Package builders who want to configure the library for standard locations,
1490 but have the package installed somewhere else so that it can easily be
1493 $ make DESTDIR=/tmp/package-root install # Unix
1494 $ mms/macro="DESTDIR=TMP:[PACKAGE-ROOT]" install ! OpenVMS
1496 The specified destination directory will be prepended to all installation
1499 Compatibility issues with previous OpenSSL versions
1500 ---------------------------------------------------
1502 ### COMPILING existing applications
1504 Starting with version 1.1.0, OpenSSL hides a number of structures that were
1505 previously open. This includes all internal libssl structures and a number
1506 of EVP types. Accessor functions have been added to allow controlled access
1507 to the structures' data.
1509 This means that some software needs to be rewritten to adapt to the new ways
1510 of doing things. This often amounts to allocating an instance of a structure
1511 explicitly where you could previously allocate them on the stack as automatic
1512 variables, and using the provided accessor functions where you would previously
1513 access a structure's field directly.
1515 Some APIs have changed as well. However, older APIs have been preserved when
1518 Post-installation Notes
1519 -----------------------
1521 With the default OpenSSL installation comes a FIPS provider module, which
1522 needs some post-installation attention, without which it will not be usable.
1523 This involves using the following command:
1525 $ openssl fipsinstall
1527 See the openssl-fipsinstall(1) manual for details and examples.
1529 Advanced Build Options
1530 ======================
1532 Environment Variables
1533 ---------------------
1535 A number of environment variables can be used to provide additional control
1536 over the build process. Typically these should be defined prior to running
1537 `Configure`. Not all environment variables are relevant to all platforms.
1540 The name of the ar executable to use.
1543 Use a different build file name than the platform default
1544 ("Makefile" on Unix-like platforms, "makefile" on native Windows,
1545 "descrip.mms" on OpenVMS). This requires that there is a
1546 corresponding build file template.
1547 See [Configurations/README.md](Configurations/README.md)
1548 for further information.
1551 The compiler to use. Configure will attempt to pick a default
1552 compiler for your platform but this choice can be overridden
1553 using this variable. Set it to the compiler executable you wish
1554 to use, e.g. gcc or clang.
1557 This environment variable has the same meaning as for the
1558 "--cross-compile-prefix" Configure flag described above. If both
1559 are set then the Configure flag takes precedence.
1562 The command string for the Perl executable to insert in the
1563 #! line of perl scripts that will be publicly installed.
1564 Default: /usr/bin/env perl
1565 Note: the value of this variable is added to the same scripts
1566 on all platforms, but it's only relevant on Unix-like platforms.
1569 This can be the value `32` or `64` to specify the architecture
1570 when it is not "obvious" to the configuration. It should generally
1571 not be necessary to specify this environment variable.
1574 The name of the nm executable to use.
1576 OPENSSL_LOCAL_CONFIG_DIR
1577 OpenSSL comes with a database of information about how it
1578 should be built on different platforms as well as build file
1579 templates for those platforms. The database is comprised of
1580 ".conf" files in the Configurations directory. The build
1581 file templates reside there as well as ".tmpl" files. See the
1582 file [Configurations/README.md](Configurations/README.md)
1583 for further information about the format of ".conf" files
1584 as well as information on the ".tmpl" files.
1585 In addition to the standard ".conf" and ".tmpl" files, it is
1586 possible to create your own ".conf" and ".tmpl" files and
1587 store them locally, outside the OpenSSL source tree.
1588 This environment variable can be set to the directory where
1589 these files are held and will be considered by Configure
1590 before it looks in the standard directories.
1593 The name of the Perl executable to use when building OpenSSL.
1594 Only needed if building should use a different Perl executable
1595 than what is used to run the Configure script.
1598 The name of the ranlib executable to use.
1601 The name of the rc executable to use. The default will be as
1602 defined for the target platform in the ".conf" file. If not
1603 defined then "windres" will be used. The WINDRES environment
1604 variable is synonymous to this. If both are defined then RC
1613 The `Configure` script generates a Makefile in a format relevant to the specific
1614 platform. The Makefiles provide a number of targets that can be used. Not all
1615 targets may be available on all platforms. Only the most common targets are
1616 described here. Examine the Makefiles themselves for the full list.
1619 The target to build all the software components and
1623 Build all the software components.
1624 THIS IS THE DEFAULT TARGET.
1627 Build all documentation components.
1630 Remove all build artefacts and return the directory to a "clean"
1634 Rebuild the dependencies in the Makefiles. This is a legacy
1635 option that no longer needs to be used since OpenSSL 1.1.0.
1638 Install all OpenSSL components.
1641 Only install the OpenSSL software components.
1644 Only install the OpenSSL documentation components.
1647 Only install the OpenSSL man pages (Unix only).
1650 Only install the OpenSSL HTML documentation.
1653 Install the FIPS provider module configuration file.
1656 Prints a list of all the self test names.
1659 Build and run the OpenSSL self tests.
1662 Uninstall all OpenSSL components.
1666 Re-run the configuration process, as exactly as the last time
1670 This is a developer option. If you are developing a patch for
1671 OpenSSL you may need to use this if you want to update
1672 automatically generated files; add new error codes or add new
1673 (or change the visibility of) public API functions. (Unix only).
1675 Running Selected Tests
1676 ----------------------
1678 You can specify a set of tests to be performed
1679 using the `make` variable `TESTS`.
1681 See the section [Running Selected Tests of
1682 test/README.md](test/README.md#running-selected-tests).
1687 Configuration Problems
1688 ----------------------
1690 ### Selecting the correct target
1692 The `./Configure` script tries hard to guess your operating system, but in some
1693 cases it does not succeed. You will see a message like the following:
1696 Operating system: x86-whatever-minix
1697 This system (minix) is not supported. See file INSTALL.md for details.
1699 Even if the automatic target selection by the `./Configure` script fails,
1700 chances are that you still might find a suitable target in the `Configurations`
1701 directory, which you can supply to the `./Configure` command,
1702 possibly after some adjustment.
1704 The `Configurations/` directory contains a lot of examples of such targets.
1705 The main configuration file is [10-main.conf], which contains all targets that
1706 are officially supported by the OpenSSL team. Other configuration files contain
1707 targets contributed by other OpenSSL users. The list of targets can be found in
1708 a Perl list `my %targets = ( ... )`.
1713 inherit_from => [ "base-target" ],
1715 cflags => add("..."),
1717 perlasm_scheme => "...",
1722 If you call `./Configure` without arguments, it will give you a list of all
1723 known targets. Using `grep`, you can lookup the target definition in the
1724 `Configurations/` directory. For example the `android-x86_64` can be found in
1725 [Configurations/15-android.conf](Configurations/15-android.conf).
1727 The directory contains two README files, which explain the general syntax and
1728 design of the configuration files.
1730 - [Configurations/README.md](Configurations/README.md)
1731 - [Configurations/README-design.md](Configurations/README-design.md)
1733 If you need further help, try to search the [openssl-users] mailing list
1734 or the [GitHub Issues] for existing solutions. If you don't find anything,
1735 you can [raise an issue] to ask a question yourself.
1737 More about our support resources can be found in the [SUPPORT] file.
1739 ### Configuration Errors
1741 If the `./Configure` or `./Configure` command fails with an error message,
1742 read the error message carefully and try to figure out whether you made
1743 a mistake (e.g., by providing a wrong option), or whether the script is
1744 working incorrectly. If you think you encountered a bug, please
1745 [raise an issue] on GitHub to file a bug report.
1747 Along with a short description of the bug, please provide the complete
1748 configure command line and the relevant output including the error message.
1750 Note: To make the output readable, please add a 'code fence' (three backquotes
1751 ` ``` ` on a separate line) before and after your output:
1754 ./Configure [your arguments...]
1763 If the build fails, look carefully at the output. Try to locate and understand
1764 the error message. It might be that the compiler is already telling you
1765 exactly what you need to do to fix your problem.
1767 There may be reasons for the failure that aren't problems in OpenSSL itself,
1768 for example if the compiler reports missing standard or third party headers.
1770 If the build succeeded previously, but fails after a source or configuration
1771 change, it might be helpful to clean the build tree before attempting another
1772 build. Use this command:
1775 $ mms clean ! (or mmk) OpenVMS
1776 $ nmake clean # Windows
1778 Assembler error messages can sometimes be sidestepped by using the `no-asm`
1779 configuration option. See also [notes](#notes-on-assembler-modules-compilation).
1781 Compiling parts of OpenSSL with gcc and others with the system compiler will
1782 result in unresolved symbols on some systems.
1784 If you are still having problems, try to search the [openssl-users] mailing
1785 list or the [GitHub Issues] for existing solutions. If you think you
1786 encountered an OpenSSL bug, please [raise an issue] to file a bug report.
1787 Please take the time to review the existing issues first; maybe the bug was
1788 already reported or has already been fixed.
1793 If some tests fail, look at the output. There may be reasons for the failure
1794 that isn't a problem in OpenSSL itself (like an OS malfunction or a Perl issue).
1796 You may want increased verbosity, that can be accomplished as described in
1797 section [Test Failures of test/README.md](test/README.md#test-failures).
1799 You may also want to selectively specify which test(s) to perform. This can be
1800 done using the `make` variable `TESTS` as described in section [Running
1801 Selected Tests of test/README.md](test/README.md#running-selected-tests).
1803 If you find a problem with OpenSSL itself, try removing any
1804 compiler optimization flags from the `CFLAGS` line in the Makefile and
1805 run `make clean; make` or corresponding.
1807 To report a bug please open an issue on GitHub, at
1808 <https://github.com/openssl/openssl/issues>.
1813 Notes on multi-threading
1814 ------------------------
1816 For some systems, the OpenSSL `Configure` script knows what compiler options
1817 are needed to generate a library that is suitable for multi-threaded
1818 applications. On these systems, support for multi-threading is enabled
1819 by default; use the `no-threads` option to disable (this should never be
1822 On other systems, to enable support for multi-threading, you will have
1823 to specify at least two options: `threads`, and a system-dependent option.
1824 (The latter is `-D_REENTRANT` on various systems.) The default in this
1825 case, obviously, is not to include support for multi-threading (but
1826 you can still use `no-threads` to suppress an annoying warning message
1827 from the `Configure` script.)
1829 OpenSSL provides built-in support for two threading models: pthreads (found on
1830 most UNIX/Linux systems), and Windows threads. No other threading models are
1831 supported. If your platform does not provide pthreads or Windows threads then
1832 you should use `Configure` with the `no-threads` option.
1834 For pthreads, all locks are non-recursive. In addition, in a debug build,
1835 the mutex attribute `PTHREAD_MUTEX_ERRORCHECK` is used. If this is not
1836 available on your platform, you might have to add
1837 `-DOPENSSL_NO_MUTEX_ERRORCHECK` to your `Configure` invocation.
1838 (On Linux `PTHREAD_MUTEX_ERRORCHECK` is an enum value, so a built-in
1839 ifdef test cannot be used.)
1841 Notes on shared libraries
1842 -------------------------
1844 For most systems the OpenSSL `Configure` script knows what is needed to
1845 build shared libraries for libcrypto and libssl. On these systems
1846 the shared libraries will be created by default. This can be suppressed and
1847 only static libraries created by using the `no-shared` option. On systems
1848 where OpenSSL does not know how to build shared libraries the `no-shared`
1849 option will be forced and only static libraries will be created.
1851 Shared libraries are named a little differently on different platforms.
1852 One way or another, they all have the major OpenSSL version number as
1853 part of the file name, i.e. for OpenSSL 1.1.x, `1.1` is somehow part of
1856 On most POSIX platforms, shared libraries are named `libcrypto.so.1.1`
1857 and `libssl.so.1.1`.
1859 on Cygwin, shared libraries are named `cygcrypto-1.1.dll` and `cygssl-1.1.dll`
1860 with import libraries `libcrypto.dll.a` and `libssl.dll.a`.
1862 On Windows build with MSVC or using MingW, shared libraries are named
1863 `libcrypto-1_1.dll` and `libssl-1_1.dll` for 32-bit Windows,
1864 `libcrypto-1_1-x64.dll` and `libssl-1_1-x64.dll` for 64-bit x86_64 Windows,
1865 and `libcrypto-1_1-ia64.dll` and `libssl-1_1-ia64.dll` for IA64 Windows.
1866 With MSVC, the import libraries are named `libcrypto.lib` and `libssl.lib`,
1867 while with MingW, they are named `libcrypto.dll.a` and `libssl.dll.a`.
1869 On VMS, shareable images (VMS speak for shared libraries) are named
1870 `ossl$libcrypto0101_shr.exe` and `ossl$libssl0101_shr.exe`. However, when
1871 OpenSSL is specifically built for 32-bit pointers, the shareable images
1872 are named `ossl$libcrypto0101_shr32.exe` and `ossl$libssl0101_shr32.exe`
1873 instead, and when built for 64-bit pointers, they are named
1874 `ossl$libcrypto0101_shr64.exe` and `ossl$libssl0101_shr64.exe`.
1876 Notes on random number generation
1877 ---------------------------------
1879 Availability of cryptographically secure random numbers is required for
1880 secret key generation. OpenSSL provides several options to seed the
1881 internal CSPRNG. If not properly seeded, the internal CSPRNG will refuse
1882 to deliver random bytes and a "PRNG not seeded error" will occur.
1884 The seeding method can be configured using the `--with-rand-seed` option,
1885 which can be used to specify a comma separated list of seed methods.
1886 However, in most cases OpenSSL will choose a suitable default method,
1887 so it is not necessary to explicitly provide this option. Note also
1888 that not all methods are available on all platforms. The FIPS provider will
1889 silently ignore seed sources that were not validated.
1891 I) On operating systems which provide a suitable randomness source (in
1892 form of a system call or system device), OpenSSL will use the optimal
1893 available method to seed the CSPRNG from the operating system's
1894 randomness sources. This corresponds to the option `--with-rand-seed=os`.
1896 II) On systems without such a suitable randomness source, automatic seeding
1897 and reseeding is disabled (`--with-rand-seed=none`) and it may be necessary
1898 to install additional support software to obtain a random seed and reseed
1899 the CSPRNG manually. Please check out the manual pages for `RAND_add()`,
1900 `RAND_bytes()`, `RAND_egd()`, and the FAQ for more information.
1902 Notes on assembler modules compilation
1903 --------------------------------------
1905 Compilation of some code paths in assembler modules might depend on whether the
1906 current assembler version supports certain ISA extensions or not. Code paths
1907 that use the AES-NI, PCLMULQDQ, SSSE3, and SHA extensions are always assembled.
1908 Apart from that, the minimum requirements for the assembler versions are shown
1911 | ISA extension | GNU as | nasm | llvm |
1912 |---------------|--------|--------|---------|
1913 | AVX | 2.19 | 2.09 | 3.0 |
1914 | AVX2 | 2.22 | 2.10 | 3.1 |
1915 | ADCX/ADOX | 2.23 | 2.10 | 3.3 |
1916 | AVX512 | 2.25 | 2.11.8 | 3.6 (*) |
1917 | AVX512IFMA | 2.26 | 2.11.8 | 6.0 (*) |
1918 | VAES | 2.30 | 2.13.3 | 6.0 (*) |
1922 (*) Even though AVX512 support was implemented in llvm 3.6, prior to version 7.0
1923 an explicit -march flag was apparently required to compile assembly modules. But
1924 then the compiler generates processor-specific code, which in turn contradicts
1925 the idea of performing dispatch at run-time, which is facilitated by the special
1926 variable `OPENSSL_ia32cap`. For versions older than 7.0, it is possible to work
1927 around the problem by forcing the build procedure to use the following script:
1930 exec clang -no-integrated-as "$@"
1932 instead of the real clang. In which case it doesn't matter what clang version
1933 is used, as it is the version of the GNU assembler that will be checked.
1940 <https://mta.openssl.org/mailman/listinfo/openssl-users>
1946 <https://github.com/openssl/openssl/issues>
1949 <https://github.com/openssl/openssl/issues/new/choose>
1952 Configurations/10-main.conf