Constify param builder string functions.
[openssl.git] / INSTALL
1  OPENSSL INSTALLATION
2  --------------------
3
4  This document describes installation on all supported operating
5  systems (the Unix/Linux family (which includes Mac OS/X), OpenVMS,
6  and Windows).
7
8  To install OpenSSL, you will need:
9
10   * A make implementation
11   * Perl 5 with core modules (please read NOTES.PERL)
12   * The perl module Text::Template (please read NOTES.PERL)
13   * an ANSI C compiler
14   * a development environment in the form of development libraries and C
15     header files
16   * a supported operating system
17
18  For additional platform specific requirements, solutions to specific
19  issues and other details, please read one of these:
20
21   * NOTES.UNIX (any supported Unix like system)
22   * NOTES.VMS (OpenVMS)
23   * NOTES.WIN (any supported Windows)
24   * NOTES.DJGPP (DOS platform with DJGPP)
25   * NOTES.ANDROID (obviously Android [NDK])
26   * NOTES.VALGRIND (testing with Valgrind)
27
28  Notational conventions in this document
29  ---------------------------------------
30
31  Throughout this document, we use the following conventions in command
32  examples:
33
34  $ command                      Any line starting with a dollar sign
35                                 ($) is a command line.
36
37  { word1 | word2 | word3 }      This denotes a mandatory choice, to be
38                                 replaced with one of the given words.
39                                 A simple example would be this:
40
41                                 $ echo { FOO | BAR | COOKIE }
42
43                                 which is to be understood as one of
44                                 these:
45
46                                 $ echo FOO
47                                 - or -
48                                 $ echo BAR
49                                 - or -
50                                 $ echo COOKIE
51
52  [ word1 | word2 | word3 ]      Similar to { word1 | word2 | word3 }
53                                 except it's optional to give any of
54                                 those.  In addition to the examples
55                                 above, this would also be valid:
56
57                                 $ echo
58
59  {{ target }}                   This denotes a mandatory word or
60                                 sequence of words of some sort.  A
61                                 simple example would be this:
62
63                                 $ type {{ filename }}
64
65                                 which is to be understood to use the
66                                 command 'type' on some file name
67                                 determined by the user.
68
69  [[ options ]]                  Similar to {{ target }}, but is
70                                 optional.
71
72  Note that the notation assumes spaces around {, }, [, ], {{, }} and
73  [[, ]].  This is to differentiate from OpenVMS directory
74  specifications, which also use [ and ], but without spaces.
75
76  Quick Start
77  -----------
78
79  If you want to just get on with it, do:
80
81   on Unix (again, this includes Mac OS/X):
82
83     $ ./config
84     $ make
85     $ make test
86     $ make install
87
88   on OpenVMS:
89
90     $ @config
91     $ mms
92     $ mms test
93     $ mms install
94
95   on Windows (only pick one of the targets for configuration):
96
97     $ perl Configure { VC-WIN32 | VC-WIN64A | VC-WIN64I | VC-CE }
98     $ nmake
99     $ nmake test
100     $ nmake install
101
102  Note that in order to perform the install step above you need to have
103  appropriate permissions to write to the installation directory.
104
105  If any of these steps fails, see section Installation in Detail below.
106
107  This will build and install OpenSSL in the default location, which is:
108
109   Unix:    normal installation directories under /usr/local
110   OpenVMS: SYS$COMMON:[OPENSSL-'version'...], where 'version' is the
111            OpenSSL version number with underscores instead of periods.
112   Windows: C:\Program Files\OpenSSL or C:\Program Files (x86)\OpenSSL
113
114  The installation directory should be appropriately protected to ensure
115  unprivileged users cannot make changes to OpenSSL binaries or files, or install
116  engines. If you already have a pre-installed version of OpenSSL as part of
117  your Operating System it is recommended that you do not overwrite the system
118  version and instead install to somewhere else.
119
120  If you want to install it anywhere else, run config like this:
121
122   On Unix:
123
124     $ ./config --prefix=/opt/openssl --openssldir=/usr/local/ssl
125
126   On OpenVMS:
127
128     $ @config --prefix=PROGRAM:[INSTALLS] --openssldir=SYS$MANAGER:[OPENSSL]
129
130  (Note: if you do add options to the configuration command, please make sure
131  you've read more than just this Quick Start, such as relevant NOTES.* files,
132  the options outline below, as configuration options may change the outcome
133  in otherwise unexpected ways)
134
135
136  Configuration Options
137  ---------------------
138
139  There are several options to ./config (or ./Configure) to customize
140  the build (note that for Windows, the defaults for --prefix and
141  --openssldir depend in what configuration is used and what Windows
142  implementation OpenSSL is built on.  More notes on this in NOTES.WIN):
143
144   --api=x.y.z
145                    Don't build with support for deprecated APIs below the
146                    specified version number. For example "--api=1.1.0" will
147                    remove support for all APIS that were deprecated in OpenSSL
148                    version 1.1.0 or below. This is a rather specialized option
149                    for developers. If you just intend to remove all deprecated
150                    APIs entirely (up to the current version), it is easier
151                    to add the 'no-deprecated' option instead (see below).
152
153   --cross-compile-prefix=PREFIX
154                    The PREFIX to include in front of commands for your
155                    toolchain. It's likely to have to end with dash, e.g.
156                    a-b-c- would invoke GNU compiler as a-b-c-gcc, etc.
157                    Unfortunately cross-compiling is too case-specific to
158                    put together one-size-fits-all instructions. You might
159                    have to pass more flags or set up environment variables
160                    to actually make it work. Android and iOS cases are
161                    discussed in corresponding Configurations/15-*.conf
162                    files. But there are cases when this option alone is
163                    sufficient. For example to build the mingw64 target on
164                    Linux "--cross-compile-prefix=x86_64-w64-mingw32-"
165                    works. Naturally provided that mingw packages are
166                    installed. Today Debian and Ubuntu users have option to
167                    install a number of prepackaged cross-compilers along
168                    with corresponding run-time and development packages for
169                    "alien" hardware. To give another example
170                    "--cross-compile-prefix=mipsel-linux-gnu-" suffices
171                    in such case. Needless to mention that you have to
172                    invoke ./Configure, not ./config, and pass your target
173                    name explicitly. Also, note that --openssldir refers
174                    to target's file system, not one you are building on.
175
176   --debug
177                    Build OpenSSL with debugging symbols and zero optimization
178                    level.
179
180   --libdir=DIR
181                    The name of the directory under the top of the installation
182                    directory tree (see the --prefix option) where libraries will
183                    be installed. By default this is "lib". Note that on Windows
184                    only ".lib" files will be stored in this location. dll files
185                    will always be installed to the "bin" directory.
186
187   --openssldir=DIR
188                    Directory for OpenSSL configuration files, and also the
189                    default certificate and key store.  Defaults are:
190
191                    Unix:           /usr/local/ssl
192                    Windows:        C:\Program Files\Common Files\SSL
193                                 or C:\Program Files (x86)\Common Files\SSL
194                    OpenVMS:        SYS$COMMON:[OPENSSL-COMMON]
195
196   --prefix=DIR
197                    The top of the installation directory tree.  Defaults are:
198
199                    Unix:           /usr/local
200                    Windows:        C:\Program Files\OpenSSL
201                                 or C:\Program Files (x86)\OpenSSL
202                    OpenVMS:        SYS$COMMON:[OPENSSL-'version']
203
204   --release
205                    Build OpenSSL without debugging symbols. This is the default.
206
207   --strict-warnings
208                    This is a developer flag that switches on various compiler
209                    options recommended for OpenSSL development. It only works
210                    when using gcc or clang as the compiler. If you are
211                    developing a patch for OpenSSL then it is recommended that
212                    you use this option where possible.
213
214   --with-zlib-include=DIR
215                    The directory for the location of the zlib include file. This
216                    option is only necessary if enable-zlib (see below) is used
217                    and the include file is not already on the system include
218                    path.
219
220   --with-zlib-lib=LIB
221                    On Unix: this is the directory containing the zlib library.
222                    If not provided the system library path will be used.
223                    On Windows: this is the filename of the zlib library (with or
224                    without a path). This flag must be provided if the
225                    zlib-dynamic option is not also used. If zlib-dynamic is used
226                    then this flag is optional and a default value ("ZLIB1") is
227                    used if not provided.
228                    On VMS: this is the filename of the zlib library (with or
229                    without a path). This flag is optional and if not provided
230                    then "GNV$LIBZSHR", "GNV$LIBZSHR32" or "GNV$LIBZSHR64" is
231                    used by default depending on the pointer size chosen.
232
233
234   --with-rand-seed=seed1[,seed2,...]
235                    A comma separated list of seeding methods which will be tried
236                    by OpenSSL in order to obtain random input (a.k.a "entropy")
237                    for seeding its cryptographically secure random number
238                    generator (CSPRNG). The current seeding methods are:
239
240                    os:         Use a trusted operating system entropy source.
241                                This is the default method if such an entropy
242                                source exists.
243                    getrandom:  Use the L<getrandom(2)> or equivalent system
244                                call.
245                    devrandom:  Use the first device from the DEVRANDOM list
246                                which can be opened to read random bytes. The
247                                DEVRANDOM preprocessor constant expands to
248                                "/dev/urandom","/dev/random","/dev/srandom" on
249                                most unix-ish operating systems.
250                    egd:        Check for an entropy generating daemon.
251                    rdcpu:      Use the RDSEED or RDRAND command if provided by
252                                the CPU.
253                    librandom:  Use librandom (not implemented yet).
254                    none:       Disable automatic seeding. This is the default
255                                on some operating systems where no suitable
256                                entropy source exists, or no support for it is
257                                implemented yet.
258
259                    For more information, see the section 'Note on random number
260                    generation' at the end of this document.
261
262   no-afalgeng
263                    Don't build the AFALG engine. This option will be forced if
264                    on a platform that does not support AFALG.
265
266   enable-ktls
267                    Build with Kernel TLS support. This option will enable the
268                    use of the Kernel TLS data-path, which can improve
269                    performance and allow for the use of sendfile and splice
270                    system calls on TLS sockets. The Kernel may use TLS
271                    accelerators if any are available on the system.
272                    This option will be forced off on systems that do not support
273                    the Kernel TLS data-path.
274
275   enable-asan
276                    Build with the Address sanitiser. This is a developer option
277                    only. It may not work on all platforms and should never be
278                    used in production environments. It will only work when used
279                    with gcc or clang and should be used in conjunction with the
280                    no-shared option.
281
282   no-asm
283                    Do not use assembler code. This should be viewed as
284                    debugging/trouble-shooting option rather than production.
285                    On some platforms a small amount of assembler code may
286                    still be used even with this option.
287
288   no-async
289                    Do not build support for async operations.
290
291   no-autoalginit
292                    Don't automatically load all supported ciphers and digests.
293                    Typically OpenSSL will make available all of its supported
294                    ciphers and digests. For a statically linked application this
295                    may be undesirable if small executable size is an objective.
296                    This only affects libcrypto. Ciphers and digests will have to
297                    be loaded manually using EVP_add_cipher() and
298                    EVP_add_digest() if this option is used. This option will
299                    force a non-shared build.
300
301   no-autoerrinit
302                    Don't automatically load all libcrypto/libssl error strings.
303                    Typically OpenSSL will automatically load human readable
304                    error strings. For a statically linked application this may
305                    be undesirable if small executable size is an objective.
306
307   no-autoload-config
308                    Don't automatically load the default openssl.cnf file.
309                    Typically OpenSSL will automatically load a system config
310                    file which configures default ssl options.
311
312   enable-buildtest-c++
313                    While testing, generate C++ buildtest files that
314                    simply check that the public OpenSSL header files
315                    are usable standalone with C++.
316
317                    Enabling this option demands extra care.  For any
318                    compiler flag given directly as configuration
319                    option, you must ensure that it's valid for both
320                    the C and the C++ compiler.  If not, the C++ build
321                    test will most likely break.  As an alternative,
322                    you can use the language specific variables, CFLAGS
323                    and CXXFLAGS.
324
325   no-capieng
326                    Don't build the CAPI engine. This option will be forced if
327                    on a platform that does not support CAPI.
328
329   no-cmp
330                    Don't build support for CMP features
331
332   no-cms
333                    Don't build support for CMS features
334
335   no-comp
336                    Don't build support for SSL/TLS compression. If this option
337                    is left enabled (the default), then compression will only
338                    work if the zlib or zlib-dynamic options are also chosen.
339
340   enable-crypto-mdebug
341                    Build support for debugging memory allocated via
342                    OPENSSL_malloc() or OPENSSL_zalloc().
343
344   enable-crypto-mdebug-backtrace
345                    As for crypto-mdebug, but additionally provide backtrace
346                    information for allocated memory.
347                    TO BE USED WITH CARE: this uses GNU C functionality, and
348                    is therefore not usable for non-GNU config targets.  If
349                    your build complains about the use of '-rdynamic' or the
350                    lack of header file execinfo.h, this option is not for you.
351                    ALSO NOTE that even though execinfo.h is available on your
352                    system (through Gnulib), the functions might just be stubs
353                    that do nothing.
354
355   no-ct
356                    Don't build support for Certificate Transparency.
357
358   no-deprecated
359                    Don't build with support for any deprecated APIs. This is the
360                    same as using "--api" and supplying the latest version
361                    number.
362
363   no-dgram
364                    Don't build support for datagram based BIOs. Selecting this
365                    option will also force the disabling of DTLS.
366
367   enable-devcryptoeng
368                    Build the /dev/crypto engine.  It is automatically selected
369                    on BSD implementations, in which case it can be disabled with
370                    no-devcryptoeng.
371
372   no-dynamic-engine
373                    Don't build the dynamically loaded engines. This only has an
374                    effect in a "shared" build
375
376   no-ec
377                    Don't build support for Elliptic Curves.
378
379   no-ec2m
380                    Don't build support for binary Elliptic Curves
381
382   enable-ec_nistp_64_gcc_128
383                    Enable support for optimised implementations of some commonly
384                    used NIST elliptic curves.
385                    This is only supported on platforms:
386                    - with little-endian storage of non-byte types
387                    - that tolerate misaligned memory references
388                    - where the compiler:
389                      - supports the non-standard type __uint128_t
390                      - defines the built-in macro __SIZEOF_INT128__
391
392   enable-egd
393                    Build support for gathering entropy from EGD (Entropy
394                    Gathering Daemon).
395
396   no-engine
397                    Don't build support for loading engines.
398
399   no-err
400                    Don't compile in any error strings.
401
402   enable-external-tests
403                    Enable building of integration with external test suites.
404                    This is a developer option and may not work on all platforms.
405                    The only supported external test suite at the current time is
406                    the BoringSSL test suite. See the file test/README.external
407                    for further details.
408
409   no-filenames
410                    Don't compile in filename and line number information (e.g.
411                    for errors and memory allocation).
412
413   no-fips
414                    Don't compile the FIPS module
415
416   enable-fuzz-libfuzzer, enable-fuzz-afl
417                    Build with support for fuzzing using either libfuzzer or AFL.
418                    These are developer options only. They may not work on all
419                    platforms and should never be used in production environments.
420                    See the file fuzz/README.md for further details.
421
422   no-gost
423                    Don't build support for GOST based ciphersuites. Note that
424                    if this feature is enabled then GOST ciphersuites are only
425                    available if the GOST algorithms are also available through
426                    loading an externally supplied engine.
427
428   no-legacy
429                    Don't build the legacy provider. Disabling this also disables
430                    the legacy algorithms: MD2 (already disabled by default).
431
432   no-makedepend
433                    Don't generate dependencies.
434
435   no-module
436                    Don't build any dynamically loadable engines.  This also
437                    implies 'no-dynamic-engine'.
438
439   no-multiblock
440                    Don't build support for writing multiple records in one
441                    go in libssl (Note: this is a different capability to the
442                    pipelining functionality).
443
444   no-nextprotoneg
445                    Don't build support for the NPN TLS extension.
446
447   no-ocsp
448                    Don't build support for OCSP.
449
450   no-padlockeng
451   no-hw-padlock
452                    Don't build the padlock engine.
453                    ('no-hw-padlock' is deprecated and should not be used)
454
455   no-pic
456                    Don't build with support for Position Independent Code.
457
458   no-pinshared     By default OpenSSL will attempt to stay in memory until the
459                    process exits. This is so that libcrypto and libssl can be
460                    properly cleaned up automatically via an "atexit()" handler.
461                    The handler is registered by libcrypto and cleans up both
462                    libraries. On some platforms the atexit() handler will run on
463                    unload of libcrypto (if it has been dynamically loaded)
464                    rather than at process exit. This option can be used to stop
465                    OpenSSL from attempting to stay in memory until the process
466                    exits. This could lead to crashes if either libcrypto or
467                    libssl have already been unloaded at the point
468                    that the atexit handler is invoked, e.g. on a platform which
469                    calls atexit() on unload of the library, and libssl is
470                    unloaded before libcrypto then a crash is likely to happen.
471                    Applications can suppress running of the atexit() handler at
472                    run time by using the OPENSSL_INIT_NO_ATEXIT option to
473                    OPENSSL_init_crypto(). See the man page for it for further
474                    details.
475
476   no-posix-io
477                    Don't use POSIX IO capabilities.
478
479   no-psk
480                    Don't build support for Pre-Shared Key based ciphersuites.
481
482   no-rdrand
483                    Don't use hardware RDRAND capabilities.
484
485   no-rfc3779
486                    Don't build support for RFC3779 ("X.509 Extensions for IP
487                    Addresses and AS Identifiers")
488
489   sctp
490                    Build support for SCTP
491
492   no-shared
493                    Do not create shared libraries, only static ones.  See "Note
494                    on shared libraries" below.
495
496   no-sock
497                    Don't build support for socket BIOs
498
499   no-srp
500                    Don't build support for SRP or SRP based ciphersuites.
501
502   no-srtp
503                    Don't build SRTP support
504
505   no-sse2
506                    Exclude SSE2 code paths from 32-bit x86 assembly modules.
507                    Normally SSE2 extension is detected at run-time, but the
508                    decision whether or not the machine code will be executed
509                    is taken solely on CPU capability vector. This means that
510                    if you happen to run OS kernel which does not support SSE2
511                    extension on Intel P4 processor, then your application
512                    might be exposed to "illegal instruction" exception.
513                    There might be a way to enable support in kernel, e.g.
514                    FreeBSD kernel can  be compiled with CPU_ENABLE_SSE, and
515                    there is a way to disengage SSE2 code paths upon application
516                    start-up, but if you aim for wider "audience" running
517                    such kernel, consider no-sse2. Both the 386 and
518                    no-asm options imply no-sse2.
519
520   enable-ssl-trace
521                    Build with the SSL Trace capabilities (adds the "-trace"
522                    option to s_client and s_server).
523
524   no-static-engine
525                    Don't build the statically linked engines. This only
526                    has an impact when not built "shared".
527
528   no-stdio
529                    Don't use anything from the C header file "stdio.h" that
530                    makes use of the "FILE" type. Only libcrypto and libssl can
531                    be built in this way. Using this option will suppress
532                    building the command line applications. Additionally since
533                    the OpenSSL tests also use the command line applications the
534                    tests will also be skipped.
535
536   no-tests
537                    Don't build test programs or run any test.
538
539   no-threads
540                    Don't try to build with support for multi-threaded
541                    applications.
542
543   threads
544                    Build with support for multi-threaded applications. Most
545                    platforms will enable this by default. However if on a
546                    platform where this is not the case then this will usually
547                    require additional system-dependent options! See "Note on
548                    multi-threading" below.
549
550   enable-trace
551                    Build with support for the integrated tracing api. See manual pages
552                    OSSL_trace_set_channel(3) and OSSL_trace_enabled(3) for details.
553
554   no-ts
555                    Don't build Time Stamping Authority support.
556
557   enable-ubsan
558                    Build with the Undefined Behaviour sanitiser. This is a
559                    developer option only. It may not work on all platforms and
560                    should never be used in production environments. It will only
561                    work when used with gcc or clang and should be used in
562                    conjunction with the "-DPEDANTIC" option (or the
563                    --strict-warnings option).
564
565   no-ui
566                    Don't build with the "UI" capability (i.e. the set of
567                    features enabling text based prompts).
568
569   enable-unit-test
570                    Enable additional unit test APIs. This should not typically
571                    be used in production deployments.
572
573   no-uplink
574                    Don't build support for UPLINK interface.
575
576   enable-weak-ssl-ciphers
577                    Build support for SSL/TLS ciphers that are considered "weak"
578                    (e.g. RC4 based ciphersuites).
579
580   zlib
581                    Build with support for zlib compression/decompression.
582
583   zlib-dynamic
584                    Like "zlib", but has OpenSSL load the zlib library
585                    dynamically when needed.  This is only supported on systems
586                    where loading of shared libraries is supported.
587
588   386
589                    In 32-bit x86 builds, when generating assembly modules,
590                    use the 80386 instruction set only (the default x86 code
591                    is more efficient, but requires at least a 486). Note:
592                    This doesn't affect code generated by compiler, you're
593                    likely to complement configuration command line with
594                    suitable compiler-specific option.
595
596   no-<prot>
597                    Don't build support for negotiating the specified SSL/TLS
598                    protocol (one of ssl, ssl3, tls, tls1, tls1_1, tls1_2,
599                    tls1_3, dtls, dtls1 or dtls1_2). If "no-tls" is selected then
600                    all of tls1, tls1_1, tls1_2 and tls1_3 are disabled.
601                    Similarly "no-dtls" will disable dtls1 and dtls1_2. The
602                    "no-ssl" option is synonymous with "no-ssl3". Note this only
603                    affects version negotiation. OpenSSL will still provide the
604                    methods for applications to explicitly select the individual
605                    protocol versions.
606
607   no-<prot>-method
608                    As for no-<prot> but in addition do not build the methods for
609                    applications to explicitly select individual protocol
610                    versions. Note that there is no "no-tls1_3-method" option
611                    because there is no application method for TLSv1.3. Using
612                    individual protocol methods directly is deprecated.
613                    Applications should use TLS_method() instead.
614
615   enable-<alg>
616                    Build with support for the specified algorithm, where <alg>
617                    is one of: md2 or rc5.
618
619   no-<alg>
620                    Build without support for the specified algorithm, where
621                    <alg> is one of: aria, bf, blake2, camellia, cast, chacha,
622                    cmac, des, dh, dsa, ecdh, ecdsa, idea, md4, mdc2, ocb,
623                    poly1305, rc2, rc4, rmd160, scrypt, seed, siphash, siv, sm2,
624                    sm3, sm4 or whirlpool.  The "ripemd" algorithm is deprecated
625                    and if used is synonymous with rmd160.
626
627   -Dxxx, -Ixxx, -Wp, -lxxx, -Lxxx, -Wl, -rpath, -R, -framework, -static
628                    These system specific options will be recognised and
629                    passed through to the compiler to allow you to define
630                    preprocessor symbols, specify additional libraries, library
631                    directories or other compiler options. It might be worth
632                    noting that some compilers generate code specifically for
633                    processor the compiler currently executes on. This is not
634                    necessarily what you might have in mind, since it might be
635                    unsuitable for execution on other, typically older,
636                    processor. Consult your compiler documentation.
637
638                    Take note of the VAR=value documentation below and how
639                    these flags interact with those variables.
640
641   -xxx, +xxx
642                    Additional options that are not otherwise recognised are
643                    passed through as they are to the compiler as well.  Again,
644                    consult your compiler documentation.
645
646                    Take note of the VAR=value documentation below and how
647                    these flags interact with those variables.
648
649   VAR=value
650                    Assignment of environment variable for Configure.  These
651                    work just like normal environment variable assignments,
652                    but are supported on all platforms and are confined to
653                    the configuration scripts only.  These assignments override
654                    the corresponding value in the inherited environment, if
655                    there is one.
656
657                    The following variables are used as "make variables" and
658                    can be used as an alternative to giving preprocessor,
659                    compiler and linker options directly as configuration.
660                    The following variables are supported:
661
662                    AR              The static library archiver.
663                    ARFLAGS         Flags for the static library archiver.
664                    AS              The assembler compiler.
665                    ASFLAGS         Flags for the assembler compiler.
666                    CC              The C compiler.
667                    CFLAGS          Flags for the C compiler.
668                    CXX             The C++ compiler.
669                    CXXFLAGS        Flags for the C++ compiler.
670                    CPP             The C/C++ preprocessor.
671                    CPPFLAGS        Flags for the C/C++ preprocessor.
672                    CPPDEFINES      List of CPP macro definitions, separated
673                                    by a platform specific character (':' or
674                                    space for Unix, ';' for Windows, ',' for
675                                    VMS).  This can be used instead of using
676                                    -D (or what corresponds to that on your
677                                    compiler) in CPPFLAGS.
678                    CPPINCLUDES     List of CPP inclusion directories, separated
679                                    the same way as for CPPDEFINES.  This can
680                                    be used instead of -I (or what corresponds
681                                    to that on your compiler) in CPPFLAGS.
682                    HASHBANGPERL    Perl invocation to be inserted after '#!'
683                                    in public perl scripts (only relevant on
684                                    Unix).
685                    LD              The program linker (not used on Unix, $(CC)
686                                    is used there).
687                    LDFLAGS         Flags for the shared library, DSO and
688                                    program linker.
689                    LDLIBS          Extra libraries to use when linking.
690                                    Takes the form of a space separated list
691                                    of library specifications on Unix and
692                                    Windows, and as a comma separated list of
693                                    libraries on VMS.
694                    RANLIB          The library archive indexer.
695                    RC              The Windows resource compiler.
696                    RCFLAGS         Flags for the Windows resource compiler.
697                    RM              The command to remove files and directories.
698
699                    These cannot be mixed with compiling / linking flags given
700                    on the command line.  In other words, something like this
701                    isn't permitted.
702
703                        ./config -DFOO CPPFLAGS=-DBAR -DCOOKIE
704
705                    Backward compatibility note:
706
707                    To be compatible with older configuration scripts, the
708                    environment variables are ignored if compiling / linking
709                    flags are given on the command line, except for these:
710
711                    AR, CC, CXX, CROSS_COMPILE, HASHBANGPERL, PERL, RANLIB, RC
712                    and WINDRES
713
714                    For example, the following command will not see -DBAR:
715
716                         CPPFLAGS=-DBAR ./config -DCOOKIE
717
718                    However, the following will see both set variables:
719
720                         CC=gcc CROSS_COMPILE=x86_64-w64-mingw32- \
721                         ./config -DCOOKIE
722
723                    If CC is set, it is advisable to also set CXX to ensure
724                    both C and C++ compilers are in the same "family".  This
725                    becomes relevant with 'enable-external-tests' and
726                    'enable-buildtest-c++'.
727
728   reconf
729   reconfigure
730                    Reconfigure from earlier data.  This fetches the previous
731                    command line options and environment from data saved in
732                    "configdata.pm", and runs the configuration process again,
733                    using these options and environment.
734                    Note: NO other option is permitted together with "reconf".
735                    This means that you also MUST use "./Configure" (or
736                    what corresponds to that on non-Unix platforms) directly
737                    to invoke this option.
738                    Note: The original configuration saves away values for ALL
739                    environment variables that were used, and if they weren't
740                    defined, they are still saved away with information that
741                    they weren't originally defined.  This information takes
742                    precedence over environment variables that are defined
743                    when reconfiguring.
744
745  Displaying configuration data
746  -----------------------------
747
748  The configuration script itself will say very little, and finishes by
749  creating "configdata.pm".  This perl module can be loaded by other scripts
750  to find all the configuration data, and it can also be used as a script to
751  display all sorts of configuration data in a human readable form.
752
753  For more information, please do:
754
755        $ ./configdata.pm --help                         # Unix
756
757        or
758
759        $ perl configdata.pm --help                      # Windows and VMS
760
761  Installation in Detail
762  ----------------------
763
764  1a. Configure OpenSSL for your operation system automatically:
765
766      NOTE: This is not available on Windows.
767
768        $ ./config [[ options ]]                         # Unix
769
770        or
771
772        $ @config [[ options ]]                          ! OpenVMS
773
774      For the remainder of this text, the Unix form will be used in all
775      examples, please use the appropriate form for your platform.
776
777      This guesses at your operating system (and compiler, if necessary) and
778      configures OpenSSL based on this guess. Run ./config -t to see
779      if it guessed correctly. If you want to use a different compiler, you
780      are cross-compiling for another platform, or the ./config guess was
781      wrong for other reasons, go to step 1b. Otherwise go to step 2.
782
783      On some systems, you can include debugging information as follows:
784
785        $ ./config -d [[ options ]]
786
787  1b. Configure OpenSSL for your operating system manually
788
789      OpenSSL knows about a range of different operating system, hardware and
790      compiler combinations. To see the ones it knows about, run
791
792        $ ./Configure                                    # Unix
793
794        or
795
796        $ perl Configure                                 # All other platforms
797
798      For the remainder of this text, the Unix form will be used in all
799      examples, please use the appropriate form for your platform.
800
801      Pick a suitable name from the list that matches your system. For most
802      operating systems there is a choice between using "cc" or "gcc".  When
803      you have identified your system (and if necessary compiler) use this name
804      as the argument to Configure. For example, a "linux-elf" user would
805      run:
806
807        $ ./Configure linux-elf [[ options ]]
808
809      If your system isn't listed, you will have to create a configuration
810      file named Configurations/{{ something }}.conf and add the correct
811      configuration for your system. See the available configs as examples
812      and read Configurations/README and Configurations/README.design for
813      more information.
814
815      The generic configurations "cc" or "gcc" should usually work on 32 bit
816      Unix-like systems.
817
818      Configure creates a build file ("Makefile" on Unix, "makefile" on Windows
819      and "descrip.mms" on OpenVMS) from a suitable template in Configurations,
820      and defines various macros in include/openssl/opensslconf.h (generated from
821      include/openssl/opensslconf.h.in).
822
823  1c. Configure OpenSSL for building outside of the source tree.
824
825      OpenSSL can be configured to build in a build directory separate from
826      the directory with the source code.  It's done by placing yourself in
827      some other directory and invoking the configuration commands from
828      there.
829
830      Unix example:
831
832        $ mkdir /var/tmp/openssl-build
833        $ cd /var/tmp/openssl-build
834        $ /PATH/TO/OPENSSL/SOURCE/config [[ options ]]
835
836        or
837
838        $ /PATH/TO/OPENSSL/SOURCE/Configure {{ target }} [[ options ]]
839
840      OpenVMS example:
841
842        $ set default sys$login:
843        $ create/dir [.tmp.openssl-build]
844        $ set default [.tmp.openssl-build]
845        $ @[PATH.TO.OPENSSL.SOURCE]config [[ options ]]
846
847        or
848
849        $ @[PATH.TO.OPENSSL.SOURCE]Configure {{ target }} [[ options ]]
850
851      Windows example:
852
853        $ C:
854        $ mkdir \temp-openssl
855        $ cd \temp-openssl
856        $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure {{ target }} [[ options ]]
857
858      Paths can be relative just as well as absolute.  Configure will
859      do its best to translate them to relative paths whenever possible.
860
861   2. Build OpenSSL by running:
862
863        $ make                                           # Unix
864        $ mms                                            ! (or mmk) OpenVMS
865        $ nmake                                          # Windows
866
867      This will build the OpenSSL libraries (libcrypto.a and libssl.a on
868      Unix, corresponding on other platforms) and the OpenSSL binary
869      ("openssl"). The libraries will be built in the top-level directory,
870      and the binary will be in the "apps" subdirectory.
871
872      Troubleshooting:
873
874      If the build fails, look at the output.  There may be reasons
875      for the failure that aren't problems in OpenSSL itself (like
876      missing standard headers).
877
878      If the build succeeded previously, but fails after a source or
879      configuration change, it might be helpful to clean the build tree
880      before attempting another build. Use this command:
881
882        $ make clean                                     # Unix
883        $ mms clean                                      ! (or mmk) OpenVMS
884        $ nmake clean                                    # Windows
885
886      Assembler error messages can sometimes be sidestepped by using the
887      "no-asm" configuration option.
888
889      Compiling parts of OpenSSL with gcc and others with the system
890      compiler will result in unresolved symbols on some systems.
891
892      If you are still having problems you can get help by sending an email
893      to the openssl-users email list (see
894      https://www.openssl.org/community/mailinglists.html for details). If
895      it is a bug with OpenSSL itself, please open an issue on GitHub, at
896      https://github.com/openssl/openssl/issues. Please review the existing
897      ones first; maybe the bug was already reported or has already been
898      fixed.
899
900   3. After a successful build, the libraries should be tested. Run:
901
902        $ make test                                      # Unix
903        $ mms test                                       ! OpenVMS
904        $ nmake test                                     # Windows
905
906      NOTE: you MUST run the tests from an unprivileged account (or
907      disable your privileges temporarily if your platform allows it).
908
909      If some tests fail, look at the output.  There may be reasons for
910      the failure that isn't a problem in OpenSSL itself (like a
911      malfunction with Perl).  You may want increased verbosity, that
912      can be accomplished like this:
913
914        $ make VERBOSE=1 test                            # Unix
915
916        $ mms /macro=(VERBOSE=1) test                    ! OpenVMS
917
918        $ nmake VERBOSE=1 test                           # Windows
919
920      If you want to run just one or a few specific tests, you can use
921      the make variable TESTS to specify them, like this:
922
923        $ make TESTS='test_rsa test_dsa' test            # Unix
924        $ mms/macro="TESTS=test_rsa test_dsa" test       ! OpenVMS
925        $ nmake TESTS='test_rsa test_dsa' test           # Windows
926
927      And of course, you can combine (Unix example shown):
928
929        $ make VERBOSE=1 TESTS='test_rsa test_dsa' test
930
931      You can find the list of available tests like this:
932
933        $ make list-tests                                # Unix
934        $ mms list-tests                                 ! OpenVMS
935        $ nmake list-tests                               # Windows
936
937      Have a look at the manual for the perl module Test::Harness to
938      see what other HARNESS_* variables there are.
939
940      If you find a problem with OpenSSL itself, try removing any
941      compiler optimization flags from the CFLAGS line in Makefile and
942      run "make clean; make" or corresponding.
943
944      To report a bug please open an issue on GitHub, at
945      https://github.com/openssl/openssl/issues.
946
947      For more details on how the make variables TESTS can be used,
948      see section TESTS in Detail below.
949
950   4. If everything tests ok, install OpenSSL with
951
952        $ make install                                   # Unix
953        $ mms install                                    ! OpenVMS
954        $ nmake install                                  # Windows
955
956      Note that in order to perform the install step above you need to have
957      appropriate permissions to write to the installation directory.
958
959      The above commands will install all the software components in this
960      directory tree under PREFIX (the directory given with --prefix or its
961      default):
962
963        Unix:
964
965          bin/           Contains the openssl binary and a few other
966                         utility scripts.
967          include/openssl
968                         Contains the header files needed if you want
969                         to build your own programs that use libcrypto
970                         or libssl.
971          lib            Contains the OpenSSL library files.
972          lib/engines    Contains the OpenSSL dynamically loadable engines.
973
974          share/man/man1 Contains the OpenSSL command line man-pages.
975          share/man/man3 Contains the OpenSSL library calls man-pages.
976          share/man/man5 Contains the OpenSSL configuration format man-pages.
977          share/man/man7 Contains the OpenSSL other misc man-pages.
978
979          share/doc/openssl/html/man1
980          share/doc/openssl/html/man3
981          share/doc/openssl/html/man5
982          share/doc/openssl/html/man7
983                         Contains the HTML rendition of the man-pages.
984
985        OpenVMS ('arch' is replaced with the architecture name, "Alpha"
986        or "ia64", 'sover' is replaced with the shared library version
987        (0101 for 1.1), and 'pz' is replaced with the pointer size
988        OpenSSL was built with):
989
990          [.EXE.'arch']  Contains the openssl binary.
991          [.EXE]         Contains a few utility scripts.
992          [.include.openssl]
993                         Contains the header files needed if you want
994                         to build your own programs that use libcrypto
995                         or libssl.
996          [.LIB.'arch']  Contains the OpenSSL library files.
997          [.ENGINES'sover''pz'.'arch']
998                         Contains the OpenSSL dynamically loadable engines.
999          [.SYS$STARTUP] Contains startup, login and shutdown scripts.
1000                         These define appropriate logical names and
1001                         command symbols.
1002          [.SYSTEST]     Contains the installation verification procedure.
1003          [.HTML]        Contains the HTML rendition of the manual pages.
1004
1005
1006      Additionally, install will add the following directories under
1007      OPENSSLDIR (the directory given with --openssldir or its default)
1008      for you convenience:
1009
1010          certs          Initially empty, this is the default location
1011                         for certificate files.
1012          private        Initially empty, this is the default location
1013                         for private key files.
1014          misc           Various scripts.
1015
1016      The installation directory should be appropriately protected to ensure
1017      unprivileged users cannot make changes to OpenSSL binaries or files, or
1018      install engines. If you already have a pre-installed version of OpenSSL as
1019      part of your Operating System it is recommended that you do not overwrite
1020      the system version and instead install to somewhere else.
1021
1022      Package builders who want to configure the library for standard
1023      locations, but have the package installed somewhere else so that
1024      it can easily be packaged, can use
1025
1026        $ make DESTDIR=/tmp/package-root install         # Unix
1027        $ mms/macro="DESTDIR=TMP:[PACKAGE-ROOT]" install ! OpenVMS
1028
1029      The specified destination directory will be prepended to all
1030      installation target paths.
1031
1032   Compatibility issues with previous OpenSSL versions:
1033
1034   *  COMPILING existing applications
1035
1036      Starting with version 1.1.0, OpenSSL hides a number of structures
1037      that were previously open.  This includes all internal libssl
1038      structures and a number of EVP types.  Accessor functions have
1039      been added to allow controlled access to the structures' data.
1040
1041      This means that some software needs to be rewritten to adapt to
1042      the new ways of doing things.  This often amounts to allocating
1043      an instance of a structure explicitly where you could previously
1044      allocate them on the stack as automatic variables, and using the
1045      provided accessor functions where you would previously access a
1046      structure's field directly.
1047
1048      Some APIs have changed as well.  However, older APIs have been
1049      preserved when possible.
1050
1051  Environment Variables
1052  ---------------------
1053
1054  A number of environment variables can be used to provide additional control
1055  over the build process. Typically these should be defined prior to running
1056  config or Configure. Not all environment variables are relevant to all
1057  platforms.
1058
1059  AR
1060                 The name of the ar executable to use.
1061
1062  BUILDFILE
1063                 Use a different build file name than the platform default
1064                 ("Makefile" on Unix-like platforms, "makefile" on native Windows,
1065                 "descrip.mms" on OpenVMS).  This requires that there is a
1066                 corresponding build file template.  See Configurations/README
1067                 for further information.
1068
1069  CC
1070                 The compiler to use. Configure will attempt to pick a default
1071                 compiler for your platform but this choice can be overridden
1072                 using this variable. Set it to the compiler executable you wish
1073                 to use, e.g. "gcc" or "clang".
1074
1075  CROSS_COMPILE
1076                 This environment variable has the same meaning as for the
1077                 "--cross-compile-prefix" Configure flag described above. If both
1078                 are set then the Configure flag takes precedence.
1079
1080  NM
1081                 The name of the nm executable to use.
1082
1083  OPENSSL_LOCAL_CONFIG_DIR
1084                 OpenSSL comes with a database of information about how it
1085                 should be built on different platforms as well as build file
1086                 templates for those platforms. The database is comprised of
1087                 ".conf" files in the Configurations directory.  The build
1088                 file templates reside there as well as ".tmpl" files. See the
1089                 file Configurations/README for further information about the
1090                 format of ".conf" files as well as information on the ".tmpl"
1091                 files.
1092                 In addition to the standard ".conf" and ".tmpl" files, it is
1093                 possible to create your own ".conf" and ".tmpl" files and store
1094                 them locally, outside the OpenSSL source tree. This environment
1095                 variable can be set to the directory where these files are held
1096                 and will be considered by Configure before it looks in the
1097                 standard directories.
1098
1099  PERL
1100                 The name of the Perl executable to use when building OpenSSL.
1101                 This variable is used in config script only. Configure on the
1102                 other hand imposes the interpreter by which it itself was
1103                 executed on the whole build procedure.
1104
1105  HASHBANGPERL
1106                 The command string for the Perl executable to insert in the
1107                 #! line of perl scripts that will be publically installed.
1108                 Default: /usr/bin/env perl
1109                 Note: the value of this variable is added to the same scripts
1110                 on all platforms, but it's only relevant on Unix-like platforms.
1111
1112  RC
1113                 The name of the rc executable to use. The default will be as
1114                 defined for the target platform in the ".conf" file. If not
1115                 defined then "windres" will be used. The WINDRES environment
1116                 variable is synonymous to this. If both are defined then RC
1117                 takes precedence.
1118
1119  RANLIB
1120                 The name of the ranlib executable to use.
1121
1122  WINDRES
1123                 See RC.
1124
1125  Makefile targets
1126  ----------------
1127
1128  The Configure script generates a Makefile in a format relevant to the specific
1129  platform. The Makefiles provide a number of targets that can be used. Not all
1130  targets may be available on all platforms. Only the most common targets are
1131  described here. Examine the Makefiles themselves for the full list.
1132
1133  all
1134                 The default target to build all the software components.
1135
1136  clean
1137                 Remove all build artefacts and return the directory to a "clean"
1138                 state.
1139
1140  depend
1141                 Rebuild the dependencies in the Makefiles. This is a legacy
1142                 option that no longer needs to be used since OpenSSL 1.1.0.
1143
1144  install
1145                 Install all OpenSSL components.
1146
1147  install_sw
1148                 Only install the OpenSSL software components.
1149
1150  install_docs
1151                 Only install the OpenSSL documentation components.
1152
1153  install_man_docs
1154                 Only install the OpenSSL man pages (Unix only).
1155
1156  install_html_docs
1157                 Only install the OpenSSL html documentation.
1158
1159  list-tests
1160                 Prints a list of all the self test names.
1161
1162  test
1163                 Build and run the OpenSSL self tests.
1164
1165  uninstall
1166                 Uninstall all OpenSSL components.
1167
1168  reconfigure
1169  reconf
1170                 Re-run the configuration process, as exactly as the last time
1171                 as possible.
1172
1173  update
1174                 This is a developer option. If you are developing a patch for
1175                 OpenSSL you may need to use this if you want to update
1176                 automatically generated files; add new error codes or add new
1177                 (or change the visibility of) public API functions. (Unix only).
1178
1179  TESTS in Detail
1180  ---------------
1181
1182  The make variable TESTS supports a versatile set of space separated tokens
1183  with which you can specify a set of tests to be performed.  With a "current
1184  set of tests" in mind, initially being empty, here are the possible tokens:
1185
1186  alltests       The current set of tests becomes the whole set of available
1187                 tests (as listed when you do 'make list-tests' or similar).
1188  xxx            Adds the test 'xxx' to the current set of tests.
1189  -xxx           Removes 'xxx' from the current set of tests.  If this is the
1190                 first token in the list, the current set of tests is first
1191                 assigned the whole set of available tests, effectively making
1192                 this token equivalent to TESTS="alltests -xxx".
1193  nn             Adds the test group 'nn' (which is a number) to the current
1194                 set of tests.
1195  -nn            Removes the test group 'nn' from the current set of tests.
1196                 If this is the first token in the list, the current set of
1197                 tests is first assigned the whole set of available tests,
1198                 effectively making this token equivalent to
1199                 TESTS="alltests -xxx".
1200
1201  Also, all tokens except for "alltests" may have wildcards, such as *.
1202  (on Unix and Windows, BSD style wildcards are supported, while on VMS,
1203  it's VMS style wildcards)
1204
1205  Example: All tests except for the fuzz tests:
1206
1207  $ make TESTS=-test_fuzz test
1208
1209  or (if you want to be explicit)
1210
1211  $ make TESTS='alltests -test_fuzz' test
1212
1213  Example: All tests that have a name starting with "test_ssl" but not those
1214  starting with "test_ssl_":
1215
1216  $ make TESTS='test_ssl* -test_ssl_*' test
1217
1218  Example: Only test group 10:
1219
1220  $ make TESTS='10'
1221
1222  Example: All tests except the slow group (group 99):
1223
1224  $ make TESTS='-99'
1225
1226  Example: All tests in test groups 80 to 99 except for tests in group 90:
1227
1228  $ make TESTS='[89]? -90'
1229
1230 To stochastically verify that the algorithm that produces uniformly distributed
1231 random numbers is operating correctly (with a false positive rate of 0.01%):
1232
1233  $ ./util/shlib_wrap.sh test/bntest -stochastic
1234
1235  Note on multi-threading
1236  -----------------------
1237
1238  For some systems, the OpenSSL Configure script knows what compiler options
1239  are needed to generate a library that is suitable for multi-threaded
1240  applications.  On these systems, support for multi-threading is enabled
1241  by default; use the "no-threads" option to disable (this should never be
1242  necessary).
1243
1244  On other systems, to enable support for multi-threading, you will have
1245  to specify at least two options: "threads", and a system-dependent option.
1246  (The latter is "-D_REENTRANT" on various systems.)  The default in this
1247  case, obviously, is not to include support for multi-threading (but
1248  you can still use "no-threads" to suppress an annoying warning message
1249  from the Configure script.)
1250
1251  OpenSSL provides built-in support for two threading models: pthreads (found on
1252  most UNIX/Linux systems), and Windows threads. No other threading models are
1253  supported. If your platform does not provide pthreads or Windows threads then
1254  you should Configure with the "no-threads" option.
1255
1256  Notes on shared libraries
1257  -------------------------
1258
1259  For most systems the OpenSSL Configure script knows what is needed to
1260  build shared libraries for libcrypto and libssl. On these systems
1261  the shared libraries will be created by default. This can be suppressed and
1262  only static libraries created by using the "no-shared" option. On systems
1263  where OpenSSL does not know how to build shared libraries the "no-shared"
1264  option will be forced and only static libraries will be created.
1265
1266  Shared libraries are named a little differently on different platforms.
1267  One way or another, they all have the major OpenSSL version number as
1268  part of the file name, i.e. for OpenSSL 1.1.x, 1.1 is somehow part of
1269  the name.
1270
1271  On most POSIX platforms, shared libraries are named libcrypto.so.1.1
1272  and libssl.so.1.1.
1273
1274  on Cygwin, shared libraries are named cygcrypto-1.1.dll and cygssl-1.1.dll
1275  with import libraries libcrypto.dll.a and libssl.dll.a.
1276
1277  On Windows build with MSVC or using MingW, shared libraries are named
1278  libcrypto-1_1.dll and libssl-1_1.dll for 32-bit Windows, libcrypto-1_1-x64.dll
1279  and libssl-1_1-x64.dll for 64-bit x86_64 Windows, and libcrypto-1_1-ia64.dll
1280  and libssl-1_1-ia64.dll for IA64 Windows.  With MSVC, the import libraries
1281  are named libcrypto.lib and libssl.lib, while with MingW, they are named
1282  libcrypto.dll.a and libssl.dll.a.
1283
1284  On VMS, shareable images (VMS speak for shared libraries) are named
1285  ossl$libcrypto0101_shr.exe and ossl$libssl0101_shr.exe.  However, when
1286  OpenSSL is specifically built for 32-bit pointers, the shareable images
1287  are named ossl$libcrypto0101_shr32.exe and ossl$libssl0101_shr32.exe
1288  instead, and when built for 64-bit pointers, they are named
1289  ossl$libcrypto0101_shr64.exe and ossl$libssl0101_shr64.exe.
1290
1291  Note on random number generation
1292  --------------------------------
1293
1294  Availability of cryptographically secure random numbers is required for
1295  secret key generation. OpenSSL provides several options to seed the
1296  internal CSPRNG. If not properly seeded, the internal CSPRNG will refuse
1297  to deliver random bytes and a "PRNG not seeded error" will occur.
1298
1299  The seeding method can be configured using the --with-rand-seed option,
1300  which can be used to specify a comma separated list of seed methods.
1301  However in most cases OpenSSL will choose a suitable default method,
1302  so it is not necessary to explicitly provide this option. Note also
1303  that not all methods are available on all platforms.
1304
1305  I) On operating systems which provide a suitable randomness source (in
1306  form  of a system call or system device), OpenSSL will use the optimal
1307  available  method to seed the CSPRNG from the operating system's
1308  randomness sources. This corresponds to the option --with-rand-seed=os.
1309
1310  II) On systems without such a suitable randomness source, automatic seeding
1311  and reseeding is disabled (--with-rand-seed=none) and it may be necessary
1312  to install additional support software to obtain a random seed and reseed
1313  the CSPRNG manually.  Please check out the manual pages for RAND_add(),
1314  RAND_bytes(), RAND_egd(), and the FAQ for more information.