Add a no-fips Configure 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   no-fips
398                    Don't compile the FIPS module
399
400   enable-fuzz-libfuzzer, enable-fuzz-afl
401                    Build with support for fuzzing using either libfuzzer or AFL.
402                    These are developer options only. They may not work on all
403                    platforms and should never be used in production environments.
404                    See the file fuzz/README.md for further details.
405
406   no-gost
407                    Don't build support for GOST based ciphersuites. Note that
408                    if this feature is enabled then GOST ciphersuites are only
409                    available if the GOST algorithms are also available through
410                    loading an externally supplied engine.
411
412   no-makedepend
413                    Don't generate dependencies.
414
415   no-module
416                    Don't build any dynamically loadable engines.  This also
417                    implies 'no-dynamic-engine'.
418
419   no-multiblock
420                    Don't build support for writing multiple records in one
421                    go in libssl (Note: this is a different capability to the
422                    pipelining functionality).
423
424   no-nextprotoneg
425                    Don't build support for the NPN TLS extension.
426
427   no-ocsp
428                    Don't build support for OCSP.
429
430   no-padlockeng
431   no-hw-padlock
432                    Don't build the padlock engine.
433                    ('no-hw-padlock' is deprecated and should not be used)
434
435   no-pic
436                    Don't build with support for Position Independent Code.
437
438   no-pinshared     By default OpenSSL will attempt to stay in memory until the
439                    process exits. This is so that libcrypto and libssl can be
440                    properly cleaned up automatically via an "atexit()" handler.
441                    The handler is registered by libcrypto and cleans up both
442                    libraries. On some platforms the atexit() handler will run on
443                    unload of libcrypto (if it has been dynamically loaded)
444                    rather than at process exit. This option can be used to stop
445                    OpenSSL from attempting to stay in memory until the process
446                    exits. This could lead to crashes if either libcrypto or
447                    libssl have already been unloaded at the point
448                    that the atexit handler is invoked, e.g. on a platform which
449                    calls atexit() on unload of the library, and libssl is
450                    unloaded before libcrypto then a crash is likely to happen.
451                    Applications can suppress running of the atexit() handler at
452                    run time by using the OPENSSL_INIT_NO_ATEXIT option to
453                    OPENSSL_init_crypto(). See the man page for it for further
454                    details.
455
456   no-posix-io
457                    Don't use POSIX IO capabilities.
458
459   no-psk
460                    Don't build support for Pre-Shared Key based ciphersuites.
461
462   no-rdrand
463                    Don't use hardware RDRAND capabilities.
464
465   no-rfc3779
466                    Don't build support for RFC3779 ("X.509 Extensions for IP
467                    Addresses and AS Identifiers")
468
469   sctp
470                    Build support for SCTP
471
472   no-shared
473                    Do not create shared libraries, only static ones.  See "Note
474                    on shared libraries" below.
475
476   no-sock
477                    Don't build support for socket BIOs
478
479   no-srp
480                    Don't build support for SRP or SRP based ciphersuites.
481
482   no-srtp
483                    Don't build SRTP support
484
485   no-sse2
486                    Exclude SSE2 code paths from 32-bit x86 assembly modules.
487                    Normally SSE2 extension is detected at run-time, but the
488                    decision whether or not the machine code will be executed
489                    is taken solely on CPU capability vector. This means that
490                    if you happen to run OS kernel which does not support SSE2
491                    extension on Intel P4 processor, then your application
492                    might be exposed to "illegal instruction" exception.
493                    There might be a way to enable support in kernel, e.g.
494                    FreeBSD kernel can  be compiled with CPU_ENABLE_SSE, and
495                    there is a way to disengage SSE2 code paths upon application
496                    start-up, but if you aim for wider "audience" running
497                    such kernel, consider no-sse2. Both the 386 and
498                    no-asm options imply no-sse2.
499
500   enable-ssl-trace
501                    Build with the SSL Trace capabilities (adds the "-trace"
502                    option to s_client and s_server).
503
504   no-static-engine
505                    Don't build the statically linked engines. This only
506                    has an impact when not built "shared".
507
508   no-stdio
509                    Don't use anything from the C header file "stdio.h" that
510                    makes use of the "FILE" type. Only libcrypto and libssl can
511                    be built in this way. Using this option will suppress
512                    building the command line applications. Additionally since
513                    the OpenSSL tests also use the command line applications the
514                    tests will also be skipped.
515
516   no-tests
517                    Don't build test programs or run any test.
518
519   no-threads
520                    Don't try to build with support for multi-threaded
521                    applications.
522
523   threads
524                    Build with support for multi-threaded applications. Most
525                    platforms will enable this by default. However if on a
526                    platform where this is not the case then this will usually
527                    require additional system-dependent options! See "Note on
528                    multi-threading" below.
529
530   enable-trace
531                    Build with support for the integrated tracing api. See manual pages
532                    OSSL_trace_set_channel(3) and OSSL_trace_enabled(3) for details.
533
534   no-ts
535                    Don't build Time Stamping Authority support.
536
537   enable-ubsan
538                    Build with the Undefined Behaviour sanitiser. This is a
539                    developer option only. It may not work on all platforms and
540                    should never be used in production environments. It will only
541                    work when used with gcc or clang and should be used in
542                    conjunction with the "-DPEDANTIC" option (or the
543                    --strict-warnings option).
544
545   no-ui
546                    Don't build with the "UI" capability (i.e. the set of
547                    features enabling text based prompts).
548
549   enable-unit-test
550                    Enable additional unit test APIs. This should not typically
551                    be used in production deployments.
552
553   enable-weak-ssl-ciphers
554                    Build support for SSL/TLS ciphers that are considered "weak"
555                    (e.g. RC4 based ciphersuites).
556
557   zlib
558                    Build with support for zlib compression/decompression.
559
560   zlib-dynamic
561                    Like "zlib", but has OpenSSL load the zlib library
562                    dynamically when needed.  This is only supported on systems
563                    where loading of shared libraries is supported.
564
565   386
566                    In 32-bit x86 builds, when generating assembly modules,
567                    use the 80386 instruction set only (the default x86 code
568                    is more efficient, but requires at least a 486). Note:
569                    This doesn't affect code generated by compiler, you're
570                    likely to complement configuration command line with
571                    suitable compiler-specific option.
572
573   no-<prot>
574                    Don't build support for negotiating the specified SSL/TLS
575                    protocol (one of ssl, ssl3, tls, tls1, tls1_1, tls1_2,
576                    tls1_3, dtls, dtls1 or dtls1_2). If "no-tls" is selected then
577                    all of tls1, tls1_1, tls1_2 and tls1_3 are disabled.
578                    Similarly "no-dtls" will disable dtls1 and dtls1_2. The
579                    "no-ssl" option is synonymous with "no-ssl3". Note this only
580                    affects version negotiation. OpenSSL will still provide the
581                    methods for applications to explicitly select the individual
582                    protocol versions.
583
584   no-<prot>-method
585                    As for no-<prot> but in addition do not build the methods for
586                    applications to explicitly select individual protocol
587                    versions. Note that there is no "no-tls1_3-method" option
588                    because there is no application method for TLSv1.3. Using
589                    individual protocol methods directly is deprecated.
590                    Applications should use TLS_method() instead.
591
592   enable-<alg>
593                    Build with support for the specified algorithm, where <alg>
594                    is one of: md2 or rc5.
595
596   no-<alg>
597                    Build without support for the specified algorithm, where
598                    <alg> is one of: aria, bf, blake2, camellia, cast, chacha,
599                    cmac, des, dh, dsa, ecdh, ecdsa, idea, md4, mdc2, ocb,
600                    poly1305, rc2, rc4, rmd160, scrypt, seed, siphash, siv, sm2,
601                    sm3, sm4 or whirlpool.  The "ripemd" algorithm is deprecated
602                    and if used is synonymous with rmd160.
603
604   -Dxxx, -Ixxx, -Wp, -lxxx, -Lxxx, -Wl, -rpath, -R, -framework, -static
605                    These system specific options will be recognised and
606                    passed through to the compiler to allow you to define
607                    preprocessor symbols, specify additional libraries, library
608                    directories or other compiler options. It might be worth
609                    noting that some compilers generate code specifically for
610                    processor the compiler currently executes on. This is not
611                    necessarily what you might have in mind, since it might be
612                    unsuitable for execution on other, typically older,
613                    processor. Consult your compiler documentation.
614
615                    Take note of the VAR=value documentation below and how
616                    these flags interact with those variables.
617
618   -xxx, +xxx
619                    Additional options that are not otherwise recognised are
620                    passed through as they are to the compiler as well.  Again,
621                    consult your compiler documentation.
622
623                    Take note of the VAR=value documentation below and how
624                    these flags interact with those variables.
625
626   VAR=value
627                    Assignment of environment variable for Configure.  These
628                    work just like normal environment variable assignments,
629                    but are supported on all platforms and are confined to
630                    the configuration scripts only.  These assignments override
631                    the corresponding value in the inherited environment, if
632                    there is one.
633
634                    The following variables are used as "make variables" and
635                    can be used as an alternative to giving preprocessor,
636                    compiler and linker options directly as configuration.
637                    The following variables are supported:
638
639                    AR              The static library archiver.
640                    ARFLAGS         Flags for the static library archiver.
641                    AS              The assembler compiler.
642                    ASFLAGS         Flags for the assembler compiler.
643                    CC              The C compiler.
644                    CFLAGS          Flags for the C compiler.
645                    CXX             The C++ compiler.
646                    CXXFLAGS        Flags for the C++ compiler.
647                    CPP             The C/C++ preprocessor.
648                    CPPFLAGS        Flags for the C/C++ preprocessor.
649                    CPPDEFINES      List of CPP macro definitions, separated
650                                    by a platform specific character (':' or
651                                    space for Unix, ';' for Windows, ',' for
652                                    VMS).  This can be used instead of using
653                                    -D (or what corresponds to that on your
654                                    compiler) in CPPFLAGS.
655                    CPPINCLUDES     List of CPP inclusion directories, separated
656                                    the same way as for CPPDEFINES.  This can
657                                    be used instead of -I (or what corresponds
658                                    to that on your compiler) in CPPFLAGS.
659                    HASHBANGPERL    Perl invocation to be inserted after '#!'
660                                    in public perl scripts (only relevant on
661                                    Unix).
662                    LD              The program linker (not used on Unix, $(CC)
663                                    is used there).
664                    LDFLAGS         Flags for the shared library, DSO and
665                                    program linker.
666                    LDLIBS          Extra libraries to use when linking.
667                                    Takes the form of a space separated list
668                                    of library specifications on Unix and
669                                    Windows, and as a comma separated list of
670                                    libraries on VMS.
671                    RANLIB          The library archive indexer.
672                    RC              The Windows resource compiler.
673                    RCFLAGS         Flags for the Windows resource compiler.
674                    RM              The command to remove files and directories.
675
676                    These cannot be mixed with compiling / linking flags given
677                    on the command line.  In other words, something like this
678                    isn't permitted.
679
680                        ./config -DFOO CPPFLAGS=-DBAR -DCOOKIE
681
682                    Backward compatibility note:
683
684                    To be compatible with older configuration scripts, the
685                    environment variables are ignored if compiling / linking
686                    flags are given on the command line, except for these:
687
688                    AR, CC, CXX, CROSS_COMPILE, HASHBANGPERL, PERL, RANLIB, RC
689                    and WINDRES
690
691                    For example, the following command will not see -DBAR:
692
693                         CPPFLAGS=-DBAR ./config -DCOOKIE
694
695                    However, the following will see both set variables:
696
697                         CC=gcc CROSS_COMPILE=x86_64-w64-mingw32- \
698                         ./config -DCOOKIE
699
700                    If CC is set, it is advisable to also set CXX to ensure
701                    both C and C++ compilers are in the same "family".  This
702                    becomes relevant with 'enable-external-tests' and
703                    'enable-buildtest-c++'.
704
705   reconf
706   reconfigure
707                    Reconfigure from earlier data.  This fetches the previous
708                    command line options and environment from data saved in
709                    "configdata.pm", and runs the configuration process again,
710                    using these options and environment.
711                    Note: NO other option is permitted together with "reconf".
712                    This means that you also MUST use "./Configure" (or
713                    what corresponds to that on non-Unix platforms) directly
714                    to invoke this option.
715                    Note: The original configuration saves away values for ALL
716                    environment variables that were used, and if they weren't
717                    defined, they are still saved away with information that
718                    they weren't originally defined.  This information takes
719                    precedence over environment variables that are defined
720                    when reconfiguring.
721
722  Displaying configuration data
723  -----------------------------
724
725  The configuration script itself will say very little, and finishes by
726  creating "configdata.pm".  This perl module can be loaded by other scripts
727  to find all the configuration data, and it can also be used as a script to
728  display all sorts of configuration data in a human readable form.
729
730  For more information, please do:
731
732        $ ./configdata.pm --help                         # Unix
733
734        or
735
736        $ perl configdata.pm --help                      # Windows and VMS
737
738  Installation in Detail
739  ----------------------
740
741  1a. Configure OpenSSL for your operation system automatically:
742
743      NOTE: This is not available on Windows.
744
745        $ ./config [[ options ]]                         # Unix
746
747        or
748
749        $ @config [[ options ]]                          ! OpenVMS
750
751      For the remainder of this text, the Unix form will be used in all
752      examples, please use the appropriate form for your platform.
753
754      This guesses at your operating system (and compiler, if necessary) and
755      configures OpenSSL based on this guess. Run ./config -t to see
756      if it guessed correctly. If you want to use a different compiler, you
757      are cross-compiling for another platform, or the ./config guess was
758      wrong for other reasons, go to step 1b. Otherwise go to step 2.
759
760      On some systems, you can include debugging information as follows:
761
762        $ ./config -d [[ options ]]
763
764  1b. Configure OpenSSL for your operating system manually
765
766      OpenSSL knows about a range of different operating system, hardware and
767      compiler combinations. To see the ones it knows about, run
768
769        $ ./Configure                                    # Unix
770
771        or
772
773        $ perl Configure                                 # All other platforms
774
775      For the remainder of this text, the Unix form will be used in all
776      examples, please use the appropriate form for your platform.
777
778      Pick a suitable name from the list that matches your system. For most
779      operating systems there is a choice between using "cc" or "gcc".  When
780      you have identified your system (and if necessary compiler) use this name
781      as the argument to Configure. For example, a "linux-elf" user would
782      run:
783
784        $ ./Configure linux-elf [[ options ]]
785
786      If your system isn't listed, you will have to create a configuration
787      file named Configurations/{{ something }}.conf and add the correct
788      configuration for your system. See the available configs as examples
789      and read Configurations/README and Configurations/README.design for
790      more information.
791
792      The generic configurations "cc" or "gcc" should usually work on 32 bit
793      Unix-like systems.
794
795      Configure creates a build file ("Makefile" on Unix, "makefile" on Windows
796      and "descrip.mms" on OpenVMS) from a suitable template in Configurations,
797      and defines various macros in include/openssl/opensslconf.h (generated from
798      include/openssl/opensslconf.h.in).
799
800  1c. Configure OpenSSL for building outside of the source tree.
801
802      OpenSSL can be configured to build in a build directory separate from
803      the directory with the source code.  It's done by placing yourself in
804      some other directory and invoking the configuration commands from
805      there.
806
807      Unix example:
808
809        $ mkdir /var/tmp/openssl-build
810        $ cd /var/tmp/openssl-build
811        $ /PATH/TO/OPENSSL/SOURCE/config [[ options ]]
812
813        or
814
815        $ /PATH/TO/OPENSSL/SOURCE/Configure {{ target }} [[ options ]]
816
817      OpenVMS example:
818
819        $ set default sys$login:
820        $ create/dir [.tmp.openssl-build]
821        $ set default [.tmp.openssl-build]
822        $ @[PATH.TO.OPENSSL.SOURCE]config [[ options ]]
823
824        or
825
826        $ @[PATH.TO.OPENSSL.SOURCE]Configure {{ target }} [[ options ]]
827
828      Windows example:
829
830        $ C:
831        $ mkdir \temp-openssl
832        $ cd \temp-openssl
833        $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure {{ target }} [[ options ]]
834
835      Paths can be relative just as well as absolute.  Configure will
836      do its best to translate them to relative paths whenever possible.
837
838   2. Build OpenSSL by running:
839
840        $ make                                           # Unix
841        $ mms                                            ! (or mmk) OpenVMS
842        $ nmake                                          # Windows
843
844      This will build the OpenSSL libraries (libcrypto.a and libssl.a on
845      Unix, corresponding on other platforms) and the OpenSSL binary
846      ("openssl"). The libraries will be built in the top-level directory,
847      and the binary will be in the "apps" subdirectory.
848
849      Troubleshooting:
850
851      If the build fails, look at the output.  There may be reasons
852      for the failure that aren't problems in OpenSSL itself (like
853      missing standard headers).
854
855      If the build succeeded previously, but fails after a source or
856      configuration change, it might be helpful to clean the build tree
857      before attempting another build. Use this command:
858
859        $ make clean                                     # Unix
860        $ mms clean                                      ! (or mmk) OpenVMS
861        $ nmake clean                                    # Windows
862
863      Assembler error messages can sometimes be sidestepped by using the
864      "no-asm" configuration option.
865
866      Compiling parts of OpenSSL with gcc and others with the system
867      compiler will result in unresolved symbols on some systems.
868
869      If you are still having problems you can get help by sending an email
870      to the openssl-users email list (see
871      https://www.openssl.org/community/mailinglists.html for details). If
872      it is a bug with OpenSSL itself, please open an issue on GitHub, at
873      https://github.com/openssl/openssl/issues. Please review the existing
874      ones first; maybe the bug was already reported or has already been
875      fixed.
876
877   3. After a successful build, the libraries should be tested. Run:
878
879        $ make test                                      # Unix
880        $ mms test                                       ! OpenVMS
881        $ nmake test                                     # Windows
882
883      NOTE: you MUST run the tests from an unprivileged account (or
884      disable your privileges temporarily if your platform allows it).
885
886      If some tests fail, look at the output.  There may be reasons for
887      the failure that isn't a problem in OpenSSL itself (like a
888      malfunction with Perl).  You may want increased verbosity, that
889      can be accomplished like this:
890
891        $ make VERBOSE=1 test                            # Unix
892
893        $ mms /macro=(VERBOSE=1) test                    ! OpenVMS
894
895        $ nmake VERBOSE=1 test                           # Windows
896
897      If you want to run just one or a few specific tests, you can use
898      the make variable TESTS to specify them, like this:
899
900        $ make TESTS='test_rsa test_dsa' test            # Unix
901        $ mms/macro="TESTS=test_rsa test_dsa" test       ! OpenVMS
902        $ nmake TESTS='test_rsa test_dsa' test           # Windows
903
904      And of course, you can combine (Unix example shown):
905
906        $ make VERBOSE=1 TESTS='test_rsa test_dsa' test
907
908      You can find the list of available tests like this:
909
910        $ make list-tests                                # Unix
911        $ mms list-tests                                 ! OpenVMS
912        $ nmake list-tests                               # Windows
913
914      Have a look at the manual for the perl module Test::Harness to
915      see what other HARNESS_* variables there are.
916
917      If you find a problem with OpenSSL itself, try removing any
918      compiler optimization flags from the CFLAGS line in Makefile and
919      run "make clean; make" or corresponding.
920
921      To report a bug please open an issue on GitHub, at
922      https://github.com/openssl/openssl/issues.
923
924      For more details on how the make variables TESTS can be used,
925      see section TESTS in Detail below.
926
927   4. If everything tests ok, install OpenSSL with
928
929        $ make install                                   # Unix
930        $ mms install                                    ! OpenVMS
931        $ nmake install                                  # Windows
932
933      This will install all the software components in this directory
934      tree under PREFIX (the directory given with --prefix or its
935      default):
936
937        Unix:
938
939          bin/           Contains the openssl binary and a few other
940                         utility scripts.
941          include/openssl
942                         Contains the header files needed if you want
943                         to build your own programs that use libcrypto
944                         or libssl.
945          lib            Contains the OpenSSL library files.
946          lib/engines    Contains the OpenSSL dynamically loadable engines.
947
948          share/man/man1 Contains the OpenSSL command line man-pages.
949          share/man/man3 Contains the OpenSSL library calls man-pages.
950          share/man/man5 Contains the OpenSSL configuration format man-pages.
951          share/man/man7 Contains the OpenSSL other misc man-pages.
952
953          share/doc/openssl/html/man1
954          share/doc/openssl/html/man3
955          share/doc/openssl/html/man5
956          share/doc/openssl/html/man7
957                         Contains the HTML rendition of the man-pages.
958
959        OpenVMS ('arch' is replaced with the architecture name, "Alpha"
960        or "ia64", 'sover' is replaced with the shared library version
961        (0101 for 1.1), and 'pz' is replaced with the pointer size
962        OpenSSL was built with):
963
964          [.EXE.'arch']  Contains the openssl binary.
965          [.EXE]         Contains a few utility scripts.
966          [.include.openssl]
967                         Contains the header files needed if you want
968                         to build your own programs that use libcrypto
969                         or libssl.
970          [.LIB.'arch']  Contains the OpenSSL library files.
971          [.ENGINES'sover''pz'.'arch']
972                         Contains the OpenSSL dynamically loadable engines.
973          [.SYS$STARTUP] Contains startup, login and shutdown scripts.
974                         These define appropriate logical names and
975                         command symbols.
976          [.SYSTEST]     Contains the installation verification procedure.
977          [.HTML]        Contains the HTML rendition of the manual pages.
978
979
980      Additionally, install will add the following directories under
981      OPENSSLDIR (the directory given with --openssldir or its default)
982      for you convenience:
983
984          certs          Initially empty, this is the default location
985                         for certificate files.
986          private        Initially empty, this is the default location
987                         for private key files.
988          misc           Various scripts.
989
990      Package builders who want to configure the library for standard
991      locations, but have the package installed somewhere else so that
992      it can easily be packaged, can use
993
994        $ make DESTDIR=/tmp/package-root install         # Unix
995        $ mms/macro="DESTDIR=TMP:[PACKAGE-ROOT]" install ! OpenVMS
996
997      The specified destination directory will be prepended to all
998      installation target paths.
999
1000   Compatibility issues with previous OpenSSL versions:
1001
1002   *  COMPILING existing applications
1003
1004      Starting with version 1.1.0, OpenSSL hides a number of structures
1005      that were previously open.  This includes all internal libssl
1006      structures and a number of EVP types.  Accessor functions have
1007      been added to allow controlled access to the structures' data.
1008
1009      This means that some software needs to be rewritten to adapt to
1010      the new ways of doing things.  This often amounts to allocating
1011      an instance of a structure explicitly where you could previously
1012      allocate them on the stack as automatic variables, and using the
1013      provided accessor functions where you would previously access a
1014      structure's field directly.
1015
1016      Some APIs have changed as well.  However, older APIs have been
1017      preserved when possible.
1018
1019  Environment Variables
1020  ---------------------
1021
1022  A number of environment variables can be used to provide additional control
1023  over the build process. Typically these should be defined prior to running
1024  config or Configure. Not all environment variables are relevant to all
1025  platforms.
1026
1027  AR
1028                 The name of the ar executable to use.
1029
1030  BUILDFILE
1031                 Use a different build file name than the platform default
1032                 ("Makefile" on Unix-like platforms, "makefile" on native Windows,
1033                 "descrip.mms" on OpenVMS).  This requires that there is a
1034                 corresponding build file template.  See Configurations/README
1035                 for further information.
1036
1037  CC
1038                 The compiler to use. Configure will attempt to pick a default
1039                 compiler for your platform but this choice can be overridden
1040                 using this variable. Set it to the compiler executable you wish
1041                 to use, e.g. "gcc" or "clang".
1042
1043  CROSS_COMPILE
1044                 This environment variable has the same meaning as for the
1045                 "--cross-compile-prefix" Configure flag described above. If both
1046                 are set then the Configure flag takes precedence.
1047
1048  NM
1049                 The name of the nm executable to use.
1050
1051  OPENSSL_LOCAL_CONFIG_DIR
1052                 OpenSSL comes with a database of information about how it
1053                 should be built on different platforms as well as build file
1054                 templates for those platforms. The database is comprised of
1055                 ".conf" files in the Configurations directory.  The build
1056                 file templates reside there as well as ".tmpl" files. See the
1057                 file Configurations/README for further information about the
1058                 format of ".conf" files as well as information on the ".tmpl"
1059                 files.
1060                 In addition to the standard ".conf" and ".tmpl" files, it is
1061                 possible to create your own ".conf" and ".tmpl" files and store
1062                 them locally, outside the OpenSSL source tree. This environment
1063                 variable can be set to the directory where these files are held
1064                 and will be considered by Configure before it looks in the
1065                 standard directories.
1066
1067  PERL
1068                 The name of the Perl executable to use when building OpenSSL.
1069                 This variable is used in config script only. Configure on the
1070                 other hand imposes the interpreter by which it itself was
1071                 executed on the whole build procedure.
1072
1073  HASHBANGPERL
1074                 The command string for the Perl executable to insert in the
1075                 #! line of perl scripts that will be publically installed.
1076                 Default: /usr/bin/env perl
1077                 Note: the value of this variable is added to the same scripts
1078                 on all platforms, but it's only relevant on Unix-like platforms.
1079
1080  RC
1081                 The name of the rc executable to use. The default will be as
1082                 defined for the target platform in the ".conf" file. If not
1083                 defined then "windres" will be used. The WINDRES environment
1084                 variable is synonymous to this. If both are defined then RC
1085                 takes precedence.
1086
1087  RANLIB
1088                 The name of the ranlib executable to use.
1089
1090  WINDRES
1091                 See RC.
1092
1093  Makefile targets
1094  ----------------
1095
1096  The Configure script generates a Makefile in a format relevant to the specific
1097  platform. The Makefiles provide a number of targets that can be used. Not all
1098  targets may be available on all platforms. Only the most common targets are
1099  described here. Examine the Makefiles themselves for the full list.
1100
1101  all
1102                 The default target to build all the software components.
1103
1104  clean
1105                 Remove all build artefacts and return the directory to a "clean"
1106                 state.
1107
1108  depend
1109                 Rebuild the dependencies in the Makefiles. This is a legacy
1110                 option that no longer needs to be used since OpenSSL 1.1.0.
1111
1112  install
1113                 Install all OpenSSL components.
1114
1115  install_sw
1116                 Only install the OpenSSL software components.
1117
1118  install_docs
1119                 Only install the OpenSSL documentation components.
1120
1121  install_man_docs
1122                 Only install the OpenSSL man pages (Unix only).
1123
1124  install_html_docs
1125                 Only install the OpenSSL html documentation.
1126
1127  list-tests
1128                 Prints a list of all the self test names.
1129
1130  test
1131                 Build and run the OpenSSL self tests.
1132
1133  uninstall
1134                 Uninstall all OpenSSL components.
1135
1136  reconfigure
1137  reconf
1138                 Re-run the configuration process, as exactly as the last time
1139                 as possible.
1140
1141  update
1142                 This is a developer option. If you are developing a patch for
1143                 OpenSSL you may need to use this if you want to update
1144                 automatically generated files; add new error codes or add new
1145                 (or change the visibility of) public API functions. (Unix only).
1146
1147  TESTS in Detail
1148  ---------------
1149
1150  The make variable TESTS supports a versatile set of space separated tokens
1151  with which you can specify a set of tests to be performed.  With a "current
1152  set of tests" in mind, initially being empty, here are the possible tokens:
1153
1154  alltests       The current set of tests becomes the whole set of available
1155                 tests (as listed when you do 'make list-tests' or similar).
1156  xxx            Adds the test 'xxx' to the current set of tests.
1157  -xxx           Removes 'xxx' from the current set of tests.  If this is the
1158                 first token in the list, the current set of tests is first
1159                 assigned the whole set of available tests, effectively making
1160                 this token equivalent to TESTS="alltests -xxx".
1161  nn             Adds the test group 'nn' (which is a number) to the current
1162                 set of tests.
1163  -nn            Removes the test group 'nn' from the current set of tests.
1164                 If this is the first token in the list, the current set of
1165                 tests is first assigned the whole set of available tests,
1166                 effectively making this token equivalent to
1167                 TESTS="alltests -xxx".
1168
1169  Also, all tokens except for "alltests" may have wildcards, such as *.
1170  (on Unix and Windows, BSD style wildcards are supported, while on VMS,
1171  it's VMS style wildcards)
1172
1173  Example: All tests except for the fuzz tests:
1174
1175  $ make TESTS=-test_fuzz test
1176
1177  or (if you want to be explicit)
1178
1179  $ make TESTS='alltests -test_fuzz' test
1180
1181  Example: All tests that have a name starting with "test_ssl" but not those
1182  starting with "test_ssl_":
1183
1184  $ make TESTS='test_ssl* -test_ssl_*' test
1185
1186  Example: Only test group 10:
1187
1188  $ make TESTS='10'
1189
1190  Example: All tests except the slow group (group 99):
1191
1192  $ make TESTS='-99'
1193
1194  Example: All tests in test groups 80 to 99 except for tests in group 90:
1195
1196  $ make TESTS='[89]? -90'
1197
1198  Note on multi-threading
1199  -----------------------
1200
1201  For some systems, the OpenSSL Configure script knows what compiler options
1202  are needed to generate a library that is suitable for multi-threaded
1203  applications.  On these systems, support for multi-threading is enabled
1204  by default; use the "no-threads" option to disable (this should never be
1205  necessary).
1206
1207  On other systems, to enable support for multi-threading, you will have
1208  to specify at least two options: "threads", and a system-dependent option.
1209  (The latter is "-D_REENTRANT" on various systems.)  The default in this
1210  case, obviously, is not to include support for multi-threading (but
1211  you can still use "no-threads" to suppress an annoying warning message
1212  from the Configure script.)
1213
1214  OpenSSL provides built-in support for two threading models: pthreads (found on
1215  most UNIX/Linux systems), and Windows threads. No other threading models are
1216  supported. If your platform does not provide pthreads or Windows threads then
1217  you should Configure with the "no-threads" option.
1218
1219  Notes on shared libraries
1220  -------------------------
1221
1222  For most systems the OpenSSL Configure script knows what is needed to
1223  build shared libraries for libcrypto and libssl. On these systems
1224  the shared libraries will be created by default. This can be suppressed and
1225  only static libraries created by using the "no-shared" option. On systems
1226  where OpenSSL does not know how to build shared libraries the "no-shared"
1227  option will be forced and only static libraries will be created.
1228
1229  Shared libraries are named a little differently on different platforms.
1230  One way or another, they all have the major OpenSSL version number as
1231  part of the file name, i.e. for OpenSSL 1.1.x, 1.1 is somehow part of
1232  the name.
1233
1234  On most POSIX platforms, shared libraries are named libcrypto.so.1.1
1235  and libssl.so.1.1.
1236
1237  on Cygwin, shared libraries are named cygcrypto-1.1.dll and cygssl-1.1.dll
1238  with import libraries libcrypto.dll.a and libssl.dll.a.
1239
1240  On Windows build with MSVC or using MingW, shared libraries are named
1241  libcrypto-1_1.dll and libssl-1_1.dll for 32-bit Windows, libcrypto-1_1-x64.dll
1242  and libssl-1_1-x64.dll for 64-bit x86_64 Windows, and libcrypto-1_1-ia64.dll
1243  and libssl-1_1-ia64.dll for IA64 Windows.  With MSVC, the import libraries
1244  are named libcrypto.lib and libssl.lib, while with MingW, they are named
1245  libcrypto.dll.a and libssl.dll.a.
1246
1247  On VMS, shareable images (VMS speak for shared libraries) are named
1248  ossl$libcrypto0101_shr.exe and ossl$libssl0101_shr.exe.  However, when
1249  OpenSSL is specifically built for 32-bit pointers, the shareable images
1250  are named ossl$libcrypto0101_shr32.exe and ossl$libssl0101_shr32.exe
1251  instead, and when built for 64-bit pointers, they are named
1252  ossl$libcrypto0101_shr64.exe and ossl$libssl0101_shr64.exe.
1253
1254  Note on random number generation
1255  --------------------------------
1256
1257  Availability of cryptographically secure random numbers is required for
1258  secret key generation. OpenSSL provides several options to seed the
1259  internal CSPRNG. If not properly seeded, the internal CSPRNG will refuse
1260  to deliver random bytes and a "PRNG not seeded error" will occur.
1261
1262  The seeding method can be configured using the --with-rand-seed option,
1263  which can be used to specify a comma separated list of seed methods.
1264  However in most cases OpenSSL will choose a suitable default method,
1265  so it is not necessary to explicitly provide this option. Note also
1266  that not all methods are available on all platforms.
1267
1268  I) On operating systems which provide a suitable randomness source (in
1269  form  of a system call or system device), OpenSSL will use the optimal
1270  available  method to seed the CSPRNG from the operating system's
1271  randomness sources. This corresponds to the option --with-rand-seed=os.
1272
1273  II) On systems without such a suitable randomness source, automatic seeding
1274  and reseeding is disabled (--with-rand-seed=none) and it may be necessary
1275  to install additional support software to obtain a random seed and reseed
1276  the CSPRNG manually.  Please check out the manual pages for RAND_add(),
1277  RAND_bytes(), RAND_egd(), and the FAQ for more information.