5 This document describes installation on all supported operating
6 systems (the Linux/Unix family, OpenVMS and Windows)
8 To install OpenSSL, you will need:
10 * A make implementation
11 * Perl 5 with core modules (please read NOTES.PERL)
12 * The perl module Text::Template (please read NOTES.PERL)
14 * a development environment in the form of development libraries and C
16 * a supported operating system
18 For additional platform specific requirements, solutions to specific
19 issues and other details, please read one of these:
21 * NOTES.UNIX (any supported Unix like system)
23 * NOTES.WIN (any supported Windows)
24 * NOTES.DJGPP (DOS platform with DJGPP)
26 Notational conventions in this document
27 ---------------------------------------
29 Throughout this document, we use the following conventions in command
32 $ command Any line starting with a dollar sign
33 ($) is a command line.
35 { word1 | word2 | word3 } This denotes a mandatory choice, to be
36 replaced with one of the given words.
37 A simple example would be this:
39 $ echo { FOO | BAR | COOKIE }
41 which is to be understood as one of
50 [ word1 | word2 | word3 ] Similar to { word1 | word2 | word3 }
51 except it's optional to give any of
52 those. In addition to the examples
53 above, this would also be valid:
57 {{ target }} This denotes a mandatory word or
58 sequence of words of some sort. A
59 simple example would be this:
63 which is to be understood to use the
64 command 'type' on some file name
65 determined by the user.
67 [[ options ]] Similar to {{ target }}, but is
70 Note that the notation assumes spaces around {, }, [, ], {{, }} and
71 [[, ]]. This is to differentiate from OpenVMS directory
72 specifications, which also use [ and ], but without spaces.
77 If you want to just get on with it, do:
93 on Windows (only pick one of the targets for configuration):
95 $ perl Configure { VC-WIN32 | VC-WIN64A | VC-WIN64I | VC-CE }
100 If any of these steps fails, see section Installation in Detail below.
102 This will build and install OpenSSL in the default location, which is:
104 Unix: normal installation directories under /usr/local
105 OpenVMS: SYS$COMMON:[OPENSSL-'version'...], where 'version' is the
106 OpenSSL version number with underscores instead of periods.
107 Windows: C:\Program Files\OpenSSL or C:\Program Files (x86)\OpenSSL
109 If you want to install it anywhere else, run config like this:
113 $ ./config --prefix=/opt/openssl --openssldir=/usr/local/ssl
117 $ @config --prefix=PROGRAM:[INSTALLS] --openssldir=SYS$MANAGER:[OPENSSL]
119 (Note: if you do add options to the configuration command, please make sure
120 you've read more than just this Quick Start, such as relevant NOTES.* files,
121 the options outline below, as configuration options may change the outcome
122 in otherwise unexpected ways)
125 Configuration Options
126 ---------------------
128 There are several options to ./config (or ./Configure) to customize
129 the build (note that for Windows, the defaults for --prefix and
130 --openssldir depend in what configuration is used and what Windows
131 implementation OpenSSL is built on. More notes on this in NOTES.WIN):
134 Don't build with support for deprecated APIs below the
135 specified version number. For example "--api=1.1.0" will
136 remove support for all APIS that were deprecated in OpenSSL
137 version 1.1.0 or below.
139 --cross-compile-prefix=PREFIX
140 The PREFIX to include in front of commands for your
141 toolchain. It's likely to have to end with dash, e.g.
142 a-b-c- would invoke GNU compiler as a-b-c-gcc, etc.
143 Unfortunately cross-compiling is too case-specific to
144 put together one-size-fits-all instructions. You might
145 have to pass more flags or set up environment variables
146 to actually make it work. Android and iOS cases are
147 discussed in corresponding Configurations/10-main.cf
148 sections. But there are cases when this option alone is
149 sufficient. For example to build the mingw64 target on
150 Linux "--cross-compile-prefix=x86_64-w64-mingw32-"
151 works. Naturally provided that mingw packages are
152 installed. Today Debian and Ubuntu users have option to
153 install a number of prepackaged cross-compilers along
154 with corresponding run-time and development packages for
155 "alien" hardware. To give another example
156 "--cross-compile-prefix=mipsel-linux-gnu-" suffices
157 in such case. Needless to mention that you have to
158 invoke ./Configure, not ./config, and pass your target
162 Build OpenSSL with debugging symbols.
165 The name of the directory under the top of the installation
166 directory tree (see the --prefix option) where libraries will
167 be installed. By default this is "lib". Note that on Windows
168 only ".lib" files will be stored in this location. dll files
169 will always be installed to the "bin" directory.
172 Directory for OpenSSL configuration files, and also the
173 default certificate and key store. Defaults are:
176 Windows: C:\Program Files\Common Files\SSL
177 or C:\Program Files (x86)\Common Files\SSL
178 OpenVMS: SYS$COMMON:[OPENSSL-COMMON]
181 The top of the installation directory tree. Defaults are:
184 Windows: C:\Program Files\OpenSSL
185 or C:\Program Files (x86)\OpenSSL
186 OpenVMS: SYS$COMMON:[OPENSSL-'version']
189 Build OpenSSL without debugging symbols. This is the default.
192 This is a developer flag that switches on various compiler
193 options recommended for OpenSSL development. It only works
194 when using gcc or clang as the compiler. If you are
195 developing a patch for OpenSSL then it is recommended that
196 you use this option where possible.
198 --with-zlib-include=DIR
199 The directory for the location of the zlib include file. This
200 option is only necessary if enable-zlib (see below) is used
201 and the include file is not already on the system include
205 On Unix: this is the directory containing the zlib library.
206 If not provided the system library path will be used.
207 On Windows: this is the filename of the zlib library (with or
208 without a path). This flag must be provided if the
209 zlib-dynamic option is not also used. If zlib-dynamic is used
210 then this flag is optional and a default value ("ZLIB1") is
211 used if not provided.
212 On VMS: this is the filename of the zlib library (with or
213 without a path). This flag is optional and if not provided
214 then "GNV$LIBZSHR", "GNV$LIBZSHR32" or "GNV$LIBZSHR64" is
215 used by default depending on the pointer size chosen.
218 Don't build the AFALG engine. This option will be forced if
219 on a platform that does not support AFALG.
222 Build with the Address sanitiser. This is a developer option
223 only. It may not work on all platforms and should never be
224 used in production environments. It will only work when used
225 with gcc or clang and should be used in conjunction with the
229 Do not use assembler code. On some platforms a small amount
230 of assembler code may still be used.
233 Do not build support for async operations.
236 Don't automatically load all supported ciphers and digests.
237 Typically OpenSSL will make available all of its supported
238 ciphers and digests. For a statically linked application this
239 may be undesirable if small executable size is an objective.
240 This only affects libcrypto. Ciphers and digests will have to
241 be loaded manually using EVP_add_cipher() and
242 EVP_add_digest() if this option is used. This option will
243 force a non-shared build.
246 Don't automatically load all libcrypto/libssl error strings.
247 Typically OpenSSL will automatically load human readable
248 error strings. For a statically linked application this may
249 be undesirable if small executable size is an objective.
253 Don't build the CAPI engine. This option will be forced if
254 on a platform that does not support CAPI.
257 Don't build support for CMS features
260 Don't build support for SSL/TLS compression. If this option
261 is left enabled (the default), then compression will only
262 work if the zlib or zlib-dynamic options are also chosen.
265 Build support for debugging memory allocated via
266 OPENSSL_malloc() or OPENSSL_zalloc().
268 enable-crypto-mdebug-backtrace
269 As for crypto-mdebug, but additionally provide backtrace
270 information for allocated memory.
271 TO BE USED WITH CARE: this uses GNU C functionality, and
272 is therefore not usable for non-GNU config targets. If
273 your build complains about the use of '-rdynamic' or the
274 lack of header file execinfo.h, this option is not for you.
275 ALSO NOTE that even though execinfo.h is available on your
276 system (through Gnulib), the functions might just be stubs
280 Don't build support for Certificate Transparency.
283 Don't build with support for any deprecated APIs. This is the
284 same as using "--api" and supplying the latest version
288 Don't build support for datagram based BIOs. Selecting this
289 option will also force the disabling of DTLS.
292 Don't build support for loading Dynamic Shared Objects.
295 Don't build the dynamically loaded engines. This only has an
296 effect in a "shared" build
299 Don't build support for Elliptic Curves.
302 Don't build support for binary Elliptic Curves
304 enable-ec_nistp_64_gcc_128
305 Enable support for optimised implementations of some commonly
306 used NIST elliptic curves. This is only supported on some
310 Build support for gathering entropy from EGD (Entropy
314 Don't build support for loading engines.
317 Don't compile in any error strings.
319 enable-external-tests
320 Enable building of integration with external test suites.
321 This is a developer option and may not work on all platforms.
322 The only supported external test suite at the current time is
323 the BoringSSL test suite. See the file test/README.external
327 Don't compile in filename and line number information (e.g.
328 for errors and memory allocation).
330 enable-fuzz-libfuzzer, enable-fuzz-afl
331 Build with support for fuzzing using either libfuzzer or AFL.
332 These are developer options only. They may not work on all
333 platforms and should never be used in production environments.
334 See the file fuzz/README.md for further details.
337 Don't build support for GOST based ciphersuites. Note that
338 if this feature is enabled then GOST ciphersuites are only
339 available if the GOST algorithms are also available through
340 loading an externally supplied engine.
343 Don't build the padlock engine.
346 Don't generate dependencies.
349 Don't build support for writing multiple records in one
350 go in libssl (Note: this is a different capability to the
351 pipelining functionality).
354 Don't build support for the NPN TLS extension.
357 Don't build support for OCSP.
360 Don't build with support for Position Independent Code.
363 Don't use POSIX IO capabilities.
366 Don't build support for Pre-Shared Key based ciphersuites.
369 Don't use hardware RDRAND capabilities.
372 Don't build support for RFC3779 ("X.509 Extensions for IP
373 Addresses and AS Identifiers")
376 Build support for SCTP
379 Do not create shared libraries, only static ones. See "Note
380 on shared libraries" below.
383 Don't build support for socket BIOs
386 Don't build support for SRP or SRP based ciphersuites.
389 Don't build SRTP support
392 Exclude SSE2 code paths from 32-bit x86 assembly modules.
393 Normally SSE2 extension is detected at run-time, but the
394 decision whether or not the machine code will be executed
395 is taken solely on CPU capability vector. This means that
396 if you happen to run OS kernel which does not support SSE2
397 extension on Intel P4 processor, then your application
398 might be exposed to "illegal instruction" exception.
399 There might be a way to enable support in kernel, e.g.
400 FreeBSD kernel can be compiled with CPU_ENABLE_SSE, and
401 there is a way to disengage SSE2 code paths upon application
402 start-up, but if you aim for wider "audience" running
403 such kernel, consider no-sse2. Both the 386 and
404 no-asm options imply no-sse2.
407 Build with the SSL Trace capabilities (adds the "-trace"
408 option to s_client and s_server).
411 Don't build the statically linked engines. This only
412 has an impact when not built "shared".
415 Don't use anything from the C header file "stdio.h" that
416 makes use of the "FILE" type. Only libcrypto and libssl can
417 be built in this way. Using this option will suppress
418 building the command line applications. Additionally since
419 the OpenSSL tests also use the command line applications the
420 tests will also be skipped.
423 Don't build test programs or run any test.
426 Don't try to build with support for multi-threaded
430 Build with support for multi-threaded applications. Most
431 platforms will enable this by default. However if on a
432 platform where this is not the case then this will usually
433 require additional system-dependent options! See "Note on
434 multi-threading" below.
436 enable-tls13downgrade
437 TODO(TLS1.3): Make this enabled by default and remove the
438 option when TLSv1.3 is out of draft
439 TLSv1.3 offers a downgrade protection mechanism. This is
440 implemented but disabled by default. It should not typically
441 be enabled except for testing purposes. Otherwise this could
442 cause problems if a pre-RFC version of OpenSSL talks to an
443 RFC implementation (it will erroneously be detected as a
447 Don't build Time Stamping Authority support.
450 Build with the Undefined Behaviour sanitiser. This is a
451 developer option only. It may not work on all platforms and
452 should never be used in production environments. It will only
453 work when used with gcc or clang and should be used in
454 conjunction with the "-DPEDANTIC" option (or the
455 --strict-warnings option).
458 Don't build with the "UI" capability (i.e. the set of
459 features enabling text based prompts).
462 Enable additional unit test APIs. This should not typically
463 be used in production deployments.
465 enable-weak-ssl-ciphers
466 Build support for SSL/TLS ciphers that are considered "weak"
467 (e.g. RC4 based ciphersuites).
470 Build with support for zlib compression/decompression.
473 Like "zlib", but has OpenSSL load the zlib library
474 dynamically when needed. This is only supported on systems
475 where loading of shared libraries is supported.
478 In 32-bit x86 builds, when generating assembly modules,
479 use the 80386 instruction set only (the default x86 code
480 is more efficient, but requires at least a 486). Note:
481 This doesn't affect code generated by compiler, you're
482 likely to complement configuration command line with
483 suitable compiler-specific option.
486 TODO(TLS1.3): Make this enabled by default
487 Build support for TLS1.3. Note: This is a WIP feature and
488 only a single draft version is supported. Implementations
489 of different draft versions will negotiate TLS 1.2 instead
490 of (draft) TLS 1.3. Use with caution!!
493 Don't build support for negotiating the specified SSL/TLS
494 protocol (one of ssl, ssl3, tls, tls1, tls1_1, tls1_2, dtls,
495 dtls1 or dtls1_2). If "no-tls" is selected then all of tls1,
496 tls1_1 and tls1_2 are disabled. Similarly "no-dtls" will
497 disable dtls1 and dtls1_2. The "no-ssl" option is synonymous
498 with "no-ssl3". Note this only affects version negotiation.
499 OpenSSL will still provide the methods for applications to
500 explicitly select the individual protocol versions.
503 As for no-<prot> but in addition do not build the methods for
504 applications to explicitly select individual protocol
508 Build with support for the specified algorithm, where <alg>
509 is one of: md2 or rc5.
512 Build without support for the specified algorithm, where
513 <alg> is one of: aria, bf, blake2, camellia, cast, chacha,
514 cmac, des, dh, dsa, ecdh, ecdsa, idea, md4, mdc2, ocb,
515 poly1305, rc2, rc4, rmd160, scrypt, seed, siphash, sm3, sm4
516 or whirlpool. The "ripemd" algorithm is deprecated and if
517 used is synonymous with rmd160.
519 -Dxxx, -Ixxx, -Wp, -lxxx, -Lxxx, -Wl, -rpath, -R, -framework, -static
520 These system specific options will be recognised and
521 passed through to the compiler to allow you to define
522 preprocessor symbols, specify additional libraries, library
523 directories or other compiler options. It might be worth
524 noting that some compilers generate code specifically for
525 processor the compiler currently executes on. This is not
526 necessarily what you might have in mind, since it might be
527 unsuitable for execution on other, typically older,
528 processor. Consult your compiler documentation.
530 Take note of the VAR=value documentation below and how
531 these flags interact with those variables.
534 Additional options that are not otherwise recognised are
535 passed through as they are to the compiler as well. Again,
536 consult your compiler documentation.
538 Take note of the VAR=value documentation below and how
539 these flags interact with those variables.
542 Assignment if environment variable for Configure. These
543 work just like normal environment variable assignments,
544 but are supported on all platforms and are confined to
545 the configuration scripts only. These assignments override
546 the corresponding value in the inherited environment, if
549 The following variables are used as "make variables" and
550 can be used as an alternative to giving preprocessor,
551 compiler and linker options directly as configuration.
552 The following variables are supported:
554 AR The static library archiver.
555 ARFLAGS Flags for the static library archiver.
556 AS The assembler compiler.
557 ASFLAGS Flags for the assembler compiler.
559 CFLAGS Flags for the C compiler.
560 CXX The C++ compiler.
561 CXXFLAGS Flags for the C++ compiler.
562 CPP The C/C++ preprocessor.
563 CPPFLAGS Flags for the C/C++ preprocessor.
564 CPPDEFINES List of CPP macro definitions, separated
565 by a platform specific character (':' or
566 space for Unix, ';' for Windows, ',' for
567 VMS). This can be used in place of -D.
568 CPPINCLUDES List of CPP inclusion directories, separated
569 the same way as for CPPDEFINES. This can
570 be used in place of -I.
571 HASHBANGPERL Perl invocation to be inserted after '#!'
572 in public perl scripts.
573 LD The program linker (not used on Unix, $(CC)
575 LDFLAGS Flags for the shared library, DSO and
577 LDLIBS Extra libraries to use when linking.
578 Takes the form of a space separated list
579 of library specifications on Unix and
580 Windows, and as a comma separated list of
582 RANLIB The library archive indexer.
583 RC The Windows resources manipulator.
584 RCFLAGS Flags for the Windows reources manipulator.
585 RM The command to remove files and directories.
587 These can be mixed with flags given on the command line.
588 Any variable assignment resets any corresponding flags
589 given before it, so for example:
591 ./config -DFOO CPPFLAGS=-DBAR -DCOOKIE
593 Will end up having 'CPPFLAGS=-DBAR -DCOOKIE'.
595 Here is how the flags documented above are collected as
596 augmentation of these variables:
598 -Dxxx xxx is collected in CPPDEFINES
599 -Ixxx xxx is collected in CPPINCLUDES
600 -Wp,xxx collected in CPPFLAGS
601 -Lxxx collected in LDFLAGS
602 -lxxx collected in LDLIBS
603 -Wp,xxx collected in LDLIBS
604 -rpath xxx collected in LDLIBS
605 -R xxx collected in LDLIBS
606 -framework xxx collected in LDLIBS
607 -static collected in LDLIBS
608 -xxx collected in CFLAGS
609 +xxx collected in CFLAGS
613 Reconfigure from earlier data. This fetches the previous
614 command line options and environment from data saved in
615 "configdata.pm", and runs the configuration process again,
616 using these options and environment.
617 Note: NO other option is permitted together with "reconf".
618 This means that you also MUST use "./Configure" (or
619 what corresponds to that on non-Unix platforms) directly
620 to invoke this option.
621 Note: The original configuration saves away values for ALL
622 environment variables that were used, and if they weren't
623 defined, they are still saved away with information that
624 they weren't originally defined. This information takes
625 precedence over environment variables that are defined
628 Displaying configuration data
629 -----------------------------
631 The configuration script itself will say very little, and finishes by
632 creating "configdata.pm". This perl module can be loaded by other scripts
633 to find all the configuration data, and it can also be used as a script to
634 display all sorts of configuration data in a human readable form.
636 For more information, please do:
638 $ ./configdata.pm --help # Unix
642 $ perl configdata.pm --help # Windows and VMS
644 Installation in Detail
645 ----------------------
647 1a. Configure OpenSSL for your operation system automatically:
649 NOTE: This is not available on Windows.
651 $ ./config [[ options ]] # Unix
655 $ @config [[ options ]] ! OpenVMS
657 For the remainder of this text, the Unix form will be used in all
658 examples, please use the appropriate form for your platform.
660 This guesses at your operating system (and compiler, if necessary) and
661 configures OpenSSL based on this guess. Run ./config -t to see
662 if it guessed correctly. If you want to use a different compiler, you
663 are cross-compiling for another platform, or the ./config guess was
664 wrong for other reasons, go to step 1b. Otherwise go to step 2.
666 On some systems, you can include debugging information as follows:
668 $ ./config -d [[ options ]]
670 1b. Configure OpenSSL for your operating system manually
672 OpenSSL knows about a range of different operating system, hardware and
673 compiler combinations. To see the ones it knows about, run
679 $ perl Configure # All other platforms
681 For the remainder of this text, the Unix form will be used in all
682 examples, please use the appropriate form for your platform.
684 Pick a suitable name from the list that matches your system. For most
685 operating systems there is a choice between using "cc" or "gcc". When
686 you have identified your system (and if necessary compiler) use this name
687 as the argument to Configure. For example, a "linux-elf" user would
690 $ ./Configure linux-elf [[ options ]]
692 If your system isn't listed, you will have to create a configuration
693 file named Configurations/{{ something }}.conf and add the correct
694 configuration for your system. See the available configs as examples
695 and read Configurations/README and Configurations/README.design for
698 The generic configurations "cc" or "gcc" should usually work on 32 bit
701 Configure creates a build file ("Makefile" on Unix, "makefile" on Windows
702 and "descrip.mms" on OpenVMS) from a suitable template in Configurations,
703 and defines various macros in include/openssl/opensslconf.h (generated from
704 include/openssl/opensslconf.h.in).
706 1c. Configure OpenSSL for building outside of the source tree.
708 OpenSSL can be configured to build in a build directory separate from
709 the directory with the source code. It's done by placing yourself in
710 some other directory and invoking the configuration commands from
715 $ mkdir /var/tmp/openssl-build
716 $ cd /var/tmp/openssl-build
717 $ /PATH/TO/OPENSSL/SOURCE/config [[ options ]]
721 $ /PATH/TO/OPENSSL/SOURCE/Configure {{ target }} [[ options ]]
725 $ set default sys$login:
726 $ create/dir [.tmp.openssl-build]
727 $ set default [.tmp.openssl-build]
728 $ @[PATH.TO.OPENSSL.SOURCE]config [[ options ]]
732 $ @[PATH.TO.OPENSSL.SOURCE]Configure {{ target }} [[ options ]]
737 $ mkdir \temp-openssl
739 $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure {{ target }} [[ options ]]
741 Paths can be relative just as well as absolute. Configure will
742 do its best to translate them to relative paths whenever possible.
744 2. Build OpenSSL by running:
747 $ mms ! (or mmk) OpenVMS
750 This will build the OpenSSL libraries (libcrypto.a and libssl.a on
751 Unix, corresponding on other platforms) and the OpenSSL binary
752 ("openssl"). The libraries will be built in the top-level directory,
753 and the binary will be in the "apps" subdirectory.
757 If the build fails, look at the output. There may be reasons
758 for the failure that aren't problems in OpenSSL itself (like
759 missing standard headers).
761 If the build succeeded previously, but fails after a source or
762 configuration change, it might be helpful to clean the build tree
763 before attempting another build. Use this command:
766 $ mms clean ! (or mmk) OpenVMS
767 $ nmake clean # Windows
769 Assembler error messages can sometimes be sidestepped by using the
770 "no-asm" configuration option.
772 Compiling parts of OpenSSL with gcc and others with the system
773 compiler will result in unresolved symbols on some systems.
775 If you are still having problems you can get help by sending an email
776 to the openssl-users email list (see
777 https://www.openssl.org/community/mailinglists.html for details). If
778 it is a bug with OpenSSL itself, please open an issue on GitHub, at
779 https://github.com/openssl/openssl/issues. Please review the existing
780 ones first; maybe the bug was already reported or has already been
783 3. After a successful build, the libraries should be tested. Run:
787 $ nmake test # Windows
789 NOTE: you MUST run the tests from an unprivileged account (or
790 disable your privileges temporarily if your platform allows it).
792 If some tests fail, look at the output. There may be reasons for
793 the failure that isn't a problem in OpenSSL itself (like a
794 malfunction with Perl). You may want increased verbosity, that
795 can be accomplished like this:
797 $ make VERBOSE=1 test # Unix
799 $ mms /macro=(VERBOSE=1) test ! OpenVMS
801 $ nmake VERBOSE=1 test # Windows
803 If you want to run just one or a few specific tests, you can use
804 the make variable TESTS to specify them, like this:
806 $ make TESTS='test_rsa test_dsa' test # Unix
807 $ mms/macro="TESTS=test_rsa test_dsa" test ! OpenVMS
808 $ nmake TESTS='test_rsa test_dsa' test # Windows
810 And of course, you can combine (Unix example shown):
812 $ make VERBOSE=1 TESTS='test_rsa test_dsa' test
814 You can find the list of available tests like this:
816 $ make list-tests # Unix
817 $ mms list-tests ! OpenVMS
818 $ nmake list-tests # Windows
820 Have a look at the manual for the perl module Test::Harness to
821 see what other HARNESS_* variables there are.
823 If you find a problem with OpenSSL itself, try removing any
824 compiler optimization flags from the CFLAGS line in Makefile and
825 run "make clean; make" or corresponding.
827 To report a bug please open an issue on GitHub, at
828 https://github.com/openssl/openssl/issues.
830 For more details on how the make variables TESTS can be used,
831 see section TESTS in Detail below.
833 4. If everything tests ok, install OpenSSL with
835 $ make install # Unix
836 $ mms install ! OpenVMS
837 $ nmake install # Windows
839 This will install all the software components in this directory
840 tree under PREFIX (the directory given with --prefix or its
845 bin/ Contains the openssl binary and a few other
848 Contains the header files needed if you want
849 to build your own programs that use libcrypto
851 lib Contains the OpenSSL library files.
852 lib/engines Contains the OpenSSL dynamically loadable engines.
854 share/man/man1 Contains the OpenSSL command line man-pages.
855 share/man/man3 Contains the OpenSSL library calls man-pages.
856 share/man/man5 Contains the OpenSSL configuration format man-pages.
857 share/man/man7 Contains the OpenSSL other misc man-pages.
859 share/doc/openssl/html/man1
860 share/doc/openssl/html/man3
861 share/doc/openssl/html/man5
862 share/doc/openssl/html/man7
863 Contains the HTML rendition of the man-pages.
865 OpenVMS ('arch' is replaced with the architecture name, "Alpha"
866 or "ia64", 'sover' is replaced with the shared library version
867 (0101 for 1.1), and 'pz' is replaced with the pointer size
868 OpenSSL was built with):
870 [.EXE.'arch'] Contains the openssl binary.
871 [.EXE] Contains a few utility scripts.
873 Contains the header files needed if you want
874 to build your own programs that use libcrypto
876 [.LIB.'arch'] Contains the OpenSSL library files.
877 [.ENGINES'sover''pz'.'arch']
878 Contains the OpenSSL dynamically loadable engines.
879 [.SYS$STARTUP] Contains startup, login and shutdown scripts.
880 These define appropriate logical names and
882 [.SYSTEST] Contains the installation verification procedure.
883 [.HTML] Contains the HTML rendition of the manual pages.
886 Additionally, install will add the following directories under
887 OPENSSLDIR (the directory given with --openssldir or its default)
890 certs Initially empty, this is the default location
891 for certificate files.
892 private Initially empty, this is the default location
893 for private key files.
894 misc Various scripts.
896 Package builders who want to configure the library for standard
897 locations, but have the package installed somewhere else so that
898 it can easily be packaged, can use
900 $ make DESTDIR=/tmp/package-root install # Unix
901 $ mms/macro="DESTDIR=TMP:[PACKAGE-ROOT]" install ! OpenVMS
903 The specified destination directory will be prepended to all
904 installation target paths.
906 Compatibility issues with previous OpenSSL versions:
908 * COMPILING existing applications
910 OpenSSL 1.1.0 hides a number of structures that were previously
911 open. This includes all internal libssl structures and a number
912 of EVP types. Accessor functions have been added to allow
913 controlled access to the structures' data.
915 This means that some software needs to be rewritten to adapt to
916 the new ways of doing things. This often amounts to allocating
917 an instance of a structure explicitly where you could previously
918 allocate them on the stack as automatic variables, and using the
919 provided accessor functions where you would previously access a
920 structure's field directly.
922 Some APIs have changed as well. However, older APIs have been
923 preserved when possible.
925 Environment Variables
926 ---------------------
928 A number of environment variables can be used to provide additional control
929 over the build process. Typically these should be defined prior to running
930 config or Configure. Not all environment variables are relevant to all
934 The name of the ar executable to use.
937 Use a different build file name than the platform default
938 ("Makefile" on Unixly platforms, "makefile" on native Windows,
939 "descrip.mms" on OpenVMS). This requires that there is a
940 corresponding build file template. See Configurations/README
941 for further information.
944 The compiler to use. Configure will attempt to pick a default
945 compiler for your platform but this choice can be overridden
946 using this variable. Set it to the compiler executable you wish
947 to use, e.g. "gcc" or "clang".
950 This environment variable has the same meaning as for the
951 "--cross-compile-prefix" Configure flag described above. If both
952 are set then the Configure flag takes precedence.
955 The name of the nm executable to use.
957 OPENSSL_LOCAL_CONFIG_DIR
958 OpenSSL comes with a database of information about how it
959 should be built on different platforms as well as build file
960 templates for those platforms. The database is comprised of
961 ".conf" files in the Configurations directory. The build
962 file templates reside there as well as ".tmpl" files. See the
963 file Configurations/README for further information about the
964 format of ".conf" files as well as information on the ".tmpl"
966 In addition to the standard ".conf" and ".tmpl" files, it is
967 possible to create your own ".conf" and ".tmpl" files and store
968 them locally, outside the OpenSSL source tree. This environment
969 variable can be set to the directory where these files are held
970 and will be considered by Configure before it looks in the
971 standard directories.
974 The name of the Perl executable to use when building OpenSSL.
975 This variable is used in config script only. Configure on the
976 other hand imposes the interpreter by which it itself was
977 executed on the whole build procedure.
980 The command string for the Perl executable to insert in the
981 #! line of perl scripts that will be publically installed.
982 Default: /usr/bin/env perl
983 Note: the value of this variable is added to the same scripts
984 on all platforms, but it's only relevant on Unix-like platforms.
987 The name of the rc executable to use. The default will be as
988 defined for the target platform in the ".conf" file. If not
989 defined then "windres" will be used. The WINDRES environment
990 variable is synonymous to this. If both are defined then RC
994 The name of the ranlib executable to use.
1002 The Configure script generates a Makefile in a format relevant to the specific
1003 platform. The Makefiles provide a number of targets that can be used. Not all
1004 targets may be available on all platforms. Only the most common targets are
1005 described here. Examine the Makefiles themselves for the full list.
1008 The default target to build all the software components.
1011 Remove all build artefacts and return the directory to a "clean"
1015 Rebuild the dependencies in the Makefiles. This is a legacy
1016 option that no longer needs to be used in OpenSSL 1.1.0.
1019 Install all OpenSSL components.
1022 Only install the OpenSSL software components.
1025 Only install the OpenSSL documentation components.
1028 Only install the OpenSSL man pages (Unix only).
1031 Only install the OpenSSL html documentation.
1034 Prints a list of all the self test names.
1037 Build and run the OpenSSL self tests.
1040 Uninstall all OpenSSL components.
1044 Re-run the configuration process, as exactly as the last time
1048 This is a developer option. If you are developing a patch for
1049 OpenSSL you may need to use this if you want to update
1050 automatically generated files; add new error codes or add new
1051 (or change the visibility of) public API functions. (Unix only).
1056 The make variable TESTS supports a versatile set of space separated tokens
1057 with which you can specify a set of tests to be performed. With a "current
1058 set of tests" in mind, initially being empty, here are the possible tokens:
1060 alltests The current set of tests becomes the whole set of available
1061 tests (as listed when you do 'make list-tests' or similar).
1062 xxx Adds the test 'xxx' to the current set of tests.
1063 -xxx Removes 'xxx' from the current set of tests. If this is the
1064 first token in the list, the current set of tests is first
1065 assigned the whole set of available tests, effectively making
1066 this token equivalent to TESTS="alltests -xxx".
1067 nn Adds the test group 'nn' (which is a number) to the current
1069 -nn Removes the test group 'nn' from the current set of tests.
1070 If this is the first token in the list, the current set of
1071 tests is first assigned the whole set of available tests,
1072 effectively making this token equivalent to
1073 TESTS="alltests -xxx".
1075 Also, all tokens except for "alltests" may have wildcards, such as *.
1076 (on Unix and Windows, BSD style wildcards are supported, while on VMS,
1077 it's VMS style wildcards)
1079 Example: All tests except for the fuzz tests:
1081 $ make TESTS=-test_fuzz test
1083 or (if you want to be explicit)
1085 $ make TESTS='alltests -test_fuzz' test
1087 Example: All tests that have a name starting with "test_ssl" but not those
1088 starting with "test_ssl_":
1090 $ make TESTS='test_ssl* -test_ssl_*' test
1092 Example: Only test group 10:
1096 Example: All tests except the slow group (group 99):
1100 Example: All tests in test groups 80 to 99 except for tests in group 90:
1102 $ make TESTS='[89]? -90'
1104 Note on multi-threading
1105 -----------------------
1107 For some systems, the OpenSSL Configure script knows what compiler options
1108 are needed to generate a library that is suitable for multi-threaded
1109 applications. On these systems, support for multi-threading is enabled
1110 by default; use the "no-threads" option to disable (this should never be
1113 On other systems, to enable support for multi-threading, you will have
1114 to specify at least two options: "threads", and a system-dependent option.
1115 (The latter is "-D_REENTRANT" on various systems.) The default in this
1116 case, obviously, is not to include support for multi-threading (but
1117 you can still use "no-threads" to suppress an annoying warning message
1118 from the Configure script.)
1120 OpenSSL provides built-in support for two threading models: pthreads (found on
1121 most UNIX/Linux systems), and Windows threads. No other threading models are
1122 supported. If your platform does not provide pthreads or Windows threads then
1123 you should Configure with the "no-threads" option.
1125 Notes on shared libraries
1126 -------------------------
1128 For most systems the OpenSSL Configure script knows what is needed to
1129 build shared libraries for libcrypto and libssl. On these systems
1130 the shared libraries will be created by default. This can be suppressed and
1131 only static libraries created by using the "no-shared" option. On systems
1132 where OpenSSL does not know how to build shared libraries the "no-shared"
1133 option will be forced and only static libraries will be created.
1135 Shared libraries are named a little differently on different platforms.
1136 One way or another, they all have the major OpenSSL version number as
1137 part of the file name, i.e. for OpenSSL 1.1.x, 1.1 is somehow part of
1140 On most POSIXly platforms, shared libraries are named libcrypto.so.1.1
1143 on Cygwin, shared libraries are named cygcrypto-1.1.dll and cygssl-1.1.dll
1144 with import libraries libcrypto.dll.a and libssl.dll.a.
1146 On Windows build with MSVC or using MingW, shared libraries are named
1147 libcrypto-1_1.dll and libssl-1_1.dll for 32-bit Windows, libcrypto-1_1-x64.dll
1148 and libssl-1_1-x64.dll for 64-bit x86_64 Windows, and libcrypto-1_1-ia64.dll
1149 and libssl-1_1-ia64.dll for IA64 Windows. With MSVC, the import libraries
1150 are named libcrypto.lib and libssl.lib, while with MingW, they are named
1151 libcrypto.dll.a and libssl.dll.a.
1153 On VMS, shareable images (VMS speak for shared libraries) are named
1154 ossl$libcrypto0101_shr.exe and ossl$libssl0101_shr.exe. However, when
1155 OpenSSL is specifically built for 32-bit pointers, the shareable images
1156 are named ossl$libcrypto0101_shr32.exe and ossl$libssl0101_shr32.exe
1157 instead, and when built for 64-bit pointers, they are named
1158 ossl$libcrypto0101_shr64.exe and ossl$libssl0101_shr64.exe.
1160 Note on random number generation
1161 --------------------------------
1163 Availability of cryptographically secure random numbers is required for
1164 secret key generation. OpenSSL provides several options to seed the
1165 internal PRNG. If not properly seeded, the internal PRNG will refuse
1166 to deliver random bytes and a "PRNG not seeded error" will occur.
1167 On systems without /dev/urandom (or similar) device, it may be necessary
1168 to install additional support software to obtain a random seed.
1169 Please check out the manual pages for RAND_add(), RAND_bytes(), RAND_egd(),
1170 and the FAQ for more information.
projects / openssl.git / blob