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]
119 (Note: if you do add options to the configuration command, please make sure
120 you've read more than just this Quick Start, such as relevant NOTES.* files,
121 the options outline below, as configuration options may change the outcome
122 in otherwise unexpected ways)
125 Configuration Options
126 ---------------------
128 There are several options to ./config (or ./Configure) to customize
129 the build (note that for Windows, the defaults for --prefix and
130 --openssldir depend in what configuration is used and what Windows
131 implementation OpenSSL is built on. More notes on this in NOTES.WIN):
134 Don't build with support for deprecated APIs below the
135 specified version number. For example "--api=1.1.0" will
136 remove support for all APIS that were deprecated in OpenSSL
137 version 1.1.0 or below.
139 --cross-compile-prefix=PREFIX
140 The PREFIX to include in front of commands for your
141 toolchain. It's likely to have to end with dash, e.g.
142 a-b-c- would invoke GNU compiler as a-b-c-gcc, etc.
143 Unfortunately cross-compiling is too case-specific to
144 put together one-size-fits-all instructions. You might
145 have to pass more flags or set up environment variables
146 to actually make it work. Android and iOS cases are
147 discussed in corresponding Configurations/10-main.cf
148 sections. But there are cases when this option alone is
149 sufficient. For example to build the mingw64 target on
150 Linux "--cross-compile-prefix=x86_64-w64-mingw32-"
151 works. Naturally provided that mingw packages are
152 installed. Today Debian and Ubuntu users have option to
153 install a number of prepackaged cross-compilers along
154 with corresponding run-time and development packages for
155 "alien" hardware. To give another example
156 "--cross-compile-prefix=mipsel-linux-gnu-" suffices
157 in such case. Needless to mention that you have to
158 invoke ./Configure, not ./config, and pass your target
162 Build OpenSSL with debugging symbols.
165 The name of the directory under the top of the installation
166 directory tree (see the --prefix option) where libraries will
167 be installed. By default this is "lib". Note that on Windows
168 only ".lib" files will be stored in this location. dll files
169 will always be installed to the "bin" directory.
172 Directory for OpenSSL configuration files, and also the
173 default certificate and key store. Defaults are:
176 Windows: C:\Program Files\Common Files\SSL
177 or C:\Program Files (x86)\Common Files\SSL
178 OpenVMS: SYS$COMMON:[OPENSSL-COMMON]
181 The top of the installation directory tree. Defaults are:
184 Windows: C:\Program Files\OpenSSL
185 or C:\Program Files (x86)\OpenSSL
186 OpenVMS: SYS$COMMON:[OPENSSL-'version']
189 Build OpenSSL without debugging symbols. This is the default.
192 This is a developer flag that switches on various compiler
193 options recommended for OpenSSL development. It only works
194 when using gcc or clang as the compiler. If you are
195 developing a patch for OpenSSL then it is recommended that
196 you use this option where possible.
198 --with-zlib-include=DIR
199 The directory for the location of the zlib include file. This
200 option is only necessary if enable-zlib (see below) is used
201 and the include file is not already on the system include
205 On Unix: this is the directory containing the zlib library.
206 If not provided the system library path will be used.
207 On Windows: this is the filename of the zlib library (with or
208 without a path). This flag must be provided if the
209 zlib-dynamic option is not also used. If zlib-dynamic is used
210 then this flag is optional and a default value ("ZLIB1") is
211 used if not provided.
212 On VMS: this is the filename of the zlib library (with or
213 without a path). This flag is optional and if not provided
214 then "GNV$LIBZSHR", "GNV$LIBZSHR32" or "GNV$LIBZSHR64" is
215 used by default depending on the pointer size chosen.
218 Don't build the AFALG engine. This option will be forced if
219 on a platform that does not support AFALG.
222 Build with the Address sanitiser. This is a developer option
223 only. It may not work on all platforms and should never be
224 used in production environments. It will only work when used
225 with gcc or clang and should be used in conjunction with the
229 Do not use assembler code. On some platforms a small amount
230 of assembler code may still be used.
233 Do not build support for async operations.
236 Don't automatically load all supported ciphers and digests.
237 Typically OpenSSL will make available all of its supported
238 ciphers and digests. For a statically linked application this
239 may be undesirable if small executable size is an objective.
240 This only affects libcrypto. Ciphers and digests will have to
241 be loaded manually using EVP_add_cipher() and
242 EVP_add_digest() if this option is used. This option will
243 force a non-shared build.
246 Don't automatically load all libcrypto/libssl error strings.
247 Typically OpenSSL will automatically load human readable
248 error strings. For a statically linked application this may
249 be undesirable if small executable size is an objective.
253 Don't build the CAPI engine. This option will be forced if
254 on a platform that does not support CAPI.
257 Don't build support for CMS features
260 Don't build support for SSL/TLS compression. If this option
261 is left enabled (the default), then compression will only
262 work if the zlib or zlib-dynamic options are also chosen.
265 Build support for debugging memory allocated via
266 OPENSSL_malloc() or OPENSSL_zalloc().
268 enable-crypto-mdebug-backtrace
269 As for crypto-mdebug, but additionally provide backtrace
270 information for allocated memory.
271 TO BE USED WITH CARE: this uses GNU C functionality, and
272 is therefore not usable for non-GNU config targets. If
273 your build complains about the use of '-rdynamic' or the
274 lack of header file execinfo.h, this option is not for you.
275 ALSO NOTE that even though execinfo.h is available on your
276 system (through Gnulib), the functions might just be stubs
280 Don't build support for Certificate Transparency.
283 Don't build with support for any deprecated APIs. This is the
284 same as using "--api" and supplying the latest version
288 Don't build support for datagram based BIOs. Selecting this
289 option will also force the disabling of DTLS.
292 Don't build support for loading Dynamic Shared Objects.
295 Don't build the dynamically loaded engines. This only has an
296 effect in a "shared" build
299 Don't build support for Elliptic Curves.
302 Don't build support for binary Elliptic Curves
304 enable-ec_nistp_64_gcc_128
305 Enable support for optimised implementations of some commonly
306 used NIST elliptic curves. This is only supported on some
310 Build support for gathering entropy from EGD (Entropy
314 Don't build support for loading engines.
317 Don't compile in any error strings.
320 Don't compile in filename and line number information (e.g.
321 for errors and memory allocation).
323 enable-fuzz-libfuzzer, enable-fuzz-afl
324 Build with support for fuzzing using either libfuzzer or AFL.
325 These are developer options only. They may not work on all
326 platforms and should never be used in production environments.
327 See the file fuzz/README.md for further details.
330 Don't build support for GOST based ciphersuites. Note that
331 if this feature is enabled then GOST ciphersuites are only
332 available if the GOST algorithms are also available through
333 loading an externally supplied engine.
336 Build support for DTLS heartbeats.
339 Don't build the padlock engine.
342 Don't generate dependencies.
345 Don't build support for writing multiple records in one
346 go in libssl (Note: this is a different capability to the
347 pipelining functionality).
350 Don't build support for the NPN TLS extension.
353 Don't build support for OCSP.
356 Don't build with support for Position Independent Code.
359 Don't use POSIX IO capabilities.
362 Don't build support for Pre-Shared Key based ciphersuites.
365 Don't use hardware RDRAND capabilities.
368 Don't build support for RFC3779 ("X.509 Extensions for IP
369 Addresses and AS Identifiers")
372 Build support for SCTP
375 Do not create shared libraries, only static ones. See "Note
376 on shared libraries" below.
379 Don't build support for socket BIOs
382 Don't build support for SRP or SRP based ciphersuites.
385 Don't build SRTP support
388 Exclude SSE2 code paths from 32-bit x86 assembly modules.
389 Normally SSE2 extension is detected at run-time, but the
390 decision whether or not the machine code will be executed
391 is taken solely on CPU capability vector. This means that
392 if you happen to run OS kernel which does not support SSE2
393 extension on Intel P4 processor, then your application
394 might be exposed to "illegal instruction" exception.
395 There might be a way to enable support in kernel, e.g.
396 FreeBSD kernel can be compiled with CPU_ENABLE_SSE, and
397 there is a way to disengage SSE2 code paths upon application
398 start-up, but if you aim for wider "audience" running
399 such kernel, consider no-sse2. Both the 386 and
400 no-asm options imply no-sse2.
403 Build with the SSL Trace capabilities (adds the "-trace"
404 option to s_client and s_server).
407 Don't build the statically linked engines. This only
408 has an impact when not built "shared".
411 Don't use anything from the C header file "stdio.h" that
412 makes use of the "FILE" type. Only libcrypto and libssl can
413 be built in this way. Using this option will suppress
414 building the command line applications. Additionally since
415 the OpenSSL tests also use the command line applications the
416 tests will also be skipped.
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 Don't build support for negotiating the specified SSL/TLS
470 protocol (one of ssl, ssl3, tls, tls1, tls1_1, tls1_2, dtls,
471 dtls1 or dtls1_2). If "no-tls" is selected then all of tls1,
472 tls1_1 and tls1_2 are disabled. Similarly "no-dtls" will
473 disable dtls1 and dtls1_2. The "no-ssl" option is synonymous
474 with "no-ssl3". Note this only affects version negotiation.
475 OpenSSL will still provide the methods for applications to
476 explicitly select the individual protocol versions.
479 As for no-<prot> but in addition do not build the methods for
480 applications to explicitly select individual protocol
484 Build with support for the specified algorithm, where <alg>
485 is one of: md2 or rc5.
488 Build without support for the specified algorithm, where
489 <alg> is one of: bf, blake2, camellia, cast, chacha, cmac,
490 des, dh, dsa, ecdh, ecdsa, idea, md4, mdc2, ocb, poly1305,
491 rc2, rc4, rmd160, scrypt, seed or whirlpool. The "ripemd"
492 algorithm is deprecated and if used is synonymous with rmd160.
494 -Dxxx, lxxx, -Lxxx, -Wl, -rpath, -R, -framework, -static
495 These system specific options will be recocognised and
496 passed through to the compiler to allow you to define
497 preprocessor symbols, specify additional libraries, library
498 directories or other compiler options. It might be worth
499 noting that some compilers generate code specifically for
500 processor the compiler currently executes on. This is not
501 necessarily what you might have in mind, since it might be
502 unsuitable for execution on other, typically older,
503 processor. Consult your compiler documentation.
506 Additional options that are not otherwise recognised are
507 passed through as they are to the compiler as well. Again,
508 consult your compiler documentation.
511 Installation in Detail
512 ----------------------
514 1a. Configure OpenSSL for your operation system automatically:
516 NOTE: This is not available on Windows.
518 $ ./config [[ options ]] # Unix
522 $ @config [[ options ]] ! OpenVMS
524 For the remainder of this text, the Unix form will be used in all
525 examples, please use the appropriate form for your platform.
527 This guesses at your operating system (and compiler, if necessary) and
528 configures OpenSSL based on this guess. Run ./config -t to see
529 if it guessed correctly. If you want to use a different compiler, you
530 are cross-compiling for another platform, or the ./config guess was
531 wrong for other reasons, go to step 1b. Otherwise go to step 2.
533 On some systems, you can include debugging information as follows:
535 $ ./config -d [[ options ]]
537 1b. Configure OpenSSL for your operating system manually
539 OpenSSL knows about a range of different operating system, hardware and
540 compiler combinations. To see the ones it knows about, run
546 $ perl Configure # All other platforms
548 For the remainder of this text, the Unix form will be used in all
549 examples, please use the appropriate form for your platform.
551 Pick a suitable name from the list that matches your system. For most
552 operating systems there is a choice between using "cc" or "gcc". When
553 you have identified your system (and if necessary compiler) use this name
554 as the argument to Configure. For example, a "linux-elf" user would
557 $ ./Configure linux-elf [[ options ]]
559 If your system isn't listed, you will have to create a configuration
560 file named Configurations/{{ something }}.conf and add the correct
561 configuration for your system. See the available configs as examples
562 and read Configurations/README and Configurations/README.design for
565 The generic configurations "cc" or "gcc" should usually work on 32 bit
568 Configure creates a build file ("Makefile" on Unix, "makefile" on Windows
569 and "descrip.mms" on OpenVMS) from a suitable template in Configurations,
570 and defines various macros in include/openssl/opensslconf.h (generated from
571 include/openssl/opensslconf.h.in).
573 1c. Configure OpenSSL for building outside of the source tree.
575 OpenSSL can be configured to build in a build directory separate from
576 the directory with the source code. It's done by placing yourself in
577 some other directory and invoking the configuration commands from
582 $ mkdir /var/tmp/openssl-build
583 $ cd /var/tmp/openssl-build
584 $ /PATH/TO/OPENSSL/SOURCE/config [[ options ]]
588 $ /PATH/TO/OPENSSL/SOURCE/Configure {{ target }} [[ options ]]
592 $ set default sys$login:
593 $ create/dir [.tmp.openssl-build]
594 $ set default [.tmp.openssl-build]
595 $ @[PATH.TO.OPENSSL.SOURCE]config [[ options ]]
599 $ @[PATH.TO.OPENSSL.SOURCE]Configure {{ target }} [[ options ]]
604 $ mkdir \temp-openssl
606 $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure {{ target }} [[ options ]]
608 Paths can be relative just as well as absolute. Configure will
609 do its best to translate them to relative paths whenever possible.
611 2. Build OpenSSL by running:
614 $ mms ! (or mmk) OpenVMS
617 This will build the OpenSSL libraries (libcrypto.a and libssl.a on
618 Unix, corresponding on other platforms) and the OpenSSL binary
619 ("openssl"). The libraries will be built in the top-level directory,
620 and the binary will be in the "apps" subdirectory.
622 If the build fails, look at the output. There may be reasons
623 for the failure that aren't problems in OpenSSL itself (like
624 missing standard headers). If you are having problems you can
625 get help by sending an email to the openssl-users email list (see
626 https://www.openssl.org/community/mailinglists.html for details). If
627 it is a bug with OpenSSL itself, please open an issue on GitHub, at
628 https://github.com/openssl/openssl/issues. Please review the existing
629 ones first; maybe the bug was already reported or has already been
632 (If you encounter assembler error messages, try the "no-asm"
633 configuration option as an immediate fix.)
635 Compiling parts of OpenSSL with gcc and others with the system
636 compiler will result in unresolved symbols on some systems.
638 3. After a successful build, the libraries should be tested. Run:
642 $ nmake test # Windows
644 NOTE: you MUST run the tests from an unprivileged account (or
645 disable your privileges temporarily if your platform allows it).
647 If some tests fail, look at the output. There may be reasons for
648 the failure that isn't a problem in OpenSSL itself (like a
649 malfunction with Perl). You may want increased verbosity, that
650 can be accomplished like this:
652 $ make VERBOSE=1 test # Unix
654 $ mms /macro=(VERBOSE=1) test ! OpenVMS
656 $ nmake VERBOSE=1 test # Windows
658 If you want to run just one or a few specific tests, you can use
659 the make variable TESTS to specify them, like this:
661 $ make TESTS='test_rsa test_dsa' test # Unix
662 $ mms/macro="TESTS=test_rsa test_dsa" test ! OpenVMS
663 $ nmake TESTS='test_rsa test_dsa' test # Windows
665 And of course, you can combine (Unix example shown):
667 $ make VERBOSE=1 TESTS='test_rsa test_dsa' test
669 You can find the list of available tests like this:
671 $ make list-tests # Unix
672 $ mms list-tests ! OpenVMS
673 $ nmake list-tests # Windows
675 Have a look at the manual for the perl module Test::Harness to
676 see what other HARNESS_* variables there are.
678 If you find a problem with OpenSSL itself, try removing any
679 compiler optimization flags from the CFLAGS line in Makefile and
680 run "make clean; make" or corresponding.
682 To report a bug please open an issue on GitHub, at
683 https://github.com/openssl/openssl/issues.
685 4. If everything tests ok, install OpenSSL with
687 $ make install # Unix
688 $ mms install ! OpenVMS
689 $ nmake install # Windows
691 This will install all the software components in this directory
692 tree under PREFIX (the directory given with --prefix or its
697 bin/ Contains the openssl binary and a few other
700 Contains the header files needed if you want
701 to build your own programs that use libcrypto
703 lib Contains the OpenSSL library files.
704 lib/engines Contains the OpenSSL dynamically loadable engines.
706 share/man/man1 Contains the OpenSSL command line man-pages.
707 share/man/man3 Contains the OpenSSL library calls man-pages.
708 share/man/man5 Contains the OpenSSL configuration format man-pages.
709 share/man/man7 Contains the OpenSSL other misc man-pages.
711 share/doc/openssl/html/man1
712 share/doc/openssl/html/man3
713 share/doc/openssl/html/man5
714 share/doc/openssl/html/man7
715 Contains the HTML rendition of the man-pages.
717 OpenVMS ('arch' is replaced with the architecture name, "Alpha"
718 or "ia64", 'sover' is replaced with the shared library version
719 (0101 for 1.1), and 'pz' is replaced with the pointer size
720 OpenSSL was built with):
722 [.EXE.'arch'] Contains the openssl binary.
723 [.EXE] Contains a few utility scripts.
725 Contains the header files needed if you want
726 to build your own programs that use libcrypto
728 [.LIB.'arch'] Contains the OpenSSL library files.
729 [.ENGINES'sover''pz'.'arch']
730 Contains the OpenSSL dynamically loadable engines.
731 [.SYS$STARTUP] Contains startup, login and shutdown scripts.
732 These define appropriate logical names and
734 [.SYSTEST] Contains the installation verification procedure.
735 [.HTML] Contains the HTML rendition of the manual pages.
738 Additionally, install will add the following directories under
739 OPENSSLDIR (the directory given with --openssldir or its default)
742 certs Initially empty, this is the default location
743 for certificate files.
744 private Initially empty, this is the default location
745 for private key files.
746 misc Various scripts.
748 Package builders who want to configure the library for standard
749 locations, but have the package installed somewhere else so that
750 it can easily be packaged, can use
752 $ make DESTDIR=/tmp/package-root install # Unix
753 $ mms/macro="DESTDIR=TMP:[PACKAGE-ROOT]" install ! OpenVMS
755 The specified destination directory will be prepended to all
756 installation target paths.
758 Compatibility issues with previous OpenSSL versions:
760 * COMPILING existing applications
762 OpenSSL 1.1.0 hides a number of structures that were previously
763 open. This includes all internal libssl structures and a number
764 of EVP types. Accessor functions have been added to allow
765 controlled access to the structures' data.
767 This means that some software needs to be rewritten to adapt to
768 the new ways of doing things. This often amounts to allocating
769 an instance of a structure explicitly where you could previously
770 allocate them on the stack as automatic variables, and using the
771 provided accessor functions where you would previously access a
772 structure's field directly.
774 Some APIs have changed as well. However, older APIs have been
775 preserved when possible.
777 Environment Variables
778 ---------------------
780 A number of environment variables can be used to provide additional control
781 over the build process. Typically these should be defined prior to running
782 config or Configure. Not all environment variables are relevant to all
786 The name of the ar executable to use.
789 Use a different build file name than the platform default
790 ("Makefile" on Unixly platforms, "makefile" on native Windows,
791 "descrip.mms" on OpenVMS). This requires that there is a
792 corresponding build file template. See Configurations/README
793 for further information.
796 The compiler to use. Configure will attempt to pick a default
797 compiler for your platform but this choice can be overridden
798 using this variable. Set it to the compiler executable you wish
799 to use, e.g. "gcc" or "clang".
802 This environment variable has the same meaning as for the
803 "--cross-compile-prefix" Configure flag described above. If both
804 are set then the Configure flag takes precedence.
807 The name of the nm executable to use.
809 OPENSSL_LOCAL_CONFIG_DIR
810 OpenSSL comes with a database of information about how it
811 should be built on different platforms as well as build file
812 templates for those platforms. The database is comprised of
813 ".conf" files in the Configurations directory. The build
814 file templates reside there as well as ".tmpl" files. See the
815 file Configurations/README for further information about the
816 format of ".conf" files as well as information on the ".tmpl"
818 In addition to the standard ".conf" and ".tmpl" files, it is
819 possible to create your own ".conf" and ".tmpl" files and store
820 them locally, outside the OpenSSL source tree. This environment
821 variable can be set to the directory where these files are held
822 and will have Configure to consider them in addition to the
826 The name of the Perl executable to use when building OpenSSL.
829 The command string for the Perl executable to insert in the
830 #! line of perl scripts that will be publically installed.
831 Default: /usr/bin/env perl
832 Note: the value of this variable is added to the same scripts
833 on all platforms, but it's only relevant on Unix-like platforms.
836 The name of the rc executable to use. The default will be as
837 defined for the target platform in the ".conf" file. If not
838 defined then "windres" will be used. The WINDRES environment
839 variable is synonymous to this. If both are defined then RC
843 The name of the ranlib executable to use.
851 The Configure script generates a Makefile in a format relevant to the specific
852 platform. The Makefiles provide a number of targets that can be used. Not all
853 targets may be available on all platforms. Only the most common targets are
854 described here. Examine the Makefiles themselves for the full list.
857 The default target to build all the software components.
860 Remove all build artefacts and return the directory to a "clean"
864 Rebuild the dependencies in the Makefiles. This is a legacy
865 option that no longer needs to be used in OpenSSL 1.1.0.
868 Install all OpenSSL components.
871 Only install the OpenSSL software components.
874 Only install the OpenSSL documentation components.
877 Only install the OpenSSL man pages (Unix only).
880 Only install the OpenSSL html documentation.
883 Prints a list of all the self test names.
886 Build and run the OpenSSL self tests.
889 Uninstall all OpenSSL components.
892 This is a developer option. If you are developing a patch for
893 OpenSSL you may need to use this if you want to update
894 automatically generated files; add new error codes or add new
895 (or change the visibility of) public API functions. (Unix only).
897 Note on multi-threading
898 -----------------------
900 For some systems, the OpenSSL Configure script knows what compiler options
901 are needed to generate a library that is suitable for multi-threaded
902 applications. On these systems, support for multi-threading is enabled
903 by default; use the "no-threads" option to disable (this should never be
906 On other systems, to enable support for multi-threading, you will have
907 to specify at least two options: "threads", and a system-dependent option.
908 (The latter is "-D_REENTRANT" on various systems.) The default in this
909 case, obviously, is not to include support for multi-threading (but
910 you can still use "no-threads" to suppress an annoying warning message
911 from the Configure script.)
913 OpenSSL provides built-in support for two threading models: pthreads (found on
914 most UNIX/Linux systems), and Windows threads. No other threading models are
915 supported. If your platform does not provide pthreads or Windows threads then
916 you should Configure with the "no-threads" option.
918 Notes on shared libraries
919 -------------------------
921 For most systems the OpenSSL Configure script knows what is needed to
922 build shared libraries for libcrypto and libssl. On these systems
923 the shared libraries will be created by default. This can be suppressed and
924 only static libraries created by using the "no-shared" option. On systems
925 where OpenSSL does not know how to build shared libraries the "no-shared"
926 option will be forced and only static libraries will be created.
928 Shared libraries are named a little differently on different platforms.
929 One way or another, they all have the major OpenSSL version number as
930 part of the file name, i.e. for OpenSSL 1.1.x, 1.1 is somehow part of
933 On most POSIXly platforms, shared libraries are named libcrypto.so.1.1
936 on Cygwin, shared libraries are named cygcrypto-1.1.dll and cygssl-1.1.dll
937 with import libraries libcrypto.dll.a and libssl.dll.a.
939 On Windows build with MSVC or using MingW, shared libraries are named
940 libcrypto-1_1.dll and libssl-1_1.dll for 32-bit Windows, libcrypto-1_1-x64.dll
941 and libssl-1_1-x64.dll for 64-bit x86_64 Windows, and libcrypto-1_1-ia64.dll
942 and libssl-1_1-ia64.dll for IA64 Windows. With MSVC, the import libraries
943 are named libcrypto.lib and libssl.lib, while with MingW, they are named
944 libcrypto.dll.a and libssl.dll.a.
946 On VMS, shareable images (VMS speak for shared libraries) are named
947 ossl$libcrypto0101_shr.exe and ossl$libssl0101_shr.exe. However, when
948 OpenSSL is specifically built for 32-bit pointers, the shareable images
949 are named ossl$libcrypto0101_shr32.exe and ossl$libssl0101_shr32.exe
950 instead, and when built for 64-bit pointers, they are named
951 ossl$libcrypto0101_shr64.exe and ossl$libssl0101_shr64.exe.
953 Note on random number generation
954 --------------------------------
956 Availability of cryptographically secure random numbers is required for
957 secret key generation. OpenSSL provides several options to seed the
958 internal PRNG. If not properly seeded, the internal PRNG will refuse
959 to deliver random bytes and a "PRNG not seeded error" will occur.
960 On systems without /dev/urandom (or similar) device, it may be necessary
961 to install additional support software to obtain a random seed.
962 Please check out the manual pages for RAND_add(), RAND_bytes(), RAND_egd(),
963 and the FAQ for more information.
projects / openssl.git / blob