4 This document describes installation on all supported operating
5 systems (the Unix/Linux family (which includes Mac OS/X), OpenVMS,
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)
25 * NOTES.ANDROID (obviously Android [NDK])
27 Notational conventions in this document
28 ---------------------------------------
30 Throughout this document, we use the following conventions in command
33 $ command Any line starting with a dollar sign
34 ($) is a command line.
36 { word1 | word2 | word3 } This denotes a mandatory choice, to be
37 replaced with one of the given words.
38 A simple example would be this:
40 $ echo { FOO | BAR | COOKIE }
42 which is to be understood as one of
51 [ word1 | word2 | word3 ] Similar to { word1 | word2 | word3 }
52 except it's optional to give any of
53 those. In addition to the examples
54 above, this would also be valid:
58 {{ target }} This denotes a mandatory word or
59 sequence of words of some sort. A
60 simple example would be this:
64 which is to be understood to use the
65 command 'type' on some file name
66 determined by the user.
68 [[ options ]] Similar to {{ target }}, but is
71 Note that the notation assumes spaces around {, }, [, ], {{, }} and
72 [[, ]]. This is to differentiate from OpenVMS directory
73 specifications, which also use [ and ], but without spaces.
78 If you want to just get on with it, do:
80 on Unix (again, this includes Mac OS/X):
94 on Windows (only pick one of the targets for configuration):
96 $ perl Configure { VC-WIN32 | VC-WIN64A | VC-WIN64I | VC-CE }
101 If any of these steps fails, see section Installation in Detail below.
103 This will build and install OpenSSL in the default location, which is:
105 Unix: normal installation directories under /usr/local
106 OpenVMS: SYS$COMMON:[OPENSSL-'version'...], where 'version' is the
107 OpenSSL version number with underscores instead of periods.
108 Windows: C:\Program Files\OpenSSL or C:\Program Files (x86)\OpenSSL
110 If you want to install it anywhere else, run config like this:
114 $ ./config --prefix=/opt/openssl --openssldir=/usr/local/ssl
118 $ @config --prefix=PROGRAM:[INSTALLS] --openssldir=SYS$MANAGER:[OPENSSL]
120 (Note: if you do add options to the configuration command, please make sure
121 you've read more than just this Quick Start, such as relevant NOTES.* files,
122 the options outline below, as configuration options may change the outcome
123 in otherwise unexpected ways)
126 Configuration Options
127 ---------------------
129 There are several options to ./config (or ./Configure) to customize
130 the build (note that for Windows, the defaults for --prefix and
131 --openssldir depend in what configuration is used and what Windows
132 implementation OpenSSL is built on. More notes on this in NOTES.WIN):
135 Don't build with support for deprecated APIs below the
136 specified version number. For example "--api=1.1.0" will
137 remove support for all APIS that were deprecated in OpenSSL
138 version 1.1.0 or below.
140 --cross-compile-prefix=PREFIX
141 The PREFIX to include in front of commands for your
142 toolchain. It's likely to have to end with dash, e.g.
143 a-b-c- would invoke GNU compiler as a-b-c-gcc, etc.
144 Unfortunately cross-compiling is too case-specific to
145 put together one-size-fits-all instructions. You might
146 have to pass more flags or set up environment variables
147 to actually make it work. Android and iOS cases are
148 discussed in corresponding Configurations/15-*.conf
149 files. But there are cases when this option alone is
150 sufficient. For example to build the mingw64 target on
151 Linux "--cross-compile-prefix=x86_64-w64-mingw32-"
152 works. Naturally provided that mingw packages are
153 installed. Today Debian and Ubuntu users have option to
154 install a number of prepackaged cross-compilers along
155 with corresponding run-time and development packages for
156 "alien" hardware. To give another example
157 "--cross-compile-prefix=mipsel-linux-gnu-" suffices
158 in such case. Needless to mention that you have to
159 invoke ./Configure, not ./config, and pass your target
160 name explicitly. Also, note that --openssldir refers
161 to target's file system, not one you are building on.
164 Build OpenSSL with debugging symbols and zero optimization
168 The name of the directory under the top of the installation
169 directory tree (see the --prefix option) where libraries will
170 be installed. By default this is "lib". Note that on Windows
171 only ".lib" files will be stored in this location. dll files
172 will always be installed to the "bin" directory.
175 Directory for OpenSSL configuration files, and also the
176 default certificate and key store. Defaults are:
179 Windows: C:\Program Files\Common Files\SSL
180 or C:\Program Files (x86)\Common Files\SSL
181 OpenVMS: SYS$COMMON:[OPENSSL-COMMON]
184 The top of the installation directory tree. Defaults are:
187 Windows: C:\Program Files\OpenSSL
188 or C:\Program Files (x86)\OpenSSL
189 OpenVMS: SYS$COMMON:[OPENSSL-'version']
192 Build OpenSSL without debugging symbols. This is the default.
195 This is a developer flag that switches on various compiler
196 options recommended for OpenSSL development. It only works
197 when using gcc or clang as the compiler. If you are
198 developing a patch for OpenSSL then it is recommended that
199 you use this option where possible.
201 --with-zlib-include=DIR
202 The directory for the location of the zlib include file. This
203 option is only necessary if enable-zlib (see below) is used
204 and the include file is not already on the system include
208 On Unix: this is the directory containing the zlib library.
209 If not provided the system library path will be used.
210 On Windows: this is the filename of the zlib library (with or
211 without a path). This flag must be provided if the
212 zlib-dynamic option is not also used. If zlib-dynamic is used
213 then this flag is optional and a default value ("ZLIB1") is
214 used if not provided.
215 On VMS: this is the filename of the zlib library (with or
216 without a path). This flag is optional and if not provided
217 then "GNV$LIBZSHR", "GNV$LIBZSHR32" or "GNV$LIBZSHR64" is
218 used by default depending on the pointer size chosen.
221 --with-rand-seed=seed1[,seed2,...]
222 A comma separated list of seeding methods which will be tried
223 by OpenSSL in order to obtain random input (a.k.a "entropy")
224 for seeding its cryptographically secure random number
225 generator (CSPRNG). The current seeding methods are:
227 os: Use a trusted operating system entropy source.
228 This is the default method if such an entropy
230 getrandom: Use the L<getrandom(2)> or equivalent system
232 devrandom: Use the the first device from the DEVRANDOM list
233 which can be opened to read random bytes. The
234 DEVRANDOM preprocessor constant expands to
235 "/dev/urandom","/dev/random","/dev/srandom" on
236 most unix-ish operating systems.
237 egd: Check for an entropy generating daemon.
238 rdcpu: Use the RDSEED or RDRAND command if provided by
240 librandom: Use librandom (not implemented yet).
241 none: Disable automatic seeding. This is the default
242 on some operating systems where no suitable
243 entropy source exists, or no support for it is
246 For more information, see the section 'Note on random number
247 generation' at the end of this document.
250 Don't build the AFALG engine. This option will be forced if
251 on a platform that does not support AFALG.
254 Build with Kernel TLS support. This option will enable the
255 use of the Kernel TLS data-path, which can improve
256 performance and allow for the use of sendfile and splice
257 system calls on TLS sockets. The Kernel may use TLS
258 accelerators if any are available on the system.
259 This option will be forced off on systems that do not support
260 the Kernel TLS data-path.
263 Build with the Address sanitiser. This is a developer option
264 only. It may not work on all platforms and should never be
265 used in production environments. It will only work when used
266 with gcc or clang and should be used in conjunction with the
270 Do not use assembler code. This should be viewed as
271 debugging/trouble-shooting option rather than production.
272 On some platforms a small amount of assembler code may
273 still be used even with this option.
276 Do not build support for async operations.
279 Don't automatically load all supported ciphers and digests.
280 Typically OpenSSL will make available all of its supported
281 ciphers and digests. For a statically linked application this
282 may be undesirable if small executable size is an objective.
283 This only affects libcrypto. Ciphers and digests will have to
284 be loaded manually using EVP_add_cipher() and
285 EVP_add_digest() if this option is used. This option will
286 force a non-shared build.
289 Don't automatically load all libcrypto/libssl error strings.
290 Typically OpenSSL will automatically load human readable
291 error strings. For a statically linked application this may
292 be undesirable if small executable size is an objective.
295 Don't automatically load the default openssl.cnf file.
296 Typically OpenSSL will automatically load a system config
297 file which configures default ssl options.
300 Don't build the CAPI engine. This option will be forced if
301 on a platform that does not support CAPI.
304 Don't build support for CMS features
307 Don't build support for SSL/TLS compression. If this option
308 is left enabled (the default), then compression will only
309 work if the zlib or zlib-dynamic options are also chosen.
312 Build support for debugging memory allocated via
313 OPENSSL_malloc() or OPENSSL_zalloc().
315 enable-crypto-mdebug-backtrace
316 As for crypto-mdebug, but additionally provide backtrace
317 information for allocated memory.
318 TO BE USED WITH CARE: this uses GNU C functionality, and
319 is therefore not usable for non-GNU config targets. If
320 your build complains about the use of '-rdynamic' or the
321 lack of header file execinfo.h, this option is not for you.
322 ALSO NOTE that even though execinfo.h is available on your
323 system (through Gnulib), the functions might just be stubs
327 Don't build support for Certificate Transparency.
330 Don't build with support for any deprecated APIs. This is the
331 same as using "--api" and supplying the latest version
335 Don't build support for datagram based BIOs. Selecting this
336 option will also force the disabling of DTLS.
339 Don't build support for loading Dynamic Shared Objects.
342 Don't build the dynamically loaded engines. This only has an
343 effect in a "shared" build
346 Don't build support for Elliptic Curves.
349 Don't build support for binary Elliptic Curves
351 enable-ec_nistp_64_gcc_128
352 Enable support for optimised implementations of some commonly
353 used NIST elliptic curves.
354 This is only supported on platforms:
355 - with little-endian storage of non-byte types
356 - that tolerate misaligned memory references
357 - where the compiler:
358 - supports the non-standard type __uint128_t
359 - defines the built-in macro __SIZEOF_INT128__
362 Build support for gathering entropy from EGD (Entropy
366 Don't build support for loading engines.
369 Don't compile in any error strings.
371 enable-external-tests
372 Enable building of integration with external test suites.
373 This is a developer option and may not work on all platforms.
374 The only supported external test suite at the current time is
375 the BoringSSL test suite. See the file test/README.external
379 Don't compile in filename and line number information (e.g.
380 for errors and memory allocation).
382 enable-fuzz-libfuzzer, enable-fuzz-afl
383 Build with support for fuzzing using either libfuzzer or AFL.
384 These are developer options only. They may not work on all
385 platforms and should never be used in production environments.
386 See the file fuzz/README.md for further details.
389 Don't build support for GOST based ciphersuites. Note that
390 if this feature is enabled then GOST ciphersuites are only
391 available if the GOST algorithms are also available through
392 loading an externally supplied engine.
395 Don't build the padlock engine.
398 Don't generate dependencies.
401 Don't build support for writing multiple records in one
402 go in libssl (Note: this is a different capability to the
403 pipelining functionality).
406 Don't build support for the NPN TLS extension.
409 Don't build support for OCSP.
412 Don't build with support for Position Independent Code.
415 Don't use POSIX IO capabilities.
418 Don't build support for Pre-Shared Key based ciphersuites.
421 Don't use hardware RDRAND capabilities.
424 Don't build support for RFC3779 ("X.509 Extensions for IP
425 Addresses and AS Identifiers")
428 Build support for SCTP
431 Do not create shared libraries, only static ones. See "Note
432 on shared libraries" below.
435 Don't build support for socket BIOs
438 Don't build support for SRP or SRP based ciphersuites.
441 Don't build SRTP support
444 Exclude SSE2 code paths from 32-bit x86 assembly modules.
445 Normally SSE2 extension is detected at run-time, but the
446 decision whether or not the machine code will be executed
447 is taken solely on CPU capability vector. This means that
448 if you happen to run OS kernel which does not support SSE2
449 extension on Intel P4 processor, then your application
450 might be exposed to "illegal instruction" exception.
451 There might be a way to enable support in kernel, e.g.
452 FreeBSD kernel can be compiled with CPU_ENABLE_SSE, and
453 there is a way to disengage SSE2 code paths upon application
454 start-up, but if you aim for wider "audience" running
455 such kernel, consider no-sse2. Both the 386 and
456 no-asm options imply no-sse2.
459 Build with the SSL Trace capabilities (adds the "-trace"
460 option to s_client and s_server).
463 Don't build the statically linked engines. This only
464 has an impact when not built "shared".
467 Don't use anything from the C header file "stdio.h" that
468 makes use of the "FILE" type. Only libcrypto and libssl can
469 be built in this way. Using this option will suppress
470 building the command line applications. Additionally since
471 the OpenSSL tests also use the command line applications the
472 tests will also be skipped.
475 Don't build test programs or run any test.
478 Don't try to build with support for multi-threaded
482 Build with support for multi-threaded applications. Most
483 platforms will enable this by default. However if on a
484 platform where this is not the case then this will usually
485 require additional system-dependent options! See "Note on
486 multi-threading" below.
489 Don't build Time Stamping Authority support.
492 Build with the Undefined Behaviour sanitiser. This is a
493 developer option only. It may not work on all platforms and
494 should never be used in production environments. It will only
495 work when used with gcc or clang and should be used in
496 conjunction with the "-DPEDANTIC" option (or the
497 --strict-warnings option).
500 Don't build with the "UI" capability (i.e. the set of
501 features enabling text based prompts).
504 Enable additional unit test APIs. This should not typically
505 be used in production deployments.
507 enable-weak-ssl-ciphers
508 Build support for SSL/TLS ciphers that are considered "weak"
509 (e.g. RC4 based ciphersuites).
512 Build with support for zlib compression/decompression.
515 Like "zlib", but has OpenSSL load the zlib library
516 dynamically when needed. This is only supported on systems
517 where loading of shared libraries is supported.
520 In 32-bit x86 builds, when generating assembly modules,
521 use the 80386 instruction set only (the default x86 code
522 is more efficient, but requires at least a 486). Note:
523 This doesn't affect code generated by compiler, you're
524 likely to complement configuration command line with
525 suitable compiler-specific option.
528 Don't build support for negotiating the specified SSL/TLS
529 protocol (one of ssl, ssl3, tls, tls1, tls1_1, tls1_2,
530 tls1_3, dtls, dtls1 or dtls1_2). If "no-tls" is selected then
531 all of tls1, tls1_1, tls1_2 and tls1_3 are disabled.
532 Similarly "no-dtls" will disable dtls1 and dtls1_2. The
533 "no-ssl" option is synonymous with "no-ssl3". Note this only
534 affects version negotiation. OpenSSL will still provide the
535 methods for applications to explicitly select the individual
539 As for no-<prot> but in addition do not build the methods for
540 applications to explicitly select individual protocol
541 versions. Note that there is no "no-tls1_3-method" option
542 because there is no application method for TLSv1.3. Using
543 individual protocol methods directly is deprecated.
544 Applications should use TLS_method() instead.
547 Build with support for the specified algorithm, where <alg>
548 is one of: md2 or rc5.
551 Build without support for the specified algorithm, where
552 <alg> is one of: aria, bf, blake2, camellia, cast, chacha,
553 cmac, des, dh, dsa, ecdh, ecdsa, idea, md4, mdc2, ocb,
554 poly1305, rc2, rc4, rmd160, scrypt, seed, siphash, sm2, sm3,
555 sm4 or whirlpool. The "ripemd" algorithm is deprecated and
556 if used is synonymous with rmd160.
558 -Dxxx, -Ixxx, -Wp, -lxxx, -Lxxx, -Wl, -rpath, -R, -framework, -static
559 These system specific options will be recognised and
560 passed through to the compiler to allow you to define
561 preprocessor symbols, specify additional libraries, library
562 directories or other compiler options. It might be worth
563 noting that some compilers generate code specifically for
564 processor the compiler currently executes on. This is not
565 necessarily what you might have in mind, since it might be
566 unsuitable for execution on other, typically older,
567 processor. Consult your compiler documentation.
569 Take note of the VAR=value documentation below and how
570 these flags interact with those variables.
573 Additional options that are not otherwise recognised are
574 passed through as they are to the compiler as well. Again,
575 consult your compiler documentation.
577 Take note of the VAR=value documentation below and how
578 these flags interact with those variables.
581 Assignment of environment variable for Configure. These
582 work just like normal environment variable assignments,
583 but are supported on all platforms and are confined to
584 the configuration scripts only. These assignments override
585 the corresponding value in the inherited environment, if
588 The following variables are used as "make variables" and
589 can be used as an alternative to giving preprocessor,
590 compiler and linker options directly as configuration.
591 The following variables are supported:
593 AR The static library archiver.
594 ARFLAGS Flags for the static library archiver.
595 AS The assembler compiler.
596 ASFLAGS Flags for the assembler compiler.
598 CFLAGS Flags for the C compiler.
599 CXX The C++ compiler.
600 CXXFLAGS Flags for the C++ compiler.
601 CPP The C/C++ preprocessor.
602 CPPFLAGS Flags for the C/C++ preprocessor.
603 CPPDEFINES List of CPP macro definitions, separated
604 by a platform specific character (':' or
605 space for Unix, ';' for Windows, ',' for
606 VMS). This can be used instead of using
607 -D (or what corresponds to that on your
608 compiler) in CPPFLAGS.
609 CPPINCLUDES List of CPP inclusion directories, separated
610 the same way as for CPPDEFINES. This can
611 be used instead of -I (or what corresponds
612 to that on your compiler) in CPPFLAGS.
613 HASHBANGPERL Perl invocation to be inserted after '#!'
614 in public perl scripts (only relevant on
616 LD The program linker (not used on Unix, $(CC)
618 LDFLAGS Flags for the shared library, DSO and
620 LDLIBS Extra libraries to use when linking.
621 Takes the form of a space separated list
622 of library specifications on Unix and
623 Windows, and as a comma separated list of
625 RANLIB The library archive indexer.
626 RC The Windows resource compiler.
627 RCFLAGS Flags for the Windows resource compiler.
628 RM The command to remove files and directories.
630 These cannot be mixed with compiling / linking flags given
631 on the command line. In other words, something like this
634 ./config -DFOO CPPFLAGS=-DBAR -DCOOKIE
636 Backward compatibility note:
638 To be compatible with older configuration scripts, the
639 environment variables are ignored if compiling / linking
640 flags are given on the command line, except for these:
642 AR, CC, CXX, CROSS_COMPILE, HASHBANGPERL, PERL, RANLIB, RC
645 For example, the following command will not see -DBAR:
647 CPPFLAGS=-DBAR ./config -DCOOKIE
649 However, the following will see both set variables:
651 CC=gcc CROSS_COMPILE=x86_64-w64-mingw32- \
656 Reconfigure from earlier data. This fetches the previous
657 command line options and environment from data saved in
658 "configdata.pm", and runs the configuration process again,
659 using these options and environment.
660 Note: NO other option is permitted together with "reconf".
661 This means that you also MUST use "./Configure" (or
662 what corresponds to that on non-Unix platforms) directly
663 to invoke this option.
664 Note: The original configuration saves away values for ALL
665 environment variables that were used, and if they weren't
666 defined, they are still saved away with information that
667 they weren't originally defined. This information takes
668 precedence over environment variables that are defined
671 Displaying configuration data
672 -----------------------------
674 The configuration script itself will say very little, and finishes by
675 creating "configdata.pm". This perl module can be loaded by other scripts
676 to find all the configuration data, and it can also be used as a script to
677 display all sorts of configuration data in a human readable form.
679 For more information, please do:
681 $ ./configdata.pm --help # Unix
685 $ perl configdata.pm --help # Windows and VMS
687 Installation in Detail
688 ----------------------
690 1a. Configure OpenSSL for your operation system automatically:
692 NOTE: This is not available on Windows.
694 $ ./config [[ options ]] # Unix
698 $ @config [[ options ]] ! OpenVMS
700 For the remainder of this text, the Unix form will be used in all
701 examples, please use the appropriate form for your platform.
703 This guesses at your operating system (and compiler, if necessary) and
704 configures OpenSSL based on this guess. Run ./config -t to see
705 if it guessed correctly. If you want to use a different compiler, you
706 are cross-compiling for another platform, or the ./config guess was
707 wrong for other reasons, go to step 1b. Otherwise go to step 2.
709 On some systems, you can include debugging information as follows:
711 $ ./config -d [[ options ]]
713 1b. Configure OpenSSL for your operating system manually
715 OpenSSL knows about a range of different operating system, hardware and
716 compiler combinations. To see the ones it knows about, run
722 $ perl Configure # All other platforms
724 For the remainder of this text, the Unix form will be used in all
725 examples, please use the appropriate form for your platform.
727 Pick a suitable name from the list that matches your system. For most
728 operating systems there is a choice between using "cc" or "gcc". When
729 you have identified your system (and if necessary compiler) use this name
730 as the argument to Configure. For example, a "linux-elf" user would
733 $ ./Configure linux-elf [[ options ]]
735 If your system isn't listed, you will have to create a configuration
736 file named Configurations/{{ something }}.conf and add the correct
737 configuration for your system. See the available configs as examples
738 and read Configurations/README and Configurations/README.design for
741 The generic configurations "cc" or "gcc" should usually work on 32 bit
744 Configure creates a build file ("Makefile" on Unix, "makefile" on Windows
745 and "descrip.mms" on OpenVMS) from a suitable template in Configurations,
746 and defines various macros in include/openssl/opensslconf.h (generated from
747 include/openssl/opensslconf.h.in).
749 1c. Configure OpenSSL for building outside of the source tree.
751 OpenSSL can be configured to build in a build directory separate from
752 the directory with the source code. It's done by placing yourself in
753 some other directory and invoking the configuration commands from
758 $ mkdir /var/tmp/openssl-build
759 $ cd /var/tmp/openssl-build
760 $ /PATH/TO/OPENSSL/SOURCE/config [[ options ]]
764 $ /PATH/TO/OPENSSL/SOURCE/Configure {{ target }} [[ options ]]
768 $ set default sys$login:
769 $ create/dir [.tmp.openssl-build]
770 $ set default [.tmp.openssl-build]
771 $ @[PATH.TO.OPENSSL.SOURCE]config [[ options ]]
775 $ @[PATH.TO.OPENSSL.SOURCE]Configure {{ target }} [[ options ]]
780 $ mkdir \temp-openssl
782 $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure {{ target }} [[ options ]]
784 Paths can be relative just as well as absolute. Configure will
785 do its best to translate them to relative paths whenever possible.
787 2. Build OpenSSL by running:
790 $ mms ! (or mmk) OpenVMS
793 This will build the OpenSSL libraries (libcrypto.a and libssl.a on
794 Unix, corresponding on other platforms) and the OpenSSL binary
795 ("openssl"). The libraries will be built in the top-level directory,
796 and the binary will be in the "apps" subdirectory.
800 If the build fails, look at the output. There may be reasons
801 for the failure that aren't problems in OpenSSL itself (like
802 missing standard headers).
804 If the build succeeded previously, but fails after a source or
805 configuration change, it might be helpful to clean the build tree
806 before attempting another build. Use this command:
809 $ mms clean ! (or mmk) OpenVMS
810 $ nmake clean # Windows
812 Assembler error messages can sometimes be sidestepped by using the
813 "no-asm" configuration option.
815 Compiling parts of OpenSSL with gcc and others with the system
816 compiler will result in unresolved symbols on some systems.
818 If you are still having problems you can get help by sending an email
819 to the openssl-users email list (see
820 https://www.openssl.org/community/mailinglists.html for details). If
821 it is a bug with OpenSSL itself, please open an issue on GitHub, at
822 https://github.com/openssl/openssl/issues. Please review the existing
823 ones first; maybe the bug was already reported or has already been
826 3. After a successful build, the libraries should be tested. Run:
830 $ nmake test # Windows
832 NOTE: you MUST run the tests from an unprivileged account (or
833 disable your privileges temporarily if your platform allows it).
835 If some tests fail, look at the output. There may be reasons for
836 the failure that isn't a problem in OpenSSL itself (like a
837 malfunction with Perl). You may want increased verbosity, that
838 can be accomplished like this:
840 $ make VERBOSE=1 test # Unix
842 $ mms /macro=(VERBOSE=1) test ! OpenVMS
844 $ nmake VERBOSE=1 test # Windows
846 If you want to run just one or a few specific tests, you can use
847 the make variable TESTS to specify them, like this:
849 $ make TESTS='test_rsa test_dsa' test # Unix
850 $ mms/macro="TESTS=test_rsa test_dsa" test ! OpenVMS
851 $ nmake TESTS='test_rsa test_dsa' test # Windows
853 And of course, you can combine (Unix example shown):
855 $ make VERBOSE=1 TESTS='test_rsa test_dsa' test
857 You can find the list of available tests like this:
859 $ make list-tests # Unix
860 $ mms list-tests ! OpenVMS
861 $ nmake list-tests # Windows
863 Have a look at the manual for the perl module Test::Harness to
864 see what other HARNESS_* variables there are.
866 If you find a problem with OpenSSL itself, try removing any
867 compiler optimization flags from the CFLAGS line in Makefile and
868 run "make clean; make" or corresponding.
870 To report a bug please open an issue on GitHub, at
871 https://github.com/openssl/openssl/issues.
873 For more details on how the make variables TESTS can be used,
874 see section TESTS in Detail below.
876 4. If everything tests ok, install OpenSSL with
878 $ make install # Unix
879 $ mms install ! OpenVMS
880 $ nmake install # Windows
882 This will install all the software components in this directory
883 tree under PREFIX (the directory given with --prefix or its
888 bin/ Contains the openssl binary and a few other
891 Contains the header files needed if you want
892 to build your own programs that use libcrypto
894 lib Contains the OpenSSL library files.
895 lib/engines Contains the OpenSSL dynamically loadable engines.
897 share/man/man1 Contains the OpenSSL command line man-pages.
898 share/man/man3 Contains the OpenSSL library calls man-pages.
899 share/man/man5 Contains the OpenSSL configuration format man-pages.
900 share/man/man7 Contains the OpenSSL other misc man-pages.
902 share/doc/openssl/html/man1
903 share/doc/openssl/html/man3
904 share/doc/openssl/html/man5
905 share/doc/openssl/html/man7
906 Contains the HTML rendition of the man-pages.
908 OpenVMS ('arch' is replaced with the architecture name, "Alpha"
909 or "ia64", 'sover' is replaced with the shared library version
910 (0101 for 1.1), and 'pz' is replaced with the pointer size
911 OpenSSL was built with):
913 [.EXE.'arch'] Contains the openssl binary.
914 [.EXE] Contains a few utility scripts.
916 Contains the header files needed if you want
917 to build your own programs that use libcrypto
919 [.LIB.'arch'] Contains the OpenSSL library files.
920 [.ENGINES'sover''pz'.'arch']
921 Contains the OpenSSL dynamically loadable engines.
922 [.SYS$STARTUP] Contains startup, login and shutdown scripts.
923 These define appropriate logical names and
925 [.SYSTEST] Contains the installation verification procedure.
926 [.HTML] Contains the HTML rendition of the manual pages.
929 Additionally, install will add the following directories under
930 OPENSSLDIR (the directory given with --openssldir or its default)
933 certs Initially empty, this is the default location
934 for certificate files.
935 private Initially empty, this is the default location
936 for private key files.
937 misc Various scripts.
939 Package builders who want to configure the library for standard
940 locations, but have the package installed somewhere else so that
941 it can easily be packaged, can use
943 $ make DESTDIR=/tmp/package-root install # Unix
944 $ mms/macro="DESTDIR=TMP:[PACKAGE-ROOT]" install ! OpenVMS
946 The specified destination directory will be prepended to all
947 installation target paths.
949 Compatibility issues with previous OpenSSL versions:
951 * COMPILING existing applications
953 OpenSSL 1.1.0 hides a number of structures that were previously
954 open. This includes all internal libssl structures and a number
955 of EVP types. Accessor functions have been added to allow
956 controlled access to the structures' data.
958 This means that some software needs to be rewritten to adapt to
959 the new ways of doing things. This often amounts to allocating
960 an instance of a structure explicitly where you could previously
961 allocate them on the stack as automatic variables, and using the
962 provided accessor functions where you would previously access a
963 structure's field directly.
965 Some APIs have changed as well. However, older APIs have been
966 preserved when possible.
968 Environment Variables
969 ---------------------
971 A number of environment variables can be used to provide additional control
972 over the build process. Typically these should be defined prior to running
973 config or Configure. Not all environment variables are relevant to all
977 The name of the ar executable to use.
980 Use a different build file name than the platform default
981 ("Makefile" on Unix-like platforms, "makefile" on native Windows,
982 "descrip.mms" on OpenVMS). This requires that there is a
983 corresponding build file template. See Configurations/README
984 for further information.
987 The compiler to use. Configure will attempt to pick a default
988 compiler for your platform but this choice can be overridden
989 using this variable. Set it to the compiler executable you wish
990 to use, e.g. "gcc" or "clang".
993 This environment variable has the same meaning as for the
994 "--cross-compile-prefix" Configure flag described above. If both
995 are set then the Configure flag takes precedence.
998 The name of the nm executable to use.
1000 OPENSSL_LOCAL_CONFIG_DIR
1001 OpenSSL comes with a database of information about how it
1002 should be built on different platforms as well as build file
1003 templates for those platforms. The database is comprised of
1004 ".conf" files in the Configurations directory. The build
1005 file templates reside there as well as ".tmpl" files. See the
1006 file Configurations/README for further information about the
1007 format of ".conf" files as well as information on the ".tmpl"
1009 In addition to the standard ".conf" and ".tmpl" files, it is
1010 possible to create your own ".conf" and ".tmpl" files and store
1011 them locally, outside the OpenSSL source tree. This environment
1012 variable can be set to the directory where these files are held
1013 and will be considered by Configure before it looks in the
1014 standard directories.
1017 The name of the Perl executable to use when building OpenSSL.
1018 This variable is used in config script only. Configure on the
1019 other hand imposes the interpreter by which it itself was
1020 executed on the whole build procedure.
1023 The command string for the Perl executable to insert in the
1024 #! line of perl scripts that will be publically installed.
1025 Default: /usr/bin/env perl
1026 Note: the value of this variable is added to the same scripts
1027 on all platforms, but it's only relevant on Unix-like platforms.
1030 The name of the rc executable to use. The default will be as
1031 defined for the target platform in the ".conf" file. If not
1032 defined then "windres" will be used. The WINDRES environment
1033 variable is synonymous to this. If both are defined then RC
1037 The name of the ranlib executable to use.
1045 The Configure script generates a Makefile in a format relevant to the specific
1046 platform. The Makefiles provide a number of targets that can be used. Not all
1047 targets may be available on all platforms. Only the most common targets are
1048 described here. Examine the Makefiles themselves for the full list.
1051 The default target to build all the software components.
1054 Remove all build artefacts and return the directory to a "clean"
1058 Rebuild the dependencies in the Makefiles. This is a legacy
1059 option that no longer needs to be used in OpenSSL 1.1.0.
1062 Install all OpenSSL components.
1065 Only install the OpenSSL software components.
1068 Only install the OpenSSL documentation components.
1071 Only install the OpenSSL man pages (Unix only).
1074 Only install the OpenSSL html documentation.
1077 Prints a list of all the self test names.
1080 Build and run the OpenSSL self tests.
1083 Uninstall all OpenSSL components.
1087 Re-run the configuration process, as exactly as the last time
1091 This is a developer option. If you are developing a patch for
1092 OpenSSL you may need to use this if you want to update
1093 automatically generated files; add new error codes or add new
1094 (or change the visibility of) public API functions. (Unix only).
1099 The make variable TESTS supports a versatile set of space separated tokens
1100 with which you can specify a set of tests to be performed. With a "current
1101 set of tests" in mind, initially being empty, here are the possible tokens:
1103 alltests The current set of tests becomes the whole set of available
1104 tests (as listed when you do 'make list-tests' or similar).
1105 xxx Adds the test 'xxx' to the current set of tests.
1106 -xxx Removes 'xxx' from the current set of tests. If this is the
1107 first token in the list, the current set of tests is first
1108 assigned the whole set of available tests, effectively making
1109 this token equivalent to TESTS="alltests -xxx".
1110 nn Adds the test group 'nn' (which is a number) to the current
1112 -nn Removes the test group 'nn' from the current set of tests.
1113 If this is the first token in the list, the current set of
1114 tests is first assigned the whole set of available tests,
1115 effectively making this token equivalent to
1116 TESTS="alltests -xxx".
1118 Also, all tokens except for "alltests" may have wildcards, such as *.
1119 (on Unix and Windows, BSD style wildcards are supported, while on VMS,
1120 it's VMS style wildcards)
1122 Example: All tests except for the fuzz tests:
1124 $ make TESTS=-test_fuzz test
1126 or (if you want to be explicit)
1128 $ make TESTS='alltests -test_fuzz' test
1130 Example: All tests that have a name starting with "test_ssl" but not those
1131 starting with "test_ssl_":
1133 $ make TESTS='test_ssl* -test_ssl_*' test
1135 Example: Only test group 10:
1139 Example: All tests except the slow group (group 99):
1143 Example: All tests in test groups 80 to 99 except for tests in group 90:
1145 $ make TESTS='[89]? -90'
1147 Note on multi-threading
1148 -----------------------
1150 For some systems, the OpenSSL Configure script knows what compiler options
1151 are needed to generate a library that is suitable for multi-threaded
1152 applications. On these systems, support for multi-threading is enabled
1153 by default; use the "no-threads" option to disable (this should never be
1156 On other systems, to enable support for multi-threading, you will have
1157 to specify at least two options: "threads", and a system-dependent option.
1158 (The latter is "-D_REENTRANT" on various systems.) The default in this
1159 case, obviously, is not to include support for multi-threading (but
1160 you can still use "no-threads" to suppress an annoying warning message
1161 from the Configure script.)
1163 OpenSSL provides built-in support for two threading models: pthreads (found on
1164 most UNIX/Linux systems), and Windows threads. No other threading models are
1165 supported. If your platform does not provide pthreads or Windows threads then
1166 you should Configure with the "no-threads" option.
1168 Notes on shared libraries
1169 -------------------------
1171 For most systems the OpenSSL Configure script knows what is needed to
1172 build shared libraries for libcrypto and libssl. On these systems
1173 the shared libraries will be created by default. This can be suppressed and
1174 only static libraries created by using the "no-shared" option. On systems
1175 where OpenSSL does not know how to build shared libraries the "no-shared"
1176 option will be forced and only static libraries will be created.
1178 Shared libraries are named a little differently on different platforms.
1179 One way or another, they all have the major OpenSSL version number as
1180 part of the file name, i.e. for OpenSSL 1.1.x, 1.1 is somehow part of
1183 On most POSIX platforms, shared libraries are named libcrypto.so.1.1
1186 on Cygwin, shared libraries are named cygcrypto-1.1.dll and cygssl-1.1.dll
1187 with import libraries libcrypto.dll.a and libssl.dll.a.
1189 On Windows build with MSVC or using MingW, shared libraries are named
1190 libcrypto-1_1.dll and libssl-1_1.dll for 32-bit Windows, libcrypto-1_1-x64.dll
1191 and libssl-1_1-x64.dll for 64-bit x86_64 Windows, and libcrypto-1_1-ia64.dll
1192 and libssl-1_1-ia64.dll for IA64 Windows. With MSVC, the import libraries
1193 are named libcrypto.lib and libssl.lib, while with MingW, they are named
1194 libcrypto.dll.a and libssl.dll.a.
1196 On VMS, shareable images (VMS speak for shared libraries) are named
1197 ossl$libcrypto0101_shr.exe and ossl$libssl0101_shr.exe. However, when
1198 OpenSSL is specifically built for 32-bit pointers, the shareable images
1199 are named ossl$libcrypto0101_shr32.exe and ossl$libssl0101_shr32.exe
1200 instead, and when built for 64-bit pointers, they are named
1201 ossl$libcrypto0101_shr64.exe and ossl$libssl0101_shr64.exe.
1203 Note on random number generation
1204 --------------------------------
1206 Availability of cryptographically secure random numbers is required for
1207 secret key generation. OpenSSL provides several options to seed the
1208 internal CSPRNG. If not properly seeded, the internal CSPRNG will refuse
1209 to deliver random bytes and a "PRNG not seeded error" will occur.
1211 The seeding method can be configured using the --with-rand-seed option,
1212 which can be used to specify a comma separated list of seed methods.
1213 However in most cases OpenSSL will choose a suitable default method,
1214 so it is not necessary to explicitly provide this option. Note also
1215 that not all methods are available on all platforms.
1217 I) On operating systems which provide a suitable randomness source (in
1218 form of a system call or system device), OpenSSL will use the optimal
1219 available method to seed the CSPRNG from the operating system's
1220 randomness sources. This corresponds to the option --with-rand-seed=os.
1222 II) On systems without such a suitable randomness source, automatic seeding
1223 and reseeding is disabled (--with-rand-seed=none) and it may be necessary
1224 to install additional support software to obtain a random seed and reseed
1225 the CSPRNG manually. Please check out the manual pages for RAND_add(),
1226 RAND_bytes(), RAND_egd(), and the FAQ for more information.
projects / openssl.git / blob