4 This document describes installation on all supported operating
5 systems (the Linux/Unix family, OpenVMS and Windows)
7 To install OpenSSL, you will need:
9 * A make implementation
10 * Perl 5 with core modules (please read NOTES.PERL)
11 * The perl module Text::Template (please read NOTES.PERL)
13 * a development environment in the form of development libraries and C
15 * a supported operating system
17 For additional platform specific requirements, solutions to specific
18 issues and other details, please read one of these:
20 * NOTES.UNIX (any supported Unix like system)
22 * NOTES.WIN (any supported Windows)
23 * NOTES.DJGPP (DOS platform with DJGPP)
24 * NOTES.ANDROID (obviously Android [NDK])
26 Notational conventions in this document
27 ---------------------------------------
29 Throughout this document, we use the following conventions in command
32 $ command Any line starting with a dollar sign
33 ($) is a command line.
35 { word1 | word2 | word3 } This denotes a mandatory choice, to be
36 replaced with one of the given words.
37 A simple example would be this:
39 $ echo { FOO | BAR | COOKIE }
41 which is to be understood as one of
50 [ word1 | word2 | word3 ] Similar to { word1 | word2 | word3 }
51 except it's optional to give any of
52 those. In addition to the examples
53 above, this would also be valid:
57 {{ target }} This denotes a mandatory word or
58 sequence of words of some sort. A
59 simple example would be this:
63 which is to be understood to use the
64 command 'type' on some file name
65 determined by the user.
67 [[ options ]] Similar to {{ target }}, but is
70 Note that the notation assumes spaces around {, }, [, ], {{, }} and
71 [[, ]]. This is to differentiate from OpenVMS directory
72 specifications, which also use [ and ], but without spaces.
77 If you want to just get on with it, do:
93 on Windows (only pick one of the targets for configuration):
95 $ perl Configure { VC-WIN32 | VC-WIN64A | VC-WIN64I | VC-CE }
100 If any of these steps fails, see section Installation in Detail below.
102 This will build and install OpenSSL in the default location, which is:
104 Unix: normal installation directories under /usr/local
105 OpenVMS: SYS$COMMON:[OPENSSL-'version'...], where 'version' is the
106 OpenSSL version number with underscores instead of periods.
107 Windows: C:\Program Files\OpenSSL or C:\Program Files (x86)\OpenSSL
109 If you want to install it anywhere else, run config like this:
113 $ ./config --prefix=/opt/openssl --openssldir=/usr/local/ssl
117 $ @config --prefix=PROGRAM:[INSTALLS] --openssldir=SYS$MANAGER:[OPENSSL]
119 (Note: if you do add options to the configuration command, please make sure
120 you've read more than just this Quick Start, such as relevant NOTES.* files,
121 the options outline below, as configuration options may change the outcome
122 in otherwise unexpected ways)
125 Configuration Options
126 ---------------------
128 There are several options to ./config (or ./Configure) to customize
129 the build (note that for Windows, the defaults for --prefix and
130 --openssldir depend in what configuration is used and what Windows
131 implementation OpenSSL is built on. More notes on this in NOTES.WIN):
134 Don't build with support for deprecated APIs below the
135 specified version number. For example "--api=1.1.0" will
136 remove support for all APIS that were deprecated in OpenSSL
137 version 1.1.0 or below.
139 --cross-compile-prefix=PREFIX
140 The PREFIX to include in front of commands for your
141 toolchain. It's likely to have to end with dash, e.g.
142 a-b-c- would invoke GNU compiler as a-b-c-gcc, etc.
143 Unfortunately cross-compiling is too case-specific to
144 put together one-size-fits-all instructions. You might
145 have to pass more flags or set up environment variables
146 to actually make it work. Android and iOS cases are
147 discussed in corresponding Configurations/10-main.cf
148 sections. But there are cases when this option alone is
149 sufficient. For example to build the mingw64 target on
150 Linux "--cross-compile-prefix=x86_64-w64-mingw32-"
151 works. Naturally provided that mingw packages are
152 installed. Today Debian and Ubuntu users have option to
153 install a number of prepackaged cross-compilers along
154 with corresponding run-time and development packages for
155 "alien" hardware. To give another example
156 "--cross-compile-prefix=mipsel-linux-gnu-" suffices
157 in such case. Needless to mention that you have to
158 invoke ./Configure, not ./config, and pass your target
162 Build OpenSSL with debugging symbols.
165 The name of the directory under the top of the installation
166 directory tree (see the --prefix option) where libraries will
167 be installed. By default this is "lib". Note that on Windows
168 only ".lib" files will be stored in this location. dll files
169 will always be installed to the "bin" directory.
172 Directory for OpenSSL configuration files, and also the
173 default certificate and key store. Defaults are:
176 Windows: C:\Program Files\Common Files\SSL
177 or C:\Program Files (x86)\Common Files\SSL
178 OpenVMS: SYS$COMMON:[OPENSSL-COMMON]
181 The top of the installation directory tree. Defaults are:
184 Windows: C:\Program Files\OpenSSL
185 or C:\Program Files (x86)\OpenSSL
186 OpenVMS: SYS$COMMON:[OPENSSL-'version']
189 Build OpenSSL without debugging symbols. This is the default.
192 This is a developer flag that switches on various compiler
193 options recommended for OpenSSL development. It only works
194 when using gcc or clang as the compiler. If you are
195 developing a patch for OpenSSL then it is recommended that
196 you use this option where possible.
198 --with-zlib-include=DIR
199 The directory for the location of the zlib include file. This
200 option is only necessary if enable-zlib (see below) is used
201 and the include file is not already on the system include
205 On Unix: this is the directory containing the zlib library.
206 If not provided the system library path will be used.
207 On Windows: this is the filename of the zlib library (with or
208 without a path). This flag must be provided if the
209 zlib-dynamic option is not also used. If zlib-dynamic is used
210 then this flag is optional and a default value ("ZLIB1") is
211 used if not provided.
212 On VMS: this is the filename of the zlib library (with or
213 without a path). This flag is optional and if not provided
214 then "GNV$LIBZSHR", "GNV$LIBZSHR32" or "GNV$LIBZSHR64" is
215 used by default depending on the pointer size chosen.
218 --with-rand-seed=seed1[,seed2,...]
219 A comma separated list of seeding methods which will be tried
220 by OpenSSL in order to obtain random input (a.k.a "entropy")
221 for seeding its cryptographically secure random number
222 generator (CSPRNG). The current seeding methods are:
224 os: Use a trusted operating system entropy source.
225 This is the default method if such an entropy
227 getrandom: Use the L<getrandom(2)> system call if available.
228 devrandom: Use the the first device from the DEVRANDOM list
229 which can be opened to read random bytes. The
230 DEVRANDOM preprocessor constant expands to
231 "/dev/urandom","/dev/random","/dev/srandom" on
232 most unix-ish operating systems.
233 egd: Check for an entropy generating daemon.
234 rdcpu: Use the RDSEED or RDRAND command if provided by
236 librandom: Use librandom (not implemented yet).
237 none: Disable automatic seeding. This is the default
238 on some operating systems where no suitable
239 entropy source exists, or no support for it is
242 For more information, see the section 'Note on random number
243 generation' at the end of this document.
246 Don't build the AFALG engine. This option will be forced if
247 on a platform that does not support AFALG.
250 Build with the Address sanitiser. This is a developer option
251 only. It may not work on all platforms and should never be
252 used in production environments. It will only work when used
253 with gcc or clang and should be used in conjunction with the
257 Do not use assembler code. On some platforms a small amount
258 of assembler code may still be used.
261 Do not build support for async operations.
264 Don't automatically load all supported ciphers and digests.
265 Typically OpenSSL will make available all of its supported
266 ciphers and digests. For a statically linked application this
267 may be undesirable if small executable size is an objective.
268 This only affects libcrypto. Ciphers and digests will have to
269 be loaded manually using EVP_add_cipher() and
270 EVP_add_digest() if this option is used. This option will
271 force a non-shared build.
274 Don't automatically load all libcrypto/libssl error strings.
275 Typically OpenSSL will automatically load human readable
276 error strings. For a statically linked application this may
277 be undesirable if small executable size is an objective.
280 Don't automatically load the default openssl.cnf file.
281 Typically OpenSSL will automatically load a system config
282 file which configures default ssl options.
285 Don't build the CAPI engine. This option will be forced if
286 on a platform that does not support CAPI.
289 Don't build support for CMS features
292 Don't build support for SSL/TLS compression. If this option
293 is left enabled (the default), then compression will only
294 work if the zlib or zlib-dynamic options are also chosen.
297 Build support for debugging memory allocated via
298 OPENSSL_malloc() or OPENSSL_zalloc().
300 enable-crypto-mdebug-backtrace
301 As for crypto-mdebug, but additionally provide backtrace
302 information for allocated memory.
303 TO BE USED WITH CARE: this uses GNU C functionality, and
304 is therefore not usable for non-GNU config targets. If
305 your build complains about the use of '-rdynamic' or the
306 lack of header file execinfo.h, this option is not for you.
307 ALSO NOTE that even though execinfo.h is available on your
308 system (through Gnulib), the functions might just be stubs
312 Don't build support for Certificate Transparency.
315 Don't build with support for any deprecated APIs. This is the
316 same as using "--api" and supplying the latest version
320 Don't build support for datagram based BIOs. Selecting this
321 option will also force the disabling of DTLS.
324 Don't build support for loading Dynamic Shared Objects.
327 Don't build the dynamically loaded engines. This only has an
328 effect in a "shared" build
331 Don't build support for Elliptic Curves.
334 Don't build support for binary Elliptic Curves
336 enable-ec_nistp_64_gcc_128
337 Enable support for optimised implementations of some commonly
338 used NIST elliptic curves. This is only supported on some
342 Build support for gathering entropy from EGD (Entropy
346 Don't build support for loading engines.
349 Don't compile in any error strings.
351 enable-external-tests
352 Enable building of integration with external test suites.
353 This is a developer option and may not work on all platforms.
354 The only supported external test suite at the current time is
355 the BoringSSL test suite. See the file test/README.external
359 Don't compile in filename and line number information (e.g.
360 for errors and memory allocation).
362 enable-fuzz-libfuzzer, enable-fuzz-afl
363 Build with support for fuzzing using either libfuzzer or AFL.
364 These are developer options only. They may not work on all
365 platforms and should never be used in production environments.
366 See the file fuzz/README.md for further details.
369 Don't build support for GOST based ciphersuites. Note that
370 if this feature is enabled then GOST ciphersuites are only
371 available if the GOST algorithms are also available through
372 loading an externally supplied engine.
375 Don't build the padlock engine.
378 Don't generate dependencies.
381 Don't build support for writing multiple records in one
382 go in libssl (Note: this is a different capability to the
383 pipelining functionality).
386 Don't build support for the NPN TLS extension.
389 Don't build support for OCSP.
392 Don't build with support for Position Independent Code.
395 Don't use POSIX IO capabilities.
398 Don't build support for Pre-Shared Key based ciphersuites.
401 Don't use hardware RDRAND capabilities.
404 Don't build support for RFC3779 ("X.509 Extensions for IP
405 Addresses and AS Identifiers")
408 Build support for SCTP
411 Do not create shared libraries, only static ones. See "Note
412 on shared libraries" below.
415 Don't build support for socket BIOs
418 Don't build support for SRP or SRP based ciphersuites.
421 Don't build SRTP support
424 Exclude SSE2 code paths from 32-bit x86 assembly modules.
425 Normally SSE2 extension is detected at run-time, but the
426 decision whether or not the machine code will be executed
427 is taken solely on CPU capability vector. This means that
428 if you happen to run OS kernel which does not support SSE2
429 extension on Intel P4 processor, then your application
430 might be exposed to "illegal instruction" exception.
431 There might be a way to enable support in kernel, e.g.
432 FreeBSD kernel can be compiled with CPU_ENABLE_SSE, and
433 there is a way to disengage SSE2 code paths upon application
434 start-up, but if you aim for wider "audience" running
435 such kernel, consider no-sse2. Both the 386 and
436 no-asm options imply no-sse2.
439 Build with the SSL Trace capabilities (adds the "-trace"
440 option to s_client and s_server).
443 Don't build the statically linked engines. This only
444 has an impact when not built "shared".
447 Don't use anything from the C header file "stdio.h" that
448 makes use of the "FILE" type. Only libcrypto and libssl can
449 be built in this way. Using this option will suppress
450 building the command line applications. Additionally since
451 the OpenSSL tests also use the command line applications the
452 tests will also be skipped.
455 Don't build test programs or run any test.
458 Don't try to build with support for multi-threaded
462 Build with support for multi-threaded applications. Most
463 platforms will enable this by default. However if on a
464 platform where this is not the case then this will usually
465 require additional system-dependent options! See "Note on
466 multi-threading" below.
468 enable-tls13downgrade
469 TODO(TLS1.3): Make this enabled by default and remove the
470 option when TLSv1.3 is out of draft
471 TLSv1.3 offers a downgrade protection mechanism. This is
472 implemented but disabled by default. It should not typically
473 be enabled except for testing purposes. Otherwise this could
474 cause problems if a pre-RFC version of OpenSSL talks to an
475 RFC implementation (it will erroneously be detected as a
479 Don't build Time Stamping Authority support.
482 Build with the Undefined Behaviour sanitiser. This is a
483 developer option only. It may not work on all platforms and
484 should never be used in production environments. It will only
485 work when used with gcc or clang and should be used in
486 conjunction with the "-DPEDANTIC" option (or the
487 --strict-warnings option).
490 Don't build with the "UI" capability (i.e. the set of
491 features enabling text based prompts).
494 Enable additional unit test APIs. This should not typically
495 be used in production deployments.
497 enable-weak-ssl-ciphers
498 Build support for SSL/TLS ciphers that are considered "weak"
499 (e.g. RC4 based ciphersuites).
502 Build with support for zlib compression/decompression.
505 Like "zlib", but has OpenSSL load the zlib library
506 dynamically when needed. This is only supported on systems
507 where loading of shared libraries is supported.
510 In 32-bit x86 builds, when generating assembly modules,
511 use the 80386 instruction set only (the default x86 code
512 is more efficient, but requires at least a 486). Note:
513 This doesn't affect code generated by compiler, you're
514 likely to complement configuration command line with
515 suitable compiler-specific option.
518 Don't build support for negotiating the specified SSL/TLS
519 protocol (one of ssl, ssl3, tls, tls1, tls1_1, tls1_2,
520 tls1_3, dtls, dtls1 or dtls1_2). If "no-tls" is selected then
521 all of tls1, tls1_1, tls1_2 and tls1_3 are disabled.
522 Similarly "no-dtls" will disable dtls1 and dtls1_2. The
523 "no-ssl" option is synonymous with "no-ssl3". Note this only
524 affects version negotiation. OpenSSL will still provide the
525 methods for applications to explicitly select the individual
529 As for no-<prot> but in addition do not build the methods for
530 applications to explicitly select individual protocol
531 versions. Note that there is no "no-tls1_3-method" option
532 because there is no application method for TLSv1.3. Using
533 individual protocol methods directly is deprecated.
534 Applications should use TLS_method() instead.
537 Build with support for the specified algorithm, where <alg>
538 is one of: md2 or rc5.
541 Build without support for the specified algorithm, where
542 <alg> is one of: aria, bf, blake2, camellia, cast, chacha,
543 cmac, des, dh, dsa, ecdh, ecdsa, idea, md4, mdc2, ocb,
544 poly1305, rc2, rc4, rmd160, scrypt, seed, siphash, sm3, sm4
545 or whirlpool. The "ripemd" algorithm is deprecated and if
546 used is synonymous with rmd160.
548 -Dxxx, -Ixxx, -Wp, -lxxx, -Lxxx, -Wl, -rpath, -R, -framework, -static
549 These system specific options will be recognised and
550 passed through to the compiler to allow you to define
551 preprocessor symbols, specify additional libraries, library
552 directories or other compiler options. It might be worth
553 noting that some compilers generate code specifically for
554 processor the compiler currently executes on. This is not
555 necessarily what you might have in mind, since it might be
556 unsuitable for execution on other, typically older,
557 processor. Consult your compiler documentation.
559 Take note of the VAR=value documentation below and how
560 these flags interact with those variables.
563 Additional options that are not otherwise recognised are
564 passed through as they are to the compiler as well. Again,
565 consult your compiler documentation.
567 Take note of the VAR=value documentation below and how
568 these flags interact with those variables.
571 Assignment of environment variable for Configure. These
572 work just like normal environment variable assignments,
573 but are supported on all platforms and are confined to
574 the configuration scripts only. These assignments override
575 the corresponding value in the inherited environment, if
578 The following variables are used as "make variables" and
579 can be used as an alternative to giving preprocessor,
580 compiler and linker options directly as configuration.
581 The following variables are supported:
583 AR The static library archiver.
584 ARFLAGS Flags for the static library archiver.
585 AS The assembler compiler.
586 ASFLAGS Flags for the assembler compiler.
588 CFLAGS Flags for the C compiler.
589 CXX The C++ compiler.
590 CXXFLAGS Flags for the C++ compiler.
591 CPP The C/C++ preprocessor.
592 CPPFLAGS Flags for the C/C++ preprocessor.
593 CPPDEFINES List of CPP macro definitions, separated
594 by a platform specific character (':' or
595 space for Unix, ';' for Windows, ',' for
596 VMS). This can be used instead of using
597 -D (or what corresponds to that on your
598 compiler) in CPPFLAGS.
599 CPPINCLUDES List of CPP inclusion directories, separated
600 the same way as for CPPDEFINES. This can
601 be used instead of -I (or what corresponds
602 to that on your compiler) in CPPFLAGS.
603 HASHBANGPERL Perl invocation to be inserted after '#!'
604 in public perl scripts (only relevant on
606 LD The program linker (not used on Unix, $(CC)
608 LDFLAGS Flags for the shared library, DSO and
610 LDLIBS Extra libraries to use when linking.
611 Takes the form of a space separated list
612 of library specifications on Unix and
613 Windows, and as a comma separated list of
615 RANLIB The library archive indexer.
616 RC The Windows resources manipulator.
617 RCFLAGS Flags for the Windows reources manipulator.
618 RM The command to remove files and directories.
620 These cannot be mixed with compiling / linking flags given
621 on the command line. In other words, something like this
624 ./config -DFOO CPPFLAGS=-DBAR -DCOOKIE
626 Backward compatibility note:
628 To be compatible with older configuration scripts, the
629 environment variables are ignored if compiling / linking
630 flags are given on the command line, except for these:
632 AR, CC, CXX, CROSS_COMPILE, HASHBANGPERL, PERL, RANLIB, RC
635 For example, the following command will not see -DBAR:
637 CPPFLAGS=-DBAR ./config -DCOOKIE
639 However, the following will see both set variables:
641 CC=gcc CROSS_COMPILE=x86_64-w64-mingw32- \
646 Reconfigure from earlier data. This fetches the previous
647 command line options and environment from data saved in
648 "configdata.pm", and runs the configuration process again,
649 using these options and environment.
650 Note: NO other option is permitted together with "reconf".
651 This means that you also MUST use "./Configure" (or
652 what corresponds to that on non-Unix platforms) directly
653 to invoke this option.
654 Note: The original configuration saves away values for ALL
655 environment variables that were used, and if they weren't
656 defined, they are still saved away with information that
657 they weren't originally defined. This information takes
658 precedence over environment variables that are defined
661 Displaying configuration data
662 -----------------------------
664 The configuration script itself will say very little, and finishes by
665 creating "configdata.pm". This perl module can be loaded by other scripts
666 to find all the configuration data, and it can also be used as a script to
667 display all sorts of configuration data in a human readable form.
669 For more information, please do:
671 $ ./configdata.pm --help # Unix
675 $ perl configdata.pm --help # Windows and VMS
677 Installation in Detail
678 ----------------------
680 1a. Configure OpenSSL for your operation system automatically:
682 NOTE: This is not available on Windows.
684 $ ./config [[ options ]] # Unix
688 $ @config [[ options ]] ! OpenVMS
690 For the remainder of this text, the Unix form will be used in all
691 examples, please use the appropriate form for your platform.
693 This guesses at your operating system (and compiler, if necessary) and
694 configures OpenSSL based on this guess. Run ./config -t to see
695 if it guessed correctly. If you want to use a different compiler, you
696 are cross-compiling for another platform, or the ./config guess was
697 wrong for other reasons, go to step 1b. Otherwise go to step 2.
699 On some systems, you can include debugging information as follows:
701 $ ./config -d [[ options ]]
703 1b. Configure OpenSSL for your operating system manually
705 OpenSSL knows about a range of different operating system, hardware and
706 compiler combinations. To see the ones it knows about, run
712 $ perl Configure # All other platforms
714 For the remainder of this text, the Unix form will be used in all
715 examples, please use the appropriate form for your platform.
717 Pick a suitable name from the list that matches your system. For most
718 operating systems there is a choice between using "cc" or "gcc". When
719 you have identified your system (and if necessary compiler) use this name
720 as the argument to Configure. For example, a "linux-elf" user would
723 $ ./Configure linux-elf [[ options ]]
725 If your system isn't listed, you will have to create a configuration
726 file named Configurations/{{ something }}.conf and add the correct
727 configuration for your system. See the available configs as examples
728 and read Configurations/README and Configurations/README.design for
731 The generic configurations "cc" or "gcc" should usually work on 32 bit
734 Configure creates a build file ("Makefile" on Unix, "makefile" on Windows
735 and "descrip.mms" on OpenVMS) from a suitable template in Configurations,
736 and defines various macros in include/openssl/opensslconf.h (generated from
737 include/openssl/opensslconf.h.in).
739 1c. Configure OpenSSL for building outside of the source tree.
741 OpenSSL can be configured to build in a build directory separate from
742 the directory with the source code. It's done by placing yourself in
743 some other directory and invoking the configuration commands from
748 $ mkdir /var/tmp/openssl-build
749 $ cd /var/tmp/openssl-build
750 $ /PATH/TO/OPENSSL/SOURCE/config [[ options ]]
754 $ /PATH/TO/OPENSSL/SOURCE/Configure {{ target }} [[ options ]]
758 $ set default sys$login:
759 $ create/dir [.tmp.openssl-build]
760 $ set default [.tmp.openssl-build]
761 $ @[PATH.TO.OPENSSL.SOURCE]config [[ options ]]
765 $ @[PATH.TO.OPENSSL.SOURCE]Configure {{ target }} [[ options ]]
770 $ mkdir \temp-openssl
772 $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure {{ target }} [[ options ]]
774 Paths can be relative just as well as absolute. Configure will
775 do its best to translate them to relative paths whenever possible.
777 2. Build OpenSSL by running:
780 $ mms ! (or mmk) OpenVMS
783 This will build the OpenSSL libraries (libcrypto.a and libssl.a on
784 Unix, corresponding on other platforms) and the OpenSSL binary
785 ("openssl"). The libraries will be built in the top-level directory,
786 and the binary will be in the "apps" subdirectory.
790 If the build fails, look at the output. There may be reasons
791 for the failure that aren't problems in OpenSSL itself (like
792 missing standard headers).
794 If the build succeeded previously, but fails after a source or
795 configuration change, it might be helpful to clean the build tree
796 before attempting another build. Use this command:
799 $ mms clean ! (or mmk) OpenVMS
800 $ nmake clean # Windows
802 Assembler error messages can sometimes be sidestepped by using the
803 "no-asm" configuration option.
805 Compiling parts of OpenSSL with gcc and others with the system
806 compiler will result in unresolved symbols on some systems.
808 If you are still having problems you can get help by sending an email
809 to the openssl-users email list (see
810 https://www.openssl.org/community/mailinglists.html for details). If
811 it is a bug with OpenSSL itself, please open an issue on GitHub, at
812 https://github.com/openssl/openssl/issues. Please review the existing
813 ones first; maybe the bug was already reported or has already been
816 3. After a successful build, the libraries should be tested. Run:
820 $ nmake test # Windows
822 NOTE: you MUST run the tests from an unprivileged account (or
823 disable your privileges temporarily if your platform allows it).
825 If some tests fail, look at the output. There may be reasons for
826 the failure that isn't a problem in OpenSSL itself (like a
827 malfunction with Perl). You may want increased verbosity, that
828 can be accomplished like this:
830 $ make VERBOSE=1 test # Unix
832 $ mms /macro=(VERBOSE=1) test ! OpenVMS
834 $ nmake VERBOSE=1 test # Windows
836 If you want to run just one or a few specific tests, you can use
837 the make variable TESTS to specify them, like this:
839 $ make TESTS='test_rsa test_dsa' test # Unix
840 $ mms/macro="TESTS=test_rsa test_dsa" test ! OpenVMS
841 $ nmake TESTS='test_rsa test_dsa' test # Windows
843 And of course, you can combine (Unix example shown):
845 $ make VERBOSE=1 TESTS='test_rsa test_dsa' test
847 You can find the list of available tests like this:
849 $ make list-tests # Unix
850 $ mms list-tests ! OpenVMS
851 $ nmake list-tests # Windows
853 Have a look at the manual for the perl module Test::Harness to
854 see what other HARNESS_* variables there are.
856 If you find a problem with OpenSSL itself, try removing any
857 compiler optimization flags from the CFLAGS line in Makefile and
858 run "make clean; make" or corresponding.
860 To report a bug please open an issue on GitHub, at
861 https://github.com/openssl/openssl/issues.
863 For more details on how the make variables TESTS can be used,
864 see section TESTS in Detail below.
866 4. If everything tests ok, install OpenSSL with
868 $ make install # Unix
869 $ mms install ! OpenVMS
870 $ nmake install # Windows
872 This will install all the software components in this directory
873 tree under PREFIX (the directory given with --prefix or its
878 bin/ Contains the openssl binary and a few other
881 Contains the header files needed if you want
882 to build your own programs that use libcrypto
884 lib Contains the OpenSSL library files.
885 lib/engines Contains the OpenSSL dynamically loadable engines.
887 share/man/man1 Contains the OpenSSL command line man-pages.
888 share/man/man3 Contains the OpenSSL library calls man-pages.
889 share/man/man5 Contains the OpenSSL configuration format man-pages.
890 share/man/man7 Contains the OpenSSL other misc man-pages.
892 share/doc/openssl/html/man1
893 share/doc/openssl/html/man3
894 share/doc/openssl/html/man5
895 share/doc/openssl/html/man7
896 Contains the HTML rendition of the man-pages.
898 OpenVMS ('arch' is replaced with the architecture name, "Alpha"
899 or "ia64", 'sover' is replaced with the shared library version
900 (0101 for 1.1), and 'pz' is replaced with the pointer size
901 OpenSSL was built with):
903 [.EXE.'arch'] Contains the openssl binary.
904 [.EXE] Contains a few utility scripts.
906 Contains the header files needed if you want
907 to build your own programs that use libcrypto
909 [.LIB.'arch'] Contains the OpenSSL library files.
910 [.ENGINES'sover''pz'.'arch']
911 Contains the OpenSSL dynamically loadable engines.
912 [.SYS$STARTUP] Contains startup, login and shutdown scripts.
913 These define appropriate logical names and
915 [.SYSTEST] Contains the installation verification procedure.
916 [.HTML] Contains the HTML rendition of the manual pages.
919 Additionally, install will add the following directories under
920 OPENSSLDIR (the directory given with --openssldir or its default)
923 certs Initially empty, this is the default location
924 for certificate files.
925 private Initially empty, this is the default location
926 for private key files.
927 misc Various scripts.
929 Package builders who want to configure the library for standard
930 locations, but have the package installed somewhere else so that
931 it can easily be packaged, can use
933 $ make DESTDIR=/tmp/package-root install # Unix
934 $ mms/macro="DESTDIR=TMP:[PACKAGE-ROOT]" install ! OpenVMS
936 The specified destination directory will be prepended to all
937 installation target paths.
939 Compatibility issues with previous OpenSSL versions:
941 * COMPILING existing applications
943 OpenSSL 1.1.0 hides a number of structures that were previously
944 open. This includes all internal libssl structures and a number
945 of EVP types. Accessor functions have been added to allow
946 controlled access to the structures' data.
948 This means that some software needs to be rewritten to adapt to
949 the new ways of doing things. This often amounts to allocating
950 an instance of a structure explicitly where you could previously
951 allocate them on the stack as automatic variables, and using the
952 provided accessor functions where you would previously access a
953 structure's field directly.
955 Some APIs have changed as well. However, older APIs have been
956 preserved when possible.
958 Environment Variables
959 ---------------------
961 A number of environment variables can be used to provide additional control
962 over the build process. Typically these should be defined prior to running
963 config or Configure. Not all environment variables are relevant to all
967 The name of the ar executable to use.
970 Use a different build file name than the platform default
971 ("Makefile" on Unixly platforms, "makefile" on native Windows,
972 "descrip.mms" on OpenVMS). This requires that there is a
973 corresponding build file template. See Configurations/README
974 for further information.
977 The compiler to use. Configure will attempt to pick a default
978 compiler for your platform but this choice can be overridden
979 using this variable. Set it to the compiler executable you wish
980 to use, e.g. "gcc" or "clang".
983 This environment variable has the same meaning as for the
984 "--cross-compile-prefix" Configure flag described above. If both
985 are set then the Configure flag takes precedence.
988 The name of the nm executable to use.
990 OPENSSL_LOCAL_CONFIG_DIR
991 OpenSSL comes with a database of information about how it
992 should be built on different platforms as well as build file
993 templates for those platforms. The database is comprised of
994 ".conf" files in the Configurations directory. The build
995 file templates reside there as well as ".tmpl" files. See the
996 file Configurations/README for further information about the
997 format of ".conf" files as well as information on the ".tmpl"
999 In addition to the standard ".conf" and ".tmpl" files, it is
1000 possible to create your own ".conf" and ".tmpl" files and store
1001 them locally, outside the OpenSSL source tree. This environment
1002 variable can be set to the directory where these files are held
1003 and will be considered by Configure before it looks in the
1004 standard directories.
1007 The name of the Perl executable to use when building OpenSSL.
1008 This variable is used in config script only. Configure on the
1009 other hand imposes the interpreter by which it itself was
1010 executed on the whole build procedure.
1013 The command string for the Perl executable to insert in the
1014 #! line of perl scripts that will be publically installed.
1015 Default: /usr/bin/env perl
1016 Note: the value of this variable is added to the same scripts
1017 on all platforms, but it's only relevant on Unix-like platforms.
1020 The name of the rc executable to use. The default will be as
1021 defined for the target platform in the ".conf" file. If not
1022 defined then "windres" will be used. The WINDRES environment
1023 variable is synonymous to this. If both are defined then RC
1027 The name of the ranlib executable to use.
1035 The Configure script generates a Makefile in a format relevant to the specific
1036 platform. The Makefiles provide a number of targets that can be used. Not all
1037 targets may be available on all platforms. Only the most common targets are
1038 described here. Examine the Makefiles themselves for the full list.
1041 The default target to build all the software components.
1044 Remove all build artefacts and return the directory to a "clean"
1048 Rebuild the dependencies in the Makefiles. This is a legacy
1049 option that no longer needs to be used in OpenSSL 1.1.0.
1052 Install all OpenSSL components.
1055 Only install the OpenSSL software components.
1058 Only install the OpenSSL documentation components.
1061 Only install the OpenSSL man pages (Unix only).
1064 Only install the OpenSSL html documentation.
1067 Prints a list of all the self test names.
1070 Build and run the OpenSSL self tests.
1073 Uninstall all OpenSSL components.
1077 Re-run the configuration process, as exactly as the last time
1081 This is a developer option. If you are developing a patch for
1082 OpenSSL you may need to use this if you want to update
1083 automatically generated files; add new error codes or add new
1084 (or change the visibility of) public API functions. (Unix only).
1089 The make variable TESTS supports a versatile set of space separated tokens
1090 with which you can specify a set of tests to be performed. With a "current
1091 set of tests" in mind, initially being empty, here are the possible tokens:
1093 alltests The current set of tests becomes the whole set of available
1094 tests (as listed when you do 'make list-tests' or similar).
1095 xxx Adds the test 'xxx' to the current set of tests.
1096 -xxx Removes 'xxx' from the current set of tests. If this is the
1097 first token in the list, the current set of tests is first
1098 assigned the whole set of available tests, effectively making
1099 this token equivalent to TESTS="alltests -xxx".
1100 nn Adds the test group 'nn' (which is a number) to the current
1102 -nn Removes the test group 'nn' from the current set of tests.
1103 If this is the first token in the list, the current set of
1104 tests is first assigned the whole set of available tests,
1105 effectively making this token equivalent to
1106 TESTS="alltests -xxx".
1108 Also, all tokens except for "alltests" may have wildcards, such as *.
1109 (on Unix and Windows, BSD style wildcards are supported, while on VMS,
1110 it's VMS style wildcards)
1112 Example: All tests except for the fuzz tests:
1114 $ make TESTS=-test_fuzz test
1116 or (if you want to be explicit)
1118 $ make TESTS='alltests -test_fuzz' test
1120 Example: All tests that have a name starting with "test_ssl" but not those
1121 starting with "test_ssl_":
1123 $ make TESTS='test_ssl* -test_ssl_*' test
1125 Example: Only test group 10:
1129 Example: All tests except the slow group (group 99):
1133 Example: All tests in test groups 80 to 99 except for tests in group 90:
1135 $ make TESTS='[89]? -90'
1137 Note on multi-threading
1138 -----------------------
1140 For some systems, the OpenSSL Configure script knows what compiler options
1141 are needed to generate a library that is suitable for multi-threaded
1142 applications. On these systems, support for multi-threading is enabled
1143 by default; use the "no-threads" option to disable (this should never be
1146 On other systems, to enable support for multi-threading, you will have
1147 to specify at least two options: "threads", and a system-dependent option.
1148 (The latter is "-D_REENTRANT" on various systems.) The default in this
1149 case, obviously, is not to include support for multi-threading (but
1150 you can still use "no-threads" to suppress an annoying warning message
1151 from the Configure script.)
1153 OpenSSL provides built-in support for two threading models: pthreads (found on
1154 most UNIX/Linux systems), and Windows threads. No other threading models are
1155 supported. If your platform does not provide pthreads or Windows threads then
1156 you should Configure with the "no-threads" option.
1158 Notes on shared libraries
1159 -------------------------
1161 For most systems the OpenSSL Configure script knows what is needed to
1162 build shared libraries for libcrypto and libssl. On these systems
1163 the shared libraries will be created by default. This can be suppressed and
1164 only static libraries created by using the "no-shared" option. On systems
1165 where OpenSSL does not know how to build shared libraries the "no-shared"
1166 option will be forced and only static libraries will be created.
1168 Shared libraries are named a little differently on different platforms.
1169 One way or another, they all have the major OpenSSL version number as
1170 part of the file name, i.e. for OpenSSL 1.1.x, 1.1 is somehow part of
1173 On most POSIXly platforms, shared libraries are named libcrypto.so.1.1
1176 on Cygwin, shared libraries are named cygcrypto-1.1.dll and cygssl-1.1.dll
1177 with import libraries libcrypto.dll.a and libssl.dll.a.
1179 On Windows build with MSVC or using MingW, shared libraries are named
1180 libcrypto-1_1.dll and libssl-1_1.dll for 32-bit Windows, libcrypto-1_1-x64.dll
1181 and libssl-1_1-x64.dll for 64-bit x86_64 Windows, and libcrypto-1_1-ia64.dll
1182 and libssl-1_1-ia64.dll for IA64 Windows. With MSVC, the import libraries
1183 are named libcrypto.lib and libssl.lib, while with MingW, they are named
1184 libcrypto.dll.a and libssl.dll.a.
1186 On VMS, shareable images (VMS speak for shared libraries) are named
1187 ossl$libcrypto0101_shr.exe and ossl$libssl0101_shr.exe. However, when
1188 OpenSSL is specifically built for 32-bit pointers, the shareable images
1189 are named ossl$libcrypto0101_shr32.exe and ossl$libssl0101_shr32.exe
1190 instead, and when built for 64-bit pointers, they are named
1191 ossl$libcrypto0101_shr64.exe and ossl$libssl0101_shr64.exe.
1193 Note on random number generation
1194 --------------------------------
1196 Availability of cryptographically secure random numbers is required for
1197 secret key generation. OpenSSL provides several options to seed the
1198 internal CSPRNG. If not properly seeded, the internal CSPRNG will refuse
1199 to deliver random bytes and a "PRNG not seeded error" will occur.
1201 The seeding method can be configured using the --with-rand-seed option,
1202 which can be used to specify a comma separated list of seed methods.
1203 However in most cases OpenSSL will choose a suitable default method,
1204 so it is not necessary to explicitely provide this option. Note also
1205 that not all methods are available on all platforms.
1207 I) On operating systems which provide a suitable randomness source (in
1208 form of a system call or system device), OpenSSL will use the optimal
1209 available method to seed the CSPRNG from the operating system's
1210 randomness sources. This corresponds to the option --with-rand-seed=os.
1212 II) On systems without such a suitable randomness source, automatic seeding
1213 and reseeding is disabled (--with-rand-seed=none) and it may be necessary
1214 to install additional support software to obtain a random seed and reseed
1215 the CSPRNG manually. Please check out the manual pages for RAND_add(),
1216 RAND_bytes(), RAND_egd(), and the FAQ for more information.
projects / openssl.git / blob