4 This document describes installation on all supported operating
5 systems (the Unix/Linux family (which includes Mac OS/X), OpenVMS,
8 To install OpenSSL, you will need:
10 * A make implementation
11 * Perl 5 with core modules (please read NOTES.PERL)
12 * The perl module Text::Template (please read NOTES.PERL)
14 * a development environment in the form of development libraries and C
16 * a supported operating system
18 For additional platform specific requirements, solutions to specific
19 issues and other details, please read one of these:
21 * NOTES.UNIX (any supported Unix like system)
23 * NOTES.WIN (any supported Windows)
24 * NOTES.DJGPP (DOS platform with DJGPP)
25 * NOTES.ANDROID (obviously Android [NDK])
26 * NOTES.VALGRIND (testing with Valgrind)
28 Notational conventions in this document
29 ---------------------------------------
31 Throughout this document, we use the following conventions in command
34 $ command Any line starting with a dollar sign
35 ($) is a command line.
37 { word1 | word2 | word3 } This denotes a mandatory choice, to be
38 replaced with one of the given words.
39 A simple example would be this:
41 $ echo { FOO | BAR | COOKIE }
43 which is to be understood as one of
52 [ word1 | word2 | word3 ] Similar to { word1 | word2 | word3 }
53 except it's optional to give any of
54 those. In addition to the examples
55 above, this would also be valid:
59 {{ target }} This denotes a mandatory word or
60 sequence of words of some sort. A
61 simple example would be this:
65 which is to be understood to use the
66 command 'type' on some file name
67 determined by the user.
69 [[ options ]] Similar to {{ target }}, but is
72 Note that the notation assumes spaces around {, }, [, ], {{, }} and
73 [[, ]]. This is to differentiate from OpenVMS directory
74 specifications, which also use [ and ], but without spaces.
79 If you want to just get on with it, do:
81 on Unix (again, this includes Mac OS/X):
95 on Windows (only pick one of the targets for configuration):
97 $ perl Configure { VC-WIN32 | VC-WIN64A | VC-WIN64I | VC-CE }
102 Note that in order to perform the install step above you need to have
103 appropriate permissions to write to the installation directory.
105 If any of these steps fails, see section Installation in Detail below.
107 This will build and install OpenSSL in the default location, which is:
109 Unix: normal installation directories under /usr/local
110 OpenVMS: SYS$COMMON:[OPENSSL-'version'...], where 'version' is the
111 OpenSSL version number with underscores instead of periods.
112 Windows: C:\Program Files\OpenSSL or C:\Program Files (x86)\OpenSSL
114 The installation directory should be appropriately protected to ensure
115 unprivileged users cannot make changes to OpenSSL binaries or files, or install
116 engines. If you already have a pre-installed version of OpenSSL as part of
117 your Operating System it is recommended that you do not overwrite the system
118 version and instead install to somewhere else.
120 If you want to install it anywhere else, run config like this:
124 $ ./config --prefix=/opt/openssl --openssldir=/usr/local/ssl
128 $ @config --prefix=PROGRAM:[INSTALLS] --openssldir=SYS$MANAGER:[OPENSSL]
130 (Note: if you do add options to the configuration command, please make sure
131 you've read more than just this Quick Start, such as relevant NOTES.* files,
132 the options outline below, as configuration options may change the outcome
133 in otherwise unexpected ways)
136 Configuration Options
137 ---------------------
139 There are several options to ./config (or ./Configure) to customize
140 the build (note that for Windows, the defaults for --prefix and
141 --openssldir depend in what configuration is used and what Windows
142 implementation OpenSSL is built on. More notes on this in NOTES.WIN):
145 Don't build with support for deprecated APIs below the
146 specified version number. For example "--api=1.1.0" will
147 remove support for all APIS that were deprecated in OpenSSL
148 version 1.1.0 or below.
150 --cross-compile-prefix=PREFIX
151 The PREFIX to include in front of commands for your
152 toolchain. It's likely to have to end with dash, e.g.
153 a-b-c- would invoke GNU compiler as a-b-c-gcc, etc.
154 Unfortunately cross-compiling is too case-specific to
155 put together one-size-fits-all instructions. You might
156 have to pass more flags or set up environment variables
157 to actually make it work. Android and iOS cases are
158 discussed in corresponding Configurations/15-*.conf
159 files. But there are cases when this option alone is
160 sufficient. For example to build the mingw64 target on
161 Linux "--cross-compile-prefix=x86_64-w64-mingw32-"
162 works. Naturally provided that mingw packages are
163 installed. Today Debian and Ubuntu users have option to
164 install a number of prepackaged cross-compilers along
165 with corresponding run-time and development packages for
166 "alien" hardware. To give another example
167 "--cross-compile-prefix=mipsel-linux-gnu-" suffices
168 in such case. Needless to mention that you have to
169 invoke ./Configure, not ./config, and pass your target
170 name explicitly. Also, note that --openssldir refers
171 to target's file system, not one you are building on.
174 Build OpenSSL with debugging symbols and zero optimization
178 The name of the directory under the top of the installation
179 directory tree (see the --prefix option) where libraries will
180 be installed. By default this is "lib". Note that on Windows
181 only ".lib" files will be stored in this location. dll files
182 will always be installed to the "bin" directory.
185 Directory for OpenSSL configuration files, and also the
186 default certificate and key store. Defaults are:
189 Windows: C:\Program Files\Common Files\SSL
190 or C:\Program Files (x86)\Common Files\SSL
191 OpenVMS: SYS$COMMON:[OPENSSL-COMMON]
194 The top of the installation directory tree. Defaults are:
197 Windows: C:\Program Files\OpenSSL
198 or C:\Program Files (x86)\OpenSSL
199 OpenVMS: SYS$COMMON:[OPENSSL-'version']
202 Build OpenSSL without debugging symbols. This is the default.
205 This is a developer flag that switches on various compiler
206 options recommended for OpenSSL development. It only works
207 when using gcc or clang as the compiler. If you are
208 developing a patch for OpenSSL then it is recommended that
209 you use this option where possible.
211 --with-zlib-include=DIR
212 The directory for the location of the zlib include file. This
213 option is only necessary if enable-zlib (see below) is used
214 and the include file is not already on the system include
218 On Unix: this is the directory containing the zlib library.
219 If not provided the system library path will be used.
220 On Windows: this is the filename of the zlib library (with or
221 without a path). This flag must be provided if the
222 zlib-dynamic option is not also used. If zlib-dynamic is used
223 then this flag is optional and a default value ("ZLIB1") is
224 used if not provided.
225 On VMS: this is the filename of the zlib library (with or
226 without a path). This flag is optional and if not provided
227 then "GNV$LIBZSHR", "GNV$LIBZSHR32" or "GNV$LIBZSHR64" is
228 used by default depending on the pointer size chosen.
231 --with-rand-seed=seed1[,seed2,...]
232 A comma separated list of seeding methods which will be tried
233 by OpenSSL in order to obtain random input (a.k.a "entropy")
234 for seeding its cryptographically secure random number
235 generator (CSPRNG). The current seeding methods are:
237 os: Use a trusted operating system entropy source.
238 This is the default method if such an entropy
240 getrandom: Use the L<getrandom(2)> or equivalent system
242 devrandom: Use the the first device from the DEVRANDOM list
243 which can be opened to read random bytes. The
244 DEVRANDOM preprocessor constant expands to
245 "/dev/urandom","/dev/random","/dev/srandom" on
246 most unix-ish operating systems.
247 egd: Check for an entropy generating daemon.
248 rdcpu: Use the RDSEED or RDRAND command if provided by
250 librandom: Use librandom (not implemented yet).
251 none: Disable automatic seeding. This is the default
252 on some operating systems where no suitable
253 entropy source exists, or no support for it is
256 For more information, see the section 'Note on random number
257 generation' at the end of this document.
260 Don't build the AFALG engine. This option will be forced if
261 on a platform that does not support AFALG.
264 Build with Kernel TLS support. This option will enable the
265 use of the Kernel TLS data-path, which can improve
266 performance and allow for the use of sendfile and splice
267 system calls on TLS sockets. The Kernel may use TLS
268 accelerators if any are available on the system.
269 This option will be forced off on systems that do not support
270 the Kernel TLS data-path.
273 Build with the Address sanitiser. This is a developer option
274 only. It may not work on all platforms and should never be
275 used in production environments. It will only work when used
276 with gcc or clang and should be used in conjunction with the
280 Do not use assembler code. This should be viewed as
281 debugging/trouble-shooting option rather than production.
282 On some platforms a small amount of assembler code may
283 still be used even with this option.
286 Do not build support for async operations.
289 Don't automatically load all supported ciphers and digests.
290 Typically OpenSSL will make available all of its supported
291 ciphers and digests. For a statically linked application this
292 may be undesirable if small executable size is an objective.
293 This only affects libcrypto. Ciphers and digests will have to
294 be loaded manually using EVP_add_cipher() and
295 EVP_add_digest() if this option is used. This option will
296 force a non-shared build.
299 Don't automatically load all libcrypto/libssl error strings.
300 Typically OpenSSL will automatically load human readable
301 error strings. For a statically linked application this may
302 be undesirable if small executable size is an objective.
305 Don't automatically load the default openssl.cnf file.
306 Typically OpenSSL will automatically load a system config
307 file which configures default ssl options.
310 While testing, generate C++ buildtest files that
311 simply check that the public OpenSSL header files
312 are usable standalone with C++.
314 Enabling this option demands extra care. For any
315 compiler flag given directly as configuration
316 option, you must ensure that it's valid for both
317 the C and the C++ compiler. If not, the C++ build
318 test will most likely break. As an alternative,
319 you can use the language specific variables, CFLAGS
323 Don't build the CAPI engine. This option will be forced if
324 on a platform that does not support CAPI.
327 Don't build support for CMP features
330 Don't build support for CMS features
333 Don't build support for SSL/TLS compression. If this option
334 is left enabled (the default), then compression will only
335 work if the zlib or zlib-dynamic options are also chosen.
338 Build support for debugging memory allocated via
339 OPENSSL_malloc() or OPENSSL_zalloc().
341 enable-crypto-mdebug-backtrace
342 As for crypto-mdebug, but additionally provide backtrace
343 information for allocated memory.
344 TO BE USED WITH CARE: this uses GNU C functionality, and
345 is therefore not usable for non-GNU config targets. If
346 your build complains about the use of '-rdynamic' or the
347 lack of header file execinfo.h, this option is not for you.
348 ALSO NOTE that even though execinfo.h is available on your
349 system (through Gnulib), the functions might just be stubs
353 Don't build support for Certificate Transparency.
356 Don't build with support for any deprecated APIs. This is the
357 same as using "--api" and supplying the latest version
361 Don't build support for datagram based BIOs. Selecting this
362 option will also force the disabling of DTLS.
365 Build the /dev/crypto engine. It is automatically selected
366 on BSD implementations, in which case it can be disabled with
370 Don't build the dynamically loaded engines. This only has an
371 effect in a "shared" build
374 Don't build support for Elliptic Curves.
377 Don't build support for binary Elliptic Curves
379 enable-ec_nistp_64_gcc_128
380 Enable support for optimised implementations of some commonly
381 used NIST elliptic curves.
382 This is only supported on platforms:
383 - with little-endian storage of non-byte types
384 - that tolerate misaligned memory references
385 - where the compiler:
386 - supports the non-standard type __uint128_t
387 - defines the built-in macro __SIZEOF_INT128__
390 Build support for gathering entropy from EGD (Entropy
394 Don't build support for loading engines.
397 Don't compile in any error strings.
399 enable-external-tests
400 Enable building of integration with external test suites.
401 This is a developer option and may not work on all platforms.
402 The only supported external test suite at the current time is
403 the BoringSSL test suite. See the file test/README.external
407 Don't compile in filename and line number information (e.g.
408 for errors and memory allocation).
411 Don't compile the FIPS module
413 enable-fuzz-libfuzzer, enable-fuzz-afl
414 Build with support for fuzzing using either libfuzzer or AFL.
415 These are developer options only. They may not work on all
416 platforms and should never be used in production environments.
417 See the file fuzz/README.md for further details.
420 Don't build support for GOST based ciphersuites. Note that
421 if this feature is enabled then GOST ciphersuites are only
422 available if the GOST algorithms are also available through
423 loading an externally supplied engine.
426 Don't build the legacy provider. Disabling this also disables
427 the legacy algorithms: MD2 (already disabled by default).
430 Don't generate dependencies.
433 Don't build any dynamically loadable engines. This also
434 implies 'no-dynamic-engine'.
437 Don't build support for writing multiple records in one
438 go in libssl (Note: this is a different capability to the
439 pipelining functionality).
442 Don't build support for the NPN TLS extension.
445 Don't build support for OCSP.
449 Don't build the padlock engine.
450 ('no-hw-padlock' is deprecated and should not be used)
453 Don't build with support for Position Independent Code.
455 no-pinshared By default OpenSSL will attempt to stay in memory until the
456 process exits. This is so that libcrypto and libssl can be
457 properly cleaned up automatically via an "atexit()" handler.
458 The handler is registered by libcrypto and cleans up both
459 libraries. On some platforms the atexit() handler will run on
460 unload of libcrypto (if it has been dynamically loaded)
461 rather than at process exit. This option can be used to stop
462 OpenSSL from attempting to stay in memory until the process
463 exits. This could lead to crashes if either libcrypto or
464 libssl have already been unloaded at the point
465 that the atexit handler is invoked, e.g. on a platform which
466 calls atexit() on unload of the library, and libssl is
467 unloaded before libcrypto then a crash is likely to happen.
468 Applications can suppress running of the atexit() handler at
469 run time by using the OPENSSL_INIT_NO_ATEXIT option to
470 OPENSSL_init_crypto(). See the man page for it for further
474 Don't use POSIX IO capabilities.
477 Don't build support for Pre-Shared Key based ciphersuites.
480 Don't use hardware RDRAND capabilities.
483 Don't build support for RFC3779 ("X.509 Extensions for IP
484 Addresses and AS Identifiers")
487 Build support for SCTP
490 Do not create shared libraries, only static ones. See "Note
491 on shared libraries" below.
494 Don't build support for socket BIOs
497 Don't build support for SRP or SRP based ciphersuites.
500 Don't build SRTP support
503 Exclude SSE2 code paths from 32-bit x86 assembly modules.
504 Normally SSE2 extension is detected at run-time, but the
505 decision whether or not the machine code will be executed
506 is taken solely on CPU capability vector. This means that
507 if you happen to run OS kernel which does not support SSE2
508 extension on Intel P4 processor, then your application
509 might be exposed to "illegal instruction" exception.
510 There might be a way to enable support in kernel, e.g.
511 FreeBSD kernel can be compiled with CPU_ENABLE_SSE, and
512 there is a way to disengage SSE2 code paths upon application
513 start-up, but if you aim for wider "audience" running
514 such kernel, consider no-sse2. Both the 386 and
515 no-asm options imply no-sse2.
518 Build with the SSL Trace capabilities (adds the "-trace"
519 option to s_client and s_server).
522 Don't build the statically linked engines. This only
523 has an impact when not built "shared".
526 Don't use anything from the C header file "stdio.h" that
527 makes use of the "FILE" type. Only libcrypto and libssl can
528 be built in this way. Using this option will suppress
529 building the command line applications. Additionally since
530 the OpenSSL tests also use the command line applications the
531 tests will also be skipped.
534 Don't build test programs or run any test.
537 Don't try to build with support for multi-threaded
541 Build with support for multi-threaded applications. Most
542 platforms will enable this by default. However if on a
543 platform where this is not the case then this will usually
544 require additional system-dependent options! See "Note on
545 multi-threading" below.
548 Build with support for the integrated tracing api. See manual pages
549 OSSL_trace_set_channel(3) and OSSL_trace_enabled(3) for details.
552 Don't build Time Stamping Authority support.
555 Build with the Undefined Behaviour sanitiser. This is a
556 developer option only. It may not work on all platforms and
557 should never be used in production environments. It will only
558 work when used with gcc or clang and should be used in
559 conjunction with the "-DPEDANTIC" option (or the
560 --strict-warnings option).
563 Don't build with the "UI" capability (i.e. the set of
564 features enabling text based prompts).
567 Enable additional unit test APIs. This should not typically
568 be used in production deployments.
571 Don't build support for UPLINK interface.
573 enable-weak-ssl-ciphers
574 Build support for SSL/TLS ciphers that are considered "weak"
575 (e.g. RC4 based ciphersuites).
578 Build with support for zlib compression/decompression.
581 Like "zlib", but has OpenSSL load the zlib library
582 dynamically when needed. This is only supported on systems
583 where loading of shared libraries is supported.
586 In 32-bit x86 builds, when generating assembly modules,
587 use the 80386 instruction set only (the default x86 code
588 is more efficient, but requires at least a 486). Note:
589 This doesn't affect code generated by compiler, you're
590 likely to complement configuration command line with
591 suitable compiler-specific option.
594 Don't build support for negotiating the specified SSL/TLS
595 protocol (one of ssl, ssl3, tls, tls1, tls1_1, tls1_2,
596 tls1_3, dtls, dtls1 or dtls1_2). If "no-tls" is selected then
597 all of tls1, tls1_1, tls1_2 and tls1_3 are disabled.
598 Similarly "no-dtls" will disable dtls1 and dtls1_2. The
599 "no-ssl" option is synonymous with "no-ssl3". Note this only
600 affects version negotiation. OpenSSL will still provide the
601 methods for applications to explicitly select the individual
605 As for no-<prot> but in addition do not build the methods for
606 applications to explicitly select individual protocol
607 versions. Note that there is no "no-tls1_3-method" option
608 because there is no application method for TLSv1.3. Using
609 individual protocol methods directly is deprecated.
610 Applications should use TLS_method() instead.
613 Build with support for the specified algorithm, where <alg>
614 is one of: md2 or rc5.
617 Build without support for the specified algorithm, where
618 <alg> is one of: aria, bf, blake2, camellia, cast, chacha,
619 cmac, des, dh, dsa, ecdh, ecdsa, idea, md4, mdc2, ocb,
620 poly1305, rc2, rc4, rmd160, scrypt, seed, siphash, siv, sm2,
621 sm3, sm4 or whirlpool. The "ripemd" algorithm is deprecated
622 and if used is synonymous with rmd160.
624 -Dxxx, -Ixxx, -Wp, -lxxx, -Lxxx, -Wl, -rpath, -R, -framework, -static
625 These system specific options will be recognised and
626 passed through to the compiler to allow you to define
627 preprocessor symbols, specify additional libraries, library
628 directories or other compiler options. It might be worth
629 noting that some compilers generate code specifically for
630 processor the compiler currently executes on. This is not
631 necessarily what you might have in mind, since it might be
632 unsuitable for execution on other, typically older,
633 processor. Consult your compiler documentation.
635 Take note of the VAR=value documentation below and how
636 these flags interact with those variables.
639 Additional options that are not otherwise recognised are
640 passed through as they are to the compiler as well. Again,
641 consult your compiler documentation.
643 Take note of the VAR=value documentation below and how
644 these flags interact with those variables.
647 Assignment of environment variable for Configure. These
648 work just like normal environment variable assignments,
649 but are supported on all platforms and are confined to
650 the configuration scripts only. These assignments override
651 the corresponding value in the inherited environment, if
654 The following variables are used as "make variables" and
655 can be used as an alternative to giving preprocessor,
656 compiler and linker options directly as configuration.
657 The following variables are supported:
659 AR The static library archiver.
660 ARFLAGS Flags for the static library archiver.
661 AS The assembler compiler.
662 ASFLAGS Flags for the assembler compiler.
664 CFLAGS Flags for the C compiler.
665 CXX The C++ compiler.
666 CXXFLAGS Flags for the C++ compiler.
667 CPP The C/C++ preprocessor.
668 CPPFLAGS Flags for the C/C++ preprocessor.
669 CPPDEFINES List of CPP macro definitions, separated
670 by a platform specific character (':' or
671 space for Unix, ';' for Windows, ',' for
672 VMS). This can be used instead of using
673 -D (or what corresponds to that on your
674 compiler) in CPPFLAGS.
675 CPPINCLUDES List of CPP inclusion directories, separated
676 the same way as for CPPDEFINES. This can
677 be used instead of -I (or what corresponds
678 to that on your compiler) in CPPFLAGS.
679 HASHBANGPERL Perl invocation to be inserted after '#!'
680 in public perl scripts (only relevant on
682 LD The program linker (not used on Unix, $(CC)
684 LDFLAGS Flags for the shared library, DSO and
686 LDLIBS Extra libraries to use when linking.
687 Takes the form of a space separated list
688 of library specifications on Unix and
689 Windows, and as a comma separated list of
691 RANLIB The library archive indexer.
692 RC The Windows resource compiler.
693 RCFLAGS Flags for the Windows resource compiler.
694 RM The command to remove files and directories.
696 These cannot be mixed with compiling / linking flags given
697 on the command line. In other words, something like this
700 ./config -DFOO CPPFLAGS=-DBAR -DCOOKIE
702 Backward compatibility note:
704 To be compatible with older configuration scripts, the
705 environment variables are ignored if compiling / linking
706 flags are given on the command line, except for these:
708 AR, CC, CXX, CROSS_COMPILE, HASHBANGPERL, PERL, RANLIB, RC
711 For example, the following command will not see -DBAR:
713 CPPFLAGS=-DBAR ./config -DCOOKIE
715 However, the following will see both set variables:
717 CC=gcc CROSS_COMPILE=x86_64-w64-mingw32- \
720 If CC is set, it is advisable to also set CXX to ensure
721 both C and C++ compilers are in the same "family". This
722 becomes relevant with 'enable-external-tests' and
723 'enable-buildtest-c++'.
727 Reconfigure from earlier data. This fetches the previous
728 command line options and environment from data saved in
729 "configdata.pm", and runs the configuration process again,
730 using these options and environment.
731 Note: NO other option is permitted together with "reconf".
732 This means that you also MUST use "./Configure" (or
733 what corresponds to that on non-Unix platforms) directly
734 to invoke this option.
735 Note: The original configuration saves away values for ALL
736 environment variables that were used, and if they weren't
737 defined, they are still saved away with information that
738 they weren't originally defined. This information takes
739 precedence over environment variables that are defined
742 Displaying configuration data
743 -----------------------------
745 The configuration script itself will say very little, and finishes by
746 creating "configdata.pm". This perl module can be loaded by other scripts
747 to find all the configuration data, and it can also be used as a script to
748 display all sorts of configuration data in a human readable form.
750 For more information, please do:
752 $ ./configdata.pm --help # Unix
756 $ perl configdata.pm --help # Windows and VMS
758 Installation in Detail
759 ----------------------
761 1a. Configure OpenSSL for your operation system automatically:
763 NOTE: This is not available on Windows.
765 $ ./config [[ options ]] # Unix
769 $ @config [[ options ]] ! OpenVMS
771 For the remainder of this text, the Unix form will be used in all
772 examples, please use the appropriate form for your platform.
774 This guesses at your operating system (and compiler, if necessary) and
775 configures OpenSSL based on this guess. Run ./config -t to see
776 if it guessed correctly. If you want to use a different compiler, you
777 are cross-compiling for another platform, or the ./config guess was
778 wrong for other reasons, go to step 1b. Otherwise go to step 2.
780 On some systems, you can include debugging information as follows:
782 $ ./config -d [[ options ]]
784 1b. Configure OpenSSL for your operating system manually
786 OpenSSL knows about a range of different operating system, hardware and
787 compiler combinations. To see the ones it knows about, run
793 $ perl Configure # All other platforms
795 For the remainder of this text, the Unix form will be used in all
796 examples, please use the appropriate form for your platform.
798 Pick a suitable name from the list that matches your system. For most
799 operating systems there is a choice between using "cc" or "gcc". When
800 you have identified your system (and if necessary compiler) use this name
801 as the argument to Configure. For example, a "linux-elf" user would
804 $ ./Configure linux-elf [[ options ]]
806 If your system isn't listed, you will have to create a configuration
807 file named Configurations/{{ something }}.conf and add the correct
808 configuration for your system. See the available configs as examples
809 and read Configurations/README and Configurations/README.design for
812 The generic configurations "cc" or "gcc" should usually work on 32 bit
815 Configure creates a build file ("Makefile" on Unix, "makefile" on Windows
816 and "descrip.mms" on OpenVMS) from a suitable template in Configurations,
817 and defines various macros in include/openssl/opensslconf.h (generated from
818 include/openssl/opensslconf.h.in).
820 1c. Configure OpenSSL for building outside of the source tree.
822 OpenSSL can be configured to build in a build directory separate from
823 the directory with the source code. It's done by placing yourself in
824 some other directory and invoking the configuration commands from
829 $ mkdir /var/tmp/openssl-build
830 $ cd /var/tmp/openssl-build
831 $ /PATH/TO/OPENSSL/SOURCE/config [[ options ]]
835 $ /PATH/TO/OPENSSL/SOURCE/Configure {{ target }} [[ options ]]
839 $ set default sys$login:
840 $ create/dir [.tmp.openssl-build]
841 $ set default [.tmp.openssl-build]
842 $ @[PATH.TO.OPENSSL.SOURCE]config [[ options ]]
846 $ @[PATH.TO.OPENSSL.SOURCE]Configure {{ target }} [[ options ]]
851 $ mkdir \temp-openssl
853 $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure {{ target }} [[ options ]]
855 Paths can be relative just as well as absolute. Configure will
856 do its best to translate them to relative paths whenever possible.
858 2. Build OpenSSL by running:
861 $ mms ! (or mmk) OpenVMS
864 This will build the OpenSSL libraries (libcrypto.a and libssl.a on
865 Unix, corresponding on other platforms) and the OpenSSL binary
866 ("openssl"). The libraries will be built in the top-level directory,
867 and the binary will be in the "apps" subdirectory.
871 If the build fails, look at the output. There may be reasons
872 for the failure that aren't problems in OpenSSL itself (like
873 missing standard headers).
875 If the build succeeded previously, but fails after a source or
876 configuration change, it might be helpful to clean the build tree
877 before attempting another build. Use this command:
880 $ mms clean ! (or mmk) OpenVMS
881 $ nmake clean # Windows
883 Assembler error messages can sometimes be sidestepped by using the
884 "no-asm" configuration option.
886 Compiling parts of OpenSSL with gcc and others with the system
887 compiler will result in unresolved symbols on some systems.
889 If you are still having problems you can get help by sending an email
890 to the openssl-users email list (see
891 https://www.openssl.org/community/mailinglists.html for details). If
892 it is a bug with OpenSSL itself, please open an issue on GitHub, at
893 https://github.com/openssl/openssl/issues. Please review the existing
894 ones first; maybe the bug was already reported or has already been
897 3. After a successful build, the libraries should be tested. Run:
901 $ nmake test # Windows
903 NOTE: you MUST run the tests from an unprivileged account (or
904 disable your privileges temporarily if your platform allows it).
906 If some tests fail, look at the output. There may be reasons for
907 the failure that isn't a problem in OpenSSL itself (like a
908 malfunction with Perl). You may want increased verbosity, that
909 can be accomplished like this:
911 $ make VERBOSE=1 test # Unix
913 $ mms /macro=(VERBOSE=1) test ! OpenVMS
915 $ nmake VERBOSE=1 test # Windows
917 If you want to run just one or a few specific tests, you can use
918 the make variable TESTS to specify them, like this:
920 $ make TESTS='test_rsa test_dsa' test # Unix
921 $ mms/macro="TESTS=test_rsa test_dsa" test ! OpenVMS
922 $ nmake TESTS='test_rsa test_dsa' test # Windows
924 And of course, you can combine (Unix example shown):
926 $ make VERBOSE=1 TESTS='test_rsa test_dsa' test
928 You can find the list of available tests like this:
930 $ make list-tests # Unix
931 $ mms list-tests ! OpenVMS
932 $ nmake list-tests # Windows
934 Have a look at the manual for the perl module Test::Harness to
935 see what other HARNESS_* variables there are.
937 If you find a problem with OpenSSL itself, try removing any
938 compiler optimization flags from the CFLAGS line in Makefile and
939 run "make clean; make" or corresponding.
941 To report a bug please open an issue on GitHub, at
942 https://github.com/openssl/openssl/issues.
944 For more details on how the make variables TESTS can be used,
945 see section TESTS in Detail below.
947 4. If everything tests ok, install OpenSSL with
949 $ make install # Unix
950 $ mms install ! OpenVMS
951 $ nmake install # Windows
953 Note that in order to perform the install step above you need to have
954 appropriate permissions to write to the installation directory.
956 The above commands will install all the software components in this
957 directory tree under PREFIX (the directory given with --prefix or its
962 bin/ Contains the openssl binary and a few other
965 Contains the header files needed if you want
966 to build your own programs that use libcrypto
968 lib Contains the OpenSSL library files.
969 lib/engines Contains the OpenSSL dynamically loadable engines.
971 share/man/man1 Contains the OpenSSL command line man-pages.
972 share/man/man3 Contains the OpenSSL library calls man-pages.
973 share/man/man5 Contains the OpenSSL configuration format man-pages.
974 share/man/man7 Contains the OpenSSL other misc man-pages.
976 share/doc/openssl/html/man1
977 share/doc/openssl/html/man3
978 share/doc/openssl/html/man5
979 share/doc/openssl/html/man7
980 Contains the HTML rendition of the man-pages.
982 OpenVMS ('arch' is replaced with the architecture name, "Alpha"
983 or "ia64", 'sover' is replaced with the shared library version
984 (0101 for 1.1), and 'pz' is replaced with the pointer size
985 OpenSSL was built with):
987 [.EXE.'arch'] Contains the openssl binary.
988 [.EXE] Contains a few utility scripts.
990 Contains the header files needed if you want
991 to build your own programs that use libcrypto
993 [.LIB.'arch'] Contains the OpenSSL library files.
994 [.ENGINES'sover''pz'.'arch']
995 Contains the OpenSSL dynamically loadable engines.
996 [.SYS$STARTUP] Contains startup, login and shutdown scripts.
997 These define appropriate logical names and
999 [.SYSTEST] Contains the installation verification procedure.
1000 [.HTML] Contains the HTML rendition of the manual pages.
1003 Additionally, install will add the following directories under
1004 OPENSSLDIR (the directory given with --openssldir or its default)
1005 for you convenience:
1007 certs Initially empty, this is the default location
1008 for certificate files.
1009 private Initially empty, this is the default location
1010 for private key files.
1011 misc Various scripts.
1013 The installation directory should be appropriately protected to ensure
1014 unprivileged users cannot make changes to OpenSSL binaries or files, or
1015 install engines. If you already have a pre-installed version of OpenSSL as
1016 part of your Operating System it is recommended that you do not overwrite
1017 the system version and instead install to somewhere else.
1019 Package builders who want to configure the library for standard
1020 locations, but have the package installed somewhere else so that
1021 it can easily be packaged, can use
1023 $ make DESTDIR=/tmp/package-root install # Unix
1024 $ mms/macro="DESTDIR=TMP:[PACKAGE-ROOT]" install ! OpenVMS
1026 The specified destination directory will be prepended to all
1027 installation target paths.
1029 Compatibility issues with previous OpenSSL versions:
1031 * COMPILING existing applications
1033 Starting with version 1.1.0, OpenSSL hides a number of structures
1034 that were previously open. This includes all internal libssl
1035 structures and a number of EVP types. Accessor functions have
1036 been added to allow controlled access to the structures' data.
1038 This means that some software needs to be rewritten to adapt to
1039 the new ways of doing things. This often amounts to allocating
1040 an instance of a structure explicitly where you could previously
1041 allocate them on the stack as automatic variables, and using the
1042 provided accessor functions where you would previously access a
1043 structure's field directly.
1045 Some APIs have changed as well. However, older APIs have been
1046 preserved when possible.
1048 Environment Variables
1049 ---------------------
1051 A number of environment variables can be used to provide additional control
1052 over the build process. Typically these should be defined prior to running
1053 config or Configure. Not all environment variables are relevant to all
1057 The name of the ar executable to use.
1060 Use a different build file name than the platform default
1061 ("Makefile" on Unix-like platforms, "makefile" on native Windows,
1062 "descrip.mms" on OpenVMS). This requires that there is a
1063 corresponding build file template. See Configurations/README
1064 for further information.
1067 The compiler to use. Configure will attempt to pick a default
1068 compiler for your platform but this choice can be overridden
1069 using this variable. Set it to the compiler executable you wish
1070 to use, e.g. "gcc" or "clang".
1073 This environment variable has the same meaning as for the
1074 "--cross-compile-prefix" Configure flag described above. If both
1075 are set then the Configure flag takes precedence.
1078 The name of the nm executable to use.
1080 OPENSSL_LOCAL_CONFIG_DIR
1081 OpenSSL comes with a database of information about how it
1082 should be built on different platforms as well as build file
1083 templates for those platforms. The database is comprised of
1084 ".conf" files in the Configurations directory. The build
1085 file templates reside there as well as ".tmpl" files. See the
1086 file Configurations/README for further information about the
1087 format of ".conf" files as well as information on the ".tmpl"
1089 In addition to the standard ".conf" and ".tmpl" files, it is
1090 possible to create your own ".conf" and ".tmpl" files and store
1091 them locally, outside the OpenSSL source tree. This environment
1092 variable can be set to the directory where these files are held
1093 and will be considered by Configure before it looks in the
1094 standard directories.
1097 The name of the Perl executable to use when building OpenSSL.
1098 This variable is used in config script only. Configure on the
1099 other hand imposes the interpreter by which it itself was
1100 executed on the whole build procedure.
1103 The command string for the Perl executable to insert in the
1104 #! line of perl scripts that will be publically installed.
1105 Default: /usr/bin/env perl
1106 Note: the value of this variable is added to the same scripts
1107 on all platforms, but it's only relevant on Unix-like platforms.
1110 The name of the rc executable to use. The default will be as
1111 defined for the target platform in the ".conf" file. If not
1112 defined then "windres" will be used. The WINDRES environment
1113 variable is synonymous to this. If both are defined then RC
1117 The name of the ranlib executable to use.
1125 The Configure script generates a Makefile in a format relevant to the specific
1126 platform. The Makefiles provide a number of targets that can be used. Not all
1127 targets may be available on all platforms. Only the most common targets are
1128 described here. Examine the Makefiles themselves for the full list.
1131 The default target to build all the software components.
1134 Remove all build artefacts and return the directory to a "clean"
1138 Rebuild the dependencies in the Makefiles. This is a legacy
1139 option that no longer needs to be used since OpenSSL 1.1.0.
1142 Install all OpenSSL components.
1145 Only install the OpenSSL software components.
1148 Only install the OpenSSL documentation components.
1151 Only install the OpenSSL man pages (Unix only).
1154 Only install the OpenSSL html documentation.
1157 Prints a list of all the self test names.
1160 Build and run the OpenSSL self tests.
1163 Uninstall all OpenSSL components.
1167 Re-run the configuration process, as exactly as the last time
1171 This is a developer option. If you are developing a patch for
1172 OpenSSL you may need to use this if you want to update
1173 automatically generated files; add new error codes or add new
1174 (or change the visibility of) public API functions. (Unix only).
1179 The make variable TESTS supports a versatile set of space separated tokens
1180 with which you can specify a set of tests to be performed. With a "current
1181 set of tests" in mind, initially being empty, here are the possible tokens:
1183 alltests The current set of tests becomes the whole set of available
1184 tests (as listed when you do 'make list-tests' or similar).
1185 xxx Adds the test 'xxx' to the current set of tests.
1186 -xxx Removes 'xxx' from the current set of tests. If this is the
1187 first token in the list, the current set of tests is first
1188 assigned the whole set of available tests, effectively making
1189 this token equivalent to TESTS="alltests -xxx".
1190 nn Adds the test group 'nn' (which is a number) to the current
1192 -nn Removes the test group 'nn' from the current set of tests.
1193 If this is the first token in the list, the current set of
1194 tests is first assigned the whole set of available tests,
1195 effectively making this token equivalent to
1196 TESTS="alltests -xxx".
1198 Also, all tokens except for "alltests" may have wildcards, such as *.
1199 (on Unix and Windows, BSD style wildcards are supported, while on VMS,
1200 it's VMS style wildcards)
1202 Example: All tests except for the fuzz tests:
1204 $ make TESTS=-test_fuzz test
1206 or (if you want to be explicit)
1208 $ make TESTS='alltests -test_fuzz' test
1210 Example: All tests that have a name starting with "test_ssl" but not those
1211 starting with "test_ssl_":
1213 $ make TESTS='test_ssl* -test_ssl_*' test
1215 Example: Only test group 10:
1219 Example: All tests except the slow group (group 99):
1223 Example: All tests in test groups 80 to 99 except for tests in group 90:
1225 $ make TESTS='[89]? -90'
1227 To stochastically verify that the algorithm that produces uniformly distributed
1228 random numbers is operating correctly (with a false positive rate of 0.01%):
1230 $ ./util/shlib_wrap.sh test/bntest -stochastic
1232 Note on multi-threading
1233 -----------------------
1235 For some systems, the OpenSSL Configure script knows what compiler options
1236 are needed to generate a library that is suitable for multi-threaded
1237 applications. On these systems, support for multi-threading is enabled
1238 by default; use the "no-threads" option to disable (this should never be
1241 On other systems, to enable support for multi-threading, you will have
1242 to specify at least two options: "threads", and a system-dependent option.
1243 (The latter is "-D_REENTRANT" on various systems.) The default in this
1244 case, obviously, is not to include support for multi-threading (but
1245 you can still use "no-threads" to suppress an annoying warning message
1246 from the Configure script.)
1248 OpenSSL provides built-in support for two threading models: pthreads (found on
1249 most UNIX/Linux systems), and Windows threads. No other threading models are
1250 supported. If your platform does not provide pthreads or Windows threads then
1251 you should Configure with the "no-threads" option.
1253 Notes on shared libraries
1254 -------------------------
1256 For most systems the OpenSSL Configure script knows what is needed to
1257 build shared libraries for libcrypto and libssl. On these systems
1258 the shared libraries will be created by default. This can be suppressed and
1259 only static libraries created by using the "no-shared" option. On systems
1260 where OpenSSL does not know how to build shared libraries the "no-shared"
1261 option will be forced and only static libraries will be created.
1263 Shared libraries are named a little differently on different platforms.
1264 One way or another, they all have the major OpenSSL version number as
1265 part of the file name, i.e. for OpenSSL 1.1.x, 1.1 is somehow part of
1268 On most POSIX platforms, shared libraries are named libcrypto.so.1.1
1271 on Cygwin, shared libraries are named cygcrypto-1.1.dll and cygssl-1.1.dll
1272 with import libraries libcrypto.dll.a and libssl.dll.a.
1274 On Windows build with MSVC or using MingW, shared libraries are named
1275 libcrypto-1_1.dll and libssl-1_1.dll for 32-bit Windows, libcrypto-1_1-x64.dll
1276 and libssl-1_1-x64.dll for 64-bit x86_64 Windows, and libcrypto-1_1-ia64.dll
1277 and libssl-1_1-ia64.dll for IA64 Windows. With MSVC, the import libraries
1278 are named libcrypto.lib and libssl.lib, while with MingW, they are named
1279 libcrypto.dll.a and libssl.dll.a.
1281 On VMS, shareable images (VMS speak for shared libraries) are named
1282 ossl$libcrypto0101_shr.exe and ossl$libssl0101_shr.exe. However, when
1283 OpenSSL is specifically built for 32-bit pointers, the shareable images
1284 are named ossl$libcrypto0101_shr32.exe and ossl$libssl0101_shr32.exe
1285 instead, and when built for 64-bit pointers, they are named
1286 ossl$libcrypto0101_shr64.exe and ossl$libssl0101_shr64.exe.
1288 Note on random number generation
1289 --------------------------------
1291 Availability of cryptographically secure random numbers is required for
1292 secret key generation. OpenSSL provides several options to seed the
1293 internal CSPRNG. If not properly seeded, the internal CSPRNG will refuse
1294 to deliver random bytes and a "PRNG not seeded error" will occur.
1296 The seeding method can be configured using the --with-rand-seed option,
1297 which can be used to specify a comma separated list of seed methods.
1298 However in most cases OpenSSL will choose a suitable default method,
1299 so it is not necessary to explicitly provide this option. Note also
1300 that not all methods are available on all platforms.
1302 I) On operating systems which provide a suitable randomness source (in
1303 form of a system call or system device), OpenSSL will use the optimal
1304 available method to seed the CSPRNG from the operating system's
1305 randomness sources. This corresponds to the option --with-rand-seed=os.
1307 II) On systems without such a suitable randomness source, automatic seeding
1308 and reseeding is disabled (--with-rand-seed=none) and it may be necessary
1309 to install additional support software to obtain a random seed and reseed
1310 the CSPRNG manually. Please check out the manual pages for RAND_add(),
1311 RAND_bytes(), RAND_egd(), and the FAQ for more information.
projects / openssl.git / blob