5 This document describes installation on all supported operating
6 systems (the Linux/Unix family, OpenVMS and Windows)
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)
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]
120 Configuration Options
121 ---------------------
123 There are several options to ./config (or ./Configure) to customize
124 the build (note that for Windows, the defaults for --prefix and
125 --openssldir depend in what configuration is used and what Windows
126 implementation OpenSSL is built on. More notes on this in NOTES.WIN):
129 Don't build with support for deprecated APIs below the
130 specified version number. For example "--api=1.1.0" will
131 remove support for all APIS that were deprecated in OpenSSL
132 version 1.1.0 or below.
134 --cross-compile-prefix=PREFIX
135 The PREFIX to include in front of commands for your
136 toolchain. It's likely to have to end with dash, e.g.
137 a-b-c- would invoke GNU compiler as a-b-c-gcc, etc.
138 Unfortunately cross-compiling is too case-specific to
139 put together one-size-fits-all instructions. You might
140 have to pass more flags or set up environment variables
141 to actually make it work. Android and iOS cases are
142 discussed in corresponding Configurations/10-main.cf
143 sections. But there are cases when this option alone is
144 sufficient. For example to build the mingw64 target on
145 Linux "--cross-compile-prefix=x86_64-w64-mingw32-"
146 works. Naturally provided that mingw packages are
147 installed. Today Debian and Ubuntu users have option to
148 install a number of prepackaged cross-compilers along
149 with corresponding run-time and development packages for
150 "alien" hardware. To give another example
151 "--cross-compile-prefix=mipsel-linux-gnu-" suffices
152 in such case. Needless to mention that you have to
153 invoke ./Configure, not ./config, and pass your target
157 Build OpenSSL with debugging symbols.
160 The name of the directory under the top of the installation
161 directory tree (see the --prefix option) where libraries will
162 be installed. By default this is "lib". Note that on Windows
163 only ".lib" files will be stored in this location. dll files
164 will always be installed to the "bin" directory.
167 Directory for OpenSSL configuration files, and also the
168 default certificate and key store. Defaults are:
171 Windows: C:\Program Files\Common Files\SSL
172 or C:\Program Files (x86)\Common Files\SSL
173 OpenVMS: SYS$COMMON:[OPENSSL-COMMON]
176 The top of the installation directory tree. Defaults are:
179 Windows: C:\Program Files\OpenSSL
180 or C:\Program Files (x86)\OpenSSL
181 OpenVMS: SYS$COMMON:[OPENSSL-'version']
184 Build OpenSSL without debugging symbols. This is the default.
187 This is a developer flag that switches on various compiler
188 options recommended for OpenSSL development. It only works
189 when using gcc or clang as the compiler. If you are
190 developing a patch for OpenSSL then it is recommended that
191 you use this option where possible.
193 --with-zlib-include=DIR
194 The directory for the location of the zlib include file. This
195 option is only necessary if enable-zlib (see below) is used
196 and the include file is not already on the system include
200 On Unix: this is the directory containing the zlib library.
201 If not provided the system library path will be used.
202 On Windows: this is the filename of the zlib library (with or
203 without a path). This flag must be provided if the
204 zlib-dynamic option is not also used. If zlib-dynamic is used
205 then this flag is optional and a default value ("ZLIB1") is
206 used if not provided.
207 On VMS: this is the filename of the zlib library (with or
208 without a path). This flag is optional and if not provided
209 then "GNV$LIBZSHR", "GNV$LIBZSHR32" or "GNV$LIBZSHR64" is
210 used by default depending on the pointer size chosen.
213 Don't build the AFALG engine. This option will be forced if
214 on a platform that does not support AFALG.
217 Build with the Address sanitiser. This is a developer option
218 only. It may not work on all platforms and should never be
219 used in production environments. It will only work when used
220 with gcc or clang and should be used in conjunction with the
224 Do not use assembler code. On some platforms a small amount
225 of assembler code may still be used.
228 Do not build support for async operations.
231 Don't automatically load all supported ciphers and digests.
232 Typically OpenSSL will make available all of its supported
233 ciphers and digests. For a statically linked application this
234 may be undesirable if small executable size is an objective.
235 This only affects libcrypto. Ciphers and digests will have to
236 be loaded manually using EVP_add_cipher() and
237 EVP_add_digest() if this option is used. This option will
238 force a non-shared build.
241 Don't automatically load all libcrypto/libssl error strings.
242 Typically OpenSSL will automatically load human readable
243 error strings. For a statically linked application this may
244 be undesirable if small executable size is an objective.
248 Don't build the CAPI engine. This option will be forced if
249 on a platform that does not support CAPI.
252 Don't build support for CMS features
255 Don't build support for SSL/TLS compression. If this option
256 is left enabled (the default), then compression will only
257 work if the zlib or zlib-dynamic options are also chosen.
260 Build support for debugging memory allocated via
261 OPENSSL_malloc() or OPENSSL_zalloc().
263 enable-crypto-mdebug-backtrace
264 As for crypto-mdebug, but additionally provide backtrace
265 information for allocated memory.
266 TO BE USED WITH CARE: this uses GNU C functionality, and
267 is therefore not usable for non-GNU config targets. If
268 your build complains about the use of '-rdynamic' or the
269 lack of header file execinfo.h, this option is not for you.
270 ALSO NOTE that even though execinfo.h is available on your
271 system (through Gnulib), the functions might just be stubs
275 Don't build support for Certificate Transparency.
278 Don't build with support for any deprecated APIs. This is the
279 same as using "--api" and supplying the latest version
283 Don't build support for datagram based BIOs. Selecting this
284 option will also force the disabling of DTLS.
287 Don't build support for loading Dynamic Shared Objects.
290 Don't build the dynamically loaded engines. This only has an
291 effect in a "shared" build
294 Don't build support for Elliptic Curves.
297 Don't build support for binary Elliptic Curves
299 enable-ec_nistp_64_gcc_128
300 Enable support for optimised implementations of some commonly
301 used NIST elliptic curves. This is only supported on some
305 Build support for gathering entropy from EGD (Entropy
309 Don't build support for loading engines.
312 Don't compile in any error strings.
314 enable-external-tests
315 Enable building of integration with external test suites.
316 This is a developer option and may not work on all platforms.
317 The only supported external test suite at the current time is
318 the BoringSSL test suite. See the file test/README.external
322 Don't compile in filename and line number information (e.g.
323 for errors and memory allocation).
325 enable-fuzz-libfuzzer, enable-fuzz-afl
326 Build with support for fuzzing using either libfuzzer or AFL.
327 These are developer options only. They may not work on all
328 platforms and should never be used in production environments.
329 See the file fuzz/README.md for further details.
332 Don't build support for GOST based ciphersuites. Note that
333 if this feature is enabled then GOST ciphersuites are only
334 available if the GOST algorithms are also available through
335 loading an externally supplied engine.
338 Don't build the padlock engine.
341 Don't generate dependencies.
344 Don't build support for writing multiple records in one
345 go in libssl (Note: this is a different capability to the
346 pipelining functionality).
349 Don't build support for the NPN TLS extension.
352 Don't build support for OCSP.
355 Don't build with support for Position Independent Code.
358 Don't use POSIX IO capabilities.
361 Don't build support for Pre-Shared Key based ciphersuites.
364 Don't use hardware RDRAND capabilities.
367 Don't build support for RFC3779 ("X.509 Extensions for IP
368 Addresses and AS Identifiers")
371 Build support for SCTP
374 Do not create shared libraries, only static ones. See "Note
375 on shared libraries" below.
378 Don't build support for socket BIOs
381 Don't build support for SRP or SRP based ciphersuites.
384 Don't build SRTP support
387 Exclude SSE2 code paths from 32-bit x86 assembly modules.
388 Normally SSE2 extension is detected at run-time, but the
389 decision whether or not the machine code will be executed
390 is taken solely on CPU capability vector. This means that
391 if you happen to run OS kernel which does not support SSE2
392 extension on Intel P4 processor, then your application
393 might be exposed to "illegal instruction" exception.
394 There might be a way to enable support in kernel, e.g.
395 FreeBSD kernel can be compiled with CPU_ENABLE_SSE, and
396 there is a way to disengage SSE2 code paths upon application
397 start-up, but if you aim for wider "audience" running
398 such kernel, consider no-sse2. Both the 386 and
399 no-asm options imply no-sse2.
402 Build with the SSL Trace capabilities (adds the "-trace"
403 option to s_client and s_server).
406 Don't build the statically linked engines. This only
407 has an impact when not built "shared".
410 Don't use any C "stdio" features. Only libcrypto and libssl
411 can be built in this way. Using this option will suppress
412 building the command line applications. Additionally since
413 the OpenSSL tests also use the command line applications the
414 tests will also be skipped.
417 Don't build test programs or run any test.
420 Don't try to build with support for multi-threaded
424 Build with support for multi-threaded applications. Most
425 platforms will enable this by default. However if on a
426 platform where this is not the case then this will usually
427 require additional system-dependent options! See "Note on
428 multi-threading" below.
431 Don't build Time Stamping Authority support.
434 Build with the Undefined Behaviour sanitiser. This is a
435 developer option only. It may not work on all platforms and
436 should never be used in production environments. It will only
437 work when used with gcc or clang and should be used in
438 conjunction with the "-DPEDANTIC" option (or the
439 --strict-warnings option).
442 Don't build with the "UI" capability (i.e. the set of
443 features enabling text based prompts).
446 Enable additional unit test APIs. This should not typically
447 be used in production deployments.
449 enable-weak-ssl-ciphers
450 Build support for SSL/TLS ciphers that are considered "weak"
451 (e.g. RC4 based ciphersuites).
454 Build with support for zlib compression/decompression.
457 Like "zlib", but has OpenSSL load the zlib library
458 dynamically when needed. This is only supported on systems
459 where loading of shared libraries is supported.
462 In 32-bit x86 builds, when generating assembly modules,
463 use the 80386 instruction set only (the default x86 code
464 is more efficient, but requires at least a 486). Note:
465 This doesn't affect code generated by compiler, you're
466 likely to complement configuration command line with
467 suitable compiler-specific option.
470 TODO(TLS1.3): Make this enabled by default
471 Build support for TLS1.3. Note: This is a WIP feature and
472 does not currently interoperate with other TLS1.3
473 implementations! Use with caution!!
476 Don't build support for negotiating the specified SSL/TLS
477 protocol (one of ssl, ssl3, tls, tls1, tls1_1, tls1_2, dtls,
478 dtls1 or dtls1_2). If "no-tls" is selected then all of tls1,
479 tls1_1 and tls1_2 are disabled. Similarly "no-dtls" will
480 disable dtls1 and dtls1_2. The "no-ssl" option is synonymous
481 with "no-ssl3". Note this only affects version negotiation.
482 OpenSSL will still provide the methods for applications to
483 explicitly select the individual protocol versions.
486 As for no-<prot> but in addition do not build the methods for
487 applications to explicitly select individual protocol
491 Build with support for the specified algorithm, where <alg>
492 is one of: md2 or rc5.
495 Build without support for the specified algorithm, where
496 <alg> is one of: bf, blake2, camellia, cast, chacha, cmac,
497 des, dh, dsa, ecdh, ecdsa, idea, md4, mdc2, ocb, poly1305,
498 rc2, rc4, rmd160, scrypt, seed, siphash or whirlpool. The
499 "ripemd" algorithm is deprecated and if used is synonymous
502 -Dxxx, -lxxx, -Lxxx, -fxxx, -mXXX, -Kxxx
503 These system specific options will be passed through to the
504 compiler to allow you to define preprocessor symbols, specify
505 additional libraries, library directories or other compiler
506 options. It might be worth noting that some compilers
507 generate code specifically for processor the compiler
508 currently executes on. This is not necessarily what you might
509 have in mind, since it might be unsuitable for execution on
510 other, typically older, processor. Consult your compiler
514 Installation in Detail
515 ----------------------
517 1a. Configure OpenSSL for your operation system automatically:
519 NOTE: This is not available on Windows.
521 $ ./config [[ options ]] # Unix
525 $ @config [[ options ]] ! OpenVMS
527 For the remainder of this text, the Unix form will be used in all
528 examples, please use the appropriate form for your platform.
530 This guesses at your operating system (and compiler, if necessary) and
531 configures OpenSSL based on this guess. Run ./config -t to see
532 if it guessed correctly. If you want to use a different compiler, you
533 are cross-compiling for another platform, or the ./config guess was
534 wrong for other reasons, go to step 1b. Otherwise go to step 2.
536 On some systems, you can include debugging information as follows:
538 $ ./config -d [[ options ]]
540 1b. Configure OpenSSL for your operating system manually
542 OpenSSL knows about a range of different operating system, hardware and
543 compiler combinations. To see the ones it knows about, run
549 $ perl Configure # All other platforms
551 For the remainder of this text, the Unix form will be used in all
552 examples, please use the appropriate form for your platform.
554 Pick a suitable name from the list that matches your system. For most
555 operating systems there is a choice between using "cc" or "gcc". When
556 you have identified your system (and if necessary compiler) use this name
557 as the argument to Configure. For example, a "linux-elf" user would
560 $ ./Configure linux-elf [[ options ]]
562 If your system isn't listed, you will have to create a configuration
563 file named Configurations/{{ something }}.conf and add the correct
564 configuration for your system. See the available configs as examples
565 and read Configurations/README and Configurations/README.design for
568 The generic configurations "cc" or "gcc" should usually work on 32 bit
571 Configure creates a build file ("Makefile" on Unix, "makefile" on Windows
572 and "descrip.mms" on OpenVMS) from a suitable template in Configurations,
573 and defines various macros in include/openssl/opensslconf.h (generated from
574 include/openssl/opensslconf.h.in).
576 1c. Configure OpenSSL for building outside of the source tree.
578 OpenSSL can be configured to build in a build directory separate from
579 the directory with the source code. It's done by placing yourself in
580 some other directory and invoking the configuration commands from
585 $ mkdir /var/tmp/openssl-build
586 $ cd /var/tmp/openssl-build
587 $ /PATH/TO/OPENSSL/SOURCE/config [[ options ]]
591 $ /PATH/TO/OPENSSL/SOURCE/Configure {{ target }} [[ options ]]
595 $ set default sys$login:
596 $ create/dir [.tmp.openssl-build]
597 $ set default [.tmp.openssl-build]
598 $ @[PATH.TO.OPENSSL.SOURCE]config [[ options ]]
602 $ @[PATH.TO.OPENSSL.SOURCE]Configure {{ target }} [[ options ]]
607 $ mkdir \temp-openssl
609 $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure {{ target }} [[ options ]]
611 Paths can be relative just as well as absolute. Configure will
612 do its best to translate them to relative paths whenever possible.
614 2. Build OpenSSL by running:
617 $ mms ! (or mmk) OpenVMS
620 This will build the OpenSSL libraries (libcrypto.a and libssl.a on
621 Unix, corresponding on other platforms) and the OpenSSL binary
622 ("openssl"). The libraries will be built in the top-level directory,
623 and the binary will be in the "apps" subdirectory.
625 If the build fails, look at the output. There may be reasons
626 for the failure that aren't problems in OpenSSL itself (like
627 missing standard headers). If you are having problems you can
628 get help by sending an email to the openssl-users email list (see
629 https://www.openssl.org/community/mailinglists.html for details). If
630 it is a bug with OpenSSL itself, please open an issue on GitHub, at
631 https://github.com/openssl/openssl/issues. Please review the existing
632 ones first; maybe the bug was already reported or has already been
635 (If you encounter assembler error messages, try the "no-asm"
636 configuration option as an immediate fix.)
638 Compiling parts of OpenSSL with gcc and others with the system
639 compiler will result in unresolved symbols on some systems.
641 3. After a successful build, the libraries should be tested. Run:
645 $ nmake test # Windows
647 NOTE: you MUST run the tests from an unprivileged account (or
648 disable your privileges temporarily if your platform allows it).
650 If some tests fail, look at the output. There may be reasons for
651 the failure that isn't a problem in OpenSSL itself (like a
652 malfunction with Perl). You may want increased verbosity, that
653 can be accomplished like this:
655 $ make VERBOSE=1 test # Unix
657 $ mms /macro=(VERBOSE=1) test ! OpenVMS
659 $ nmake VERBOSE=1 test # Windows
661 If you want to run just one or a few specific tests, you can use
662 the make variable TESTS to specify them, like this:
664 $ make TESTS='test_rsa test_dsa' test # Unix
665 $ mms/macro="TESTS=test_rsa test_dsa" test ! OpenVMS
666 $ nmake TESTS='test_rsa test_dsa' test # Windows
668 And of course, you can combine (Unix example shown):
670 $ make VERBOSE=1 TESTS='test_rsa test_dsa' test
672 You can find the list of available tests like this:
674 $ make list-tests # Unix
675 $ mms list-tests ! OpenVMS
676 $ nmake list-tests # Windows
678 Have a look at the manual for the perl module Test::Harness to
679 see what other HARNESS_* variables there are.
681 If you find a problem with OpenSSL itself, try removing any
682 compiler optimization flags from the CFLAGS line in Makefile and
683 run "make clean; make" or corresponding.
685 Please send bug reports to <rt@openssl.org>.
687 For more details on how the make variables TESTS can be used,
688 see section TESTS in Detail below.
690 4. If everything tests ok, install OpenSSL with
692 $ make install # Unix
693 $ mms install ! OpenVMS
694 $ nmake install # Windows
696 This will install all the software components in this directory
697 tree under PREFIX (the directory given with --prefix or its
702 bin/ Contains the openssl binary and a few other
705 Contains the header files needed if you want
706 to build your own programs that use libcrypto
708 lib Contains the OpenSSL library files.
709 lib/engines Contains the OpenSSL dynamically loadable engines.
711 share/man/man1 Contains the OpenSSL command line man-pages.
712 share/man/man3 Contains the OpenSSL library calls man-pages.
713 share/man/man5 Contains the OpenSSL configuration format man-pages.
714 share/man/man7 Contains the OpenSSL other misc man-pages.
716 share/doc/openssl/html/man1
717 share/doc/openssl/html/man3
718 share/doc/openssl/html/man5
719 share/doc/openssl/html/man7
720 Contains the HTML rendition of the man-pages.
722 OpenVMS ('arch' is replaced with the architecture name, "Alpha"
723 or "ia64", 'sover' is replaced with the shared library version
724 (0101 for 1.1), and 'pz' is replaced with the pointer size
725 OpenSSL was built with):
727 [.EXE.'arch'] Contains the openssl binary.
728 [.EXE] Contains a few utility scripts.
730 Contains the header files needed if you want
731 to build your own programs that use libcrypto
733 [.LIB.'arch'] Contains the OpenSSL library files.
734 [.ENGINES'sover''pz'.'arch']
735 Contains the OpenSSL dynamically loadable engines.
736 [.SYS$STARTUP] Contains startup, login and shutdown scripts.
737 These define appropriate logical names and
739 [.SYSTEST] Contains the installation verification procedure.
740 [.HTML] Contains the HTML rendition of the manual pages.
743 Additionally, install will add the following directories under
744 OPENSSLDIR (the directory given with --openssldir or its default)
747 certs Initially empty, this is the default location
748 for certificate files.
749 private Initially empty, this is the default location
750 for private key files.
751 misc Various scripts.
753 Package builders who want to configure the library for standard
754 locations, but have the package installed somewhere else so that
755 it can easily be packaged, can use
757 $ make DESTDIR=/tmp/package-root install # Unix
758 $ mms/macro="DESTDIR=TMP:[PACKAGE-ROOT]" install ! OpenVMS
760 The specified destination directory will be prepended to all
761 installation target paths.
763 Compatibility issues with previous OpenSSL versions:
765 * COMPILING existing applications
767 OpenSSL 1.1.0 hides a number of structures that were previously
768 open. This includes all internal libssl structures and a number
769 of EVP types. Accessor functions have been added to allow
770 controlled access to the structures' data.
772 This means that some software needs to be rewritten to adapt to
773 the new ways of doing things. This often amounts to allocating
774 an instance of a structure explicitly where you could previously
775 allocate them on the stack as automatic variables, and using the
776 provided accessor functions where you would previously access a
777 structure's field directly.
779 Some APIs have changed as well. However, older APIs have been
780 preserved when possible.
782 Environment Variables
783 ---------------------
785 A number of environment variables can be used to provide additional control
786 over the build process. Typically these should be defined prior to running
787 config or Configure. Not all environment variables are relevant to all
791 The name of the ar executable to use.
794 Use a different build file name than the platform default
795 ("Makefile" on Unixly platforms, "makefile" on native Windows,
796 "descrip.mms" on OpenVMS). This requires that there is a
797 corresponding build file template. See Configurations/README
798 for further information.
801 The compiler to use. Configure will attempt to pick a default
802 compiler for your platform but this choice can be overridden
803 using this variable. Set it to the compiler executable you wish
804 to use, e.g. "gcc" or "clang".
807 This environment variable has the same meaning as for the
808 "--cross-compile-prefix" Configure flag described above. If both
809 are set then the Configure flag takes precedence.
812 The name of the nm executable to use.
814 OPENSSL_LOCAL_CONFIG_DIR
815 OpenSSL comes with a database of information about how it
816 should be built on different platforms as well as build file
817 templates for those platforms. The database is comprised of
818 ".conf" files in the Configurations directory. The build
819 file templates reside there as well as ".tmpl" files. See the
820 file Configurations/README for further information about the
821 format of ".conf" files as well as information on the ".tmpl"
823 In addition to the standard ".conf" and ".tmpl" files, it is
824 possible to create your own ".conf" and ".tmpl" files and store
825 them locally, outside the OpenSSL source tree. This environment
826 variable can be set to the directory where these files are held
827 and will be considered by Configure before it looks in the
828 standard directories.
831 The name of the Perl executable to use when building OpenSSL.
832 This variable is used in config script only. Configure on the
833 other hand imposes the interpreter by which it itself was
834 executed on the whole build procedure.
837 The command string for the Perl executable to insert in the
838 #! line of perl scripts that will be publically installed.
839 Default: /usr/bin/env perl
840 Note: the value of this variable is added to the same scripts
841 on all platforms, but it's only relevant on Unix-like platforms.
844 The name of the rc executable to use. The default will be as
845 defined for the target platform in the ".conf" file. If not
846 defined then "windres" will be used. The WINDRES environment
847 variable is synonymous to this. If both are defined then RC
851 The name of the ranlib executable to use.
859 The Configure script generates a Makefile in a format relevant to the specific
860 platform. The Makefiles provide a number of targets that can be used. Not all
861 targets may be available on all platforms. Only the most common targets are
862 described here. Examine the Makefiles themselves for the full list.
865 The default target to build all the software components.
868 Remove all build artefacts and return the directory to a "clean"
872 Rebuild the dependencies in the Makefiles. This is a legacy
873 option that no longer needs to be used in OpenSSL 1.1.0.
876 Install all OpenSSL components.
879 Only install the OpenSSL software components.
882 Only install the OpenSSL documentation components.
885 Only install the OpenSSL man pages (Unix only).
888 Only install the OpenSSL html documentation.
891 Prints a list of all the self test names.
894 Build and run the OpenSSL self tests.
897 Uninstall all OpenSSL components.
900 This is a developer option. If you are developing a patch for
901 OpenSSL you may need to use this if you want to update
902 automatically generated files; add new error codes or add new
903 (or change the visibility of) public API functions. (Unix only).
908 The make variable TESTS supports a versatile set of space separated tokens
909 with which you can specify a set of tests to be performed. With a "current
910 set of tests" in mind, initially being empty, here are the possible tokens:
912 alltests The current set of tests becomes the whole set of available
913 tests (as listed when you do 'make list-tests' or similar).
914 xxx Adds the test 'xxx' to the current set of tests.
915 -xxx Removes 'xxx' from the current set of tests. If this is the
916 first token in the list, the current set of tests is first
917 assigned the whole set of available tests, effectively making
918 this token equivalent to TESTS="alltests -xxx"
920 Also, all tokens except for "alltests" may have wildcards, such as *.
921 (on Unix and Windows, BSD style wildcards are supported, while on VMS,
922 it's VMS style wildcards)
924 Example: All tests except for the fuzz tests:
926 $ make TESTS=-test_fuzz test
928 or (if you want to be explicit)
930 $ make TESTS='alltests -test_fuzz' test
932 Example: All tests that have a name starting with "test_ssl" but not those
933 starting with "test_ssl_":
935 $ make TESTS='test_ssl* -test_ssl_*' test
937 Note on multi-threading
938 -----------------------
940 For some systems, the OpenSSL Configure script knows what compiler options
941 are needed to generate a library that is suitable for multi-threaded
942 applications. On these systems, support for multi-threading is enabled
943 by default; use the "no-threads" option to disable (this should never be
946 On other systems, to enable support for multi-threading, you will have
947 to specify at least two options: "threads", and a system-dependent option.
948 (The latter is "-D_REENTRANT" on various systems.) The default in this
949 case, obviously, is not to include support for multi-threading (but
950 you can still use "no-threads" to suppress an annoying warning message
951 from the Configure script.)
953 OpenSSL provides built-in support for two threading models: pthreads (found on
954 most UNIX/Linux systems), and Windows threads. No other threading models are
955 supported. If your platform does not provide pthreads or Windows threads then
956 you should Configure with the "no-threads" option.
958 Notes on shared libraries
959 -------------------------
961 For most systems the OpenSSL Configure script knows what is needed to
962 build shared libraries for libcrypto and libssl. On these systems
963 the shared libraries will be created by default. This can be suppressed and
964 only static libraries created by using the "no-shared" option. On systems
965 where OpenSSL does not know how to build shared libraries the "no-shared"
966 option will be forced and only static libraries will be created.
968 Shared libraries are named a little differently on different platforms.
969 One way or another, they all have the major OpenSSL version number as
970 part of the file name, i.e. for OpenSSL 1.1.x, 1.1 is somehow part of
973 On most POSIXly platforms, shared libraries are named libcrypto.so.1.1
976 on Cygwin, shared libraries are named cygcrypto-1.1.dll and cygssl-1.1.dll
977 with import libraries libcrypto.dll.a and libssl.dll.a.
979 On Windows build with MSVC or using MingW, shared libraries are named
980 libcrypto-1_1.dll and libssl-1_1.dll for 32-bit Windows, libcrypto-1_1-x64.dll
981 and libssl-1_1-x64.dll for 64-bit x86_64 Windows, and libcrypto-1_1-ia64.dll
982 and libssl-1_1-ia64.dll for IA64 Windows. With MSVC, the import libraries
983 are named libcrypto.lib and libssl.lib, while with MingW, they are named
984 libcrypto.dll.a and libssl.dll.a.
986 On VMS, shareable images (VMS speak for shared libraries) are named
987 ossl$libcrypto0101_shr.exe and ossl$libssl0101_shr.exe. However, when
988 OpenSSL is specifically built for 32-bit pointers, the shareable images
989 are named ossl$libcrypto0101_shr32.exe and ossl$libssl0101_shr32.exe
990 instead, and when built for 64-bit pointers, they are named
991 ossl$libcrypto0101_shr64.exe and ossl$libssl0101_shr64.exe.
993 Note on random number generation
994 --------------------------------
996 Availability of cryptographically secure random numbers is required for
997 secret key generation. OpenSSL provides several options to seed the
998 internal PRNG. If not properly seeded, the internal PRNG will refuse
999 to deliver random bytes and a "PRNG not seeded error" will occur.
1000 On systems without /dev/urandom (or similar) device, it may be necessary
1001 to install additional support software to obtain a random seed.
1002 Please check out the manual pages for RAND_add(), RAND_bytes(), RAND_egd(),
1003 and the FAQ for more information.
projects / openssl.git / blob