1 OPENSSL INSTALLATION 2 -------------------- 3 4 This document describes installation on all supported operating 5 systems (the Unix/Linux family (which includes Mac OS/X), OpenVMS, 6 and Windows). 7 8 To install OpenSSL, you will need: 9 10 * A make implementation 11 * Perl 5 with core modules (please read NOTES.PERL) 12 * The perl module Text::Template (please read NOTES.PERL) 13 * an ANSI C compiler 14 * a development environment in the form of development libraries and C 15 header files 16 * a supported operating system 17 18 For additional platform specific requirements, solutions to specific 19 issues and other details, please read one of these: 20 21 * NOTES.UNIX (any supported Unix like system) 22 * NOTES.VMS (OpenVMS) 23 * NOTES.WIN (any supported Windows) 24 * NOTES.DJGPP (DOS platform with DJGPP) 25 * NOTES.ANDROID (obviously Android [NDK]) 26 27 Notational conventions in this document 28 --------------------------------------- 29 30 Throughout this document, we use the following conventions in command 31 examples: 32 33 $ command Any line starting with a dollar sign 34 ($) is a command line. 35 36 { word1 | word2 | word3 } This denotes a mandatory choice, to be 37 replaced with one of the given words. 38 A simple example would be this: 39 40 $ echo { FOO | BAR | COOKIE } 41 42 which is to be understood as one of 43 these: 44 45 $ echo FOO 46 - or - 47 $ echo BAR 48 - or - 49 $ echo COOKIE 50 51 [ word1 | word2 | word3 ] Similar to { word1 | word2 | word3 } 52 except it's optional to give any of 53 those. In addition to the examples 54 above, this would also be valid: 55 56 $ echo 57 58 {{ target }} This denotes a mandatory word or 59 sequence of words of some sort. A 60 simple example would be this: 61 62 $ type {{ filename }} 63 64 which is to be understood to use the 65 command 'type' on some file name 66 determined by the user. 67 68 [[ options ]] Similar to {{ target }}, but is 69 optional. 70 71 Note that the notation assumes spaces around {, }, [, ], {{, }} and 72 [[, ]]. This is to differentiate from OpenVMS directory 73 specifications, which also use [ and ], but without spaces. 74 75 Quick Start 76 ----------- 77 78 If you want to just get on with it, do: 79 80 on Unix (again, this includes Mac OS/X): 81 82 $ ./config 83 $ make 84 $ make test 85 $ make install 86 87 on OpenVMS: 88 89 $ @config 90 $ mms 91 $ mms test 92 $ mms install 93 94 on Windows (only pick one of the targets for configuration): 95 96 $ perl Configure { VC-WIN32 | VC-WIN64A | VC-WIN64I | VC-CE } 97 $ nmake 98 $ nmake test 99 $ nmake install 100 101 Note that in order to perform the install step above you need to have 102 appropriate permissions to write to the installation directory. 103 104 If any of these steps fails, see section Installation in Detail below. 105 106 This will build and install OpenSSL in the default location, which is: 107 108 Unix: normal installation directories under /usr/local 109 OpenVMS: SYS$COMMON:[OPENSSL] 110 Windows: C:\Program Files\OpenSSL or C:\Program Files (x86)\OpenSSL 111 112 The installation directory should be appropriately protected to ensure 113 unprivileged users cannot make changes to OpenSSL binaries or files, or install 114 engines. If you already have a pre-installed version of OpenSSL as part of 115 your Operating System it is recommended that you do not overwrite the system 116 version and instead install to somewhere else. 117 118 If you want to install it anywhere else, run config like this (the options 119 --prefix and --openssldir are explained further down, and the values shown 120 here are mere examples): 121 122 On Unix: 123 124 $ ./config --prefix=/opt/openssl --openssldir=/usr/local/ssl 125 126 On OpenVMS: 127 128 $ @config --prefix=PROGRAM:[INSTALLS] --openssldir=SYS$MANAGER:[OPENSSL] 129 130 (Note: if you do add options to the configuration command, please make sure 131 you've read more than just this Quick Start, such as relevant NOTES.* files, 132 the options outline below, as configuration options may change the outcome 133 in otherwise unexpected ways) 134 135 136 Configuration Options 137 --------------------- 138 139 There are several options to ./config (or ./Configure) to customize 140 the build (note that for Windows, the defaults for --prefix and 141 --openssldir depend in what configuration is used and what Windows 142 implementation OpenSSL is built on. More notes on this in NOTES.WIN): 143 144 --api=x.y.z 145 Don't build with support for deprecated APIs below the 146 specified version number. For example "--api=1.1.0" will 147 remove support for all APIS that were deprecated in OpenSSL 148 version 1.1.0 or below. This is a rather specialized option 149 for developers. If you just intend to remove all deprecated 150 APIs entirely (up to the current version), it is easier 151 to add the 'no-deprecated' option instead (see below). 152 153 --cross-compile-prefix=PREFIX 154 The PREFIX to include in front of commands for your 155 toolchain. It's likely to have to end with dash, e.g. 156 a-b-c- would invoke GNU compiler as a-b-c-gcc, etc. 157 Unfortunately cross-compiling is too case-specific to 158 put together one-size-fits-all instructions. You might 159 have to pass more flags or set up environment variables 160 to actually make it work. Android and iOS cases are 161 discussed in corresponding Configurations/15-*.conf 162 files. But there are cases when this option alone is 163 sufficient. For example to build the mingw64 target on 164 Linux "--cross-compile-prefix=x86_64-w64-mingw32-" 165 works. Naturally provided that mingw packages are 166 installed. Today Debian and Ubuntu users have option to 167 install a number of prepackaged cross-compilers along 168 with corresponding run-time and development packages for 169 "alien" hardware. To give another example 170 "--cross-compile-prefix=mipsel-linux-gnu-" suffices 171 in such case. Needless to mention that you have to 172 invoke ./Configure, not ./config, and pass your target 173 name explicitly. Also, note that --openssldir refers 174 to target's file system, not one you are building on. 175 176 --debug 177 Build OpenSSL with debugging symbols and zero optimization 178 level. 179 180 --libdir=DIR 181 The name of the directory under the top of the installation 182 directory tree (see the --prefix option) where libraries will 183 be installed. By default this is "lib". Note that on Windows 184 only ".lib" files will be stored in this location. dll files 185 will always be installed to the "bin" directory. 186 187 --openssldir=DIR 188 Directory for OpenSSL configuration files, and also the 189 default certificate and key store. Defaults are: 190 191 Unix: /usr/local/ssl 192 Windows: C:\Program Files\Common Files\SSL 193 or C:\Program Files (x86)\Common Files\SSL 194 OpenVMS: SYS$COMMON:[OPENSSL-COMMON] 195 196 --prefix=DIR 197 The top of the installation directory tree. Defaults are: 198 199 Unix: /usr/local 200 Windows: C:\Program Files\OpenSSL 201 or C:\Program Files (x86)\OpenSSL 202 OpenVMS: SYS$COMMON:[OPENSSL] 203 204 --release 205 Build OpenSSL without debugging symbols. This is the default. 206 207 --strict-warnings 208 This is a developer flag that switches on various compiler 209 options recommended for OpenSSL development. It only works 210 when using gcc or clang as the compiler. If you are 211 developing a patch for OpenSSL then it is recommended that 212 you use this option where possible. 213 214 --with-zlib-include=DIR 215 The directory for the location of the zlib include file. This 216 option is only necessary if enable-zlib (see below) is used 217 and the include file is not already on the system include 218 path. 219 220 --with-zlib-lib=LIB 221 On Unix: this is the directory containing the zlib library. 222 If not provided the system library path will be used. 223 On Windows: this is the filename of the zlib library (with or 224 without a path). This flag must be provided if the 225 zlib-dynamic option is not also used. If zlib-dynamic is used 226 then this flag is optional and a default value ("ZLIB1") is 227 used if not provided. 228 On VMS: this is the filename of the zlib library (with or 229 without a path). This flag is optional and if not provided 230 then "GNV$LIBZSHR", "GNV$LIBZSHR32" or "GNV$LIBZSHR64" is 231 used by default depending on the pointer size chosen. 232 233 234 --with-rand-seed=seed1[,seed2,...] 235 A comma separated list of seeding methods which will be tried 236 by OpenSSL in order to obtain random input (a.k.a "entropy") 237 for seeding its cryptographically secure random number 238 generator (CSPRNG). The current seeding methods are: 239 240 os: Use a trusted operating system entropy source. 241 This is the default method if such an entropy 242 source exists. 243 getrandom: Use the L<getrandom(2)> or equivalent system 244 call. 245 devrandom: Use the first device from the DEVRANDOM list 246 which can be opened to read random bytes. The 247 DEVRANDOM preprocessor constant expands to 248 "/dev/urandom","/dev/random","/dev/srandom" on 249 most unix-ish operating systems. 250 egd: Check for an entropy generating daemon. 251 rdcpu: Use the RDSEED or RDRAND command if provided by 252 the CPU. 253 librandom: Use librandom (not implemented yet). 254 none: Disable automatic seeding. This is the default 255 on some operating systems where no suitable 256 entropy source exists, or no support for it is 257 implemented yet. 258 259 For more information, see the section 'Note on random number 260 generation' at the end of this document. 261 262 no-afalgeng 263 Don't build the AFALG engine. This option will be forced if 264 on a platform that does not support AFALG. 265 266 enable-ktls 267 Build with Kernel TLS support. This option will enable the 268 use of the Kernel TLS data-path, which can improve 269 performance and allow for the use of sendfile and splice 270 system calls on TLS sockets. The Kernel may use TLS 271 accelerators if any are available on the system. 272 This option will be forced off on systems that do not support 273 the Kernel TLS data-path. 274 275 enable-asan 276 Build with the Address sanitiser. This is a developer option 277 only. It may not work on all platforms and should never be 278 used in production environments. It will only work when used 279 with gcc or clang and should be used in conjunction with the 280 no-shared option. 281 282 no-asm 283 Do not use assembler code. This should be viewed as 284 debugging/trouble-shooting option rather than production. 285 On some platforms a small amount of assembler code may 286 still be used even with this option. 287 288 no-async 289 Do not build support for async operations. 290 291 no-autoalginit 292 Don't automatically load all supported ciphers and digests. 293 Typically OpenSSL will make available all of its supported 294 ciphers and digests. For a statically linked application this 295 may be undesirable if small executable size is an objective. 296 This only affects libcrypto. Ciphers and digests will have to 297 be loaded manually using EVP_add_cipher() and 298 EVP_add_digest() if this option is used. This option will 299 force a non-shared build. 300 301 no-autoerrinit 302 Don't automatically load all libcrypto/libssl error strings. 303 Typically OpenSSL will automatically load human readable 304 error strings. For a statically linked application this may 305 be undesirable if small executable size is an objective. 306 307 no-autoload-config 308 Don't automatically load the default openssl.cnf file. 309 Typically OpenSSL will automatically load a system config 310 file which configures default ssl options. 311 312 enable-buildtest-c++ 313 While testing, generate C++ buildtest files that 314 simply check that the public OpenSSL header files 315 are usable standalone with C++. 316 317 Enabling this option demands extra care. For any 318 compiler flag given directly as configuration 319 option, you must ensure that it's valid for both 320 the C and the C++ compiler. If not, the C++ build 321 test will most likely break. As an alternative, 322 you can use the language specific variables, CFLAGS 323 and CXXFLAGS. 324 325 no-capieng 326 Don't build the CAPI engine. This option will be forced if 327 on a platform that does not support CAPI. 328 329 no-cms 330 Don't build support for CMS features 331 332 no-comp 333 Don't build support for SSL/TLS compression. If this option 334 is left enabled (the default), then compression will only 335 work if the zlib or zlib-dynamic options are also chosen. 336 337 enable-crypto-mdebug 338 Build support for debugging memory allocated via 339 OPENSSL_malloc() or OPENSSL_zalloc(). 340 341 enable-crypto-mdebug-backtrace 342 As for crypto-mdebug, but additionally provide backtrace 343 information for allocated memory. 344 TO BE USED WITH CARE: this uses GNU C functionality, and 345 is therefore not usable for non-GNU config targets. If 346 your build complains about the use of '-rdynamic' or the 347 lack of header file execinfo.h, this option is not for you. 348 ALSO NOTE that even though execinfo.h is available on your 349 system (through Gnulib), the functions might just be stubs 350 that do nothing. 351 352 no-ct 353 Don't build support for Certificate Transparency. 354 355 no-deprecated 356 Don't build with support for any deprecated APIs. This is the 357 same as using "--api" and supplying the latest version 358 number. 359 360 no-dgram 361 Don't build support for datagram based BIOs. Selecting this 362 option will also force the disabling of DTLS. 363 364 no-dso 365 Don't build support for loading Dynamic Shared Objects. 366 367 enable-devcryptoeng 368 Build the /dev/crypto engine. It is automatically selected 369 on BSD implementations, in which case it can be disabled with 370 no-devcryptoeng. 371 372 no-dynamic-engine 373 Don't build the dynamically loaded engines. This only has an 374 effect in a "shared" build 375 376 no-ec 377 Don't build support for Elliptic Curves. 378 379 no-ec2m 380 Don't build support for binary Elliptic Curves 381 382 enable-ec_nistp_64_gcc_128 383 Enable support for optimised implementations of some commonly 384 used NIST elliptic curves. 385 This is only supported on platforms: 386 - with little-endian storage of non-byte types 387 - that tolerate misaligned memory references 388 - where the compiler: 389 - supports the non-standard type __uint128_t 390 - defines the built-in macro __SIZEOF_INT128__ 391 392 enable-egd 393 Build support for gathering entropy from EGD (Entropy 394 Gathering Daemon). 395 396 no-engine 397 Don't build support for loading engines. 398 399 no-err 400 Don't compile in any error strings. 401 402 enable-external-tests 403 Enable building of integration with external test suites. 404 This is a developer option and may not work on all platforms. 405 The only supported external test suite at the current time is 406 the BoringSSL test suite. See the file test/README.external 407 for further details. 408 409 no-filenames 410 Don't compile in filename and line number information (e.g. 411 for errors and memory allocation). 412 413 enable-fuzz-libfuzzer, enable-fuzz-afl 414 Build with support for fuzzing using either libfuzzer or AFL. 415 These are developer options only. They may not work on all 416 platforms and should never be used in production environments. 417 See the file fuzz/README.md for further details. 418 419 no-gost 420 Don't build support for GOST based ciphersuites. Note that 421 if this feature is enabled then GOST ciphersuites are only 422 available if the GOST algorithms are also available through 423 loading an externally supplied engine. 424 425 no-hw-padlock 426 Don't build the padlock engine. 427 428 no-makedepend 429 Don't generate dependencies. 430 431 no-multiblock 432 Don't build support for writing multiple records in one 433 go in libssl (Note: this is a different capability to the 434 pipelining functionality). 435 436 no-nextprotoneg 437 Don't build support for the NPN TLS extension. 438 439 no-ocsp 440 Don't build support for OCSP. 441 442 no-pic 443 Don't build with support for Position Independent Code. 444 445 no-pinshared By default OpenSSL will attempt to stay in memory until the 446 process exits. This is so that libcrypto and libssl can be 447 properly cleaned up automatically via an "atexit()" handler. 448 The handler is registered by libcrypto and cleans up both 449 libraries. On some platforms the atexit() handler will run on 450 unload of libcrypto (if it has been dynamically loaded) 451 rather than at process exit. This option can be used to stop 452 OpenSSL from attempting to stay in memory until the process 453 exits. This could lead to crashes if either libcrypto or 454 libssl have already been unloaded at the point 455 that the atexit handler is invoked, e.g. on a platform which 456 calls atexit() on unload of the library, and libssl is 457 unloaded before libcrypto then a crash is likely to happen. 458 Applications can suppress running of the atexit() handler at 459 run time by using the OPENSSL_INIT_NO_ATEXIT option to 460 OPENSSL_init_crypto(). See the man page for it for further 461 details. 462 463 no-posix-io 464 Don't use POSIX IO capabilities. 465 466 no-psk 467 Don't build support for Pre-Shared Key based ciphersuites. 468 469 no-rdrand 470 Don't use hardware RDRAND capabilities. 471 472 no-rfc3779 473 Don't build support for RFC3779 ("X.509 Extensions for IP 474 Addresses and AS Identifiers") 475 476 sctp 477 Build support for SCTP 478 479 no-shared 480 Do not create shared libraries, only static ones. See "Note 481 on shared libraries" below. 482 483 no-sock 484 Don't build support for socket BIOs 485 486 no-srp 487 Don't build support for SRP or SRP based ciphersuites. 488 489 no-srtp 490 Don't build SRTP support 491 492 no-sse2 493 Exclude SSE2 code paths from 32-bit x86 assembly modules. 494 Normally SSE2 extension is detected at run-time, but the 495 decision whether or not the machine code will be executed 496 is taken solely on CPU capability vector. This means that 497 if you happen to run OS kernel which does not support SSE2 498 extension on Intel P4 processor, then your application 499 might be exposed to "illegal instruction" exception. 500 There might be a way to enable support in kernel, e.g. 501 FreeBSD kernel can be compiled with CPU_ENABLE_SSE, and 502 there is a way to disengage SSE2 code paths upon application 503 start-up, but if you aim for wider "audience" running 504 such kernel, consider no-sse2. Both the 386 and 505 no-asm options imply no-sse2. 506 507 enable-ssl-trace 508 Build with the SSL Trace capabilities (adds the "-trace" 509 option to s_client and s_server). 510 511 no-static-engine 512 Don't build the statically linked engines. This only 513 has an impact when not built "shared". 514 515 no-stdio 516 Don't use anything from the C header file "stdio.h" that 517 makes use of the "FILE" type. Only libcrypto and libssl can 518 be built in this way. Using this option will suppress 519 building the command line applications. Additionally since 520 the OpenSSL tests also use the command line applications the 521 tests will also be skipped. 522 523 no-tests 524 Don't build test programs or run any test. 525 526 no-threads 527 Don't try to build with support for multi-threaded 528 applications. 529 530 threads 531 Build with support for multi-threaded applications. Most 532 platforms will enable this by default. However if on a 533 platform where this is not the case then this will usually 534 require additional system-dependent options! See "Note on 535 multi-threading" below. 536 537 no-ts 538 Don't build Time Stamping Authority support. 539 540 enable-ubsan 541 Build with the Undefined Behaviour sanitiser. This is a 542 developer option only. It may not work on all platforms and 543 should never be used in production environments. It will only 544 work when used with gcc or clang and should be used in 545 conjunction with the "-DPEDANTIC" option (or the 546 --strict-warnings option). 547 548 no-ui-console 549 Don't build with the "UI" console method (i.e. the "UI" 550 method that enables text based console prompts). 551 552 enable-unit-test 553 Enable additional unit test APIs. This should not typically 554 be used in production deployments. 555 556 enable-weak-ssl-ciphers 557 Build support for SSL/TLS ciphers that are considered "weak" 558 (e.g. RC4 based ciphersuites). 559 560 zlib 561 Build with support for zlib compression/decompression. 562 563 zlib-dynamic 564 Like "zlib", but has OpenSSL load the zlib library 565 dynamically when needed. This is only supported on systems 566 where loading of shared libraries is supported. 567 568 386 569 In 32-bit x86 builds, when generating assembly modules, 570 use the 80386 instruction set only (the default x86 code 571 is more efficient, but requires at least a 486). Note: 572 This doesn't affect code generated by compiler, you're 573 likely to complement configuration command line with 574 suitable compiler-specific option. 575 576 no-<prot> 577 Don't build support for negotiating the specified SSL/TLS 578 protocol (one of ssl, ssl3, tls, tls1, tls1_1, tls1_2, 579 tls1_3, dtls, dtls1 or dtls1_2). If "no-tls" is selected then 580 all of tls1, tls1_1, tls1_2 and tls1_3 are disabled. 581 Similarly "no-dtls" will disable dtls1 and dtls1_2. The 582 "no-ssl" option is synonymous with "no-ssl3". Note this only 583 affects version negotiation. OpenSSL will still provide the 584 methods for applications to explicitly select the individual 585 protocol versions. 586 587 no-<prot>-method 588 As for no-<prot> but in addition do not build the methods for 589 applications to explicitly select individual protocol 590 versions. Note that there is no "no-tls1_3-method" option 591 because there is no application method for TLSv1.3. Using 592 individual protocol methods directly is deprecated. 593 Applications should use TLS_method() instead. 594 595 enable-<alg> 596 Build with support for the specified algorithm, where <alg> 597 is one of: md2 or rc5. 598 599 no-<alg> 600 Build without support for the specified algorithm, where 601 <alg> is one of: aria, bf, blake2, camellia, cast, chacha, 602 cmac, des, dh, dsa, ecdh, ecdsa, idea, md4, mdc2, ocb, 603 poly1305, rc2, rc4, rmd160, scrypt, seed, siphash, sm2, sm3, 604 sm4 or whirlpool. The "ripemd" algorithm is deprecated and 605 if used is synonymous with rmd160. 606 607 -Dxxx, -Ixxx, -Wp, -lxxx, -Lxxx, -Wl, -rpath, -R, -framework, -static 608 These system specific options will be recognised and 609 passed through to the compiler to allow you to define 610 preprocessor symbols, specify additional libraries, library 611 directories or other compiler options. It might be worth 612 noting that some compilers generate code specifically for 613 processor the compiler currently executes on. This is not 614 necessarily what you might have in mind, since it might be 615 unsuitable for execution on other, typically older, 616 processor. Consult your compiler documentation. 617 618 Take note of the VAR=value documentation below and how 619 these flags interact with those variables. 620 621 -xxx, +xxx, /xxx 622 Additional options that are not otherwise recognised are 623 passed through as they are to the compiler as well. 624 Unix-style options beginning with a '-' or '+' and 625 Windows-style options beginning with a '/' are recognized. 626 Again, consult your compiler documentation. 627 628 If the option contains arguments separated by spaces, 629 then the URL-style notation %20 can be used for the space 630 character in order to avoid having to quote the option. 631 For example, -opt%20arg gets expanded to -opt arg. 632 In fact, any ASCII character can be encoded as %xx using its 633 hexadecimal encoding. 634 635 Take note of the VAR=value documentation below and how 636 these flags interact with those variables. 637 638 VAR=value 639 Assignment of environment variable for Configure. These 640 work just like normal environment variable assignments, 641 but are supported on all platforms and are confined to 642 the configuration scripts only. These assignments override 643 the corresponding value in the inherited environment, if 644 there is one. 645 646 The following variables are used as "make variables" and 647 can be used as an alternative to giving preprocessor, 648 compiler and linker options directly as configuration. 649 The following variables are supported: 650 651 AR The static library archiver. 652 ARFLAGS Flags for the static library archiver. 653 AS The assembler compiler. 654 ASFLAGS Flags for the assembler compiler. 655 CC The C compiler. 656 CFLAGS Flags for the C compiler. 657 CXX The C++ compiler. 658 CXXFLAGS Flags for the C++ compiler. 659 CPP The C/C++ preprocessor. 660 CPPFLAGS Flags for the C/C++ preprocessor. 661 CPPDEFINES List of CPP macro definitions, separated 662 by a platform specific character (':' or 663 space for Unix, ';' for Windows, ',' for 664 VMS). This can be used instead of using 665 -D (or what corresponds to that on your 666 compiler) in CPPFLAGS. 667 CPPINCLUDES List of CPP inclusion directories, separated 668 the same way as for CPPDEFINES. This can 669 be used instead of -I (or what corresponds 670 to that on your compiler) in CPPFLAGS. 671 HASHBANGPERL Perl invocation to be inserted after '#!' 672 in public perl scripts (only relevant on 673 Unix). 674 LD The program linker (not used on Unix, $(CC) 675 is used there). 676 LDFLAGS Flags for the shared library, DSO and 677 program linker. 678 LDLIBS Extra libraries to use when linking. 679 Takes the form of a space separated list 680 of library specifications on Unix and 681 Windows, and as a comma separated list of 682 libraries on VMS. 683 RANLIB The library archive indexer. 684 RC The Windows resource compiler. 685 RCFLAGS Flags for the Windows resource compiler. 686 RM The command to remove files and directories. 687 688 These cannot be mixed with compiling / linking flags given 689 on the command line. In other words, something like this 690 isn't permitted. 691 692 ./config -DFOO CPPFLAGS=-DBAR -DCOOKIE 693 694 Backward compatibility note: 695 696 To be compatible with older configuration scripts, the 697 environment variables are ignored if compiling / linking 698 flags are given on the command line, except for these: 699 700 AR, CC, CXX, CROSS_COMPILE, HASHBANGPERL, PERL, RANLIB, RC 701 and WINDRES 702 703 For example, the following command will not see -DBAR: 704 705 CPPFLAGS=-DBAR ./config -DCOOKIE 706 707 However, the following will see both set variables: 708 709 CC=gcc CROSS_COMPILE=x86_64-w64-mingw32- \ 710 ./config -DCOOKIE 711 712 If CC is set, it is advisable to also set CXX to ensure 713 both C and C++ compilers are in the same "family". This 714 becomes relevant with 'enable-external-tests' and 715 'enable-buildtest-c++'. 716 717 reconf 718 reconfigure 719 Reconfigure from earlier data. This fetches the previous 720 command line options and environment from data saved in 721 "configdata.pm", and runs the configuration process again, 722 using these options and environment. 723 Note: NO other option is permitted together with "reconf". 724 This means that you also MUST use "./Configure" (or 725 what corresponds to that on non-Unix platforms) directly 726 to invoke this option. 727 Note: The original configuration saves away values for ALL 728 environment variables that were used, and if they weren't 729 defined, they are still saved away with information that 730 they weren't originally defined. This information takes 731 precedence over environment variables that are defined 732 when reconfiguring. 733 734 Displaying configuration data 735 ----------------------------- 736 737 The configuration script itself will say very little, and finishes by 738 creating "configdata.pm". This perl module can be loaded by other scripts 739 to find all the configuration data, and it can also be used as a script to 740 display all sorts of configuration data in a human readable form. 741 742 For more information, please do: 743 744 $ ./configdata.pm --help # Unix 745 746 or 747 748 $ perl configdata.pm --help # Windows and VMS 749 750 Installation in Detail 751 ---------------------- 752 753 1a. Configure OpenSSL for your operation system automatically: 754 755 NOTE: This is not available on Windows. 756 757 $ ./config [[ options ]] # Unix 758 759 or 760 761 $ @config [[ options ]] ! OpenVMS 762 763 For the remainder of this text, the Unix form will be used in all 764 examples, please use the appropriate form for your platform. 765 766 This guesses at your operating system (and compiler, if necessary) and 767 configures OpenSSL based on this guess. Run ./config -t to see 768 if it guessed correctly. If you want to use a different compiler, you 769 are cross-compiling for another platform, or the ./config guess was 770 wrong for other reasons, go to step 1b. Otherwise go to step 2. 771 772 On some systems, you can include debugging information as follows: 773 774 $ ./config -d [[ options ]] 775 776 1b. Configure OpenSSL for your operating system manually 777 778 OpenSSL knows about a range of different operating system, hardware and 779 compiler combinations. To see the ones it knows about, run 780 781 $ ./Configure # Unix 782 783 or 784 785 $ perl Configure # All other platforms 786 787 For the remainder of this text, the Unix form will be used in all 788 examples, please use the appropriate form for your platform. 789 790 Pick a suitable name from the list that matches your system. For most 791 operating systems there is a choice between using "cc" or "gcc". When 792 you have identified your system (and if necessary compiler) use this name 793 as the argument to Configure. For example, a "linux-elf" user would 794 run: 795 796 $ ./Configure linux-elf [[ options ]] 797 798 If your system isn't listed, you will have to create a configuration 799 file named Configurations/{{ something }}.conf and add the correct 800 configuration for your system. See the available configs as examples 801 and read Configurations/README and Configurations/README.design for 802 more information. 803 804 The generic configurations "cc" or "gcc" should usually work on 32 bit 805 Unix-like systems. 806 807 Configure creates a build file ("Makefile" on Unix, "makefile" on Windows 808 and "descrip.mms" on OpenVMS) from a suitable template in Configurations, 809 and defines various macros in include/openssl/opensslconf.h (generated from 810 include/openssl/opensslconf.h.in). 811 812 1c. Configure OpenSSL for building outside of the source tree. 813 814 OpenSSL can be configured to build in a build directory separate from 815 the directory with the source code. It's done by placing yourself in 816 some other directory and invoking the configuration commands from 817 there. 818 819 Unix example: 820 821 $ mkdir /var/tmp/openssl-build 822 $ cd /var/tmp/openssl-build 823 $ /PATH/TO/OPENSSL/SOURCE/config [[ options ]] 824 825 or 826 827 $ /PATH/TO/OPENSSL/SOURCE/Configure {{ target }} [[ options ]] 828 829 OpenVMS example: 830 831 $ set default sys$login: 832 $ create/dir [.tmp.openssl-build] 833 $ set default [.tmp.openssl-build] 834 $ @[PATH.TO.OPENSSL.SOURCE]config [[ options ]] 835 836 or 837 838 $ @[PATH.TO.OPENSSL.SOURCE]Configure {{ target }} [[ options ]] 839 840 Windows example: 841 842 $ C: 843 $ mkdir \temp-openssl 844 $ cd \temp-openssl 845 $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure {{ target }} [[ options ]] 846 847 Paths can be relative just as well as absolute. Configure will 848 do its best to translate them to relative paths whenever possible. 849 850 2. Build OpenSSL by running: 851 852 $ make # Unix 853 $ mms ! (or mmk) OpenVMS 854 $ nmake # Windows 855 856 This will build the OpenSSL libraries (libcrypto.a and libssl.a on 857 Unix, corresponding on other platforms) and the OpenSSL binary 858 ("openssl"). The libraries will be built in the top-level directory, 859 and the binary will be in the "apps" subdirectory. 860 861 Troubleshooting: 862 863 If the build fails, look at the output. There may be reasons 864 for the failure that aren't problems in OpenSSL itself (like 865 missing standard headers). 866 867 If the build succeeded previously, but fails after a source or 868 configuration change, it might be helpful to clean the build tree 869 before attempting another build. Use this command: 870 871 $ make clean # Unix 872 $ mms clean ! (or mmk) OpenVMS 873 $ nmake clean # Windows 874 875 Assembler error messages can sometimes be sidestepped by using the 876 "no-asm" configuration option. 877 878 Compiling parts of OpenSSL with gcc and others with the system 879 compiler will result in unresolved symbols on some systems. 880 881 If you are still having problems you can get help by sending an email 882 to the openssl-users email list (see 883 https://www.openssl.org/community/mailinglists.html for details). If 884 it is a bug with OpenSSL itself, please open an issue on GitHub, at 885 https://github.com/openssl/openssl/issues. Please review the existing 886 ones first; maybe the bug was already reported or has already been 887 fixed. 888 889 3. After a successful build, the libraries should be tested. Run: 890 891 $ make test # Unix 892 $ mms test ! OpenVMS 893 $ nmake test # Windows 894 895 NOTE: you MUST run the tests from an unprivileged account (or 896 disable your privileges temporarily if your platform allows it). 897 898 If some tests fail, look at the output. There may be reasons for 899 the failure that isn't a problem in OpenSSL itself (like a 900 malfunction with Perl). You may want increased verbosity, that 901 can be accomplished like this: 902 903 $ make VERBOSE=1 test # Unix 904 905 $ mms /macro=(VERBOSE=1) test ! OpenVMS 906 907 $ nmake VERBOSE=1 test # Windows 908 909 If you want to run just one or a few specific tests, you can use 910 the make variable TESTS to specify them, like this: 911 912 $ make TESTS='test_rsa test_dsa' test # Unix 913 $ mms/macro="TESTS=test_rsa test_dsa" test ! OpenVMS 914 $ nmake TESTS='test_rsa test_dsa' test # Windows 915 916 And of course, you can combine (Unix example shown): 917 918 $ make VERBOSE=1 TESTS='test_rsa test_dsa' test 919 920 You can find the list of available tests like this: 921 922 $ make list-tests # Unix 923 $ mms list-tests ! OpenVMS 924 $ nmake list-tests # Windows 925 926 Have a look at the manual for the perl module Test::Harness to 927 see what other HARNESS_* variables there are. 928 929 If you find a problem with OpenSSL itself, try removing any 930 compiler optimization flags from the CFLAGS line in Makefile and 931 run "make clean; make" or corresponding. 932 933 To report a bug please open an issue on GitHub, at 934 https://github.com/openssl/openssl/issues. 935 936 For more details on how the make variables TESTS can be used, 937 see section TESTS in Detail below. 938 939 4. If everything tests ok, install OpenSSL with 940 941 $ make install # Unix 942 $ mms install ! OpenVMS 943 $ nmake install # Windows 944 945 Note that in order to perform the install step above you need to have 946 appropriate permissions to write to the installation directory. 947 948 The above commands will install all the software components in this 949 directory tree under PREFIX (the directory given with --prefix or its 950 default): 951 952 Unix: 953 954 bin/ Contains the openssl binary and a few other 955 utility scripts. 956 include/openssl 957 Contains the header files needed if you want 958 to build your own programs that use libcrypto 959 or libssl. 960 lib Contains the OpenSSL library files. 961 lib/engines Contains the OpenSSL dynamically loadable engines. 962 963 share/man/man1 Contains the OpenSSL command line man-pages. 964 share/man/man3 Contains the OpenSSL library calls man-pages. 965 share/man/man5 Contains the OpenSSL configuration format man-pages. 966 share/man/man7 Contains the OpenSSL other misc man-pages. 967 968 share/doc/openssl/html/man1 969 share/doc/openssl/html/man3 970 share/doc/openssl/html/man5 971 share/doc/openssl/html/man7 972 Contains the HTML rendition of the man-pages. 973 974 OpenVMS ('arch' is replaced with the architecture name, "ALPHA" 975 or "IA64", 'sover' is replaced with the shared library version 976 (0101 for 1.1.x), and 'pz' is replaced with the pointer size 977 OpenSSL was built with): 978 979 [.EXE.'arch'] Contains the openssl binary. 980 [.EXE] Contains a few utility scripts. 981 [.include.openssl] 982 Contains the header files needed if you want 983 to build your own programs that use libcrypto 984 or libssl. 985 [.LIB.'arch'] Contains the OpenSSL library files. 986 [.ENGINES'sover''pz'.'arch'] 987 Contains the OpenSSL dynamically loadable engines. 988 [.SYS$STARTUP] Contains startup, login and shutdown scripts. 989 These define appropriate logical names and 990 command symbols. 991 [.SYSTEST] Contains the installation verification procedure. 992 [.HTML] Contains the HTML rendition of the manual pages. 993 994 995 Additionally, install will add the following directories under 996 OPENSSLDIR (the directory given with --openssldir or its default) 997 for you convenience: 998 999 certs Initially empty, this is the default location 1000 for certificate files. 1001 private Initially empty, this is the default location 1002 for private key files. 1003 misc Various scripts. 1004 1005 The installation directory should be appropriately protected to ensure 1006 unprivileged users cannot make changes to OpenSSL binaries or files, or 1007 install engines. If you already have a pre-installed version of OpenSSL as 1008 part of your Operating System it is recommended that you do not overwrite 1009 the system version and instead install to somewhere else. 1010 1011 Package builders who want to configure the library for standard 1012 locations, but have the package installed somewhere else so that 1013 it can easily be packaged, can use 1014 1015 $ make DESTDIR=/tmp/package-root install # Unix 1016 $ mms/macro="DESTDIR=TMP:[PACKAGE-ROOT]" install ! OpenVMS 1017 1018 The specified destination directory will be prepended to all 1019 installation target paths. 1020 1021 Compatibility issues with previous OpenSSL versions: 1022 1023 * COMPILING existing applications 1024 1025 Starting with version 1.1.0, OpenSSL hides a number of structures 1026 that were previously open. This includes all internal libssl 1027 structures and a number of EVP types. Accessor functions have 1028 been added to allow controlled access to the structures' data. 1029 1030 This means that some software needs to be rewritten to adapt to 1031 the new ways of doing things. This often amounts to allocating 1032 an instance of a structure explicitly where you could previously 1033 allocate them on the stack as automatic variables, and using the 1034 provided accessor functions where you would previously access a 1035 structure's field directly. 1036 1037 Some APIs have changed as well. However, older APIs have been 1038 preserved when possible. 1039 1040 Environment Variables 1041 --------------------- 1042 1043 A number of environment variables can be used to provide additional control 1044 over the build process. Typically these should be defined prior to running 1045 config or Configure. Not all environment variables are relevant to all 1046 platforms. 1047 1048 AR 1049 The name of the ar executable to use. 1050 1051 BUILDFILE 1052 Use a different build file name than the platform default 1053 ("Makefile" on Unix-like platforms, "makefile" on native Windows, 1054 "descrip.mms" on OpenVMS). This requires that there is a 1055 corresponding build file template. See Configurations/README 1056 for further information. 1057 1058 CC 1059 The compiler to use. Configure will attempt to pick a default 1060 compiler for your platform but this choice can be overridden 1061 using this variable. Set it to the compiler executable you wish 1062 to use, e.g. "gcc" or "clang". 1063 1064 CROSS_COMPILE 1065 This environment variable has the same meaning as for the 1066 "--cross-compile-prefix" Configure flag described above. If both 1067 are set then the Configure flag takes precedence. 1068 1069 NM 1070 The name of the nm executable to use. 1071 1072 OPENSSL_LOCAL_CONFIG_DIR 1073 OpenSSL comes with a database of information about how it 1074 should be built on different platforms as well as build file 1075 templates for those platforms. The database is comprised of 1076 ".conf" files in the Configurations directory. The build 1077 file templates reside there as well as ".tmpl" files. See the 1078 file Configurations/README for further information about the 1079 format of ".conf" files as well as information on the ".tmpl" 1080 files. 1081 In addition to the standard ".conf" and ".tmpl" files, it is 1082 possible to create your own ".conf" and ".tmpl" files and store 1083 them locally, outside the OpenSSL source tree. This environment 1084 variable can be set to the directory where these files are held 1085 and will be considered by Configure before it looks in the 1086 standard directories. 1087 1088 PERL 1089 The name of the Perl executable to use when building OpenSSL. 1090 This variable is used in config script only. Configure on the 1091 other hand imposes the interpreter by which it itself was 1092 executed on the whole build procedure. 1093 1094 HASHBANGPERL 1095 The command string for the Perl executable to insert in the 1096 #! line of perl scripts that will be publicly installed. 1097 Default: /usr/bin/env perl 1098 Note: the value of this variable is added to the same scripts 1099 on all platforms, but it's only relevant on Unix-like platforms. 1100 1101 RC 1102 The name of the rc executable to use. The default will be as 1103 defined for the target platform in the ".conf" file. If not 1104 defined then "windres" will be used. The WINDRES environment 1105 variable is synonymous to this. If both are defined then RC 1106 takes precedence. 1107 1108 RANLIB 1109 The name of the ranlib executable to use. 1110 1111 WINDRES 1112 See RC. 1113 1114 Makefile targets 1115 ---------------- 1116 1117 The Configure script generates a Makefile in a format relevant to the specific 1118 platform. The Makefiles provide a number of targets that can be used. Not all 1119 targets may be available on all platforms. Only the most common targets are 1120 described here. Examine the Makefiles themselves for the full list. 1121 1122 all 1123 The default target to build all the software components. 1124 1125 clean 1126 Remove all build artefacts and return the directory to a "clean" 1127 state. 1128 1129 depend 1130 Rebuild the dependencies in the Makefiles. This is a legacy 1131 option that no longer needs to be used since OpenSSL 1.1.0. 1132 1133 install 1134 Install all OpenSSL components. 1135 1136 install_sw 1137 Only install the OpenSSL software components. 1138 1139 install_docs 1140 Only install the OpenSSL documentation components. 1141 1142 install_man_docs 1143 Only install the OpenSSL man pages (Unix only). 1144 1145 install_html_docs 1146 Only install the OpenSSL html documentation. 1147 1148 list-tests 1149 Prints a list of all the self test names. 1150 1151 test 1152 Build and run the OpenSSL self tests. 1153 1154 uninstall 1155 Uninstall all OpenSSL components. 1156 1157 reconfigure 1158 reconf 1159 Re-run the configuration process, as exactly as the last time 1160 as possible. 1161 1162 update 1163 This is a developer option. If you are developing a patch for 1164 OpenSSL you may need to use this if you want to update 1165 automatically generated files; add new error codes or add new 1166 (or change the visibility of) public API functions. (Unix only). 1167 1168 TESTS in Detail 1169 --------------- 1170 1171 The make variable TESTS supports a versatile set of space separated tokens 1172 with which you can specify a set of tests to be performed. With a "current 1173 set of tests" in mind, initially being empty, here are the possible tokens: 1174 1175 alltests The current set of tests becomes the whole set of available 1176 tests (as listed when you do 'make list-tests' or similar). 1177 xxx Adds the test 'xxx' to the current set of tests. 1178 -xxx Removes 'xxx' from the current set of tests. If this is the 1179 first token in the list, the current set of tests is first 1180 assigned the whole set of available tests, effectively making 1181 this token equivalent to TESTS="alltests -xxx". 1182 nn Adds the test group 'nn' (which is a number) to the current 1183 set of tests. 1184 -nn Removes the test group 'nn' from the current set of tests. 1185 If this is the first token in the list, the current set of 1186 tests is first assigned the whole set of available tests, 1187 effectively making this token equivalent to 1188 TESTS="alltests -xxx". 1189 1190 Also, all tokens except for "alltests" may have wildcards, such as *. 1191 (on Unix and Windows, BSD style wildcards are supported, while on VMS, 1192 it's VMS style wildcards) 1193 1194 Example: All tests except for the fuzz tests: 1195 1196 $ make TESTS=-test_fuzz test 1197 1198 or (if you want to be explicit) 1199 1200 $ make TESTS='alltests -test_fuzz' test 1201 1202 Example: All tests that have a name starting with "test_ssl" but not those 1203 starting with "test_ssl_": 1204 1205 $ make TESTS='test_ssl* -test_ssl_*' test 1206 1207 Example: Only test group 10: 1208 1209 $ make TESTS='10' 1210 1211 Example: All tests except the slow group (group 99): 1212 1213 $ make TESTS='-99' 1214 1215 Example: All tests in test groups 80 to 99 except for tests in group 90: 1216 1217 $ make TESTS='[89]? -90' 1218 1219 Note on multi-threading 1220 ----------------------- 1221 1222 For some systems, the OpenSSL Configure script knows what compiler options 1223 are needed to generate a library that is suitable for multi-threaded 1224 applications. On these systems, support for multi-threading is enabled 1225 by default; use the "no-threads" option to disable (this should never be 1226 necessary). 1227 1228 On other systems, to enable support for multi-threading, you will have 1229 to specify at least two options: "threads", and a system-dependent option. 1230 (The latter is "-D_REENTRANT" on various systems.) The default in this 1231 case, obviously, is not to include support for multi-threading (but 1232 you can still use "no-threads" to suppress an annoying warning message 1233 from the Configure script.) 1234 1235 OpenSSL provides built-in support for two threading models: pthreads (found on 1236 most UNIX/Linux systems), and Windows threads. No other threading models are 1237 supported. If your platform does not provide pthreads or Windows threads then 1238 you should Configure with the "no-threads" option. 1239 1240 Notes on shared libraries 1241 ------------------------- 1242 1243 For most systems the OpenSSL Configure script knows what is needed to 1244 build shared libraries for libcrypto and libssl. On these systems 1245 the shared libraries will be created by default. This can be suppressed and 1246 only static libraries created by using the "no-shared" option. On systems 1247 where OpenSSL does not know how to build shared libraries the "no-shared" 1248 option will be forced and only static libraries will be created. 1249 1250 Shared libraries are named a little differently on different platforms. 1251 One way or another, they all have the major OpenSSL version number as 1252 part of the file name, i.e. for OpenSSL 1.1.x, 1.1 is somehow part of 1253 the name. 1254 1255 On most POSIX platforms, shared libraries are named libcrypto.so.1.1 1256 and libssl.so.1.1. 1257 1258 on Cygwin, shared libraries are named cygcrypto-1.1.dll and cygssl-1.1.dll 1259 with import libraries libcrypto.dll.a and libssl.dll.a. 1260 1261 On Windows build with MSVC or using MingW, shared libraries are named 1262 libcrypto-1_1.dll and libssl-1_1.dll for 32-bit Windows, libcrypto-1_1-x64.dll 1263 and libssl-1_1-x64.dll for 64-bit x86_64 Windows, and libcrypto-1_1-ia64.dll 1264 and libssl-1_1-ia64.dll for IA64 Windows. With MSVC, the import libraries 1265 are named libcrypto.lib and libssl.lib, while with MingW, they are named 1266 libcrypto.dll.a and libssl.dll.a. 1267 1268 On VMS, shareable images (VMS speak for shared libraries) are named 1269 ossl$libcrypto0101_shr.exe and ossl$libssl0101_shr.exe. However, when 1270 OpenSSL is specifically built for 32-bit pointers, the shareable images 1271 are named ossl$libcrypto0101_shr32.exe and ossl$libssl0101_shr32.exe 1272 instead, and when built for 64-bit pointers, they are named 1273 ossl$libcrypto0101_shr64.exe and ossl$libssl0101_shr64.exe. 1274 1275 Note on random number generation 1276 -------------------------------- 1277 1278 Availability of cryptographically secure random numbers is required for 1279 secret key generation. OpenSSL provides several options to seed the 1280 internal CSPRNG. If not properly seeded, the internal CSPRNG will refuse 1281 to deliver random bytes and a "PRNG not seeded error" will occur. 1282 1283 The seeding method can be configured using the --with-rand-seed option, 1284 which can be used to specify a comma separated list of seed methods. 1285 However in most cases OpenSSL will choose a suitable default method, 1286 so it is not necessary to explicitly provide this option. Note also 1287 that not all methods are available on all platforms. 1288 1289 I) On operating systems which provide a suitable randomness source (in 1290 form of a system call or system device), OpenSSL will use the optimal 1291 available method to seed the CSPRNG from the operating system's 1292 randomness sources. This corresponds to the option --with-rand-seed=os. 1293 1294 II) On systems without such a suitable randomness source, automatic seeding 1295 and reseeding is disabled (--with-rand-seed=none) and it may be necessary 1296 to install additional support software to obtain a random seed and reseed 1297 the CSPRNG manually. Please check out the manual pages for RAND_add(), 1298 RAND_bytes(), RAND_egd(), and the FAQ for more information. 1299