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 the Address sanitiser. This is a developer option
255 only. It may not work on all platforms and should never be
256 used in production environments. It will only work when used
257 with gcc or clang and should be used in conjunction with the
261 Do not use assembler code. This should be viewed as
262 debugging/trouble-shooting option rather than production.
263 On some platforms a small amount of assembler code may
264 still be used even with this option.
267 Do not build support for async operations.
270 Don't automatically load all supported ciphers and digests.
271 Typically OpenSSL will make available all of its supported
272 ciphers and digests. For a statically linked application this
273 may be undesirable if small executable size is an objective.
274 This only affects libcrypto. Ciphers and digests will have to
275 be loaded manually using EVP_add_cipher() and
276 EVP_add_digest() if this option is used. This option will
277 force a non-shared build.
280 Don't automatically load all libcrypto/libssl error strings.
281 Typically OpenSSL will automatically load human readable
282 error strings. For a statically linked application this may
283 be undesirable if small executable size is an objective.
286 Don't automatically load the default openssl.cnf file.
287 Typically OpenSSL will automatically load a system config
288 file which configures default ssl options.
291 Don't build the CAPI engine. This option will be forced if
292 on a platform that does not support CAPI.
295 Don't build support for CMS features
298 Don't build support for SSL/TLS compression. If this option
299 is left enabled (the default), then compression will only
300 work if the zlib or zlib-dynamic options are also chosen.
303 Build support for debugging memory allocated via
304 OPENSSL_malloc() or OPENSSL_zalloc().
306 enable-crypto-mdebug-backtrace
307 As for crypto-mdebug, but additionally provide backtrace
308 information for allocated memory.
309 TO BE USED WITH CARE: this uses GNU C functionality, and
310 is therefore not usable for non-GNU config targets. If
311 your build complains about the use of '-rdynamic' or the
312 lack of header file execinfo.h, this option is not for you.
313 ALSO NOTE that even though execinfo.h is available on your
314 system (through Gnulib), the functions might just be stubs
318 Don't build support for Certificate Transparency.
321 Don't build with support for any deprecated APIs. This is the
322 same as using "--api" and supplying the latest version
326 Don't build support for datagram based BIOs. Selecting this
327 option will also force the disabling of DTLS.
330 Build the /dev/crypto engine. It is automatically selected
331 on BSD implementations, in which case it can be disabled with
335 Don't build the dynamically loaded engines. This only has an
336 effect in a "shared" build
339 Don't build support for Elliptic Curves.
342 Don't build support for binary Elliptic Curves
344 enable-ec_nistp_64_gcc_128
345 Enable support for optimised implementations of some commonly
346 used NIST elliptic curves.
347 This is only supported on platforms:
348 - with little-endian storage of non-byte types
349 - that tolerate misaligned memory references
350 - where the compiler:
351 - supports the non-standard type __uint128_t
352 - defines the built-in macro __SIZEOF_INT128__
355 Build support for gathering entropy from EGD (Entropy
359 Don't build support for loading engines.
362 Don't compile in any error strings.
364 enable-external-tests
365 Enable building of integration with external test suites.
366 This is a developer option and may not work on all platforms.
367 The only supported external test suite at the current time is
368 the BoringSSL test suite. See the file test/README.external
372 Don't compile in filename and line number information (e.g.
373 for errors and memory allocation).
375 enable-fuzz-libfuzzer, enable-fuzz-afl
376 Build with support for fuzzing using either libfuzzer or AFL.
377 These are developer options only. They may not work on all
378 platforms and should never be used in production environments.
379 See the file fuzz/README.md for further details.
382 Don't build support for GOST based ciphersuites. Note that
383 if this feature is enabled then GOST ciphersuites are only
384 available if the GOST algorithms are also available through
385 loading an externally supplied engine.
388 Don't build the padlock engine.
391 Don't generate dependencies.
394 Don't build support for writing multiple records in one
395 go in libssl (Note: this is a different capability to the
396 pipelining functionality).
399 Don't build support for the NPN TLS extension.
402 Don't build support for OCSP.
405 Don't build with support for Position Independent Code.
407 no-pinshared By default OpenSSL will attempt to stay in memory until the
408 process exits. This is so that libcrypto and libssl can be
409 properly cleaned up automatically via an "atexit()" handler.
410 The handler is registered by libcrypto and cleans up both
411 libraries. On some platforms the atexit() handler will run on
412 unload of libcrypto (if it has been dynamically loaded)
413 rather than at process exit. This option can be used to stop
414 OpenSSL from attempting to stay in memory until the process
415 exits. This could lead to crashes if either libcrypto or
416 libssl have already been unloaded at the point
417 that the atexit handler is invoked, e.g. on a platform which
418 calls atexit() on unload of the library, and libssl is
419 unloaded before libcrypto then a crash is likely to happen.
420 Applications can suppress running of the atexit() handler at
421 run time by using the OPENSSL_INIT_NO_ATEXIT option to
422 OPENSSL_init_crypto(). See the man page for it for further
426 Don't use POSIX IO capabilities.
429 Don't build support for Pre-Shared Key based ciphersuites.
432 Don't use hardware RDRAND capabilities.
435 Don't build support for RFC3779 ("X.509 Extensions for IP
436 Addresses and AS Identifiers")
439 Build support for SCTP
442 Do not create shared libraries, only static ones. See "Note
443 on shared libraries" below.
446 Don't build support for socket BIOs
449 Don't build support for SRP or SRP based ciphersuites.
452 Don't build SRTP support
455 Exclude SSE2 code paths from 32-bit x86 assembly modules.
456 Normally SSE2 extension is detected at run-time, but the
457 decision whether or not the machine code will be executed
458 is taken solely on CPU capability vector. This means that
459 if you happen to run OS kernel which does not support SSE2
460 extension on Intel P4 processor, then your application
461 might be exposed to "illegal instruction" exception.
462 There might be a way to enable support in kernel, e.g.
463 FreeBSD kernel can be compiled with CPU_ENABLE_SSE, and
464 there is a way to disengage SSE2 code paths upon application
465 start-up, but if you aim for wider "audience" running
466 such kernel, consider no-sse2. Both the 386 and
467 no-asm options imply no-sse2.
470 Build with the SSL Trace capabilities (adds the "-trace"
471 option to s_client and s_server).
474 Don't build the statically linked engines. This only
475 has an impact when not built "shared".
478 Don't use anything from the C header file "stdio.h" that
479 makes use of the "FILE" type. Only libcrypto and libssl can
480 be built in this way. Using this option will suppress
481 building the command line applications. Additionally since
482 the OpenSSL tests also use the command line applications the
483 tests will also be skipped.
486 Don't build test programs or run any test.
489 Don't try to build with support for multi-threaded
493 Build with support for multi-threaded applications. Most
494 platforms will enable this by default. However if on a
495 platform where this is not the case then this will usually
496 require additional system-dependent options! See "Note on
497 multi-threading" below.
500 Don't build Time Stamping Authority support.
503 Build with the Undefined Behaviour sanitiser. This is a
504 developer option only. It may not work on all platforms and
505 should never be used in production environments. It will only
506 work when used with gcc or clang and should be used in
507 conjunction with the "-DPEDANTIC" option (or the
508 --strict-warnings option).
511 Don't build with the "UI" capability (i.e. the set of
512 features enabling text based prompts).
515 Enable additional unit test APIs. This should not typically
516 be used in production deployments.
518 enable-weak-ssl-ciphers
519 Build support for SSL/TLS ciphers that are considered "weak"
520 (e.g. RC4 based ciphersuites).
523 Build with support for zlib compression/decompression.
526 Like "zlib", but has OpenSSL load the zlib library
527 dynamically when needed. This is only supported on systems
528 where loading of shared libraries is supported.
531 In 32-bit x86 builds, when generating assembly modules,
532 use the 80386 instruction set only (the default x86 code
533 is more efficient, but requires at least a 486). Note:
534 This doesn't affect code generated by compiler, you're
535 likely to complement configuration command line with
536 suitable compiler-specific option.
539 Don't build support for negotiating the specified SSL/TLS
540 protocol (one of ssl, ssl3, tls, tls1, tls1_1, tls1_2,
541 tls1_3, dtls, dtls1 or dtls1_2). If "no-tls" is selected then
542 all of tls1, tls1_1, tls1_2 and tls1_3 are disabled.
543 Similarly "no-dtls" will disable dtls1 and dtls1_2. The
544 "no-ssl" option is synonymous with "no-ssl3". Note this only
545 affects version negotiation. OpenSSL will still provide the
546 methods for applications to explicitly select the individual
550 As for no-<prot> but in addition do not build the methods for
551 applications to explicitly select individual protocol
552 versions. Note that there is no "no-tls1_3-method" option
553 because there is no application method for TLSv1.3. Using
554 individual protocol methods directly is deprecated.
555 Applications should use TLS_method() instead.
558 Build with support for the specified algorithm, where <alg>
559 is one of: md2 or rc5.
562 Build without support for the specified algorithm, where
563 <alg> is one of: aria, bf, blake2, camellia, cast, chacha,
564 cmac, des, dh, dsa, ecdh, ecdsa, idea, md4, mdc2, ocb,
565 poly1305, rc2, rc4, rmd160, scrypt, seed, siphash, sm2, sm3,
566 sm4 or whirlpool. The "ripemd" algorithm is deprecated and
567 if used is synonymous with rmd160.
569 -Dxxx, -Ixxx, -Wp, -lxxx, -Lxxx, -Wl, -rpath, -R, -framework, -static
570 These system specific options will be recognised and
571 passed through to the compiler to allow you to define
572 preprocessor symbols, specify additional libraries, library
573 directories or other compiler options. It might be worth
574 noting that some compilers generate code specifically for
575 processor the compiler currently executes on. This is not
576 necessarily what you might have in mind, since it might be
577 unsuitable for execution on other, typically older,
578 processor. Consult your compiler documentation.
580 Take note of the VAR=value documentation below and how
581 these flags interact with those variables.
584 Additional options that are not otherwise recognised are
585 passed through as they are to the compiler as well. Again,
586 consult your compiler documentation.
588 Take note of the VAR=value documentation below and how
589 these flags interact with those variables.
592 Assignment of environment variable for Configure. These
593 work just like normal environment variable assignments,
594 but are supported on all platforms and are confined to
595 the configuration scripts only. These assignments override
596 the corresponding value in the inherited environment, if
599 The following variables are used as "make variables" and
600 can be used as an alternative to giving preprocessor,
601 compiler and linker options directly as configuration.
602 The following variables are supported:
604 AR The static library archiver.
605 ARFLAGS Flags for the static library archiver.
606 AS The assembler compiler.
607 ASFLAGS Flags for the assembler compiler.
609 CFLAGS Flags for the C compiler.
610 CXX The C++ compiler.
611 CXXFLAGS Flags for the C++ compiler.
612 CPP The C/C++ preprocessor.
613 CPPFLAGS Flags for the C/C++ preprocessor.
614 CPPDEFINES List of CPP macro definitions, separated
615 by a platform specific character (':' or
616 space for Unix, ';' for Windows, ',' for
617 VMS). This can be used instead of using
618 -D (or what corresponds to that on your
619 compiler) in CPPFLAGS.
620 CPPINCLUDES List of CPP inclusion directories, separated
621 the same way as for CPPDEFINES. This can
622 be used instead of -I (or what corresponds
623 to that on your compiler) in CPPFLAGS.
624 HASHBANGPERL Perl invocation to be inserted after '#!'
625 in public perl scripts (only relevant on
627 LD The program linker (not used on Unix, $(CC)
629 LDFLAGS Flags for the shared library, DSO and
631 LDLIBS Extra libraries to use when linking.
632 Takes the form of a space separated list
633 of library specifications on Unix and
634 Windows, and as a comma separated list of
636 RANLIB The library archive indexer.
637 RC The Windows resource compiler.
638 RCFLAGS Flags for the Windows resource compiler.
639 RM The command to remove files and directories.
641 These cannot be mixed with compiling / linking flags given
642 on the command line. In other words, something like this
645 ./config -DFOO CPPFLAGS=-DBAR -DCOOKIE
647 Backward compatibility note:
649 To be compatible with older configuration scripts, the
650 environment variables are ignored if compiling / linking
651 flags are given on the command line, except for these:
653 AR, CC, CXX, CROSS_COMPILE, HASHBANGPERL, PERL, RANLIB, RC
656 For example, the following command will not see -DBAR:
658 CPPFLAGS=-DBAR ./config -DCOOKIE
660 However, the following will see both set variables:
662 CC=gcc CROSS_COMPILE=x86_64-w64-mingw32- \
667 Reconfigure from earlier data. This fetches the previous
668 command line options and environment from data saved in
669 "configdata.pm", and runs the configuration process again,
670 using these options and environment.
671 Note: NO other option is permitted together with "reconf".
672 This means that you also MUST use "./Configure" (or
673 what corresponds to that on non-Unix platforms) directly
674 to invoke this option.
675 Note: The original configuration saves away values for ALL
676 environment variables that were used, and if they weren't
677 defined, they are still saved away with information that
678 they weren't originally defined. This information takes
679 precedence over environment variables that are defined
682 Displaying configuration data
683 -----------------------------
685 The configuration script itself will say very little, and finishes by
686 creating "configdata.pm". This perl module can be loaded by other scripts
687 to find all the configuration data, and it can also be used as a script to
688 display all sorts of configuration data in a human readable form.
690 For more information, please do:
692 $ ./configdata.pm --help # Unix
696 $ perl configdata.pm --help # Windows and VMS
698 Installation in Detail
699 ----------------------
701 1a. Configure OpenSSL for your operation system automatically:
703 NOTE: This is not available on Windows.
705 $ ./config [[ options ]] # Unix
709 $ @config [[ options ]] ! OpenVMS
711 For the remainder of this text, the Unix form will be used in all
712 examples, please use the appropriate form for your platform.
714 This guesses at your operating system (and compiler, if necessary) and
715 configures OpenSSL based on this guess. Run ./config -t to see
716 if it guessed correctly. If you want to use a different compiler, you
717 are cross-compiling for another platform, or the ./config guess was
718 wrong for other reasons, go to step 1b. Otherwise go to step 2.
720 On some systems, you can include debugging information as follows:
722 $ ./config -d [[ options ]]
724 1b. Configure OpenSSL for your operating system manually
726 OpenSSL knows about a range of different operating system, hardware and
727 compiler combinations. To see the ones it knows about, run
733 $ perl Configure # All other platforms
735 For the remainder of this text, the Unix form will be used in all
736 examples, please use the appropriate form for your platform.
738 Pick a suitable name from the list that matches your system. For most
739 operating systems there is a choice between using "cc" or "gcc". When
740 you have identified your system (and if necessary compiler) use this name
741 as the argument to Configure. For example, a "linux-elf" user would
744 $ ./Configure linux-elf [[ options ]]
746 If your system isn't listed, you will have to create a configuration
747 file named Configurations/{{ something }}.conf and add the correct
748 configuration for your system. See the available configs as examples
749 and read Configurations/README and Configurations/README.design for
752 The generic configurations "cc" or "gcc" should usually work on 32 bit
755 Configure creates a build file ("Makefile" on Unix, "makefile" on Windows
756 and "descrip.mms" on OpenVMS) from a suitable template in Configurations,
757 and defines various macros in include/openssl/opensslconf.h (generated from
758 include/openssl/opensslconf.h.in).
760 1c. Configure OpenSSL for building outside of the source tree.
762 OpenSSL can be configured to build in a build directory separate from
763 the directory with the source code. It's done by placing yourself in
764 some other directory and invoking the configuration commands from
769 $ mkdir /var/tmp/openssl-build
770 $ cd /var/tmp/openssl-build
771 $ /PATH/TO/OPENSSL/SOURCE/config [[ options ]]
775 $ /PATH/TO/OPENSSL/SOURCE/Configure {{ target }} [[ options ]]
779 $ set default sys$login:
780 $ create/dir [.tmp.openssl-build]
781 $ set default [.tmp.openssl-build]
782 $ @[PATH.TO.OPENSSL.SOURCE]config [[ options ]]
786 $ @[PATH.TO.OPENSSL.SOURCE]Configure {{ target }} [[ options ]]
791 $ mkdir \temp-openssl
793 $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure {{ target }} [[ options ]]
795 Paths can be relative just as well as absolute. Configure will
796 do its best to translate them to relative paths whenever possible.
798 2. Build OpenSSL by running:
801 $ mms ! (or mmk) OpenVMS
804 This will build the OpenSSL libraries (libcrypto.a and libssl.a on
805 Unix, corresponding on other platforms) and the OpenSSL binary
806 ("openssl"). The libraries will be built in the top-level directory,
807 and the binary will be in the "apps" subdirectory.
811 If the build fails, look at the output. There may be reasons
812 for the failure that aren't problems in OpenSSL itself (like
813 missing standard headers).
815 If the build succeeded previously, but fails after a source or
816 configuration change, it might be helpful to clean the build tree
817 before attempting another build. Use this command:
820 $ mms clean ! (or mmk) OpenVMS
821 $ nmake clean # Windows
823 Assembler error messages can sometimes be sidestepped by using the
824 "no-asm" configuration option.
826 Compiling parts of OpenSSL with gcc and others with the system
827 compiler will result in unresolved symbols on some systems.
829 If you are still having problems you can get help by sending an email
830 to the openssl-users email list (see
831 https://www.openssl.org/community/mailinglists.html for details). If
832 it is a bug with OpenSSL itself, please open an issue on GitHub, at
833 https://github.com/openssl/openssl/issues. Please review the existing
834 ones first; maybe the bug was already reported or has already been
837 3. After a successful build, the libraries should be tested. Run:
841 $ nmake test # Windows
843 NOTE: you MUST run the tests from an unprivileged account (or
844 disable your privileges temporarily if your platform allows it).
846 If some tests fail, look at the output. There may be reasons for
847 the failure that isn't a problem in OpenSSL itself (like a
848 malfunction with Perl). You may want increased verbosity, that
849 can be accomplished like this:
851 $ make VERBOSE=1 test # Unix
853 $ mms /macro=(VERBOSE=1) test ! OpenVMS
855 $ nmake VERBOSE=1 test # Windows
857 If you want to run just one or a few specific tests, you can use
858 the make variable TESTS to specify them, like this:
860 $ make TESTS='test_rsa test_dsa' test # Unix
861 $ mms/macro="TESTS=test_rsa test_dsa" test ! OpenVMS
862 $ nmake TESTS='test_rsa test_dsa' test # Windows
864 And of course, you can combine (Unix example shown):
866 $ make VERBOSE=1 TESTS='test_rsa test_dsa' test
868 You can find the list of available tests like this:
870 $ make list-tests # Unix
871 $ mms list-tests ! OpenVMS
872 $ nmake list-tests # Windows
874 Have a look at the manual for the perl module Test::Harness to
875 see what other HARNESS_* variables there are.
877 If you find a problem with OpenSSL itself, try removing any
878 compiler optimization flags from the CFLAGS line in Makefile and
879 run "make clean; make" or corresponding.
881 To report a bug please open an issue on GitHub, at
882 https://github.com/openssl/openssl/issues.
884 For more details on how the make variables TESTS can be used,
885 see section TESTS in Detail below.
887 4. If everything tests ok, install OpenSSL with
889 $ make install # Unix
890 $ mms install ! OpenVMS
891 $ nmake install # Windows
893 This will install all the software components in this directory
894 tree under PREFIX (the directory given with --prefix or its
899 bin/ Contains the openssl binary and a few other
902 Contains the header files needed if you want
903 to build your own programs that use libcrypto
905 lib Contains the OpenSSL library files.
906 lib/engines Contains the OpenSSL dynamically loadable engines.
908 share/man/man1 Contains the OpenSSL command line man-pages.
909 share/man/man3 Contains the OpenSSL library calls man-pages.
910 share/man/man5 Contains the OpenSSL configuration format man-pages.
911 share/man/man7 Contains the OpenSSL other misc man-pages.
913 share/doc/openssl/html/man1
914 share/doc/openssl/html/man3
915 share/doc/openssl/html/man5
916 share/doc/openssl/html/man7
917 Contains the HTML rendition of the man-pages.
919 OpenVMS ('arch' is replaced with the architecture name, "Alpha"
920 or "ia64", 'sover' is replaced with the shared library version
921 (0101 for 1.1), and 'pz' is replaced with the pointer size
922 OpenSSL was built with):
924 [.EXE.'arch'] Contains the openssl binary.
925 [.EXE] Contains a few utility scripts.
927 Contains the header files needed if you want
928 to build your own programs that use libcrypto
930 [.LIB.'arch'] Contains the OpenSSL library files.
931 [.ENGINES'sover''pz'.'arch']
932 Contains the OpenSSL dynamically loadable engines.
933 [.SYS$STARTUP] Contains startup, login and shutdown scripts.
934 These define appropriate logical names and
936 [.SYSTEST] Contains the installation verification procedure.
937 [.HTML] Contains the HTML rendition of the manual pages.
940 Additionally, install will add the following directories under
941 OPENSSLDIR (the directory given with --openssldir or its default)
944 certs Initially empty, this is the default location
945 for certificate files.
946 private Initially empty, this is the default location
947 for private key files.
948 misc Various scripts.
950 Package builders who want to configure the library for standard
951 locations, but have the package installed somewhere else so that
952 it can easily be packaged, can use
954 $ make DESTDIR=/tmp/package-root install # Unix
955 $ mms/macro="DESTDIR=TMP:[PACKAGE-ROOT]" install ! OpenVMS
957 The specified destination directory will be prepended to all
958 installation target paths.
960 Compatibility issues with previous OpenSSL versions:
962 * COMPILING existing applications
964 Starting with version 1.1.0, OpenSSL hides a number of structures
965 that were previously open. This includes all internal libssl
966 structures and a number of EVP types. Accessor functions have
967 been added to allow controlled access to the structures' data.
969 This means that some software needs to be rewritten to adapt to
970 the new ways of doing things. This often amounts to allocating
971 an instance of a structure explicitly where you could previously
972 allocate them on the stack as automatic variables, and using the
973 provided accessor functions where you would previously access a
974 structure's field directly.
976 Some APIs have changed as well. However, older APIs have been
977 preserved when possible.
979 Environment Variables
980 ---------------------
982 A number of environment variables can be used to provide additional control
983 over the build process. Typically these should be defined prior to running
984 config or Configure. Not all environment variables are relevant to all
988 The name of the ar executable to use.
991 Use a different build file name than the platform default
992 ("Makefile" on Unix-like platforms, "makefile" on native Windows,
993 "descrip.mms" on OpenVMS). This requires that there is a
994 corresponding build file template. See Configurations/README
995 for further information.
998 The compiler to use. Configure will attempt to pick a default
999 compiler for your platform but this choice can be overridden
1000 using this variable. Set it to the compiler executable you wish
1001 to use, e.g. "gcc" or "clang".
1004 This environment variable has the same meaning as for the
1005 "--cross-compile-prefix" Configure flag described above. If both
1006 are set then the Configure flag takes precedence.
1009 The name of the nm executable to use.
1011 OPENSSL_LOCAL_CONFIG_DIR
1012 OpenSSL comes with a database of information about how it
1013 should be built on different platforms as well as build file
1014 templates for those platforms. The database is comprised of
1015 ".conf" files in the Configurations directory. The build
1016 file templates reside there as well as ".tmpl" files. See the
1017 file Configurations/README for further information about the
1018 format of ".conf" files as well as information on the ".tmpl"
1020 In addition to the standard ".conf" and ".tmpl" files, it is
1021 possible to create your own ".conf" and ".tmpl" files and store
1022 them locally, outside the OpenSSL source tree. This environment
1023 variable can be set to the directory where these files are held
1024 and will be considered by Configure before it looks in the
1025 standard directories.
1028 The name of the Perl executable to use when building OpenSSL.
1029 This variable is used in config script only. Configure on the
1030 other hand imposes the interpreter by which it itself was
1031 executed on the whole build procedure.
1034 The command string for the Perl executable to insert in the
1035 #! line of perl scripts that will be publically installed.
1036 Default: /usr/bin/env perl
1037 Note: the value of this variable is added to the same scripts
1038 on all platforms, but it's only relevant on Unix-like platforms.
1041 The name of the rc executable to use. The default will be as
1042 defined for the target platform in the ".conf" file. If not
1043 defined then "windres" will be used. The WINDRES environment
1044 variable is synonymous to this. If both are defined then RC
1048 The name of the ranlib executable to use.
1056 The Configure script generates a Makefile in a format relevant to the specific
1057 platform. The Makefiles provide a number of targets that can be used. Not all
1058 targets may be available on all platforms. Only the most common targets are
1059 described here. Examine the Makefiles themselves for the full list.
1062 The default target to build all the software components.
1065 Remove all build artefacts and return the directory to a "clean"
1069 Rebuild the dependencies in the Makefiles. This is a legacy
1070 option that no longer needs to be used since OpenSSL 1.1.0.
1073 Install all OpenSSL components.
1076 Only install the OpenSSL software components.
1079 Only install the OpenSSL documentation components.
1082 Only install the OpenSSL man pages (Unix only).
1085 Only install the OpenSSL html documentation.
1088 Prints a list of all the self test names.
1091 Build and run the OpenSSL self tests.
1094 Uninstall all OpenSSL components.
1098 Re-run the configuration process, as exactly as the last time
1102 This is a developer option. If you are developing a patch for
1103 OpenSSL you may need to use this if you want to update
1104 automatically generated files; add new error codes or add new
1105 (or change the visibility of) public API functions. (Unix only).
1110 The make variable TESTS supports a versatile set of space separated tokens
1111 with which you can specify a set of tests to be performed. With a "current
1112 set of tests" in mind, initially being empty, here are the possible tokens:
1114 alltests The current set of tests becomes the whole set of available
1115 tests (as listed when you do 'make list-tests' or similar).
1116 xxx Adds the test 'xxx' to the current set of tests.
1117 -xxx Removes 'xxx' from the current set of tests. If this is the
1118 first token in the list, the current set of tests is first
1119 assigned the whole set of available tests, effectively making
1120 this token equivalent to TESTS="alltests -xxx".
1121 nn Adds the test group 'nn' (which is a number) to the current
1123 -nn Removes the test group 'nn' from the current set of tests.
1124 If this is the first token in the list, the current set of
1125 tests is first assigned the whole set of available tests,
1126 effectively making this token equivalent to
1127 TESTS="alltests -xxx".
1129 Also, all tokens except for "alltests" may have wildcards, such as *.
1130 (on Unix and Windows, BSD style wildcards are supported, while on VMS,
1131 it's VMS style wildcards)
1133 Example: All tests except for the fuzz tests:
1135 $ make TESTS=-test_fuzz test
1137 or (if you want to be explicit)
1139 $ make TESTS='alltests -test_fuzz' test
1141 Example: All tests that have a name starting with "test_ssl" but not those
1142 starting with "test_ssl_":
1144 $ make TESTS='test_ssl* -test_ssl_*' test
1146 Example: Only test group 10:
1150 Example: All tests except the slow group (group 99):
1154 Example: All tests in test groups 80 to 99 except for tests in group 90:
1156 $ make TESTS='[89]? -90'
1158 Note on multi-threading
1159 -----------------------
1161 For some systems, the OpenSSL Configure script knows what compiler options
1162 are needed to generate a library that is suitable for multi-threaded
1163 applications. On these systems, support for multi-threading is enabled
1164 by default; use the "no-threads" option to disable (this should never be
1167 On other systems, to enable support for multi-threading, you will have
1168 to specify at least two options: "threads", and a system-dependent option.
1169 (The latter is "-D_REENTRANT" on various systems.) The default in this
1170 case, obviously, is not to include support for multi-threading (but
1171 you can still use "no-threads" to suppress an annoying warning message
1172 from the Configure script.)
1174 OpenSSL provides built-in support for two threading models: pthreads (found on
1175 most UNIX/Linux systems), and Windows threads. No other threading models are
1176 supported. If your platform does not provide pthreads or Windows threads then
1177 you should Configure with the "no-threads" option.
1179 Notes on shared libraries
1180 -------------------------
1182 For most systems the OpenSSL Configure script knows what is needed to
1183 build shared libraries for libcrypto and libssl. On these systems
1184 the shared libraries will be created by default. This can be suppressed and
1185 only static libraries created by using the "no-shared" option. On systems
1186 where OpenSSL does not know how to build shared libraries the "no-shared"
1187 option will be forced and only static libraries will be created.
1189 Shared libraries are named a little differently on different platforms.
1190 One way or another, they all have the major OpenSSL version number as
1191 part of the file name, i.e. for OpenSSL 1.1.x, 1.1 is somehow part of
1194 On most POSIX platforms, shared libraries are named libcrypto.so.1.1
1197 on Cygwin, shared libraries are named cygcrypto-1.1.dll and cygssl-1.1.dll
1198 with import libraries libcrypto.dll.a and libssl.dll.a.
1200 On Windows build with MSVC or using MingW, shared libraries are named
1201 libcrypto-1_1.dll and libssl-1_1.dll for 32-bit Windows, libcrypto-1_1-x64.dll
1202 and libssl-1_1-x64.dll for 64-bit x86_64 Windows, and libcrypto-1_1-ia64.dll
1203 and libssl-1_1-ia64.dll for IA64 Windows. With MSVC, the import libraries
1204 are named libcrypto.lib and libssl.lib, while with MingW, they are named
1205 libcrypto.dll.a and libssl.dll.a.
1207 On VMS, shareable images (VMS speak for shared libraries) are named
1208 ossl$libcrypto0101_shr.exe and ossl$libssl0101_shr.exe. However, when
1209 OpenSSL is specifically built for 32-bit pointers, the shareable images
1210 are named ossl$libcrypto0101_shr32.exe and ossl$libssl0101_shr32.exe
1211 instead, and when built for 64-bit pointers, they are named
1212 ossl$libcrypto0101_shr64.exe and ossl$libssl0101_shr64.exe.
1214 Note on random number generation
1215 --------------------------------
1217 Availability of cryptographically secure random numbers is required for
1218 secret key generation. OpenSSL provides several options to seed the
1219 internal CSPRNG. If not properly seeded, the internal CSPRNG will refuse
1220 to deliver random bytes and a "PRNG not seeded error" will occur.
1222 The seeding method can be configured using the --with-rand-seed option,
1223 which can be used to specify a comma separated list of seed methods.
1224 However in most cases OpenSSL will choose a suitable default method,
1225 so it is not necessary to explicitly provide this option. Note also
1226 that not all methods are available on all platforms.
1228 I) On operating systems which provide a suitable randomness source (in
1229 form of a system call or system device), OpenSSL will use the optimal
1230 available method to seed the CSPRNG from the operating system's
1231 randomness sources. This corresponds to the option --with-rand-seed=os.
1233 II) On systems without such a suitable randomness source, automatic seeding
1234 and reseeding is disabled (--with-rand-seed=none) and it may be necessary
1235 to install additional support software to obtain a random seed and reseed
1236 the CSPRNG manually. Please check out the manual pages for RAND_add(),
1237 RAND_bytes(), RAND_egd(), and the FAQ for more information.
projects / oweals / openssl.git / blob