0b93ccd98b5ce9ff576ceb5874cdb8cadb8a976a
[openssl.git] / INSTALL.md
1 Build and Install
2 =================
3
4 This document describes installation on all supported operating
5 systems (the Unix/Linux family, including macOS), OpenVMS,
6 and Windows).
7
8 Table of Contents
9 =================
10
11  - [Prerequisites](#prerequisites)
12  - [Notational Conventions](#notational-conventions)
13  - [Quick Installation Guide](#quick-installation-guide)
14    - [Building OpenSSL](#building-openssl)
15    - [Installing OpenSSL](#installing-openssl)
16  - [Configuration Options](#configuration-options)
17    - [API Level](#api-level)
18    - [Cross Compile Prefix](#cross-compile-prefix)
19    - [Build Type](#build-type)
20    - [Directories](#directories)
21    - [Compiler Warnings](#compiler-warnings)
22    - [ZLib Flags](#zlib-flags)
23    - [Seeding the Random Generator](#seeding-the-random-generator)
24    - [Enable and Disable Features](#enable-and-disable-features)
25    - [Displaying configuration data](#displaying-configuration-data)
26  - [Installation Steps in Detail](#installation-steps-in-detail)
27    - [Configure](#configure-openssl)
28    - [Build](#build-openssl)
29    - [Test](#test-openssl)
30    - [Install](#install-openssl)
31  - [Advanced Build Options](#advanced-build-options)
32    - [Environment Variables](#environment-variables)
33    - [Makefile Targets](#makefile-targets)
34    - [Running Selected Tests](#running-selected-tests)
35  - [Troubleshooting](#troubleshooting)
36    - [Configuration Problems](#configuration-problems)
37    - [Build Failures](#build-failures)
38    - [Test Failures](#test-failures)
39  - [Notes](#notes)
40    - [Notes on multi-threading](#notes-on-multi-threading)
41    - [Notes on shared libraries](#notes-on-shared-libraries)
42    - [Notes on random number generation](#notes-on-random-number-generation)
43
44 Prerequisites
45 =============
46
47 To install OpenSSL, you will need:
48
49  * A make implementation
50  * Perl 5 with core modules (please read [NOTES.PERL](NOTES.PERL))
51  * The Perl module Text::Template (please read [NOTES.PERL](NOTES.PERL))
52  * an ANSI C compiler
53  * a development environment in the form of development libraries and C
54    header files
55  * a supported operating system
56
57 For additional platform specific requirements, solutions to specific
58 issues and other details, please read one of these:
59
60  * [NOTES.UNIX](NOTES.UNIX) - notes for Unix like systems
61  * [NOTES.VMS](NOTES.VMS) - notes related to OpenVMS
62  * [NOTES.WIN](NOTES.WIN) - notes related to the Windows platform
63  * [NOTES.DJGPP](NOTES.DJGPP) - building for DOS with DJGPP
64  * [NOTES.ANDROID](NOTES.ANDROID) - building for Android platforms (using NDK)
65  * [NOTES.VALGRIND](NOTES.VALGRIND) - testing with Valgrind
66  * [NOTES.PERL](NOTES.PERL) - some notes on Perl
67
68 Notational conventions
69 ======================
70
71 Throughout this document, we use the following conventions.
72
73 Commands
74 --------
75
76 Any line starting with a dollar sign is a command line.
77
78     $ command
79
80 The dollar sign indicates the shell prompt and is not to be entered as
81 part of the command.
82
83 Choices
84 -------
85
86 Several words in curly braces separated by pipe characters indicate a
87 **mandatory choice**, to be replaced with one of the given words.
88 For example, the line
89
90     $ echo { WORD1 | WORD2 | WORD3 }
91
92 represents one of the following three commands
93
94     $ echo WORD1
95     - or -
96     $ echo WORD2
97     - or -
98     $ echo WORD3
99
100 One or several words in square brackets separated by pipe characters
101 denote an **optional choice**.  It is similar to the mandatory choice,
102 but it can also be omitted entirely.
103
104 So the line
105
106     $ echo [ WORD1 | WORD2 | WORD3 ]
107
108 represents one of the four commands
109
110     $ echo WORD1
111     - or -
112     $ echo WORD2
113     - or -
114     $ echo WORD3
115     - or -
116     $ echo
117
118 Arguments
119 ---------
120
121 **Mandatory arguments** are enclosed in double curly braces.
122 A simple example would be
123
124     $ type {{ filename }}
125
126 which is to be understood to use the command `type` on some file name
127 determined by the user.
128
129 **Optional Arguments** are enclosed in double square brackets.
130
131     [[ options ]]
132
133 Note that the notation assumes spaces around {, }, [, ], {{, }} and
134 [[, ]].  This is to differentiate from OpenVMS directory
135 specifications, which also use [ and ], but without spaces.
136
137 Quick Installation Guide
138 ========================
139
140 If you just want to get OpenSSL installed without bothering too much
141 about the details, here is the short version of how to build and install
142 OpenSSL.  If any of the following steps fails, please consult the
143 [Installation in Detail](#installation-in-detail) section below.
144
145 Building OpenSSL
146 ----------------
147
148 Use the following commands to configure, build and test OpenSSL.
149 The testing is optional, but recommended if you intend to install
150 OpenSSL for production use.
151
152 ### Unix / Linux / macOS
153
154     $ ./config
155     $ make
156     $ make test
157
158 ### OpenVMS
159
160 Use the following commands to build OpenSSL:
161
162     $ @config
163     $ mms
164     $ mms test
165
166 ### Windows
167
168 If you are using Visual Studio, open a Developer Command Prompt and
169 and issue the following commands to build OpenSSL.
170
171     $ perl Configure { VC-WIN32 | VC-WIN64A | VC-WIN64I | VC-CE }
172     $ nmake
173     $ nmake test
174
175 As mentioned in the [Choices](#choices) section, you need to pick one
176 of the four Configure targets in the first command.
177
178 Most likely you will be using the VC-WIN64A target for 64bit Windows
179 binaries (AMD64) or VC-WIN32 for 32bit Windows binaries (X86).
180 The other two options are VC_WIN64I (Intel IA64, Itanium) and
181 VC-CE (Windows CE) are rather uncommon nowadays.
182
183 Installing OpenSSL
184 ------------------
185
186 The following commands will install OpenSSL to a default system location.
187
188 **Danger Zone:** even if you are impatient, please read the following two
189 paragraphs carefully before you install OpenSSL.
190
191 For security reasons the default system location is by default not writable
192 for unprivileged users.  So for the final installation step administrative
193 privileges are required.  The default system location and the procedure to
194 obtain administrative privileges depends on the operating sytem.
195 It is recommended to compile and test OpenSSL with normal user privileges
196 and use administrative privileges only for the final installation step.
197
198 On some platforms OpenSSL is preinstalled as part of the Operating System.
199 In this case it is highly recommended not to overwrite the system versions,
200 because other applications or libraries might depend on it.
201 To avoid breaking other applications, install your copy of OpenSSL to a
202 [different location](#installing-to-a-different-location) which is not in
203 the global search path for system libraries.
204
205 Finally, if you plan on using the FIPS module, you need to read the
206 [Post-installation Notes](#post-installation-notes) further down.
207
208 ### Unix / Linux / macOS
209
210 Depending on your distribution, you need to run the following command as
211 root user or prepend `sudo` to the command:
212
213     $ make install
214
215 By default, OpenSSL will be installed to
216
217     /usr/local
218
219 More precisely, the files will be installed into the  subdirectories
220
221     /usr/local/bin
222     /usr/local/lib
223     /usr/local/include
224     ...
225
226 depending on the file type, as it is custom on Unix-like operating systems.
227
228 ### OpenVMS
229
230 Use the following command to install OpenSSL.
231
232     $ mms install
233
234 By default, OpenSSL will be installed to
235
236     SYS$COMMON:[OPENSSL-'version'...]
237
238 where 'version' is the OpenSSL version number with underscores instead
239 of periods.
240
241 ### Windows
242
243 If you are using Visual Studio, open the Developer Command Prompt _elevated_
244 and issue the following command.
245
246     $ nmake install
247
248 The easiest way to elevate the Command Prompt is to press and hold down
249 the both the `<CTRL>` and `<SHIFT>` key while clicking the menu item in the
250 task menu.
251
252 The default installation location is
253
254     C:\Program Files\OpenSSL
255
256 for native binaries, or
257
258     C:\Program Files (x86)\OpenSSL
259
260 for 32bit binaries on 64bit Windows (WOW64).
261
262 #### Installing to a different location
263
264 To install OpenSSL to a different location (for example into your home
265 directory for testing purposes) run config as shown in the following
266 examples.
267
268 On Unix:
269
270     $ ./config --prefix=/opt/openssl --openssldir=/usr/local/ssl
271
272 On OpenVMS:
273
274     $ @config --prefix=PROGRAM:[INSTALLS] --openssldir=SYS$MANAGER:[OPENSSL]
275
276 Note: if you do add options to the configuration command, please make sure
277 you've read more than just this Quick Start, such as relevant `NOTES.*` files,
278 the options outline below, as configuration options may change the outcome
279 in otherwise unexpected ways.
280
281 Configuration Options
282 =====================
283
284 There are several options to ./config (or ./Configure) to customize
285 the build (note that for Windows, the defaults for `--prefix` and
286 `--openssldir` depend in what configuration is used and what Windows
287 implementation OpenSSL is built on.  More notes on this in NOTES.WIN):
288
289 API Level
290 ---------
291
292     --api=x.y[.z]
293
294 Build the OpenSSL libraries to support the API for the specified version.
295 If [no-deprecated](#no-deprecated) is also given, don't build with support
296 for deprecated APIs in or below the specified version number.  For example,
297 addding
298
299     --api=1.1.0 no-deprecated
300
301 will remove support for all APIs that were deprecated in OpenSSL version
302 1.1.0 or below.  This is a rather specialized option for developers.
303 If you just intend to remove all deprecated APIs up to the current version
304 entirely, just specify [no-deprecated](#no-deprecated).
305 If `--api` isn't given, it defaults to the current (minor) OpenSSL version.
306
307 Cross Compile Prefix
308 --------------------
309
310     --cross-compile-prefix=PREFIX
311
312 The PREFIX to include in front of commands for your toolchain.
313
314 It is likely to have to end with dash, e.g.  a-b-c- would invoke GNU compiler as
315 a-b-c-gcc, etc.  Unfortunately cross-compiling is too case-specific to put
316 together one-size-fits-all instructions.  You might have to pass more flags or
317 set up environment variables to actually make it work.  Android and iOS cases are
318 discussed in corresponding `Configurations/15-*.conf` files.  But there are cases
319 when this option alone is sufficient.  For example to build the mingw64 target on
320 Linux `--cross-compile-prefix=x86_64-w64-mingw32-` works.  Naturally provided
321 that mingw packages are installed.  Today Debian and Ubuntu users have option to
322 install a number of prepackaged cross-compilers along with corresponding
323 run-time and development packages for "alien" hardware.  To give another example
324 `--cross-compile-prefix=mipsel-linux-gnu-` suffices in such case.  Needless to
325 mention that you have to invoke `./Configure`, not `./config`, and pass your target
326 name explicitly.  Also, note that `--openssldir` refers to target's file system,
327 not one you are building on.
328
329 Build Type
330 ----------
331
332     --debug
333
334 Build OpenSSL with debugging symbols and zero optimization level.
335
336     --release
337
338 Build OpenSSL without debugging symbols.  This is the default.
339
340 Directories
341 -----------
342
343 ### libdir
344
345     --libdir=DIR
346
347 The name of the directory under the top of the installation directory tree
348 (see the `--prefix` option) where libraries will be installed.  By default
349 this is "lib". Note that on Windows only static libraries (`*.lib`) will
350 be stored in this location. Shared libraries (`*.dll`) will always be
351 installed to the "bin" directory.
352
353 ### openssldir
354
355     --openssldir=DIR
356
357 Directory for OpenSSL configuration files, and also the default certificate
358 and key store.  Defaults are:
359
360     Unix:           /usr/local/ssl
361     Windows:        C:\Program Files\Common Files\SSL
362     OpenVMS:        SYS$COMMON:[OPENSSL-COMMON]
363
364 For 32bit Windows applications on Windows 64bit (WOW64), always replace
365 `C:\Program Files` by `C:\Program Files (x86)`.
366
367 ### prefix
368
369     --prefix=DIR
370
371 The top of the installation directory tree.  Defaults are:
372
373     Unix:           /usr/local
374     Windows:        C:\Program Files\OpenSSL
375     OpenVMS:        SYS$COMMON:[OPENSSL-'version']
376
377 Compiler Warnings
378 -----------------
379
380     --strict-warnings
381
382 This is a developer flag that switches on various compiler options recommended
383 for OpenSSL development.  It only works when using gcc or clang as the compiler.
384 If you are developing a patch for OpenSSL then it is recommended that you use
385 this option where possible.
386
387 ZLib Flags
388 ----------
389
390 ### with-zlib-include
391
392     --with-zlib-include=DIR
393
394 The directory for the location of the zlib include file.  This option is only
395 necessary if [enable-zlib](#enable-zlib) is used and the include file is not
396 already on the system include path.
397
398 ### with-zlib-lib
399
400     --with-zlib-lib=LIB
401
402 **On Unix**: this is the directory containing the zlib library.
403 If not provided the system library path will be used.
404
405 **On Windows:** this is the filename of the zlib library (with or
406 without a path).  This flag must be provided if the
407 [zlib-dynamic](#zlib-dynamic) option is not also used.  If zlib-dynamic is used
408 then this flag is optional and defaults to "ZLIB1" if not provided.
409
410 **On VMS:** this is the filename of the zlib library (with or without a path).
411 This flag is optional and if not provided then "GNV$LIBZSHR", "GNV$LIBZSHR32"
412 or "GNV$LIBZSHR64" is used by default depending on the pointer size chosen.
413
414 Seeding the Random Generator
415 ----------------------------
416
417     --with-rand-seed=seed1[,seed2,...]
418
419 A comma separated list of seeding methods which will be tried by OpenSSL
420 in order to obtain random input (a.k.a "entropy") for seeding its
421 cryptographically secure random number generator (CSPRNG).
422 The current seeding methods are:
423
424 ### os
425
426 Use a trusted operating system entropy source.
427 This is the default method if such an entropy source exists.
428
429 ### getrandom
430
431 Use the [getrandom(2)][man-getrandom] or equivalent system call.
432
433 [man-getrandom]: http://man7.org/linux/man-pages/man2/getrandom.2.html
434
435 ### devrandom
436
437 Use the first device from the DEVRANDOM list which can be opened to read
438 random bytes.  The DEVRANDOM preprocessor constant expands to
439
440     "/dev/urandom","/dev/random","/dev/srandom"
441
442 on most unix-ish operating systems.
443
444 ### egd
445
446 Check for an entropy generating daemon.
447
448 ### rdcpu
449
450 Use the RDSEED or RDRAND command if provided by the CPU.
451
452 ### librandom
453
454 Use librandom (not implemented yet).
455
456 ### none
457
458 Disable automatic seeding.  This is the default on some operating systems where
459 no suitable entropy source exists, or no support for it is implemented yet.
460
461 For more information, see the section [Notes on random number generation][rng]
462 at the end of this document.
463
464 [rng]: #notes-on-random-number-generation
465
466 Enable and Disable Features
467 ---------------------------
468
469 Feature options always come in pairs, an option to enable feature xxxx, and
470 and option to disable it:
471
472     [ enable-xxxx | no-xxxx ]
473
474 Whether a feature is enabled or disabled by default, depends on the feature.
475 In the following list, always the non-default variant is documented: if
476 feature xxxx is disabled by default then enable-xxxx is documented and
477 if feature xxxx is enabled by default then no-xxxx is documented.
478
479 ### no-afalgeng
480
481 Don't build the AFALG engine.
482
483 This option will be forced on a platform that does not support AFALG.
484
485 ### enable-ktls
486
487 Build with Kernel TLS support.
488
489 This option will enable the use of the Kernel TLS data-path, which can improve
490 performance and allow for the use of sendfile and splice system calls on
491 TLS sockets.  The Kernel may use TLS accelerators if any are available on the
492 system.  This option will be forced off on systems that do not support the
493 Kernel TLS data-path.
494
495 ### enable-asan
496
497 Build with the Address sanitiser.
498
499 This is a developer option only.  It may not work on all platforms and should
500 never be used in production environments.  It will only work when used with
501 gcc or clang and should be used in conjunction with the [no-shared](#no-shared)
502 option.
503
504 ### no-acvp_tests
505
506 Do not build support for Automated Cryptographic Validation Protocol (ACVP)
507 tests.
508
509 This is required for FIPS validation purposes. Certain ACVP tests require
510 access to algorithm internals that are not normally accessible.
511 Additional information related to ACVP can be found at
512 <https://github.com/usnistgov/ACVP>.
513
514 ### no-asm
515
516 Do not use assembler code.
517
518 This should be viewed as debugging/troubleshooting option rather than for
519 production use.  On some platforms a small amount of assembler code may still
520 be used even with this option.
521
522 ### no-async
523
524 Do not build support for async operations.
525
526 ### no-autoalginit
527
528 Don't automatically load all supported ciphers and digests.
529
530 Typically OpenSSL will make available all of its supported ciphers and digests.
531 For a statically linked application this may be undesirable if small executable
532 size is an objective.  This only affects libcrypto.  Ciphers and digests will
533 have to be loaded manually using EVP_add_cipher() and EVP_add_digest() if this
534 option is used.  This option will force a non-shared build.
535
536 ### no-autoerrinit
537
538 Don't automatically load all libcrypto/libssl error strings.
539
540 Typically OpenSSL will automatically load human readable error strings.  For a
541 statically linked application this may be undesirable if small executable size
542 is an objective.
543
544 ### no-autoload-config
545
546 Don't automatically load the default openssl.cnf file.
547
548 Typically OpenSSL will automatically load a system config file which configures
549 default SSL options.
550
551 ### enable-buildtest-c++
552
553 While testing, generate C++ buildtest files that simply check that the public
554 OpenSSL header files are usable standalone with C++.
555
556 Enabling this option demands extra care.  For any compiler flag given directly
557 as configuration option, you must ensure that it's valid for both the C and
558 the C++ compiler.  If not, the C++ build test will most likely break.  As an
559 alternative, you can use the language specific variables, CFLAGS and CXXFLAGS.
560
561 ### no-capieng
562
563 Don't build the CAPI engine.
564
565 This option will be forced if on a platform that does not support CAPI.
566
567 ### no-cmp
568
569 Don't build support for Certificate Management Protocol (CMP).
570
571 ### no-cms
572
573 Don't build support for Cryptographic Message Syntax (CMS).
574
575 ### no-comp
576
577 Don't build support for SSL/TLS compression.
578
579 If this option is enabled (the default), then compression will only work if
580 the zlib or zlib-dynamic options are also chosen.
581
582 ### enable-crypto-mdebug
583
584 This now only enables the failed-malloc feature.
585
586 ### enable-crypto-mdebug-backtrace
587
588 This is a no-op; the project uses the compiler's address/leak sanitizer instead.
589
590 ### no-ct
591
592 Don't build support for Certificate Transparency (CT).
593
594 ### no-deprecated
595
596 Don't build with support for deprecated APIs up until and including the version
597 given with `--api` (or the current version, if `--api` wasn't specified).
598
599 ### no-dgram
600
601 Don't build support for datagram based BIOs.
602
603 Selecting this option will also force the disabling of DTLS.
604
605 ### no-dso
606
607 Don't build support for loading Dynamic Shared Objects (DSO)
608
609 ### enable-devcryptoeng
610
611 Build the `/dev/crypto` engine.
612
613 This option is automatically selected on the BSD platform, in which case it can
614 be disabled with no-devcryptoeng.
615
616 ### no-dynamic-engine
617
618 Don't build the dynamically loaded engines.
619
620 This only has an effect in a shared build.
621
622 ### no-ec
623
624 Don't build support for Elliptic Curves.
625
626 ### no-ec2m
627
628 Don't build support for binary Elliptic Curves
629
630 ### enable-ec_nistp_64_gcc_128
631
632 Enable support for optimised implementations of some commonly used NIST
633 elliptic curves.
634
635 This option is only supported on platforms:
636
637  - with little-endian storage of non-byte types
638  - that tolerate misaligned memory references
639  - where the compiler:
640    - supports the non-standard type `__uint128_t`
641    - defines the built-in macro `__SIZEOF_INT128__`
642
643 ### enable-egd
644
645 Build support for gathering entropy from the Entropy Gathering Daemon (EGD).
646
647 ### no-engine
648
649 Don't build support for loading engines.
650
651 ### no-err
652
653 Don't compile in any error strings.
654
655 ### enable-external-tests
656
657 Enable building of integration with external test suites.
658
659 This is a developer option and may not work on all platforms.  The following
660 external test suites are currently supported:
661
662  - BoringSSL test suite
663  - Python PYCA/Cryptography test suite
664  - krb5 test suite
665
666 See the file [test/README.external](test/README.external) for further details.
667
668 ### no-filenames
669
670 Don't compile in filename and line number information (e.g.  for errors and
671 memory allocation).
672
673 ### no-fips
674
675 Don't compile the FIPS provider
676
677 ### enable-fuzz-libfuzzer, enable-fuzz-afl
678
679 Build with support for fuzzing using either libfuzzer or AFL.
680
681 These are developer options only.  They may not work on all  platforms and
682 should never be used in production environments.
683
684 See the file [fuzz/README.md](fuzz/README.md) for further details.
685
686 ### no-gost
687
688 Don't build support for GOST based ciphersuites.
689
690 Note that if this feature is enabled then GOST ciphersuites are only available
691 if the GOST algorithms are also available through loading an externally supplied
692 engine.
693
694 ### no-legacy
695
696 Don't build the legacy provider.
697
698 Disabling this also disables the legacy algorithms: MD2 (already disabled by default).
699
700 ### no-makedepend
701
702 Don't generate dependencies.
703
704 ### no-module
705
706 Don't build any dynamically loadable engines.
707
708 This also implies 'no-dynamic-engine'.
709
710 ### no-multiblock
711
712 Don't build support for writing multiple records in one go in libssl
713
714 Note: this is a different capability to the pipelining functionality.
715
716 ### no-nextprotoneg
717
718 Don't build support for the Next Protocol Negotiation (NPN) TLS extension.
719
720 ### no-ocsp
721
722 Don't build support for Online Certificate Status Protocol (OCSP).
723
724 ### no-padlockeng
725
726 Don't build the padlock engine.
727
728 ### no-hw-padlock
729
730 As synonyme for no-padlockeng.  Deprecated and should not be used.
731
732 ### no-pic
733
734 Don't build with support for Position Independent Code.
735
736 ### no-pinshared
737
738 Don't pin the shared libraries.
739
740 By default OpenSSL will attempt to stay in memory until the process exits.
741 This is so that libcrypto and libssl can be properly cleaned up automatically
742 via an atexit() handler.  The handler is registered by libcrypto and cleans
743 up both libraries.  On some platforms the atexit() handler will run on unload of
744 libcrypto (if it has been dynamically loaded) rather than at process exit.  This
745 option can be used to stop OpenSSL from attempting to stay in memory until the
746 process exits.  This could lead to crashes if either libcrypto or libssl have
747 already been unloaded at the point that the atexit handler is invoked, e.g.  on a
748 platform which calls atexit() on unload of the library, and libssl is unloaded
749 before libcrypto then a crash is likely to happen.  Applications can suppress
750 running of the atexit() handler at run time by using the OPENSSL_INIT_NO_ATEXIT
751 option to OPENSSL_init_crypto().  See the man page for it for further details.
752
753 ### no-posix-io
754
755 Don't use POSIX IO capabilities.
756
757 ### no-psk
758
759 Don't build support for Pre-Shared Key based ciphersuites.
760
761 ### no-rdrand
762
763 Don't use hardware RDRAND capabilities.
764
765 ### no-rfc3779
766
767 Don't build support for RFC3779, "X.509 Extensions for IP Addresses and
768 AS Identifiers".
769
770 ### sctp
771
772 Build support for Stream Control Transmission Protocol (SCTP).
773
774 ### no-shared
775
776 Do not create shared libraries, only static ones.
777
778 See [Notes on shared libraries](#notes-on-shared-libraries) below.
779
780 ### no-sock
781
782 Don't build support for socket BIOs.
783
784 ### no-srp
785
786 Don't build support for Secure Remote Password (SRP) protocol or
787 SRP based ciphersuites.
788
789 ### no-srtp
790
791 Don't build Secure Real-Time Transport Protocol (SRTP) support.
792
793 ### no-sse2
794
795 Exclude SSE2 code paths from 32-bit x86 assembly modules.
796
797 Normally SSE2 extension is detected at run-time, but the decision whether or not
798 the machine code will be executed is taken solely on CPU capability vector.  This
799 means that if you happen to run OS kernel which does not support SSE2 extension
800 on Intel P4 processor, then your application might be exposed to "illegal
801 instruction" exception.  There might be a way to enable support in kernel, e.g.
802 FreeBSD kernel can be compiled with CPU_ENABLE_SSE, and there is a way to
803 disengage SSE2 code paths upon application start-up, but if you aim for wider
804 "audience" running such kernel, consider no-sse2.  Both the 386 and no-asm
805 options imply no-sse2.
806
807 ### enable-ssl-trace
808
809 Build with the SSL Trace capabilities.
810
811 This adds the "-trace" option to s_client and s_server.
812
813 ### no-static-engine
814
815 Don't build the statically linked engines.
816
817 This only has an impact when not built "shared".
818
819 ### no-stdio
820
821 Don't use anything from the C header file "stdio.h" that makes use of the "FILE"
822 type.  Only libcrypto and libssl can be built in this way.  Using this option will
823 suppress building the command line applications.  Additionally, since the OpenSSL
824 tests also use the command line applications, the tests will also be skipped.
825
826 ### no-tests
827
828 Don't build test programs or run any tests.
829
830 ### no-threads
831
832 Don't build with support for multi-threaded applications.
833
834 ### threads
835
836 Build with support for multi-threaded applications.  Most platforms will enable
837 this by default.  However if on a platform where this is not the case then this
838 will usually require additional system-dependent options!
839
840 See [Notes on multi-threading](#notes-on-multi-threading) below.
841
842 ### enable-trace
843
844 Build with support for the integrated tracing api.
845
846 See manual pages OSSL_trace_set_channel(3) and OSSL_trace_enabled(3) for details.
847
848 ### no-ts
849
850 Don't build Time Stamping (TS) Authority support.
851
852 ### enable-ubsan
853
854 Build with the Undefined Behaviour sanitiser (UBSAN).
855
856 This is a developer option only.  It may not work on all platforms and should
857 never be used in production environments.  It will only work when used with gcc
858 or clang and should be used in conjunction with the `-DPEDANTIC` option
859 (or the `--strict-warnings` option).
860
861 ### no-ui-console
862
863 Don't build with the User Interface (UI) console method
864
865 The User Interface console method enables text based console prompts.
866
867 ### enable-unit-test
868
869 Enable additional unit test APIs.
870
871 This should not typically be used in production deployments.
872
873 ### no-uplink
874
875 Don't build support for UPLINK interface.
876
877 ### enable-weak-ssl-ciphers
878
879 Build support for SSL/TLS ciphers that are considered "weak"
880
881 Enabling this includes for example the RC4 based ciphersuites.
882
883 ### zlib
884
885 Build with support for zlib compression/decompression.
886
887 ### zlib-dynamic
888
889 Like the zlib option, but has OpenSSL load the zlib library dynamically
890 when needed.
891
892 This is only supported on systems where loading of shared libraries is supported.
893
894 ### 386
895
896 In 32-bit x86 builds, use the 80386 instruction set only in assembly modules
897
898 The default x86 code is more efficient, but requires at least an 486 processor.
899 Note: This doesn't affect compiler generated code, so this option needs to be
900 accompanied by a corresponding compiler-specific option.
901
902 ### no-{protocol}
903
904     no-{ssl|ssl3|tls|tls1|tls1_1|tls1_2|tls1_3|dtls|dtls1|dtls1_2}
905
906 Don't build support for negotiating the specified SSL/TLS protocol.
907
908 If "no-tls" is selected then all of tls1, tls1_1, tls1_2 and tls1_3 are disabled.
909 Similarly "no-dtls" will disable dtls1 and dtls1_2.  The "no-ssl" option is
910 synonymous with "no-ssl3".  Note this only affects version negotiation.
911 OpenSSL will still provide the methods for applications to explicitly select
912 the individual protocol versions.
913
914 ### no-{protocol}-method
915
916     no-{ssl|ssl3|tls|tls1|tls1_1|tls1_2|tls1_3|dtls|dtls1|dtls1_2}-method
917
918 Analogous to no-{protocol} but in addition do not build the methods for
919 applications to explicitly select individual protocol versions.  Note that there
920 is no "no-tls1_3-method" option because there is no application method for
921 TLSv1.3.
922
923 Using individual protocol methods directly is deprecated.  Applications should
924 use TLS_method() instead.
925
926 ### enable-{algorithm}
927
928     enable-{md2|rc5}
929
930 Build with support for the specified algorithm.
931
932 ### no-{algorithm}
933
934     no-{aria|bf|blake2|camellia|cast|chacha|cmac|
935         des|dh|dsa|ecdh|ecdsa|idea|md4|mdc2|ocb|
936         poly1305|rc2|rc4|rmd160|scrypt|seed|
937         siphash|siv|sm2|sm3|sm4|whirlpool}
938
939 Build without support for the specified algorithm.
940
941 The "ripemd" algorithm is deprecated and if used is synonymous with rmd160.
942
943 ### Compiler-specific options
944
945     -Dxxx, -Ixxx, -Wp, -lxxx, -Lxxx, -Wl, -rpath, -R, -framework, -static
946
947 These system specific options will be recognised and passed through to the
948 compiler to allow you to define preprocessor symbols, specify additional
949 libraries, library directories or other compiler options.  It might be worth
950 noting that some compilers generate code specifically for processor the
951 compiler currently executes on.  This is not necessarily what you might have
952 in mind, since it might be unsuitable for execution on other, typically older,
953 processor.  Consult your compiler documentation.
954
955 Take note of the [Environment Variables](#environment-variables) documentation
956 below and how these flags interact with those variables.
957
958     -xxx, +xxx, /xxx
959
960 Additional options that are not otherwise recognised are passed through as
961 they are to the compiler as well.  Unix-style options beginning with a
962 '-' or '+' and Windows-style options beginning with a '/' are recognized.
963 Again, consult your compiler documentation.
964
965 If the option contains arguments separated by spaces, then the URL-style
966 notation %20 can be used for the space character in order to avoid having
967 to quote the option.  For example, -opt%20arg gets expanded to -opt arg.
968 In fact, any ASCII character can be encoded as %xx using its hexadecimal
969 encoding.
970
971 Take note of the [Environment Variables](#environment-variables) documentation
972 below and how these flags interact with those variables.
973
974 ### Environment Variables
975
976     VAR=value
977
978 Assign the given value to the environment variable VAR for Configure.
979
980 These work just like normal environment variable assignments, but are supported
981 on all platforms and are confined to the configuration scripts only.
982 These assignments override the corresponding value in the inherited environment,
983 if there is one.
984
985 The following variables are used as "make variables" and can be used as an
986 alternative to giving preprocessor, compiler and linker options directly as
987 configuration.  The following variables are supported:
988
989     AR              The static library archiver.
990     ARFLAGS         Flags for the static library archiver.
991     AS              The assembler compiler.
992     ASFLAGS         Flags for the assembler compiler.
993     CC              The C compiler.
994     CFLAGS          Flags for the C compiler.
995     CXX             The C++ compiler.
996     CXXFLAGS        Flags for the C++ compiler.
997     CPP             The C/C++ preprocessor.
998     CPPFLAGS        Flags for the C/C++ preprocessor.
999     CPPDEFINES      List of CPP macro definitions, separated
1000                     by a platform specific character (':' or
1001                     space for Unix, ';' for Windows, ',' for
1002                     VMS).  This can be used instead of using
1003                     -D (or what corresponds to that on your
1004                     compiler) in CPPFLAGS.
1005     CPPINCLUDES     List of CPP inclusion directories, separated
1006                     the same way as for CPPDEFINES.  This can
1007                     be used instead of -I (or what corresponds
1008                     to that on your compiler) in CPPFLAGS.
1009     HASHBANGPERL    Perl invocation to be inserted after '#!'
1010                     in public perl scripts (only relevant on
1011                     Unix).
1012     LD              The program linker (not used on Unix, $(CC)
1013                     is used there).
1014     LDFLAGS         Flags for the shared library, DSO and
1015                     program linker.
1016     LDLIBS          Extra libraries to use when linking.
1017                     Takes the form of a space separated list
1018                     of library specifications on Unix and
1019                     Windows, and as a comma separated list of
1020                     libraries on VMS.
1021     RANLIB          The library archive indexer.
1022     RC              The Windows resource compiler.
1023     RCFLAGS         Flags for the Windows resource compiler.
1024     RM              The command to remove files and directories.
1025
1026 These cannot be mixed with compiling/linking flags given on the command line.
1027 In other words, something like this isn't permitted.
1028
1029     ./config -DFOO CPPFLAGS=-DBAR -DCOOKIE
1030
1031 Backward compatibility note:
1032
1033 To be compatible with older configuration scripts, the environment variables
1034 are ignored if compiling/linking flags are given on the command line, except
1035 for the following:
1036
1037     AR, CC, CXX, CROSS_COMPILE, HASHBANGPERL, PERL, RANLIB, RC, and WINDRES
1038
1039 For example, the following command will not see -DBAR:
1040
1041     CPPFLAGS=-DBAR ./config -DCOOKIE
1042
1043 However, the following will see both set variables:
1044
1045     CC=gcc CROSS_COMPILE=x86_64-w64-mingw32- ./config -DCOOKIE
1046
1047 If CC is set, it is advisable to also set CXX to ensure both the C and C++
1048 compiler are in the same "family".  This becomes relevant with
1049 'enable-external-tests' and 'enable-buildtest-c++'.
1050
1051 ### Reconfigure
1052
1053     reconf
1054     reconfigure
1055
1056 Reconfigure from earlier data.
1057
1058 This fetches the previous command line options and environment from data saved
1059 in "configdata.pm" and runs the configuration process again, using these
1060 options and environment.  Note: NO other option is permitted together with
1061 "reconf".  This means that you also MUST use "./Configure" (or what corresponds
1062 to that on non-Unix platforms) directly to invoke this option.  Note: The
1063 original configuration saves away values for ALL environment variables that were
1064 used, and if they weren't defined, they are still saved away with information
1065 that they weren't originally defined.  This information takes precedence over
1066 environment variables that are defined when reconfiguring.
1067
1068 Displaying configuration data
1069 -----------------------------
1070
1071 The configuration script itself will say very little, and finishes by
1072 creating "configdata.pm".  This perl module can be loaded by other scripts
1073 to find all the configuration data, and it can also be used as a script to
1074 display all sorts of configuration data in a human readable form.
1075
1076 For more information, please do:
1077
1078     $ ./configdata.pm --help                         # Unix
1079
1080 or
1081
1082     $ perl configdata.pm --help                      # Windows and VMS
1083
1084 Installation Steps in Detail
1085 ============================
1086
1087 Configure OpenSSL
1088 -----------------
1089
1090 ### Automatic Configuration
1091
1092 On some platform a `config` script is available which attempts to guess
1093 your operating system (and compiler, if necessary) and calls the `Configure`
1094 Perl script with appropriate target based on its guess.  Further options can
1095 be supplied to the `config` script, which will be passed on to the `Configure`
1096 script.
1097
1098 #### Unix / Linux / macOS
1099
1100     $ ./config [[ options ]]
1101
1102 #### OpenVMS
1103
1104     $ @config [[ options ]]
1105
1106 #### Windows
1107
1108 Automatic configuration is not available on Windows.
1109
1110 For the remainder of this text, the Unix form will be used in all examples,
1111 please use the appropriate form for your platform.
1112
1113 You can run
1114
1115     $ ./config -t
1116
1117 to see whether your target is guessed correctly.  If you want to use a different
1118 compiler, you  are cross-compiling for another platform, or the ./config guess
1119 was wrong for other reasons, see the [Manual Configuration](#manual-configuration)
1120 section.  Oherwise continue with the [Build OpenSSL](#build-openssl) section below.
1121
1122 On some systems, you can include debugging information as follows:
1123
1124       $ ./config -d [[ options ]]
1125
1126 ### Manual Configuration
1127
1128 OpenSSL knows about a range of different operating system, hardware and
1129 compiler combinations.  To see the ones it knows about, run
1130
1131     $ ./Configure                                    # Unix
1132
1133 or
1134
1135     $ perl Configure                                 # All other platforms
1136
1137 For the remainder of this text, the Unix form will be used in all examples.
1138 Please use the appropriate form for your platform.
1139
1140 Pick a suitable name from the list that matches your system.  For most
1141 operating systems there is a choice between using "cc" or "gcc".
1142 When you have identified your system (and if necessary compiler) use this
1143 name as the argument to Configure.  For example, a "linux-elf" user would
1144 run:
1145
1146     $ ./Configure linux-elf [[ options ]]
1147
1148 ### Creating your own Configuration
1149
1150 If your system isn't listed, you will have to create a configuration
1151 file named Configurations/{{ something }}.conf and add the correct
1152 configuration for your system.  See the available configs as examples
1153 and read Configurations/README and Configurations/README.design for
1154 more information.
1155
1156 The generic configurations "cc" or "gcc" should usually work on 32 bit
1157 Unix-like systems.
1158
1159 Configure creates a build file ("Makefile" on Unix, "makefile" on Windows
1160 and "descrip.mms" on OpenVMS) from a suitable template in Configurations,
1161 and defines various macros in include/openssl/configuration.h (generated
1162 from include/openssl/configuration.h.in).
1163
1164 ### Out of Tree Builds
1165
1166 OpenSSL can be configured to build in a build directory separate from the
1167 source code directory.  It's done by placing yourself in some other
1168 directory and invoking the configuration commands from there.
1169
1170 #### Unix example
1171
1172     $ mkdir /var/tmp/openssl-build
1173     $ cd /var/tmp/openssl-build
1174     $ /PATH/TO/OPENSSL/SOURCE/config [[ options ]]
1175
1176 or
1177
1178     $ /PATH/TO/OPENSSL/SOURCE/Configure {{ target }} [[ options ]]
1179
1180 #### OpenVMS example
1181
1182     $ set default sys$login:
1183     $ create/dir [.tmp.openssl-build]
1184     $ set default [.tmp.openssl-build]
1185     $ @[PATH.TO.OPENSSL.SOURCE]config [[ options ]]
1186
1187 or
1188
1189     $ @[PATH.TO.OPENSSL.SOURCE]Configure {{ target }} [[ options ]]
1190
1191 #### Windows example
1192
1193     $ C:
1194     $ mkdir \temp-openssl
1195     $ cd \temp-openssl
1196     $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure {{ target }} [[ options ]]
1197
1198 Paths can be relative just as well as absolute.  Configure will do its best
1199 to translate them to relative paths whenever possible.
1200
1201 Build OpenSSL
1202 -------------
1203
1204 Build OpenSSL by running:
1205
1206     $ make                                           # Unix
1207     $ mms                                            ! (or mmk) OpenVMS
1208     $ nmake                                          # Windows
1209
1210 This will build the OpenSSL libraries (libcrypto.a and libssl.a on
1211 Unix, corresponding on other platforms) and the OpenSSL binary
1212 ("openssl").  The libraries will be built in the top-level directory,
1213 and the binary will be in the "apps" subdirectory.
1214
1215 If the build fails, take a look at the [Build Failures](#build-failures)
1216 subsection of the [Troubleshooting](#troubleshooting) section.
1217
1218 Test OpenSSL
1219 ------------
1220
1221 After a successful build, and before installing, the libraries should
1222 be tested.  Run:
1223
1224     $ make test                                      # Unix
1225     $ mms test                                       ! OpenVMS
1226     $ nmake test                                     # Windows
1227
1228 **Warning:** you MUST run the tests from an unprivileged account (or disable
1229 your privileges temporarily if your platform allows it).
1230
1231 If some tests fail, take a look at the [Test Failures](#test-failures)
1232 subsection of the [Troubleshooting](#troubleshooting) section.
1233
1234 Install OpenSSL
1235 ---------------
1236
1237 If everything tests ok, install OpenSSL with
1238
1239     $ make install                                   # Unix
1240     $ mms install                                    ! OpenVMS
1241     $ nmake install                                  # Windows
1242
1243 Note that in order to perform the install step above you need to have
1244 appropriate permissions to write to the installation directory.
1245
1246 The above commands will install all the software components in this
1247 directory tree under PREFIX (the directory given with `--prefix` or
1248 its default):
1249
1250 ### Unix / Linux / macOS
1251
1252     bin/           Contains the openssl binary and a few other
1253                    utility scripts.
1254     include/openssl
1255                    Contains the header files needed if you want
1256                    to build your own programs that use libcrypto
1257                    or libssl.
1258     lib            Contains the OpenSSL library files.
1259     lib/engines    Contains the OpenSSL dynamically loadable engines.
1260
1261     share/man/man1 Contains the OpenSSL command line man-pages.
1262     share/man/man3 Contains the OpenSSL library calls man-pages.
1263     share/man/man5 Contains the OpenSSL configuration format man-pages.
1264     share/man/man7 Contains the OpenSSL other misc man-pages.
1265
1266     share/doc/openssl/html/man1
1267     share/doc/openssl/html/man3
1268     share/doc/openssl/html/man5
1269     share/doc/openssl/html/man7
1270                    Contains the HTML rendition of the man-pages.
1271
1272 ### OpenVMS
1273
1274 'arch' is replaced with the architecture name, "Alpha" or "ia64",
1275 'sover' is replaced with the shared library version (0101 for 1.1), and
1276 'pz' is replaced with the pointer size OpenSSL was built with:
1277
1278     [.EXE.'arch']  Contains the openssl binary.
1279     [.EXE]         Contains a few utility scripts.
1280     [.include.openssl]
1281                    Contains the header files needed if you want
1282                    to build your own programs that use libcrypto
1283                    or libssl.
1284     [.LIB.'arch']  Contains the OpenSSL library files.
1285     [.ENGINES'sover''pz'.'arch']
1286                    Contains the OpenSSL dynamically loadable engines.
1287     [.SYS$STARTUP] Contains startup, login and shutdown scripts.
1288                    These define appropriate logical names and
1289                    command symbols.
1290     [.SYSTEST]     Contains the installation verification procedure.
1291     [.HTML]        Contains the HTML rendition of the manual pages.
1292
1293 ### Additional Directories
1294
1295 Additionally, install will add the following directories under
1296 OPENSSLDIR (the directory given with `--openssldir` or its default)
1297 for you convenience:
1298
1299     certs          Initially empty, this is the default location
1300                    for certificate files.
1301     private        Initially empty, this is the default location
1302                    for private key files.
1303     misc           Various scripts.
1304
1305 The installation directory should be appropriately protected to ensure
1306 unprivileged users cannot make changes to OpenSSL binaries or files, or
1307 install engines.  If you already have a pre-installed version of OpenSSL as
1308 part of your Operating System it is recommended that you do not overwrite
1309 the system version and instead install to somewhere else.
1310
1311 Package builders who want to configure the library for standard locations,
1312 but have the package installed somewhere else so that it can easily be
1313 packaged, can use
1314
1315   $ make DESTDIR=/tmp/package-root install         # Unix
1316   $ mms/macro="DESTDIR=TMP:[PACKAGE-ROOT]" install ! OpenVMS
1317
1318 The specified destination directory will be prepended to all installation
1319 target paths.
1320
1321 Compatibility issues with previous OpenSSL versions
1322 ---------------------------------------------------
1323
1324 ### COMPILING existing applications
1325
1326 Starting with version 1.1.0, OpenSSL hides a number of structures that were
1327 previously open.  This includes all internal libssl structures and a number
1328 of EVP types.  Accessor functions have been added to allow controlled access
1329 to the structures' data.
1330
1331 This means that some software needs to be rewritten to adapt to the new ways
1332 of doing things.  This often amounts to allocating an instance of a structure
1333 explicitly where you could previously allocate them on the stack as automatic
1334 variables, and using the provided accessor functions where you would previously
1335 access a structure's field directly.
1336
1337 Some APIs have changed as well.  However, older APIs have been preserved when
1338 possible.
1339
1340 Post-installation Notes
1341 -----------------------
1342
1343 With the default OpenSSL installation comes a FIPS provider module, which
1344 needs some post-installation attention, without which it will not be usable.
1345 This involves using the following command:
1346
1347     openssl fipsinstall
1348
1349 See the openssl-fipsinstall(1) manual for details and examples.
1350
1351 Advanced Build Options
1352 ======================
1353
1354 Environment Variables
1355 ---------------------
1356
1357 A number of environment variables can be used to provide additional control
1358 over the build process.  Typically these should be defined prior to running
1359 config or Configure.  Not all environment variables are relevant to all
1360 platforms.
1361
1362     AR
1363                    The name of the ar executable to use.
1364
1365     BUILDFILE
1366                    Use a different build file name than the platform default
1367                    ("Makefile" on Unix-like platforms, "makefile" on native Windows,
1368                    "descrip.mms" on OpenVMS).  This requires that there is a
1369                    corresponding build file template.  See Configurations/README
1370                    for further information.
1371
1372     CC
1373                    The compiler to use. Configure will attempt to pick a default
1374                    compiler for your platform but this choice can be overridden
1375                    using this variable. Set it to the compiler executable you wish
1376                    to use, e.g. "gcc" or "clang".
1377
1378     CROSS_COMPILE
1379                    This environment variable has the same meaning as for the
1380                    "--cross-compile-prefix" Configure flag described above. If both
1381                    are set then the Configure flag takes precedence.
1382
1383     NM
1384                    The name of the nm executable to use.
1385
1386     OPENSSL_LOCAL_CONFIG_DIR
1387                    OpenSSL comes with a database of information about how it
1388                    should be built on different platforms as well as build file
1389                    templates for those platforms. The database is comprised of
1390                    ".conf" files in the Configurations directory.  The build
1391                    file templates reside there as well as ".tmpl" files. See the
1392                    file Configurations/README for further information about the
1393                    format of ".conf" files as well as information on the ".tmpl"
1394                    files.
1395                    In addition to the standard ".conf" and ".tmpl" files, it is
1396                    possible to create your own ".conf" and ".tmpl" files and store
1397                    them locally, outside the OpenSSL source tree. This environment
1398                    variable can be set to the directory where these files are held
1399                    and will be considered by Configure before it looks in the
1400                    standard directories.
1401
1402     PERL
1403                    The name of the Perl executable to use when building OpenSSL.
1404                    This variable is used in config script only. Configure on the
1405                    other hand imposes the interpreter by which it itself was
1406                    executed on the whole build procedure.
1407
1408     HASHBANGPERL
1409                    The command string for the Perl executable to insert in the
1410                    #! line of perl scripts that will be publicly installed.
1411                    Default: /usr/bin/env perl
1412                    Note: the value of this variable is added to the same scripts
1413                    on all platforms, but it's only relevant on Unix-like platforms.
1414
1415     RC
1416                    The name of the rc executable to use. The default will be as
1417                    defined for the target platform in the ".conf" file. If not
1418                    defined then "windres" will be used. The WINDRES environment
1419                    variable is synonymous to this. If both are defined then RC
1420                    takes precedence.
1421
1422     RANLIB
1423                    The name of the ranlib executable to use.
1424
1425     WINDRES
1426                    See RC.
1427
1428 Makefile Targets
1429 ----------------
1430
1431 The Configure script generates a Makefile in a format relevant to the specific
1432 platform.  The Makefiles provide a number of targets that can be used.  Not all
1433 targets may be available on all platforms.  Only the most common targets are
1434 described here.  Examine the Makefiles themselves for the full list.
1435
1436     all
1437                    The target to build all the software components and
1438                    documentation.
1439
1440     build_sw
1441                    Build all the software components.
1442                    THIS IS THE DEFAULT TARGET.
1443
1444     build_docs
1445                    Build all documentation components.
1446
1447     clean
1448                    Remove all build artefacts and return the directory to a "clean"
1449                    state.
1450
1451     depend
1452                    Rebuild the dependencies in the Makefiles. This is a legacy
1453                    option that no longer needs to be used since OpenSSL 1.1.0.
1454
1455     install
1456                    Install all OpenSSL components.
1457
1458     install_sw
1459                    Only install the OpenSSL software components.
1460
1461     install_docs
1462                    Only install the OpenSSL documentation components.
1463
1464     install_man_docs
1465                    Only install the OpenSSL man pages (Unix only).
1466
1467     install_html_docs
1468                    Only install the OpenSSL html documentation.
1469
1470     list-tests
1471                    Prints a list of all the self test names.
1472
1473     test
1474                    Build and run the OpenSSL self tests.
1475
1476     uninstall
1477                    Uninstall all OpenSSL components.
1478
1479     reconfigure
1480     reconf
1481                    Re-run the configuration process, as exactly as the last time
1482                    as possible.
1483
1484     update
1485                    This is a developer option. If you are developing a patch for
1486                    OpenSSL you may need to use this if you want to update
1487                    automatically generated files; add new error codes or add new
1488                    (or change the visibility of) public API functions. (Unix only).
1489
1490 Running Selected Tests
1491 ----------------------
1492
1493 The make variable TESTS supports a versatile set of space separated tokens
1494 with which you can specify a set of tests to be performed.  With a "current
1495 set of tests" in mind, initially being empty, here are the possible tokens:
1496
1497      alltests      The current set of tests becomes the whole set of available
1498                    tests (as listed when you do 'make list-tests' or similar).
1499
1500      xxx           Adds the test 'xxx' to the current set of tests.
1501
1502     -xxx           Removes 'xxx' from the current set of tests.  If this is the
1503                    first token in the list, the current set of tests is first
1504                    assigned the whole set of available tests, effectively making
1505                    this token equivalent to TESTS="alltests -xxx".
1506
1507      nn            Adds the test group 'nn' (which is a number) to the current
1508                    set of tests.
1509
1510     -nn            Removes the test group 'nn' from the current set of tests.
1511                    If this is the first token in the list, the current set of
1512                    tests is first assigned the whole set of available tests,
1513                    effectively making this token equivalent to
1514                    TESTS="alltests -xxx".
1515
1516 Also, all tokens except for "alltests" may have wildcards, such as *.
1517 (on Unix and Windows, BSD style wildcards are supported, while on VMS,
1518 it's VMS style wildcards)
1519
1520 ### Examples
1521
1522 Run all tests except for the fuzz tests:
1523
1524     $ make TESTS=-test_fuzz test
1525
1526 or, if you want to be explicit:
1527
1528     $ make TESTS='alltests -test_fuzz' test
1529
1530 Run all tests that have a name starting with "test_ssl" but not those
1531 starting with "test_ssl_":
1532
1533     $ make TESTS='test_ssl* -test_ssl_*' test
1534
1535 Run only test group 10:
1536
1537     $ make TESTS='10'
1538
1539 Run all tests except the slow group (group 99):
1540
1541     $ make TESTS='-99'
1542
1543 Run all tests in test groups 80 to 99 except for tests in group 90:
1544
1545     $ make TESTS='[89]? -90'
1546
1547 To stochastically verify that the algorithm that produces uniformly distributed
1548 random numbers is operating correctly (with a false positive rate of 0.01%):
1549
1550     $ ./util/wrap.sh test/bntest -stochastic
1551
1552 Troubleshooting
1553 ===============
1554
1555 Configuration Problems
1556 ----------------------
1557
1558 ### Selecting the correct target
1559
1560 The `./config` script tries hard to guess your operating system, but in some
1561 cases it does not succeed. You will see a message like the following:
1562
1563     ./config
1564     Operating system: x86-whatever-minix
1565     This system (minix) is not supported. See file INSTALL for details.
1566
1567 Even if the automatic target selection by the `./config` script fails, chances
1568 are that you still might find a suitable target in the Configurations directory,
1569 which you can supply to the `./Configure` command, possibly after some adjustment.
1570
1571 The Configurations directory contains a lot of examples of such targets.
1572 The main configuration file is [10-main.conf][], which contains all targets that
1573 are officially supported by the OpenSSL team. Other configuration files contain
1574 targets contributed by other OpenSSL users. The list of targets can be found in
1575 a Perl list `my %targets = ( ... )`.
1576
1577     my %targets = (
1578     ...
1579     "target-name" => {
1580         inherit_from     => [ "base-target" ],
1581         CC               => "...",
1582         cflags           => add("..."),
1583         asm_arch         => '...',
1584         perlasm_scheme   => "...",
1585     },
1586     ...
1587     )
1588
1589 If you call `.\Configure` without arguments, it will give you a list of all
1590 known targets. Using `grep`, you can lookup the target definition in the
1591 Configurations directory. For example the "android-x86_64" can be found in
1592 Configurations/15-android.conf.
1593
1594 The directory contains two README files, which explain the general syntax and
1595 design of the configurations files.
1596
1597  - [Configurations/README](Configurations/README)
1598  - [Configurations/README.design](Configurations/README.design)
1599
1600 If you need further help, try to search the [openssl-users][] mailing list
1601 or the [GitHub Issues][] for existing solutions. If you don't find anything,
1602 you can [raise an issue][] to ask a question yourself.
1603
1604 More about our support resources can be found in the [SUPPORT][] file.
1605
1606 ### Configuration Errors
1607
1608 If the `./config` or `./Configure`  command fails with an error message,
1609 read the error message carefully and try to figure out whether you made
1610 a mistake (e.g., by providing a wrong option), or whether the script is
1611 working incorrectly. If you think you encountered a bug, please
1612 [raise an issue][] on GitHub to file a bug report.
1613
1614 Along with a short description of the bug, please provide the complete
1615 configure command line and the relevant output including the error message.
1616
1617 Note: To make the output readable, pleace add a 'code fence' (three backquotes
1618 ` ``` ` on a separate line) before and after your output:
1619
1620      ```
1621      ./Configure [your arguments...]
1622
1623      [output...]
1624
1625      ```
1626
1627 Build Failures
1628 --------------
1629
1630 If the build fails, look carefully at the output. Try to locate and understand
1631 the error message. It might be that the compiler is already telling you
1632 exactly what you need to do to fix your problem.
1633
1634 There may be reasons for the failure that aren't problems in OpenSSL itself,
1635 for example if the compiler reports missing standard or third party headers.
1636
1637 If the build succeeded previously, but fails after a source or configuration
1638 change, it might be helpful to clean the build tree before attempting another
1639 build.  Use this command:
1640
1641     make clean                                     # Unix
1642     mms clean                                      ! (or mmk) OpenVMS
1643     nmake clean                                    # Windows
1644
1645 Assembler error messages can sometimes be sidestepped by using the
1646 "no-asm" configuration option.
1647
1648 Compiling parts of OpenSSL with gcc and others with the system compiler will
1649 result in unresolved symbols on some systems.
1650
1651 If you are still having problems, try to search the [openssl-users][] mailing
1652 list or the [GitHub Issues][] for existing solutions. If you think you
1653 encountered an OpenSSL bug, please [raise an issue][] to file a bug report.
1654 Please take the time to review the existing issues first; maybe the bug was
1655 already reported or has already been fixed.
1656
1657 Test Failures
1658 -------------
1659
1660 If some tests fail, look at the output.  There may be reasons for the failure
1661 that isn't a problem in OpenSSL itself (like an OS malfunction or a Perl issue).
1662 You may want increased verbosity, that can be accomplished like this:
1663
1664 Full verbosity (`make` macro `VERBOSE` or `V`):
1665
1666     make V=1 test                                  # Unix
1667     mms /macro=(V=1) test                          ! OpenVMS
1668     nmake V=1 test                                 # Windows
1669
1670 Verbosity on test failure (`VERBOSE_FAILURE` or `VF´, Unix example shown):
1671
1672     make test VF=1
1673
1674 Verbosity on failed (sub-)tests only (`VERBOSE_FAILURES_ONLY` or `VFO`):
1675
1676     make test VFO=1
1677
1678 Verbosity on failed (sub-)tests, in addition progress on succeeded (sub-)tests
1679 (`VERBOSE_FAILURES_PROGRESS` or `VFP`):
1680
1681     make test VFP=1
1682
1683 If you want to run just one or a few specific tests, you can use
1684 the make variable TESTS to specify them, like this:
1685
1686     make TESTS='test_rsa test_dsa' test            # Unix
1687     mms/macro="TESTS=test_rsa test_dsa" test       ! OpenVMS
1688     nmake TESTS='test_rsa test_dsa' test           # Windows
1689
1690 And of course, you can combine (Unix examples shown):
1691
1692     make test TESTS='test_rsa test_dsa' VF=1
1693     make test TESTS="test_cmp_*" VFO=1
1694
1695 You can find the list of available tests like this:
1696
1697     make list-tests                                # Unix
1698     mms list-tests                                 ! OpenVMS
1699     nmake list-tests                               # Windows
1700
1701 Have a look at the manual for the perl module Test::Harness to
1702 see what other HARNESS_* variables there are.
1703
1704 If you find a problem with OpenSSL itself, try removing any
1705 compiler optimization flags from the CFLAGS line in Makefile and
1706 run "make clean; make" or corresponding.
1707
1708 To report a bug please open an issue on GitHub, at
1709 <https://github.com/openssl/openssl/issues>.
1710
1711 For more details on how the make variables TESTS can be used,
1712 see section [Running Selected Tests](#running-selected-tests) below.
1713
1714 Notes
1715 =====
1716
1717 Notes on multi-threading
1718 ------------------------
1719
1720 For some systems, the OpenSSL Configure script knows what compiler options
1721 are needed to generate a library that is suitable for multi-threaded
1722 applications.  On these systems, support for multi-threading is enabled
1723 by default; use the "no-threads" option to disable (this should never be
1724 necessary).
1725
1726 On other systems, to enable support for multi-threading, you will have
1727 to specify at least two options: "threads", and a system-dependent option.
1728 (The latter is "-D_REENTRANT" on various systems.)  The default in this
1729 case, obviously, is not to include support for multi-threading (but
1730 you can still use "no-threads" to suppress an annoying warning message
1731 from the Configure script.)
1732
1733 OpenSSL provides built-in support for two threading models: pthreads (found on
1734 most UNIX/Linux systems), and Windows threads.  No other threading models are
1735 supported.  If your platform does not provide pthreads or Windows threads then
1736 you should Configure with the "no-threads" option.
1737
1738 Notes on shared libraries
1739 -------------------------
1740
1741 For most systems the OpenSSL Configure script knows what is needed to
1742 build shared libraries for libcrypto and libssl.  On these systems
1743 the shared libraries will be created by default.  This can be suppressed and
1744 only static libraries created by using the "no-shared" option.  On systems
1745 where OpenSSL does not know how to build shared libraries the "no-shared"
1746 option will be forced and only static libraries will be created.
1747
1748 Shared libraries are named a little differently on different platforms.
1749 One way or another, they all have the major OpenSSL version number as
1750 part of the file name, i.e.  for OpenSSL 1.1.x, 1.1 is somehow part of
1751 the name.
1752
1753 On most POSIX platforms, shared libraries are named libcrypto.so.1.1
1754 and libssl.so.1.1.
1755
1756 on Cygwin, shared libraries are named cygcrypto-1.1.dll and cygssl-1.1.dll
1757 with import libraries libcrypto.dll.a and libssl.dll.a.
1758
1759 On Windows build with MSVC or using MingW, shared libraries are named
1760 libcrypto-1_1.dll and libssl-1_1.dll for 32-bit Windows, libcrypto-1_1-x64.dll
1761 and libssl-1_1-x64.dll for 64-bit x86_64 Windows, and libcrypto-1_1-ia64.dll
1762 and libssl-1_1-ia64.dll for IA64 Windows.  With MSVC, the import libraries
1763 are named libcrypto.lib and libssl.lib, while with MingW, they are named
1764 libcrypto.dll.a and libssl.dll.a.
1765
1766 On VMS, shareable images (VMS speak for shared libraries) are named
1767 ossl$libcrypto0101_shr.exe and ossl$libssl0101_shr.exe.  However, when
1768 OpenSSL is specifically built for 32-bit pointers, the shareable images
1769 are named ossl$libcrypto0101_shr32.exe and ossl$libssl0101_shr32.exe
1770 instead, and when built for 64-bit pointers, they are named
1771 ossl$libcrypto0101_shr64.exe and ossl$libssl0101_shr64.exe.
1772
1773 Notes on random number generation
1774 ---------------------------------
1775
1776 Availability of cryptographically secure random numbers is required for
1777 secret key generation.  OpenSSL provides several options to seed the
1778 internal CSPRNG.  If not properly seeded, the internal CSPRNG will refuse
1779 to deliver random bytes and a "PRNG not seeded error" will occur.
1780
1781 The seeding method can be configured using the `--with-rand-seed` option,
1782 which can be used to specify a comma separated list of seed methods.
1783 However in most cases OpenSSL will choose a suitable default method,
1784 so it is not necessary to explicitly provide this option.  Note also
1785 that not all methods are available on all platforms.
1786
1787 I) On operating systems which provide a suitable randomness source (in
1788 form  of a system call or system device), OpenSSL will use the optimal
1789 available  method to seed the CSPRNG from the operating system's
1790 randomness sources.  This corresponds to the option `--with-rand-seed=os`.
1791
1792 II) On systems without such a suitable randomness source, automatic seeding
1793 and reseeding is disabled (--with-rand-seed=none) and it may be necessary
1794 to install additional support software to obtain a random seed and reseed
1795 the CSPRNG manually.  Please check out the manual pages for RAND_add(),
1796 RAND_bytes(), RAND_egd(), and the FAQ for more information.
1797
1798 <!-- Links  -->
1799
1800 [openssl-users]:
1801     <https://mta.openssl.org/mailman/listinfo/openssl-users>
1802
1803 [SUPPORT]:
1804     ./SUPPORT.md
1805
1806 [GitHub Issues]:
1807     <https://github.com/openssl/openssl/issues>
1808
1809 [raise an issue]:
1810     <https://github.com/openssl/openssl/issues/new/choose>
1811
1812 [10-main.conf]:
1813     Configurations/10-main.conf