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