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 If any of these steps fails, see section Installation in Detail below.
103 This will build and install OpenSSL in the default location, which is:
105 Unix: normal installation directories under /usr/local
106 OpenVMS: SYS$COMMON:[OPENSSL-'version'...], where 'version' is the
107 OpenSSL version number with underscores instead of periods.
108 Windows: C:\Program Files\OpenSSL or C:\Program Files (x86)\OpenSSL
110 If you want to install it anywhere else, run config like this:
114 $ ./config --prefix=/opt/openssl --openssldir=/usr/local/ssl
118 $ @config --prefix=PROGRAM:[INSTALLS] --openssldir=SYS$MANAGER:[OPENSSL]
120 (Note: if you do add options to the configuration command, please make sure
121 you've read more than just this Quick Start, such as relevant NOTES.* files,
122 the options outline below, as configuration options may change the outcome
123 in otherwise unexpected ways)
126 Configuration Options
127 ---------------------
129 There are several options to ./config (or ./Configure) to customize
130 the build (note that for Windows, the defaults for --prefix and
131 --openssldir depend in what configuration is used and what Windows
132 implementation OpenSSL is built on. More notes on this in NOTES.WIN):
135 Don't build with support for deprecated APIs below the
136 specified version number. For example "--api=1.1.0" will
137 remove support for all APIS that were deprecated in OpenSSL
138 version 1.1.0 or below.
140 --cross-compile-prefix=PREFIX
141 The PREFIX to include in front of commands for your
142 toolchain. It's likely to have to end with dash, e.g.
143 a-b-c- would invoke GNU compiler as a-b-c-gcc, etc.
144 Unfortunately cross-compiling is too case-specific to
145 put together one-size-fits-all instructions. You might
146 have to pass more flags or set up environment variables
147 to actually make it work. Android and iOS cases are
148 discussed in corresponding Configurations/15-*.conf
149 files. But there are cases when this option alone is
150 sufficient. For example to build the mingw64 target on
151 Linux "--cross-compile-prefix=x86_64-w64-mingw32-"
152 works. Naturally provided that mingw packages are
153 installed. Today Debian and Ubuntu users have option to
154 install a number of prepackaged cross-compilers along
155 with corresponding run-time and development packages for
156 "alien" hardware. To give another example
157 "--cross-compile-prefix=mipsel-linux-gnu-" suffices
158 in such case. Needless to mention that you have to
159 invoke ./Configure, not ./config, and pass your target
160 name explicitly. Also, note that --openssldir refers
161 to target's file system, not one you are building on.
164 Build OpenSSL with debugging symbols and zero optimization
168 The name of the directory under the top of the installation
169 directory tree (see the --prefix option) where libraries will
170 be installed. By default this is "lib". Note that on Windows
171 only ".lib" files will be stored in this location. dll files
172 will always be installed to the "bin" directory.
175 Directory for OpenSSL configuration files, and also the
176 default certificate and key store. Defaults are:
179 Windows: C:\Program Files\Common Files\SSL
180 or C:\Program Files (x86)\Common Files\SSL
181 OpenVMS: SYS$COMMON:[OPENSSL-COMMON]
184 The top of the installation directory tree. Defaults are:
187 Windows: C:\Program Files\OpenSSL
188 or C:\Program Files (x86)\OpenSSL
189 OpenVMS: SYS$COMMON:[OPENSSL-'version']
192 Build OpenSSL without debugging symbols. This is the default.
195 This is a developer flag that switches on various compiler
196 options recommended for OpenSSL development. It only works
197 when using gcc or clang as the compiler. If you are
198 developing a patch for OpenSSL then it is recommended that
199 you use this option where possible.
201 --with-zlib-include=DIR
202 The directory for the location of the zlib include file. This
203 option is only necessary if enable-zlib (see below) is used
204 and the include file is not already on the system include
208 On Unix: this is the directory containing the zlib library.
209 If not provided the system library path will be used.
210 On Windows: this is the filename of the zlib library (with or
211 without a path). This flag must be provided if the
212 zlib-dynamic option is not also used. If zlib-dynamic is used
213 then this flag is optional and a default value ("ZLIB1") is
214 used if not provided.
215 On VMS: this is the filename of the zlib library (with or
216 without a path). This flag is optional and if not provided
217 then "GNV$LIBZSHR", "GNV$LIBZSHR32" or "GNV$LIBZSHR64" is
218 used by default depending on the pointer size chosen.
221 --with-rand-seed=seed1[,seed2,...]
222 A comma separated list of seeding methods which will be tried
223 by OpenSSL in order to obtain random input (a.k.a "entropy")
224 for seeding its cryptographically secure random number
225 generator (CSPRNG). The current seeding methods are:
227 os: Use a trusted operating system entropy source.
228 This is the default method if such an entropy
230 getrandom: Use the L<getrandom(2)> or equivalent system
232 devrandom: Use the the first device from the DEVRANDOM list
233 which can be opened to read random bytes. The
234 DEVRANDOM preprocessor constant expands to
235 "/dev/urandom","/dev/random","/dev/srandom" on
236 most unix-ish operating systems.
237 egd: Check for an entropy generating daemon.
238 rdcpu: Use the RDSEED or RDRAND command if provided by
240 librandom: Use librandom (not implemented yet).
241 none: Disable automatic seeding. This is the default
242 on some operating systems where no suitable
243 entropy source exists, or no support for it is
246 For more information, see the section 'Note on random number
247 generation' at the end of this document.
250 Don't build the AFALG engine. This option will be forced if
251 on a platform that does not support AFALG.
254 Build with Kernel TLS support. This option will enable the
255 use of the Kernel TLS data-path, which can improve
256 performance and allow for the use of sendfile and splice
257 system calls on TLS sockets. The Kernel may use TLS
258 accelerators if any are available on the system.
259 This option will be forced off on systems that do not support
260 the Kernel TLS data-path.
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 Don't build the CAPI engine. This option will be forced if
301 on a platform that does not support CAPI.
304 Don't build support for CMS features
307 Don't build support for SSL/TLS compression. If this option
308 is left enabled (the default), then compression will only
309 work if the zlib or zlib-dynamic options are also chosen.
312 Build support for debugging memory allocated via
313 OPENSSL_malloc() or OPENSSL_zalloc().
315 enable-crypto-mdebug-backtrace
316 As for crypto-mdebug, but additionally provide backtrace
317 information for allocated memory.
318 TO BE USED WITH CARE: this uses GNU C functionality, and
319 is therefore not usable for non-GNU config targets. If
320 your build complains about the use of '-rdynamic' or the
321 lack of header file execinfo.h, this option is not for you.
322 ALSO NOTE that even though execinfo.h is available on your
323 system (through Gnulib), the functions might just be stubs
327 Don't build support for Certificate Transparency.
330 Don't build with support for any deprecated APIs. This is the
331 same as using "--api" and supplying the latest version
335 Don't build support for datagram based BIOs. Selecting this
336 option will also force the disabling of DTLS.
339 Build the /dev/crypto engine. It is automatically selected
340 on BSD implementations, in which case it can be disabled with
344 Don't build support for loading Dynamic Shared Objects.
347 Don't build the dynamically loaded engines. This only has an
348 effect in a "shared" build
351 Don't build support for Elliptic Curves.
354 Don't build support for binary Elliptic Curves
356 enable-ec_nistp_64_gcc_128
357 Enable support for optimised implementations of some commonly
358 used NIST elliptic curves.
359 This is only supported on platforms:
360 - with little-endian storage of non-byte types
361 - that tolerate misaligned memory references
362 - where the compiler:
363 - supports the non-standard type __uint128_t
364 - defines the built-in macro __SIZEOF_INT128__
367 Build support for gathering entropy from EGD (Entropy
371 Don't build support for loading engines.
374 Don't compile in any error strings.
376 enable-external-tests
377 Enable building of integration with external test suites.
378 This is a developer option and may not work on all platforms.
379 The only supported external test suite at the current time is
380 the BoringSSL test suite. See the file test/README.external
384 Don't compile in filename and line number information (e.g.
385 for errors and memory allocation).
387 enable-fuzz-libfuzzer, enable-fuzz-afl
388 Build with support for fuzzing using either libfuzzer or AFL.
389 These are developer options only. They may not work on all
390 platforms and should never be used in production environments.
391 See the file fuzz/README.md for further details.
394 Don't build support for GOST based ciphersuites. Note that
395 if this feature is enabled then GOST ciphersuites are only
396 available if the GOST algorithms are also available through
397 loading an externally supplied engine.
400 Don't generate dependencies.
403 Don't build support for writing multiple records in one
404 go in libssl (Note: this is a different capability to the
405 pipelining functionality).
408 Don't build support for the NPN TLS extension.
411 Don't build support for OCSP.
415 Don't build the padlock engine.
416 ('no-hw-padlock' is deprecated and should not be used)
419 Don't build with support for Position Independent Code.
421 no-pinshared By default OpenSSL will attempt to stay in memory until the
422 process exits. This is so that libcrypto and libssl can be
423 properly cleaned up automatically via an "atexit()" handler.
424 The handler is registered by libcrypto and cleans up both
425 libraries. On some platforms the atexit() handler will run on
426 unload of libcrypto (if it has been dynamically loaded)
427 rather than at process exit. This option can be used to stop
428 OpenSSL from attempting to stay in memory until the process
429 exits. This could lead to crashes if either libcrypto or
430 libssl have already been unloaded at the point
431 that the atexit handler is invoked, e.g. on a platform which
432 calls atexit() on unload of the library, and libssl is
433 unloaded before libcrypto then a crash is likely to happen.
434 Applications can suppress running of the atexit() handler at
435 run time by using the OPENSSL_INIT_NO_ATEXIT option to
436 OPENSSL_init_crypto(). See the man page for it for further
440 Don't use POSIX IO capabilities.
443 Don't build support for Pre-Shared Key based ciphersuites.
446 Don't use hardware RDRAND capabilities.
449 Don't build support for RFC3779 ("X.509 Extensions for IP
450 Addresses and AS Identifiers")
453 Build support for SCTP
456 Do not create shared libraries, only static ones. See "Note
457 on shared libraries" below.
460 Don't build support for socket BIOs
463 Don't build support for SRP or SRP based ciphersuites.
466 Don't build SRTP support
469 Exclude SSE2 code paths from 32-bit x86 assembly modules.
470 Normally SSE2 extension is detected at run-time, but the
471 decision whether or not the machine code will be executed
472 is taken solely on CPU capability vector. This means that
473 if you happen to run OS kernel which does not support SSE2
474 extension on Intel P4 processor, then your application
475 might be exposed to "illegal instruction" exception.
476 There might be a way to enable support in kernel, e.g.
477 FreeBSD kernel can be compiled with CPU_ENABLE_SSE, and
478 there is a way to disengage SSE2 code paths upon application
479 start-up, but if you aim for wider "audience" running
480 such kernel, consider no-sse2. Both the 386 and
481 no-asm options imply no-sse2.
484 Build with the SSL Trace capabilities (adds the "-trace"
485 option to s_client and s_server).
488 Don't build the statically linked engines. This only
489 has an impact when not built "shared".
492 Don't use anything from the C header file "stdio.h" that
493 makes use of the "FILE" type. Only libcrypto and libssl can
494 be built in this way. Using this option will suppress
495 building the command line applications. Additionally since
496 the OpenSSL tests also use the command line applications the
497 tests will also be skipped.
500 Don't build test programs or run any test.
503 Don't try to build with support for multi-threaded
507 Build with support for multi-threaded applications. Most
508 platforms will enable this by default. However if on a
509 platform where this is not the case then this will usually
510 require additional system-dependent options! See "Note on
511 multi-threading" below.
514 Don't build Time Stamping Authority support.
517 Build with the Undefined Behaviour sanitiser. This is a
518 developer option only. It may not work on all platforms and
519 should never be used in production environments. It will only
520 work when used with gcc or clang and should be used in
521 conjunction with the "-DPEDANTIC" option (or the
522 --strict-warnings option).
525 Don't build with the "UI" capability (i.e. the set of
526 features enabling text based prompts).
529 Enable additional unit test APIs. This should not typically
530 be used in production deployments.
532 enable-weak-ssl-ciphers
533 Build support for SSL/TLS ciphers that are considered "weak"
534 (e.g. RC4 based ciphersuites).
537 Build with support for zlib compression/decompression.
540 Like "zlib", but has OpenSSL load the zlib library
541 dynamically when needed. This is only supported on systems
542 where loading of shared libraries is supported.
545 In 32-bit x86 builds, when generating assembly modules,
546 use the 80386 instruction set only (the default x86 code
547 is more efficient, but requires at least a 486). Note:
548 This doesn't affect code generated by compiler, you're
549 likely to complement configuration command line with
550 suitable compiler-specific option.
553 Don't build support for negotiating the specified SSL/TLS
554 protocol (one of ssl, ssl3, tls, tls1, tls1_1, tls1_2,
555 tls1_3, dtls, dtls1 or dtls1_2). If "no-tls" is selected then
556 all of tls1, tls1_1, tls1_2 and tls1_3 are disabled.
557 Similarly "no-dtls" will disable dtls1 and dtls1_2. The
558 "no-ssl" option is synonymous with "no-ssl3". Note this only
559 affects version negotiation. OpenSSL will still provide the
560 methods for applications to explicitly select the individual
564 As for no-<prot> but in addition do not build the methods for
565 applications to explicitly select individual protocol
566 versions. Note that there is no "no-tls1_3-method" option
567 because there is no application method for TLSv1.3. Using
568 individual protocol methods directly is deprecated.
569 Applications should use TLS_method() instead.
572 Build with support for the specified algorithm, where <alg>
573 is one of: md2 or rc5.
576 Build without support for the specified algorithm, where
577 <alg> is one of: aria, bf, blake2, camellia, cast, chacha,
578 cmac, des, dh, dsa, ecdh, ecdsa, idea, md4, mdc2, ocb,
579 poly1305, rc2, rc4, rmd160, scrypt, seed, siphash, siv, sm2,
580 sm3, sm4 or whirlpool. The "ripemd" algorithm is deprecated
581 and if used is synonymous with rmd160.
583 -Dxxx, -Ixxx, -Wp, -lxxx, -Lxxx, -Wl, -rpath, -R, -framework, -static
584 These system specific options will be recognised and
585 passed through to the compiler to allow you to define
586 preprocessor symbols, specify additional libraries, library
587 directories or other compiler options. It might be worth
588 noting that some compilers generate code specifically for
589 processor the compiler currently executes on. This is not
590 necessarily what you might have in mind, since it might be
591 unsuitable for execution on other, typically older,
592 processor. Consult your compiler documentation.
594 Take note of the VAR=value documentation below and how
595 these flags interact with those variables.
598 Additional options that are not otherwise recognised are
599 passed through as they are to the compiler as well. Again,
600 consult your compiler documentation.
602 Take note of the VAR=value documentation below and how
603 these flags interact with those variables.
606 Assignment of environment variable for Configure. These
607 work just like normal environment variable assignments,
608 but are supported on all platforms and are confined to
609 the configuration scripts only. These assignments override
610 the corresponding value in the inherited environment, if
613 The following variables are used as "make variables" and
614 can be used as an alternative to giving preprocessor,
615 compiler and linker options directly as configuration.
616 The following variables are supported:
618 AR The static library archiver.
619 ARFLAGS Flags for the static library archiver.
620 AS The assembler compiler.
621 ASFLAGS Flags for the assembler compiler.
623 CFLAGS Flags for the C compiler.
624 CXX The C++ compiler.
625 CXXFLAGS Flags for the C++ compiler.
626 CPP The C/C++ preprocessor.
627 CPPFLAGS Flags for the C/C++ preprocessor.
628 CPPDEFINES List of CPP macro definitions, separated
629 by a platform specific character (':' or
630 space for Unix, ';' for Windows, ',' for
631 VMS). This can be used instead of using
632 -D (or what corresponds to that on your
633 compiler) in CPPFLAGS.
634 CPPINCLUDES List of CPP inclusion directories, separated
635 the same way as for CPPDEFINES. This can
636 be used instead of -I (or what corresponds
637 to that on your compiler) in CPPFLAGS.
638 HASHBANGPERL Perl invocation to be inserted after '#!'
639 in public perl scripts (only relevant on
641 LD The program linker (not used on Unix, $(CC)
643 LDFLAGS Flags for the shared library, DSO and
645 LDLIBS Extra libraries to use when linking.
646 Takes the form of a space separated list
647 of library specifications on Unix and
648 Windows, and as a comma separated list of
650 RANLIB The library archive indexer.
651 RC The Windows resource compiler.
652 RCFLAGS Flags for the Windows resource compiler.
653 RM The command to remove files and directories.
655 These cannot be mixed with compiling / linking flags given
656 on the command line. In other words, something like this
659 ./config -DFOO CPPFLAGS=-DBAR -DCOOKIE
661 Backward compatibility note:
663 To be compatible with older configuration scripts, the
664 environment variables are ignored if compiling / linking
665 flags are given on the command line, except for these:
667 AR, CC, CXX, CROSS_COMPILE, HASHBANGPERL, PERL, RANLIB, RC
670 For example, the following command will not see -DBAR:
672 CPPFLAGS=-DBAR ./config -DCOOKIE
674 However, the following will see both set variables:
676 CC=gcc CROSS_COMPILE=x86_64-w64-mingw32- \
681 Reconfigure from earlier data. This fetches the previous
682 command line options and environment from data saved in
683 "configdata.pm", and runs the configuration process again,
684 using these options and environment.
685 Note: NO other option is permitted together with "reconf".
686 This means that you also MUST use "./Configure" (or
687 what corresponds to that on non-Unix platforms) directly
688 to invoke this option.
689 Note: The original configuration saves away values for ALL
690 environment variables that were used, and if they weren't
691 defined, they are still saved away with information that
692 they weren't originally defined. This information takes
693 precedence over environment variables that are defined
696 Displaying configuration data
697 -----------------------------
699 The configuration script itself will say very little, and finishes by
700 creating "configdata.pm". This perl module can be loaded by other scripts
701 to find all the configuration data, and it can also be used as a script to
702 display all sorts of configuration data in a human readable form.
704 For more information, please do:
706 $ ./configdata.pm --help # Unix
710 $ perl configdata.pm --help # Windows and VMS
712 Installation in Detail
713 ----------------------
715 1a. Configure OpenSSL for your operation system automatically:
717 NOTE: This is not available on Windows.
719 $ ./config [[ options ]] # Unix
723 $ @config [[ options ]] ! OpenVMS
725 For the remainder of this text, the Unix form will be used in all
726 examples, please use the appropriate form for your platform.
728 This guesses at your operating system (and compiler, if necessary) and
729 configures OpenSSL based on this guess. Run ./config -t to see
730 if it guessed correctly. If you want to use a different compiler, you
731 are cross-compiling for another platform, or the ./config guess was
732 wrong for other reasons, go to step 1b. Otherwise go to step 2.
734 On some systems, you can include debugging information as follows:
736 $ ./config -d [[ options ]]
738 1b. Configure OpenSSL for your operating system manually
740 OpenSSL knows about a range of different operating system, hardware and
741 compiler combinations. To see the ones it knows about, run
747 $ perl Configure # All other platforms
749 For the remainder of this text, the Unix form will be used in all
750 examples, please use the appropriate form for your platform.
752 Pick a suitable name from the list that matches your system. For most
753 operating systems there is a choice between using "cc" or "gcc". When
754 you have identified your system (and if necessary compiler) use this name
755 as the argument to Configure. For example, a "linux-elf" user would
758 $ ./Configure linux-elf [[ options ]]
760 If your system isn't listed, you will have to create a configuration
761 file named Configurations/{{ something }}.conf and add the correct
762 configuration for your system. See the available configs as examples
763 and read Configurations/README and Configurations/README.design for
766 The generic configurations "cc" or "gcc" should usually work on 32 bit
769 Configure creates a build file ("Makefile" on Unix, "makefile" on Windows
770 and "descrip.mms" on OpenVMS) from a suitable template in Configurations,
771 and defines various macros in include/openssl/opensslconf.h (generated from
772 include/openssl/opensslconf.h.in).
774 1c. Configure OpenSSL for building outside of the source tree.
776 OpenSSL can be configured to build in a build directory separate from
777 the directory with the source code. It's done by placing yourself in
778 some other directory and invoking the configuration commands from
783 $ mkdir /var/tmp/openssl-build
784 $ cd /var/tmp/openssl-build
785 $ /PATH/TO/OPENSSL/SOURCE/config [[ options ]]
789 $ /PATH/TO/OPENSSL/SOURCE/Configure {{ target }} [[ options ]]
793 $ set default sys$login:
794 $ create/dir [.tmp.openssl-build]
795 $ set default [.tmp.openssl-build]
796 $ @[PATH.TO.OPENSSL.SOURCE]config [[ options ]]
800 $ @[PATH.TO.OPENSSL.SOURCE]Configure {{ target }} [[ options ]]
805 $ mkdir \temp-openssl
807 $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure {{ target }} [[ options ]]
809 Paths can be relative just as well as absolute. Configure will
810 do its best to translate them to relative paths whenever possible.
812 2. Build OpenSSL by running:
815 $ mms ! (or mmk) OpenVMS
818 This will build the OpenSSL libraries (libcrypto.a and libssl.a on
819 Unix, corresponding on other platforms) and the OpenSSL binary
820 ("openssl"). The libraries will be built in the top-level directory,
821 and the binary will be in the "apps" subdirectory.
825 If the build fails, look at the output. There may be reasons
826 for the failure that aren't problems in OpenSSL itself (like
827 missing standard headers).
829 If the build succeeded previously, but fails after a source or
830 configuration change, it might be helpful to clean the build tree
831 before attempting another build. Use this command:
834 $ mms clean ! (or mmk) OpenVMS
835 $ nmake clean # Windows
837 Assembler error messages can sometimes be sidestepped by using the
838 "no-asm" configuration option.
840 Compiling parts of OpenSSL with gcc and others with the system
841 compiler will result in unresolved symbols on some systems.
843 If you are still having problems you can get help by sending an email
844 to the openssl-users email list (see
845 https://www.openssl.org/community/mailinglists.html for details). If
846 it is a bug with OpenSSL itself, please open an issue on GitHub, at
847 https://github.com/openssl/openssl/issues. Please review the existing
848 ones first; maybe the bug was already reported or has already been
851 3. After a successful build, the libraries should be tested. Run:
855 $ nmake test # Windows
857 NOTE: you MUST run the tests from an unprivileged account (or
858 disable your privileges temporarily if your platform allows it).
860 If some tests fail, look at the output. There may be reasons for
861 the failure that isn't a problem in OpenSSL itself (like a
862 malfunction with Perl). You may want increased verbosity, that
863 can be accomplished like this:
865 $ make VERBOSE=1 test # Unix
867 $ mms /macro=(VERBOSE=1) test ! OpenVMS
869 $ nmake VERBOSE=1 test # Windows
871 If you want to run just one or a few specific tests, you can use
872 the make variable TESTS to specify them, like this:
874 $ make TESTS='test_rsa test_dsa' test # Unix
875 $ mms/macro="TESTS=test_rsa test_dsa" test ! OpenVMS
876 $ nmake TESTS='test_rsa test_dsa' test # Windows
878 And of course, you can combine (Unix example shown):
880 $ make VERBOSE=1 TESTS='test_rsa test_dsa' test
882 You can find the list of available tests like this:
884 $ make list-tests # Unix
885 $ mms list-tests ! OpenVMS
886 $ nmake list-tests # Windows
888 Have a look at the manual for the perl module Test::Harness to
889 see what other HARNESS_* variables there are.
891 If you find a problem with OpenSSL itself, try removing any
892 compiler optimization flags from the CFLAGS line in Makefile and
893 run "make clean; make" or corresponding.
895 To report a bug please open an issue on GitHub, at
896 https://github.com/openssl/openssl/issues.
898 For more details on how the make variables TESTS can be used,
899 see section TESTS in Detail below.
901 4. If everything tests ok, install OpenSSL with
903 $ make install # Unix
904 $ mms install ! OpenVMS
905 $ nmake install # Windows
907 This will install all the software components in this directory
908 tree under PREFIX (the directory given with --prefix or its
913 bin/ Contains the openssl binary and a few other
916 Contains the header files needed if you want
917 to build your own programs that use libcrypto
919 lib Contains the OpenSSL library files.
920 lib/engines Contains the OpenSSL dynamically loadable engines.
922 share/man/man1 Contains the OpenSSL command line man-pages.
923 share/man/man3 Contains the OpenSSL library calls man-pages.
924 share/man/man5 Contains the OpenSSL configuration format man-pages.
925 share/man/man7 Contains the OpenSSL other misc man-pages.
927 share/doc/openssl/html/man1
928 share/doc/openssl/html/man3
929 share/doc/openssl/html/man5
930 share/doc/openssl/html/man7
931 Contains the HTML rendition of the man-pages.
933 OpenVMS ('arch' is replaced with the architecture name, "Alpha"
934 or "ia64", 'sover' is replaced with the shared library version
935 (0101 for 1.1), and 'pz' is replaced with the pointer size
936 OpenSSL was built with):
938 [.EXE.'arch'] Contains the openssl binary.
939 [.EXE] Contains a few utility scripts.
941 Contains the header files needed if you want
942 to build your own programs that use libcrypto
944 [.LIB.'arch'] Contains the OpenSSL library files.
945 [.ENGINES'sover''pz'.'arch']
946 Contains the OpenSSL dynamically loadable engines.
947 [.SYS$STARTUP] Contains startup, login and shutdown scripts.
948 These define appropriate logical names and
950 [.SYSTEST] Contains the installation verification procedure.
951 [.HTML] Contains the HTML rendition of the manual pages.
954 Additionally, install will add the following directories under
955 OPENSSLDIR (the directory given with --openssldir or its default)
958 certs Initially empty, this is the default location
959 for certificate files.
960 private Initially empty, this is the default location
961 for private key files.
962 misc Various scripts.
964 Package builders who want to configure the library for standard
965 locations, but have the package installed somewhere else so that
966 it can easily be packaged, can use
968 $ make DESTDIR=/tmp/package-root install # Unix
969 $ mms/macro="DESTDIR=TMP:[PACKAGE-ROOT]" install ! OpenVMS
971 The specified destination directory will be prepended to all
972 installation target paths.
974 Compatibility issues with previous OpenSSL versions:
976 * COMPILING existing applications
978 Starting with version 1.1.0, OpenSSL hides a number of structures
979 that were previously open. This includes all internal libssl
980 structures and a number of EVP types. Accessor functions have
981 been added to allow controlled access to the structures' data.
983 This means that some software needs to be rewritten to adapt to
984 the new ways of doing things. This often amounts to allocating
985 an instance of a structure explicitly where you could previously
986 allocate them on the stack as automatic variables, and using the
987 provided accessor functions where you would previously access a
988 structure's field directly.
990 Some APIs have changed as well. However, older APIs have been
991 preserved when possible.
993 Environment Variables
994 ---------------------
996 A number of environment variables can be used to provide additional control
997 over the build process. Typically these should be defined prior to running
998 config or Configure. Not all environment variables are relevant to all
1002 The name of the ar executable to use.
1005 Use a different build file name than the platform default
1006 ("Makefile" on Unix-like platforms, "makefile" on native Windows,
1007 "descrip.mms" on OpenVMS). This requires that there is a
1008 corresponding build file template. See Configurations/README
1009 for further information.
1012 The compiler to use. Configure will attempt to pick a default
1013 compiler for your platform but this choice can be overridden
1014 using this variable. Set it to the compiler executable you wish
1015 to use, e.g. "gcc" or "clang".
1018 This environment variable has the same meaning as for the
1019 "--cross-compile-prefix" Configure flag described above. If both
1020 are set then the Configure flag takes precedence.
1023 The name of the nm executable to use.
1025 OPENSSL_LOCAL_CONFIG_DIR
1026 OpenSSL comes with a database of information about how it
1027 should be built on different platforms as well as build file
1028 templates for those platforms. The database is comprised of
1029 ".conf" files in the Configurations directory. The build
1030 file templates reside there as well as ".tmpl" files. See the
1031 file Configurations/README for further information about the
1032 format of ".conf" files as well as information on the ".tmpl"
1034 In addition to the standard ".conf" and ".tmpl" files, it is
1035 possible to create your own ".conf" and ".tmpl" files and store
1036 them locally, outside the OpenSSL source tree. This environment
1037 variable can be set to the directory where these files are held
1038 and will be considered by Configure before it looks in the
1039 standard directories.
1042 The name of the Perl executable to use when building OpenSSL.
1043 This variable is used in config script only. Configure on the
1044 other hand imposes the interpreter by which it itself was
1045 executed on the whole build procedure.
1048 The command string for the Perl executable to insert in the
1049 #! line of perl scripts that will be publically installed.
1050 Default: /usr/bin/env perl
1051 Note: the value of this variable is added to the same scripts
1052 on all platforms, but it's only relevant on Unix-like platforms.
1055 The name of the rc executable to use. The default will be as
1056 defined for the target platform in the ".conf" file. If not
1057 defined then "windres" will be used. The WINDRES environment
1058 variable is synonymous to this. If both are defined then RC
1062 The name of the ranlib executable to use.
1070 The Configure script generates a Makefile in a format relevant to the specific
1071 platform. The Makefiles provide a number of targets that can be used. Not all
1072 targets may be available on all platforms. Only the most common targets are
1073 described here. Examine the Makefiles themselves for the full list.
1076 The default target to build all the software components.
1079 Remove all build artefacts and return the directory to a "clean"
1083 Rebuild the dependencies in the Makefiles. This is a legacy
1084 option that no longer needs to be used since OpenSSL 1.1.0.
1087 Install all OpenSSL components.
1090 Only install the OpenSSL software components.
1093 Only install the OpenSSL documentation components.
1096 Only install the OpenSSL man pages (Unix only).
1099 Only install the OpenSSL html documentation.
1102 Prints a list of all the self test names.
1105 Build and run the OpenSSL self tests.
1108 Uninstall all OpenSSL components.
1112 Re-run the configuration process, as exactly as the last time
1116 This is a developer option. If you are developing a patch for
1117 OpenSSL you may need to use this if you want to update
1118 automatically generated files; add new error codes or add new
1119 (or change the visibility of) public API functions. (Unix only).
1124 The make variable TESTS supports a versatile set of space separated tokens
1125 with which you can specify a set of tests to be performed. With a "current
1126 set of tests" in mind, initially being empty, here are the possible tokens:
1128 alltests The current set of tests becomes the whole set of available
1129 tests (as listed when you do 'make list-tests' or similar).
1130 xxx Adds the test 'xxx' to the current set of tests.
1131 -xxx Removes 'xxx' from the current set of tests. If this is the
1132 first token in the list, the current set of tests is first
1133 assigned the whole set of available tests, effectively making
1134 this token equivalent to TESTS="alltests -xxx".
1135 nn Adds the test group 'nn' (which is a number) to the current
1137 -nn Removes the test group 'nn' from the current set of tests.
1138 If this is the first token in the list, the current set of
1139 tests is first assigned the whole set of available tests,
1140 effectively making this token equivalent to
1141 TESTS="alltests -xxx".
1143 Also, all tokens except for "alltests" may have wildcards, such as *.
1144 (on Unix and Windows, BSD style wildcards are supported, while on VMS,
1145 it's VMS style wildcards)
1147 Example: All tests except for the fuzz tests:
1149 $ make TESTS=-test_fuzz test
1151 or (if you want to be explicit)
1153 $ make TESTS='alltests -test_fuzz' test
1155 Example: All tests that have a name starting with "test_ssl" but not those
1156 starting with "test_ssl_":
1158 $ make TESTS='test_ssl* -test_ssl_*' test
1160 Example: Only test group 10:
1164 Example: All tests except the slow group (group 99):
1168 Example: All tests in test groups 80 to 99 except for tests in group 90:
1170 $ make TESTS='[89]? -90'
1172 Note on multi-threading
1173 -----------------------
1175 For some systems, the OpenSSL Configure script knows what compiler options
1176 are needed to generate a library that is suitable for multi-threaded
1177 applications. On these systems, support for multi-threading is enabled
1178 by default; use the "no-threads" option to disable (this should never be
1181 On other systems, to enable support for multi-threading, you will have
1182 to specify at least two options: "threads", and a system-dependent option.
1183 (The latter is "-D_REENTRANT" on various systems.) The default in this
1184 case, obviously, is not to include support for multi-threading (but
1185 you can still use "no-threads" to suppress an annoying warning message
1186 from the Configure script.)
1188 OpenSSL provides built-in support for two threading models: pthreads (found on
1189 most UNIX/Linux systems), and Windows threads. No other threading models are
1190 supported. If your platform does not provide pthreads or Windows threads then
1191 you should Configure with the "no-threads" option.
1193 Notes on shared libraries
1194 -------------------------
1196 For most systems the OpenSSL Configure script knows what is needed to
1197 build shared libraries for libcrypto and libssl. On these systems
1198 the shared libraries will be created by default. This can be suppressed and
1199 only static libraries created by using the "no-shared" option. On systems
1200 where OpenSSL does not know how to build shared libraries the "no-shared"
1201 option will be forced and only static libraries will be created.
1203 Shared libraries are named a little differently on different platforms.
1204 One way or another, they all have the major OpenSSL version number as
1205 part of the file name, i.e. for OpenSSL 1.1.x, 1.1 is somehow part of
1208 On most POSIX platforms, shared libraries are named libcrypto.so.1.1
1211 on Cygwin, shared libraries are named cygcrypto-1.1.dll and cygssl-1.1.dll
1212 with import libraries libcrypto.dll.a and libssl.dll.a.
1214 On Windows build with MSVC or using MingW, shared libraries are named
1215 libcrypto-1_1.dll and libssl-1_1.dll for 32-bit Windows, libcrypto-1_1-x64.dll
1216 and libssl-1_1-x64.dll for 64-bit x86_64 Windows, and libcrypto-1_1-ia64.dll
1217 and libssl-1_1-ia64.dll for IA64 Windows. With MSVC, the import libraries
1218 are named libcrypto.lib and libssl.lib, while with MingW, they are named
1219 libcrypto.dll.a and libssl.dll.a.
1221 On VMS, shareable images (VMS speak for shared libraries) are named
1222 ossl$libcrypto0101_shr.exe and ossl$libssl0101_shr.exe. However, when
1223 OpenSSL is specifically built for 32-bit pointers, the shareable images
1224 are named ossl$libcrypto0101_shr32.exe and ossl$libssl0101_shr32.exe
1225 instead, and when built for 64-bit pointers, they are named
1226 ossl$libcrypto0101_shr64.exe and ossl$libssl0101_shr64.exe.
1228 Note on random number generation
1229 --------------------------------
1231 Availability of cryptographically secure random numbers is required for
1232 secret key generation. OpenSSL provides several options to seed the
1233 internal CSPRNG. If not properly seeded, the internal CSPRNG will refuse
1234 to deliver random bytes and a "PRNG not seeded error" will occur.
1236 The seeding method can be configured using the --with-rand-seed option,
1237 which can be used to specify a comma separated list of seed methods.
1238 However in most cases OpenSSL will choose a suitable default method,
1239 so it is not necessary to explicitly provide this option. Note also
1240 that not all methods are available on all platforms.
1242 I) On operating systems which provide a suitable randomness source (in
1243 form of a system call or system device), OpenSSL will use the optimal
1244 available method to seed the CSPRNG from the operating system's
1245 randomness sources. This corresponds to the option --with-rand-seed=os.
1247 II) On systems without such a suitable randomness source, automatic seeding
1248 and reseeding is disabled (--with-rand-seed=none) and it may be necessary
1249 to install additional support software to obtain a random seed and reseed
1250 the CSPRNG manually. Please check out the manual pages for RAND_add(),
1251 RAND_bytes(), RAND_egd(), and the FAQ for more information.
projects / openssl.git / blob