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.
430 enable-tls13downgrade
431 TODO(TLS1.3): Make this enabled by default and remove the
432 option when TLSv1.3 is out of draft
433 TLSv1.3 offers a downgrade protection mechanism. This is
434 implemented but disabled by default. It should not typically
435 be enabled except for testing purposes. Otherwise this could
436 cause problems if a pre-RFC version of OpenSSL talks to an
437 RFC implementation (it will erroneously be detected as a
441 Don't build Time Stamping Authority support.
444 Build with the Undefined Behaviour sanitiser. This is a
445 developer option only. It may not work on all platforms and
446 should never be used in production environments. It will only
447 work when used with gcc or clang and should be used in
448 conjunction with the "-DPEDANTIC" option (or the
449 --strict-warnings option).
452 Don't build with the "UI" capability (i.e. the set of
453 features enabling text based prompts).
456 Enable additional unit test APIs. This should not typically
457 be used in production deployments.
459 enable-weak-ssl-ciphers
460 Build support for SSL/TLS ciphers that are considered "weak"
461 (e.g. RC4 based ciphersuites).
464 Build with support for zlib compression/decompression.
467 Like "zlib", but has OpenSSL load the zlib library
468 dynamically when needed. This is only supported on systems
469 where loading of shared libraries is supported.
472 In 32-bit x86 builds, when generating assembly modules,
473 use the 80386 instruction set only (the default x86 code
474 is more efficient, but requires at least a 486). Note:
475 This doesn't affect code generated by compiler, you're
476 likely to complement configuration command line with
477 suitable compiler-specific option.
480 TODO(TLS1.3): Make this enabled by default
481 Build support for TLS1.3. Note: This is a WIP feature and
482 does not currently interoperate with other TLS1.3
483 implementations! Use with caution!!
486 Don't build support for negotiating the specified SSL/TLS
487 protocol (one of ssl, ssl3, tls, tls1, tls1_1, tls1_2, dtls,
488 dtls1 or dtls1_2). If "no-tls" is selected then all of tls1,
489 tls1_1 and tls1_2 are disabled. Similarly "no-dtls" will
490 disable dtls1 and dtls1_2. The "no-ssl" option is synonymous
491 with "no-ssl3". Note this only affects version negotiation.
492 OpenSSL will still provide the methods for applications to
493 explicitly select the individual protocol versions.
496 As for no-<prot> but in addition do not build the methods for
497 applications to explicitly select individual protocol
501 Build with support for the specified algorithm, where <alg>
502 is one of: md2 or rc5.
505 Build without support for the specified algorithm, where
506 <alg> is one of: bf, blake2, camellia, cast, chacha, cmac,
507 des, dh, dsa, ecdh, ecdsa, idea, md4, mdc2, ocb, poly1305,
508 rc2, rc4, rmd160, scrypt, seed, siphash or whirlpool. The
509 "ripemd" algorithm is deprecated and if used is synonymous
512 -Dxxx, -lxxx, -Lxxx, -fxxx, -mXXX, -Kxxx
513 These system specific options will be passed through to the
514 compiler to allow you to define preprocessor symbols, specify
515 additional libraries, library directories or other compiler
516 options. It might be worth noting that some compilers
517 generate code specifically for processor the compiler
518 currently executes on. This is not necessarily what you might
519 have in mind, since it might be unsuitable for execution on
520 other, typically older, processor. Consult your compiler
524 Installation in Detail
525 ----------------------
527 1a. Configure OpenSSL for your operation system automatically:
529 NOTE: This is not available on Windows.
531 $ ./config [[ options ]] # Unix
535 $ @config [[ options ]] ! OpenVMS
537 For the remainder of this text, the Unix form will be used in all
538 examples, please use the appropriate form for your platform.
540 This guesses at your operating system (and compiler, if necessary) and
541 configures OpenSSL based on this guess. Run ./config -t to see
542 if it guessed correctly. If you want to use a different compiler, you
543 are cross-compiling for another platform, or the ./config guess was
544 wrong for other reasons, go to step 1b. Otherwise go to step 2.
546 On some systems, you can include debugging information as follows:
548 $ ./config -d [[ options ]]
550 1b. Configure OpenSSL for your operating system manually
552 OpenSSL knows about a range of different operating system, hardware and
553 compiler combinations. To see the ones it knows about, run
559 $ perl Configure # All other platforms
561 For the remainder of this text, the Unix form will be used in all
562 examples, please use the appropriate form for your platform.
564 Pick a suitable name from the list that matches your system. For most
565 operating systems there is a choice between using "cc" or "gcc". When
566 you have identified your system (and if necessary compiler) use this name
567 as the argument to Configure. For example, a "linux-elf" user would
570 $ ./Configure linux-elf [[ options ]]
572 If your system isn't listed, you will have to create a configuration
573 file named Configurations/{{ something }}.conf and add the correct
574 configuration for your system. See the available configs as examples
575 and read Configurations/README and Configurations/README.design for
578 The generic configurations "cc" or "gcc" should usually work on 32 bit
581 Configure creates a build file ("Makefile" on Unix, "makefile" on Windows
582 and "descrip.mms" on OpenVMS) from a suitable template in Configurations,
583 and defines various macros in include/openssl/opensslconf.h (generated from
584 include/openssl/opensslconf.h.in).
586 1c. Configure OpenSSL for building outside of the source tree.
588 OpenSSL can be configured to build in a build directory separate from
589 the directory with the source code. It's done by placing yourself in
590 some other directory and invoking the configuration commands from
595 $ mkdir /var/tmp/openssl-build
596 $ cd /var/tmp/openssl-build
597 $ /PATH/TO/OPENSSL/SOURCE/config [[ options ]]
601 $ /PATH/TO/OPENSSL/SOURCE/Configure {{ target }} [[ options ]]
605 $ set default sys$login:
606 $ create/dir [.tmp.openssl-build]
607 $ set default [.tmp.openssl-build]
608 $ @[PATH.TO.OPENSSL.SOURCE]config [[ options ]]
612 $ @[PATH.TO.OPENSSL.SOURCE]Configure {{ target }} [[ options ]]
617 $ mkdir \temp-openssl
619 $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure {{ target }} [[ options ]]
621 Paths can be relative just as well as absolute. Configure will
622 do its best to translate them to relative paths whenever possible.
624 2. Build OpenSSL by running:
627 $ mms ! (or mmk) OpenVMS
630 This will build the OpenSSL libraries (libcrypto.a and libssl.a on
631 Unix, corresponding on other platforms) and the OpenSSL binary
632 ("openssl"). The libraries will be built in the top-level directory,
633 and the binary will be in the "apps" subdirectory.
635 If the build fails, look at the output. There may be reasons
636 for the failure that aren't problems in OpenSSL itself (like
637 missing standard headers). If you are having problems you can
638 get help by sending an email to the openssl-users email list (see
639 https://www.openssl.org/community/mailinglists.html for details). If
640 it is a bug with OpenSSL itself, please open an issue on GitHub, at
641 https://github.com/openssl/openssl/issues. Please review the existing
642 ones first; maybe the bug was already reported or has already been
645 (If you encounter assembler error messages, try the "no-asm"
646 configuration option as an immediate fix.)
648 Compiling parts of OpenSSL with gcc and others with the system
649 compiler will result in unresolved symbols on some systems.
651 3. After a successful build, the libraries should be tested. Run:
655 $ nmake test # Windows
657 NOTE: you MUST run the tests from an unprivileged account (or
658 disable your privileges temporarily if your platform allows it).
660 If some tests fail, look at the output. There may be reasons for
661 the failure that isn't a problem in OpenSSL itself (like a
662 malfunction with Perl). You may want increased verbosity, that
663 can be accomplished like this:
665 $ make VERBOSE=1 test # Unix
667 $ mms /macro=(VERBOSE=1) test ! OpenVMS
669 $ nmake VERBOSE=1 test # Windows
671 If you want to run just one or a few specific tests, you can use
672 the make variable TESTS to specify them, like this:
674 $ make TESTS='test_rsa test_dsa' test # Unix
675 $ mms/macro="TESTS=test_rsa test_dsa" test ! OpenVMS
676 $ nmake TESTS='test_rsa test_dsa' test # Windows
678 And of course, you can combine (Unix example shown):
680 $ make VERBOSE=1 TESTS='test_rsa test_dsa' test
682 You can find the list of available tests like this:
684 $ make list-tests # Unix
685 $ mms list-tests ! OpenVMS
686 $ nmake list-tests # Windows
688 Have a look at the manual for the perl module Test::Harness to
689 see what other HARNESS_* variables there are.
691 If you find a problem with OpenSSL itself, try removing any
692 compiler optimization flags from the CFLAGS line in Makefile and
693 run "make clean; make" or corresponding.
695 Please send bug reports to <rt@openssl.org>.
697 For more details on how the make variables TESTS can be used,
698 see section TESTS in Detail below.
700 4. If everything tests ok, install OpenSSL with
702 $ make install # Unix
703 $ mms install ! OpenVMS
704 $ nmake install # Windows
706 This will install all the software components in this directory
707 tree under PREFIX (the directory given with --prefix or its
712 bin/ Contains the openssl binary and a few other
715 Contains the header files needed if you want
716 to build your own programs that use libcrypto
718 lib Contains the OpenSSL library files.
719 lib/engines Contains the OpenSSL dynamically loadable engines.
721 share/man/man1 Contains the OpenSSL command line man-pages.
722 share/man/man3 Contains the OpenSSL library calls man-pages.
723 share/man/man5 Contains the OpenSSL configuration format man-pages.
724 share/man/man7 Contains the OpenSSL other misc man-pages.
726 share/doc/openssl/html/man1
727 share/doc/openssl/html/man3
728 share/doc/openssl/html/man5
729 share/doc/openssl/html/man7
730 Contains the HTML rendition of the man-pages.
732 OpenVMS ('arch' is replaced with the architecture name, "Alpha"
733 or "ia64", 'sover' is replaced with the shared library version
734 (0101 for 1.1), and 'pz' is replaced with the pointer size
735 OpenSSL was built with):
737 [.EXE.'arch'] Contains the openssl binary.
738 [.EXE] Contains a few utility scripts.
740 Contains the header files needed if you want
741 to build your own programs that use libcrypto
743 [.LIB.'arch'] Contains the OpenSSL library files.
744 [.ENGINES'sover''pz'.'arch']
745 Contains the OpenSSL dynamically loadable engines.
746 [.SYS$STARTUP] Contains startup, login and shutdown scripts.
747 These define appropriate logical names and
749 [.SYSTEST] Contains the installation verification procedure.
750 [.HTML] Contains the HTML rendition of the manual pages.
753 Additionally, install will add the following directories under
754 OPENSSLDIR (the directory given with --openssldir or its default)
757 certs Initially empty, this is the default location
758 for certificate files.
759 private Initially empty, this is the default location
760 for private key files.
761 misc Various scripts.
763 Package builders who want to configure the library for standard
764 locations, but have the package installed somewhere else so that
765 it can easily be packaged, can use
767 $ make DESTDIR=/tmp/package-root install # Unix
768 $ mms/macro="DESTDIR=TMP:[PACKAGE-ROOT]" install ! OpenVMS
770 The specified destination directory will be prepended to all
771 installation target paths.
773 Compatibility issues with previous OpenSSL versions:
775 * COMPILING existing applications
777 OpenSSL 1.1.0 hides a number of structures that were previously
778 open. This includes all internal libssl structures and a number
779 of EVP types. Accessor functions have been added to allow
780 controlled access to the structures' data.
782 This means that some software needs to be rewritten to adapt to
783 the new ways of doing things. This often amounts to allocating
784 an instance of a structure explicitly where you could previously
785 allocate them on the stack as automatic variables, and using the
786 provided accessor functions where you would previously access a
787 structure's field directly.
789 Some APIs have changed as well. However, older APIs have been
790 preserved when possible.
792 Environment Variables
793 ---------------------
795 A number of environment variables can be used to provide additional control
796 over the build process. Typically these should be defined prior to running
797 config or Configure. Not all environment variables are relevant to all
801 The name of the ar executable to use.
804 Use a different build file name than the platform default
805 ("Makefile" on Unixly platforms, "makefile" on native Windows,
806 "descrip.mms" on OpenVMS). This requires that there is a
807 corresponding build file template. See Configurations/README
808 for further information.
811 The compiler to use. Configure will attempt to pick a default
812 compiler for your platform but this choice can be overridden
813 using this variable. Set it to the compiler executable you wish
814 to use, e.g. "gcc" or "clang".
817 This environment variable has the same meaning as for the
818 "--cross-compile-prefix" Configure flag described above. If both
819 are set then the Configure flag takes precedence.
822 The name of the nm executable to use.
824 OPENSSL_LOCAL_CONFIG_DIR
825 OpenSSL comes with a database of information about how it
826 should be built on different platforms as well as build file
827 templates for those platforms. The database is comprised of
828 ".conf" files in the Configurations directory. The build
829 file templates reside there as well as ".tmpl" files. See the
830 file Configurations/README for further information about the
831 format of ".conf" files as well as information on the ".tmpl"
833 In addition to the standard ".conf" and ".tmpl" files, it is
834 possible to create your own ".conf" and ".tmpl" files and store
835 them locally, outside the OpenSSL source tree. This environment
836 variable can be set to the directory where these files are held
837 and will be considered by Configure before it looks in the
838 standard directories.
841 The name of the Perl executable to use when building OpenSSL.
842 This variable is used in config script only. Configure on the
843 other hand imposes the interpreter by which it itself was
844 executed on the whole build procedure.
847 The command string for the Perl executable to insert in the
848 #! line of perl scripts that will be publically installed.
849 Default: /usr/bin/env perl
850 Note: the value of this variable is added to the same scripts
851 on all platforms, but it's only relevant on Unix-like platforms.
854 The name of the rc executable to use. The default will be as
855 defined for the target platform in the ".conf" file. If not
856 defined then "windres" will be used. The WINDRES environment
857 variable is synonymous to this. If both are defined then RC
861 The name of the ranlib executable to use.
869 The Configure script generates a Makefile in a format relevant to the specific
870 platform. The Makefiles provide a number of targets that can be used. Not all
871 targets may be available on all platforms. Only the most common targets are
872 described here. Examine the Makefiles themselves for the full list.
875 The default target to build all the software components.
878 Remove all build artefacts and return the directory to a "clean"
882 Rebuild the dependencies in the Makefiles. This is a legacy
883 option that no longer needs to be used in OpenSSL 1.1.0.
886 Install all OpenSSL components.
889 Only install the OpenSSL software components.
892 Only install the OpenSSL documentation components.
895 Only install the OpenSSL man pages (Unix only).
898 Only install the OpenSSL html documentation.
901 Prints a list of all the self test names.
904 Build and run the OpenSSL self tests.
907 Uninstall all OpenSSL components.
910 This is a developer option. If you are developing a patch for
911 OpenSSL you may need to use this if you want to update
912 automatically generated files; add new error codes or add new
913 (or change the visibility of) public API functions. (Unix only).
918 The make variable TESTS supports a versatile set of space separated tokens
919 with which you can specify a set of tests to be performed. With a "current
920 set of tests" in mind, initially being empty, here are the possible tokens:
922 alltests The current set of tests becomes the whole set of available
923 tests (as listed when you do 'make list-tests' or similar).
924 xxx Adds the test 'xxx' to the current set of tests.
925 -xxx Removes 'xxx' from the current set of tests. If this is the
926 first token in the list, the current set of tests is first
927 assigned the whole set of available tests, effectively making
928 this token equivalent to TESTS="alltests -xxx".
929 nn Adds the test group 'nn' (which is a number) to the current
931 -nn Removes the test group 'nn' from the current set of tests.
932 If this is the first token in the list, the current set of
933 tests is first assigned the whole set of available tests,
934 effectively making this token equivalent to
935 TESTS="alltests -xxx".
937 Also, all tokens except for "alltests" may have wildcards, such as *.
938 (on Unix and Windows, BSD style wildcards are supported, while on VMS,
939 it's VMS style wildcards)
941 Example: All tests except for the fuzz tests:
943 $ make TESTS=-test_fuzz test
945 or (if you want to be explicit)
947 $ make TESTS='alltests -test_fuzz' test
949 Example: All tests that have a name starting with "test_ssl" but not those
950 starting with "test_ssl_":
952 $ make TESTS='test_ssl* -test_ssl_*' test
954 Example: Only test group 10:
958 Example: All tests except the slow group (group 99):
962 Example: All tests in test groups 80 to 99 except for tests in group 90:
964 $ make TESTS='[89]? -90'
966 Note on multi-threading
967 -----------------------
969 For some systems, the OpenSSL Configure script knows what compiler options
970 are needed to generate a library that is suitable for multi-threaded
971 applications. On these systems, support for multi-threading is enabled
972 by default; use the "no-threads" option to disable (this should never be
975 On other systems, to enable support for multi-threading, you will have
976 to specify at least two options: "threads", and a system-dependent option.
977 (The latter is "-D_REENTRANT" on various systems.) The default in this
978 case, obviously, is not to include support for multi-threading (but
979 you can still use "no-threads" to suppress an annoying warning message
980 from the Configure script.)
982 OpenSSL provides built-in support for two threading models: pthreads (found on
983 most UNIX/Linux systems), and Windows threads. No other threading models are
984 supported. If your platform does not provide pthreads or Windows threads then
985 you should Configure with the "no-threads" option.
987 Notes on shared libraries
988 -------------------------
990 For most systems the OpenSSL Configure script knows what is needed to
991 build shared libraries for libcrypto and libssl. On these systems
992 the shared libraries will be created by default. This can be suppressed and
993 only static libraries created by using the "no-shared" option. On systems
994 where OpenSSL does not know how to build shared libraries the "no-shared"
995 option will be forced and only static libraries will be created.
997 Shared libraries are named a little differently on different platforms.
998 One way or another, they all have the major OpenSSL version number as
999 part of the file name, i.e. for OpenSSL 1.1.x, 1.1 is somehow part of
1002 On most POSIXly platforms, shared libraries are named libcrypto.so.1.1
1005 on Cygwin, shared libraries are named cygcrypto-1.1.dll and cygssl-1.1.dll
1006 with import libraries libcrypto.dll.a and libssl.dll.a.
1008 On Windows build with MSVC or using MingW, shared libraries are named
1009 libcrypto-1_1.dll and libssl-1_1.dll for 32-bit Windows, libcrypto-1_1-x64.dll
1010 and libssl-1_1-x64.dll for 64-bit x86_64 Windows, and libcrypto-1_1-ia64.dll
1011 and libssl-1_1-ia64.dll for IA64 Windows. With MSVC, the import libraries
1012 are named libcrypto.lib and libssl.lib, while with MingW, they are named
1013 libcrypto.dll.a and libssl.dll.a.
1015 On VMS, shareable images (VMS speak for shared libraries) are named
1016 ossl$libcrypto0101_shr.exe and ossl$libssl0101_shr.exe. However, when
1017 OpenSSL is specifically built for 32-bit pointers, the shareable images
1018 are named ossl$libcrypto0101_shr32.exe and ossl$libssl0101_shr32.exe
1019 instead, and when built for 64-bit pointers, they are named
1020 ossl$libcrypto0101_shr64.exe and ossl$libssl0101_shr64.exe.
1022 Note on random number generation
1023 --------------------------------
1025 Availability of cryptographically secure random numbers is required for
1026 secret key generation. OpenSSL provides several options to seed the
1027 internal PRNG. If not properly seeded, the internal PRNG will refuse
1028 to deliver random bytes and a "PRNG not seeded error" will occur.
1029 On systems without /dev/urandom (or similar) device, it may be necessary
1030 to install additional support software to obtain a random seed.
1031 Please check out the manual pages for RAND_add(), RAND_bytes(), RAND_egd(),
1032 and the FAQ for more information.
projects / openssl.git / blob