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 CMP features
321 Don't build support for CMS features
324 Don't build support for SSL/TLS compression. If this option
325 is left enabled (the default), then compression will only
326 work if the zlib or zlib-dynamic options are also chosen.
329 Build support for debugging memory allocated via
330 OPENSSL_malloc() or OPENSSL_zalloc().
332 enable-crypto-mdebug-backtrace
333 As for crypto-mdebug, but additionally provide backtrace
334 information for allocated memory.
335 TO BE USED WITH CARE: this uses GNU C functionality, and
336 is therefore not usable for non-GNU config targets. If
337 your build complains about the use of '-rdynamic' or the
338 lack of header file execinfo.h, this option is not for you.
339 ALSO NOTE that even though execinfo.h is available on your
340 system (through Gnulib), the functions might just be stubs
344 Don't build support for Certificate Transparency.
347 Don't build with support for any deprecated APIs. This is the
348 same as using "--api" and supplying the latest version
352 Don't build support for datagram based BIOs. Selecting this
353 option will also force the disabling of DTLS.
356 Build the /dev/crypto engine. It is automatically selected
357 on BSD implementations, in which case it can be disabled with
361 Don't build the dynamically loaded engines. This only has an
362 effect in a "shared" build
365 Don't build support for Elliptic Curves.
368 Don't build support for binary Elliptic Curves
370 enable-ec_nistp_64_gcc_128
371 Enable support for optimised implementations of some commonly
372 used NIST elliptic curves.
373 This is only supported on platforms:
374 - with little-endian storage of non-byte types
375 - that tolerate misaligned memory references
376 - where the compiler:
377 - supports the non-standard type __uint128_t
378 - defines the built-in macro __SIZEOF_INT128__
381 Build support for gathering entropy from EGD (Entropy
385 Don't build support for loading engines.
388 Don't compile in any error strings.
390 enable-external-tests
391 Enable building of integration with external test suites.
392 This is a developer option and may not work on all platforms.
393 The only supported external test suite at the current time is
394 the BoringSSL test suite. See the file test/README.external
398 Don't compile in filename and line number information (e.g.
399 for errors and memory allocation).
402 Don't compile the FIPS module
404 enable-fuzz-libfuzzer, enable-fuzz-afl
405 Build with support for fuzzing using either libfuzzer or AFL.
406 These are developer options only. They may not work on all
407 platforms and should never be used in production environments.
408 See the file fuzz/README.md for further details.
411 Don't build support for GOST based ciphersuites. Note that
412 if this feature is enabled then GOST ciphersuites are only
413 available if the GOST algorithms are also available through
414 loading an externally supplied engine.
417 Don't build the legacy provider. Disabling this also disables
418 the legacy algorithms: MD2 (already disabled by default).
421 Don't generate dependencies.
424 Don't build any dynamically loadable engines. This also
425 implies 'no-dynamic-engine'.
428 Don't build support for writing multiple records in one
429 go in libssl (Note: this is a different capability to the
430 pipelining functionality).
433 Don't build support for the NPN TLS extension.
436 Don't build support for OCSP.
440 Don't build the padlock engine.
441 ('no-hw-padlock' is deprecated and should not be used)
444 Don't build with support for Position Independent Code.
446 no-pinshared By default OpenSSL will attempt to stay in memory until the
447 process exits. This is so that libcrypto and libssl can be
448 properly cleaned up automatically via an "atexit()" handler.
449 The handler is registered by libcrypto and cleans up both
450 libraries. On some platforms the atexit() handler will run on
451 unload of libcrypto (if it has been dynamically loaded)
452 rather than at process exit. This option can be used to stop
453 OpenSSL from attempting to stay in memory until the process
454 exits. This could lead to crashes if either libcrypto or
455 libssl have already been unloaded at the point
456 that the atexit handler is invoked, e.g. on a platform which
457 calls atexit() on unload of the library, and libssl is
458 unloaded before libcrypto then a crash is likely to happen.
459 Applications can suppress running of the atexit() handler at
460 run time by using the OPENSSL_INIT_NO_ATEXIT option to
461 OPENSSL_init_crypto(). See the man page for it for further
465 Don't use POSIX IO capabilities.
468 Don't build support for Pre-Shared Key based ciphersuites.
471 Don't use hardware RDRAND capabilities.
474 Don't build support for RFC3779 ("X.509 Extensions for IP
475 Addresses and AS Identifiers")
478 Build support for SCTP
481 Do not create shared libraries, only static ones. See "Note
482 on shared libraries" below.
485 Don't build support for socket BIOs
488 Don't build support for SRP or SRP based ciphersuites.
491 Don't build SRTP support
494 Exclude SSE2 code paths from 32-bit x86 assembly modules.
495 Normally SSE2 extension is detected at run-time, but the
496 decision whether or not the machine code will be executed
497 is taken solely on CPU capability vector. This means that
498 if you happen to run OS kernel which does not support SSE2
499 extension on Intel P4 processor, then your application
500 might be exposed to "illegal instruction" exception.
501 There might be a way to enable support in kernel, e.g.
502 FreeBSD kernel can be compiled with CPU_ENABLE_SSE, and
503 there is a way to disengage SSE2 code paths upon application
504 start-up, but if you aim for wider "audience" running
505 such kernel, consider no-sse2. Both the 386 and
506 no-asm options imply no-sse2.
509 Build with the SSL Trace capabilities (adds the "-trace"
510 option to s_client and s_server).
513 Don't build the statically linked engines. This only
514 has an impact when not built "shared".
517 Don't use anything from the C header file "stdio.h" that
518 makes use of the "FILE" type. Only libcrypto and libssl can
519 be built in this way. Using this option will suppress
520 building the command line applications. Additionally since
521 the OpenSSL tests also use the command line applications the
522 tests will also be skipped.
525 Don't build test programs or run any test.
528 Don't try to build with support for multi-threaded
532 Build with support for multi-threaded applications. Most
533 platforms will enable this by default. However if on a
534 platform where this is not the case then this will usually
535 require additional system-dependent options! See "Note on
536 multi-threading" below.
539 Build with support for the integrated tracing api. See manual pages
540 OSSL_trace_set_channel(3) and OSSL_trace_enabled(3) for details.
543 Don't build Time Stamping Authority support.
546 Build with the Undefined Behaviour sanitiser. This is a
547 developer option only. It may not work on all platforms and
548 should never be used in production environments. It will only
549 work when used with gcc or clang and should be used in
550 conjunction with the "-DPEDANTIC" option (or the
551 --strict-warnings option).
554 Don't build with the "UI" capability (i.e. the set of
555 features enabling text based prompts).
558 Enable additional unit test APIs. This should not typically
559 be used in production deployments.
562 Don't build support for UPLINK interface.
564 enable-weak-ssl-ciphers
565 Build support for SSL/TLS ciphers that are considered "weak"
566 (e.g. RC4 based ciphersuites).
569 Build with support for zlib compression/decompression.
572 Like "zlib", but has OpenSSL load the zlib library
573 dynamically when needed. This is only supported on systems
574 where loading of shared libraries is supported.
577 In 32-bit x86 builds, when generating assembly modules,
578 use the 80386 instruction set only (the default x86 code
579 is more efficient, but requires at least a 486). Note:
580 This doesn't affect code generated by compiler, you're
581 likely to complement configuration command line with
582 suitable compiler-specific option.
585 Don't build support for negotiating the specified SSL/TLS
586 protocol (one of ssl, ssl3, tls, tls1, tls1_1, tls1_2,
587 tls1_3, dtls, dtls1 or dtls1_2). If "no-tls" is selected then
588 all of tls1, tls1_1, tls1_2 and tls1_3 are disabled.
589 Similarly "no-dtls" will disable dtls1 and dtls1_2. The
590 "no-ssl" option is synonymous with "no-ssl3". Note this only
591 affects version negotiation. OpenSSL will still provide the
592 methods for applications to explicitly select the individual
596 As for no-<prot> but in addition do not build the methods for
597 applications to explicitly select individual protocol
598 versions. Note that there is no "no-tls1_3-method" option
599 because there is no application method for TLSv1.3. Using
600 individual protocol methods directly is deprecated.
601 Applications should use TLS_method() instead.
604 Build with support for the specified algorithm, where <alg>
605 is one of: md2 or rc5.
608 Build without support for the specified algorithm, where
609 <alg> is one of: aria, bf, blake2, camellia, cast, chacha,
610 cmac, des, dh, dsa, ecdh, ecdsa, idea, md4, mdc2, ocb,
611 poly1305, rc2, rc4, rmd160, scrypt, seed, siphash, siv, sm2,
612 sm3, sm4 or whirlpool. The "ripemd" algorithm is deprecated
613 and if used is synonymous with rmd160.
615 -Dxxx, -Ixxx, -Wp, -lxxx, -Lxxx, -Wl, -rpath, -R, -framework, -static
616 These system specific options will be recognised and
617 passed through to the compiler to allow you to define
618 preprocessor symbols, specify additional libraries, library
619 directories or other compiler options. It might be worth
620 noting that some compilers generate code specifically for
621 processor the compiler currently executes on. This is not
622 necessarily what you might have in mind, since it might be
623 unsuitable for execution on other, typically older,
624 processor. Consult your compiler documentation.
626 Take note of the VAR=value documentation below and how
627 these flags interact with those variables.
630 Additional options that are not otherwise recognised are
631 passed through as they are to the compiler as well. Again,
632 consult your compiler documentation.
634 Take note of the VAR=value documentation below and how
635 these flags interact with those variables.
638 Assignment of environment variable for Configure. These
639 work just like normal environment variable assignments,
640 but are supported on all platforms and are confined to
641 the configuration scripts only. These assignments override
642 the corresponding value in the inherited environment, if
645 The following variables are used as "make variables" and
646 can be used as an alternative to giving preprocessor,
647 compiler and linker options directly as configuration.
648 The following variables are supported:
650 AR The static library archiver.
651 ARFLAGS Flags for the static library archiver.
652 AS The assembler compiler.
653 ASFLAGS Flags for the assembler compiler.
655 CFLAGS Flags for the C compiler.
656 CXX The C++ compiler.
657 CXXFLAGS Flags for the C++ compiler.
658 CPP The C/C++ preprocessor.
659 CPPFLAGS Flags for the C/C++ preprocessor.
660 CPPDEFINES List of CPP macro definitions, separated
661 by a platform specific character (':' or
662 space for Unix, ';' for Windows, ',' for
663 VMS). This can be used instead of using
664 -D (or what corresponds to that on your
665 compiler) in CPPFLAGS.
666 CPPINCLUDES List of CPP inclusion directories, separated
667 the same way as for CPPDEFINES. This can
668 be used instead of -I (or what corresponds
669 to that on your compiler) in CPPFLAGS.
670 HASHBANGPERL Perl invocation to be inserted after '#!'
671 in public perl scripts (only relevant on
673 LD The program linker (not used on Unix, $(CC)
675 LDFLAGS Flags for the shared library, DSO and
677 LDLIBS Extra libraries to use when linking.
678 Takes the form of a space separated list
679 of library specifications on Unix and
680 Windows, and as a comma separated list of
682 RANLIB The library archive indexer.
683 RC The Windows resource compiler.
684 RCFLAGS Flags for the Windows resource compiler.
685 RM The command to remove files and directories.
687 These cannot be mixed with compiling / linking flags given
688 on the command line. In other words, something like this
691 ./config -DFOO CPPFLAGS=-DBAR -DCOOKIE
693 Backward compatibility note:
695 To be compatible with older configuration scripts, the
696 environment variables are ignored if compiling / linking
697 flags are given on the command line, except for these:
699 AR, CC, CXX, CROSS_COMPILE, HASHBANGPERL, PERL, RANLIB, RC
702 For example, the following command will not see -DBAR:
704 CPPFLAGS=-DBAR ./config -DCOOKIE
706 However, the following will see both set variables:
708 CC=gcc CROSS_COMPILE=x86_64-w64-mingw32- \
711 If CC is set, it is advisable to also set CXX to ensure
712 both C and C++ compilers are in the same "family". This
713 becomes relevant with 'enable-external-tests' and
714 'enable-buildtest-c++'.
718 Reconfigure from earlier data. This fetches the previous
719 command line options and environment from data saved in
720 "configdata.pm", and runs the configuration process again,
721 using these options and environment.
722 Note: NO other option is permitted together with "reconf".
723 This means that you also MUST use "./Configure" (or
724 what corresponds to that on non-Unix platforms) directly
725 to invoke this option.
726 Note: The original configuration saves away values for ALL
727 environment variables that were used, and if they weren't
728 defined, they are still saved away with information that
729 they weren't originally defined. This information takes
730 precedence over environment variables that are defined
733 Displaying configuration data
734 -----------------------------
736 The configuration script itself will say very little, and finishes by
737 creating "configdata.pm". This perl module can be loaded by other scripts
738 to find all the configuration data, and it can also be used as a script to
739 display all sorts of configuration data in a human readable form.
741 For more information, please do:
743 $ ./configdata.pm --help # Unix
747 $ perl configdata.pm --help # Windows and VMS
749 Installation in Detail
750 ----------------------
752 1a. Configure OpenSSL for your operation system automatically:
754 NOTE: This is not available on Windows.
756 $ ./config [[ options ]] # Unix
760 $ @config [[ options ]] ! OpenVMS
762 For the remainder of this text, the Unix form will be used in all
763 examples, please use the appropriate form for your platform.
765 This guesses at your operating system (and compiler, if necessary) and
766 configures OpenSSL based on this guess. Run ./config -t to see
767 if it guessed correctly. If you want to use a different compiler, you
768 are cross-compiling for another platform, or the ./config guess was
769 wrong for other reasons, go to step 1b. Otherwise go to step 2.
771 On some systems, you can include debugging information as follows:
773 $ ./config -d [[ options ]]
775 1b. Configure OpenSSL for your operating system manually
777 OpenSSL knows about a range of different operating system, hardware and
778 compiler combinations. To see the ones it knows about, run
784 $ perl Configure # All other platforms
786 For the remainder of this text, the Unix form will be used in all
787 examples, please use the appropriate form for your platform.
789 Pick a suitable name from the list that matches your system. For most
790 operating systems there is a choice between using "cc" or "gcc". When
791 you have identified your system (and if necessary compiler) use this name
792 as the argument to Configure. For example, a "linux-elf" user would
795 $ ./Configure linux-elf [[ options ]]
797 If your system isn't listed, you will have to create a configuration
798 file named Configurations/{{ something }}.conf and add the correct
799 configuration for your system. See the available configs as examples
800 and read Configurations/README and Configurations/README.design for
803 The generic configurations "cc" or "gcc" should usually work on 32 bit
806 Configure creates a build file ("Makefile" on Unix, "makefile" on Windows
807 and "descrip.mms" on OpenVMS) from a suitable template in Configurations,
808 and defines various macros in include/openssl/opensslconf.h (generated from
809 include/openssl/opensslconf.h.in).
811 1c. Configure OpenSSL for building outside of the source tree.
813 OpenSSL can be configured to build in a build directory separate from
814 the directory with the source code. It's done by placing yourself in
815 some other directory and invoking the configuration commands from
820 $ mkdir /var/tmp/openssl-build
821 $ cd /var/tmp/openssl-build
822 $ /PATH/TO/OPENSSL/SOURCE/config [[ options ]]
826 $ /PATH/TO/OPENSSL/SOURCE/Configure {{ target }} [[ options ]]
830 $ set default sys$login:
831 $ create/dir [.tmp.openssl-build]
832 $ set default [.tmp.openssl-build]
833 $ @[PATH.TO.OPENSSL.SOURCE]config [[ options ]]
837 $ @[PATH.TO.OPENSSL.SOURCE]Configure {{ target }} [[ options ]]
842 $ mkdir \temp-openssl
844 $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure {{ target }} [[ options ]]
846 Paths can be relative just as well as absolute. Configure will
847 do its best to translate them to relative paths whenever possible.
849 2. Build OpenSSL by running:
852 $ mms ! (or mmk) OpenVMS
855 This will build the OpenSSL libraries (libcrypto.a and libssl.a on
856 Unix, corresponding on other platforms) and the OpenSSL binary
857 ("openssl"). The libraries will be built in the top-level directory,
858 and the binary will be in the "apps" subdirectory.
862 If the build fails, look at the output. There may be reasons
863 for the failure that aren't problems in OpenSSL itself (like
864 missing standard headers).
866 If the build succeeded previously, but fails after a source or
867 configuration change, it might be helpful to clean the build tree
868 before attempting another build. Use this command:
871 $ mms clean ! (or mmk) OpenVMS
872 $ nmake clean # Windows
874 Assembler error messages can sometimes be sidestepped by using the
875 "no-asm" configuration option.
877 Compiling parts of OpenSSL with gcc and others with the system
878 compiler will result in unresolved symbols on some systems.
880 If you are still having problems you can get help by sending an email
881 to the openssl-users email list (see
882 https://www.openssl.org/community/mailinglists.html for details). If
883 it is a bug with OpenSSL itself, please open an issue on GitHub, at
884 https://github.com/openssl/openssl/issues. Please review the existing
885 ones first; maybe the bug was already reported or has already been
888 3. After a successful build, the libraries should be tested. Run:
892 $ nmake test # Windows
894 NOTE: you MUST run the tests from an unprivileged account (or
895 disable your privileges temporarily if your platform allows it).
897 If some tests fail, look at the output. There may be reasons for
898 the failure that isn't a problem in OpenSSL itself (like a
899 malfunction with Perl). You may want increased verbosity, that
900 can be accomplished like this:
902 $ make VERBOSE=1 test # Unix
904 $ mms /macro=(VERBOSE=1) test ! OpenVMS
906 $ nmake VERBOSE=1 test # Windows
908 If you want to run just one or a few specific tests, you can use
909 the make variable TESTS to specify them, like this:
911 $ make TESTS='test_rsa test_dsa' test # Unix
912 $ mms/macro="TESTS=test_rsa test_dsa" test ! OpenVMS
913 $ nmake TESTS='test_rsa test_dsa' test # Windows
915 And of course, you can combine (Unix example shown):
917 $ make VERBOSE=1 TESTS='test_rsa test_dsa' test
919 You can find the list of available tests like this:
921 $ make list-tests # Unix
922 $ mms list-tests ! OpenVMS
923 $ nmake list-tests # Windows
925 Have a look at the manual for the perl module Test::Harness to
926 see what other HARNESS_* variables there are.
928 If you find a problem with OpenSSL itself, try removing any
929 compiler optimization flags from the CFLAGS line in Makefile and
930 run "make clean; make" or corresponding.
932 To report a bug please open an issue on GitHub, at
933 https://github.com/openssl/openssl/issues.
935 For more details on how the make variables TESTS can be used,
936 see section TESTS in Detail below.
938 4. If everything tests ok, install OpenSSL with
940 $ make install # Unix
941 $ mms install ! OpenVMS
942 $ nmake install # Windows
944 This will install all the software components in this directory
945 tree under PREFIX (the directory given with --prefix or its
950 bin/ Contains the openssl binary and a few other
953 Contains the header files needed if you want
954 to build your own programs that use libcrypto
956 lib Contains the OpenSSL library files.
957 lib/engines Contains the OpenSSL dynamically loadable engines.
959 share/man/man1 Contains the OpenSSL command line man-pages.
960 share/man/man3 Contains the OpenSSL library calls man-pages.
961 share/man/man5 Contains the OpenSSL configuration format man-pages.
962 share/man/man7 Contains the OpenSSL other misc man-pages.
964 share/doc/openssl/html/man1
965 share/doc/openssl/html/man3
966 share/doc/openssl/html/man5
967 share/doc/openssl/html/man7
968 Contains the HTML rendition of the man-pages.
970 OpenVMS ('arch' is replaced with the architecture name, "Alpha"
971 or "ia64", 'sover' is replaced with the shared library version
972 (0101 for 1.1), and 'pz' is replaced with the pointer size
973 OpenSSL was built with):
975 [.EXE.'arch'] Contains the openssl binary.
976 [.EXE] Contains a few utility scripts.
978 Contains the header files needed if you want
979 to build your own programs that use libcrypto
981 [.LIB.'arch'] Contains the OpenSSL library files.
982 [.ENGINES'sover''pz'.'arch']
983 Contains the OpenSSL dynamically loadable engines.
984 [.SYS$STARTUP] Contains startup, login and shutdown scripts.
985 These define appropriate logical names and
987 [.SYSTEST] Contains the installation verification procedure.
988 [.HTML] Contains the HTML rendition of the manual pages.
991 Additionally, install will add the following directories under
992 OPENSSLDIR (the directory given with --openssldir or its default)
995 certs Initially empty, this is the default location
996 for certificate files.
997 private Initially empty, this is the default location
998 for private key files.
999 misc Various scripts.
1001 Package builders who want to configure the library for standard
1002 locations, but have the package installed somewhere else so that
1003 it can easily be packaged, can use
1005 $ make DESTDIR=/tmp/package-root install # Unix
1006 $ mms/macro="DESTDIR=TMP:[PACKAGE-ROOT]" install ! OpenVMS
1008 The specified destination directory will be prepended to all
1009 installation target paths.
1011 Compatibility issues with previous OpenSSL versions:
1013 * COMPILING existing applications
1015 Starting with version 1.1.0, OpenSSL hides a number of structures
1016 that were previously open. This includes all internal libssl
1017 structures and a number of EVP types. Accessor functions have
1018 been added to allow controlled access to the structures' data.
1020 This means that some software needs to be rewritten to adapt to
1021 the new ways of doing things. This often amounts to allocating
1022 an instance of a structure explicitly where you could previously
1023 allocate them on the stack as automatic variables, and using the
1024 provided accessor functions where you would previously access a
1025 structure's field directly.
1027 Some APIs have changed as well. However, older APIs have been
1028 preserved when possible.
1030 Environment Variables
1031 ---------------------
1033 A number of environment variables can be used to provide additional control
1034 over the build process. Typically these should be defined prior to running
1035 config or Configure. Not all environment variables are relevant to all
1039 The name of the ar executable to use.
1042 Use a different build file name than the platform default
1043 ("Makefile" on Unix-like platforms, "makefile" on native Windows,
1044 "descrip.mms" on OpenVMS). This requires that there is a
1045 corresponding build file template. See Configurations/README
1046 for further information.
1049 The compiler to use. Configure will attempt to pick a default
1050 compiler for your platform but this choice can be overridden
1051 using this variable. Set it to the compiler executable you wish
1052 to use, e.g. "gcc" or "clang".
1055 This environment variable has the same meaning as for the
1056 "--cross-compile-prefix" Configure flag described above. If both
1057 are set then the Configure flag takes precedence.
1060 The name of the nm executable to use.
1062 OPENSSL_LOCAL_CONFIG_DIR
1063 OpenSSL comes with a database of information about how it
1064 should be built on different platforms as well as build file
1065 templates for those platforms. The database is comprised of
1066 ".conf" files in the Configurations directory. The build
1067 file templates reside there as well as ".tmpl" files. See the
1068 file Configurations/README for further information about the
1069 format of ".conf" files as well as information on the ".tmpl"
1071 In addition to the standard ".conf" and ".tmpl" files, it is
1072 possible to create your own ".conf" and ".tmpl" files and store
1073 them locally, outside the OpenSSL source tree. This environment
1074 variable can be set to the directory where these files are held
1075 and will be considered by Configure before it looks in the
1076 standard directories.
1079 The name of the Perl executable to use when building OpenSSL.
1080 This variable is used in config script only. Configure on the
1081 other hand imposes the interpreter by which it itself was
1082 executed on the whole build procedure.
1085 The command string for the Perl executable to insert in the
1086 #! line of perl scripts that will be publically installed.
1087 Default: /usr/bin/env perl
1088 Note: the value of this variable is added to the same scripts
1089 on all platforms, but it's only relevant on Unix-like platforms.
1092 The name of the rc executable to use. The default will be as
1093 defined for the target platform in the ".conf" file. If not
1094 defined then "windres" will be used. The WINDRES environment
1095 variable is synonymous to this. If both are defined then RC
1099 The name of the ranlib executable to use.
1107 The Configure script generates a Makefile in a format relevant to the specific
1108 platform. The Makefiles provide a number of targets that can be used. Not all
1109 targets may be available on all platforms. Only the most common targets are
1110 described here. Examine the Makefiles themselves for the full list.
1113 The default target to build all the software components.
1116 Remove all build artefacts and return the directory to a "clean"
1120 Rebuild the dependencies in the Makefiles. This is a legacy
1121 option that no longer needs to be used since OpenSSL 1.1.0.
1124 Install all OpenSSL components.
1127 Only install the OpenSSL software components.
1130 Only install the OpenSSL documentation components.
1133 Only install the OpenSSL man pages (Unix only).
1136 Only install the OpenSSL html documentation.
1139 Prints a list of all the self test names.
1142 Build and run the OpenSSL self tests.
1145 Uninstall all OpenSSL components.
1149 Re-run the configuration process, as exactly as the last time
1153 This is a developer option. If you are developing a patch for
1154 OpenSSL you may need to use this if you want to update
1155 automatically generated files; add new error codes or add new
1156 (or change the visibility of) public API functions. (Unix only).
1161 The make variable TESTS supports a versatile set of space separated tokens
1162 with which you can specify a set of tests to be performed. With a "current
1163 set of tests" in mind, initially being empty, here are the possible tokens:
1165 alltests The current set of tests becomes the whole set of available
1166 tests (as listed when you do 'make list-tests' or similar).
1167 xxx Adds the test 'xxx' to the current set of tests.
1168 -xxx Removes 'xxx' from the current set of tests. If this is the
1169 first token in the list, the current set of tests is first
1170 assigned the whole set of available tests, effectively making
1171 this token equivalent to TESTS="alltests -xxx".
1172 nn Adds the test group 'nn' (which is a number) to the current
1174 -nn Removes the test group 'nn' from the current set of tests.
1175 If this is the first token in the list, the current set of
1176 tests is first assigned the whole set of available tests,
1177 effectively making this token equivalent to
1178 TESTS="alltests -xxx".
1180 Also, all tokens except for "alltests" may have wildcards, such as *.
1181 (on Unix and Windows, BSD style wildcards are supported, while on VMS,
1182 it's VMS style wildcards)
1184 Example: All tests except for the fuzz tests:
1186 $ make TESTS=-test_fuzz test
1188 or (if you want to be explicit)
1190 $ make TESTS='alltests -test_fuzz' test
1192 Example: All tests that have a name starting with "test_ssl" but not those
1193 starting with "test_ssl_":
1195 $ make TESTS='test_ssl* -test_ssl_*' test
1197 Example: Only test group 10:
1201 Example: All tests except the slow group (group 99):
1205 Example: All tests in test groups 80 to 99 except for tests in group 90:
1207 $ make TESTS='[89]? -90'
1209 To stochastically verify that the algorithm that produces uniformly distributed
1210 random numbers is operating correctly (with a false positive rate of 0.01%):
1212 $ ./util/shlib_wrap.sh test/bntest -stochastic
1214 Note on multi-threading
1215 -----------------------
1217 For some systems, the OpenSSL Configure script knows what compiler options
1218 are needed to generate a library that is suitable for multi-threaded
1219 applications. On these systems, support for multi-threading is enabled
1220 by default; use the "no-threads" option to disable (this should never be
1223 On other systems, to enable support for multi-threading, you will have
1224 to specify at least two options: "threads", and a system-dependent option.
1225 (The latter is "-D_REENTRANT" on various systems.) The default in this
1226 case, obviously, is not to include support for multi-threading (but
1227 you can still use "no-threads" to suppress an annoying warning message
1228 from the Configure script.)
1230 OpenSSL provides built-in support for two threading models: pthreads (found on
1231 most UNIX/Linux systems), and Windows threads. No other threading models are
1232 supported. If your platform does not provide pthreads or Windows threads then
1233 you should Configure with the "no-threads" option.
1235 Notes on shared libraries
1236 -------------------------
1238 For most systems the OpenSSL Configure script knows what is needed to
1239 build shared libraries for libcrypto and libssl. On these systems
1240 the shared libraries will be created by default. This can be suppressed and
1241 only static libraries created by using the "no-shared" option. On systems
1242 where OpenSSL does not know how to build shared libraries the "no-shared"
1243 option will be forced and only static libraries will be created.
1245 Shared libraries are named a little differently on different platforms.
1246 One way or another, they all have the major OpenSSL version number as
1247 part of the file name, i.e. for OpenSSL 1.1.x, 1.1 is somehow part of
1250 On most POSIX platforms, shared libraries are named libcrypto.so.1.1
1253 on Cygwin, shared libraries are named cygcrypto-1.1.dll and cygssl-1.1.dll
1254 with import libraries libcrypto.dll.a and libssl.dll.a.
1256 On Windows build with MSVC or using MingW, shared libraries are named
1257 libcrypto-1_1.dll and libssl-1_1.dll for 32-bit Windows, libcrypto-1_1-x64.dll
1258 and libssl-1_1-x64.dll for 64-bit x86_64 Windows, and libcrypto-1_1-ia64.dll
1259 and libssl-1_1-ia64.dll for IA64 Windows. With MSVC, the import libraries
1260 are named libcrypto.lib and libssl.lib, while with MingW, they are named
1261 libcrypto.dll.a and libssl.dll.a.
1263 On VMS, shareable images (VMS speak for shared libraries) are named
1264 ossl$libcrypto0101_shr.exe and ossl$libssl0101_shr.exe. However, when
1265 OpenSSL is specifically built for 32-bit pointers, the shareable images
1266 are named ossl$libcrypto0101_shr32.exe and ossl$libssl0101_shr32.exe
1267 instead, and when built for 64-bit pointers, they are named
1268 ossl$libcrypto0101_shr64.exe and ossl$libssl0101_shr64.exe.
1270 Note on random number generation
1271 --------------------------------
1273 Availability of cryptographically secure random numbers is required for
1274 secret key generation. OpenSSL provides several options to seed the
1275 internal CSPRNG. If not properly seeded, the internal CSPRNG will refuse
1276 to deliver random bytes and a "PRNG not seeded error" will occur.
1278 The seeding method can be configured using the --with-rand-seed option,
1279 which can be used to specify a comma separated list of seed methods.
1280 However in most cases OpenSSL will choose a suitable default method,
1281 so it is not necessary to explicitly provide this option. Note also
1282 that not all methods are available on all platforms.
1284 I) On operating systems which provide a suitable randomness source (in
1285 form of a system call or system device), OpenSSL will use the optimal
1286 available method to seed the CSPRNG from the operating system's
1287 randomness sources. This corresponds to the option --with-rand-seed=os.
1289 II) On systems without such a suitable randomness source, automatic seeding
1290 and reseeding is disabled (--with-rand-seed=none) and it may be necessary
1291 to install additional support software to obtain a random seed and reseed
1292 the CSPRNG manually. Please check out the manual pages for RAND_add(),
1293 RAND_bytes(), RAND_egd(), and the FAQ for more information.
projects / openssl.git / blob