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])
27 Notational conventions in this document
28 ---------------------------------------
30 Throughout this document, we use the following conventions in command
33 $ command Any line starting with a dollar sign
34 ($) is a command line.
36 { word1 | word2 | word3 } This denotes a mandatory choice, to be
37 replaced with one of the given words.
38 A simple example would be this:
40 $ echo { FOO | BAR | COOKIE }
42 which is to be understood as one of
51 [ word1 | word2 | word3 ] Similar to { word1 | word2 | word3 }
52 except it's optional to give any of
53 those. In addition to the examples
54 above, this would also be valid:
58 {{ target }} This denotes a mandatory word or
59 sequence of words of some sort. A
60 simple example would be this:
64 which is to be understood to use the
65 command 'type' on some file name
66 determined by the user.
68 [[ options ]] Similar to {{ target }}, but is
71 Note that the notation assumes spaces around {, }, [, ], {{, }} and
72 [[, ]]. This is to differentiate from OpenVMS directory
73 specifications, which also use [ and ], but without spaces.
78 If you want to just get on with it, do:
80 on Unix (again, this includes Mac OS/X):
94 on Windows (only pick one of the targets for configuration):
96 $ perl Configure { VC-WIN32 | VC-WIN64A | VC-WIN64I | VC-CE }
101 Note that in order to perform the install step above you need to have
102 appropriate permissions to write to the installation directory.
104 If any of these steps fails, see section Installation in Detail below.
106 This will build and install OpenSSL in the default location, which is:
108 Unix: normal installation directories under /usr/local
109 OpenVMS: SYS$COMMON:[OPENSSL-'version'...], where 'version' is the
110 OpenSSL version number with underscores instead of periods.
111 Windows: C:\Program Files\OpenSSL or C:\Program Files (x86)\OpenSSL
113 The installation directory should be appropriately protected to ensure
114 unprivileged users cannot make changes to OpenSSL binaries or files, or install
115 engines. If you already have a pre-installed version of OpenSSL as part of
116 your Operating System it is recommended that you do not overwrite the system
117 version and instead install to somewhere else.
119 If you want to install it anywhere else, run config like this:
123 $ ./config --prefix=/opt/openssl --openssldir=/usr/local/ssl
127 $ @config --prefix=PROGRAM:[INSTALLS] --openssldir=SYS$MANAGER:[OPENSSL]
129 (Note: if you do add options to the configuration command, please make sure
130 you've read more than just this Quick Start, such as relevant NOTES.* files,
131 the options outline below, as configuration options may change the outcome
132 in otherwise unexpected ways)
135 Configuration Options
136 ---------------------
138 There are several options to ./config (or ./Configure) to customize
139 the build (note that for Windows, the defaults for --prefix and
140 --openssldir depend in what configuration is used and what Windows
141 implementation OpenSSL is built on. More notes on this in NOTES.WIN):
144 Don't build with support for deprecated APIs below the
145 specified version number. For example "--api=1.1.0" will
146 remove support for all APIS that were deprecated in OpenSSL
147 version 1.1.0 or below.
149 --cross-compile-prefix=PREFIX
150 The PREFIX to include in front of commands for your
151 toolchain. It's likely to have to end with dash, e.g.
152 a-b-c- would invoke GNU compiler as a-b-c-gcc, etc.
153 Unfortunately cross-compiling is too case-specific to
154 put together one-size-fits-all instructions. You might
155 have to pass more flags or set up environment variables
156 to actually make it work. Android and iOS cases are
157 discussed in corresponding Configurations/15-*.conf
158 files. But there are cases when this option alone is
159 sufficient. For example to build the mingw64 target on
160 Linux "--cross-compile-prefix=x86_64-w64-mingw32-"
161 works. Naturally provided that mingw packages are
162 installed. Today Debian and Ubuntu users have option to
163 install a number of prepackaged cross-compilers along
164 with corresponding run-time and development packages for
165 "alien" hardware. To give another example
166 "--cross-compile-prefix=mipsel-linux-gnu-" suffices
167 in such case. Needless to mention that you have to
168 invoke ./Configure, not ./config, and pass your target
169 name explicitly. Also, note that --openssldir refers
170 to target's file system, not one you are building on.
173 Build OpenSSL with debugging symbols and zero optimization
177 The name of the directory under the top of the installation
178 directory tree (see the --prefix option) where libraries will
179 be installed. By default this is "lib". Note that on Windows
180 only ".lib" files will be stored in this location. dll files
181 will always be installed to the "bin" directory.
184 Directory for OpenSSL configuration files, and also the
185 default certificate and key store. Defaults are:
188 Windows: C:\Program Files\Common Files\SSL
189 or C:\Program Files (x86)\Common Files\SSL
190 OpenVMS: SYS$COMMON:[OPENSSL-COMMON]
193 The top of the installation directory tree. Defaults are:
196 Windows: C:\Program Files\OpenSSL
197 or C:\Program Files (x86)\OpenSSL
198 OpenVMS: SYS$COMMON:[OPENSSL-'version']
201 Build OpenSSL without debugging symbols. This is the default.
204 This is a developer flag that switches on various compiler
205 options recommended for OpenSSL development. It only works
206 when using gcc or clang as the compiler. If you are
207 developing a patch for OpenSSL then it is recommended that
208 you use this option where possible.
210 --with-zlib-include=DIR
211 The directory for the location of the zlib include file. This
212 option is only necessary if enable-zlib (see below) is used
213 and the include file is not already on the system include
217 On Unix: this is the directory containing the zlib library.
218 If not provided the system library path will be used.
219 On Windows: this is the filename of the zlib library (with or
220 without a path). This flag must be provided if the
221 zlib-dynamic option is not also used. If zlib-dynamic is used
222 then this flag is optional and a default value ("ZLIB1") is
223 used if not provided.
224 On VMS: this is the filename of the zlib library (with or
225 without a path). This flag is optional and if not provided
226 then "GNV$LIBZSHR", "GNV$LIBZSHR32" or "GNV$LIBZSHR64" is
227 used by default depending on the pointer size chosen.
230 --with-rand-seed=seed1[,seed2,...]
231 A comma separated list of seeding methods which will be tried
232 by OpenSSL in order to obtain random input (a.k.a "entropy")
233 for seeding its cryptographically secure random number
234 generator (CSPRNG). The current seeding methods are:
236 os: Use a trusted operating system entropy source.
237 This is the default method if such an entropy
239 getrandom: Use the L<getrandom(2)> or equivalent system
241 devrandom: Use the the first device from the DEVRANDOM list
242 which can be opened to read random bytes. The
243 DEVRANDOM preprocessor constant expands to
244 "/dev/urandom","/dev/random","/dev/srandom" on
245 most unix-ish operating systems.
246 egd: Check for an entropy generating daemon.
247 rdcpu: Use the RDSEED or RDRAND command if provided by
249 librandom: Use librandom (not implemented yet).
250 none: Disable automatic seeding. This is the default
251 on some operating systems where no suitable
252 entropy source exists, or no support for it is
255 For more information, see the section 'Note on random number
256 generation' at the end of this document.
259 Don't build the AFALG engine. This option will be forced if
260 on a platform that does not support AFALG.
263 Build with the Address sanitiser. This is a developer option
264 only. It may not work on all platforms and should never be
265 used in production environments. It will only work when used
266 with gcc or clang and should be used in conjunction with the
270 Do not use assembler code. This should be viewed as
271 debugging/trouble-shooting option rather than production.
272 On some platforms a small amount of assembler code may
273 still be used even with this option.
276 Do not build support for async operations.
279 Don't automatically load all supported ciphers and digests.
280 Typically OpenSSL will make available all of its supported
281 ciphers and digests. For a statically linked application this
282 may be undesirable if small executable size is an objective.
283 This only affects libcrypto. Ciphers and digests will have to
284 be loaded manually using EVP_add_cipher() and
285 EVP_add_digest() if this option is used. This option will
286 force a non-shared build.
289 Don't automatically load all libcrypto/libssl error strings.
290 Typically OpenSSL will automatically load human readable
291 error strings. For a statically linked application this may
292 be undesirable if small executable size is an objective.
295 Don't automatically load the default openssl.cnf file.
296 Typically OpenSSL will automatically load a system config
297 file which configures default ssl options.
300 While testing, generate C++ buildtest files that
301 simply check that the public OpenSSL header files
302 are usable standalone with C++.
304 Enabling this option demands extra care. For any
305 compiler flag given directly as configuration
306 option, you must ensure that it's valid for both
307 the C and the C++ compiler. If not, the C++ build
308 test will most likely break. As an alternative,
309 you can use the language specific variables, CFLAGS
313 Don't build the CAPI engine. This option will be forced if
314 on a platform that does not support CAPI.
317 Don't build support for CMS features
320 Don't build support for SSL/TLS compression. If this option
321 is left enabled (the default), then compression will only
322 work if the zlib or zlib-dynamic options are also chosen.
325 Build support for debugging memory allocated via
326 OPENSSL_malloc() or OPENSSL_zalloc().
328 enable-crypto-mdebug-backtrace
329 As for crypto-mdebug, but additionally provide backtrace
330 information for allocated memory.
331 TO BE USED WITH CARE: this uses GNU C functionality, and
332 is therefore not usable for non-GNU config targets. If
333 your build complains about the use of '-rdynamic' or the
334 lack of header file execinfo.h, this option is not for you.
335 ALSO NOTE that even though execinfo.h is available on your
336 system (through Gnulib), the functions might just be stubs
340 Don't build support for Certificate Transparency.
343 Don't build with support for any deprecated APIs. This is the
344 same as using "--api" and supplying the latest version
348 Don't build support for datagram based BIOs. Selecting this
349 option will also force the disabling of DTLS.
352 Build the /dev/crypto engine. It is automatically selected
353 on BSD implementations, in which case it can be disabled with
357 Don't build the dynamically loaded engines. This only has an
358 effect in a "shared" build
361 Don't build support for Elliptic Curves.
364 Don't build support for binary Elliptic Curves
366 enable-ec_nistp_64_gcc_128
367 Enable support for optimised implementations of some commonly
368 used NIST elliptic curves.
369 This is only supported on platforms:
370 - with little-endian storage of non-byte types
371 - that tolerate misaligned memory references
372 - where the compiler:
373 - supports the non-standard type __uint128_t
374 - defines the built-in macro __SIZEOF_INT128__
377 Build support for gathering entropy from EGD (Entropy
381 Don't build support for loading engines.
384 Don't compile in any error strings.
386 enable-external-tests
387 Enable building of integration with external test suites.
388 This is a developer option and may not work on all platforms.
389 The only supported external test suite at the current time is
390 the BoringSSL test suite. See the file test/README.external
394 Don't compile in filename and line number information (e.g.
395 for errors and memory allocation).
397 enable-fuzz-libfuzzer, enable-fuzz-afl
398 Build with support for fuzzing using either libfuzzer or AFL.
399 These are developer options only. They may not work on all
400 platforms and should never be used in production environments.
401 See the file fuzz/README.md for further details.
404 Don't build support for GOST based ciphersuites. Note that
405 if this feature is enabled then GOST ciphersuites are only
406 available if the GOST algorithms are also available through
407 loading an externally supplied engine.
410 Don't build the padlock engine.
413 Don't generate dependencies.
416 Don't build support for writing multiple records in one
417 go in libssl (Note: this is a different capability to the
418 pipelining functionality).
421 Don't build support for the NPN TLS extension.
424 Don't build support for OCSP.
427 Don't build with support for Position Independent Code.
429 no-pinshared By default OpenSSL will attempt to stay in memory until the
430 process exits. This is so that libcrypto and libssl can be
431 properly cleaned up automatically via an "atexit()" handler.
432 The handler is registered by libcrypto and cleans up both
433 libraries. On some platforms the atexit() handler will run on
434 unload of libcrypto (if it has been dynamically loaded)
435 rather than at process exit. This option can be used to stop
436 OpenSSL from attempting to stay in memory until the process
437 exits. This could lead to crashes if either libcrypto or
438 libssl have already been unloaded at the point
439 that the atexit handler is invoked, e.g. on a platform which
440 calls atexit() on unload of the library, and libssl is
441 unloaded before libcrypto then a crash is likely to happen.
442 Applications can suppress running of the atexit() handler at
443 run time by using the OPENSSL_INIT_NO_ATEXIT option to
444 OPENSSL_init_crypto(). See the man page for it for further
448 Don't use POSIX IO capabilities.
451 Don't build support for Pre-Shared Key based ciphersuites.
454 Don't use hardware RDRAND capabilities.
457 Don't build support for RFC3779 ("X.509 Extensions for IP
458 Addresses and AS Identifiers")
461 Build support for SCTP
464 Do not create shared libraries, only static ones. See "Note
465 on shared libraries" below.
468 Don't build support for socket BIOs
471 Don't build support for SRP or SRP based ciphersuites.
474 Don't build SRTP support
477 Exclude SSE2 code paths from 32-bit x86 assembly modules.
478 Normally SSE2 extension is detected at run-time, but the
479 decision whether or not the machine code will be executed
480 is taken solely on CPU capability vector. This means that
481 if you happen to run OS kernel which does not support SSE2
482 extension on Intel P4 processor, then your application
483 might be exposed to "illegal instruction" exception.
484 There might be a way to enable support in kernel, e.g.
485 FreeBSD kernel can be compiled with CPU_ENABLE_SSE, and
486 there is a way to disengage SSE2 code paths upon application
487 start-up, but if you aim for wider "audience" running
488 such kernel, consider no-sse2. Both the 386 and
489 no-asm options imply no-sse2.
492 Build with the SSL Trace capabilities (adds the "-trace"
493 option to s_client and s_server).
496 Don't build the statically linked engines. This only
497 has an impact when not built "shared".
500 Don't use anything from the C header file "stdio.h" that
501 makes use of the "FILE" type. Only libcrypto and libssl can
502 be built in this way. Using this option will suppress
503 building the command line applications. Additionally since
504 the OpenSSL tests also use the command line applications the
505 tests will also be skipped.
508 Don't build test programs or run any test.
511 Don't try to build with support for multi-threaded
515 Build with support for multi-threaded applications. Most
516 platforms will enable this by default. However if on a
517 platform where this is not the case then this will usually
518 require additional system-dependent options! See "Note on
519 multi-threading" below.
522 Don't build Time Stamping Authority support.
525 Build with the Undefined Behaviour sanitiser. This is a
526 developer option only. It may not work on all platforms and
527 should never be used in production environments. It will only
528 work when used with gcc or clang and should be used in
529 conjunction with the "-DPEDANTIC" option (or the
530 --strict-warnings option).
533 Don't build with the "UI" capability (i.e. the set of
534 features enabling text based prompts).
537 Enable additional unit test APIs. This should not typically
538 be used in production deployments.
540 enable-weak-ssl-ciphers
541 Build support for SSL/TLS ciphers that are considered "weak"
542 (e.g. RC4 based ciphersuites).
545 Build with support for zlib compression/decompression.
548 Like "zlib", but has OpenSSL load the zlib library
549 dynamically when needed. This is only supported on systems
550 where loading of shared libraries is supported.
553 In 32-bit x86 builds, when generating assembly modules,
554 use the 80386 instruction set only (the default x86 code
555 is more efficient, but requires at least a 486). Note:
556 This doesn't affect code generated by compiler, you're
557 likely to complement configuration command line with
558 suitable compiler-specific option.
561 Don't build support for negotiating the specified SSL/TLS
562 protocol (one of ssl, ssl3, tls, tls1, tls1_1, tls1_2,
563 tls1_3, dtls, dtls1 or dtls1_2). If "no-tls" is selected then
564 all of tls1, tls1_1, tls1_2 and tls1_3 are disabled.
565 Similarly "no-dtls" will disable dtls1 and dtls1_2. The
566 "no-ssl" option is synonymous with "no-ssl3". Note this only
567 affects version negotiation. OpenSSL will still provide the
568 methods for applications to explicitly select the individual
572 As for no-<prot> but in addition do not build the methods for
573 applications to explicitly select individual protocol
574 versions. Note that there is no "no-tls1_3-method" option
575 because there is no application method for TLSv1.3. Using
576 individual protocol methods directly is deprecated.
577 Applications should use TLS_method() instead.
580 Build with support for the specified algorithm, where <alg>
581 is one of: md2 or rc5.
584 Build without support for the specified algorithm, where
585 <alg> is one of: aria, bf, blake2, camellia, cast, chacha,
586 cmac, des, dh, dsa, ecdh, ecdsa, idea, md4, mdc2, ocb,
587 poly1305, rc2, rc4, rmd160, scrypt, seed, siphash, sm2, sm3,
588 sm4 or whirlpool. The "ripemd" algorithm is deprecated and
589 if used is synonymous with rmd160.
591 -Dxxx, -Ixxx, -Wp, -lxxx, -Lxxx, -Wl, -rpath, -R, -framework, -static
592 These system specific options will be recognised and
593 passed through to the compiler to allow you to define
594 preprocessor symbols, specify additional libraries, library
595 directories or other compiler options. It might be worth
596 noting that some compilers generate code specifically for
597 processor the compiler currently executes on. This is not
598 necessarily what you might have in mind, since it might be
599 unsuitable for execution on other, typically older,
600 processor. Consult your compiler documentation.
602 Take note of the VAR=value documentation below and how
603 these flags interact with those variables.
606 Additional options that are not otherwise recognised are
607 passed through as they are to the compiler as well. Again,
608 consult your compiler documentation.
610 Take note of the VAR=value documentation below and how
611 these flags interact with those variables.
614 Assignment of environment variable for Configure. These
615 work just like normal environment variable assignments,
616 but are supported on all platforms and are confined to
617 the configuration scripts only. These assignments override
618 the corresponding value in the inherited environment, if
621 The following variables are used as "make variables" and
622 can be used as an alternative to giving preprocessor,
623 compiler and linker options directly as configuration.
624 The following variables are supported:
626 AR The static library archiver.
627 ARFLAGS Flags for the static library archiver.
628 AS The assembler compiler.
629 ASFLAGS Flags for the assembler compiler.
631 CFLAGS Flags for the C compiler.
632 CXX The C++ compiler.
633 CXXFLAGS Flags for the C++ compiler.
634 CPP The C/C++ preprocessor.
635 CPPFLAGS Flags for the C/C++ preprocessor.
636 CPPDEFINES List of CPP macro definitions, separated
637 by a platform specific character (':' or
638 space for Unix, ';' for Windows, ',' for
639 VMS). This can be used instead of using
640 -D (or what corresponds to that on your
641 compiler) in CPPFLAGS.
642 CPPINCLUDES List of CPP inclusion directories, separated
643 the same way as for CPPDEFINES. This can
644 be used instead of -I (or what corresponds
645 to that on your compiler) in CPPFLAGS.
646 HASHBANGPERL Perl invocation to be inserted after '#!'
647 in public perl scripts (only relevant on
649 LD The program linker (not used on Unix, $(CC)
651 LDFLAGS Flags for the shared library, DSO and
653 LDLIBS Extra libraries to use when linking.
654 Takes the form of a space separated list
655 of library specifications on Unix and
656 Windows, and as a comma separated list of
658 RANLIB The library archive indexer.
659 RC The Windows resource compiler.
660 RCFLAGS Flags for the Windows resource compiler.
661 RM The command to remove files and directories.
663 These cannot be mixed with compiling / linking flags given
664 on the command line. In other words, something like this
667 ./config -DFOO CPPFLAGS=-DBAR -DCOOKIE
669 Backward compatibility note:
671 To be compatible with older configuration scripts, the
672 environment variables are ignored if compiling / linking
673 flags are given on the command line, except for these:
675 AR, CC, CXX, CROSS_COMPILE, HASHBANGPERL, PERL, RANLIB, RC
678 For example, the following command will not see -DBAR:
680 CPPFLAGS=-DBAR ./config -DCOOKIE
682 However, the following will see both set variables:
684 CC=gcc CROSS_COMPILE=x86_64-w64-mingw32- \
687 If CC is set, it is advisable to also set CXX to ensure
688 both C and C++ compilers are in the same "family". This
689 becomes relevant with 'enable-external-tests' and
690 'enable-buildtest-c++'.
694 Reconfigure from earlier data. This fetches the previous
695 command line options and environment from data saved in
696 "configdata.pm", and runs the configuration process again,
697 using these options and environment.
698 Note: NO other option is permitted together with "reconf".
699 This means that you also MUST use "./Configure" (or
700 what corresponds to that on non-Unix platforms) directly
701 to invoke this option.
702 Note: The original configuration saves away values for ALL
703 environment variables that were used, and if they weren't
704 defined, they are still saved away with information that
705 they weren't originally defined. This information takes
706 precedence over environment variables that are defined
709 Displaying configuration data
710 -----------------------------
712 The configuration script itself will say very little, and finishes by
713 creating "configdata.pm". This perl module can be loaded by other scripts
714 to find all the configuration data, and it can also be used as a script to
715 display all sorts of configuration data in a human readable form.
717 For more information, please do:
719 $ ./configdata.pm --help # Unix
723 $ perl configdata.pm --help # Windows and VMS
725 Installation in Detail
726 ----------------------
728 1a. Configure OpenSSL for your operation system automatically:
730 NOTE: This is not available on Windows.
732 $ ./config [[ options ]] # Unix
736 $ @config [[ options ]] ! OpenVMS
738 For the remainder of this text, the Unix form will be used in all
739 examples, please use the appropriate form for your platform.
741 This guesses at your operating system (and compiler, if necessary) and
742 configures OpenSSL based on this guess. Run ./config -t to see
743 if it guessed correctly. If you want to use a different compiler, you
744 are cross-compiling for another platform, or the ./config guess was
745 wrong for other reasons, go to step 1b. Otherwise go to step 2.
747 On some systems, you can include debugging information as follows:
749 $ ./config -d [[ options ]]
751 1b. Configure OpenSSL for your operating system manually
753 OpenSSL knows about a range of different operating system, hardware and
754 compiler combinations. To see the ones it knows about, run
760 $ perl Configure # All other platforms
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 Pick a suitable name from the list that matches your system. For most
766 operating systems there is a choice between using "cc" or "gcc". When
767 you have identified your system (and if necessary compiler) use this name
768 as the argument to Configure. For example, a "linux-elf" user would
771 $ ./Configure linux-elf [[ options ]]
773 If your system isn't listed, you will have to create a configuration
774 file named Configurations/{{ something }}.conf and add the correct
775 configuration for your system. See the available configs as examples
776 and read Configurations/README and Configurations/README.design for
779 The generic configurations "cc" or "gcc" should usually work on 32 bit
782 Configure creates a build file ("Makefile" on Unix, "makefile" on Windows
783 and "descrip.mms" on OpenVMS) from a suitable template in Configurations,
784 and defines various macros in include/openssl/opensslconf.h (generated from
785 include/openssl/opensslconf.h.in).
787 1c. Configure OpenSSL for building outside of the source tree.
789 OpenSSL can be configured to build in a build directory separate from
790 the directory with the source code. It's done by placing yourself in
791 some other directory and invoking the configuration commands from
796 $ mkdir /var/tmp/openssl-build
797 $ cd /var/tmp/openssl-build
798 $ /PATH/TO/OPENSSL/SOURCE/config [[ options ]]
802 $ /PATH/TO/OPENSSL/SOURCE/Configure {{ target }} [[ options ]]
806 $ set default sys$login:
807 $ create/dir [.tmp.openssl-build]
808 $ set default [.tmp.openssl-build]
809 $ @[PATH.TO.OPENSSL.SOURCE]config [[ options ]]
813 $ @[PATH.TO.OPENSSL.SOURCE]Configure {{ target }} [[ options ]]
818 $ mkdir \temp-openssl
820 $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure {{ target }} [[ options ]]
822 Paths can be relative just as well as absolute. Configure will
823 do its best to translate them to relative paths whenever possible.
825 2. Build OpenSSL by running:
828 $ mms ! (or mmk) OpenVMS
831 This will build the OpenSSL libraries (libcrypto.a and libssl.a on
832 Unix, corresponding on other platforms) and the OpenSSL binary
833 ("openssl"). The libraries will be built in the top-level directory,
834 and the binary will be in the "apps" subdirectory.
838 If the build fails, look at the output. There may be reasons
839 for the failure that aren't problems in OpenSSL itself (like
840 missing standard headers).
842 If the build succeeded previously, but fails after a source or
843 configuration change, it might be helpful to clean the build tree
844 before attempting another build. Use this command:
847 $ mms clean ! (or mmk) OpenVMS
848 $ nmake clean # Windows
850 Assembler error messages can sometimes be sidestepped by using the
851 "no-asm" configuration option.
853 Compiling parts of OpenSSL with gcc and others with the system
854 compiler will result in unresolved symbols on some systems.
856 If you are still having problems you can get help by sending an email
857 to the openssl-users email list (see
858 https://www.openssl.org/community/mailinglists.html for details). If
859 it is a bug with OpenSSL itself, please open an issue on GitHub, at
860 https://github.com/openssl/openssl/issues. Please review the existing
861 ones first; maybe the bug was already reported or has already been
864 3. After a successful build, the libraries should be tested. Run:
868 $ nmake test # Windows
870 NOTE: you MUST run the tests from an unprivileged account (or
871 disable your privileges temporarily if your platform allows it).
873 If some tests fail, look at the output. There may be reasons for
874 the failure that isn't a problem in OpenSSL itself (like a
875 malfunction with Perl). You may want increased verbosity, that
876 can be accomplished like this:
878 $ make VERBOSE=1 test # Unix
880 $ mms /macro=(VERBOSE=1) test ! OpenVMS
882 $ nmake VERBOSE=1 test # Windows
884 If you want to run just one or a few specific tests, you can use
885 the make variable TESTS to specify them, like this:
887 $ make TESTS='test_rsa test_dsa' test # Unix
888 $ mms/macro="TESTS=test_rsa test_dsa" test ! OpenVMS
889 $ nmake TESTS='test_rsa test_dsa' test # Windows
891 And of course, you can combine (Unix example shown):
893 $ make VERBOSE=1 TESTS='test_rsa test_dsa' test
895 You can find the list of available tests like this:
897 $ make list-tests # Unix
898 $ mms list-tests ! OpenVMS
899 $ nmake list-tests # Windows
901 Have a look at the manual for the perl module Test::Harness to
902 see what other HARNESS_* variables there are.
904 If you find a problem with OpenSSL itself, try removing any
905 compiler optimization flags from the CFLAGS line in Makefile and
906 run "make clean; make" or corresponding.
908 To report a bug please open an issue on GitHub, at
909 https://github.com/openssl/openssl/issues.
911 For more details on how the make variables TESTS can be used,
912 see section TESTS in Detail below.
914 4. If everything tests ok, install OpenSSL with
916 $ make install # Unix
917 $ mms install ! OpenVMS
918 $ nmake install # Windows
920 Note that in order to perform the install step above you need to have
921 appropriate permissions to write to the installation directory.
923 The above commands will install all the software components in this
924 directory tree under PREFIX (the directory given with --prefix or its
929 bin/ Contains the openssl binary and a few other
932 Contains the header files needed if you want
933 to build your own programs that use libcrypto
935 lib Contains the OpenSSL library files.
936 lib/engines Contains the OpenSSL dynamically loadable engines.
938 share/man/man1 Contains the OpenSSL command line man-pages.
939 share/man/man3 Contains the OpenSSL library calls man-pages.
940 share/man/man5 Contains the OpenSSL configuration format man-pages.
941 share/man/man7 Contains the OpenSSL other misc man-pages.
943 share/doc/openssl/html/man1
944 share/doc/openssl/html/man3
945 share/doc/openssl/html/man5
946 share/doc/openssl/html/man7
947 Contains the HTML rendition of the man-pages.
949 OpenVMS ('arch' is replaced with the architecture name, "Alpha"
950 or "ia64", 'sover' is replaced with the shared library version
951 (0101 for 1.1), and 'pz' is replaced with the pointer size
952 OpenSSL was built with):
954 [.EXE.'arch'] Contains the openssl binary.
955 [.EXE] Contains a few utility scripts.
957 Contains the header files needed if you want
958 to build your own programs that use libcrypto
960 [.LIB.'arch'] Contains the OpenSSL library files.
961 [.ENGINES'sover''pz'.'arch']
962 Contains the OpenSSL dynamically loadable engines.
963 [.SYS$STARTUP] Contains startup, login and shutdown scripts.
964 These define appropriate logical names and
966 [.SYSTEST] Contains the installation verification procedure.
967 [.HTML] Contains the HTML rendition of the manual pages.
970 Additionally, install will add the following directories under
971 OPENSSLDIR (the directory given with --openssldir or its default)
974 certs Initially empty, this is the default location
975 for certificate files.
976 private Initially empty, this is the default location
977 for private key files.
978 misc Various scripts.
980 The installation directory should be appropriately protected to ensure
981 unprivileged users cannot make changes to OpenSSL binaries or files, or
982 install engines. If you already have a pre-installed version of OpenSSL as
983 part of your Operating System it is recommended that you do not overwrite
984 the system version and instead install to somewhere else.
986 Package builders who want to configure the library for standard
987 locations, but have the package installed somewhere else so that
988 it can easily be packaged, can use
990 $ make DESTDIR=/tmp/package-root install # Unix
991 $ mms/macro="DESTDIR=TMP:[PACKAGE-ROOT]" install ! OpenVMS
993 The specified destination directory will be prepended to all
994 installation target paths.
996 Compatibility issues with previous OpenSSL versions:
998 * COMPILING existing applications
1000 Starting with version 1.1.0, OpenSSL hides a number of structures
1001 that were previously open. This includes all internal libssl
1002 structures and a number of EVP types. Accessor functions have
1003 been added to allow controlled access to the structures' data.
1005 This means that some software needs to be rewritten to adapt to
1006 the new ways of doing things. This often amounts to allocating
1007 an instance of a structure explicitly where you could previously
1008 allocate them on the stack as automatic variables, and using the
1009 provided accessor functions where you would previously access a
1010 structure's field directly.
1012 Some APIs have changed as well. However, older APIs have been
1013 preserved when possible.
1015 Environment Variables
1016 ---------------------
1018 A number of environment variables can be used to provide additional control
1019 over the build process. Typically these should be defined prior to running
1020 config or Configure. Not all environment variables are relevant to all
1024 The name of the ar executable to use.
1027 Use a different build file name than the platform default
1028 ("Makefile" on Unix-like platforms, "makefile" on native Windows,
1029 "descrip.mms" on OpenVMS). This requires that there is a
1030 corresponding build file template. See Configurations/README
1031 for further information.
1034 The compiler to use. Configure will attempt to pick a default
1035 compiler for your platform but this choice can be overridden
1036 using this variable. Set it to the compiler executable you wish
1037 to use, e.g. "gcc" or "clang".
1040 This environment variable has the same meaning as for the
1041 "--cross-compile-prefix" Configure flag described above. If both
1042 are set then the Configure flag takes precedence.
1045 The name of the nm executable to use.
1047 OPENSSL_LOCAL_CONFIG_DIR
1048 OpenSSL comes with a database of information about how it
1049 should be built on different platforms as well as build file
1050 templates for those platforms. The database is comprised of
1051 ".conf" files in the Configurations directory. The build
1052 file templates reside there as well as ".tmpl" files. See the
1053 file Configurations/README for further information about the
1054 format of ".conf" files as well as information on the ".tmpl"
1056 In addition to the standard ".conf" and ".tmpl" files, it is
1057 possible to create your own ".conf" and ".tmpl" files and store
1058 them locally, outside the OpenSSL source tree. This environment
1059 variable can be set to the directory where these files are held
1060 and will be considered by Configure before it looks in the
1061 standard directories.
1064 The name of the Perl executable to use when building OpenSSL.
1065 This variable is used in config script only. Configure on the
1066 other hand imposes the interpreter by which it itself was
1067 executed on the whole build procedure.
1070 The command string for the Perl executable to insert in the
1071 #! line of perl scripts that will be publically installed.
1072 Default: /usr/bin/env perl
1073 Note: the value of this variable is added to the same scripts
1074 on all platforms, but it's only relevant on Unix-like platforms.
1077 The name of the rc executable to use. The default will be as
1078 defined for the target platform in the ".conf" file. If not
1079 defined then "windres" will be used. The WINDRES environment
1080 variable is synonymous to this. If both are defined then RC
1084 The name of the ranlib executable to use.
1092 The Configure script generates a Makefile in a format relevant to the specific
1093 platform. The Makefiles provide a number of targets that can be used. Not all
1094 targets may be available on all platforms. Only the most common targets are
1095 described here. Examine the Makefiles themselves for the full list.
1098 The default target to build all the software components.
1101 Remove all build artefacts and return the directory to a "clean"
1105 Rebuild the dependencies in the Makefiles. This is a legacy
1106 option that no longer needs to be used since OpenSSL 1.1.0.
1109 Install all OpenSSL components.
1112 Only install the OpenSSL software components.
1115 Only install the OpenSSL documentation components.
1118 Only install the OpenSSL man pages (Unix only).
1121 Only install the OpenSSL html documentation.
1124 Prints a list of all the self test names.
1127 Build and run the OpenSSL self tests.
1130 Uninstall all OpenSSL components.
1134 Re-run the configuration process, as exactly as the last time
1138 This is a developer option. If you are developing a patch for
1139 OpenSSL you may need to use this if you want to update
1140 automatically generated files; add new error codes or add new
1141 (or change the visibility of) public API functions. (Unix only).
1146 The make variable TESTS supports a versatile set of space separated tokens
1147 with which you can specify a set of tests to be performed. With a "current
1148 set of tests" in mind, initially being empty, here are the possible tokens:
1150 alltests The current set of tests becomes the whole set of available
1151 tests (as listed when you do 'make list-tests' or similar).
1152 xxx Adds the test 'xxx' to the current set of tests.
1153 -xxx Removes 'xxx' from the current set of tests. If this is the
1154 first token in the list, the current set of tests is first
1155 assigned the whole set of available tests, effectively making
1156 this token equivalent to TESTS="alltests -xxx".
1157 nn Adds the test group 'nn' (which is a number) to the current
1159 -nn Removes the test group 'nn' from the current set of tests.
1160 If this is the first token in the list, the current set of
1161 tests is first assigned the whole set of available tests,
1162 effectively making this token equivalent to
1163 TESTS="alltests -xxx".
1165 Also, all tokens except for "alltests" may have wildcards, such as *.
1166 (on Unix and Windows, BSD style wildcards are supported, while on VMS,
1167 it's VMS style wildcards)
1169 Example: All tests except for the fuzz tests:
1171 $ make TESTS=-test_fuzz test
1173 or (if you want to be explicit)
1175 $ make TESTS='alltests -test_fuzz' test
1177 Example: All tests that have a name starting with "test_ssl" but not those
1178 starting with "test_ssl_":
1180 $ make TESTS='test_ssl* -test_ssl_*' test
1182 Example: Only test group 10:
1186 Example: All tests except the slow group (group 99):
1190 Example: All tests in test groups 80 to 99 except for tests in group 90:
1192 $ make TESTS='[89]? -90'
1194 Note on multi-threading
1195 -----------------------
1197 For some systems, the OpenSSL Configure script knows what compiler options
1198 are needed to generate a library that is suitable for multi-threaded
1199 applications. On these systems, support for multi-threading is enabled
1200 by default; use the "no-threads" option to disable (this should never be
1203 On other systems, to enable support for multi-threading, you will have
1204 to specify at least two options: "threads", and a system-dependent option.
1205 (The latter is "-D_REENTRANT" on various systems.) The default in this
1206 case, obviously, is not to include support for multi-threading (but
1207 you can still use "no-threads" to suppress an annoying warning message
1208 from the Configure script.)
1210 OpenSSL provides built-in support for two threading models: pthreads (found on
1211 most UNIX/Linux systems), and Windows threads. No other threading models are
1212 supported. If your platform does not provide pthreads or Windows threads then
1213 you should Configure with the "no-threads" option.
1215 Notes on shared libraries
1216 -------------------------
1218 For most systems the OpenSSL Configure script knows what is needed to
1219 build shared libraries for libcrypto and libssl. On these systems
1220 the shared libraries will be created by default. This can be suppressed and
1221 only static libraries created by using the "no-shared" option. On systems
1222 where OpenSSL does not know how to build shared libraries the "no-shared"
1223 option will be forced and only static libraries will be created.
1225 Shared libraries are named a little differently on different platforms.
1226 One way or another, they all have the major OpenSSL version number as
1227 part of the file name, i.e. for OpenSSL 1.1.x, 1.1 is somehow part of
1230 On most POSIX platforms, shared libraries are named libcrypto.so.1.1
1233 on Cygwin, shared libraries are named cygcrypto-1.1.dll and cygssl-1.1.dll
1234 with import libraries libcrypto.dll.a and libssl.dll.a.
1236 On Windows build with MSVC or using MingW, shared libraries are named
1237 libcrypto-1_1.dll and libssl-1_1.dll for 32-bit Windows, libcrypto-1_1-x64.dll
1238 and libssl-1_1-x64.dll for 64-bit x86_64 Windows, and libcrypto-1_1-ia64.dll
1239 and libssl-1_1-ia64.dll for IA64 Windows. With MSVC, the import libraries
1240 are named libcrypto.lib and libssl.lib, while with MingW, they are named
1241 libcrypto.dll.a and libssl.dll.a.
1243 On VMS, shareable images (VMS speak for shared libraries) are named
1244 ossl$libcrypto0101_shr.exe and ossl$libssl0101_shr.exe. However, when
1245 OpenSSL is specifically built for 32-bit pointers, the shareable images
1246 are named ossl$libcrypto0101_shr32.exe and ossl$libssl0101_shr32.exe
1247 instead, and when built for 64-bit pointers, they are named
1248 ossl$libcrypto0101_shr64.exe and ossl$libssl0101_shr64.exe.
1250 Note on random number generation
1251 --------------------------------
1253 Availability of cryptographically secure random numbers is required for
1254 secret key generation. OpenSSL provides several options to seed the
1255 internal CSPRNG. If not properly seeded, the internal CSPRNG will refuse
1256 to deliver random bytes and a "PRNG not seeded error" will occur.
1258 The seeding method can be configured using the --with-rand-seed option,
1259 which can be used to specify a comma separated list of seed methods.
1260 However in most cases OpenSSL will choose a suitable default method,
1261 so it is not necessary to explicitly provide this option. Note also
1262 that not all methods are available on all platforms.
1264 I) On operating systems which provide a suitable randomness source (in
1265 form of a system call or system device), OpenSSL will use the optimal
1266 available method to seed the CSPRNG from the operating system's
1267 randomness sources. This corresponds to the option --with-rand-seed=os.
1269 II) On systems without such a suitable randomness source, automatic seeding
1270 and reseeding is disabled (--with-rand-seed=none) and it may be necessary
1271 to install additional support software to obtain a random seed and reseed
1272 the CSPRNG manually. Please check out the manual pages for RAND_add(),
1273 RAND_bytes(), RAND_egd(), and the FAQ for more information.
projects / openssl.git / blob