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 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).
398 Don't compile the FIPS module
400 enable-fuzz-libfuzzer, enable-fuzz-afl
401 Build with support for fuzzing using either libfuzzer or AFL.
402 These are developer options only. They may not work on all
403 platforms and should never be used in production environments.
404 See the file fuzz/README.md for further details.
407 Don't build support for GOST based ciphersuites. Note that
408 if this feature is enabled then GOST ciphersuites are only
409 available if the GOST algorithms are also available through
410 loading an externally supplied engine.
413 Don't build the legacy provider. Disabling this also disables
414 the legacy algorithms: MD2 (already disabled by default).
417 Don't generate dependencies.
420 Don't build any dynamically loadable engines. This also
421 implies 'no-dynamic-engine'.
424 Don't build support for writing multiple records in one
425 go in libssl (Note: this is a different capability to the
426 pipelining functionality).
429 Don't build support for the NPN TLS extension.
432 Don't build support for OCSP.
436 Don't build the padlock engine.
437 ('no-hw-padlock' is deprecated and should not be used)
440 Don't build with support for Position Independent Code.
442 no-pinshared By default OpenSSL will attempt to stay in memory until the
443 process exits. This is so that libcrypto and libssl can be
444 properly cleaned up automatically via an "atexit()" handler.
445 The handler is registered by libcrypto and cleans up both
446 libraries. On some platforms the atexit() handler will run on
447 unload of libcrypto (if it has been dynamically loaded)
448 rather than at process exit. This option can be used to stop
449 OpenSSL from attempting to stay in memory until the process
450 exits. This could lead to crashes if either libcrypto or
451 libssl have already been unloaded at the point
452 that the atexit handler is invoked, e.g. on a platform which
453 calls atexit() on unload of the library, and libssl is
454 unloaded before libcrypto then a crash is likely to happen.
455 Applications can suppress running of the atexit() handler at
456 run time by using the OPENSSL_INIT_NO_ATEXIT option to
457 OPENSSL_init_crypto(). See the man page for it for further
461 Don't use POSIX IO capabilities.
464 Don't build support for Pre-Shared Key based ciphersuites.
467 Don't use hardware RDRAND capabilities.
470 Don't build support for RFC3779 ("X.509 Extensions for IP
471 Addresses and AS Identifiers")
474 Build support for SCTP
477 Do not create shared libraries, only static ones. See "Note
478 on shared libraries" below.
481 Don't build support for socket BIOs
484 Don't build support for SRP or SRP based ciphersuites.
487 Don't build SRTP support
490 Exclude SSE2 code paths from 32-bit x86 assembly modules.
491 Normally SSE2 extension is detected at run-time, but the
492 decision whether or not the machine code will be executed
493 is taken solely on CPU capability vector. This means that
494 if you happen to run OS kernel which does not support SSE2
495 extension on Intel P4 processor, then your application
496 might be exposed to "illegal instruction" exception.
497 There might be a way to enable support in kernel, e.g.
498 FreeBSD kernel can be compiled with CPU_ENABLE_SSE, and
499 there is a way to disengage SSE2 code paths upon application
500 start-up, but if you aim for wider "audience" running
501 such kernel, consider no-sse2. Both the 386 and
502 no-asm options imply no-sse2.
505 Build with the SSL Trace capabilities (adds the "-trace"
506 option to s_client and s_server).
509 Don't build the statically linked engines. This only
510 has an impact when not built "shared".
513 Don't use anything from the C header file "stdio.h" that
514 makes use of the "FILE" type. Only libcrypto and libssl can
515 be built in this way. Using this option will suppress
516 building the command line applications. Additionally since
517 the OpenSSL tests also use the command line applications the
518 tests will also be skipped.
521 Don't build test programs or run any test.
524 Don't try to build with support for multi-threaded
528 Build with support for multi-threaded applications. Most
529 platforms will enable this by default. However if on a
530 platform where this is not the case then this will usually
531 require additional system-dependent options! See "Note on
532 multi-threading" below.
535 Build with support for the integrated tracing api. See manual pages
536 OSSL_trace_set_channel(3) and OSSL_trace_enabled(3) for details.
539 Don't build Time Stamping Authority support.
542 Build with the Undefined Behaviour sanitiser. This is a
543 developer option only. It may not work on all platforms and
544 should never be used in production environments. It will only
545 work when used with gcc or clang and should be used in
546 conjunction with the "-DPEDANTIC" option (or the
547 --strict-warnings option).
550 Don't build with the "UI" capability (i.e. the set of
551 features enabling text based prompts).
554 Enable additional unit test APIs. This should not typically
555 be used in production deployments.
557 enable-weak-ssl-ciphers
558 Build support for SSL/TLS ciphers that are considered "weak"
559 (e.g. RC4 based ciphersuites).
562 Build with support for zlib compression/decompression.
565 Like "zlib", but has OpenSSL load the zlib library
566 dynamically when needed. This is only supported on systems
567 where loading of shared libraries is supported.
570 In 32-bit x86 builds, when generating assembly modules,
571 use the 80386 instruction set only (the default x86 code
572 is more efficient, but requires at least a 486). Note:
573 This doesn't affect code generated by compiler, you're
574 likely to complement configuration command line with
575 suitable compiler-specific option.
578 Don't build support for negotiating the specified SSL/TLS
579 protocol (one of ssl, ssl3, tls, tls1, tls1_1, tls1_2,
580 tls1_3, dtls, dtls1 or dtls1_2). If "no-tls" is selected then
581 all of tls1, tls1_1, tls1_2 and tls1_3 are disabled.
582 Similarly "no-dtls" will disable dtls1 and dtls1_2. The
583 "no-ssl" option is synonymous with "no-ssl3". Note this only
584 affects version negotiation. OpenSSL will still provide the
585 methods for applications to explicitly select the individual
589 As for no-<prot> but in addition do not build the methods for
590 applications to explicitly select individual protocol
591 versions. Note that there is no "no-tls1_3-method" option
592 because there is no application method for TLSv1.3. Using
593 individual protocol methods directly is deprecated.
594 Applications should use TLS_method() instead.
597 Build with support for the specified algorithm, where <alg>
598 is one of: md2 or rc5.
601 Build without support for the specified algorithm, where
602 <alg> is one of: aria, bf, blake2, camellia, cast, chacha,
603 cmac, des, dh, dsa, ecdh, ecdsa, idea, md4, mdc2, ocb,
604 poly1305, rc2, rc4, rmd160, scrypt, seed, siphash, siv, sm2,
605 sm3, sm4 or whirlpool. The "ripemd" algorithm is deprecated
606 and if used is synonymous with rmd160.
608 -Dxxx, -Ixxx, -Wp, -lxxx, -Lxxx, -Wl, -rpath, -R, -framework, -static
609 These system specific options will be recognised and
610 passed through to the compiler to allow you to define
611 preprocessor symbols, specify additional libraries, library
612 directories or other compiler options. It might be worth
613 noting that some compilers generate code specifically for
614 processor the compiler currently executes on. This is not
615 necessarily what you might have in mind, since it might be
616 unsuitable for execution on other, typically older,
617 processor. Consult your compiler documentation.
619 Take note of the VAR=value documentation below and how
620 these flags interact with those variables.
623 Additional options that are not otherwise recognised are
624 passed through as they are to the compiler as well. Again,
625 consult your compiler documentation.
627 Take note of the VAR=value documentation below and how
628 these flags interact with those variables.
631 Assignment of environment variable for Configure. These
632 work just like normal environment variable assignments,
633 but are supported on all platforms and are confined to
634 the configuration scripts only. These assignments override
635 the corresponding value in the inherited environment, if
638 The following variables are used as "make variables" and
639 can be used as an alternative to giving preprocessor,
640 compiler and linker options directly as configuration.
641 The following variables are supported:
643 AR The static library archiver.
644 ARFLAGS Flags for the static library archiver.
645 AS The assembler compiler.
646 ASFLAGS Flags for the assembler compiler.
648 CFLAGS Flags for the C compiler.
649 CXX The C++ compiler.
650 CXXFLAGS Flags for the C++ compiler.
651 CPP The C/C++ preprocessor.
652 CPPFLAGS Flags for the C/C++ preprocessor.
653 CPPDEFINES List of CPP macro definitions, separated
654 by a platform specific character (':' or
655 space for Unix, ';' for Windows, ',' for
656 VMS). This can be used instead of using
657 -D (or what corresponds to that on your
658 compiler) in CPPFLAGS.
659 CPPINCLUDES List of CPP inclusion directories, separated
660 the same way as for CPPDEFINES. This can
661 be used instead of -I (or what corresponds
662 to that on your compiler) in CPPFLAGS.
663 HASHBANGPERL Perl invocation to be inserted after '#!'
664 in public perl scripts (only relevant on
666 LD The program linker (not used on Unix, $(CC)
668 LDFLAGS Flags for the shared library, DSO and
670 LDLIBS Extra libraries to use when linking.
671 Takes the form of a space separated list
672 of library specifications on Unix and
673 Windows, and as a comma separated list of
675 RANLIB The library archive indexer.
676 RC The Windows resource compiler.
677 RCFLAGS Flags for the Windows resource compiler.
678 RM The command to remove files and directories.
680 These cannot be mixed with compiling / linking flags given
681 on the command line. In other words, something like this
684 ./config -DFOO CPPFLAGS=-DBAR -DCOOKIE
686 Backward compatibility note:
688 To be compatible with older configuration scripts, the
689 environment variables are ignored if compiling / linking
690 flags are given on the command line, except for these:
692 AR, CC, CXX, CROSS_COMPILE, HASHBANGPERL, PERL, RANLIB, RC
695 For example, the following command will not see -DBAR:
697 CPPFLAGS=-DBAR ./config -DCOOKIE
699 However, the following will see both set variables:
701 CC=gcc CROSS_COMPILE=x86_64-w64-mingw32- \
704 If CC is set, it is advisable to also set CXX to ensure
705 both C and C++ compilers are in the same "family". This
706 becomes relevant with 'enable-external-tests' and
707 'enable-buildtest-c++'.
711 Reconfigure from earlier data. This fetches the previous
712 command line options and environment from data saved in
713 "configdata.pm", and runs the configuration process again,
714 using these options and environment.
715 Note: NO other option is permitted together with "reconf".
716 This means that you also MUST use "./Configure" (or
717 what corresponds to that on non-Unix platforms) directly
718 to invoke this option.
719 Note: The original configuration saves away values for ALL
720 environment variables that were used, and if they weren't
721 defined, they are still saved away with information that
722 they weren't originally defined. This information takes
723 precedence over environment variables that are defined
726 Displaying configuration data
727 -----------------------------
729 The configuration script itself will say very little, and finishes by
730 creating "configdata.pm". This perl module can be loaded by other scripts
731 to find all the configuration data, and it can also be used as a script to
732 display all sorts of configuration data in a human readable form.
734 For more information, please do:
736 $ ./configdata.pm --help # Unix
740 $ perl configdata.pm --help # Windows and VMS
742 Installation in Detail
743 ----------------------
745 1a. Configure OpenSSL for your operation system automatically:
747 NOTE: This is not available on Windows.
749 $ ./config [[ options ]] # Unix
753 $ @config [[ options ]] ! OpenVMS
755 For the remainder of this text, the Unix form will be used in all
756 examples, please use the appropriate form for your platform.
758 This guesses at your operating system (and compiler, if necessary) and
759 configures OpenSSL based on this guess. Run ./config -t to see
760 if it guessed correctly. If you want to use a different compiler, you
761 are cross-compiling for another platform, or the ./config guess was
762 wrong for other reasons, go to step 1b. Otherwise go to step 2.
764 On some systems, you can include debugging information as follows:
766 $ ./config -d [[ options ]]
768 1b. Configure OpenSSL for your operating system manually
770 OpenSSL knows about a range of different operating system, hardware and
771 compiler combinations. To see the ones it knows about, run
777 $ perl Configure # All other platforms
779 For the remainder of this text, the Unix form will be used in all
780 examples, please use the appropriate form for your platform.
782 Pick a suitable name from the list that matches your system. For most
783 operating systems there is a choice between using "cc" or "gcc". When
784 you have identified your system (and if necessary compiler) use this name
785 as the argument to Configure. For example, a "linux-elf" user would
788 $ ./Configure linux-elf [[ options ]]
790 If your system isn't listed, you will have to create a configuration
791 file named Configurations/{{ something }}.conf and add the correct
792 configuration for your system. See the available configs as examples
793 and read Configurations/README and Configurations/README.design for
796 The generic configurations "cc" or "gcc" should usually work on 32 bit
799 Configure creates a build file ("Makefile" on Unix, "makefile" on Windows
800 and "descrip.mms" on OpenVMS) from a suitable template in Configurations,
801 and defines various macros in include/openssl/opensslconf.h (generated from
802 include/openssl/opensslconf.h.in).
804 1c. Configure OpenSSL for building outside of the source tree.
806 OpenSSL can be configured to build in a build directory separate from
807 the directory with the source code. It's done by placing yourself in
808 some other directory and invoking the configuration commands from
813 $ mkdir /var/tmp/openssl-build
814 $ cd /var/tmp/openssl-build
815 $ /PATH/TO/OPENSSL/SOURCE/config [[ options ]]
819 $ /PATH/TO/OPENSSL/SOURCE/Configure {{ target }} [[ options ]]
823 $ set default sys$login:
824 $ create/dir [.tmp.openssl-build]
825 $ set default [.tmp.openssl-build]
826 $ @[PATH.TO.OPENSSL.SOURCE]config [[ options ]]
830 $ @[PATH.TO.OPENSSL.SOURCE]Configure {{ target }} [[ options ]]
835 $ mkdir \temp-openssl
837 $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure {{ target }} [[ options ]]
839 Paths can be relative just as well as absolute. Configure will
840 do its best to translate them to relative paths whenever possible.
842 2. Build OpenSSL by running:
845 $ mms ! (or mmk) OpenVMS
848 This will build the OpenSSL libraries (libcrypto.a and libssl.a on
849 Unix, corresponding on other platforms) and the OpenSSL binary
850 ("openssl"). The libraries will be built in the top-level directory,
851 and the binary will be in the "apps" subdirectory.
855 If the build fails, look at the output. There may be reasons
856 for the failure that aren't problems in OpenSSL itself (like
857 missing standard headers).
859 If the build succeeded previously, but fails after a source or
860 configuration change, it might be helpful to clean the build tree
861 before attempting another build. Use this command:
864 $ mms clean ! (or mmk) OpenVMS
865 $ nmake clean # Windows
867 Assembler error messages can sometimes be sidestepped by using the
868 "no-asm" configuration option.
870 Compiling parts of OpenSSL with gcc and others with the system
871 compiler will result in unresolved symbols on some systems.
873 If you are still having problems you can get help by sending an email
874 to the openssl-users email list (see
875 https://www.openssl.org/community/mailinglists.html for details). If
876 it is a bug with OpenSSL itself, please open an issue on GitHub, at
877 https://github.com/openssl/openssl/issues. Please review the existing
878 ones first; maybe the bug was already reported or has already been
881 3. After a successful build, the libraries should be tested. Run:
885 $ nmake test # Windows
887 NOTE: you MUST run the tests from an unprivileged account (or
888 disable your privileges temporarily if your platform allows it).
890 If some tests fail, look at the output. There may be reasons for
891 the failure that isn't a problem in OpenSSL itself (like a
892 malfunction with Perl). You may want increased verbosity, that
893 can be accomplished like this:
895 $ make VERBOSE=1 test # Unix
897 $ mms /macro=(VERBOSE=1) test ! OpenVMS
899 $ nmake VERBOSE=1 test # Windows
901 If you want to run just one or a few specific tests, you can use
902 the make variable TESTS to specify them, like this:
904 $ make TESTS='test_rsa test_dsa' test # Unix
905 $ mms/macro="TESTS=test_rsa test_dsa" test ! OpenVMS
906 $ nmake TESTS='test_rsa test_dsa' test # Windows
908 And of course, you can combine (Unix example shown):
910 $ make VERBOSE=1 TESTS='test_rsa test_dsa' test
912 You can find the list of available tests like this:
914 $ make list-tests # Unix
915 $ mms list-tests ! OpenVMS
916 $ nmake list-tests # Windows
918 Have a look at the manual for the perl module Test::Harness to
919 see what other HARNESS_* variables there are.
921 If you find a problem with OpenSSL itself, try removing any
922 compiler optimization flags from the CFLAGS line in Makefile and
923 run "make clean; make" or corresponding.
925 To report a bug please open an issue on GitHub, at
926 https://github.com/openssl/openssl/issues.
928 For more details on how the make variables TESTS can be used,
929 see section TESTS in Detail below.
931 4. If everything tests ok, install OpenSSL with
933 $ make install # Unix
934 $ mms install ! OpenVMS
935 $ nmake install # Windows
937 This will install all the software components in this directory
938 tree under PREFIX (the directory given with --prefix or its
943 bin/ Contains the openssl binary and a few other
946 Contains the header files needed if you want
947 to build your own programs that use libcrypto
949 lib Contains the OpenSSL library files.
950 lib/engines Contains the OpenSSL dynamically loadable engines.
952 share/man/man1 Contains the OpenSSL command line man-pages.
953 share/man/man3 Contains the OpenSSL library calls man-pages.
954 share/man/man5 Contains the OpenSSL configuration format man-pages.
955 share/man/man7 Contains the OpenSSL other misc man-pages.
957 share/doc/openssl/html/man1
958 share/doc/openssl/html/man3
959 share/doc/openssl/html/man5
960 share/doc/openssl/html/man7
961 Contains the HTML rendition of the man-pages.
963 OpenVMS ('arch' is replaced with the architecture name, "Alpha"
964 or "ia64", 'sover' is replaced with the shared library version
965 (0101 for 1.1), and 'pz' is replaced with the pointer size
966 OpenSSL was built with):
968 [.EXE.'arch'] Contains the openssl binary.
969 [.EXE] Contains a few utility scripts.
971 Contains the header files needed if you want
972 to build your own programs that use libcrypto
974 [.LIB.'arch'] Contains the OpenSSL library files.
975 [.ENGINES'sover''pz'.'arch']
976 Contains the OpenSSL dynamically loadable engines.
977 [.SYS$STARTUP] Contains startup, login and shutdown scripts.
978 These define appropriate logical names and
980 [.SYSTEST] Contains the installation verification procedure.
981 [.HTML] Contains the HTML rendition of the manual pages.
984 Additionally, install will add the following directories under
985 OPENSSLDIR (the directory given with --openssldir or its default)
988 certs Initially empty, this is the default location
989 for certificate files.
990 private Initially empty, this is the default location
991 for private key files.
992 misc Various scripts.
994 Package builders who want to configure the library for standard
995 locations, but have the package installed somewhere else so that
996 it can easily be packaged, can use
998 $ make DESTDIR=/tmp/package-root install # Unix
999 $ mms/macro="DESTDIR=TMP:[PACKAGE-ROOT]" install ! OpenVMS
1001 The specified destination directory will be prepended to all
1002 installation target paths.
1004 Compatibility issues with previous OpenSSL versions:
1006 * COMPILING existing applications
1008 Starting with version 1.1.0, OpenSSL hides a number of structures
1009 that were previously open. This includes all internal libssl
1010 structures and a number of EVP types. Accessor functions have
1011 been added to allow controlled access to the structures' data.
1013 This means that some software needs to be rewritten to adapt to
1014 the new ways of doing things. This often amounts to allocating
1015 an instance of a structure explicitly where you could previously
1016 allocate them on the stack as automatic variables, and using the
1017 provided accessor functions where you would previously access a
1018 structure's field directly.
1020 Some APIs have changed as well. However, older APIs have been
1021 preserved when possible.
1023 Environment Variables
1024 ---------------------
1026 A number of environment variables can be used to provide additional control
1027 over the build process. Typically these should be defined prior to running
1028 config or Configure. Not all environment variables are relevant to all
1032 The name of the ar executable to use.
1035 Use a different build file name than the platform default
1036 ("Makefile" on Unix-like platforms, "makefile" on native Windows,
1037 "descrip.mms" on OpenVMS). This requires that there is a
1038 corresponding build file template. See Configurations/README
1039 for further information.
1042 The compiler to use. Configure will attempt to pick a default
1043 compiler for your platform but this choice can be overridden
1044 using this variable. Set it to the compiler executable you wish
1045 to use, e.g. "gcc" or "clang".
1048 This environment variable has the same meaning as for the
1049 "--cross-compile-prefix" Configure flag described above. If both
1050 are set then the Configure flag takes precedence.
1053 The name of the nm executable to use.
1055 OPENSSL_LOCAL_CONFIG_DIR
1056 OpenSSL comes with a database of information about how it
1057 should be built on different platforms as well as build file
1058 templates for those platforms. The database is comprised of
1059 ".conf" files in the Configurations directory. The build
1060 file templates reside there as well as ".tmpl" files. See the
1061 file Configurations/README for further information about the
1062 format of ".conf" files as well as information on the ".tmpl"
1064 In addition to the standard ".conf" and ".tmpl" files, it is
1065 possible to create your own ".conf" and ".tmpl" files and store
1066 them locally, outside the OpenSSL source tree. This environment
1067 variable can be set to the directory where these files are held
1068 and will be considered by Configure before it looks in the
1069 standard directories.
1072 The name of the Perl executable to use when building OpenSSL.
1073 This variable is used in config script only. Configure on the
1074 other hand imposes the interpreter by which it itself was
1075 executed on the whole build procedure.
1078 The command string for the Perl executable to insert in the
1079 #! line of perl scripts that will be publically installed.
1080 Default: /usr/bin/env perl
1081 Note: the value of this variable is added to the same scripts
1082 on all platforms, but it's only relevant on Unix-like platforms.
1085 The name of the rc executable to use. The default will be as
1086 defined for the target platform in the ".conf" file. If not
1087 defined then "windres" will be used. The WINDRES environment
1088 variable is synonymous to this. If both are defined then RC
1092 The name of the ranlib executable to use.
1100 The Configure script generates a Makefile in a format relevant to the specific
1101 platform. The Makefiles provide a number of targets that can be used. Not all
1102 targets may be available on all platforms. Only the most common targets are
1103 described here. Examine the Makefiles themselves for the full list.
1106 The default target to build all the software components.
1109 Remove all build artefacts and return the directory to a "clean"
1113 Rebuild the dependencies in the Makefiles. This is a legacy
1114 option that no longer needs to be used since OpenSSL 1.1.0.
1117 Install all OpenSSL components.
1120 Only install the OpenSSL software components.
1123 Only install the OpenSSL documentation components.
1126 Only install the OpenSSL man pages (Unix only).
1129 Only install the OpenSSL html documentation.
1132 Prints a list of all the self test names.
1135 Build and run the OpenSSL self tests.
1138 Uninstall all OpenSSL components.
1142 Re-run the configuration process, as exactly as the last time
1146 This is a developer option. If you are developing a patch for
1147 OpenSSL you may need to use this if you want to update
1148 automatically generated files; add new error codes or add new
1149 (or change the visibility of) public API functions. (Unix only).
1154 The make variable TESTS supports a versatile set of space separated tokens
1155 with which you can specify a set of tests to be performed. With a "current
1156 set of tests" in mind, initially being empty, here are the possible tokens:
1158 alltests The current set of tests becomes the whole set of available
1159 tests (as listed when you do 'make list-tests' or similar).
1160 xxx Adds the test 'xxx' to the current set of tests.
1161 -xxx Removes 'xxx' from the current set of tests. If this is the
1162 first token in the list, the current set of tests is first
1163 assigned the whole set of available tests, effectively making
1164 this token equivalent to TESTS="alltests -xxx".
1165 nn Adds the test group 'nn' (which is a number) to the current
1167 -nn Removes the test group 'nn' from the current set of tests.
1168 If this is the first token in the list, the current set of
1169 tests is first assigned the whole set of available tests,
1170 effectively making this token equivalent to
1171 TESTS="alltests -xxx".
1173 Also, all tokens except for "alltests" may have wildcards, such as *.
1174 (on Unix and Windows, BSD style wildcards are supported, while on VMS,
1175 it's VMS style wildcards)
1177 Example: All tests except for the fuzz tests:
1179 $ make TESTS=-test_fuzz test
1181 or (if you want to be explicit)
1183 $ make TESTS='alltests -test_fuzz' test
1185 Example: All tests that have a name starting with "test_ssl" but not those
1186 starting with "test_ssl_":
1188 $ make TESTS='test_ssl* -test_ssl_*' test
1190 Example: Only test group 10:
1194 Example: All tests except the slow group (group 99):
1198 Example: All tests in test groups 80 to 99 except for tests in group 90:
1200 $ make TESTS='[89]? -90'
1202 Note on multi-threading
1203 -----------------------
1205 For some systems, the OpenSSL Configure script knows what compiler options
1206 are needed to generate a library that is suitable for multi-threaded
1207 applications. On these systems, support for multi-threading is enabled
1208 by default; use the "no-threads" option to disable (this should never be
1211 On other systems, to enable support for multi-threading, you will have
1212 to specify at least two options: "threads", and a system-dependent option.
1213 (The latter is "-D_REENTRANT" on various systems.) The default in this
1214 case, obviously, is not to include support for multi-threading (but
1215 you can still use "no-threads" to suppress an annoying warning message
1216 from the Configure script.)
1218 OpenSSL provides built-in support for two threading models: pthreads (found on
1219 most UNIX/Linux systems), and Windows threads. No other threading models are
1220 supported. If your platform does not provide pthreads or Windows threads then
1221 you should Configure with the "no-threads" option.
1223 Notes on shared libraries
1224 -------------------------
1226 For most systems the OpenSSL Configure script knows what is needed to
1227 build shared libraries for libcrypto and libssl. On these systems
1228 the shared libraries will be created by default. This can be suppressed and
1229 only static libraries created by using the "no-shared" option. On systems
1230 where OpenSSL does not know how to build shared libraries the "no-shared"
1231 option will be forced and only static libraries will be created.
1233 Shared libraries are named a little differently on different platforms.
1234 One way or another, they all have the major OpenSSL version number as
1235 part of the file name, i.e. for OpenSSL 1.1.x, 1.1 is somehow part of
1238 On most POSIX platforms, shared libraries are named libcrypto.so.1.1
1241 on Cygwin, shared libraries are named cygcrypto-1.1.dll and cygssl-1.1.dll
1242 with import libraries libcrypto.dll.a and libssl.dll.a.
1244 On Windows build with MSVC or using MingW, shared libraries are named
1245 libcrypto-1_1.dll and libssl-1_1.dll for 32-bit Windows, libcrypto-1_1-x64.dll
1246 and libssl-1_1-x64.dll for 64-bit x86_64 Windows, and libcrypto-1_1-ia64.dll
1247 and libssl-1_1-ia64.dll for IA64 Windows. With MSVC, the import libraries
1248 are named libcrypto.lib and libssl.lib, while with MingW, they are named
1249 libcrypto.dll.a and libssl.dll.a.
1251 On VMS, shareable images (VMS speak for shared libraries) are named
1252 ossl$libcrypto0101_shr.exe and ossl$libssl0101_shr.exe. However, when
1253 OpenSSL is specifically built for 32-bit pointers, the shareable images
1254 are named ossl$libcrypto0101_shr32.exe and ossl$libssl0101_shr32.exe
1255 instead, and when built for 64-bit pointers, they are named
1256 ossl$libcrypto0101_shr64.exe and ossl$libssl0101_shr64.exe.
1258 Note on random number generation
1259 --------------------------------
1261 Availability of cryptographically secure random numbers is required for
1262 secret key generation. OpenSSL provides several options to seed the
1263 internal CSPRNG. If not properly seeded, the internal CSPRNG will refuse
1264 to deliver random bytes and a "PRNG not seeded error" will occur.
1266 The seeding method can be configured using the --with-rand-seed option,
1267 which can be used to specify a comma separated list of seed methods.
1268 However in most cases OpenSSL will choose a suitable default method,
1269 so it is not necessary to explicitly provide this option. Note also
1270 that not all methods are available on all platforms.
1272 I) On operating systems which provide a suitable randomness source (in
1273 form of a system call or system device), OpenSSL will use the optimal
1274 available method to seed the CSPRNG from the operating system's
1275 randomness sources. This corresponds to the option --with-rand-seed=os.
1277 II) On systems without such a suitable randomness source, automatic seeding
1278 and reseeding is disabled (--with-rand-seed=none) and it may be necessary
1279 to install additional support software to obtain a random seed and reseed
1280 the CSPRNG manually. Please check out the manual pages for RAND_add(),
1281 RAND_bytes(), RAND_egd(), and the FAQ for more information.
projects / openssl.git / blob