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 Note that in order to perform the install step above you need to have
103 appropriate permissions to write to the installation directory.
105 If any of these steps fails, see section Installation in Detail below.
107 This will build and install OpenSSL in the default location, which is:
109 Unix: normal installation directories under /usr/local
110 OpenVMS: SYS$COMMON:[OPENSSL-'version'...], where 'version' is the
111 OpenSSL version number with underscores instead of periods.
112 Windows: C:\Program Files\OpenSSL or C:\Program Files (x86)\OpenSSL
114 The installation directory should be appropriately protected to ensure
115 unprivileged users cannot make changes to OpenSSL binaries or files, or install
116 engines. If you already have a pre-installed version of OpenSSL as part of
117 your Operating System it is recommended that you do not overwrite the system
118 version and instead install to somewhere else.
120 If you want to install it anywhere else, run config like this:
124 $ ./config --prefix=/opt/openssl --openssldir=/usr/local/ssl
128 $ @config --prefix=PROGRAM:[INSTALLS] --openssldir=SYS$MANAGER:[OPENSSL]
130 (Note: if you do add options to the configuration command, please make sure
131 you've read more than just this Quick Start, such as relevant NOTES.* files,
132 the options outline below, as configuration options may change the outcome
133 in otherwise unexpected ways)
136 Configuration Options
137 ---------------------
139 There are several options to ./config (or ./Configure) to customize
140 the build (note that for Windows, the defaults for --prefix and
141 --openssldir depend in what configuration is used and what Windows
142 implementation OpenSSL is built on. More notes on this in NOTES.WIN):
145 Build the OpenSSL libraries to support the API for
146 the specified version. If "no-deprecated" is also
147 given, don't build with support for deprecated APIs
148 in or below the specified version number. For example
149 "--api=1.1.0" with "no-deprecated" will remove
150 support for all APIS that were deprecated in
151 OpenSSL version 1.1.0 or below.
152 This is a rather specialized option for developers.
153 If you just intend to remove all deprecated APIs
154 entirely (up to the current version), only specify
155 "-no-deprecated" (see below).
156 If "--api" isn't given, it defaults to the current
157 OpenSSL minor version.
159 --cross-compile-prefix=PREFIX
160 The PREFIX to include in front of commands for your
161 toolchain. It's likely to have to end with dash, e.g.
162 a-b-c- would invoke GNU compiler as a-b-c-gcc, etc.
163 Unfortunately cross-compiling is too case-specific to
164 put together one-size-fits-all instructions. You might
165 have to pass more flags or set up environment variables
166 to actually make it work. Android and iOS cases are
167 discussed in corresponding Configurations/15-*.conf
168 files. But there are cases when this option alone is
169 sufficient. For example to build the mingw64 target on
170 Linux "--cross-compile-prefix=x86_64-w64-mingw32-"
171 works. Naturally provided that mingw packages are
172 installed. Today Debian and Ubuntu users have option to
173 install a number of prepackaged cross-compilers along
174 with corresponding run-time and development packages for
175 "alien" hardware. To give another example
176 "--cross-compile-prefix=mipsel-linux-gnu-" suffices
177 in such case. Needless to mention that you have to
178 invoke ./Configure, not ./config, and pass your target
179 name explicitly. Also, note that --openssldir refers
180 to target's file system, not one you are building on.
183 Build OpenSSL with debugging symbols and zero optimization
187 The name of the directory under the top of the installation
188 directory tree (see the --prefix option) where libraries will
189 be installed. By default this is "lib". Note that on Windows
190 only ".lib" files will be stored in this location. dll files
191 will always be installed to the "bin" directory.
194 Directory for OpenSSL configuration files, and also the
195 default certificate and key store. Defaults are:
198 Windows: C:\Program Files\Common Files\SSL
199 or C:\Program Files (x86)\Common Files\SSL
200 OpenVMS: SYS$COMMON:[OPENSSL-COMMON]
203 The top of the installation directory tree. Defaults are:
206 Windows: C:\Program Files\OpenSSL
207 or C:\Program Files (x86)\OpenSSL
208 OpenVMS: SYS$COMMON:[OPENSSL-'version']
211 Build OpenSSL without debugging symbols. This is the default.
214 This is a developer flag that switches on various compiler
215 options recommended for OpenSSL development. It only works
216 when using gcc or clang as the compiler. If you are
217 developing a patch for OpenSSL then it is recommended that
218 you use this option where possible.
220 --with-zlib-include=DIR
221 The directory for the location of the zlib include file. This
222 option is only necessary if enable-zlib (see below) is used
223 and the include file is not already on the system include
227 On Unix: this is the directory containing the zlib library.
228 If not provided the system library path will be used.
229 On Windows: this is the filename of the zlib library (with or
230 without a path). This flag must be provided if the
231 zlib-dynamic option is not also used. If zlib-dynamic is used
232 then this flag is optional and a default value ("ZLIB1") is
233 used if not provided.
234 On VMS: this is the filename of the zlib library (with or
235 without a path). This flag is optional and if not provided
236 then "GNV$LIBZSHR", "GNV$LIBZSHR32" or "GNV$LIBZSHR64" is
237 used by default depending on the pointer size chosen.
240 --with-rand-seed=seed1[,seed2,...]
241 A comma separated list of seeding methods which will be tried
242 by OpenSSL in order to obtain random input (a.k.a "entropy")
243 for seeding its cryptographically secure random number
244 generator (CSPRNG). The current seeding methods are:
246 os: Use a trusted operating system entropy source.
247 This is the default method if such an entropy
249 getrandom: Use the L<getrandom(2)> or equivalent system
251 devrandom: Use the first device from the DEVRANDOM list
252 which can be opened to read random bytes. The
253 DEVRANDOM preprocessor constant expands to
254 "/dev/urandom","/dev/random","/dev/srandom" on
255 most unix-ish operating systems.
256 egd: Check for an entropy generating daemon.
257 rdcpu: Use the RDSEED or RDRAND command if provided by
259 librandom: Use librandom (not implemented yet).
260 none: Disable automatic seeding. This is the default
261 on some operating systems where no suitable
262 entropy source exists, or no support for it is
265 For more information, see the section 'Note on random number
266 generation' at the end of this document.
269 Don't build the AFALG engine. This option will be forced if
270 on a platform that does not support AFALG.
273 Build with Kernel TLS support. This option will enable the
274 use of the Kernel TLS data-path, which can improve
275 performance and allow for the use of sendfile and splice
276 system calls on TLS sockets. The Kernel may use TLS
277 accelerators if any are available on the system.
278 This option will be forced off on systems that do not support
279 the Kernel TLS data-path.
282 Build with the Address sanitiser. This is a developer option
283 only. It may not work on all platforms and should never be
284 used in production environments. It will only work when used
285 with gcc or clang and should be used in conjunction with the
289 Do not use assembler code. This should be viewed as
290 debugging/trouble-shooting option rather than production.
291 On some platforms a small amount of assembler code may
292 still be used even with this option.
295 Do not build support for async operations.
298 Don't automatically load all supported ciphers and digests.
299 Typically OpenSSL will make available all of its supported
300 ciphers and digests. For a statically linked application this
301 may be undesirable if small executable size is an objective.
302 This only affects libcrypto. Ciphers and digests will have to
303 be loaded manually using EVP_add_cipher() and
304 EVP_add_digest() if this option is used. This option will
305 force a non-shared build.
308 Don't automatically load all libcrypto/libssl error strings.
309 Typically OpenSSL will automatically load human readable
310 error strings. For a statically linked application this may
311 be undesirable if small executable size is an objective.
314 Don't automatically load the default openssl.cnf file.
315 Typically OpenSSL will automatically load a system config
316 file which configures default ssl options.
319 While testing, generate C++ buildtest files that
320 simply check that the public OpenSSL header files
321 are usable standalone with C++.
323 Enabling this option demands extra care. For any
324 compiler flag given directly as configuration
325 option, you must ensure that it's valid for both
326 the C and the C++ compiler. If not, the C++ build
327 test will most likely break. As an alternative,
328 you can use the language specific variables, CFLAGS
332 Don't build the CAPI engine. This option will be forced if
333 on a platform that does not support CAPI.
336 Don't build support for CMP features
339 Don't build support for CMS features
342 Don't build support for SSL/TLS compression. If this option
343 is left enabled (the default), then compression will only
344 work if the zlib or zlib-dynamic options are also chosen.
347 Build support for debugging memory allocated via
348 OPENSSL_malloc() or OPENSSL_zalloc().
350 enable-crypto-mdebug-backtrace
351 As for crypto-mdebug, but additionally provide backtrace
352 information for allocated memory.
353 TO BE USED WITH CARE: this uses GNU C functionality, and
354 is therefore not usable for non-GNU config targets. If
355 your build complains about the use of '-rdynamic' or the
356 lack of header file execinfo.h, this option is not for you.
357 ALSO NOTE that even though execinfo.h is available on your
358 system (through Gnulib), the functions might just be stubs
362 Don't build support for Certificate Transparency.
365 Don't build with support for deprecated APIs up
366 until and including the version given with
367 "--api" (or the current version of "--api" wasn't
371 Don't build support for datagram based BIOs. Selecting this
372 option will also force the disabling of DTLS.
375 Don't build support for loading Dynamic Shared Objects.
378 Build the /dev/crypto engine. It is automatically selected
379 on BSD implementations, in which case it can be disabled with
383 Don't build the dynamically loaded engines. This only has an
384 effect in a "shared" build
387 Don't build support for Elliptic Curves.
390 Don't build support for binary Elliptic Curves
392 enable-ec_nistp_64_gcc_128
393 Enable support for optimised implementations of some commonly
394 used NIST elliptic curves.
395 This is only supported on platforms:
396 - with little-endian storage of non-byte types
397 - that tolerate misaligned memory references
398 - where the compiler:
399 - supports the non-standard type __uint128_t
400 - defines the built-in macro __SIZEOF_INT128__
403 Build support for gathering entropy from EGD (Entropy
407 Don't build support for loading engines.
410 Don't compile in any error strings.
412 enable-external-tests
413 Enable building of integration with external test suites.
414 This is a developer option and may not work on all platforms.
415 The only supported external test suite at the current time is
416 the BoringSSL test suite. See the file test/README.external
420 Don't compile in filename and line number information (e.g.
421 for errors and memory allocation).
424 Don't compile the FIPS module
426 enable-fuzz-libfuzzer, enable-fuzz-afl
427 Build with support for fuzzing using either libfuzzer or AFL.
428 These are developer options only. They may not work on all
429 platforms and should never be used in production environments.
430 See the file fuzz/README.md for further details.
433 Don't build support for GOST based ciphersuites. Note that
434 if this feature is enabled then GOST ciphersuites are only
435 available if the GOST algorithms are also available through
436 loading an externally supplied engine.
439 Don't build the legacy provider. Disabling this also disables
440 the legacy algorithms: MD2 (already disabled by default).
443 Don't generate dependencies.
446 Don't build any dynamically loadable engines. This also
447 implies 'no-dynamic-engine'.
450 Don't build support for writing multiple records in one
451 go in libssl (Note: this is a different capability to the
452 pipelining functionality).
455 Don't build support for the NPN TLS extension.
458 Don't build support for OCSP.
462 Don't build the padlock engine.
463 ('no-hw-padlock' is deprecated and should not be used)
466 Don't build with support for Position Independent Code.
468 no-pinshared By default OpenSSL will attempt to stay in memory until the
469 process exits. This is so that libcrypto and libssl can be
470 properly cleaned up automatically via an "atexit()" handler.
471 The handler is registered by libcrypto and cleans up both
472 libraries. On some platforms the atexit() handler will run on
473 unload of libcrypto (if it has been dynamically loaded)
474 rather than at process exit. This option can be used to stop
475 OpenSSL from attempting to stay in memory until the process
476 exits. This could lead to crashes if either libcrypto or
477 libssl have already been unloaded at the point
478 that the atexit handler is invoked, e.g. on a platform which
479 calls atexit() on unload of the library, and libssl is
480 unloaded before libcrypto then a crash is likely to happen.
481 Applications can suppress running of the atexit() handler at
482 run time by using the OPENSSL_INIT_NO_ATEXIT option to
483 OPENSSL_init_crypto(). See the man page for it for further
487 Don't use POSIX IO capabilities.
490 Don't build support for Pre-Shared Key based ciphersuites.
493 Don't use hardware RDRAND capabilities.
496 Don't build support for RFC3779 ("X.509 Extensions for IP
497 Addresses and AS Identifiers")
500 Build support for SCTP
503 Do not create shared libraries, only static ones. See "Note
504 on shared libraries" below.
507 Don't build support for socket BIOs
510 Don't build support for SRP or SRP based ciphersuites.
513 Don't build SRTP support
516 Exclude SSE2 code paths from 32-bit x86 assembly modules.
517 Normally SSE2 extension is detected at run-time, but the
518 decision whether or not the machine code will be executed
519 is taken solely on CPU capability vector. This means that
520 if you happen to run OS kernel which does not support SSE2
521 extension on Intel P4 processor, then your application
522 might be exposed to "illegal instruction" exception.
523 There might be a way to enable support in kernel, e.g.
524 FreeBSD kernel can be compiled with CPU_ENABLE_SSE, and
525 there is a way to disengage SSE2 code paths upon application
526 start-up, but if you aim for wider "audience" running
527 such kernel, consider no-sse2. Both the 386 and
528 no-asm options imply no-sse2.
531 Build with the SSL Trace capabilities (adds the "-trace"
532 option to s_client and s_server).
535 Don't build the statically linked engines. This only
536 has an impact when not built "shared".
539 Don't use anything from the C header file "stdio.h" that
540 makes use of the "FILE" type. Only libcrypto and libssl can
541 be built in this way. Using this option will suppress
542 building the command line applications. Additionally since
543 the OpenSSL tests also use the command line applications the
544 tests will also be skipped.
547 Don't build test programs or run any test.
550 Don't try to build with support for multi-threaded
554 Build with support for multi-threaded applications. Most
555 platforms will enable this by default. However if on a
556 platform where this is not the case then this will usually
557 require additional system-dependent options! See "Note on
558 multi-threading" below.
561 Build with support for the integrated tracing api. See manual pages
562 OSSL_trace_set_channel(3) and OSSL_trace_enabled(3) for details.
565 Don't build Time Stamping Authority support.
568 Build with the Undefined Behaviour sanitiser. This is a
569 developer option only. It may not work on all platforms and
570 should never be used in production environments. It will only
571 work when used with gcc or clang and should be used in
572 conjunction with the "-DPEDANTIC" option (or the
573 --strict-warnings option).
576 Don't build with the "UI" capability (i.e. the set of
577 features enabling text based prompts).
580 Enable additional unit test APIs. This should not typically
581 be used in production deployments.
584 Don't build support for UPLINK interface.
586 enable-weak-ssl-ciphers
587 Build support for SSL/TLS ciphers that are considered "weak"
588 (e.g. RC4 based ciphersuites).
591 Build with support for zlib compression/decompression.
594 Like "zlib", but has OpenSSL load the zlib library
595 dynamically when needed. This is only supported on systems
596 where loading of shared libraries is supported.
599 In 32-bit x86 builds, when generating assembly modules,
600 use the 80386 instruction set only (the default x86 code
601 is more efficient, but requires at least a 486). Note:
602 This doesn't affect code generated by compiler, you're
603 likely to complement configuration command line with
604 suitable compiler-specific option.
607 Don't build support for negotiating the specified SSL/TLS
608 protocol (one of ssl, ssl3, tls, tls1, tls1_1, tls1_2,
609 tls1_3, dtls, dtls1 or dtls1_2). If "no-tls" is selected then
610 all of tls1, tls1_1, tls1_2 and tls1_3 are disabled.
611 Similarly "no-dtls" will disable dtls1 and dtls1_2. The
612 "no-ssl" option is synonymous with "no-ssl3". Note this only
613 affects version negotiation. OpenSSL will still provide the
614 methods for applications to explicitly select the individual
618 As for no-<prot> but in addition do not build the methods for
619 applications to explicitly select individual protocol
620 versions. Note that there is no "no-tls1_3-method" option
621 because there is no application method for TLSv1.3. Using
622 individual protocol methods directly is deprecated.
623 Applications should use TLS_method() instead.
626 Build with support for the specified algorithm, where <alg>
627 is one of: md2 or rc5.
630 Build without support for the specified algorithm, where
631 <alg> is one of: aria, bf, blake2, camellia, cast, chacha,
632 cmac, des, dh, dsa, ecdh, ecdsa, idea, md4, mdc2, ocb,
633 poly1305, rc2, rc4, rmd160, scrypt, seed, siphash, siv, sm2,
634 sm3, sm4 or whirlpool. The "ripemd" algorithm is deprecated
635 and if used is synonymous with rmd160.
637 -Dxxx, -Ixxx, -Wp, -lxxx, -Lxxx, -Wl, -rpath, -R, -framework, -static
638 These system specific options will be recognised and
639 passed through to the compiler to allow you to define
640 preprocessor symbols, specify additional libraries, library
641 directories or other compiler options. It might be worth
642 noting that some compilers generate code specifically for
643 processor the compiler currently executes on. This is not
644 necessarily what you might have in mind, since it might be
645 unsuitable for execution on other, typically older,
646 processor. Consult your compiler documentation.
648 Take note of the VAR=value documentation below and how
649 these flags interact with those variables.
652 Additional options that are not otherwise recognised are
653 passed through as they are to the compiler as well.
654 Unix-style options beginning with a '-' or '+' and
655 Windows-style options beginning with a '/' are recognized.
656 Again, consult your compiler documentation.
658 If the option contains arguments separated by spaces,
659 then the URL-style notation %20 can be used for the space
660 character in order to avoid having to quote the option.
661 For example, -opt%20arg gets expanded to -opt arg.
662 In fact, any ASCII character can be encoded as %xx using its
663 hexadecimal encoding.
665 Take note of the VAR=value documentation below and how
666 these flags interact with those variables.
669 Assignment of environment variable for Configure. These
670 work just like normal environment variable assignments,
671 but are supported on all platforms and are confined to
672 the configuration scripts only. These assignments override
673 the corresponding value in the inherited environment, if
676 The following variables are used as "make variables" and
677 can be used as an alternative to giving preprocessor,
678 compiler and linker options directly as configuration.
679 The following variables are supported:
681 AR The static library archiver.
682 ARFLAGS Flags for the static library archiver.
683 AS The assembler compiler.
684 ASFLAGS Flags for the assembler compiler.
686 CFLAGS Flags for the C compiler.
687 CXX The C++ compiler.
688 CXXFLAGS Flags for the C++ compiler.
689 CPP The C/C++ preprocessor.
690 CPPFLAGS Flags for the C/C++ preprocessor.
691 CPPDEFINES List of CPP macro definitions, separated
692 by a platform specific character (':' or
693 space for Unix, ';' for Windows, ',' for
694 VMS). This can be used instead of using
695 -D (or what corresponds to that on your
696 compiler) in CPPFLAGS.
697 CPPINCLUDES List of CPP inclusion directories, separated
698 the same way as for CPPDEFINES. This can
699 be used instead of -I (or what corresponds
700 to that on your compiler) in CPPFLAGS.
701 HASHBANGPERL Perl invocation to be inserted after '#!'
702 in public perl scripts (only relevant on
704 LD The program linker (not used on Unix, $(CC)
706 LDFLAGS Flags for the shared library, DSO and
708 LDLIBS Extra libraries to use when linking.
709 Takes the form of a space separated list
710 of library specifications on Unix and
711 Windows, and as a comma separated list of
713 RANLIB The library archive indexer.
714 RC The Windows resource compiler.
715 RCFLAGS Flags for the Windows resource compiler.
716 RM The command to remove files and directories.
718 These cannot be mixed with compiling / linking flags given
719 on the command line. In other words, something like this
722 ./config -DFOO CPPFLAGS=-DBAR -DCOOKIE
724 Backward compatibility note:
726 To be compatible with older configuration scripts, the
727 environment variables are ignored if compiling / linking
728 flags are given on the command line, except for these:
730 AR, CC, CXX, CROSS_COMPILE, HASHBANGPERL, PERL, RANLIB, RC
733 For example, the following command will not see -DBAR:
735 CPPFLAGS=-DBAR ./config -DCOOKIE
737 However, the following will see both set variables:
739 CC=gcc CROSS_COMPILE=x86_64-w64-mingw32- \
742 If CC is set, it is advisable to also set CXX to ensure
743 both C and C++ compilers are in the same "family". This
744 becomes relevant with 'enable-external-tests' and
745 'enable-buildtest-c++'.
749 Reconfigure from earlier data. This fetches the previous
750 command line options and environment from data saved in
751 "configdata.pm", and runs the configuration process again,
752 using these options and environment.
753 Note: NO other option is permitted together with "reconf".
754 This means that you also MUST use "./Configure" (or
755 what corresponds to that on non-Unix platforms) directly
756 to invoke this option.
757 Note: The original configuration saves away values for ALL
758 environment variables that were used, and if they weren't
759 defined, they are still saved away with information that
760 they weren't originally defined. This information takes
761 precedence over environment variables that are defined
764 Displaying configuration data
765 -----------------------------
767 The configuration script itself will say very little, and finishes by
768 creating "configdata.pm". This perl module can be loaded by other scripts
769 to find all the configuration data, and it can also be used as a script to
770 display all sorts of configuration data in a human readable form.
772 For more information, please do:
774 $ ./configdata.pm --help # Unix
778 $ perl configdata.pm --help # Windows and VMS
780 Installation in Detail
781 ----------------------
783 1a. Configure OpenSSL for your operation system automatically:
785 NOTE: This is not available on Windows.
787 $ ./config [[ options ]] # Unix
791 $ @config [[ options ]] ! OpenVMS
793 For the remainder of this text, the Unix form will be used in all
794 examples, please use the appropriate form for your platform.
796 This guesses at your operating system (and compiler, if necessary) and
797 configures OpenSSL based on this guess. Run ./config -t to see
798 if it guessed correctly. If you want to use a different compiler, you
799 are cross-compiling for another platform, or the ./config guess was
800 wrong for other reasons, go to step 1b. Otherwise go to step 2.
802 On some systems, you can include debugging information as follows:
804 $ ./config -d [[ options ]]
806 1b. Configure OpenSSL for your operating system manually
808 OpenSSL knows about a range of different operating system, hardware and
809 compiler combinations. To see the ones it knows about, run
815 $ perl Configure # All other platforms
817 For the remainder of this text, the Unix form will be used in all
818 examples, please use the appropriate form for your platform.
820 Pick a suitable name from the list that matches your system. For most
821 operating systems there is a choice between using "cc" or "gcc". When
822 you have identified your system (and if necessary compiler) use this name
823 as the argument to Configure. For example, a "linux-elf" user would
826 $ ./Configure linux-elf [[ options ]]
828 If your system isn't listed, you will have to create a configuration
829 file named Configurations/{{ something }}.conf and add the correct
830 configuration for your system. See the available configs as examples
831 and read Configurations/README and Configurations/README.design for
834 The generic configurations "cc" or "gcc" should usually work on 32 bit
837 Configure creates a build file ("Makefile" on Unix, "makefile" on Windows
838 and "descrip.mms" on OpenVMS) from a suitable template in Configurations,
839 and defines various macros in include/openssl/opensslconf.h (generated from
840 include/openssl/opensslconf.h.in).
842 1c. Configure OpenSSL for building outside of the source tree.
844 OpenSSL can be configured to build in a build directory separate from
845 the directory with the source code. It's done by placing yourself in
846 some other directory and invoking the configuration commands from
851 $ mkdir /var/tmp/openssl-build
852 $ cd /var/tmp/openssl-build
853 $ /PATH/TO/OPENSSL/SOURCE/config [[ options ]]
857 $ /PATH/TO/OPENSSL/SOURCE/Configure {{ target }} [[ options ]]
861 $ set default sys$login:
862 $ create/dir [.tmp.openssl-build]
863 $ set default [.tmp.openssl-build]
864 $ @[PATH.TO.OPENSSL.SOURCE]config [[ options ]]
868 $ @[PATH.TO.OPENSSL.SOURCE]Configure {{ target }} [[ options ]]
873 $ mkdir \temp-openssl
875 $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure {{ target }} [[ options ]]
877 Paths can be relative just as well as absolute. Configure will
878 do its best to translate them to relative paths whenever possible.
880 2. Build OpenSSL by running:
883 $ mms ! (or mmk) OpenVMS
886 This will build the OpenSSL libraries (libcrypto.a and libssl.a on
887 Unix, corresponding on other platforms) and the OpenSSL binary
888 ("openssl"). The libraries will be built in the top-level directory,
889 and the binary will be in the "apps" subdirectory.
893 If the build fails, look at the output. There may be reasons
894 for the failure that aren't problems in OpenSSL itself (like
895 missing standard headers).
897 If the build succeeded previously, but fails after a source or
898 configuration change, it might be helpful to clean the build tree
899 before attempting another build. Use this command:
902 $ mms clean ! (or mmk) OpenVMS
903 $ nmake clean # Windows
905 Assembler error messages can sometimes be sidestepped by using the
906 "no-asm" configuration option.
908 Compiling parts of OpenSSL with gcc and others with the system
909 compiler will result in unresolved symbols on some systems.
911 If you are still having problems you can get help by sending an email
912 to the openssl-users email list (see
913 https://www.openssl.org/community/mailinglists.html for details). If
914 it is a bug with OpenSSL itself, please open an issue on GitHub, at
915 https://github.com/openssl/openssl/issues. Please review the existing
916 ones first; maybe the bug was already reported or has already been
919 3. After a successful build, the libraries should be tested. Run:
923 $ nmake test # Windows
925 NOTE: you MUST run the tests from an unprivileged account (or
926 disable your privileges temporarily if your platform allows it).
928 If some tests fail, look at the output. There may be reasons for
929 the failure that isn't a problem in OpenSSL itself (like a
930 malfunction with Perl). You may want increased verbosity, that
931 can be accomplished like this:
933 Verbosity on failure only (make macro VERBOSE_FAILURE or VF):
935 $ make VF=1 test # Unix
936 $ mms /macro=(VF=1) test ! OpenVMS
937 $ nmake VF=1 test # Windows
939 Full verbosity (make macro VERBOSE or V):
941 $ make V=1 test # Unix
942 $ mms /macro=(V=1) test ! OpenVMS
943 $ nmake V=1 test # Windows
945 If you want to run just one or a few specific tests, you can use
946 the make variable TESTS to specify them, like this:
948 $ make TESTS='test_rsa test_dsa' test # Unix
949 $ mms/macro="TESTS=test_rsa test_dsa" test ! OpenVMS
950 $ nmake TESTS='test_rsa test_dsa' test # Windows
952 And of course, you can combine (Unix example shown):
954 $ make VF=1 TESTS='test_rsa test_dsa' test
956 You can find the list of available tests like this:
958 $ make list-tests # Unix
959 $ mms list-tests ! OpenVMS
960 $ nmake list-tests # Windows
962 Have a look at the manual for the perl module Test::Harness to
963 see what other HARNESS_* variables there are.
965 If you find a problem with OpenSSL itself, try removing any
966 compiler optimization flags from the CFLAGS line in Makefile and
967 run "make clean; make" or corresponding.
969 To report a bug please open an issue on GitHub, at
970 https://github.com/openssl/openssl/issues.
972 For more details on how the make variables TESTS can be used,
973 see section TESTS in Detail below.
975 4. If everything tests ok, install OpenSSL with
977 $ make install # Unix
978 $ mms install ! OpenVMS
979 $ nmake install # Windows
981 Note that in order to perform the install step above you need to have
982 appropriate permissions to write to the installation directory.
984 The above commands will install all the software components in this
985 directory tree under PREFIX (the directory given with --prefix or its
990 bin/ Contains the openssl binary and a few other
993 Contains the header files needed if you want
994 to build your own programs that use libcrypto
996 lib Contains the OpenSSL library files.
997 lib/engines Contains the OpenSSL dynamically loadable engines.
999 share/man/man1 Contains the OpenSSL command line man-pages.
1000 share/man/man3 Contains the OpenSSL library calls man-pages.
1001 share/man/man5 Contains the OpenSSL configuration format man-pages.
1002 share/man/man7 Contains the OpenSSL other misc man-pages.
1004 share/doc/openssl/html/man1
1005 share/doc/openssl/html/man3
1006 share/doc/openssl/html/man5
1007 share/doc/openssl/html/man7
1008 Contains the HTML rendition of the man-pages.
1010 OpenVMS ('arch' is replaced with the architecture name, "Alpha"
1011 or "ia64", 'sover' is replaced with the shared library version
1012 (0101 for 1.1), and 'pz' is replaced with the pointer size
1013 OpenSSL was built with):
1015 [.EXE.'arch'] Contains the openssl binary.
1016 [.EXE] Contains a few utility scripts.
1018 Contains the header files needed if you want
1019 to build your own programs that use libcrypto
1021 [.LIB.'arch'] Contains the OpenSSL library files.
1022 [.ENGINES'sover''pz'.'arch']
1023 Contains the OpenSSL dynamically loadable engines.
1024 [.SYS$STARTUP] Contains startup, login and shutdown scripts.
1025 These define appropriate logical names and
1027 [.SYSTEST] Contains the installation verification procedure.
1028 [.HTML] Contains the HTML rendition of the manual pages.
1031 Additionally, install will add the following directories under
1032 OPENSSLDIR (the directory given with --openssldir or its default)
1033 for you convenience:
1035 certs Initially empty, this is the default location
1036 for certificate files.
1037 private Initially empty, this is the default location
1038 for private key files.
1039 misc Various scripts.
1041 The installation directory should be appropriately protected to ensure
1042 unprivileged users cannot make changes to OpenSSL binaries or files, or
1043 install engines. If you already have a pre-installed version of OpenSSL as
1044 part of your Operating System it is recommended that you do not overwrite
1045 the system version and instead install to somewhere else.
1047 Package builders who want to configure the library for standard
1048 locations, but have the package installed somewhere else so that
1049 it can easily be packaged, can use
1051 $ make DESTDIR=/tmp/package-root install # Unix
1052 $ mms/macro="DESTDIR=TMP:[PACKAGE-ROOT]" install ! OpenVMS
1054 The specified destination directory will be prepended to all
1055 installation target paths.
1057 Compatibility issues with previous OpenSSL versions:
1059 * COMPILING existing applications
1061 Starting with version 1.1.0, OpenSSL hides a number of structures
1062 that were previously open. This includes all internal libssl
1063 structures and a number of EVP types. Accessor functions have
1064 been added to allow controlled access to the structures' data.
1066 This means that some software needs to be rewritten to adapt to
1067 the new ways of doing things. This often amounts to allocating
1068 an instance of a structure explicitly where you could previously
1069 allocate them on the stack as automatic variables, and using the
1070 provided accessor functions where you would previously access a
1071 structure's field directly.
1073 Some APIs have changed as well. However, older APIs have been
1074 preserved when possible.
1076 Environment Variables
1077 ---------------------
1079 A number of environment variables can be used to provide additional control
1080 over the build process. Typically these should be defined prior to running
1081 config or Configure. Not all environment variables are relevant to all
1085 The name of the ar executable to use.
1088 Use a different build file name than the platform default
1089 ("Makefile" on Unix-like platforms, "makefile" on native Windows,
1090 "descrip.mms" on OpenVMS). This requires that there is a
1091 corresponding build file template. See Configurations/README
1092 for further information.
1095 The compiler to use. Configure will attempt to pick a default
1096 compiler for your platform but this choice can be overridden
1097 using this variable. Set it to the compiler executable you wish
1098 to use, e.g. "gcc" or "clang".
1101 This environment variable has the same meaning as for the
1102 "--cross-compile-prefix" Configure flag described above. If both
1103 are set then the Configure flag takes precedence.
1106 The name of the nm executable to use.
1108 OPENSSL_LOCAL_CONFIG_DIR
1109 OpenSSL comes with a database of information about how it
1110 should be built on different platforms as well as build file
1111 templates for those platforms. The database is comprised of
1112 ".conf" files in the Configurations directory. The build
1113 file templates reside there as well as ".tmpl" files. See the
1114 file Configurations/README for further information about the
1115 format of ".conf" files as well as information on the ".tmpl"
1117 In addition to the standard ".conf" and ".tmpl" files, it is
1118 possible to create your own ".conf" and ".tmpl" files and store
1119 them locally, outside the OpenSSL source tree. This environment
1120 variable can be set to the directory where these files are held
1121 and will be considered by Configure before it looks in the
1122 standard directories.
1125 The name of the Perl executable to use when building OpenSSL.
1126 This variable is used in config script only. Configure on the
1127 other hand imposes the interpreter by which it itself was
1128 executed on the whole build procedure.
1131 The command string for the Perl executable to insert in the
1132 #! line of perl scripts that will be publically installed.
1133 Default: /usr/bin/env perl
1134 Note: the value of this variable is added to the same scripts
1135 on all platforms, but it's only relevant on Unix-like platforms.
1138 The name of the rc executable to use. The default will be as
1139 defined for the target platform in the ".conf" file. If not
1140 defined then "windres" will be used. The WINDRES environment
1141 variable is synonymous to this. If both are defined then RC
1145 The name of the ranlib executable to use.
1153 The Configure script generates a Makefile in a format relevant to the specific
1154 platform. The Makefiles provide a number of targets that can be used. Not all
1155 targets may be available on all platforms. Only the most common targets are
1156 described here. Examine the Makefiles themselves for the full list.
1159 The target to build all the software components and
1163 Build all the software components.
1164 THIS IS THE DEFAULT TARGET.
1167 Build all documentation components.
1170 Remove all build artefacts and return the directory to a "clean"
1174 Rebuild the dependencies in the Makefiles. This is a legacy
1175 option that no longer needs to be used since OpenSSL 1.1.0.
1178 Install all OpenSSL components.
1181 Only install the OpenSSL software components.
1184 Only install the OpenSSL documentation components.
1187 Only install the OpenSSL man pages (Unix only).
1190 Only install the OpenSSL html documentation.
1193 Prints a list of all the self test names.
1196 Build and run the OpenSSL self tests.
1199 Uninstall all OpenSSL components.
1203 Re-run the configuration process, as exactly as the last time
1207 This is a developer option. If you are developing a patch for
1208 OpenSSL you may need to use this if you want to update
1209 automatically generated files; add new error codes or add new
1210 (or change the visibility of) public API functions. (Unix only).
1215 The make variable TESTS supports a versatile set of space separated tokens
1216 with which you can specify a set of tests to be performed. With a "current
1217 set of tests" in mind, initially being empty, here are the possible tokens:
1219 alltests The current set of tests becomes the whole set of available
1220 tests (as listed when you do 'make list-tests' or similar).
1221 xxx Adds the test 'xxx' to the current set of tests.
1222 -xxx Removes 'xxx' from the current set of tests. If this is the
1223 first token in the list, the current set of tests is first
1224 assigned the whole set of available tests, effectively making
1225 this token equivalent to TESTS="alltests -xxx".
1226 nn Adds the test group 'nn' (which is a number) to the current
1228 -nn Removes the test group 'nn' from the current set of tests.
1229 If this is the first token in the list, the current set of
1230 tests is first assigned the whole set of available tests,
1231 effectively making this token equivalent to
1232 TESTS="alltests -xxx".
1234 Also, all tokens except for "alltests" may have wildcards, such as *.
1235 (on Unix and Windows, BSD style wildcards are supported, while on VMS,
1236 it's VMS style wildcards)
1238 Example: All tests except for the fuzz tests:
1240 $ make TESTS=-test_fuzz test
1242 or (if you want to be explicit)
1244 $ make TESTS='alltests -test_fuzz' test
1246 Example: All tests that have a name starting with "test_ssl" but not those
1247 starting with "test_ssl_":
1249 $ make TESTS='test_ssl* -test_ssl_*' test
1251 Example: Only test group 10:
1255 Example: All tests except the slow group (group 99):
1259 Example: All tests in test groups 80 to 99 except for tests in group 90:
1261 $ make TESTS='[89]? -90'
1263 To stochastically verify that the algorithm that produces uniformly distributed
1264 random numbers is operating correctly (with a false positive rate of 0.01%):
1266 $ ./util/shlib_wrap.sh test/bntest -stochastic
1268 Note on multi-threading
1269 -----------------------
1271 For some systems, the OpenSSL Configure script knows what compiler options
1272 are needed to generate a library that is suitable for multi-threaded
1273 applications. On these systems, support for multi-threading is enabled
1274 by default; use the "no-threads" option to disable (this should never be
1277 On other systems, to enable support for multi-threading, you will have
1278 to specify at least two options: "threads", and a system-dependent option.
1279 (The latter is "-D_REENTRANT" on various systems.) The default in this
1280 case, obviously, is not to include support for multi-threading (but
1281 you can still use "no-threads" to suppress an annoying warning message
1282 from the Configure script.)
1284 OpenSSL provides built-in support for two threading models: pthreads (found on
1285 most UNIX/Linux systems), and Windows threads. No other threading models are
1286 supported. If your platform does not provide pthreads or Windows threads then
1287 you should Configure with the "no-threads" option.
1289 Notes on shared libraries
1290 -------------------------
1292 For most systems the OpenSSL Configure script knows what is needed to
1293 build shared libraries for libcrypto and libssl. On these systems
1294 the shared libraries will be created by default. This can be suppressed and
1295 only static libraries created by using the "no-shared" option. On systems
1296 where OpenSSL does not know how to build shared libraries the "no-shared"
1297 option will be forced and only static libraries will be created.
1299 Shared libraries are named a little differently on different platforms.
1300 One way or another, they all have the major OpenSSL version number as
1301 part of the file name, i.e. for OpenSSL 1.1.x, 1.1 is somehow part of
1304 On most POSIX platforms, shared libraries are named libcrypto.so.1.1
1307 on Cygwin, shared libraries are named cygcrypto-1.1.dll and cygssl-1.1.dll
1308 with import libraries libcrypto.dll.a and libssl.dll.a.
1310 On Windows build with MSVC or using MingW, shared libraries are named
1311 libcrypto-1_1.dll and libssl-1_1.dll for 32-bit Windows, libcrypto-1_1-x64.dll
1312 and libssl-1_1-x64.dll for 64-bit x86_64 Windows, and libcrypto-1_1-ia64.dll
1313 and libssl-1_1-ia64.dll for IA64 Windows. With MSVC, the import libraries
1314 are named libcrypto.lib and libssl.lib, while with MingW, they are named
1315 libcrypto.dll.a and libssl.dll.a.
1317 On VMS, shareable images (VMS speak for shared libraries) are named
1318 ossl$libcrypto0101_shr.exe and ossl$libssl0101_shr.exe. However, when
1319 OpenSSL is specifically built for 32-bit pointers, the shareable images
1320 are named ossl$libcrypto0101_shr32.exe and ossl$libssl0101_shr32.exe
1321 instead, and when built for 64-bit pointers, they are named
1322 ossl$libcrypto0101_shr64.exe and ossl$libssl0101_shr64.exe.
1324 Note on random number generation
1325 --------------------------------
1327 Availability of cryptographically secure random numbers is required for
1328 secret key generation. OpenSSL provides several options to seed the
1329 internal CSPRNG. If not properly seeded, the internal CSPRNG will refuse
1330 to deliver random bytes and a "PRNG not seeded error" will occur.
1332 The seeding method can be configured using the --with-rand-seed option,
1333 which can be used to specify a comma separated list of seed methods.
1334 However in most cases OpenSSL will choose a suitable default method,
1335 so it is not necessary to explicitly provide this option. Note also
1336 that not all methods are available on all platforms.
1338 I) On operating systems which provide a suitable randomness source (in
1339 form of a system call or system device), OpenSSL will use the optimal
1340 available method to seed the CSPRNG from the operating system's
1341 randomness sources. This corresponds to the option --with-rand-seed=os.
1343 II) On systems without such a suitable randomness source, automatic seeding
1344 and reseeding is disabled (--with-rand-seed=none) and it may be necessary
1345 to install additional support software to obtain a random seed and reseed
1346 the CSPRNG manually. Please check out the manual pages for RAND_add(),
1347 RAND_bytes(), RAND_egd(), and the FAQ for more information.
projects / thirdparty / openssl.git / blob