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