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