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