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:
22 * NOTES.WIN (any supported Windows)
23 * NOTES.DJGPP (DOS platform with DJGPP)
25 Notational conventions in this document
26 ---------------------------------------
28 Throughout this document, we use the following conventions in command
31 $ command Any line starting with a dollar sign
32 ($) is a command line.
34 { word1 | word2 | word3 } This denotes a mandatory choice, to be
35 replaced with one of the given words.
36 A simple example would be this:
38 $ echo { FOO | BAR | COOKIE }
40 which is to be understood as one of
49 [ word1 | word2 | word3 ] Similar to { word1 | word2 | word3 }
50 except it's optional to give any of
51 those. In addition to the examples
52 above, this would also be valid:
56 {{ target }} This denotes a mandatory word or
57 sequence of words of some sort. A
58 simple example would be this:
62 which is to be understood to use the
63 command 'type' on some file name
64 determined by the user.
66 [[ options ]] Similar to {{ target }}, but is
69 Note that the notation assumes spaces around {, }, [, ], {{, }} and
70 [[, ]]. This is to differentiate from OpenVMS directory
71 specifications, which also use [ and ], but without spaces.
76 If you want to just get on with it, do:
92 on Windows (only pick one of the targets for configuration):
94 $ perl Configure { VC-WIN32 | VC-WIN64A | VC-WIN64I | VC-CE }
99 If any of these steps fails, see section Installation in Detail below.
101 This will build and install OpenSSL in the default location, which is:
103 Unix: normal installation directories under /usr/local
104 OpenVMS: SYS$COMMON:[OPENSSL-'version'...], where 'version' is the
105 OpenSSL version number with underscores instead of periods.
106 Windows: C:\Program Files\OpenSSL or C:\Program Files (x86)\OpenSSL
108 If you want to install it anywhere else, run config like this:
112 $ ./config --prefix=/opt/openssl --openssldir=/usr/local/ssl
116 $ @config --prefix=PROGRAM:[INSTALLS] --openssldir=SYS$MANAGER:[OPENSSL]
119 Configuration Options
120 ---------------------
122 There are several options to ./config (or ./Configure) to customize
123 the build (note that for Windows, the defaults for --prefix and
124 --openssldir depend in what configuration is used and what Windows
125 implementation OpenSSL is built on. More notes on this in NOTES.WIN):
128 Don't build with support for deprecated APIs below the
129 specified version number. For example "--api=1.1.0" will
130 remove support for all APIS that were deprecated in OpenSSL
131 version 1.1.0 or below.
133 --cross-compile-prefix=PREFIX
134 The PREFIX to include in front of commands for your
135 toolchain. It's likely to have to end with dash, e.g.
136 a-b-c- would invoke GNU compiler as a-b-c-gcc, etc.
137 Unfortunately cross-compiling is too case-specific to
138 put together one-size-fits-all instructions. You might
139 have to pass more flags or set up environment variables
140 to actually make it work. Android and iOS cases are
141 discussed in corresponding Configurations/10-main.cf
142 sections. But there are cases when this option alone is
143 sufficient. For example to build the mingw64 target on
144 Linux "--cross-compile-prefix=x86_64-w64-mingw32-"
145 works. Naturally provided that mingw packages are
146 installed. Today Debian and Ubuntu users have option to
147 install a number of prepackaged cross-compilers along
148 with corresponding run-time and development packages for
149 "alien" hardware. To give another example
150 "--cross-compile-prefix=mipsel-linux-gnu-" suffices
151 in such case. Needless to mention that you have to
152 invoke ./Configure, not ./config, and pass your target
156 Build OpenSSL with debugging symbols.
159 The name of the directory under the top of the installation
160 directory tree (see the --prefix option) where libraries will
161 be installed. By default this is "lib". Note that on Windows
162 only ".lib" files will be stored in this location. dll files
163 will always be installed to the "bin" directory.
166 Directory for OpenSSL configuration files, and also the
167 default certificate and key store. Defaults are:
170 Windows: C:\Program Files\Common Files\SSL
171 or C:\Program Files (x86)\Common Files\SSL
172 OpenVMS: SYS$COMMON:[OPENSSL-COMMON]
175 The top of the installation directory tree. Defaults are:
178 Windows: C:\Program Files\OpenSSL
179 or C:\Program Files (x86)\OpenSSL
180 OpenVMS: SYS$COMMON:[OPENSSL-'version']
183 Build OpenSSL without debugging symbols. This is the default.
186 This is a developer flag that switches on various compiler
187 options recommended for OpenSSL development. It only works
188 when using gcc or clang as the compiler. If you are
189 developing a patch for OpenSSL then it is recommended that
190 you use this option where possible.
192 --with-zlib-include=DIR
193 The directory for the location of the zlib include file. This
194 option is only necessary if enable-zlib (see below) is used
195 and the include file is not already on the system include
199 On Unix: this is the directory containing the zlib library.
200 If not provided the system library path will be used.
201 On Windows: this is the filename of the zlib library (with or
202 without a path). This flag must be provided if the
203 zlib-dynamic option is not also used. If zlib-dynamic is used
204 then this flag is optional and a default value ("ZLIB1") is
205 used if not provided.
206 On VMS: this is the filename of the zlib library (with or
207 without a path). This flag is optional and if not provided
208 then "GNV$LIBZSHR", "GNV$LIBZSHR32" or "GNV$LIBZSHR64" is
209 used by default depending on the pointer size chosen.
212 Don't build the AFALG engine. This option will be forced if
213 on a platform that does not support AFALG.
216 Build with the Address sanitiser. This is a developer option
217 only. It may not work on all platforms and should never be
218 used in production environments. It will only work when used
219 with gcc or clang and should be used in conjunction with the
223 Do not use assembler code. On some platforms a small amount
224 of assembler code may still be used.
227 Do not build support for async operations.
230 Don't automatically load all supported ciphers and digests.
231 Typically OpenSSL will make available all of its supported
232 ciphers and digests. For a statically linked application this
233 may be undesirable if small executable size is an objective.
234 This only affects libcrypto. Ciphers and digests will have to
235 be loaded manually using EVP_add_cipher() and
236 EVP_add_digest() if this option is used. This option will
237 force a non-shared build.
240 Don't automatically load all libcrypto/libssl error strings.
241 Typically OpenSSL will automatically load human readable
242 error strings. For a statically linked application this may
243 be undesirable if small executable size is an objective.
247 Don't build the CAPI engine. This option will be forced if
248 on a platform that does not support CAPI.
251 Don't build support for CMS features
254 Don't build support for SSL/TLS compression. If this option
255 is left enabled (the default), then compression will only
256 work if the zlib or zlib-dynamic options are also chosen.
259 Build support for debugging memory allocated via
260 OPENSSL_malloc() or OPENSSL_zalloc().
262 enable-crypto-mdebug-backtrace
263 As for crypto-mdebug, but additionally provide backtrace
264 information for allocated memory.
265 TO BE USED WITH CARE: this uses GNU C functionality, and
266 is therefore not usable for non-GNU config targets. If
267 your build complains about the use of '-rdynamic' or the
268 lack of header file execinfo.h, this option is not for you.
269 ALSO NOTE that even though execinfo.h is available on your
270 system (through Gnulib), the functions might just be stubs
274 Don't build support for Certificate Transparency.
277 Don't build with support for any deprecated APIs. This is the
278 same as using "--api" and supplying the latest version
282 Don't build support for datagram based BIOs. Selecting this
283 option will also force the disabling of DTLS.
286 Don't build support for loading Dynamic Shared Objects.
289 Don't build the dynamically loaded engines. This only has an
290 effect in a "shared" build
293 Don't build support for Elliptic Curves.
296 Don't build support for binary Elliptic Curves
298 enable-ec_nistp_64_gcc_128
299 Enable support for optimised implementations of some commonly
300 used NIST elliptic curves. This is only supported on some
304 Build support for gathering entropy from EGD (Entropy
308 Don't build support for loading engines.
311 Don't compile in any error strings.
313 enable-external-tests
314 Enable building of integration with external test suites.
315 This is a developer option and may not work on all platforms.
316 The only supported external test suite at the current time is
317 the BoringSSL test suite. See the file test/README.external
321 Don't compile in filename and line number information (e.g.
322 for errors and memory allocation).
324 enable-fuzz-libfuzzer, enable-fuzz-afl
325 Build with support for fuzzing using either libfuzzer or AFL.
326 These are developer options only. They may not work on all
327 platforms and should never be used in production environments.
328 See the file fuzz/README.md for further details.
331 Don't build support for GOST based ciphersuites. Note that
332 if this feature is enabled then GOST ciphersuites are only
333 available if the GOST algorithms are also available through
334 loading an externally supplied engine.
337 Don't build the padlock engine.
340 Don't generate dependencies.
343 Don't build support for writing multiple records in one
344 go in libssl (Note: this is a different capability to the
345 pipelining functionality).
348 Don't build support for the NPN TLS extension.
351 Don't build support for OCSP.
354 Don't build with support for Position Independent Code.
357 Don't use POSIX IO capabilities.
360 Don't build support for Pre-Shared Key based ciphersuites.
363 Don't use hardware RDRAND capabilities.
366 Don't build support for RFC3779 ("X.509 Extensions for IP
367 Addresses and AS Identifiers")
370 Build support for SCTP
373 Do not create shared libraries, only static ones. See "Note
374 on shared libraries" below.
377 Don't build support for socket BIOs
380 Don't build support for SRP or SRP based ciphersuites.
383 Don't build SRTP support
386 Exclude SSE2 code paths from 32-bit x86 assembly modules.
387 Normally SSE2 extension is detected at run-time, but the
388 decision whether or not the machine code will be executed
389 is taken solely on CPU capability vector. This means that
390 if you happen to run OS kernel which does not support SSE2
391 extension on Intel P4 processor, then your application
392 might be exposed to "illegal instruction" exception.
393 There might be a way to enable support in kernel, e.g.
394 FreeBSD kernel can be compiled with CPU_ENABLE_SSE, and
395 there is a way to disengage SSE2 code paths upon application
396 start-up, but if you aim for wider "audience" running
397 such kernel, consider no-sse2. Both the 386 and
398 no-asm options imply no-sse2.
401 Build with the SSL Trace capabilities (adds the "-trace"
402 option to s_client and s_server).
405 Don't build the statically linked engines. This only
406 has an impact when not built "shared".
409 Don't use any C "stdio" features. Only libcrypto and libssl
410 can be built in this way. Using this option will suppress
411 building the command line applications. Additionally since
412 the OpenSSL tests also use the command line applications the
413 tests will also be skipped.
416 Don't build test programs or run any test.
419 Don't try to build with support for multi-threaded
423 Build with support for multi-threaded applications. Most
424 platforms will enable this by default. However if on a
425 platform where this is not the case then this will usually
426 require additional system-dependent options! See "Note on
427 multi-threading" below.
430 Don't build Time Stamping Authority support.
433 Build with the Undefined Behaviour sanitiser. This is a
434 developer option only. It may not work on all platforms and
435 should never be used in production environments. It will only
436 work when used with gcc or clang and should be used in
437 conjunction with the "-DPEDANTIC" option (or the
438 --strict-warnings option).
441 Don't build with the "UI" capability (i.e. the set of
442 features enabling text based prompts).
445 Enable additional unit test APIs. This should not typically
446 be used in production deployments.
448 enable-weak-ssl-ciphers
449 Build support for SSL/TLS ciphers that are considered "weak"
450 (e.g. RC4 based ciphersuites).
453 Build with support for zlib compression/decompression.
456 Like "zlib", but has OpenSSL load the zlib library
457 dynamically when needed. This is only supported on systems
458 where loading of shared libraries is supported.
461 In 32-bit x86 builds, when generating assembly modules,
462 use the 80386 instruction set only (the default x86 code
463 is more efficient, but requires at least a 486). Note:
464 This doesn't affect code generated by compiler, you're
465 likely to complement configuration command line with
466 suitable compiler-specific option.
469 TODO(TLS1.3): Make this enabled by default
470 Build support for TLS1.3. Note: This is a WIP feature and
471 does not currently interoperate with other TLS1.3
472 implementations! Use with caution!!
475 Don't build support for negotiating the specified SSL/TLS
476 protocol (one of ssl, ssl3, tls, tls1, tls1_1, tls1_2, dtls,
477 dtls1 or dtls1_2). If "no-tls" is selected then all of tls1,
478 tls1_1 and tls1_2 are disabled. Similarly "no-dtls" will
479 disable dtls1 and dtls1_2. The "no-ssl" option is synonymous
480 with "no-ssl3". Note this only affects version negotiation.
481 OpenSSL will still provide the methods for applications to
482 explicitly select the individual protocol versions.
485 As for no-<prot> but in addition do not build the methods for
486 applications to explicitly select individual protocol
490 Build with support for the specified algorithm, where <alg>
491 is one of: md2 or rc5.
494 Build without support for the specified algorithm, where
495 <alg> is one of: bf, blake2, camellia, cast, chacha, cmac,
496 des, dh, dsa, ecdh, ecdsa, idea, md4, mdc2, ocb, poly1305,
497 rc2, rc4, rmd160, scrypt, seed or whirlpool. The "ripemd"
498 algorithm is deprecated and if used is synonymous with rmd160.
500 -Dxxx, -lxxx, -Lxxx, -fxxx, -mXXX, -Kxxx
501 These system specific options will be passed through to the
502 compiler to allow you to define preprocessor symbols, specify
503 additional libraries, library directories or other compiler
504 options. It might be worth noting that some compilers
505 generate code specifically for processor the compiler
506 currently executes on. This is not necessarily what you might
507 have in mind, since it might be unsuitable for execution on
508 other, typically older, processor. Consult your compiler
512 Installation in Detail
513 ----------------------
515 1a. Configure OpenSSL for your operation system automatically:
517 NOTE: This is not available on Windows.
519 $ ./config [[ options ]] # Unix
523 $ @config [[ options ]] ! OpenVMS
525 For the remainder of this text, the Unix form will be used in all
526 examples, please use the appropriate form for your platform.
528 This guesses at your operating system (and compiler, if necessary) and
529 configures OpenSSL based on this guess. Run ./config -t to see
530 if it guessed correctly. If you want to use a different compiler, you
531 are cross-compiling for another platform, or the ./config guess was
532 wrong for other reasons, go to step 1b. Otherwise go to step 2.
534 On some systems, you can include debugging information as follows:
536 $ ./config -d [[ options ]]
538 1b. Configure OpenSSL for your operating system manually
540 OpenSSL knows about a range of different operating system, hardware and
541 compiler combinations. To see the ones it knows about, run
547 $ perl Configure # All other platforms
549 For the remainder of this text, the Unix form will be used in all
550 examples, please use the appropriate form for your platform.
552 Pick a suitable name from the list that matches your system. For most
553 operating systems there is a choice between using "cc" or "gcc". When
554 you have identified your system (and if necessary compiler) use this name
555 as the argument to Configure. For example, a "linux-elf" user would
558 $ ./Configure linux-elf [[ options ]]
560 If your system isn't listed, you will have to create a configuration
561 file named Configurations/{{ something }}.conf and add the correct
562 configuration for your system. See the available configs as examples
563 and read Configurations/README and Configurations/README.design for
566 The generic configurations "cc" or "gcc" should usually work on 32 bit
569 Configure creates a build file ("Makefile" on Unix, "makefile" on Windows
570 and "descrip.mms" on OpenVMS) from a suitable template in Configurations,
571 and defines various macros in include/openssl/opensslconf.h (generated from
572 include/openssl/opensslconf.h.in).
574 1c. Configure OpenSSL for building outside of the source tree.
576 OpenSSL can be configured to build in a build directory separate from
577 the directory with the source code. It's done by placing yourself in
578 some other directory and invoking the configuration commands from
583 $ mkdir /var/tmp/openssl-build
584 $ cd /var/tmp/openssl-build
585 $ /PATH/TO/OPENSSL/SOURCE/config [[ options ]]
589 $ /PATH/TO/OPENSSL/SOURCE/Configure {{ target }} [[ options ]]
593 $ set default sys$login:
594 $ create/dir [.tmp.openssl-build]
595 $ set default [.tmp.openssl-build]
596 $ @[PATH.TO.OPENSSL.SOURCE]config [[ options ]]
600 $ @[PATH.TO.OPENSSL.SOURCE]Configure {{ target }} [[ options ]]
605 $ mkdir \temp-openssl
607 $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure {{ target }} [[ options ]]
609 Paths can be relative just as well as absolute. Configure will
610 do its best to translate them to relative paths whenever possible.
612 2. Build OpenSSL by running:
615 $ mms ! (or mmk) OpenVMS
618 This will build the OpenSSL libraries (libcrypto.a and libssl.a on
619 Unix, corresponding on other platforms) and the OpenSSL binary
620 ("openssl"). The libraries will be built in the top-level directory,
621 and the binary will be in the "apps" subdirectory.
623 If the build fails, look at the output. There may be reasons
624 for the failure that aren't problems in OpenSSL itself (like
625 missing standard headers). If you are having problems you can
626 get help by sending an email to the openssl-users email list (see
627 https://www.openssl.org/community/mailinglists.html for details). If
628 it is a bug with OpenSSL itself, please open an issue on GitHub, at
629 https://github.com/openssl/openssl/issues. Please review the existing
630 ones first; maybe the bug was already reported or has already been
633 (If you encounter assembler error messages, try the "no-asm"
634 configuration option as an immediate fix.)
636 Compiling parts of OpenSSL with gcc and others with the system
637 compiler will result in unresolved symbols on some systems.
639 3. After a successful build, the libraries should be tested. Run:
643 $ nmake test # Windows
645 NOTE: you MUST run the tests from an unprivileged account (or
646 disable your privileges temporarily if your platform allows it).
648 If some tests fail, look at the output. There may be reasons for
649 the failure that isn't a problem in OpenSSL itself (like a
650 malfunction with Perl). You may want increased verbosity, that
651 can be accomplished like this:
653 $ make VERBOSE=1 test # Unix
655 $ mms /macro=(VERBOSE=1) test ! OpenVMS
657 $ nmake VERBOSE=1 test # Windows
659 If you want to run just one or a few specific tests, you can use
660 the make variable TESTS to specify them, like this:
662 $ make TESTS='test_rsa test_dsa' test # Unix
663 $ mms/macro="TESTS=test_rsa test_dsa" test ! OpenVMS
664 $ nmake TESTS='test_rsa test_dsa' test # Windows
666 And of course, you can combine (Unix example shown):
668 $ make VERBOSE=1 TESTS='test_rsa test_dsa' test
670 You can find the list of available tests like this:
672 $ make list-tests # Unix
673 $ mms list-tests ! OpenVMS
674 $ nmake list-tests # Windows
676 Have a look at the manual for the perl module Test::Harness to
677 see what other HARNESS_* variables there are.
679 If you find a problem with OpenSSL itself, try removing any
680 compiler optimization flags from the CFLAGS line in Makefile and
681 run "make clean; make" or corresponding.
683 Please send bug reports to <rt@openssl.org>.
685 For more details on how the make variables TESTS can be used,
686 see section TESTS in Detail below.
688 4. If everything tests ok, install OpenSSL with
690 $ make install # Unix
691 $ mms install ! OpenVMS
692 $ nmake install # Windows
694 This will install all the software components in this directory
695 tree under PREFIX (the directory given with --prefix or its
700 bin/ Contains the openssl binary and a few other
703 Contains the header files needed if you want
704 to build your own programs that use libcrypto
706 lib Contains the OpenSSL library files.
707 lib/engines Contains the OpenSSL dynamically loadable engines.
709 share/man/man1 Contains the OpenSSL command line man-pages.
710 share/man/man3 Contains the OpenSSL library calls man-pages.
711 share/man/man5 Contains the OpenSSL configuration format man-pages.
712 share/man/man7 Contains the OpenSSL other misc man-pages.
714 share/doc/openssl/html/man1
715 share/doc/openssl/html/man3
716 share/doc/openssl/html/man5
717 share/doc/openssl/html/man7
718 Contains the HTML rendition of the man-pages.
720 OpenVMS ('arch' is replaced with the architecture name, "Alpha"
721 or "ia64", 'sover' is replaced with the shared library version
722 (0101 for 1.1), and 'pz' is replaced with the pointer size
723 OpenSSL was built with):
725 [.EXE.'arch'] Contains the openssl binary.
726 [.EXE] Contains a few utility scripts.
728 Contains the header files needed if you want
729 to build your own programs that use libcrypto
731 [.LIB.'arch'] Contains the OpenSSL library files.
732 [.ENGINES'sover''pz'.'arch']
733 Contains the OpenSSL dynamically loadable engines.
734 [.SYS$STARTUP] Contains startup, login and shutdown scripts.
735 These define appropriate logical names and
737 [.SYSTEST] Contains the installation verification procedure.
738 [.HTML] Contains the HTML rendition of the manual pages.
741 Additionally, install will add the following directories under
742 OPENSSLDIR (the directory given with --openssldir or its default)
745 certs Initially empty, this is the default location
746 for certificate files.
747 private Initially empty, this is the default location
748 for private key files.
749 misc Various scripts.
751 Package builders who want to configure the library for standard
752 locations, but have the package installed somewhere else so that
753 it can easily be packaged, can use
755 $ make DESTDIR=/tmp/package-root install # Unix
756 $ mms/macro="DESTDIR=TMP:[PACKAGE-ROOT]" install ! OpenVMS
758 The specified destination directory will be prepended to all
759 installation target paths.
761 Compatibility issues with previous OpenSSL versions:
763 * COMPILING existing applications
765 OpenSSL 1.1.0 hides a number of structures that were previously
766 open. This includes all internal libssl structures and a number
767 of EVP types. Accessor functions have been added to allow
768 controlled access to the structures' data.
770 This means that some software needs to be rewritten to adapt to
771 the new ways of doing things. This often amounts to allocating
772 an instance of a structure explicitly where you could previously
773 allocate them on the stack as automatic variables, and using the
774 provided accessor functions where you would previously access a
775 structure's field directly.
777 Some APIs have changed as well. However, older APIs have been
778 preserved when possible.
780 Environment Variables
781 ---------------------
783 A number of environment variables can be used to provide additional control
784 over the build process. Typically these should be defined prior to running
785 config or Configure. Not all environment variables are relevant to all
789 The name of the ar executable to use.
792 Use a different build file name than the platform default
793 ("Makefile" on Unixly platforms, "makefile" on native Windows,
794 "descrip.mms" on OpenVMS). This requires that there is a
795 corresponding build file template. See Configurations/README
796 for further information.
799 The compiler to use. Configure will attempt to pick a default
800 compiler for your platform but this choice can be overridden
801 using this variable. Set it to the compiler executable you wish
802 to use, e.g. "gcc" or "clang".
805 This environment variable has the same meaning as for the
806 "--cross-compile-prefix" Configure flag described above. If both
807 are set then the Configure flag takes precedence.
810 The name of the nm executable to use.
812 OPENSSL_LOCAL_CONFIG_DIR
813 OpenSSL comes with a database of information about how it
814 should be built on different platforms as well as build file
815 templates for those platforms. The database is comprised of
816 ".conf" files in the Configurations directory. The build
817 file templates reside there as well as ".tmpl" files. See the
818 file Configurations/README for further information about the
819 format of ".conf" files as well as information on the ".tmpl"
821 In addition to the standard ".conf" and ".tmpl" files, it is
822 possible to create your own ".conf" and ".tmpl" files and store
823 them locally, outside the OpenSSL source tree. This environment
824 variable can be set to the directory where these files are held
825 and will be considered by Configure before it looks in the
826 standard directories.
829 The name of the Perl executable to use when building OpenSSL.
830 This variable is used in config script only. Configure on the
831 other hand imposes the interpreter by which it itself was
832 executed on the whole build procedure.
835 The command string for the Perl executable to insert in the
836 #! line of perl scripts that will be publically installed.
837 Default: /usr/bin/env perl
838 Note: the value of this variable is added to the same scripts
839 on all platforms, but it's only relevant on Unix-like platforms.
842 The name of the rc executable to use. The default will be as
843 defined for the target platform in the ".conf" file. If not
844 defined then "windres" will be used. The WINDRES environment
845 variable is synonymous to this. If both are defined then RC
849 The name of the ranlib executable to use.
857 The Configure script generates a Makefile in a format relevant to the specific
858 platform. The Makefiles provide a number of targets that can be used. Not all
859 targets may be available on all platforms. Only the most common targets are
860 described here. Examine the Makefiles themselves for the full list.
863 The default target to build all the software components.
866 Remove all build artefacts and return the directory to a "clean"
870 Rebuild the dependencies in the Makefiles. This is a legacy
871 option that no longer needs to be used in OpenSSL 1.1.0.
874 Install all OpenSSL components.
877 Only install the OpenSSL software components.
880 Only install the OpenSSL documentation components.
883 Only install the OpenSSL man pages (Unix only).
886 Only install the OpenSSL html documentation.
889 Prints a list of all the self test names.
892 Build and run the OpenSSL self tests.
895 Uninstall all OpenSSL components.
898 This is a developer option. If you are developing a patch for
899 OpenSSL you may need to use this if you want to update
900 automatically generated files; add new error codes or add new
901 (or change the visibility of) public API functions. (Unix only).
906 The make variable TESTS supports a versatile set of space separated tokens
907 with which you can specify a set of tests to be performed. With a "current
908 set of tests" in mind, initially being empty, here are the possible tokens:
910 alltests The current set of tests becomes the whole set of available
911 tests (as listed when you do 'make list-tests' or similar).
912 xxx Adds the test 'xxx' to the current set of tests.
913 -xxx Removes 'xxx' from the current set of tests. If this is the
914 first token in the list, the current set of tests is first
915 assigned the whole set of available tests, effectively making
916 this token equivalent to TESTS="alltests -xxx"
918 Also, all tokens except for "alltests" may have wildcards, such as *.
919 (on Unix and Windows, BSD style wildcards are supported, while on VMS,
920 it's VMS style wildcards)
922 Example: All tests except for the fuzz tests:
924 $ make TESTS=-test_fuzz test
926 or (if you want to be explicit)
928 $ make TESTS='alltests -test_fuzz' test
930 Example: All tests that have a name starting with "test_ssl" but not those
931 starting with "test_ssl_":
933 $ make TESTS='test_ssl* -test_ssl_*' test
935 Note on multi-threading
936 -----------------------
938 For some systems, the OpenSSL Configure script knows what compiler options
939 are needed to generate a library that is suitable for multi-threaded
940 applications. On these systems, support for multi-threading is enabled
941 by default; use the "no-threads" option to disable (this should never be
944 On other systems, to enable support for multi-threading, you will have
945 to specify at least two options: "threads", and a system-dependent option.
946 (The latter is "-D_REENTRANT" on various systems.) The default in this
947 case, obviously, is not to include support for multi-threading (but
948 you can still use "no-threads" to suppress an annoying warning message
949 from the Configure script.)
951 OpenSSL provides built-in support for two threading models: pthreads (found on
952 most UNIX/Linux systems), and Windows threads. No other threading models are
953 supported. If your platform does not provide pthreads or Windows threads then
954 you should Configure with the "no-threads" option.
956 Notes on shared libraries
957 -------------------------
959 For most systems the OpenSSL Configure script knows what is needed to
960 build shared libraries for libcrypto and libssl. On these systems
961 the shared libraries will be created by default. This can be suppressed and
962 only static libraries created by using the "no-shared" option. On systems
963 where OpenSSL does not know how to build shared libraries the "no-shared"
964 option will be forced and only static libraries will be created.
966 Shared libraries are named a little differently on different platforms.
967 One way or another, they all have the major OpenSSL version number as
968 part of the file name, i.e. for OpenSSL 1.1.x, 1.1 is somehow part of
971 On most POSIXly platforms, shared libraries are named libcrypto.so.1.1
974 on Cygwin, shared libraries are named cygcrypto-1.1.dll and cygssl-1.1.dll
975 with import libraries libcrypto.dll.a and libssl.dll.a.
977 On Windows build with MSVC or using MingW, shared libraries are named
978 libcrypto-1_1.dll and libssl-1_1.dll for 32-bit Windows, libcrypto-1_1-x64.dll
979 and libssl-1_1-x64.dll for 64-bit x86_64 Windows, and libcrypto-1_1-ia64.dll
980 and libssl-1_1-ia64.dll for IA64 Windows. With MSVC, the import libraries
981 are named libcrypto.lib and libssl.lib, while with MingW, they are named
982 libcrypto.dll.a and libssl.dll.a.
984 On VMS, shareable images (VMS speak for shared libraries) are named
985 ossl$libcrypto0101_shr.exe and ossl$libssl0101_shr.exe. However, when
986 OpenSSL is specifically built for 32-bit pointers, the shareable images
987 are named ossl$libcrypto0101_shr32.exe and ossl$libssl0101_shr32.exe
988 instead, and when built for 64-bit pointers, they are named
989 ossl$libcrypto0101_shr64.exe and ossl$libssl0101_shr64.exe.
991 Note on random number generation
992 --------------------------------
994 Availability of cryptographically secure random numbers is required for
995 secret key generation. OpenSSL provides several options to seed the
996 internal PRNG. If not properly seeded, the internal PRNG will refuse
997 to deliver random bytes and a "PRNG not seeded error" will occur.
998 On systems without /dev/urandom (or similar) device, it may be necessary
999 to install additional support software to obtain a random seed.
1000 Please check out the manual pages for RAND_add(), RAND_bytes(), RAND_egd(),
1001 and the FAQ for more information.
projects / openssl.git / blob