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)> or equivalent system
229 devrandom: Use the the first device from the DEVRANDOM list
230 which can be opened to read random bytes. The
231 DEVRANDOM preprocessor constant expands to
232 "/dev/urandom","/dev/random","/dev/srandom" on
233 most unix-ish operating systems.
234 egd: Check for an entropy generating daemon.
235 rdcpu: Use the RDSEED or RDRAND command if provided by
237 librandom: Use librandom (not implemented yet).
238 none: Disable automatic seeding. This is the default
239 on some operating systems where no suitable
240 entropy source exists, or no support for it is
243 For more information, see the section 'Note on random number
244 generation' at the end of this document.
247 Don't build the AFALG engine. This option will be forced if
248 on a platform that does not support AFALG.
251 Build with the Address sanitiser. This is a developer option
252 only. It may not work on all platforms and should never be
253 used in production environments. It will only work when used
254 with gcc or clang and should be used in conjunction with the
258 Do not use assembler code. On some platforms a small amount
259 of assembler code may still be used.
262 Do not build support for async operations.
265 Don't automatically load all supported ciphers and digests.
266 Typically OpenSSL will make available all of its supported
267 ciphers and digests. For a statically linked application this
268 may be undesirable if small executable size is an objective.
269 This only affects libcrypto. Ciphers and digests will have to
270 be loaded manually using EVP_add_cipher() and
271 EVP_add_digest() if this option is used. This option will
272 force a non-shared build.
275 Don't automatically load all libcrypto/libssl error strings.
276 Typically OpenSSL will automatically load human readable
277 error strings. For a statically linked application this may
278 be undesirable if small executable size is an objective.
281 Don't automatically load the default openssl.cnf file.
282 Typically OpenSSL will automatically load a system config
283 file which configures default ssl options.
286 Don't build the CAPI engine. This option will be forced if
287 on a platform that does not support CAPI.
290 Don't build support for CMS features
293 Don't build support for SSL/TLS compression. If this option
294 is left enabled (the default), then compression will only
295 work if the zlib or zlib-dynamic options are also chosen.
298 Build support for debugging memory allocated via
299 OPENSSL_malloc() or OPENSSL_zalloc().
301 enable-crypto-mdebug-backtrace
302 As for crypto-mdebug, but additionally provide backtrace
303 information for allocated memory.
304 TO BE USED WITH CARE: this uses GNU C functionality, and
305 is therefore not usable for non-GNU config targets. If
306 your build complains about the use of '-rdynamic' or the
307 lack of header file execinfo.h, this option is not for you.
308 ALSO NOTE that even though execinfo.h is available on your
309 system (through Gnulib), the functions might just be stubs
313 Don't build support for Certificate Transparency.
316 Don't build with support for any deprecated APIs. This is the
317 same as using "--api" and supplying the latest version
321 Don't build support for datagram based BIOs. Selecting this
322 option will also force the disabling of DTLS.
325 Don't build support for loading Dynamic Shared Objects.
328 Don't build the dynamically loaded engines. This only has an
329 effect in a "shared" build
332 Don't build support for Elliptic Curves.
335 Don't build support for binary Elliptic Curves
337 enable-ec_nistp_64_gcc_128
338 Enable support for optimised implementations of some commonly
339 used NIST elliptic curves.
340 This is only supported on platforms:
341 - with little-endian storage of non-byte types
342 - that tolerate misaligned memory references
343 - where the compiler:
344 - supports the non-standard type __uint128_t
345 - defines the built-in macro __SIZEOF_INT128__
348 Build support for gathering entropy from EGD (Entropy
352 Don't build support for loading engines.
355 Don't compile in any error strings.
357 enable-external-tests
358 Enable building of integration with external test suites.
359 This is a developer option and may not work on all platforms.
360 The only supported external test suite at the current time is
361 the BoringSSL test suite. See the file test/README.external
365 Don't compile in filename and line number information (e.g.
366 for errors and memory allocation).
368 enable-fuzz-libfuzzer, enable-fuzz-afl
369 Build with support for fuzzing using either libfuzzer or AFL.
370 These are developer options only. They may not work on all
371 platforms and should never be used in production environments.
372 See the file fuzz/README.md for further details.
375 Don't build support for GOST based ciphersuites. Note that
376 if this feature is enabled then GOST ciphersuites are only
377 available if the GOST algorithms are also available through
378 loading an externally supplied engine.
381 Don't build the padlock engine.
384 Don't generate dependencies.
387 Don't build support for writing multiple records in one
388 go in libssl (Note: this is a different capability to the
389 pipelining functionality).
392 Don't build support for the NPN TLS extension.
395 Don't build support for OCSP.
398 Don't build with support for Position Independent Code.
401 Don't use POSIX IO capabilities.
404 Don't build support for Pre-Shared Key based ciphersuites.
407 Don't use hardware RDRAND capabilities.
410 Don't build support for RFC3779 ("X.509 Extensions for IP
411 Addresses and AS Identifiers")
414 Build support for SCTP
417 Do not create shared libraries, only static ones. See "Note
418 on shared libraries" below.
421 Don't build support for socket BIOs
424 Don't build support for SRP or SRP based ciphersuites.
427 Don't build SRTP support
430 Exclude SSE2 code paths from 32-bit x86 assembly modules.
431 Normally SSE2 extension is detected at run-time, but the
432 decision whether or not the machine code will be executed
433 is taken solely on CPU capability vector. This means that
434 if you happen to run OS kernel which does not support SSE2
435 extension on Intel P4 processor, then your application
436 might be exposed to "illegal instruction" exception.
437 There might be a way to enable support in kernel, e.g.
438 FreeBSD kernel can be compiled with CPU_ENABLE_SSE, and
439 there is a way to disengage SSE2 code paths upon application
440 start-up, but if you aim for wider "audience" running
441 such kernel, consider no-sse2. Both the 386 and
442 no-asm options imply no-sse2.
445 Build with the SSL Trace capabilities (adds the "-trace"
446 option to s_client and s_server).
449 Don't build the statically linked engines. This only
450 has an impact when not built "shared".
453 Don't use anything from the C header file "stdio.h" that
454 makes use of the "FILE" type. Only libcrypto and libssl can
455 be built in this way. Using this option will suppress
456 building the command line applications. Additionally since
457 the OpenSSL tests also use the command line applications the
458 tests will also be skipped.
461 Don't build test programs or run any test.
464 Don't try to build with support for multi-threaded
468 Build with support for multi-threaded applications. Most
469 platforms will enable this by default. However if on a
470 platform where this is not the case then this will usually
471 require additional system-dependent options! See "Note on
472 multi-threading" below.
474 enable-tls13downgrade
475 TODO(TLS1.3): Make this enabled by default and remove the
476 option when TLSv1.3 is out of draft
477 TLSv1.3 offers a downgrade protection mechanism. This is
478 implemented but disabled by default. It should not typically
479 be enabled except for testing purposes. Otherwise this could
480 cause problems if a pre-RFC version of OpenSSL talks to an
481 RFC implementation (it will erroneously be detected as a
485 Don't build Time Stamping Authority support.
488 Build with the Undefined Behaviour sanitiser. This is a
489 developer option only. It may not work on all platforms and
490 should never be used in production environments. It will only
491 work when used with gcc or clang and should be used in
492 conjunction with the "-DPEDANTIC" option (or the
493 --strict-warnings option).
496 Don't build with the "UI" capability (i.e. the set of
497 features enabling text based prompts).
500 Enable additional unit test APIs. This should not typically
501 be used in production deployments.
503 enable-weak-ssl-ciphers
504 Build support for SSL/TLS ciphers that are considered "weak"
505 (e.g. RC4 based ciphersuites).
508 Build with support for zlib compression/decompression.
511 Like "zlib", but has OpenSSL load the zlib library
512 dynamically when needed. This is only supported on systems
513 where loading of shared libraries is supported.
516 In 32-bit x86 builds, when generating assembly modules,
517 use the 80386 instruction set only (the default x86 code
518 is more efficient, but requires at least a 486). Note:
519 This doesn't affect code generated by compiler, you're
520 likely to complement configuration command line with
521 suitable compiler-specific option.
524 Don't build support for negotiating the specified SSL/TLS
525 protocol (one of ssl, ssl3, tls, tls1, tls1_1, tls1_2,
526 tls1_3, dtls, dtls1 or dtls1_2). If "no-tls" is selected then
527 all of tls1, tls1_1, tls1_2 and tls1_3 are disabled.
528 Similarly "no-dtls" will disable dtls1 and dtls1_2. The
529 "no-ssl" option is synonymous with "no-ssl3". Note this only
530 affects version negotiation. OpenSSL will still provide the
531 methods for applications to explicitly select the individual
535 As for no-<prot> but in addition do not build the methods for
536 applications to explicitly select individual protocol
537 versions. Note that there is no "no-tls1_3-method" option
538 because there is no application method for TLSv1.3. Using
539 individual protocol methods directly is deprecated.
540 Applications should use TLS_method() instead.
543 Build with support for the specified algorithm, where <alg>
544 is one of: md2 or rc5.
547 Build without support for the specified algorithm, where
548 <alg> is one of: aria, bf, blake2, camellia, cast, chacha,
549 cmac, des, dh, dsa, ecdh, ecdsa, idea, md4, mdc2, ocb,
550 poly1305, rc2, rc4, rmd160, scrypt, seed, siphash, sm3, sm4
551 or whirlpool. The "ripemd" algorithm is deprecated and if
552 used is synonymous with rmd160.
554 -Dxxx, -Ixxx, -Wp, -lxxx, -Lxxx, -Wl, -rpath, -R, -framework, -static
555 These system specific options will be recognised and
556 passed through to the compiler to allow you to define
557 preprocessor symbols, specify additional libraries, library
558 directories or other compiler options. It might be worth
559 noting that some compilers generate code specifically for
560 processor the compiler currently executes on. This is not
561 necessarily what you might have in mind, since it might be
562 unsuitable for execution on other, typically older,
563 processor. Consult your compiler documentation.
565 Take note of the VAR=value documentation below and how
566 these flags interact with those variables.
569 Additional options that are not otherwise recognised are
570 passed through as they are to the compiler as well. Again,
571 consult your compiler documentation.
573 Take note of the VAR=value documentation below and how
574 these flags interact with those variables.
577 Assignment of environment variable for Configure. These
578 work just like normal environment variable assignments,
579 but are supported on all platforms and are confined to
580 the configuration scripts only. These assignments override
581 the corresponding value in the inherited environment, if
584 The following variables are used as "make variables" and
585 can be used as an alternative to giving preprocessor,
586 compiler and linker options directly as configuration.
587 The following variables are supported:
589 AR The static library archiver.
590 ARFLAGS Flags for the static library archiver.
591 AS The assembler compiler.
592 ASFLAGS Flags for the assembler compiler.
594 CFLAGS Flags for the C compiler.
595 CXX The C++ compiler.
596 CXXFLAGS Flags for the C++ compiler.
597 CPP The C/C++ preprocessor.
598 CPPFLAGS Flags for the C/C++ preprocessor.
599 CPPDEFINES List of CPP macro definitions, separated
600 by a platform specific character (':' or
601 space for Unix, ';' for Windows, ',' for
602 VMS). This can be used instead of using
603 -D (or what corresponds to that on your
604 compiler) in CPPFLAGS.
605 CPPINCLUDES List of CPP inclusion directories, separated
606 the same way as for CPPDEFINES. This can
607 be used instead of -I (or what corresponds
608 to that on your compiler) in CPPFLAGS.
609 HASHBANGPERL Perl invocation to be inserted after '#!'
610 in public perl scripts (only relevant on
612 LD The program linker (not used on Unix, $(CC)
614 LDFLAGS Flags for the shared library, DSO and
616 LDLIBS Extra libraries to use when linking.
617 Takes the form of a space separated list
618 of library specifications on Unix and
619 Windows, and as a comma separated list of
621 RANLIB The library archive indexer.
622 RC The Windows resources manipulator.
623 RCFLAGS Flags for the Windows reources manipulator.
624 RM The command to remove files and directories.
626 These cannot be mixed with compiling / linking flags given
627 on the command line. In other words, something like this
630 ./config -DFOO CPPFLAGS=-DBAR -DCOOKIE
632 Backward compatibility note:
634 To be compatible with older configuration scripts, the
635 environment variables are ignored if compiling / linking
636 flags are given on the command line, except for these:
638 AR, CC, CXX, CROSS_COMPILE, HASHBANGPERL, PERL, RANLIB, RC
641 For example, the following command will not see -DBAR:
643 CPPFLAGS=-DBAR ./config -DCOOKIE
645 However, the following will see both set variables:
647 CC=gcc CROSS_COMPILE=x86_64-w64-mingw32- \
652 Reconfigure from earlier data. This fetches the previous
653 command line options and environment from data saved in
654 "configdata.pm", and runs the configuration process again,
655 using these options and environment.
656 Note: NO other option is permitted together with "reconf".
657 This means that you also MUST use "./Configure" (or
658 what corresponds to that on non-Unix platforms) directly
659 to invoke this option.
660 Note: The original configuration saves away values for ALL
661 environment variables that were used, and if they weren't
662 defined, they are still saved away with information that
663 they weren't originally defined. This information takes
664 precedence over environment variables that are defined
667 Displaying configuration data
668 -----------------------------
670 The configuration script itself will say very little, and finishes by
671 creating "configdata.pm". This perl module can be loaded by other scripts
672 to find all the configuration data, and it can also be used as a script to
673 display all sorts of configuration data in a human readable form.
675 For more information, please do:
677 $ ./configdata.pm --help # Unix
681 $ perl configdata.pm --help # Windows and VMS
683 Installation in Detail
684 ----------------------
686 1a. Configure OpenSSL for your operation system automatically:
688 NOTE: This is not available on Windows.
690 $ ./config [[ options ]] # Unix
694 $ @config [[ options ]] ! OpenVMS
696 For the remainder of this text, the Unix form will be used in all
697 examples, please use the appropriate form for your platform.
699 This guesses at your operating system (and compiler, if necessary) and
700 configures OpenSSL based on this guess. Run ./config -t to see
701 if it guessed correctly. If you want to use a different compiler, you
702 are cross-compiling for another platform, or the ./config guess was
703 wrong for other reasons, go to step 1b. Otherwise go to step 2.
705 On some systems, you can include debugging information as follows:
707 $ ./config -d [[ options ]]
709 1b. Configure OpenSSL for your operating system manually
711 OpenSSL knows about a range of different operating system, hardware and
712 compiler combinations. To see the ones it knows about, run
718 $ perl Configure # All other platforms
720 For the remainder of this text, the Unix form will be used in all
721 examples, please use the appropriate form for your platform.
723 Pick a suitable name from the list that matches your system. For most
724 operating systems there is a choice between using "cc" or "gcc". When
725 you have identified your system (and if necessary compiler) use this name
726 as the argument to Configure. For example, a "linux-elf" user would
729 $ ./Configure linux-elf [[ options ]]
731 If your system isn't listed, you will have to create a configuration
732 file named Configurations/{{ something }}.conf and add the correct
733 configuration for your system. See the available configs as examples
734 and read Configurations/README and Configurations/README.design for
737 The generic configurations "cc" or "gcc" should usually work on 32 bit
740 Configure creates a build file ("Makefile" on Unix, "makefile" on Windows
741 and "descrip.mms" on OpenVMS) from a suitable template in Configurations,
742 and defines various macros in include/openssl/opensslconf.h (generated from
743 include/openssl/opensslconf.h.in).
745 1c. Configure OpenSSL for building outside of the source tree.
747 OpenSSL can be configured to build in a build directory separate from
748 the directory with the source code. It's done by placing yourself in
749 some other directory and invoking the configuration commands from
754 $ mkdir /var/tmp/openssl-build
755 $ cd /var/tmp/openssl-build
756 $ /PATH/TO/OPENSSL/SOURCE/config [[ options ]]
760 $ /PATH/TO/OPENSSL/SOURCE/Configure {{ target }} [[ options ]]
764 $ set default sys$login:
765 $ create/dir [.tmp.openssl-build]
766 $ set default [.tmp.openssl-build]
767 $ @[PATH.TO.OPENSSL.SOURCE]config [[ options ]]
771 $ @[PATH.TO.OPENSSL.SOURCE]Configure {{ target }} [[ options ]]
776 $ mkdir \temp-openssl
778 $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure {{ target }} [[ options ]]
780 Paths can be relative just as well as absolute. Configure will
781 do its best to translate them to relative paths whenever possible.
783 2. Build OpenSSL by running:
786 $ mms ! (or mmk) OpenVMS
789 This will build the OpenSSL libraries (libcrypto.a and libssl.a on
790 Unix, corresponding on other platforms) and the OpenSSL binary
791 ("openssl"). The libraries will be built in the top-level directory,
792 and the binary will be in the "apps" subdirectory.
796 If the build fails, look at the output. There may be reasons
797 for the failure that aren't problems in OpenSSL itself (like
798 missing standard headers).
800 If the build succeeded previously, but fails after a source or
801 configuration change, it might be helpful to clean the build tree
802 before attempting another build. Use this command:
805 $ mms clean ! (or mmk) OpenVMS
806 $ nmake clean # Windows
808 Assembler error messages can sometimes be sidestepped by using the
809 "no-asm" configuration option.
811 Compiling parts of OpenSSL with gcc and others with the system
812 compiler will result in unresolved symbols on some systems.
814 If you are still having problems you can get help by sending an email
815 to the openssl-users email list (see
816 https://www.openssl.org/community/mailinglists.html for details). If
817 it is a bug with OpenSSL itself, please open an issue on GitHub, at
818 https://github.com/openssl/openssl/issues. Please review the existing
819 ones first; maybe the bug was already reported or has already been
822 3. After a successful build, the libraries should be tested. Run:
826 $ nmake test # Windows
828 NOTE: you MUST run the tests from an unprivileged account (or
829 disable your privileges temporarily if your platform allows it).
831 If some tests fail, look at the output. There may be reasons for
832 the failure that isn't a problem in OpenSSL itself (like a
833 malfunction with Perl). You may want increased verbosity, that
834 can be accomplished like this:
836 $ make VERBOSE=1 test # Unix
838 $ mms /macro=(VERBOSE=1) test ! OpenVMS
840 $ nmake VERBOSE=1 test # Windows
842 If you want to run just one or a few specific tests, you can use
843 the make variable TESTS to specify them, like this:
845 $ make TESTS='test_rsa test_dsa' test # Unix
846 $ mms/macro="TESTS=test_rsa test_dsa" test ! OpenVMS
847 $ nmake TESTS='test_rsa test_dsa' test # Windows
849 And of course, you can combine (Unix example shown):
851 $ make VERBOSE=1 TESTS='test_rsa test_dsa' test
853 You can find the list of available tests like this:
855 $ make list-tests # Unix
856 $ mms list-tests ! OpenVMS
857 $ nmake list-tests # Windows
859 Have a look at the manual for the perl module Test::Harness to
860 see what other HARNESS_* variables there are.
862 If you find a problem with OpenSSL itself, try removing any
863 compiler optimization flags from the CFLAGS line in Makefile and
864 run "make clean; make" or corresponding.
866 To report a bug please open an issue on GitHub, at
867 https://github.com/openssl/openssl/issues.
869 For more details on how the make variables TESTS can be used,
870 see section TESTS in Detail below.
872 4. If everything tests ok, install OpenSSL with
874 $ make install # Unix
875 $ mms install ! OpenVMS
876 $ nmake install # Windows
878 This will install all the software components in this directory
879 tree under PREFIX (the directory given with --prefix or its
884 bin/ Contains the openssl binary and a few other
887 Contains the header files needed if you want
888 to build your own programs that use libcrypto
890 lib Contains the OpenSSL library files.
891 lib/engines Contains the OpenSSL dynamically loadable engines.
893 share/man/man1 Contains the OpenSSL command line man-pages.
894 share/man/man3 Contains the OpenSSL library calls man-pages.
895 share/man/man5 Contains the OpenSSL configuration format man-pages.
896 share/man/man7 Contains the OpenSSL other misc man-pages.
898 share/doc/openssl/html/man1
899 share/doc/openssl/html/man3
900 share/doc/openssl/html/man5
901 share/doc/openssl/html/man7
902 Contains the HTML rendition of the man-pages.
904 OpenVMS ('arch' is replaced with the architecture name, "Alpha"
905 or "ia64", 'sover' is replaced with the shared library version
906 (0101 for 1.1), and 'pz' is replaced with the pointer size
907 OpenSSL was built with):
909 [.EXE.'arch'] Contains the openssl binary.
910 [.EXE] Contains a few utility scripts.
912 Contains the header files needed if you want
913 to build your own programs that use libcrypto
915 [.LIB.'arch'] Contains the OpenSSL library files.
916 [.ENGINES'sover''pz'.'arch']
917 Contains the OpenSSL dynamically loadable engines.
918 [.SYS$STARTUP] Contains startup, login and shutdown scripts.
919 These define appropriate logical names and
921 [.SYSTEST] Contains the installation verification procedure.
922 [.HTML] Contains the HTML rendition of the manual pages.
925 Additionally, install will add the following directories under
926 OPENSSLDIR (the directory given with --openssldir or its default)
929 certs Initially empty, this is the default location
930 for certificate files.
931 private Initially empty, this is the default location
932 for private key files.
933 misc Various scripts.
935 Package builders who want to configure the library for standard
936 locations, but have the package installed somewhere else so that
937 it can easily be packaged, can use
939 $ make DESTDIR=/tmp/package-root install # Unix
940 $ mms/macro="DESTDIR=TMP:[PACKAGE-ROOT]" install ! OpenVMS
942 The specified destination directory will be prepended to all
943 installation target paths.
945 Compatibility issues with previous OpenSSL versions:
947 * COMPILING existing applications
949 OpenSSL 1.1.0 hides a number of structures that were previously
950 open. This includes all internal libssl structures and a number
951 of EVP types. Accessor functions have been added to allow
952 controlled access to the structures' data.
954 This means that some software needs to be rewritten to adapt to
955 the new ways of doing things. This often amounts to allocating
956 an instance of a structure explicitly where you could previously
957 allocate them on the stack as automatic variables, and using the
958 provided accessor functions where you would previously access a
959 structure's field directly.
961 Some APIs have changed as well. However, older APIs have been
962 preserved when possible.
964 Environment Variables
965 ---------------------
967 A number of environment variables can be used to provide additional control
968 over the build process. Typically these should be defined prior to running
969 config or Configure. Not all environment variables are relevant to all
973 The name of the ar executable to use.
976 Use a different build file name than the platform default
977 ("Makefile" on Unixly platforms, "makefile" on native Windows,
978 "descrip.mms" on OpenVMS). This requires that there is a
979 corresponding build file template. See Configurations/README
980 for further information.
983 The compiler to use. Configure will attempt to pick a default
984 compiler for your platform but this choice can be overridden
985 using this variable. Set it to the compiler executable you wish
986 to use, e.g. "gcc" or "clang".
989 This environment variable has the same meaning as for the
990 "--cross-compile-prefix" Configure flag described above. If both
991 are set then the Configure flag takes precedence.
994 The name of the nm executable to use.
996 OPENSSL_LOCAL_CONFIG_DIR
997 OpenSSL comes with a database of information about how it
998 should be built on different platforms as well as build file
999 templates for those platforms. The database is comprised of
1000 ".conf" files in the Configurations directory. The build
1001 file templates reside there as well as ".tmpl" files. See the
1002 file Configurations/README for further information about the
1003 format of ".conf" files as well as information on the ".tmpl"
1005 In addition to the standard ".conf" and ".tmpl" files, it is
1006 possible to create your own ".conf" and ".tmpl" files and store
1007 them locally, outside the OpenSSL source tree. This environment
1008 variable can be set to the directory where these files are held
1009 and will be considered by Configure before it looks in the
1010 standard directories.
1013 The name of the Perl executable to use when building OpenSSL.
1014 This variable is used in config script only. Configure on the
1015 other hand imposes the interpreter by which it itself was
1016 executed on the whole build procedure.
1019 The command string for the Perl executable to insert in the
1020 #! line of perl scripts that will be publically installed.
1021 Default: /usr/bin/env perl
1022 Note: the value of this variable is added to the same scripts
1023 on all platforms, but it's only relevant on Unix-like platforms.
1026 The name of the rc executable to use. The default will be as
1027 defined for the target platform in the ".conf" file. If not
1028 defined then "windres" will be used. The WINDRES environment
1029 variable is synonymous to this. If both are defined then RC
1033 The name of the ranlib executable to use.
1041 The Configure script generates a Makefile in a format relevant to the specific
1042 platform. The Makefiles provide a number of targets that can be used. Not all
1043 targets may be available on all platforms. Only the most common targets are
1044 described here. Examine the Makefiles themselves for the full list.
1047 The default target to build all the software components.
1050 Remove all build artefacts and return the directory to a "clean"
1054 Rebuild the dependencies in the Makefiles. This is a legacy
1055 option that no longer needs to be used in OpenSSL 1.1.0.
1058 Install all OpenSSL components.
1061 Only install the OpenSSL software components.
1064 Only install the OpenSSL documentation components.
1067 Only install the OpenSSL man pages (Unix only).
1070 Only install the OpenSSL html documentation.
1073 Prints a list of all the self test names.
1076 Build and run the OpenSSL self tests.
1079 Uninstall all OpenSSL components.
1083 Re-run the configuration process, as exactly as the last time
1087 This is a developer option. If you are developing a patch for
1088 OpenSSL you may need to use this if you want to update
1089 automatically generated files; add new error codes or add new
1090 (or change the visibility of) public API functions. (Unix only).
1095 The make variable TESTS supports a versatile set of space separated tokens
1096 with which you can specify a set of tests to be performed. With a "current
1097 set of tests" in mind, initially being empty, here are the possible tokens:
1099 alltests The current set of tests becomes the whole set of available
1100 tests (as listed when you do 'make list-tests' or similar).
1101 xxx Adds the test 'xxx' to the current set of tests.
1102 -xxx Removes 'xxx' from the current set of tests. If this is the
1103 first token in the list, the current set of tests is first
1104 assigned the whole set of available tests, effectively making
1105 this token equivalent to TESTS="alltests -xxx".
1106 nn Adds the test group 'nn' (which is a number) to the current
1108 -nn Removes the test group 'nn' from the current set of tests.
1109 If this is the first token in the list, the current set of
1110 tests is first assigned the whole set of available tests,
1111 effectively making this token equivalent to
1112 TESTS="alltests -xxx".
1114 Also, all tokens except for "alltests" may have wildcards, such as *.
1115 (on Unix and Windows, BSD style wildcards are supported, while on VMS,
1116 it's VMS style wildcards)
1118 Example: All tests except for the fuzz tests:
1120 $ make TESTS=-test_fuzz test
1122 or (if you want to be explicit)
1124 $ make TESTS='alltests -test_fuzz' test
1126 Example: All tests that have a name starting with "test_ssl" but not those
1127 starting with "test_ssl_":
1129 $ make TESTS='test_ssl* -test_ssl_*' test
1131 Example: Only test group 10:
1135 Example: All tests except the slow group (group 99):
1139 Example: All tests in test groups 80 to 99 except for tests in group 90:
1141 $ make TESTS='[89]? -90'
1143 Note on multi-threading
1144 -----------------------
1146 For some systems, the OpenSSL Configure script knows what compiler options
1147 are needed to generate a library that is suitable for multi-threaded
1148 applications. On these systems, support for multi-threading is enabled
1149 by default; use the "no-threads" option to disable (this should never be
1152 On other systems, to enable support for multi-threading, you will have
1153 to specify at least two options: "threads", and a system-dependent option.
1154 (The latter is "-D_REENTRANT" on various systems.) The default in this
1155 case, obviously, is not to include support for multi-threading (but
1156 you can still use "no-threads" to suppress an annoying warning message
1157 from the Configure script.)
1159 OpenSSL provides built-in support for two threading models: pthreads (found on
1160 most UNIX/Linux systems), and Windows threads. No other threading models are
1161 supported. If your platform does not provide pthreads or Windows threads then
1162 you should Configure with the "no-threads" option.
1164 Notes on shared libraries
1165 -------------------------
1167 For most systems the OpenSSL Configure script knows what is needed to
1168 build shared libraries for libcrypto and libssl. On these systems
1169 the shared libraries will be created by default. This can be suppressed and
1170 only static libraries created by using the "no-shared" option. On systems
1171 where OpenSSL does not know how to build shared libraries the "no-shared"
1172 option will be forced and only static libraries will be created.
1174 Shared libraries are named a little differently on different platforms.
1175 One way or another, they all have the major OpenSSL version number as
1176 part of the file name, i.e. for OpenSSL 1.1.x, 1.1 is somehow part of
1179 On most POSIXly platforms, shared libraries are named libcrypto.so.1.1
1182 on Cygwin, shared libraries are named cygcrypto-1.1.dll and cygssl-1.1.dll
1183 with import libraries libcrypto.dll.a and libssl.dll.a.
1185 On Windows build with MSVC or using MingW, shared libraries are named
1186 libcrypto-1_1.dll and libssl-1_1.dll for 32-bit Windows, libcrypto-1_1-x64.dll
1187 and libssl-1_1-x64.dll for 64-bit x86_64 Windows, and libcrypto-1_1-ia64.dll
1188 and libssl-1_1-ia64.dll for IA64 Windows. With MSVC, the import libraries
1189 are named libcrypto.lib and libssl.lib, while with MingW, they are named
1190 libcrypto.dll.a and libssl.dll.a.
1192 On VMS, shareable images (VMS speak for shared libraries) are named
1193 ossl$libcrypto0101_shr.exe and ossl$libssl0101_shr.exe. However, when
1194 OpenSSL is specifically built for 32-bit pointers, the shareable images
1195 are named ossl$libcrypto0101_shr32.exe and ossl$libssl0101_shr32.exe
1196 instead, and when built for 64-bit pointers, they are named
1197 ossl$libcrypto0101_shr64.exe and ossl$libssl0101_shr64.exe.
1199 Note on random number generation
1200 --------------------------------
1202 Availability of cryptographically secure random numbers is required for
1203 secret key generation. OpenSSL provides several options to seed the
1204 internal CSPRNG. If not properly seeded, the internal CSPRNG will refuse
1205 to deliver random bytes and a "PRNG not seeded error" will occur.
1207 The seeding method can be configured using the --with-rand-seed option,
1208 which can be used to specify a comma separated list of seed methods.
1209 However in most cases OpenSSL will choose a suitable default method,
1210 so it is not necessary to explicitely provide this option. Note also
1211 that not all methods are available on all platforms.
1213 I) On operating systems which provide a suitable randomness source (in
1214 form of a system call or system device), OpenSSL will use the optimal
1215 available method to seed the CSPRNG from the operating system's
1216 randomness sources. This corresponds to the option --with-rand-seed=os.
1218 II) On systems without such a suitable randomness source, automatic seeding
1219 and reseeding is disabled (--with-rand-seed=none) and it may be necessary
1220 to install additional support software to obtain a random seed and reseed
1221 the CSPRNG manually. Please check out the manual pages for RAND_add(),
1222 RAND_bytes(), RAND_egd(), and the FAQ for more information.
projects / thirdparty / openssl.git / blob