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 Don't build support for negotiating the specified SSL/TLS
487 protocol (one of ssl, ssl3, tls, tls1, tls1_1, tls1_2,
488 tls1_3, dtls, dtls1 or dtls1_2). If "no-tls" is selected then
489 all of tls1, tls1_1, tls1_2 and tls1_3 are disabled.
490 Similarly "no-dtls" will disable dtls1 and dtls1_2. The
491 "no-ssl" option is synonymous with "no-ssl3". Note this only
492 affects version negotiation. OpenSSL will still provide the
493 methods for applications to explicitly select the individual
497 As for no-<prot> but in addition do not build the methods for
498 applications to explicitly select individual protocol
499 versions. Note that there is no "no-tls1_3-method" option
500 because there is no application method for TLSv1.3. Using
501 individual protocol methods directly is deprecated.
502 Applications should use TLS_method() instead.
505 Build with support for the specified algorithm, where <alg>
506 is one of: md2 or rc5.
509 Build without support for the specified algorithm, where
510 <alg> is one of: aria, bf, blake2, camellia, cast, chacha,
511 cmac, des, dh, dsa, ecdh, ecdsa, idea, md4, mdc2, ocb,
512 poly1305, rc2, rc4, rmd160, scrypt, seed, siphash, sm3, sm4
513 or whirlpool. The "ripemd" algorithm is deprecated and if
514 used is synonymous with rmd160.
516 -Dxxx, -Ixxx, -Wp, -lxxx, -Lxxx, -Wl, -rpath, -R, -framework, -static
517 These system specific options will be recognised and
518 passed through to the compiler to allow you to define
519 preprocessor symbols, specify additional libraries, library
520 directories or other compiler options. It might be worth
521 noting that some compilers generate code specifically for
522 processor the compiler currently executes on. This is not
523 necessarily what you might have in mind, since it might be
524 unsuitable for execution on other, typically older,
525 processor. Consult your compiler documentation.
527 Take note of the VAR=value documentation below and how
528 these flags interact with those variables.
531 Additional options that are not otherwise recognised are
532 passed through as they are to the compiler as well. Again,
533 consult your compiler documentation.
535 Take note of the VAR=value documentation below and how
536 these flags interact with those variables.
539 Assignment of environment variable for Configure. These
540 work just like normal environment variable assignments,
541 but are supported on all platforms and are confined to
542 the configuration scripts only. These assignments override
543 the corresponding value in the inherited environment, if
546 The following variables are used as "make variables" and
547 can be used as an alternative to giving preprocessor,
548 compiler and linker options directly as configuration.
549 The following variables are supported:
551 AR The static library archiver.
552 ARFLAGS Flags for the static library archiver.
553 AS The assembler compiler.
554 ASFLAGS Flags for the assembler compiler.
556 CFLAGS Flags for the C compiler.
557 CXX The C++ compiler.
558 CXXFLAGS Flags for the C++ compiler.
559 CPP The C/C++ preprocessor.
560 CPPFLAGS Flags for the C/C++ preprocessor.
561 CPPDEFINES List of CPP macro definitions, separated
562 by a platform specific character (':' or
563 space for Unix, ';' for Windows, ',' for
564 VMS). This can be used instead of using
565 -D (or what corresponds to that on your
566 compiler) in CPPFLAGS.
567 CPPINCLUDES List of CPP inclusion directories, separated
568 the same way as for CPPDEFINES. This can
569 be used instead of -I (or what corresponds
570 to that on your compiler) in CPPFLAGS.
571 HASHBANGPERL Perl invocation to be inserted after '#!'
572 in public perl scripts (only relevant on
574 LD The program linker (not used on Unix, $(CC)
576 LDFLAGS Flags for the shared library, DSO and
578 LDLIBS Extra libraries to use when linking.
579 Takes the form of a space separated list
580 of library specifications on Unix and
581 Windows, and as a comma separated list of
583 RANLIB The library archive indexer.
584 RC The Windows resources manipulator.
585 RCFLAGS Flags for the Windows reources manipulator.
586 RM The command to remove files and directories.
588 These cannot be mixed with compiling / linking flags given
589 on the command line. In other words, something like this
592 ./config -DFOO CPPFLAGS=-DBAR -DCOOKIE
594 Backward compatibility note:
596 To be compatible with older configuration scripts, the
597 environment variables are ignored if compiling / linking
598 flags are given on the command line, except for these:
600 AR, CC, CXX, CROSS_COMPILE, HASHBANGPERL, PERL, RANLIB, RC
603 For example, the following command will not see -DBAR:
605 CPPFLAGS=-DBAR ./config -DCOOKIE
607 However, the following will see both set variables:
609 CC=gcc CROSS_COMPILE=x86_64-w64-mingw32- \
614 Reconfigure from earlier data. This fetches the previous
615 command line options and environment from data saved in
616 "configdata.pm", and runs the configuration process again,
617 using these options and environment.
618 Note: NO other option is permitted together with "reconf".
619 This means that you also MUST use "./Configure" (or
620 what corresponds to that on non-Unix platforms) directly
621 to invoke this option.
622 Note: The original configuration saves away values for ALL
623 environment variables that were used, and if they weren't
624 defined, they are still saved away with information that
625 they weren't originally defined. This information takes
626 precedence over environment variables that are defined
629 Displaying configuration data
630 -----------------------------
632 The configuration script itself will say very little, and finishes by
633 creating "configdata.pm". This perl module can be loaded by other scripts
634 to find all the configuration data, and it can also be used as a script to
635 display all sorts of configuration data in a human readable form.
637 For more information, please do:
639 $ ./configdata.pm --help # Unix
643 $ perl configdata.pm --help # Windows and VMS
645 Installation in Detail
646 ----------------------
648 1a. Configure OpenSSL for your operation system automatically:
650 NOTE: This is not available on Windows.
652 $ ./config [[ options ]] # Unix
656 $ @config [[ options ]] ! OpenVMS
658 For the remainder of this text, the Unix form will be used in all
659 examples, please use the appropriate form for your platform.
661 This guesses at your operating system (and compiler, if necessary) and
662 configures OpenSSL based on this guess. Run ./config -t to see
663 if it guessed correctly. If you want to use a different compiler, you
664 are cross-compiling for another platform, or the ./config guess was
665 wrong for other reasons, go to step 1b. Otherwise go to step 2.
667 On some systems, you can include debugging information as follows:
669 $ ./config -d [[ options ]]
671 1b. Configure OpenSSL for your operating system manually
673 OpenSSL knows about a range of different operating system, hardware and
674 compiler combinations. To see the ones it knows about, run
680 $ perl Configure # All other platforms
682 For the remainder of this text, the Unix form will be used in all
683 examples, please use the appropriate form for your platform.
685 Pick a suitable name from the list that matches your system. For most
686 operating systems there is a choice between using "cc" or "gcc". When
687 you have identified your system (and if necessary compiler) use this name
688 as the argument to Configure. For example, a "linux-elf" user would
691 $ ./Configure linux-elf [[ options ]]
693 If your system isn't listed, you will have to create a configuration
694 file named Configurations/{{ something }}.conf and add the correct
695 configuration for your system. See the available configs as examples
696 and read Configurations/README and Configurations/README.design for
699 The generic configurations "cc" or "gcc" should usually work on 32 bit
702 Configure creates a build file ("Makefile" on Unix, "makefile" on Windows
703 and "descrip.mms" on OpenVMS) from a suitable template in Configurations,
704 and defines various macros in include/openssl/opensslconf.h (generated from
705 include/openssl/opensslconf.h.in).
707 1c. Configure OpenSSL for building outside of the source tree.
709 OpenSSL can be configured to build in a build directory separate from
710 the directory with the source code. It's done by placing yourself in
711 some other directory and invoking the configuration commands from
716 $ mkdir /var/tmp/openssl-build
717 $ cd /var/tmp/openssl-build
718 $ /PATH/TO/OPENSSL/SOURCE/config [[ options ]]
722 $ /PATH/TO/OPENSSL/SOURCE/Configure {{ target }} [[ options ]]
726 $ set default sys$login:
727 $ create/dir [.tmp.openssl-build]
728 $ set default [.tmp.openssl-build]
729 $ @[PATH.TO.OPENSSL.SOURCE]config [[ options ]]
733 $ @[PATH.TO.OPENSSL.SOURCE]Configure {{ target }} [[ options ]]
738 $ mkdir \temp-openssl
740 $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure {{ target }} [[ options ]]
742 Paths can be relative just as well as absolute. Configure will
743 do its best to translate them to relative paths whenever possible.
745 2. Build OpenSSL by running:
748 $ mms ! (or mmk) OpenVMS
751 This will build the OpenSSL libraries (libcrypto.a and libssl.a on
752 Unix, corresponding on other platforms) and the OpenSSL binary
753 ("openssl"). The libraries will be built in the top-level directory,
754 and the binary will be in the "apps" subdirectory.
758 If the build fails, look at the output. There may be reasons
759 for the failure that aren't problems in OpenSSL itself (like
760 missing standard headers).
762 If the build succeeded previously, but fails after a source or
763 configuration change, it might be helpful to clean the build tree
764 before attempting another build. Use this command:
767 $ mms clean ! (or mmk) OpenVMS
768 $ nmake clean # Windows
770 Assembler error messages can sometimes be sidestepped by using the
771 "no-asm" configuration option.
773 Compiling parts of OpenSSL with gcc and others with the system
774 compiler will result in unresolved symbols on some systems.
776 If you are still having problems you can get help by sending an email
777 to the openssl-users email list (see
778 https://www.openssl.org/community/mailinglists.html for details). If
779 it is a bug with OpenSSL itself, please open an issue on GitHub, at
780 https://github.com/openssl/openssl/issues. Please review the existing
781 ones first; maybe the bug was already reported or has already been
784 3. After a successful build, the libraries should be tested. Run:
788 $ nmake test # Windows
790 NOTE: you MUST run the tests from an unprivileged account (or
791 disable your privileges temporarily if your platform allows it).
793 If some tests fail, look at the output. There may be reasons for
794 the failure that isn't a problem in OpenSSL itself (like a
795 malfunction with Perl). You may want increased verbosity, that
796 can be accomplished like this:
798 $ make VERBOSE=1 test # Unix
800 $ mms /macro=(VERBOSE=1) test ! OpenVMS
802 $ nmake VERBOSE=1 test # Windows
804 If you want to run just one or a few specific tests, you can use
805 the make variable TESTS to specify them, like this:
807 $ make TESTS='test_rsa test_dsa' test # Unix
808 $ mms/macro="TESTS=test_rsa test_dsa" test ! OpenVMS
809 $ nmake TESTS='test_rsa test_dsa' test # Windows
811 And of course, you can combine (Unix example shown):
813 $ make VERBOSE=1 TESTS='test_rsa test_dsa' test
815 You can find the list of available tests like this:
817 $ make list-tests # Unix
818 $ mms list-tests ! OpenVMS
819 $ nmake list-tests # Windows
821 Have a look at the manual for the perl module Test::Harness to
822 see what other HARNESS_* variables there are.
824 If you find a problem with OpenSSL itself, try removing any
825 compiler optimization flags from the CFLAGS line in Makefile and
826 run "make clean; make" or corresponding.
828 To report a bug please open an issue on GitHub, at
829 https://github.com/openssl/openssl/issues.
831 For more details on how the make variables TESTS can be used,
832 see section TESTS in Detail below.
834 4. If everything tests ok, install OpenSSL with
836 $ make install # Unix
837 $ mms install ! OpenVMS
838 $ nmake install # Windows
840 This will install all the software components in this directory
841 tree under PREFIX (the directory given with --prefix or its
846 bin/ Contains the openssl binary and a few other
849 Contains the header files needed if you want
850 to build your own programs that use libcrypto
852 lib Contains the OpenSSL library files.
853 lib/engines Contains the OpenSSL dynamically loadable engines.
855 share/man/man1 Contains the OpenSSL command line man-pages.
856 share/man/man3 Contains the OpenSSL library calls man-pages.
857 share/man/man5 Contains the OpenSSL configuration format man-pages.
858 share/man/man7 Contains the OpenSSL other misc man-pages.
860 share/doc/openssl/html/man1
861 share/doc/openssl/html/man3
862 share/doc/openssl/html/man5
863 share/doc/openssl/html/man7
864 Contains the HTML rendition of the man-pages.
866 OpenVMS ('arch' is replaced with the architecture name, "Alpha"
867 or "ia64", 'sover' is replaced with the shared library version
868 (0101 for 1.1), and 'pz' is replaced with the pointer size
869 OpenSSL was built with):
871 [.EXE.'arch'] Contains the openssl binary.
872 [.EXE] Contains a few utility scripts.
874 Contains the header files needed if you want
875 to build your own programs that use libcrypto
877 [.LIB.'arch'] Contains the OpenSSL library files.
878 [.ENGINES'sover''pz'.'arch']
879 Contains the OpenSSL dynamically loadable engines.
880 [.SYS$STARTUP] Contains startup, login and shutdown scripts.
881 These define appropriate logical names and
883 [.SYSTEST] Contains the installation verification procedure.
884 [.HTML] Contains the HTML rendition of the manual pages.
887 Additionally, install will add the following directories under
888 OPENSSLDIR (the directory given with --openssldir or its default)
891 certs Initially empty, this is the default location
892 for certificate files.
893 private Initially empty, this is the default location
894 for private key files.
895 misc Various scripts.
897 Package builders who want to configure the library for standard
898 locations, but have the package installed somewhere else so that
899 it can easily be packaged, can use
901 $ make DESTDIR=/tmp/package-root install # Unix
902 $ mms/macro="DESTDIR=TMP:[PACKAGE-ROOT]" install ! OpenVMS
904 The specified destination directory will be prepended to all
905 installation target paths.
907 Compatibility issues with previous OpenSSL versions:
909 * COMPILING existing applications
911 OpenSSL 1.1.0 hides a number of structures that were previously
912 open. This includes all internal libssl structures and a number
913 of EVP types. Accessor functions have been added to allow
914 controlled access to the structures' data.
916 This means that some software needs to be rewritten to adapt to
917 the new ways of doing things. This often amounts to allocating
918 an instance of a structure explicitly where you could previously
919 allocate them on the stack as automatic variables, and using the
920 provided accessor functions where you would previously access a
921 structure's field directly.
923 Some APIs have changed as well. However, older APIs have been
924 preserved when possible.
926 Environment Variables
927 ---------------------
929 A number of environment variables can be used to provide additional control
930 over the build process. Typically these should be defined prior to running
931 config or Configure. Not all environment variables are relevant to all
935 The name of the ar executable to use.
938 Use a different build file name than the platform default
939 ("Makefile" on Unixly platforms, "makefile" on native Windows,
940 "descrip.mms" on OpenVMS). This requires that there is a
941 corresponding build file template. See Configurations/README
942 for further information.
945 The compiler to use. Configure will attempt to pick a default
946 compiler for your platform but this choice can be overridden
947 using this variable. Set it to the compiler executable you wish
948 to use, e.g. "gcc" or "clang".
951 This environment variable has the same meaning as for the
952 "--cross-compile-prefix" Configure flag described above. If both
953 are set then the Configure flag takes precedence.
956 The name of the nm executable to use.
958 OPENSSL_LOCAL_CONFIG_DIR
959 OpenSSL comes with a database of information about how it
960 should be built on different platforms as well as build file
961 templates for those platforms. The database is comprised of
962 ".conf" files in the Configurations directory. The build
963 file templates reside there as well as ".tmpl" files. See the
964 file Configurations/README for further information about the
965 format of ".conf" files as well as information on the ".tmpl"
967 In addition to the standard ".conf" and ".tmpl" files, it is
968 possible to create your own ".conf" and ".tmpl" files and store
969 them locally, outside the OpenSSL source tree. This environment
970 variable can be set to the directory where these files are held
971 and will be considered by Configure before it looks in the
972 standard directories.
975 The name of the Perl executable to use when building OpenSSL.
976 This variable is used in config script only. Configure on the
977 other hand imposes the interpreter by which it itself was
978 executed on the whole build procedure.
981 The command string for the Perl executable to insert in the
982 #! line of perl scripts that will be publically installed.
983 Default: /usr/bin/env perl
984 Note: the value of this variable is added to the same scripts
985 on all platforms, but it's only relevant on Unix-like platforms.
988 The name of the rc executable to use. The default will be as
989 defined for the target platform in the ".conf" file. If not
990 defined then "windres" will be used. The WINDRES environment
991 variable is synonymous to this. If both are defined then RC
995 The name of the ranlib executable to use.
1003 The Configure script generates a Makefile in a format relevant to the specific
1004 platform. The Makefiles provide a number of targets that can be used. Not all
1005 targets may be available on all platforms. Only the most common targets are
1006 described here. Examine the Makefiles themselves for the full list.
1009 The default target to build all the software components.
1012 Remove all build artefacts and return the directory to a "clean"
1016 Rebuild the dependencies in the Makefiles. This is a legacy
1017 option that no longer needs to be used in OpenSSL 1.1.0.
1020 Install all OpenSSL components.
1023 Only install the OpenSSL software components.
1026 Only install the OpenSSL documentation components.
1029 Only install the OpenSSL man pages (Unix only).
1032 Only install the OpenSSL html documentation.
1035 Prints a list of all the self test names.
1038 Build and run the OpenSSL self tests.
1041 Uninstall all OpenSSL components.
1045 Re-run the configuration process, as exactly as the last time
1049 This is a developer option. If you are developing a patch for
1050 OpenSSL you may need to use this if you want to update
1051 automatically generated files; add new error codes or add new
1052 (or change the visibility of) public API functions. (Unix only).
1057 The make variable TESTS supports a versatile set of space separated tokens
1058 with which you can specify a set of tests to be performed. With a "current
1059 set of tests" in mind, initially being empty, here are the possible tokens:
1061 alltests The current set of tests becomes the whole set of available
1062 tests (as listed when you do 'make list-tests' or similar).
1063 xxx Adds the test 'xxx' to the current set of tests.
1064 -xxx Removes 'xxx' from the current set of tests. If this is the
1065 first token in the list, the current set of tests is first
1066 assigned the whole set of available tests, effectively making
1067 this token equivalent to TESTS="alltests -xxx".
1068 nn Adds the test group 'nn' (which is a number) to the current
1070 -nn Removes the test group 'nn' from the current set of tests.
1071 If this is the first token in the list, the current set of
1072 tests is first assigned the whole set of available tests,
1073 effectively making this token equivalent to
1074 TESTS="alltests -xxx".
1076 Also, all tokens except for "alltests" may have wildcards, such as *.
1077 (on Unix and Windows, BSD style wildcards are supported, while on VMS,
1078 it's VMS style wildcards)
1080 Example: All tests except for the fuzz tests:
1082 $ make TESTS=-test_fuzz test
1084 or (if you want to be explicit)
1086 $ make TESTS='alltests -test_fuzz' test
1088 Example: All tests that have a name starting with "test_ssl" but not those
1089 starting with "test_ssl_":
1091 $ make TESTS='test_ssl* -test_ssl_*' test
1093 Example: Only test group 10:
1097 Example: All tests except the slow group (group 99):
1101 Example: All tests in test groups 80 to 99 except for tests in group 90:
1103 $ make TESTS='[89]? -90'
1105 Note on multi-threading
1106 -----------------------
1108 For some systems, the OpenSSL Configure script knows what compiler options
1109 are needed to generate a library that is suitable for multi-threaded
1110 applications. On these systems, support for multi-threading is enabled
1111 by default; use the "no-threads" option to disable (this should never be
1114 On other systems, to enable support for multi-threading, you will have
1115 to specify at least two options: "threads", and a system-dependent option.
1116 (The latter is "-D_REENTRANT" on various systems.) The default in this
1117 case, obviously, is not to include support for multi-threading (but
1118 you can still use "no-threads" to suppress an annoying warning message
1119 from the Configure script.)
1121 OpenSSL provides built-in support for two threading models: pthreads (found on
1122 most UNIX/Linux systems), and Windows threads. No other threading models are
1123 supported. If your platform does not provide pthreads or Windows threads then
1124 you should Configure with the "no-threads" option.
1126 Notes on shared libraries
1127 -------------------------
1129 For most systems the OpenSSL Configure script knows what is needed to
1130 build shared libraries for libcrypto and libssl. On these systems
1131 the shared libraries will be created by default. This can be suppressed and
1132 only static libraries created by using the "no-shared" option. On systems
1133 where OpenSSL does not know how to build shared libraries the "no-shared"
1134 option will be forced and only static libraries will be created.
1136 Shared libraries are named a little differently on different platforms.
1137 One way or another, they all have the major OpenSSL version number as
1138 part of the file name, i.e. for OpenSSL 1.1.x, 1.1 is somehow part of
1141 On most POSIXly platforms, shared libraries are named libcrypto.so.1.1
1144 on Cygwin, shared libraries are named cygcrypto-1.1.dll and cygssl-1.1.dll
1145 with import libraries libcrypto.dll.a and libssl.dll.a.
1147 On Windows build with MSVC or using MingW, shared libraries are named
1148 libcrypto-1_1.dll and libssl-1_1.dll for 32-bit Windows, libcrypto-1_1-x64.dll
1149 and libssl-1_1-x64.dll for 64-bit x86_64 Windows, and libcrypto-1_1-ia64.dll
1150 and libssl-1_1-ia64.dll for IA64 Windows. With MSVC, the import libraries
1151 are named libcrypto.lib and libssl.lib, while with MingW, they are named
1152 libcrypto.dll.a and libssl.dll.a.
1154 On VMS, shareable images (VMS speak for shared libraries) are named
1155 ossl$libcrypto0101_shr.exe and ossl$libssl0101_shr.exe. However, when
1156 OpenSSL is specifically built for 32-bit pointers, the shareable images
1157 are named ossl$libcrypto0101_shr32.exe and ossl$libssl0101_shr32.exe
1158 instead, and when built for 64-bit pointers, they are named
1159 ossl$libcrypto0101_shr64.exe and ossl$libssl0101_shr64.exe.
1161 Note on random number generation
1162 --------------------------------
1164 Availability of cryptographically secure random numbers is required for
1165 secret key generation. OpenSSL provides several options to seed the
1166 internal PRNG. If not properly seeded, the internal PRNG will refuse
1167 to deliver random bytes and a "PRNG not seeded error" will occur.
1168 On systems without /dev/urandom (or similar) device, it may be necessary
1169 to install additional support software to obtain a random seed.
1170 Please check out the manual pages for RAND_add(), RAND_bytes(), RAND_egd(),
1171 and the FAQ for more information.
projects / oweals / openssl.git / blob