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