4 This document describes installation on all supported operating
5 systems (the Unix/Linux family (which includes Mac OS/X), OpenVMS,
8 To install OpenSSL, you will need:
10 * A make implementation
11 * Perl 5 with core modules (please read NOTES.PERL)
12 * The perl module Text::Template (please read NOTES.PERL)
14 * a development environment in the form of development libraries and C
16 * a supported operating system
18 For additional platform specific requirements, solutions to specific
19 issues and other details, please read one of these:
21 * NOTES.UNIX (any supported Unix like system)
23 * NOTES.WIN (any supported Windows)
24 * NOTES.DJGPP (DOS platform with DJGPP)
25 * NOTES.ANDROID (obviously Android [NDK])
26 * NOTES.VALGRIND (testing with Valgrind)
28 Notational conventions in this document
29 ---------------------------------------
31 Throughout this document, we use the following conventions in command
34 $ command Any line starting with a dollar sign
35 ($) is a command line.
37 { word1 | word2 | word3 } This denotes a mandatory choice, to be
38 replaced with one of the given words.
39 A simple example would be this:
41 $ echo { FOO | BAR | COOKIE }
43 which is to be understood as one of
52 [ word1 | word2 | word3 ] Similar to { word1 | word2 | word3 }
53 except it's optional to give any of
54 those. In addition to the examples
55 above, this would also be valid:
59 {{ target }} This denotes a mandatory word or
60 sequence of words of some sort. A
61 simple example would be this:
65 which is to be understood to use the
66 command 'type' on some file name
67 determined by the user.
69 [[ options ]] Similar to {{ target }}, but is
72 Note that the notation assumes spaces around {, }, [, ], {{, }} and
73 [[, ]]. This is to differentiate from OpenVMS directory
74 specifications, which also use [ and ], but without spaces.
79 If you want to just get on with it, do:
81 on Unix (again, this includes Mac OS/X):
95 on Windows (only pick one of the targets for configuration):
97 $ perl Configure { VC-WIN32 | VC-WIN64A | VC-WIN64I | VC-CE }
102 If any of these steps fails, see section Installation in Detail below.
104 This will build and install OpenSSL in the default location, which is:
106 Unix: normal installation directories under /usr/local
107 OpenVMS: SYS$COMMON:[OPENSSL-'version'...], where 'version' is the
108 OpenSSL version number with underscores instead of periods.
109 Windows: C:\Program Files\OpenSSL or C:\Program Files (x86)\OpenSSL
111 If you want to install it anywhere else, run config like this:
115 $ ./config --prefix=/opt/openssl --openssldir=/usr/local/ssl
119 $ @config --prefix=PROGRAM:[INSTALLS] --openssldir=SYS$MANAGER:[OPENSSL]
121 (Note: if you do add options to the configuration command, please make sure
122 you've read more than just this Quick Start, such as relevant NOTES.* files,
123 the options outline below, as configuration options may change the outcome
124 in otherwise unexpected ways)
127 Configuration Options
128 ---------------------
130 There are several options to ./config (or ./Configure) to customize
131 the build (note that for Windows, the defaults for --prefix and
132 --openssldir depend in what configuration is used and what Windows
133 implementation OpenSSL is built on. More notes on this in NOTES.WIN):
136 Don't build with support for deprecated APIs below the
137 specified version number. For example "--api=1.1.0" will
138 remove support for all APIS that were deprecated in OpenSSL
139 version 1.1.0 or below.
141 --cross-compile-prefix=PREFIX
142 The PREFIX to include in front of commands for your
143 toolchain. It's likely to have to end with dash, e.g.
144 a-b-c- would invoke GNU compiler as a-b-c-gcc, etc.
145 Unfortunately cross-compiling is too case-specific to
146 put together one-size-fits-all instructions. You might
147 have to pass more flags or set up environment variables
148 to actually make it work. Android and iOS cases are
149 discussed in corresponding Configurations/15-*.conf
150 files. But there are cases when this option alone is
151 sufficient. For example to build the mingw64 target on
152 Linux "--cross-compile-prefix=x86_64-w64-mingw32-"
153 works. Naturally provided that mingw packages are
154 installed. Today Debian and Ubuntu users have option to
155 install a number of prepackaged cross-compilers along
156 with corresponding run-time and development packages for
157 "alien" hardware. To give another example
158 "--cross-compile-prefix=mipsel-linux-gnu-" suffices
159 in such case. Needless to mention that you have to
160 invoke ./Configure, not ./config, and pass your target
161 name explicitly. Also, note that --openssldir refers
162 to target's file system, not one you are building on.
165 Build OpenSSL with debugging symbols and zero optimization
169 The name of the directory under the top of the installation
170 directory tree (see the --prefix option) where libraries will
171 be installed. By default this is "lib". Note that on Windows
172 only ".lib" files will be stored in this location. dll files
173 will always be installed to the "bin" directory.
176 Directory for OpenSSL configuration files, and also the
177 default certificate and key store. Defaults are:
180 Windows: C:\Program Files\Common Files\SSL
181 or C:\Program Files (x86)\Common Files\SSL
182 OpenVMS: SYS$COMMON:[OPENSSL-COMMON]
185 The top of the installation directory tree. Defaults are:
188 Windows: C:\Program Files\OpenSSL
189 or C:\Program Files (x86)\OpenSSL
190 OpenVMS: SYS$COMMON:[OPENSSL-'version']
193 Build OpenSSL without debugging symbols. This is the default.
196 This is a developer flag that switches on various compiler
197 options recommended for OpenSSL development. It only works
198 when using gcc or clang as the compiler. If you are
199 developing a patch for OpenSSL then it is recommended that
200 you use this option where possible.
202 --with-zlib-include=DIR
203 The directory for the location of the zlib include file. This
204 option is only necessary if enable-zlib (see below) is used
205 and the include file is not already on the system include
209 On Unix: this is the directory containing the zlib library.
210 If not provided the system library path will be used.
211 On Windows: this is the filename of the zlib library (with or
212 without a path). This flag must be provided if the
213 zlib-dynamic option is not also used. If zlib-dynamic is used
214 then this flag is optional and a default value ("ZLIB1") is
215 used if not provided.
216 On VMS: this is the filename of the zlib library (with or
217 without a path). This flag is optional and if not provided
218 then "GNV$LIBZSHR", "GNV$LIBZSHR32" or "GNV$LIBZSHR64" is
219 used by default depending on the pointer size chosen.
222 --with-rand-seed=seed1[,seed2,...]
223 A comma separated list of seeding methods which will be tried
224 by OpenSSL in order to obtain random input (a.k.a "entropy")
225 for seeding its cryptographically secure random number
226 generator (CSPRNG). The current seeding methods are:
228 os: Use a trusted operating system entropy source.
229 This is the default method if such an entropy
231 getrandom: Use the L<getrandom(2)> or equivalent system
233 devrandom: Use the the first device from the DEVRANDOM list
234 which can be opened to read random bytes. The
235 DEVRANDOM preprocessor constant expands to
236 "/dev/urandom","/dev/random","/dev/srandom" on
237 most unix-ish operating systems.
238 egd: Check for an entropy generating daemon.
239 rdcpu: Use the RDSEED or RDRAND command if provided by
241 librandom: Use librandom (not implemented yet).
242 none: Disable automatic seeding. This is the default
243 on some operating systems where no suitable
244 entropy source exists, or no support for it is
247 For more information, see the section 'Note on random number
248 generation' at the end of this document.
251 Don't build the AFALG engine. This option will be forced if
252 on a platform that does not support AFALG.
255 Build with Kernel TLS support. This option will enable the
256 use of the Kernel TLS data-path, which can improve
257 performance and allow for the use of sendfile and splice
258 system calls on TLS sockets. The Kernel may use TLS
259 accelerators if any are available on the system.
260 This option will be forced off on systems that do not support
261 the Kernel TLS data-path.
264 Build with the Address sanitiser. This is a developer option
265 only. It may not work on all platforms and should never be
266 used in production environments. It will only work when used
267 with gcc or clang and should be used in conjunction with the
271 Do not use assembler code. This should be viewed as
272 debugging/trouble-shooting option rather than production.
273 On some platforms a small amount of assembler code may
274 still be used even with this option.
277 Do not build support for async operations.
280 Don't automatically load all supported ciphers and digests.
281 Typically OpenSSL will make available all of its supported
282 ciphers and digests. For a statically linked application this
283 may be undesirable if small executable size is an objective.
284 This only affects libcrypto. Ciphers and digests will have to
285 be loaded manually using EVP_add_cipher() and
286 EVP_add_digest() if this option is used. This option will
287 force a non-shared build.
290 Don't automatically load all libcrypto/libssl error strings.
291 Typically OpenSSL will automatically load human readable
292 error strings. For a statically linked application this may
293 be undesirable if small executable size is an objective.
296 Don't automatically load the default openssl.cnf file.
297 Typically OpenSSL will automatically load a system config
298 file which configures default ssl options.
301 While testing, generate C++ buildtest files that
302 simply check that the public OpenSSL header files
303 are usable standalone with C++.
305 Enabling this option demands extra care. For any
306 compiler flag given directly as configuration
307 option, you must ensure that it's valid for both
308 the C and the C++ compiler. If not, the C++ build
309 test will most likely break. As an alternative,
310 you can use the language specific variables, CFLAGS
314 Don't build the CAPI engine. This option will be forced if
315 on a platform that does not support CAPI.
318 Don't build support for CMS features
321 Don't build support for SSL/TLS compression. If this option
322 is left enabled (the default), then compression will only
323 work if the zlib or zlib-dynamic options are also chosen.
326 Build support for debugging memory allocated via
327 OPENSSL_malloc() or OPENSSL_zalloc().
329 enable-crypto-mdebug-backtrace
330 As for crypto-mdebug, but additionally provide backtrace
331 information for allocated memory.
332 TO BE USED WITH CARE: this uses GNU C functionality, and
333 is therefore not usable for non-GNU config targets. If
334 your build complains about the use of '-rdynamic' or the
335 lack of header file execinfo.h, this option is not for you.
336 ALSO NOTE that even though execinfo.h is available on your
337 system (through Gnulib), the functions might just be stubs
341 Don't build support for Certificate Transparency.
344 Don't build with support for any deprecated APIs. This is the
345 same as using "--api" and supplying the latest version
349 Don't build support for datagram based BIOs. Selecting this
350 option will also force the disabling of DTLS.
353 Build the /dev/crypto engine. It is automatically selected
354 on BSD implementations, in which case it can be disabled with
358 Don't build the dynamically loaded engines. This only has an
359 effect in a "shared" build
362 Don't build support for Elliptic Curves.
365 Don't build support for binary Elliptic Curves
367 enable-ec_nistp_64_gcc_128
368 Enable support for optimised implementations of some commonly
369 used NIST elliptic curves.
370 This is only supported on platforms:
371 - with little-endian storage of non-byte types
372 - that tolerate misaligned memory references
373 - where the compiler:
374 - supports the non-standard type __uint128_t
375 - defines the built-in macro __SIZEOF_INT128__
378 Build support for gathering entropy from EGD (Entropy
382 Don't build support for loading engines.
385 Don't compile in any error strings.
387 enable-external-tests
388 Enable building of integration with external test suites.
389 This is a developer option and may not work on all platforms.
390 The only supported external test suite at the current time is
391 the BoringSSL test suite. See the file test/README.external
395 Don't compile in filename and line number information (e.g.
396 for errors and memory allocation).
399 Don't compile the FIPS module
401 enable-fuzz-libfuzzer, enable-fuzz-afl
402 Build with support for fuzzing using either libfuzzer or AFL.
403 These are developer options only. They may not work on all
404 platforms and should never be used in production environments.
405 See the file fuzz/README.md for further details.
408 Don't build support for GOST based ciphersuites. Note that
409 if this feature is enabled then GOST ciphersuites are only
410 available if the GOST algorithms are also available through
411 loading an externally supplied engine.
414 Don't build the legacy provider. Disabling this also disables
415 the legacy algorithms: MD2 (already disabled by default).
418 Don't generate dependencies.
421 Don't build any dynamically loadable engines. This also
422 implies 'no-dynamic-engine'.
425 Don't build support for writing multiple records in one
426 go in libssl (Note: this is a different capability to the
427 pipelining functionality).
430 Don't build support for the NPN TLS extension.
433 Don't build support for OCSP.
437 Don't build the padlock engine.
438 ('no-hw-padlock' is deprecated and should not be used)
441 Don't build with support for Position Independent Code.
443 no-pinshared By default OpenSSL will attempt to stay in memory until the
444 process exits. This is so that libcrypto and libssl can be
445 properly cleaned up automatically via an "atexit()" handler.
446 The handler is registered by libcrypto and cleans up both
447 libraries. On some platforms the atexit() handler will run on
448 unload of libcrypto (if it has been dynamically loaded)
449 rather than at process exit. This option can be used to stop
450 OpenSSL from attempting to stay in memory until the process
451 exits. This could lead to crashes if either libcrypto or
452 libssl have already been unloaded at the point
453 that the atexit handler is invoked, e.g. on a platform which
454 calls atexit() on unload of the library, and libssl is
455 unloaded before libcrypto then a crash is likely to happen.
456 Applications can suppress running of the atexit() handler at
457 run time by using the OPENSSL_INIT_NO_ATEXIT option to
458 OPENSSL_init_crypto(). See the man page for it for further
462 Don't use POSIX IO capabilities.
465 Don't build support for Pre-Shared Key based ciphersuites.
468 Don't use hardware RDRAND capabilities.
471 Don't build support for RFC3779 ("X.509 Extensions for IP
472 Addresses and AS Identifiers")
475 Build support for SCTP
478 Do not create shared libraries, only static ones. See "Note
479 on shared libraries" below.
482 Don't build support for socket BIOs
485 Don't build support for SRP or SRP based ciphersuites.
488 Don't build SRTP support
491 Exclude SSE2 code paths from 32-bit x86 assembly modules.
492 Normally SSE2 extension is detected at run-time, but the
493 decision whether or not the machine code will be executed
494 is taken solely on CPU capability vector. This means that
495 if you happen to run OS kernel which does not support SSE2
496 extension on Intel P4 processor, then your application
497 might be exposed to "illegal instruction" exception.
498 There might be a way to enable support in kernel, e.g.
499 FreeBSD kernel can be compiled with CPU_ENABLE_SSE, and
500 there is a way to disengage SSE2 code paths upon application
501 start-up, but if you aim for wider "audience" running
502 such kernel, consider no-sse2. Both the 386 and
503 no-asm options imply no-sse2.
506 Build with the SSL Trace capabilities (adds the "-trace"
507 option to s_client and s_server).
510 Don't build the statically linked engines. This only
511 has an impact when not built "shared".
514 Don't use anything from the C header file "stdio.h" that
515 makes use of the "FILE" type. Only libcrypto and libssl can
516 be built in this way. Using this option will suppress
517 building the command line applications. Additionally since
518 the OpenSSL tests also use the command line applications the
519 tests will also be skipped.
522 Don't build test programs or run any test.
525 Don't try to build with support for multi-threaded
529 Build with support for multi-threaded applications. Most
530 platforms will enable this by default. However if on a
531 platform where this is not the case then this will usually
532 require additional system-dependent options! See "Note on
533 multi-threading" below.
536 Build with support for the integrated tracing api. See manual pages
537 OSSL_trace_set_channel(3) and OSSL_trace_enabled(3) for details.
540 Don't build Time Stamping Authority support.
543 Build with the Undefined Behaviour sanitiser. This is a
544 developer option only. It may not work on all platforms and
545 should never be used in production environments. It will only
546 work when used with gcc or clang and should be used in
547 conjunction with the "-DPEDANTIC" option (or the
548 --strict-warnings option).
551 Don't build with the "UI" capability (i.e. the set of
552 features enabling text based prompts).
555 Enable additional unit test APIs. This should not typically
556 be used in production deployments.
558 enable-weak-ssl-ciphers
559 Build support for SSL/TLS ciphers that are considered "weak"
560 (e.g. RC4 based ciphersuites).
563 Build with support for zlib compression/decompression.
566 Like "zlib", but has OpenSSL load the zlib library
567 dynamically when needed. This is only supported on systems
568 where loading of shared libraries is supported.
571 In 32-bit x86 builds, when generating assembly modules,
572 use the 80386 instruction set only (the default x86 code
573 is more efficient, but requires at least a 486). Note:
574 This doesn't affect code generated by compiler, you're
575 likely to complement configuration command line with
576 suitable compiler-specific option.
579 Don't build support for negotiating the specified SSL/TLS
580 protocol (one of ssl, ssl3, tls, tls1, tls1_1, tls1_2,
581 tls1_3, dtls, dtls1 or dtls1_2). If "no-tls" is selected then
582 all of tls1, tls1_1, tls1_2 and tls1_3 are disabled.
583 Similarly "no-dtls" will disable dtls1 and dtls1_2. The
584 "no-ssl" option is synonymous with "no-ssl3". Note this only
585 affects version negotiation. OpenSSL will still provide the
586 methods for applications to explicitly select the individual
590 As for no-<prot> but in addition do not build the methods for
591 applications to explicitly select individual protocol
592 versions. Note that there is no "no-tls1_3-method" option
593 because there is no application method for TLSv1.3. Using
594 individual protocol methods directly is deprecated.
595 Applications should use TLS_method() instead.
598 Build with support for the specified algorithm, where <alg>
599 is one of: md2 or rc5.
602 Build without support for the specified algorithm, where
603 <alg> is one of: aria, bf, blake2, camellia, cast, chacha,
604 cmac, des, dh, dsa, ecdh, ecdsa, idea, md4, mdc2, ocb,
605 poly1305, rc2, rc4, rmd160, scrypt, seed, siphash, siv, sm2,
606 sm3, sm4 or whirlpool. The "ripemd" algorithm is deprecated
607 and if used is synonymous with rmd160.
609 -Dxxx, -Ixxx, -Wp, -lxxx, -Lxxx, -Wl, -rpath, -R, -framework, -static
610 These system specific options will be recognised and
611 passed through to the compiler to allow you to define
612 preprocessor symbols, specify additional libraries, library
613 directories or other compiler options. It might be worth
614 noting that some compilers generate code specifically for
615 processor the compiler currently executes on. This is not
616 necessarily what you might have in mind, since it might be
617 unsuitable for execution on other, typically older,
618 processor. Consult your compiler documentation.
620 Take note of the VAR=value documentation below and how
621 these flags interact with those variables.
624 Additional options that are not otherwise recognised are
625 passed through as they are to the compiler as well. Again,
626 consult your compiler documentation.
628 Take note of the VAR=value documentation below and how
629 these flags interact with those variables.
632 Assignment of environment variable for Configure. These
633 work just like normal environment variable assignments,
634 but are supported on all platforms and are confined to
635 the configuration scripts only. These assignments override
636 the corresponding value in the inherited environment, if
639 The following variables are used as "make variables" and
640 can be used as an alternative to giving preprocessor,
641 compiler and linker options directly as configuration.
642 The following variables are supported:
644 AR The static library archiver.
645 ARFLAGS Flags for the static library archiver.
646 AS The assembler compiler.
647 ASFLAGS Flags for the assembler compiler.
649 CFLAGS Flags for the C compiler.
650 CXX The C++ compiler.
651 CXXFLAGS Flags for the C++ compiler.
652 CPP The C/C++ preprocessor.
653 CPPFLAGS Flags for the C/C++ preprocessor.
654 CPPDEFINES List of CPP macro definitions, separated
655 by a platform specific character (':' or
656 space for Unix, ';' for Windows, ',' for
657 VMS). This can be used instead of using
658 -D (or what corresponds to that on your
659 compiler) in CPPFLAGS.
660 CPPINCLUDES List of CPP inclusion directories, separated
661 the same way as for CPPDEFINES. This can
662 be used instead of -I (or what corresponds
663 to that on your compiler) in CPPFLAGS.
664 HASHBANGPERL Perl invocation to be inserted after '#!'
665 in public perl scripts (only relevant on
667 LD The program linker (not used on Unix, $(CC)
669 LDFLAGS Flags for the shared library, DSO and
671 LDLIBS Extra libraries to use when linking.
672 Takes the form of a space separated list
673 of library specifications on Unix and
674 Windows, and as a comma separated list of
676 RANLIB The library archive indexer.
677 RC The Windows resource compiler.
678 RCFLAGS Flags for the Windows resource compiler.
679 RM The command to remove files and directories.
681 These cannot be mixed with compiling / linking flags given
682 on the command line. In other words, something like this
685 ./config -DFOO CPPFLAGS=-DBAR -DCOOKIE
687 Backward compatibility note:
689 To be compatible with older configuration scripts, the
690 environment variables are ignored if compiling / linking
691 flags are given on the command line, except for these:
693 AR, CC, CXX, CROSS_COMPILE, HASHBANGPERL, PERL, RANLIB, RC
696 For example, the following command will not see -DBAR:
698 CPPFLAGS=-DBAR ./config -DCOOKIE
700 However, the following will see both set variables:
702 CC=gcc CROSS_COMPILE=x86_64-w64-mingw32- \
705 If CC is set, it is advisable to also set CXX to ensure
706 both C and C++ compilers are in the same "family". This
707 becomes relevant with 'enable-external-tests' and
708 'enable-buildtest-c++'.
712 Reconfigure from earlier data. This fetches the previous
713 command line options and environment from data saved in
714 "configdata.pm", and runs the configuration process again,
715 using these options and environment.
716 Note: NO other option is permitted together with "reconf".
717 This means that you also MUST use "./Configure" (or
718 what corresponds to that on non-Unix platforms) directly
719 to invoke this option.
720 Note: The original configuration saves away values for ALL
721 environment variables that were used, and if they weren't
722 defined, they are still saved away with information that
723 they weren't originally defined. This information takes
724 precedence over environment variables that are defined
727 Displaying configuration data
728 -----------------------------
730 The configuration script itself will say very little, and finishes by
731 creating "configdata.pm". This perl module can be loaded by other scripts
732 to find all the configuration data, and it can also be used as a script to
733 display all sorts of configuration data in a human readable form.
735 For more information, please do:
737 $ ./configdata.pm --help # Unix
741 $ perl configdata.pm --help # Windows and VMS
743 Installation in Detail
744 ----------------------
746 1a. Configure OpenSSL for your operation system automatically:
748 NOTE: This is not available on Windows.
750 $ ./config [[ options ]] # Unix
754 $ @config [[ options ]] ! OpenVMS
756 For the remainder of this text, the Unix form will be used in all
757 examples, please use the appropriate form for your platform.
759 This guesses at your operating system (and compiler, if necessary) and
760 configures OpenSSL based on this guess. Run ./config -t to see
761 if it guessed correctly. If you want to use a different compiler, you
762 are cross-compiling for another platform, or the ./config guess was
763 wrong for other reasons, go to step 1b. Otherwise go to step 2.
765 On some systems, you can include debugging information as follows:
767 $ ./config -d [[ options ]]
769 1b. Configure OpenSSL for your operating system manually
771 OpenSSL knows about a range of different operating system, hardware and
772 compiler combinations. To see the ones it knows about, run
778 $ perl Configure # All other platforms
780 For the remainder of this text, the Unix form will be used in all
781 examples, please use the appropriate form for your platform.
783 Pick a suitable name from the list that matches your system. For most
784 operating systems there is a choice between using "cc" or "gcc". When
785 you have identified your system (and if necessary compiler) use this name
786 as the argument to Configure. For example, a "linux-elf" user would
789 $ ./Configure linux-elf [[ options ]]
791 If your system isn't listed, you will have to create a configuration
792 file named Configurations/{{ something }}.conf and add the correct
793 configuration for your system. See the available configs as examples
794 and read Configurations/README and Configurations/README.design for
797 The generic configurations "cc" or "gcc" should usually work on 32 bit
800 Configure creates a build file ("Makefile" on Unix, "makefile" on Windows
801 and "descrip.mms" on OpenVMS) from a suitable template in Configurations,
802 and defines various macros in include/openssl/opensslconf.h (generated from
803 include/openssl/opensslconf.h.in).
805 1c. Configure OpenSSL for building outside of the source tree.
807 OpenSSL can be configured to build in a build directory separate from
808 the directory with the source code. It's done by placing yourself in
809 some other directory and invoking the configuration commands from
814 $ mkdir /var/tmp/openssl-build
815 $ cd /var/tmp/openssl-build
816 $ /PATH/TO/OPENSSL/SOURCE/config [[ options ]]
820 $ /PATH/TO/OPENSSL/SOURCE/Configure {{ target }} [[ options ]]
824 $ set default sys$login:
825 $ create/dir [.tmp.openssl-build]
826 $ set default [.tmp.openssl-build]
827 $ @[PATH.TO.OPENSSL.SOURCE]config [[ options ]]
831 $ @[PATH.TO.OPENSSL.SOURCE]Configure {{ target }} [[ options ]]
836 $ mkdir \temp-openssl
838 $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure {{ target }} [[ options ]]
840 Paths can be relative just as well as absolute. Configure will
841 do its best to translate them to relative paths whenever possible.
843 2. Build OpenSSL by running:
846 $ mms ! (or mmk) OpenVMS
849 This will build the OpenSSL libraries (libcrypto.a and libssl.a on
850 Unix, corresponding on other platforms) and the OpenSSL binary
851 ("openssl"). The libraries will be built in the top-level directory,
852 and the binary will be in the "apps" subdirectory.
856 If the build fails, look at the output. There may be reasons
857 for the failure that aren't problems in OpenSSL itself (like
858 missing standard headers).
860 If the build succeeded previously, but fails after a source or
861 configuration change, it might be helpful to clean the build tree
862 before attempting another build. Use this command:
865 $ mms clean ! (or mmk) OpenVMS
866 $ nmake clean # Windows
868 Assembler error messages can sometimes be sidestepped by using the
869 "no-asm" configuration option.
871 Compiling parts of OpenSSL with gcc and others with the system
872 compiler will result in unresolved symbols on some systems.
874 If you are still having problems you can get help by sending an email
875 to the openssl-users email list (see
876 https://www.openssl.org/community/mailinglists.html for details). If
877 it is a bug with OpenSSL itself, please open an issue on GitHub, at
878 https://github.com/openssl/openssl/issues. Please review the existing
879 ones first; maybe the bug was already reported or has already been
882 3. After a successful build, the libraries should be tested. Run:
886 $ nmake test # Windows
888 NOTE: you MUST run the tests from an unprivileged account (or
889 disable your privileges temporarily if your platform allows it).
891 If some tests fail, look at the output. There may be reasons for
892 the failure that isn't a problem in OpenSSL itself (like a
893 malfunction with Perl). You may want increased verbosity, that
894 can be accomplished like this:
896 $ make VERBOSE=1 test # Unix
898 $ mms /macro=(VERBOSE=1) test ! OpenVMS
900 $ nmake VERBOSE=1 test # Windows
902 If you want to run just one or a few specific tests, you can use
903 the make variable TESTS to specify them, like this:
905 $ make TESTS='test_rsa test_dsa' test # Unix
906 $ mms/macro="TESTS=test_rsa test_dsa" test ! OpenVMS
907 $ nmake TESTS='test_rsa test_dsa' test # Windows
909 And of course, you can combine (Unix example shown):
911 $ make VERBOSE=1 TESTS='test_rsa test_dsa' test
913 You can find the list of available tests like this:
915 $ make list-tests # Unix
916 $ mms list-tests ! OpenVMS
917 $ nmake list-tests # Windows
919 Have a look at the manual for the perl module Test::Harness to
920 see what other HARNESS_* variables there are.
922 If you find a problem with OpenSSL itself, try removing any
923 compiler optimization flags from the CFLAGS line in Makefile and
924 run "make clean; make" or corresponding.
926 To report a bug please open an issue on GitHub, at
927 https://github.com/openssl/openssl/issues.
929 For more details on how the make variables TESTS can be used,
930 see section TESTS in Detail below.
932 4. If everything tests ok, install OpenSSL with
934 $ make install # Unix
935 $ mms install ! OpenVMS
936 $ nmake install # Windows
938 This will install all the software components in this directory
939 tree under PREFIX (the directory given with --prefix or its
944 bin/ Contains the openssl binary and a few other
947 Contains the header files needed if you want
948 to build your own programs that use libcrypto
950 lib Contains the OpenSSL library files.
951 lib/engines Contains the OpenSSL dynamically loadable engines.
953 share/man/man1 Contains the OpenSSL command line man-pages.
954 share/man/man3 Contains the OpenSSL library calls man-pages.
955 share/man/man5 Contains the OpenSSL configuration format man-pages.
956 share/man/man7 Contains the OpenSSL other misc man-pages.
958 share/doc/openssl/html/man1
959 share/doc/openssl/html/man3
960 share/doc/openssl/html/man5
961 share/doc/openssl/html/man7
962 Contains the HTML rendition of the man-pages.
964 OpenVMS ('arch' is replaced with the architecture name, "Alpha"
965 or "ia64", 'sover' is replaced with the shared library version
966 (0101 for 1.1), and 'pz' is replaced with the pointer size
967 OpenSSL was built with):
969 [.EXE.'arch'] Contains the openssl binary.
970 [.EXE] Contains a few utility scripts.
972 Contains the header files needed if you want
973 to build your own programs that use libcrypto
975 [.LIB.'arch'] Contains the OpenSSL library files.
976 [.ENGINES'sover''pz'.'arch']
977 Contains the OpenSSL dynamically loadable engines.
978 [.SYS$STARTUP] Contains startup, login and shutdown scripts.
979 These define appropriate logical names and
981 [.SYSTEST] Contains the installation verification procedure.
982 [.HTML] Contains the HTML rendition of the manual pages.
985 Additionally, install will add the following directories under
986 OPENSSLDIR (the directory given with --openssldir or its default)
989 certs Initially empty, this is the default location
990 for certificate files.
991 private Initially empty, this is the default location
992 for private key files.
993 misc Various scripts.
995 Package builders who want to configure the library for standard
996 locations, but have the package installed somewhere else so that
997 it can easily be packaged, can use
999 $ make DESTDIR=/tmp/package-root install # Unix
1000 $ mms/macro="DESTDIR=TMP:[PACKAGE-ROOT]" install ! OpenVMS
1002 The specified destination directory will be prepended to all
1003 installation target paths.
1005 Compatibility issues with previous OpenSSL versions:
1007 * COMPILING existing applications
1009 Starting with version 1.1.0, OpenSSL hides a number of structures
1010 that were previously open. This includes all internal libssl
1011 structures and a number of EVP types. Accessor functions have
1012 been added to allow controlled access to the structures' data.
1014 This means that some software needs to be rewritten to adapt to
1015 the new ways of doing things. This often amounts to allocating
1016 an instance of a structure explicitly where you could previously
1017 allocate them on the stack as automatic variables, and using the
1018 provided accessor functions where you would previously access a
1019 structure's field directly.
1021 Some APIs have changed as well. However, older APIs have been
1022 preserved when possible.
1024 Environment Variables
1025 ---------------------
1027 A number of environment variables can be used to provide additional control
1028 over the build process. Typically these should be defined prior to running
1029 config or Configure. Not all environment variables are relevant to all
1033 The name of the ar executable to use.
1036 Use a different build file name than the platform default
1037 ("Makefile" on Unix-like platforms, "makefile" on native Windows,
1038 "descrip.mms" on OpenVMS). This requires that there is a
1039 corresponding build file template. See Configurations/README
1040 for further information.
1043 The compiler to use. Configure will attempt to pick a default
1044 compiler for your platform but this choice can be overridden
1045 using this variable. Set it to the compiler executable you wish
1046 to use, e.g. "gcc" or "clang".
1049 This environment variable has the same meaning as for the
1050 "--cross-compile-prefix" Configure flag described above. If both
1051 are set then the Configure flag takes precedence.
1054 The name of the nm executable to use.
1056 OPENSSL_LOCAL_CONFIG_DIR
1057 OpenSSL comes with a database of information about how it
1058 should be built on different platforms as well as build file
1059 templates for those platforms. The database is comprised of
1060 ".conf" files in the Configurations directory. The build
1061 file templates reside there as well as ".tmpl" files. See the
1062 file Configurations/README for further information about the
1063 format of ".conf" files as well as information on the ".tmpl"
1065 In addition to the standard ".conf" and ".tmpl" files, it is
1066 possible to create your own ".conf" and ".tmpl" files and store
1067 them locally, outside the OpenSSL source tree. This environment
1068 variable can be set to the directory where these files are held
1069 and will be considered by Configure before it looks in the
1070 standard directories.
1073 The name of the Perl executable to use when building OpenSSL.
1074 This variable is used in config script only. Configure on the
1075 other hand imposes the interpreter by which it itself was
1076 executed on the whole build procedure.
1079 The command string for the Perl executable to insert in the
1080 #! line of perl scripts that will be publically installed.
1081 Default: /usr/bin/env perl
1082 Note: the value of this variable is added to the same scripts
1083 on all platforms, but it's only relevant on Unix-like platforms.
1086 The name of the rc executable to use. The default will be as
1087 defined for the target platform in the ".conf" file. If not
1088 defined then "windres" will be used. The WINDRES environment
1089 variable is synonymous to this. If both are defined then RC
1093 The name of the ranlib executable to use.
1101 The Configure script generates a Makefile in a format relevant to the specific
1102 platform. The Makefiles provide a number of targets that can be used. Not all
1103 targets may be available on all platforms. Only the most common targets are
1104 described here. Examine the Makefiles themselves for the full list.
1107 The default target to build all the software components.
1110 Remove all build artefacts and return the directory to a "clean"
1114 Rebuild the dependencies in the Makefiles. This is a legacy
1115 option that no longer needs to be used since OpenSSL 1.1.0.
1118 Install all OpenSSL components.
1121 Only install the OpenSSL software components.
1124 Only install the OpenSSL documentation components.
1127 Only install the OpenSSL man pages (Unix only).
1130 Only install the OpenSSL html documentation.
1133 Prints a list of all the self test names.
1136 Build and run the OpenSSL self tests.
1139 Uninstall all OpenSSL components.
1143 Re-run the configuration process, as exactly as the last time
1147 This is a developer option. If you are developing a patch for
1148 OpenSSL you may need to use this if you want to update
1149 automatically generated files; add new error codes or add new
1150 (or change the visibility of) public API functions. (Unix only).
1155 The make variable TESTS supports a versatile set of space separated tokens
1156 with which you can specify a set of tests to be performed. With a "current
1157 set of tests" in mind, initially being empty, here are the possible tokens:
1159 alltests The current set of tests becomes the whole set of available
1160 tests (as listed when you do 'make list-tests' or similar).
1161 xxx Adds the test 'xxx' to the current set of tests.
1162 -xxx Removes 'xxx' from the current set of tests. If this is the
1163 first token in the list, the current set of tests is first
1164 assigned the whole set of available tests, effectively making
1165 this token equivalent to TESTS="alltests -xxx".
1166 nn Adds the test group 'nn' (which is a number) to the current
1168 -nn Removes the test group 'nn' from the current set of tests.
1169 If this is the first token in the list, the current set of
1170 tests is first assigned the whole set of available tests,
1171 effectively making this token equivalent to
1172 TESTS="alltests -xxx".
1174 Also, all tokens except for "alltests" may have wildcards, such as *.
1175 (on Unix and Windows, BSD style wildcards are supported, while on VMS,
1176 it's VMS style wildcards)
1178 Example: All tests except for the fuzz tests:
1180 $ make TESTS=-test_fuzz test
1182 or (if you want to be explicit)
1184 $ make TESTS='alltests -test_fuzz' test
1186 Example: All tests that have a name starting with "test_ssl" but not those
1187 starting with "test_ssl_":
1189 $ make TESTS='test_ssl* -test_ssl_*' test
1191 Example: Only test group 10:
1195 Example: All tests except the slow group (group 99):
1199 Example: All tests in test groups 80 to 99 except for tests in group 90:
1201 $ make TESTS='[89]? -90'
1203 Note on multi-threading
1204 -----------------------
1206 For some systems, the OpenSSL Configure script knows what compiler options
1207 are needed to generate a library that is suitable for multi-threaded
1208 applications. On these systems, support for multi-threading is enabled
1209 by default; use the "no-threads" option to disable (this should never be
1212 On other systems, to enable support for multi-threading, you will have
1213 to specify at least two options: "threads", and a system-dependent option.
1214 (The latter is "-D_REENTRANT" on various systems.) The default in this
1215 case, obviously, is not to include support for multi-threading (but
1216 you can still use "no-threads" to suppress an annoying warning message
1217 from the Configure script.)
1219 OpenSSL provides built-in support for two threading models: pthreads (found on
1220 most UNIX/Linux systems), and Windows threads. No other threading models are
1221 supported. If your platform does not provide pthreads or Windows threads then
1222 you should Configure with the "no-threads" option.
1224 Notes on shared libraries
1225 -------------------------
1227 For most systems the OpenSSL Configure script knows what is needed to
1228 build shared libraries for libcrypto and libssl. On these systems
1229 the shared libraries will be created by default. This can be suppressed and
1230 only static libraries created by using the "no-shared" option. On systems
1231 where OpenSSL does not know how to build shared libraries the "no-shared"
1232 option will be forced and only static libraries will be created.
1234 Shared libraries are named a little differently on different platforms.
1235 One way or another, they all have the major OpenSSL version number as
1236 part of the file name, i.e. for OpenSSL 1.1.x, 1.1 is somehow part of
1239 On most POSIX platforms, shared libraries are named libcrypto.so.1.1
1242 on Cygwin, shared libraries are named cygcrypto-1.1.dll and cygssl-1.1.dll
1243 with import libraries libcrypto.dll.a and libssl.dll.a.
1245 On Windows build with MSVC or using MingW, shared libraries are named
1246 libcrypto-1_1.dll and libssl-1_1.dll for 32-bit Windows, libcrypto-1_1-x64.dll
1247 and libssl-1_1-x64.dll for 64-bit x86_64 Windows, and libcrypto-1_1-ia64.dll
1248 and libssl-1_1-ia64.dll for IA64 Windows. With MSVC, the import libraries
1249 are named libcrypto.lib and libssl.lib, while with MingW, they are named
1250 libcrypto.dll.a and libssl.dll.a.
1252 On VMS, shareable images (VMS speak for shared libraries) are named
1253 ossl$libcrypto0101_shr.exe and ossl$libssl0101_shr.exe. However, when
1254 OpenSSL is specifically built for 32-bit pointers, the shareable images
1255 are named ossl$libcrypto0101_shr32.exe and ossl$libssl0101_shr32.exe
1256 instead, and when built for 64-bit pointers, they are named
1257 ossl$libcrypto0101_shr64.exe and ossl$libssl0101_shr64.exe.
1259 Note on random number generation
1260 --------------------------------
1262 Availability of cryptographically secure random numbers is required for
1263 secret key generation. OpenSSL provides several options to seed the
1264 internal CSPRNG. If not properly seeded, the internal CSPRNG will refuse
1265 to deliver random bytes and a "PRNG not seeded error" will occur.
1267 The seeding method can be configured using the --with-rand-seed option,
1268 which can be used to specify a comma separated list of seed methods.
1269 However in most cases OpenSSL will choose a suitable default method,
1270 so it is not necessary to explicitly provide this option. Note also
1271 that not all methods are available on all platforms.
1273 I) On operating systems which provide a suitable randomness source (in
1274 form of a system call or system device), OpenSSL will use the optimal
1275 available method to seed the CSPRNG from the operating system's
1276 randomness sources. This corresponds to the option --with-rand-seed=os.
1278 II) On systems without such a suitable randomness source, automatic seeding
1279 and reseeding is disabled (--with-rand-seed=none) and it may be necessary
1280 to install additional support software to obtain a random seed and reseed
1281 the CSPRNG manually. Please check out the manual pages for RAND_add(),
1282 RAND_bytes(), RAND_egd(), and the FAQ for more information.
projects / openssl.git / blob