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 any C "stdio" features. Only libcrypto and libssl
412 can be built in this way. Using this option will suppress
413 building the command line applications. Additionally since
414 the OpenSSL tests also use the command line applications the
415 tests will also be skipped.
418 Don't try to build with support for multi-threaded
422 Build with support for multi-threaded applications. Most
423 platforms will enable this by default. However if on a
424 platform where this is not the case then this will usually
425 require additional system-dependent options! See "Note on
426 multi-threading" below.
429 Don't build Time Stamping Authority support.
432 Build with the Undefined Behaviour sanitiser. This is a
433 developer option only. It may not work on all platforms and
434 should never be used in production environments. It will only
435 work when used with gcc or clang and should be used in
436 conjunction with the "-DPEDANTIC" option (or the
437 --strict-warnings option).
440 Don't build with the "UI" capability (i.e. the set of
441 features enabling text based prompts).
444 Enable additional unit test APIs. This should not typically
445 be used in production deployments.
447 enable-weak-ssl-ciphers
448 Build support for SSL/TLS ciphers that are considered "weak"
449 (e.g. RC4 based ciphersuites).
452 Build with support for zlib compression/decompression.
455 Like "zlib", but has OpenSSL load the zlib library
456 dynamically when needed. This is only supported on systems
457 where loading of shared libraries is supported.
460 In 32-bit x86 builds, when generating assembly modules,
461 use the 80386 instruction set only (the default x86 code
462 is more efficient, but requires at least a 486). Note:
463 This doesn't affect code generated by compiler, you're
464 likely to complement configuration command line with
465 suitable compiler-specific option.
468 Don't build support for negotiating the specified SSL/TLS
469 protocol (one of ssl, ssl3, tls, tls1, tls1_1, tls1_2, dtls,
470 dtls1 or dtls1_2). If "no-tls" is selected then all of tls1,
471 tls1_1 and tls1_2 are disabled. Similarly "no-dtls" will
472 disable dtls1 and dtls1_2. The "no-ssl" option is synonymous
473 with "no-ssl3". Note this only affects version negotiation.
474 OpenSSL will still provide the methods for applications to
475 explicitly select the individual protocol versions.
478 As for no-<prot> but in addition do not build the methods for
479 applications to explicitly select individual protocol
483 Build with support for the specified algorithm, where <alg>
484 is one of: md2 or rc5.
487 Build without support for the specified algorithm, where
488 <alg> is one of: bf, blake2, camellia, cast, chacha, cmac,
489 des, dh, dsa, ecdh, ecdsa, idea, md4, mdc2, ocb, poly1305,
490 rc2, rc4, rmd160, scrypt, seed or whirlpool. The "ripemd"
491 algorithm is deprecated and if used is synonymous with rmd160.
493 -Dxxx, lxxx, -Lxxx, -Wl, -rpath, -R, -framework, -static
494 These system specific options will be recocognised and
495 passed through to the compiler to allow you to define
496 preprocessor symbols, specify additional libraries, library
497 directories or other compiler options. It might be worth
498 noting that some compilers generate code specifically for
499 processor the compiler currently executes on. This is not
500 necessarily what you might have in mind, since it might be
501 unsuitable for execution on other, typically older,
502 processor. Consult your compiler documentation.
505 Additional options that are not otherwise recognised are
506 passed through as they are to the compiler as well. Again,
507 consult your compiler documentation.
510 Installation in Detail
511 ----------------------
513 1a. Configure OpenSSL for your operation system automatically:
515 NOTE: This is not available on Windows.
517 $ ./config [[ options ]] # Unix
521 $ @config [[ options ]] ! OpenVMS
523 For the remainder of this text, the Unix form will be used in all
524 examples, please use the appropriate form for your platform.
526 This guesses at your operating system (and compiler, if necessary) and
527 configures OpenSSL based on this guess. Run ./config -t to see
528 if it guessed correctly. If you want to use a different compiler, you
529 are cross-compiling for another platform, or the ./config guess was
530 wrong for other reasons, go to step 1b. Otherwise go to step 2.
532 On some systems, you can include debugging information as follows:
534 $ ./config -d [[ options ]]
536 1b. Configure OpenSSL for your operating system manually
538 OpenSSL knows about a range of different operating system, hardware and
539 compiler combinations. To see the ones it knows about, run
545 $ perl Configure # All other platforms
547 For the remainder of this text, the Unix form will be used in all
548 examples, please use the appropriate form for your platform.
550 Pick a suitable name from the list that matches your system. For most
551 operating systems there is a choice between using "cc" or "gcc". When
552 you have identified your system (and if necessary compiler) use this name
553 as the argument to Configure. For example, a "linux-elf" user would
556 $ ./Configure linux-elf [[ options ]]
558 If your system isn't listed, you will have to create a configuration
559 file named Configurations/{{ something }}.conf and add the correct
560 configuration for your system. See the available configs as examples
561 and read Configurations/README and Configurations/README.design for
564 The generic configurations "cc" or "gcc" should usually work on 32 bit
567 Configure creates a build file ("Makefile" on Unix, "makefile" on Windows
568 and "descrip.mms" on OpenVMS) from a suitable template in Configurations,
569 and defines various macros in include/openssl/opensslconf.h (generated from
570 include/openssl/opensslconf.h.in).
572 1c. Configure OpenSSL for building outside of the source tree.
574 OpenSSL can be configured to build in a build directory separate from
575 the directory with the source code. It's done by placing yourself in
576 some other directory and invoking the configuration commands from
581 $ mkdir /var/tmp/openssl-build
582 $ cd /var/tmp/openssl-build
583 $ /PATH/TO/OPENSSL/SOURCE/config [[ options ]]
587 $ /PATH/TO/OPENSSL/SOURCE/Configure {{ target }} [[ options ]]
591 $ set default sys$login:
592 $ create/dir [.tmp.openssl-build]
593 $ set default [.tmp.openssl-build]
594 $ @[PATH.TO.OPENSSL.SOURCE]config [[ options ]]
598 $ @[PATH.TO.OPENSSL.SOURCE]Configure {{ target }} [[ options ]]
603 $ mkdir \temp-openssl
605 $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure {{ target }} [[ options ]]
607 Paths can be relative just as well as absolute. Configure will
608 do its best to translate them to relative paths whenever possible.
610 2. Build OpenSSL by running:
613 $ mms ! (or mmk) OpenVMS
616 This will build the OpenSSL libraries (libcrypto.a and libssl.a on
617 Unix, corresponding on other platforms) and the OpenSSL binary
618 ("openssl"). The libraries will be built in the top-level directory,
619 and the binary will be in the "apps" subdirectory.
621 If the build fails, look at the output. There may be reasons
622 for the failure that aren't problems in OpenSSL itself (like
623 missing standard headers). If you are having problems you can
624 get help by sending an email to the openssl-users email list (see
625 https://www.openssl.org/community/mailinglists.html for details). If
626 it is a bug with OpenSSL itself, please open an issue on GitHub, at
627 https://github.com/openssl/openssl/issues. Please review the existing
628 ones first; maybe the bug was already reported or has already been
631 (If you encounter assembler error messages, try the "no-asm"
632 configuration option as an immediate fix.)
634 Compiling parts of OpenSSL with gcc and others with the system
635 compiler will result in unresolved symbols on some systems.
637 3. After a successful build, the libraries should be tested. Run:
641 $ nmake test # Windows
643 NOTE: you MUST run the tests from an unprivileged account (or
644 disable your privileges temporarily if your platform allows it).
646 If some tests fail, look at the output. There may be reasons for
647 the failure that isn't a problem in OpenSSL itself (like a
648 malfunction with Perl). You may want increased verbosity, that
649 can be accomplished like this:
651 $ make VERBOSE=1 test # Unix
653 $ mms /macro=(VERBOSE=1) test ! OpenVMS
655 $ nmake VERBOSE=1 test # Windows
657 If you want to run just one or a few specific tests, you can use
658 the make variable TESTS to specify them, like this:
660 $ make TESTS='test_rsa test_dsa' test # Unix
661 $ mms/macro="TESTS=test_rsa test_dsa" test ! OpenVMS
662 $ nmake TESTS='test_rsa test_dsa' test # Windows
664 And of course, you can combine (Unix example shown):
666 $ make VERBOSE=1 TESTS='test_rsa test_dsa' test
668 You can find the list of available tests like this:
670 $ make list-tests # Unix
671 $ mms list-tests ! OpenVMS
672 $ nmake list-tests # Windows
674 Have a look at the manual for the perl module Test::Harness to
675 see what other HARNESS_* variables there are.
677 If you find a problem with OpenSSL itself, try removing any
678 compiler optimization flags from the CFLAGS line in Makefile and
679 run "make clean; make" or corresponding.
681 Please send bug reports to <rt@openssl.org>.
683 4. If everything tests ok, install OpenSSL with
685 $ make install # Unix
686 $ mms install ! OpenVMS
687 $ nmake install # Windows
689 This will install all the software components in this directory
690 tree under PREFIX (the directory given with --prefix or its
695 bin/ Contains the openssl binary and a few other
698 Contains the header files needed if you want
699 to build your own programs that use libcrypto
701 lib Contains the OpenSSL library files.
702 lib/engines Contains the OpenSSL dynamically loadable engines.
704 share/man/man1 Contains the OpenSSL command line man-pages.
705 share/man/man3 Contains the OpenSSL library calls man-pages.
706 share/man/man5 Contains the OpenSSL configuration format man-pages.
707 share/man/man7 Contains the OpenSSL other misc man-pages.
709 share/doc/openssl/html/man1
710 share/doc/openssl/html/man3
711 share/doc/openssl/html/man5
712 share/doc/openssl/html/man7
713 Contains the HTML rendition of the man-pages.
715 OpenVMS ('arch' is replaced with the architecture name, "Alpha"
716 or "ia64", 'sover' is replaced with the shared library version
717 (0101 for 1.1), and 'pz' is replaced with the pointer size
718 OpenSSL was built with):
720 [.EXE.'arch'] Contains the openssl binary.
721 [.EXE] Contains a few utility scripts.
723 Contains the header files needed if you want
724 to build your own programs that use libcrypto
726 [.LIB.'arch'] Contains the OpenSSL library files.
727 [.ENGINES'sover''pz'.'arch']
728 Contains the OpenSSL dynamically loadable engines.
729 [.SYS$STARTUP] Contains startup, login and shutdown scripts.
730 These define appropriate logical names and
732 [.SYSTEST] Contains the installation verification procedure.
733 [.HTML] Contains the HTML rendition of the manual pages.
736 Additionally, install will add the following directories under
737 OPENSSLDIR (the directory given with --openssldir or its default)
740 certs Initially empty, this is the default location
741 for certificate files.
742 private Initially empty, this is the default location
743 for private key files.
744 misc Various scripts.
746 Package builders who want to configure the library for standard
747 locations, but have the package installed somewhere else so that
748 it can easily be packaged, can use
750 $ make DESTDIR=/tmp/package-root install # Unix
751 $ mms/macro="DESTDIR=TMP:[PACKAGE-ROOT]" install ! OpenVMS
753 The specified destination directory will be prepended to all
754 installation target paths.
756 Compatibility issues with previous OpenSSL versions:
758 * COMPILING existing applications
760 OpenSSL 1.1.0 hides a number of structures that were previously
761 open. This includes all internal libssl structures and a number
762 of EVP types. Accessor functions have been added to allow
763 controlled access to the structures' data.
765 This means that some software needs to be rewritten to adapt to
766 the new ways of doing things. This often amounts to allocating
767 an instance of a structure explicitly where you could previously
768 allocate them on the stack as automatic variables, and using the
769 provided accessor functions where you would previously access a
770 structure's field directly.
772 Some APIs have changed as well. However, older APIs have been
773 preserved when possible.
775 Environment Variables
776 ---------------------
778 A number of environment variables can be used to provide additional control
779 over the build process. Typically these should be defined prior to running
780 config or Configure. Not all environment variables are relevant to all
784 The name of the ar executable to use.
787 Use a different build file name than the platform default
788 ("Makefile" on Unixly platforms, "makefile" on native Windows,
789 "descrip.mms" on OpenVMS). This requires that there is a
790 corresponding build file template. See Configurations/README
791 for further information.
794 The compiler to use. Configure will attempt to pick a default
795 compiler for your platform but this choice can be overridden
796 using this variable. Set it to the compiler executable you wish
797 to use, e.g. "gcc" or "clang".
800 This environment variable has the same meaning as for the
801 "--cross-compile-prefix" Configure flag described above. If both
802 are set then the Configure flag takes precedence.
805 The name of the nm executable to use.
807 OPENSSL_LOCAL_CONFIG_DIR
808 OpenSSL comes with a database of information about how it
809 should be built on different platforms as well as build file
810 templates for those platforms. The database is comprised of
811 ".conf" files in the Configurations directory. The build
812 file templates reside there as well as ".tmpl" files. See the
813 file Configurations/README for further information about the
814 format of ".conf" files as well as information on the ".tmpl"
816 In addition to the standard ".conf" and ".tmpl" files, it is
817 possible to create your own ".conf" and ".tmpl" files and store
818 them locally, outside the OpenSSL source tree. This environment
819 variable can be set to the directory where these files are held
820 and will have Configure to consider them in addition to the
824 The name of the Perl executable to use when building OpenSSL.
827 The command string for the Perl executable to insert in the
828 #! line of perl scripts that will be publically installed.
829 Default: /usr/bin/env perl
830 Note: the value of this variable is added to the same scripts
831 on all platforms, but it's only relevant on Unix-like platforms.
834 The name of the rc executable to use. The default will be as
835 defined for the target platform in the ".conf" file. If not
836 defined then "windres" will be used. The WINDRES environment
837 variable is synonymous to this. If both are defined then RC
841 The name of the ranlib executable to use.
849 The Configure script generates a Makefile in a format relevant to the specific
850 platform. The Makefiles provide a number of targets that can be used. Not all
851 targets may be available on all platforms. Only the most common targets are
852 described here. Examine the Makefiles themselves for the full list.
855 The default target to build all the software components.
858 Remove all build artefacts and return the directory to a "clean"
862 Rebuild the dependencies in the Makefiles. This is a legacy
863 option that no longer needs to be used in OpenSSL 1.1.0.
866 Install all OpenSSL components.
869 Only install the OpenSSL software components.
872 Only install the OpenSSL documentation components.
875 Only install the OpenSSL man pages (Unix only).
878 Only install the OpenSSL html documentation.
881 Prints a list of all the self test names.
884 Build and run the OpenSSL self tests.
887 Uninstall all OpenSSL components.
890 This is a developer option. If you are developing a patch for
891 OpenSSL you may need to use this if you want to update
892 automatically generated files; add new error codes or add new
893 (or change the visibility of) public API functions. (Unix only).
895 Note on multi-threading
896 -----------------------
898 For some systems, the OpenSSL Configure script knows what compiler options
899 are needed to generate a library that is suitable for multi-threaded
900 applications. On these systems, support for multi-threading is enabled
901 by default; use the "no-threads" option to disable (this should never be
904 On other systems, to enable support for multi-threading, you will have
905 to specify at least two options: "threads", and a system-dependent option.
906 (The latter is "-D_REENTRANT" on various systems.) The default in this
907 case, obviously, is not to include support for multi-threading (but
908 you can still use "no-threads" to suppress an annoying warning message
909 from the Configure script.)
911 OpenSSL provides built-in support for two threading models: pthreads (found on
912 most UNIX/Linux systems), and Windows threads. No other threading models are
913 supported. If your platform does not provide pthreads or Windows threads then
914 you should Configure with the "no-threads" option.
916 Notes on shared libraries
917 -------------------------
919 For most systems the OpenSSL Configure script knows what is needed to
920 build shared libraries for libcrypto and libssl. On these systems
921 the shared libraries will be created by default. This can be suppressed and
922 only static libraries created by using the "no-shared" option. On systems
923 where OpenSSL does not know how to build shared libraries the "no-shared"
924 option will be forced and only static libraries will be created.
926 Shared libraries are named a little differently on different platforms.
927 One way or another, they all have the major OpenSSL version number as
928 part of the file name, i.e. for OpenSSL 1.1.x, 1.1 is somehow part of
931 On most POSIXly platforms, shared libraries are named libcrypto.so.1.1
934 on Cygwin, shared libraries are named cygcrypto-1.1.dll and cygssl-1.1.dll
935 with import libraries libcrypto.dll.a and libssl.dll.a.
937 On Windows build with MSVC or using MingW, shared libraries are named
938 libcrypto-1_1.dll and libssl-1_1.dll for 32-bit Windows, libcrypto-1_1-x64.dll
939 and libssl-1_1-x64.dll for 64-bit x86_64 Windows, and libcrypto-1_1-ia64.dll
940 and libssl-1_1-ia64.dll for IA64 Windows. With MSVC, the import libraries
941 are named libcrypto.lib and libssl.lib, while with MingW, they are named
942 libcrypto.dll.a and libssl.dll.a.
944 On VMS, shareable images (VMS speak for shared libraries) are named
945 ossl$libcrypto0101_shr.exe and ossl$libssl0101_shr.exe. However, when
946 OpenSSL is specifically built for 32-bit pointers, the shareable images
947 are named ossl$libcrypto0101_shr32.exe and ossl$libssl0101_shr32.exe
948 instead, and when built for 64-bit pointers, they are named
949 ossl$libcrypto0101_shr64.exe and ossl$libssl0101_shr64.exe.
951 Note on random number generation
952 --------------------------------
954 Availability of cryptographically secure random numbers is required for
955 secret key generation. OpenSSL provides several options to seed the
956 internal PRNG. If not properly seeded, the internal PRNG will refuse
957 to deliver random bytes and a "PRNG not seeded error" will occur.
958 On systems without /dev/urandom (or similar) device, it may be necessary
959 to install additional support software to obtain a random seed.
960 Please check out the manual pages for RAND_add(), RAND_bytes(), RAND_egd(),
961 and the FAQ for more information.
projects / openssl.git / blob