4 This document describes installation on all supported operating
5 systems (the Linux/Unix family, OpenVMS and Windows)
7 To install OpenSSL, you will need:
9 * A make implementation
10 * Perl 5 with core modules (please read NOTES.PERL)
11 * The perl module Text::Template (please read NOTES.PERL)
13 * a development environment in the form of development libraries and C
15 * a supported operating system
17 For additional platform specific requirements, solutions to specific
18 issues and other details, please read one of these:
20 * NOTES.UNIX (any supported Unix like system)
22 * NOTES.WIN (any supported Windows)
23 * NOTES.DJGPP (DOS platform with DJGPP)
24 * NOTES.ANDROID (obviously Android [NDK])
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 --with-rand-seed=seed1[,seed2,...]
219 A comma separated list of seeding methods which will be tried
220 by OpenSSL in order to obtain random input (a.k.a "entropy")
221 for seeding its cryptographically secure random number
222 generator (CSPRNG). The current seeding methods are:
224 os: Use a trusted operating system entropy source.
225 This is the default method if such an entropy
227 getrandom: Use the L<getrandom(2)> system call if available.
228 devrandom: Use the the first device from the DEVRANDOM list
229 which can be opened to read random bytes. The
230 DEVRANDOM preprocessor constant expands to
231 "/dev/urandom","/dev/random","/dev/srandom" on
232 most unix-ish operating systems.
233 egd: Check for an entropy generating daemon.
234 rdcpu: Use the RDSEED or RDRAND command if provided by
236 librandom: Use librandom (not implemented yet).
237 none: Disable automatic seeding. This is the default
238 on some operating systems where no suitable
239 entropy source exists, or no support for it is
242 For more information, see the section 'Note on random number
243 generation' at the end of this document.
246 Don't build the AFALG engine. This option will be forced if
247 on a platform that does not support AFALG.
250 Build with the Address sanitiser. This is a developer option
251 only. It may not work on all platforms and should never be
252 used in production environments. It will only work when used
253 with gcc or clang and should be used in conjunction with the
257 Do not use assembler code. On some platforms a small amount
258 of assembler code may still be used.
261 Do not build support for async operations.
264 Don't automatically load all supported ciphers and digests.
265 Typically OpenSSL will make available all of its supported
266 ciphers and digests. For a statically linked application this
267 may be undesirable if small executable size is an objective.
268 This only affects libcrypto. Ciphers and digests will have to
269 be loaded manually using EVP_add_cipher() and
270 EVP_add_digest() if this option is used. This option will
271 force a non-shared build.
274 Don't automatically load all libcrypto/libssl error strings.
275 Typically OpenSSL will automatically load human readable
276 error strings. For a statically linked application this may
277 be undesirable if small executable size is an objective.
281 Don't build the CAPI engine. This option will be forced if
282 on a platform that does not support CAPI.
285 Don't build support for CMS features
288 Don't build support for SSL/TLS compression. If this option
289 is left enabled (the default), then compression will only
290 work if the zlib or zlib-dynamic options are also chosen.
293 Build support for debugging memory allocated via
294 OPENSSL_malloc() or OPENSSL_zalloc().
296 enable-crypto-mdebug-backtrace
297 As for crypto-mdebug, but additionally provide backtrace
298 information for allocated memory.
299 TO BE USED WITH CARE: this uses GNU C functionality, and
300 is therefore not usable for non-GNU config targets. If
301 your build complains about the use of '-rdynamic' or the
302 lack of header file execinfo.h, this option is not for you.
303 ALSO NOTE that even though execinfo.h is available on your
304 system (through Gnulib), the functions might just be stubs
308 Don't build support for Certificate Transparency.
311 Don't build with support for any deprecated APIs. This is the
312 same as using "--api" and supplying the latest version
316 Don't build support for datagram based BIOs. Selecting this
317 option will also force the disabling of DTLS.
320 Don't build support for loading Dynamic Shared Objects.
323 Don't build the dynamically loaded engines. This only has an
324 effect in a "shared" build
327 Don't build support for Elliptic Curves.
330 Don't build support for binary Elliptic Curves
332 enable-ec_nistp_64_gcc_128
333 Enable support for optimised implementations of some commonly
334 used NIST elliptic curves. This is only supported on some
338 Build support for gathering entropy from EGD (Entropy
342 Don't build support for loading engines.
345 Don't compile in any error strings.
347 enable-external-tests
348 Enable building of integration with external test suites.
349 This is a developer option and may not work on all platforms.
350 The only supported external test suite at the current time is
351 the BoringSSL test suite. See the file test/README.external
355 Don't compile in filename and line number information (e.g.
356 for errors and memory allocation).
358 enable-fuzz-libfuzzer, enable-fuzz-afl
359 Build with support for fuzzing using either libfuzzer or AFL.
360 These are developer options only. They may not work on all
361 platforms and should never be used in production environments.
362 See the file fuzz/README.md for further details.
365 Don't build support for GOST based ciphersuites. Note that
366 if this feature is enabled then GOST ciphersuites are only
367 available if the GOST algorithms are also available through
368 loading an externally supplied engine.
371 Don't build the padlock engine.
374 Don't generate dependencies.
377 Don't build support for writing multiple records in one
378 go in libssl (Note: this is a different capability to the
379 pipelining functionality).
382 Don't build support for the NPN TLS extension.
385 Don't build support for OCSP.
388 Don't build with support for Position Independent Code.
391 Don't use POSIX IO capabilities.
394 Don't build support for Pre-Shared Key based ciphersuites.
397 Don't use hardware RDRAND capabilities.
400 Don't build support for RFC3779 ("X.509 Extensions for IP
401 Addresses and AS Identifiers")
404 Build support for SCTP
407 Do not create shared libraries, only static ones. See "Note
408 on shared libraries" below.
411 Don't build support for socket BIOs
414 Don't build support for SRP or SRP based ciphersuites.
417 Don't build SRTP support
420 Exclude SSE2 code paths from 32-bit x86 assembly modules.
421 Normally SSE2 extension is detected at run-time, but the
422 decision whether or not the machine code will be executed
423 is taken solely on CPU capability vector. This means that
424 if you happen to run OS kernel which does not support SSE2
425 extension on Intel P4 processor, then your application
426 might be exposed to "illegal instruction" exception.
427 There might be a way to enable support in kernel, e.g.
428 FreeBSD kernel can be compiled with CPU_ENABLE_SSE, and
429 there is a way to disengage SSE2 code paths upon application
430 start-up, but if you aim for wider "audience" running
431 such kernel, consider no-sse2. Both the 386 and
432 no-asm options imply no-sse2.
435 Build with the SSL Trace capabilities (adds the "-trace"
436 option to s_client and s_server).
439 Don't build the statically linked engines. This only
440 has an impact when not built "shared".
443 Don't use anything from the C header file "stdio.h" that
444 makes use of the "FILE" type. Only libcrypto and libssl can
445 be built in this way. Using this option will suppress
446 building the command line applications. Additionally since
447 the OpenSSL tests also use the command line applications the
448 tests will also be skipped.
451 Don't build test programs or run any test.
454 Don't try to build with support for multi-threaded
458 Build with support for multi-threaded applications. Most
459 platforms will enable this by default. However if on a
460 platform where this is not the case then this will usually
461 require additional system-dependent options! See "Note on
462 multi-threading" below.
464 enable-tls13downgrade
465 TODO(TLS1.3): Make this enabled by default and remove the
466 option when TLSv1.3 is out of draft
467 TLSv1.3 offers a downgrade protection mechanism. This is
468 implemented but disabled by default. It should not typically
469 be enabled except for testing purposes. Otherwise this could
470 cause problems if a pre-RFC version of OpenSSL talks to an
471 RFC implementation (it will erroneously be detected as a
475 Don't build Time Stamping Authority support.
478 Build with the Undefined Behaviour sanitiser. This is a
479 developer option only. It may not work on all platforms and
480 should never be used in production environments. It will only
481 work when used with gcc or clang and should be used in
482 conjunction with the "-DPEDANTIC" option (or the
483 --strict-warnings option).
486 Don't build with the "UI" capability (i.e. the set of
487 features enabling text based prompts).
490 Enable additional unit test APIs. This should not typically
491 be used in production deployments.
493 enable-weak-ssl-ciphers
494 Build support for SSL/TLS ciphers that are considered "weak"
495 (e.g. RC4 based ciphersuites).
498 Build with support for zlib compression/decompression.
501 Like "zlib", but has OpenSSL load the zlib library
502 dynamically when needed. This is only supported on systems
503 where loading of shared libraries is supported.
506 In 32-bit x86 builds, when generating assembly modules,
507 use the 80386 instruction set only (the default x86 code
508 is more efficient, but requires at least a 486). Note:
509 This doesn't affect code generated by compiler, you're
510 likely to complement configuration command line with
511 suitable compiler-specific option.
514 Don't build support for negotiating the specified SSL/TLS
515 protocol (one of ssl, ssl3, tls, tls1, tls1_1, tls1_2,
516 tls1_3, dtls, dtls1 or dtls1_2). If "no-tls" is selected then
517 all of tls1, tls1_1, tls1_2 and tls1_3 are disabled.
518 Similarly "no-dtls" will disable dtls1 and dtls1_2. The
519 "no-ssl" option is synonymous with "no-ssl3". Note this only
520 affects version negotiation. OpenSSL will still provide the
521 methods for applications to explicitly select the individual
525 As for no-<prot> but in addition do not build the methods for
526 applications to explicitly select individual protocol
527 versions. Note that there is no "no-tls1_3-method" option
528 because there is no application method for TLSv1.3. Using
529 individual protocol methods directly is deprecated.
530 Applications should use TLS_method() instead.
533 Build with support for the specified algorithm, where <alg>
534 is one of: md2 or rc5.
537 Build without support for the specified algorithm, where
538 <alg> is one of: aria, bf, blake2, camellia, cast, chacha,
539 cmac, des, dh, dsa, ecdh, ecdsa, idea, md4, mdc2, ocb,
540 poly1305, rc2, rc4, rmd160, scrypt, seed, siphash, sm3, sm4
541 or whirlpool. The "ripemd" algorithm is deprecated and if
542 used is synonymous with rmd160.
544 -Dxxx, -Ixxx, -Wp, -lxxx, -Lxxx, -Wl, -rpath, -R, -framework, -static
545 These system specific options will be recognised and
546 passed through to the compiler to allow you to define
547 preprocessor symbols, specify additional libraries, library
548 directories or other compiler options. It might be worth
549 noting that some compilers generate code specifically for
550 processor the compiler currently executes on. This is not
551 necessarily what you might have in mind, since it might be
552 unsuitable for execution on other, typically older,
553 processor. Consult your compiler documentation.
555 Take note of the VAR=value documentation below and how
556 these flags interact with those variables.
559 Additional options that are not otherwise recognised are
560 passed through as they are to the compiler as well. Again,
561 consult your compiler documentation.
563 Take note of the VAR=value documentation below and how
564 these flags interact with those variables.
567 Assignment of environment variable for Configure. These
568 work just like normal environment variable assignments,
569 but are supported on all platforms and are confined to
570 the configuration scripts only. These assignments override
571 the corresponding value in the inherited environment, if
574 The following variables are used as "make variables" and
575 can be used as an alternative to giving preprocessor,
576 compiler and linker options directly as configuration.
577 The following variables are supported:
579 AR The static library archiver.
580 ARFLAGS Flags for the static library archiver.
581 AS The assembler compiler.
582 ASFLAGS Flags for the assembler compiler.
584 CFLAGS Flags for the C compiler.
585 CXX The C++ compiler.
586 CXXFLAGS Flags for the C++ compiler.
587 CPP The C/C++ preprocessor.
588 CPPFLAGS Flags for the C/C++ preprocessor.
589 CPPDEFINES List of CPP macro definitions, separated
590 by a platform specific character (':' or
591 space for Unix, ';' for Windows, ',' for
592 VMS). This can be used instead of using
593 -D (or what corresponds to that on your
594 compiler) in CPPFLAGS.
595 CPPINCLUDES List of CPP inclusion directories, separated
596 the same way as for CPPDEFINES. This can
597 be used instead of -I (or what corresponds
598 to that on your compiler) in CPPFLAGS.
599 HASHBANGPERL Perl invocation to be inserted after '#!'
600 in public perl scripts (only relevant on
602 LD The program linker (not used on Unix, $(CC)
604 LDFLAGS Flags for the shared library, DSO and
606 LDLIBS Extra libraries to use when linking.
607 Takes the form of a space separated list
608 of library specifications on Unix and
609 Windows, and as a comma separated list of
611 RANLIB The library archive indexer.
612 RC The Windows resources manipulator.
613 RCFLAGS Flags for the Windows reources manipulator.
614 RM The command to remove files and directories.
616 These cannot be mixed with compiling / linking flags given
617 on the command line. In other words, something like this
620 ./config -DFOO CPPFLAGS=-DBAR -DCOOKIE
622 Backward compatibility note:
624 To be compatible with older configuration scripts, the
625 environment variables are ignored if compiling / linking
626 flags are given on the command line, except for these:
628 AR, CC, CXX, CROSS_COMPILE, HASHBANGPERL, PERL, RANLIB, RC
631 For example, the following command will not see -DBAR:
633 CPPFLAGS=-DBAR ./config -DCOOKIE
635 However, the following will see both set variables:
637 CC=gcc CROSS_COMPILE=x86_64-w64-mingw32- \
642 Reconfigure from earlier data. This fetches the previous
643 command line options and environment from data saved in
644 "configdata.pm", and runs the configuration process again,
645 using these options and environment.
646 Note: NO other option is permitted together with "reconf".
647 This means that you also MUST use "./Configure" (or
648 what corresponds to that on non-Unix platforms) directly
649 to invoke this option.
650 Note: The original configuration saves away values for ALL
651 environment variables that were used, and if they weren't
652 defined, they are still saved away with information that
653 they weren't originally defined. This information takes
654 precedence over environment variables that are defined
657 Displaying configuration data
658 -----------------------------
660 The configuration script itself will say very little, and finishes by
661 creating "configdata.pm". This perl module can be loaded by other scripts
662 to find all the configuration data, and it can also be used as a script to
663 display all sorts of configuration data in a human readable form.
665 For more information, please do:
667 $ ./configdata.pm --help # Unix
671 $ perl configdata.pm --help # Windows and VMS
673 Installation in Detail
674 ----------------------
676 1a. Configure OpenSSL for your operation system automatically:
678 NOTE: This is not available on Windows.
680 $ ./config [[ options ]] # Unix
684 $ @config [[ options ]] ! OpenVMS
686 For the remainder of this text, the Unix form will be used in all
687 examples, please use the appropriate form for your platform.
689 This guesses at your operating system (and compiler, if necessary) and
690 configures OpenSSL based on this guess. Run ./config -t to see
691 if it guessed correctly. If you want to use a different compiler, you
692 are cross-compiling for another platform, or the ./config guess was
693 wrong for other reasons, go to step 1b. Otherwise go to step 2.
695 On some systems, you can include debugging information as follows:
697 $ ./config -d [[ options ]]
699 1b. Configure OpenSSL for your operating system manually
701 OpenSSL knows about a range of different operating system, hardware and
702 compiler combinations. To see the ones it knows about, run
708 $ perl Configure # All other platforms
710 For the remainder of this text, the Unix form will be used in all
711 examples, please use the appropriate form for your platform.
713 Pick a suitable name from the list that matches your system. For most
714 operating systems there is a choice between using "cc" or "gcc". When
715 you have identified your system (and if necessary compiler) use this name
716 as the argument to Configure. For example, a "linux-elf" user would
719 $ ./Configure linux-elf [[ options ]]
721 If your system isn't listed, you will have to create a configuration
722 file named Configurations/{{ something }}.conf and add the correct
723 configuration for your system. See the available configs as examples
724 and read Configurations/README and Configurations/README.design for
727 The generic configurations "cc" or "gcc" should usually work on 32 bit
730 Configure creates a build file ("Makefile" on Unix, "makefile" on Windows
731 and "descrip.mms" on OpenVMS) from a suitable template in Configurations,
732 and defines various macros in include/openssl/opensslconf.h (generated from
733 include/openssl/opensslconf.h.in).
735 1c. Configure OpenSSL for building outside of the source tree.
737 OpenSSL can be configured to build in a build directory separate from
738 the directory with the source code. It's done by placing yourself in
739 some other directory and invoking the configuration commands from
744 $ mkdir /var/tmp/openssl-build
745 $ cd /var/tmp/openssl-build
746 $ /PATH/TO/OPENSSL/SOURCE/config [[ options ]]
750 $ /PATH/TO/OPENSSL/SOURCE/Configure {{ target }} [[ options ]]
754 $ set default sys$login:
755 $ create/dir [.tmp.openssl-build]
756 $ set default [.tmp.openssl-build]
757 $ @[PATH.TO.OPENSSL.SOURCE]config [[ options ]]
761 $ @[PATH.TO.OPENSSL.SOURCE]Configure {{ target }} [[ options ]]
766 $ mkdir \temp-openssl
768 $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure {{ target }} [[ options ]]
770 Paths can be relative just as well as absolute. Configure will
771 do its best to translate them to relative paths whenever possible.
773 2. Build OpenSSL by running:
776 $ mms ! (or mmk) OpenVMS
779 This will build the OpenSSL libraries (libcrypto.a and libssl.a on
780 Unix, corresponding on other platforms) and the OpenSSL binary
781 ("openssl"). The libraries will be built in the top-level directory,
782 and the binary will be in the "apps" subdirectory.
786 If the build fails, look at the output. There may be reasons
787 for the failure that aren't problems in OpenSSL itself (like
788 missing standard headers).
790 If the build succeeded previously, but fails after a source or
791 configuration change, it might be helpful to clean the build tree
792 before attempting another build. Use this command:
795 $ mms clean ! (or mmk) OpenVMS
796 $ nmake clean # Windows
798 Assembler error messages can sometimes be sidestepped by using the
799 "no-asm" configuration option.
801 Compiling parts of OpenSSL with gcc and others with the system
802 compiler will result in unresolved symbols on some systems.
804 If you are still having problems you can get help by sending an email
805 to the openssl-users email list (see
806 https://www.openssl.org/community/mailinglists.html for details). If
807 it is a bug with OpenSSL itself, please open an issue on GitHub, at
808 https://github.com/openssl/openssl/issues. Please review the existing
809 ones first; maybe the bug was already reported or has already been
812 3. After a successful build, the libraries should be tested. Run:
816 $ nmake test # Windows
818 NOTE: you MUST run the tests from an unprivileged account (or
819 disable your privileges temporarily if your platform allows it).
821 If some tests fail, look at the output. There may be reasons for
822 the failure that isn't a problem in OpenSSL itself (like a
823 malfunction with Perl). You may want increased verbosity, that
824 can be accomplished like this:
826 $ make VERBOSE=1 test # Unix
828 $ mms /macro=(VERBOSE=1) test ! OpenVMS
830 $ nmake VERBOSE=1 test # Windows
832 If you want to run just one or a few specific tests, you can use
833 the make variable TESTS to specify them, like this:
835 $ make TESTS='test_rsa test_dsa' test # Unix
836 $ mms/macro="TESTS=test_rsa test_dsa" test ! OpenVMS
837 $ nmake TESTS='test_rsa test_dsa' test # Windows
839 And of course, you can combine (Unix example shown):
841 $ make VERBOSE=1 TESTS='test_rsa test_dsa' test
843 You can find the list of available tests like this:
845 $ make list-tests # Unix
846 $ mms list-tests ! OpenVMS
847 $ nmake list-tests # Windows
849 Have a look at the manual for the perl module Test::Harness to
850 see what other HARNESS_* variables there are.
852 If you find a problem with OpenSSL itself, try removing any
853 compiler optimization flags from the CFLAGS line in Makefile and
854 run "make clean; make" or corresponding.
856 To report a bug please open an issue on GitHub, at
857 https://github.com/openssl/openssl/issues.
859 For more details on how the make variables TESTS can be used,
860 see section TESTS in Detail below.
862 4. If everything tests ok, install OpenSSL with
864 $ make install # Unix
865 $ mms install ! OpenVMS
866 $ nmake install # Windows
868 This will install all the software components in this directory
869 tree under PREFIX (the directory given with --prefix or its
874 bin/ Contains the openssl binary and a few other
877 Contains the header files needed if you want
878 to build your own programs that use libcrypto
880 lib Contains the OpenSSL library files.
881 lib/engines Contains the OpenSSL dynamically loadable engines.
883 share/man/man1 Contains the OpenSSL command line man-pages.
884 share/man/man3 Contains the OpenSSL library calls man-pages.
885 share/man/man5 Contains the OpenSSL configuration format man-pages.
886 share/man/man7 Contains the OpenSSL other misc man-pages.
888 share/doc/openssl/html/man1
889 share/doc/openssl/html/man3
890 share/doc/openssl/html/man5
891 share/doc/openssl/html/man7
892 Contains the HTML rendition of the man-pages.
894 OpenVMS ('arch' is replaced with the architecture name, "Alpha"
895 or "ia64", 'sover' is replaced with the shared library version
896 (0101 for 1.1), and 'pz' is replaced with the pointer size
897 OpenSSL was built with):
899 [.EXE.'arch'] Contains the openssl binary.
900 [.EXE] Contains a few utility scripts.
902 Contains the header files needed if you want
903 to build your own programs that use libcrypto
905 [.LIB.'arch'] Contains the OpenSSL library files.
906 [.ENGINES'sover''pz'.'arch']
907 Contains the OpenSSL dynamically loadable engines.
908 [.SYS$STARTUP] Contains startup, login and shutdown scripts.
909 These define appropriate logical names and
911 [.SYSTEST] Contains the installation verification procedure.
912 [.HTML] Contains the HTML rendition of the manual pages.
915 Additionally, install will add the following directories under
916 OPENSSLDIR (the directory given with --openssldir or its default)
919 certs Initially empty, this is the default location
920 for certificate files.
921 private Initially empty, this is the default location
922 for private key files.
923 misc Various scripts.
925 Package builders who want to configure the library for standard
926 locations, but have the package installed somewhere else so that
927 it can easily be packaged, can use
929 $ make DESTDIR=/tmp/package-root install # Unix
930 $ mms/macro="DESTDIR=TMP:[PACKAGE-ROOT]" install ! OpenVMS
932 The specified destination directory will be prepended to all
933 installation target paths.
935 Compatibility issues with previous OpenSSL versions:
937 * COMPILING existing applications
939 OpenSSL 1.1.0 hides a number of structures that were previously
940 open. This includes all internal libssl structures and a number
941 of EVP types. Accessor functions have been added to allow
942 controlled access to the structures' data.
944 This means that some software needs to be rewritten to adapt to
945 the new ways of doing things. This often amounts to allocating
946 an instance of a structure explicitly where you could previously
947 allocate them on the stack as automatic variables, and using the
948 provided accessor functions where you would previously access a
949 structure's field directly.
951 Some APIs have changed as well. However, older APIs have been
952 preserved when possible.
954 Environment Variables
955 ---------------------
957 A number of environment variables can be used to provide additional control
958 over the build process. Typically these should be defined prior to running
959 config or Configure. Not all environment variables are relevant to all
963 The name of the ar executable to use.
966 Use a different build file name than the platform default
967 ("Makefile" on Unixly platforms, "makefile" on native Windows,
968 "descrip.mms" on OpenVMS). This requires that there is a
969 corresponding build file template. See Configurations/README
970 for further information.
973 The compiler to use. Configure will attempt to pick a default
974 compiler for your platform but this choice can be overridden
975 using this variable. Set it to the compiler executable you wish
976 to use, e.g. "gcc" or "clang".
979 This environment variable has the same meaning as for the
980 "--cross-compile-prefix" Configure flag described above. If both
981 are set then the Configure flag takes precedence.
984 The name of the nm executable to use.
986 OPENSSL_LOCAL_CONFIG_DIR
987 OpenSSL comes with a database of information about how it
988 should be built on different platforms as well as build file
989 templates for those platforms. The database is comprised of
990 ".conf" files in the Configurations directory. The build
991 file templates reside there as well as ".tmpl" files. See the
992 file Configurations/README for further information about the
993 format of ".conf" files as well as information on the ".tmpl"
995 In addition to the standard ".conf" and ".tmpl" files, it is
996 possible to create your own ".conf" and ".tmpl" files and store
997 them locally, outside the OpenSSL source tree. This environment
998 variable can be set to the directory where these files are held
999 and will be considered by Configure before it looks in the
1000 standard directories.
1003 The name of the Perl executable to use when building OpenSSL.
1004 This variable is used in config script only. Configure on the
1005 other hand imposes the interpreter by which it itself was
1006 executed on the whole build procedure.
1009 The command string for the Perl executable to insert in the
1010 #! line of perl scripts that will be publically installed.
1011 Default: /usr/bin/env perl
1012 Note: the value of this variable is added to the same scripts
1013 on all platforms, but it's only relevant on Unix-like platforms.
1016 The name of the rc executable to use. The default will be as
1017 defined for the target platform in the ".conf" file. If not
1018 defined then "windres" will be used. The WINDRES environment
1019 variable is synonymous to this. If both are defined then RC
1023 The name of the ranlib executable to use.
1031 The Configure script generates a Makefile in a format relevant to the specific
1032 platform. The Makefiles provide a number of targets that can be used. Not all
1033 targets may be available on all platforms. Only the most common targets are
1034 described here. Examine the Makefiles themselves for the full list.
1037 The default target to build all the software components.
1040 Remove all build artefacts and return the directory to a "clean"
1044 Rebuild the dependencies in the Makefiles. This is a legacy
1045 option that no longer needs to be used in OpenSSL 1.1.0.
1048 Install all OpenSSL components.
1051 Only install the OpenSSL software components.
1054 Only install the OpenSSL documentation components.
1057 Only install the OpenSSL man pages (Unix only).
1060 Only install the OpenSSL html documentation.
1063 Prints a list of all the self test names.
1066 Build and run the OpenSSL self tests.
1069 Uninstall all OpenSSL components.
1073 Re-run the configuration process, as exactly as the last time
1077 This is a developer option. If you are developing a patch for
1078 OpenSSL you may need to use this if you want to update
1079 automatically generated files; add new error codes or add new
1080 (or change the visibility of) public API functions. (Unix only).
1085 The make variable TESTS supports a versatile set of space separated tokens
1086 with which you can specify a set of tests to be performed. With a "current
1087 set of tests" in mind, initially being empty, here are the possible tokens:
1089 alltests The current set of tests becomes the whole set of available
1090 tests (as listed when you do 'make list-tests' or similar).
1091 xxx Adds the test 'xxx' to the current set of tests.
1092 -xxx Removes 'xxx' from the current set of tests. If this is the
1093 first token in the list, the current set of tests is first
1094 assigned the whole set of available tests, effectively making
1095 this token equivalent to TESTS="alltests -xxx".
1096 nn Adds the test group 'nn' (which is a number) to the current
1098 -nn Removes the test group 'nn' from the current set of tests.
1099 If this is the first token in the list, the current set of
1100 tests is first assigned the whole set of available tests,
1101 effectively making this token equivalent to
1102 TESTS="alltests -xxx".
1104 Also, all tokens except for "alltests" may have wildcards, such as *.
1105 (on Unix and Windows, BSD style wildcards are supported, while on VMS,
1106 it's VMS style wildcards)
1108 Example: All tests except for the fuzz tests:
1110 $ make TESTS=-test_fuzz test
1112 or (if you want to be explicit)
1114 $ make TESTS='alltests -test_fuzz' test
1116 Example: All tests that have a name starting with "test_ssl" but not those
1117 starting with "test_ssl_":
1119 $ make TESTS='test_ssl* -test_ssl_*' test
1121 Example: Only test group 10:
1125 Example: All tests except the slow group (group 99):
1129 Example: All tests in test groups 80 to 99 except for tests in group 90:
1131 $ make TESTS='[89]? -90'
1133 Note on multi-threading
1134 -----------------------
1136 For some systems, the OpenSSL Configure script knows what compiler options
1137 are needed to generate a library that is suitable for multi-threaded
1138 applications. On these systems, support for multi-threading is enabled
1139 by default; use the "no-threads" option to disable (this should never be
1142 On other systems, to enable support for multi-threading, you will have
1143 to specify at least two options: "threads", and a system-dependent option.
1144 (The latter is "-D_REENTRANT" on various systems.) The default in this
1145 case, obviously, is not to include support for multi-threading (but
1146 you can still use "no-threads" to suppress an annoying warning message
1147 from the Configure script.)
1149 OpenSSL provides built-in support for two threading models: pthreads (found on
1150 most UNIX/Linux systems), and Windows threads. No other threading models are
1151 supported. If your platform does not provide pthreads or Windows threads then
1152 you should Configure with the "no-threads" option.
1154 Notes on shared libraries
1155 -------------------------
1157 For most systems the OpenSSL Configure script knows what is needed to
1158 build shared libraries for libcrypto and libssl. On these systems
1159 the shared libraries will be created by default. This can be suppressed and
1160 only static libraries created by using the "no-shared" option. On systems
1161 where OpenSSL does not know how to build shared libraries the "no-shared"
1162 option will be forced and only static libraries will be created.
1164 Shared libraries are named a little differently on different platforms.
1165 One way or another, they all have the major OpenSSL version number as
1166 part of the file name, i.e. for OpenSSL 1.1.x, 1.1 is somehow part of
1169 On most POSIXly platforms, shared libraries are named libcrypto.so.1.1
1172 on Cygwin, shared libraries are named cygcrypto-1.1.dll and cygssl-1.1.dll
1173 with import libraries libcrypto.dll.a and libssl.dll.a.
1175 On Windows build with MSVC or using MingW, shared libraries are named
1176 libcrypto-1_1.dll and libssl-1_1.dll for 32-bit Windows, libcrypto-1_1-x64.dll
1177 and libssl-1_1-x64.dll for 64-bit x86_64 Windows, and libcrypto-1_1-ia64.dll
1178 and libssl-1_1-ia64.dll for IA64 Windows. With MSVC, the import libraries
1179 are named libcrypto.lib and libssl.lib, while with MingW, they are named
1180 libcrypto.dll.a and libssl.dll.a.
1182 On VMS, shareable images (VMS speak for shared libraries) are named
1183 ossl$libcrypto0101_shr.exe and ossl$libssl0101_shr.exe. However, when
1184 OpenSSL is specifically built for 32-bit pointers, the shareable images
1185 are named ossl$libcrypto0101_shr32.exe and ossl$libssl0101_shr32.exe
1186 instead, and when built for 64-bit pointers, they are named
1187 ossl$libcrypto0101_shr64.exe and ossl$libssl0101_shr64.exe.
1189 Note on random number generation
1190 --------------------------------
1192 Availability of cryptographically secure random numbers is required for
1193 secret key generation. OpenSSL provides several options to seed the
1194 internal CSPRNG. If not properly seeded, the internal CSPRNG will refuse
1195 to deliver random bytes and a "PRNG not seeded error" will occur.
1197 The seeding method can be configured using the --with-rand-seed option,
1198 which can be used to specify a comma separated list of seed methods.
1199 However in most cases OpenSSL will choose a suitable default method,
1200 so it is not necessary to explicitely provide this option. Note also
1201 that not all methods are available on all platforms.
1203 I) On operating systems which provide a suitable randomness source (in
1204 form of a system call or system device), OpenSSL will use the optimal
1205 available method to seed the CSPRNG from the operating system's
1206 randomness sources. This corresponds to the option --with-rand-seed=os.
1208 II) On systems without such a suitable randomness source, automatic seeding
1209 and reseeding is disabled (--with-rand-seed=none) and it may be necessary
1210 to install additional support software to obtain a random seed and reseed
1211 the CSPRNG manually. Please check out the manual pages for RAND_add(),
1212 RAND_bytes(), RAND_egd(), and the FAQ for more information.
projects / openssl.git / blob