5 [This document describes installation on all supported operating
6 systems (currently mainly the Linux/Unix family, OpenVMS and
9 To install OpenSSL, you will need:
11 * A make implementation
12 * Perl 5 with core modules (please read NOTES.PERL)
13 * The perl module Text::Template (please read NOTES.PERL)
15 * a development environment in the form of development libraries and C
17 * a supported operating system
19 For additional platform specific requirements and other details,
20 please read one of these:
23 * NOTES.WIN (any supported Windows)
24 * NOTES.DJGPP (DOS platform with DJGPP)
29 If you want to just get on with it, do:
45 on Windows (only pick one of the targets for configuration):
47 $ perl Configure { VC-WIN32 | VC-WIN64A | VC-WIN64I | VC-CE }
52 [If any of these steps fails, see section Installation in Detail below.]
54 This will build and install OpenSSL in the default location, which is:
56 Unix: normal installation directories under /usr/local
57 OpenVMS: SYS$COMMON:[OPENSSL-'version'...], where 'version' is the
58 OpenSSL version number with underscores instead of periods.
59 Windows: C:\Program Files\OpenSSL or C:\Program Files (x86)\OpenSSL
61 If you want to install it anywhere else, run config like this:
65 $ ./config --prefix=/opt/openssl --openssldir=/usr/local/ssl
69 $ @config --prefix=PROGRAM:[INSTALLS] --openssldir=SYS$MANAGER:[OPENSSL]
75 There are several options to ./config (or ./Configure) to customize
76 the build (note that for Windows, the defaults for --prefix and
77 --openssldir depend in what configuration is used and what Windows
78 implementation OpenSSL is built on. More notes on this in NOTES.WIN):
81 Don't build with support for deprecated APIs below the
82 specified version number. For example "--api=1.1.0" will
83 remove support for all APIS that were deprecated in OpenSSL
84 version 1.1.0 or below.
86 --cross-compile-prefix=PREFIX
87 The PREFIX to include in front of commands for your
88 toolchain. For example to build the mingw64 target on Linux
89 you might use "--cross-compile-prefix=x86_64-w64-mingw32-".
90 If the compiler is gcc, then this will attempt to run
91 x86_64-w64-mingw32-gcc when compiling.
94 Build OpenSSL with debugging symbols.
97 The name of the directory under the top of the installation
98 directory tree (see the --prefix option) where libraries will
99 be installed. By default this is "lib". Note that on Windows
100 only ".lib" files will be stored in this location. dll files
101 will always be installed to the "bin" directory.
104 Directory for OpenSSL configuration files, and also the
105 default certificate and key store. Defaults are:
108 Windows: C:\Program Files\Common Files\SSL
109 or C:\Program Files (x86)\Common Files\SSL
110 OpenVMS: SYS$COMMON:[OPENSSL-COMMON]
113 The top of the installation directory tree. Defaults are:
116 Windows: C:\Program Files\OpenSSL
117 or C:\Program Files (x86)\OpenSSL
118 OpenVMS: SYS$COMMON:[OPENSSL-'version']
121 Build OpenSSL without debugging symbols. This is the default.
124 This is a developer flag that switches on various compiler
125 options recommended for OpenSSL development. It only works
126 when using gcc or clang as the compiler. If you are
127 developing a patch for OpenSSL then it is recommended that
128 you use this option where possible.
130 --with-zlib-include=DIR
131 The directory for the location of the zlib include file. This
132 option is only necessary if enable-zlib (see below) is used
133 and the include file is not already on the system include
137 On Unix: this is the directory containing the zlib library.
138 If not provided the system library path will be used.
139 On Windows: this is the filename of the zlib library (with or
140 without a path). This flag must be provided if the
141 zlib-dynamic option is not also used. If zlib-dynamic is used
142 then this flag is optional and a default value ("ZLIB1") is
143 used if not provided.
144 On VMS: this is the filename of the zlib library (with or
145 without a path). This flag is optional and if not provided
146 then "GNV$LIBZSHR", "GNV$LIBZSHR32" or "GNV$LIBZSHR64" is
147 used by default depending on the pointer size chosen.
150 Don't build the AFALG engine. This option will be forced if
151 on a platform that does not support AFALG.
154 Build with the Address sanitiser. This is a developer option
155 only. It may not work on all platforms and should never be
156 used in production environments. It will only work when used
157 with gcc or clang and should be used in conjunction with the
161 Do not use assembler code. On some platforms a small amount
162 of assembler code may still be used.
165 Do not build support for async operations.
168 Don't automatically load all supported ciphers and digests.
169 Typically OpenSSL will make available all of its supported
170 ciphers and digests. For a statically linked application this
171 may be undesirable if small executable size is an objective.
172 This only affects libcrypto. Ciphers and digests will have to
173 be loaded manually using EVP_add_cipher() and
174 EVP_add_digest() if this option is used. This option will
175 force a non-shared build.
178 Don't automatically load all libcrypto/libssl error strings.
179 Typically OpenSSL will automatically load human readable
180 error strings. For a statically linked application this may
181 be undesirable if small executable size is an objective.
185 Don't build the CAPI engine. This option will be forced if
186 on a platform that does not support CAPI.
189 Don't build support for CMS features
192 Don't build support for SSL/TLS compression. If this option
193 is left enabled (the default), then compression will only
194 work if the zlib or zlib-dynamic options are also chosen.
197 Build support for debugging memory allocated via
198 OPENSSL_malloc() or OPENSSL_zalloc().
200 enable-crypto-mdebug-backtrace
201 As for crypto-mdebug, but additionally provide backtrace
202 information for allocated memory.
203 TO BE USED WITH CARE: this uses GNU C functionality, and
204 is therefore not usable for non-GNU config targets. If
205 your build complains about the use of '-rdynamic' or the
206 lack of header file execinfo.h, this option is not for you.
207 ALSO NOTE that even though execinfo.h is available on your
208 system (through Gnulib), the functions might just be stubs
212 Don't build support for Certificate Transparency.
215 Don't build with support for any deprecated APIs. This is the
216 same as using "--api" and supplying the latest version
220 Don't build support for datagram based BIOs. Selecting this
221 option will also force the disabling of DTLS.
224 Don't build support for loading Dynamic Shared Objects.
227 Don't build the dynamically loaded engines. This only has an
228 effect in a "shared" build
231 Don't build support for Elliptic Curves.
234 Don't build support for binary Elliptic Curves
236 enable-ec_nistp_64_gcc_128
237 Enable support for optimised implementations of some commonly
238 used NIST elliptic curves. This is only supported on some
242 Build support for gathering entropy from EGD (Entropy
246 Don't build support for loading engines.
249 Don't compile in any error strings.
252 Don't compile in filename and line number information (e.g.
253 for errors and memory allocation).
256 Build with support for fuzzing. This is a developer option
257 only. It may not work on all platforms and should never be
258 used in production environments. See the file fuzz/README.md
262 Don't build support for GOST based ciphersuites. Note that
263 if this feature is enabled then GOST ciphersuites are only
264 available if the GOST algorithms are also available through
265 loading an externally supplied engine.
268 Build support for DTLS heartbeats.
271 Don't build the padlock engine.
274 Don't generate dependencies.
277 Don't build support for writing multiple records in one
278 go in libssl (Note: this is a different capability to the
279 pipelining functionality).
282 Don't build support for the NPN TLS extension.
285 Don't build support for OCSP.
288 Don't build with support for Position Independent Code.
291 Don't use POSIX IO capabilities.
294 Don't build support for Pre-Shared Key based ciphersuites.
297 Don't use hardware RDRAND capabilities.
300 Don't build support for RFC3779 ("X.509 Extensions for IP
301 Addresses and AS Identifiers")
304 Build support for SCTP
307 Do not create shared libraries, only static ones. See "Note
308 on shared libraries" below.
311 Don't build support for socket BIOs
314 Don't build support for SRP or SRP based ciphersuites.
317 Don't build SRTP support
320 Exclude SSE2 code paths. Normally SSE2 extension is
321 detected at run-time, but the decision whether or not the
322 machine code will be executed is taken solely on CPU
323 capability vector. This means that if you happen to run OS
324 kernel which does not support SSE2 extension on Intel P4
325 processor, then your application might be exposed to
326 "illegal instruction" exception. There might be a way
327 to enable support in kernel, e.g. FreeBSD kernel can be
328 compiled with CPU_ENABLE_SSE, and there is a way to
329 disengage SSE2 code paths upon application start-up,
330 but if you aim for wider "audience" running such kernel,
331 consider no-sse2. Both the 386 and no-asm options imply
335 Build with the SSL Trace capabilities (adds the "-trace"
336 option to s_client and s_server).
339 Don't build the statically linked engines. This only
340 has an impact when not built "shared".
343 Don't use any C "stdio" features. Only libcrypto and libssl
344 can be built in this way. Using this option will suppress
345 building the command line applications. Additionally since
346 the OpenSSL tests also use the command line applications the
347 tests will also be skipped.
350 Don't try to build with support for multi-threaded
354 Build with support for multi-threaded applications. Most
355 platforms will enable this by default. However if on a
356 platform where this is not the case then this will usually
357 require additional system-dependent options! See "Note on
358 multi-threading" below.
361 Don't build Time Stamping Authority support.
364 Build with the Undefined Behaviour sanitiser. This is a
365 developer option only. It may not work on all platforms and
366 should never be used in production environments. It will only
367 work when used with gcc or clang and should be used in
368 conjunction with the "-DPEDANTIC" option (or the
369 --strict-warnings option).
372 Don't build with the "UI" capability (i.e. the set of
373 features enabling text based prompts).
376 Enable additional unit test APIs. This should not typically
377 be used in production deployments.
379 enable-weak-ssl-ciphers
380 Build support for SSL/TLS ciphers that are considered "weak"
381 (e.g. RC4 based ciphersuites).
384 Build with support for zlib compression/decompression.
387 Like "zlib", but has OpenSSL load the zlib library
388 dynamically when needed. This is only supported on systems
389 where loading of shared libraries is supported.
392 On Intel hardware, use the 80386 instruction set only
393 (the default x86 code is more efficient, but requires at
394 least a 486). Note: Use compiler flags for any other CPU
395 specific configuration, e.g. "-m32" to build x86 code on
399 Don't build support for negotiating the specified SSL/TLS
400 protocol (one of ssl, ssl3, tls, tls1, tls1_1, tls1_2, dtls,
401 dtls1 or dtls1_2). If "no-tls" is selected then all of tls1,
402 tls1_1 and tls1_2 are disabled. Similarly "no-dtls" will
403 disable dtls1 and dtls1_2. The "no-ssl" option is synonymous
404 with "no-ssl3". Note this only affects version negotiation.
405 OpenSSL will still provide the methods for applications to
406 explicitly select the individual protocol versions.
409 As for no-<prot> but in addition do not build the methods for
410 applications to explicitly select individual protocol
414 Build with support for the specified algorithm, where <alg>
415 is one of: md2 or rc5.
418 Build without support for the specified algorithm, where
419 <alg> is one of: bf, blake2, camellia, cast, chacha, cmac,
420 des, dh, dsa, ecdh, ecdsa, idea, md4, md5, mdc2, ocb,
421 ploy1305, rc2, rc4, rmd160, scrypt, seed or whirlpool. The
422 "ripemd" algorithm is deprecated and if used is synonymous
425 -Dxxx, -lxxx, -Lxxx, -fxxx, -mXXX, -Kxxx
426 These system specific options will be passed through to the
427 compiler to allow you to define preprocessor symbols, specify
428 additional libraries, library directories or other compiler
432 Installation in Detail
433 ----------------------
435 1a. Configure OpenSSL for your operation system automatically:
437 NOTE: This is not available on Windows.
439 $ ./config [options] # Unix
443 $ @config [options] ! OpenVMS
445 For the remainder of this text, the Unix form will be used in all
446 examples, please use the appropriate form for your platform.
448 This guesses at your operating system (and compiler, if necessary) and
449 configures OpenSSL based on this guess. Run ./config -t to see
450 if it guessed correctly. If you want to use a different compiler, you
451 are cross-compiling for another platform, or the ./config guess was
452 wrong for other reasons, go to step 1b. Otherwise go to step 2.
454 On some systems, you can include debugging information as follows:
456 $ ./config -d [options]
458 1b. Configure OpenSSL for your operating system manually
460 OpenSSL knows about a range of different operating system, hardware and
461 compiler combinations. To see the ones it knows about, run
467 $ perl Configure # All other platforms
469 For the remainder of this text, the Unix form will be used in all
470 examples, please use the appropriate form for your platform.
472 Pick a suitable name from the list that matches your system. For most
473 operating systems there is a choice between using "cc" or "gcc". When
474 you have identified your system (and if necessary compiler) use this name
475 as the argument to Configure. For example, a "linux-elf" user would
478 $ ./Configure linux-elf [options]
480 If your system isn't listed, you will have to create a configuration
481 file named Configurations/{something}.conf and add the correct
482 configuration for your system. See the available configs as examples
483 and read Configurations/README and Configurations/README.design for
486 The generic configurations "cc" or "gcc" should usually work on 32 bit
489 Configure creates a build file ("Makefile" on Unix, "makefile" on Windows
490 and "descrip.mms" on OpenVMS) from a suitable template in Configurations,
491 and defines various macros in include/openssl/opensslconf.h (generated from
492 include/openssl/opensslconf.h.in).
494 1c. Configure OpenSSL for building outside of the source tree.
496 OpenSSL can be configured to build in a build directory separate from
497 the directory with the source code. It's done by placing yourself in
498 some other directory and invoking the configuration commands from
503 $ mkdir /var/tmp/openssl-build
504 $ cd /var/tmp/openssl-build
505 $ /PATH/TO/OPENSSL/SOURCE/config [options]
509 $ /PATH/TO/OPENSSL/SOURCE/Configure [target] [options]
513 $ set default sys$login:
514 $ create/dir [.tmp.openssl-build]
515 $ set default [.tmp.openssl-build]
516 $ @[PATH.TO.OPENSSL.SOURCE]config {options}
520 $ @[PATH.TO.OPENSSL.SOURCE]Configure {target} {options}
525 $ mkdir \temp-openssl
527 $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure {target} {options}
529 Paths can be relative just as well as absolute. Configure will
530 do its best to translate them to relative paths whenever possible.
532 2. Build OpenSSL by running:
535 $ mms ! (or mmk) OpenVMS
538 This will build the OpenSSL libraries (libcrypto.a and libssl.a on
539 Unix, corresponding on other platforms) and the OpenSSL binary
540 ("openssl"). The libraries will be built in the top-level directory,
541 and the binary will be in the "apps" subdirectory.
543 If the build fails, look at the output. There may be reasons for
544 the failure that aren't problems in OpenSSL itself (like missing
545 standard headers). If you are having problems you can get help by
546 sending an email to the openssl-users email list (see
547 https://www.openssl.org/community/mailinglists.html for details). If it
548 is a bug with OpenSSL itself, please report the problem to
549 <rt@openssl.org> (note that your message will be recorded in the request
550 tracker publicly readable at
551 https://www.openssl.org/community/index.html#bugs and will be
552 forwarded to a public mailing list). Please check out the request
553 tracker. Maybe the bug was already reported or has already been
556 [If you encounter assembler error messages, try the "no-asm"
557 configuration option as an immediate fix.]
559 Compiling parts of OpenSSL with gcc and others with the system
560 compiler will result in unresolved symbols on some systems.
562 3. After a successful build, the libraries should be tested. Run:
566 $ nmake test # Windows
568 NOTE: you MUST run the tests from an unprivileged account (or
569 disable your privileges temporarily if your platform allows it).
571 If some tests fail, look at the output. There may be reasons for
572 the failure that isn't a problem in OpenSSL itself (like a
573 malfunction with Perl). You may want increased verbosity, that
574 can be accomplished like this:
576 $ make VERBOSE=1 test # Unix
578 $ mms /macro=(VERBOSE=1) test ! OpenVMS
580 $ nmake VERBOSE=1 test # Windows
582 If you want to run just one or a few specific tests, you can use
583 the make variable TESTS to specify them, like this:
585 $ make TESTS='test_rsa test_dsa' test # Unix
586 $ mms/macro="TESTS=test_rsa test_dsa" test ! OpenVMS
587 $ nmake TESTS='test_rsa test_dsa' test # Windows
589 And of course, you can combine (Unix example shown):
591 $ make VERBOSE=1 TESTS='test_rsa test_dsa' test
593 You can find the list of available tests like this:
595 $ make list-tests # Unix
596 $ mms list-tests ! OpenVMS
597 $ nmake list-tests # Windows
599 Have a look at the manual for the perl module Test::Harness to
600 see what other HARNESS_* variables there are.
602 If you find a problem with OpenSSL itself, try removing any
603 compiler optimization flags from the CFLAGS line in Makefile and
604 run "make clean; make" or corresponding.
606 Please send bug reports to <rt@openssl.org>.
608 4. If everything tests ok, install OpenSSL with
610 $ make install # Unix
611 $ mms install ! OpenVMS
612 $ nmake install # Windows
614 This will install all the software components in this directory
615 tree under PREFIX (the directory given with --prefix or its
620 bin/ Contains the openssl binary and a few other
623 Contains the header files needed if you want
624 to build your own programs that use libcrypto
626 lib Contains the OpenSSL library files.
627 lib/engines Contains the OpenSSL dynamically loadable engines.
628 share/man/{man1,man3,man5,man7}
629 Contains the OpenSSL man-pages.
630 share/doc/openssl/html/{man1,man3,man5,man7}
631 Contains the HTML rendition of the man-pages.
633 OpenVMS ('arch' is replaced with the architecture name, "Alpha"
636 [.EXE.'arch'] Contains the openssl binary and a few other
639 Contains the header files needed if you want
640 to build your own programs that use libcrypto
642 [.LIB.'arch'] Contains the OpenSSL library files.
644 Contains the OpenSSL dynamically loadable engines.
645 [.SYS$STARTUP] Contains startup, login and shutdown scripts.
646 These define appropriate logical names and
650 Additionally, install will add the following directories under
651 OPENSSLDIR (the directory given with --openssldir or its default)
654 certs Initially empty, this is the default location
655 for certificate files.
656 private Initially empty, this is the default location
657 for private key files.
658 misc Various scripts.
660 Package builders who want to configure the library for standard
661 locations, but have the package installed somewhere else so that
662 it can easily be packaged, can use
664 $ make DESTDIR=/tmp/package-root install # Unix
665 $ mms/macro="DESTDIR=TMP:[PACKAGE-ROOT]" install ! OpenVMS
667 The specified destination directory will be prepended to all
668 installation target paths.
670 Compatibility issues with previous OpenSSL versions:
672 * COMPILING existing applications
674 OpenSSL 1.1.0 hides a number of structures that were previously
675 open. This includes all internal libssl structures and a number
676 of EVP types. Accessor functions have been added to allow
677 controlled access to the structures' data.
679 This means that some software needs to be rewritten to adapt to
680 the new ways of doing things. This often amounts to allocating
681 an instance of a structure explicitly where you could previously
682 allocate them on the stack as automatic variables, and using the
683 provided accessor functions where you would previously access a
684 structure's field directly.
686 Some APIs have changed as well. However, older APIs have been
687 preserved when possible.
689 Environment Variables
690 ---------------------
692 A number of environment variables can be used to provide additional control
693 over the build process. Typically these should be defined prior to running
694 config or Configure. Not all environment variables are relevant to all
698 The name of the ar executable to use.
701 The compiler to use. Configure will attempt to pick a default
702 compiler for your platform but this choice can be overridden
703 using this variable. Set it to the compiler executable you wish
704 to use, e.g. "gcc" or "clang".
707 This environment variable has the same meaning as for the
708 "--cross-compile-prefix" Configure flag described above. If both
709 are set then the Configure flag takes precedence.
712 The name of the nm executable to use.
714 OPENSSL_LOCAL_CONFIG_DIR
715 OpenSSL comes with a database of information about how it
716 should be built on different platforms. This information is
717 held in ".conf" files in the Configurations directory. See the
718 file Configurations/README for further information about the
719 format of ".conf" files. As well as the standard ".conf" files
720 it is possible to create your own ".conf" files and store them
721 locally, outside the OpenSSL source tree. This environment
722 variable can be set to the directory where these files are held.
725 The name of the Perl executable to use when building OpenSSL.
728 The command string for the Perl executable to insert in the
729 #! line of perl scripts that will be publically installed.
730 Default: /usr/bin/env perl
731 Note: the value of this variable is added to the same scripts
732 on all platforms, but it's only relevant on Unix-like platforms.
735 The name of the rc executable to use. The default will be as
736 defined for the target platform in the ".conf" file. If not
737 defined then "windres" will be used. The WINDRES environment
738 variable is synonymous to this. If both are defined then RC
742 The name of the ranlib executable to use.
750 The Configure script generates a Makefile in a format relevant to the specific
751 platform. The Makefiles provide a number of targets that can be used. Not all
752 targets may be available on all platforms. Only the most common targets are
753 described here. Examine the Makefiles themselves for the full list.
756 The default target to build all the software components.
759 Remove all build artefacts and return the directory to a "clean"
763 Rebuild the dependencies in the Makefiles. This is a legacy
764 option that no longer needs to be used in OpenSSL 1.1.0.
767 Install all OpenSSL components.
770 Only install the OpenSSL software components.
773 Only install the OpenSSL documentation components.
776 Only install the OpenSSL man pages (Unix only).
779 Only install the OpenSSL html documentation.
782 Prints a list of all the self test names.
785 Build and run the OpenSSL self tests.
788 Uninstall all OpenSSL components.
791 This is a developer option. If you are developing a patch for
792 OpenSSL you may need to use this if you want to update
793 automatically generated files; add new error codes or add new
794 (or change the visibility of) public API functions. (Unix only).
796 Note on multi-threading
797 -----------------------
799 For some systems, the OpenSSL Configure script knows what compiler options
800 are needed to generate a library that is suitable for multi-threaded
801 applications. On these systems, support for multi-threading is enabled
802 by default; use the "no-threads" option to disable (this should never be
805 On other systems, to enable support for multi-threading, you will have
806 to specify at least two options: "threads", and a system-dependent option.
807 (The latter is "-D_REENTRANT" on various systems.) The default in this
808 case, obviously, is not to include support for multi-threading (but
809 you can still use "no-threads" to suppress an annoying warning message
810 from the Configure script.)
812 OpenSSL provides built-in support for two threading models: pthreads (found on
813 most UNIX/Linux systems), and Windows threads. No other threading models are
814 supported. If your platform does not provide pthreads or Windows threads then
815 you should Configure with the "no-threads" option.
817 Note on shared libraries
818 ------------------------
820 For most systems the OpenSSL Configure script knows what is needed to
821 build shared libraries for libcrypto and libssl. On these systems
822 the shared libraries will be created by default. This can be suppressed and
823 only static libraries created by using the "no-shared" option. On systems
824 where OpenSSL does not know how to build shared libraries the "no-shared"
825 option will be forced and only static libraries will be created.
827 Note on random number generation
828 --------------------------------
830 Availability of cryptographically secure random numbers is required for
831 secret key generation. OpenSSL provides several options to seed the
832 internal PRNG. If not properly seeded, the internal PRNG will refuse
833 to deliver random bytes and a "PRNG not seeded error" will occur.
834 On systems without /dev/urandom (or similar) device, it may be necessary
835 to install additional support software to obtain a random seed.
836 Please check out the manual pages for RAND_add(), RAND_bytes(), RAND_egd(),
837 and the FAQ for more information.
projects / openssl.git / blob