Constify code about X509_VERIFY_PARAM
[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.VMS (OpenVMS)
22   * NOTES.WIN (any supported Windows)
23   * NOTES.DJGPP (DOS platform with DJGPP)
24
25  Notational conventions in this document
26  ---------------------------------------
27
28  Throughout this document, we use the following conventions in command
29  examples:
30
31  $ command                      Any line starting with a dollar sign
32                                 ($) is a command line.
33
34  { word1 | word2 | word3 }      This denotes a mandatory choice, to be
35                                 replaced with one of the given words.
36                                 A simple example would be this:
37
38                                 $ echo { FOO | BAR | COOKIE }
39
40                                 which is to be understood as one of
41                                 these:
42
43                                 $ echo FOO
44                                 - or -
45                                 $ echo BAR
46                                 - or -
47                                 $ echo COOKIE
48
49  [ word1 | word2 | word3 ]      Similar to { word1 | word2 | word3 }
50                                 except it's optional to give any of
51                                 those.  In addition to the examples
52                                 above, this would also be valid:
53
54                                 $ echo
55
56  {{ target }}                   This denotes a mandatory word or
57                                 sequence of words of some sort.  A
58                                 simple example would be this:
59
60                                 $ type {{ filename }}
61
62                                 which is to be understood to use the
63                                 command 'type' on some file name
64                                 determined by the user.
65
66  [[ options ]]                  Similar to {{ target }}, but is
67                                 optional.
68
69  Note that the notation assumes spaces around {, }, [, ], {{, }} and
70  [[, ]].  This is to differentiate from OpenVMS directory
71  specifications, which also use [ and ], but without spaces.
72
73  Quick Start
74  -----------
75
76  If you want to just get on with it, do:
77
78   on Unix:
79
80     $ ./config
81     $ make
82     $ make test
83     $ make install
84
85   on OpenVMS:
86
87     $ @config
88     $ mms
89     $ mms test
90     $ mms install
91
92   on Windows (only pick one of the targets for configuration):
93
94     $ perl Configure { VC-WIN32 | VC-WIN64A | VC-WIN64I | VC-CE }
95     $ nmake
96     $ nmake test
97     $ nmake install
98
99  If any of these steps fails, see section Installation in Detail below.
100
101  This will build and install OpenSSL in the default location, which is:
102
103   Unix:    normal installation directories under /usr/local
104   OpenVMS: SYS$COMMON:[OPENSSL-'version'...], where 'version' is the
105            OpenSSL version number with underscores instead of periods.
106   Windows: C:\Program Files\OpenSSL or C:\Program Files (x86)\OpenSSL
107
108  If you want to install it anywhere else, run config like this:
109
110   On Unix:
111
112     $ ./config --prefix=/opt/openssl --openssldir=/usr/local/ssl
113
114   On OpenVMS:
115
116     $ @config --prefix=PROGRAM:[INSTALLS] --openssldir=SYS$MANAGER:[OPENSSL]
117
118
119  Configuration Options
120  ---------------------
121
122  There are several options to ./config (or ./Configure) to customize
123  the build (note that for Windows, the defaults for --prefix and
124  --openssldir depend in what configuration is used and what Windows
125  implementation OpenSSL is built on.  More notes on this in NOTES.WIN):
126
127   --api=x.y.z
128                    Don't build with support for deprecated APIs below the
129                    specified version number. For example "--api=1.1.0" will
130                    remove support for all APIS that were deprecated in OpenSSL
131                    version 1.1.0 or below.
132
133   --cross-compile-prefix=PREFIX
134                    The PREFIX to include in front of commands for your
135                    toolchain. It's likely to have to end with dash, e.g.
136                    a-b-c- would invoke GNU compiler as a-b-c-gcc, etc.
137                    Unfortunately cross-compiling is too case-specific to
138                    put together one-size-fits-all instructions. You might
139                    have to pass more flags or set up environment variables
140                    to actually make it work. Android and iOS cases are
141                    discussed in corresponding Configurations/10-main.cf
142                    sections. But there are cases when this option alone is
143                    sufficient. For example to build the mingw64 target on
144                    Linux "--cross-compile-prefix=x86_64-w64-mingw32-"
145                    works. Naturally provided that mingw packages are
146                    installed. Today Debian and Ubuntu users have option to
147                    install a number of prepackaged cross-compilers along
148                    with corresponding run-time and development packages for
149                    "alien" hardware. To give another example
150                    "--cross-compile-prefix=mipsel-linux-gnu-" suffices
151                    in such case. Needless to mention that you have to
152                    invoke ./Configure, not ./config, and pass your target
153                    name explicitly.
154
155   --debug
156                    Build OpenSSL with debugging symbols.
157
158   --libdir=DIR
159                    The name of the directory under the top of the installation
160                    directory tree (see the --prefix option) where libraries will
161                    be installed. By default this is "lib". Note that on Windows
162                    only ".lib" files will be stored in this location. dll files
163                    will always be installed to the "bin" directory.
164
165   --openssldir=DIR
166                    Directory for OpenSSL configuration files, and also the
167                    default certificate and key store.  Defaults are:
168
169                    Unix:           /usr/local/ssl
170                    Windows:        C:\Program Files\Common Files\SSL
171                                 or C:\Program Files (x86)\Common Files\SSL
172                    OpenVMS:        SYS$COMMON:[OPENSSL-COMMON]
173
174   --prefix=DIR
175                    The top of the installation directory tree.  Defaults are:
176
177                    Unix:           /usr/local
178                    Windows:        C:\Program Files\OpenSSL
179                                 or C:\Program Files (x86)\OpenSSL
180                    OpenVMS:        SYS$COMMON:[OPENSSL-'version']
181
182   --release
183                    Build OpenSSL without debugging symbols. This is the default.
184
185   --strict-warnings
186                    This is a developer flag that switches on various compiler
187                    options recommended for OpenSSL development. It only works
188                    when using gcc or clang as the compiler. If you are
189                    developing a patch for OpenSSL then it is recommended that
190                    you use this option where possible.
191
192   --with-zlib-include=DIR
193                    The directory for the location of the zlib include file. This
194                    option is only necessary if enable-zlib (see below) is used
195                    and the include file is not already on the system include
196                    path.
197
198   --with-zlib-lib=LIB
199                    On Unix: this is the directory containing the zlib library.
200                    If not provided the system library path will be used.
201                    On Windows: this is the filename of the zlib library (with or
202                    without a path). This flag must be provided if the
203                    zlib-dynamic option is not also used. If zlib-dynamic is used
204                    then this flag is optional and a default value ("ZLIB1") is
205                    used if not provided. 
206                    On VMS: this is the filename of the zlib library (with or
207                    without a path). This flag is optional and if not provided
208                    then "GNV$LIBZSHR", "GNV$LIBZSHR32" or "GNV$LIBZSHR64" is
209                    used by default depending on the pointer size chosen.
210
211   no-afalgeng
212                    Don't build the AFALG engine. This option will be forced if
213                    on a platform that does not support AFALG.
214
215   enable-asan
216                    Build with the Address sanitiser. This is a developer option
217                    only. It may not work on all platforms and should never be
218                    used in production environments. It will only work when used
219                    with gcc or clang and should be used in conjunction with the
220                    no-shared option.
221
222   no-asm
223                    Do not use assembler code. On some platforms a small amount
224                    of assembler code may still be used.
225
226   no-async
227                    Do not build support for async operations.
228
229   no-autoalginit
230                    Don't automatically load all supported ciphers and digests.
231                    Typically OpenSSL will make available all of its supported
232                    ciphers and digests. For a statically linked application this
233                    may be undesirable if small executable size is an objective.
234                    This only affects libcrypto. Ciphers and digests will have to
235                    be loaded manually using EVP_add_cipher() and
236                    EVP_add_digest() if this option is used. This option will
237                    force a non-shared build.
238
239   no-autoerrinit
240                    Don't automatically load all libcrypto/libssl error strings.
241                    Typically OpenSSL will automatically load human readable
242                    error strings. For a statically linked application this may
243                    be undesirable if small executable size is an objective.
244
245
246   no-capieng
247                    Don't build the CAPI engine. This option will be forced if
248                    on a platform that does not support CAPI.
249
250   no-cms
251                    Don't build support for CMS features
252
253   no-comp
254                    Don't build support for SSL/TLS compression. If this option
255                    is left enabled (the default), then compression will only
256                    work if the zlib or zlib-dynamic options are also chosen.
257
258   enable-crypto-mdebug
259                    Build support for debugging memory allocated via
260                    OPENSSL_malloc() or OPENSSL_zalloc().
261
262   enable-crypto-mdebug-backtrace
263                    As for crypto-mdebug, but additionally provide backtrace
264                    information for allocated memory.
265                    TO BE USED WITH CARE: this uses GNU C functionality, and
266                    is therefore not usable for non-GNU config targets.  If
267                    your build complains about the use of '-rdynamic' or the
268                    lack of header file execinfo.h, this option is not for you.
269                    ALSO NOTE that even though execinfo.h is available on your
270                    system (through Gnulib), the functions might just be stubs
271                    that do nothing.
272
273   no-ct
274                    Don't build support for Certificate Transparency.
275
276   no-deprecated
277                    Don't build with support for any deprecated APIs. This is the
278                    same as using "--api" and supplying the latest version
279                    number.
280
281   no-dgram
282                    Don't build support for datagram based BIOs. Selecting this
283                    option will also force the disabling of DTLS.
284
285   no-dso
286                    Don't build support for loading Dynamic Shared Objects.
287
288   no-dynamic-engine
289                    Don't build the dynamically loaded engines. This only has an
290                    effect in a "shared" build
291
292   no-ec
293                    Don't build support for Elliptic Curves.
294
295   no-ec2m
296                    Don't build support for binary Elliptic Curves
297
298   enable-ec_nistp_64_gcc_128
299                    Enable support for optimised implementations of some commonly
300                    used NIST elliptic curves. This is only supported on some
301                    platforms.
302
303   enable-egd
304                    Build support for gathering entropy from EGD (Entropy
305                    Gathering Daemon).
306
307   no-engine
308                    Don't build support for loading engines.
309
310   no-err
311                    Don't compile in any error strings.
312
313   no-filenames
314                    Don't compile in filename and line number information (e.g.
315                    for errors and memory allocation).
316
317   enable-fuzz-libfuzzer, enable-fuzz-afl
318                    Build with support for fuzzing using either libfuzzer or AFL.
319                    These are developer options only. They may not work on all
320                    platforms and should never be used in production environments.
321                    See the file fuzz/README.md for further details.
322
323   no-gost
324                    Don't build support for GOST based ciphersuites. Note that
325                    if this feature is enabled then GOST ciphersuites are only
326                    available if the GOST algorithms are also available through
327                    loading an externally supplied engine.
328
329   enable-heartbeats
330                    Build support for DTLS heartbeats.
331
332   no-hw-padlock
333                    Don't build the padlock engine.
334
335   no-makedepend
336                    Don't generate dependencies.
337
338   no-multiblock
339                    Don't build support for writing multiple records in one
340                    go in libssl (Note: this is a different capability to the
341                    pipelining functionality).
342
343   no-nextprotoneg
344                    Don't build support for the NPN TLS extension.
345
346   no-ocsp
347                    Don't build support for OCSP.
348
349   no-pic
350                    Don't build with support for Position Independent Code.
351
352   no-posix-io
353                    Don't use POSIX IO capabilities.
354
355   no-psk
356                    Don't build support for Pre-Shared Key based ciphersuites.
357
358   no-rdrand
359                    Don't use hardware RDRAND capabilities.
360
361   no-rfc3779
362                    Don't build support for RFC3779 ("X.509 Extensions for IP
363                    Addresses and AS Identifiers")
364
365   sctp
366                    Build support for SCTP
367
368   no-shared
369                    Do not create shared libraries, only static ones.  See "Note
370                    on shared libraries" below.
371
372   no-sock
373                    Don't build support for socket BIOs
374
375   no-srp
376                    Don't build support for SRP or SRP based ciphersuites.
377
378   no-srtp
379                    Don't build SRTP support
380
381   no-sse2
382                    Exclude SSE2 code paths. Normally SSE2 extension is
383                    detected at run-time, but the decision whether or not the
384                    machine code will be executed is taken solely on CPU
385                    capability vector. This means that if you happen to run OS
386                    kernel which does not support SSE2 extension on Intel P4
387                    processor, then your application might be exposed to
388                    "illegal instruction" exception. There might be a way
389                    to enable support in kernel, e.g. FreeBSD kernel can be
390                    compiled with CPU_ENABLE_SSE, and there is a way to
391                    disengage SSE2 code paths upon application start-up,
392                    but if you aim for wider "audience" running such kernel,
393                    consider no-sse2. Both the 386 and no-asm options imply
394                    no-sse2.
395
396   enable-ssl-trace
397                    Build with the SSL Trace capabilities (adds the "-trace"
398                    option to s_client and s_server).
399
400   no-static-engine
401                    Don't build the statically linked engines. This only
402                    has an impact when not built "shared".
403
404   no-stdio
405                    Don't use any C "stdio" features. Only libcrypto and libssl
406                    can be built in this way. Using this option will suppress
407                    building the command line applications. Additionally since
408                    the OpenSSL tests also use the command line applications the
409                    tests will also be skipped.
410
411   no-threads
412                    Don't try to build with support for multi-threaded
413                    applications.
414
415   threads
416                    Build with support for multi-threaded applications. Most
417                    platforms will enable this by default. However if on a
418                    platform where this is not the case then this will usually
419                    require additional system-dependent options! See "Note on
420                    multi-threading" below.
421
422   no-ts
423                    Don't build Time Stamping Authority support.
424
425   enable-ubsan
426                    Build with the Undefined Behaviour sanitiser. This is a
427                    developer option only. It may not work on all platforms and
428                    should never be used in production environments. It will only
429                    work when used with gcc or clang and should be used in
430                    conjunction with the "-DPEDANTIC" option (or the
431                    --strict-warnings option).
432
433   no-ui
434                    Don't build with the "UI" capability (i.e. the set of
435                    features enabling text based prompts).
436
437   enable-unit-test
438                    Enable additional unit test APIs. This should not typically
439                    be used in production deployments.
440
441   enable-weak-ssl-ciphers
442                    Build support for SSL/TLS ciphers that are considered "weak"
443                    (e.g. RC4 based ciphersuites).
444
445   zlib
446                    Build with support for zlib compression/decompression.
447
448   zlib-dynamic
449                    Like "zlib", but has OpenSSL load the zlib library
450                    dynamically when needed.  This is only supported on systems
451                    where loading of shared libraries is supported.
452
453   386
454                    On Intel hardware, use the 80386 instruction set only
455                    (the default x86 code is more efficient, but requires at
456                    least a 486). Note: Use compiler flags for any other CPU
457                    specific configuration, e.g. "-m32" to build x86 code on
458                    an x64 system.
459
460   no-<prot>
461                    Don't build support for negotiating the specified SSL/TLS
462                    protocol (one of ssl, ssl3, tls, tls1, tls1_1, tls1_2, dtls,
463                    dtls1 or dtls1_2). If "no-tls" is selected then all of tls1,
464                    tls1_1 and tls1_2 are disabled. Similarly "no-dtls" will
465                    disable dtls1 and dtls1_2. The "no-ssl" option is synonymous
466                    with "no-ssl3". Note this only affects version negotiation.
467                    OpenSSL will still provide the methods for applications to
468                    explicitly select the individual protocol versions.
469
470   no-<prot>-method
471                    As for no-<prot> but in addition do not build the methods for
472                    applications to explicitly select individual protocol
473                    versions.
474
475   enable-<alg>
476                    Build with support for the specified algorithm, where <alg>
477                    is one of: md2 or rc5.
478
479   no-<alg>
480                    Build without support for the specified algorithm, where
481                    <alg> is one of: bf, blake2, camellia, cast, chacha, cmac,
482                    des, dh, dsa, ecdh, ecdsa, idea, md4, md5, mdc2, ocb,
483                    ploy1305, rc2, rc4, rmd160, scrypt, seed or whirlpool. The
484                    "ripemd" algorithm is deprecated and if used is synonymous
485                    with rmd160.
486
487   -Dxxx, -lxxx, -Lxxx, -fxxx, -mXXX, -Kxxx
488                    These system specific options will be passed through to the
489                    compiler to allow you to define preprocessor symbols, specify
490                    additional libraries, library directories or other compiler
491                    options.
492
493
494  Installation in Detail
495  ----------------------
496
497  1a. Configure OpenSSL for your operation system automatically:
498
499      NOTE: This is not available on Windows.
500
501        $ ./config [[ options ]]                         # Unix
502
503        or
504
505        $ @config [[ options ]]                          ! OpenVMS
506
507      For the remainder of this text, the Unix form will be used in all
508      examples, please use the appropriate form for your platform.
509
510      This guesses at your operating system (and compiler, if necessary) and
511      configures OpenSSL based on this guess. Run ./config -t to see
512      if it guessed correctly. If you want to use a different compiler, you
513      are cross-compiling for another platform, or the ./config guess was
514      wrong for other reasons, go to step 1b. Otherwise go to step 2.
515
516      On some systems, you can include debugging information as follows:
517
518        $ ./config -d [[ options ]]
519
520  1b. Configure OpenSSL for your operating system manually
521
522      OpenSSL knows about a range of different operating system, hardware and
523      compiler combinations. To see the ones it knows about, run
524
525        $ ./Configure                                    # Unix
526
527        or
528
529        $ perl Configure                                 # All other platforms
530
531      For the remainder of this text, the Unix form will be used in all
532      examples, please use the appropriate form for your platform.
533
534      Pick a suitable name from the list that matches your system. For most
535      operating systems there is a choice between using "cc" or "gcc".  When
536      you have identified your system (and if necessary compiler) use this name
537      as the argument to Configure. For example, a "linux-elf" user would
538      run:
539
540        $ ./Configure linux-elf [[ options ]]
541
542      If your system isn't listed, you will have to create a configuration
543      file named Configurations/{{ something }}.conf and add the correct
544      configuration for your system. See the available configs as examples
545      and read Configurations/README and Configurations/README.design for
546      more information.
547
548      The generic configurations "cc" or "gcc" should usually work on 32 bit
549      Unix-like systems.
550
551      Configure creates a build file ("Makefile" on Unix, "makefile" on Windows
552      and "descrip.mms" on OpenVMS) from a suitable template in Configurations,
553      and defines various macros in include/openssl/opensslconf.h (generated from
554      include/openssl/opensslconf.h.in).
555
556  1c. Configure OpenSSL for building outside of the source tree.
557
558      OpenSSL can be configured to build in a build directory separate from
559      the directory with the source code.  It's done by placing yourself in
560      some other directory and invoking the configuration commands from
561      there.
562
563      Unix example:
564
565        $ mkdir /var/tmp/openssl-build
566        $ cd /var/tmp/openssl-build
567        $ /PATH/TO/OPENSSL/SOURCE/config [[ options ]]
568
569        or
570
571        $ /PATH/TO/OPENSSL/SOURCE/Configure {{ target }} [[ options ]]
572
573      OpenVMS example:
574
575        $ set default sys$login:
576        $ create/dir [.tmp.openssl-build]
577        $ set default [.tmp.openssl-build]
578        $ @[PATH.TO.OPENSSL.SOURCE]config [[ options ]]
579
580        or
581
582        $ @[PATH.TO.OPENSSL.SOURCE]Configure {{ target }} [[ options ]]
583
584      Windows example:
585
586        $ C:
587        $ mkdir \temp-openssl
588        $ cd \temp-openssl
589        $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure {{ target }} [[ options ]]
590
591      Paths can be relative just as well as absolute.  Configure will
592      do its best to translate them to relative paths whenever possible.
593
594   2. Build OpenSSL by running:
595
596        $ make                                           # Unix
597        $ mms                                            ! (or mmk) OpenVMS
598        $ nmake                                          # Windows
599
600      This will build the OpenSSL libraries (libcrypto.a and libssl.a on
601      Unix, corresponding on other platforms) and the OpenSSL binary
602      ("openssl"). The libraries will be built in the top-level directory,
603      and the binary will be in the "apps" subdirectory.
604
605      If the build fails, look at the output.  There may be reasons for
606      the failure that aren't problems in OpenSSL itself (like missing
607      standard headers).  If you are having problems you can get help by
608      sending an email to the openssl-users email list (see
609      https://www.openssl.org/community/mailinglists.html for details). If it
610      is a bug with OpenSSL itself, please report the problem to
611      <rt@openssl.org> (note that your message will be recorded in the request
612      tracker publicly readable at
613      https://www.openssl.org/community/index.html#bugs and will be
614      forwarded to a public mailing list). Please check out the request
615      tracker. Maybe the bug was already reported or has already been
616      fixed.
617
618      (If you encounter assembler error messages, try the "no-asm"
619      configuration option as an immediate fix.)
620
621      Compiling parts of OpenSSL with gcc and others with the system
622      compiler will result in unresolved symbols on some systems.
623
624   3. After a successful build, the libraries should be tested. Run:
625
626        $ make test                                      # Unix
627        $ mms test                                       ! OpenVMS
628        $ nmake test                                     # Windows
629
630      NOTE: you MUST run the tests from an unprivileged account (or
631      disable your privileges temporarily if your platform allows it).
632
633      If some tests fail, look at the output.  There may be reasons for
634      the failure that isn't a problem in OpenSSL itself (like a
635      malfunction with Perl).  You may want increased verbosity, that
636      can be accomplished like this:
637
638        $ make VERBOSE=1 test                            # Unix
639
640        $ mms /macro=(VERBOSE=1) test                    ! OpenVMS
641
642        $ nmake VERBOSE=1 test                           # Windows
643
644      If you want to run just one or a few specific tests, you can use
645      the make variable TESTS to specify them, like this:
646
647        $ make TESTS='test_rsa test_dsa' test            # Unix
648        $ mms/macro="TESTS=test_rsa test_dsa" test       ! OpenVMS
649        $ nmake TESTS='test_rsa test_dsa' test           # Windows
650
651      And of course, you can combine (Unix example shown):
652        
653        $ make VERBOSE=1 TESTS='test_rsa test_dsa' test
654
655      You can find the list of available tests like this:
656
657        $ make list-tests                                # Unix
658        $ mms list-tests                                 ! OpenVMS
659        $ nmake list-tests                               # Windows
660
661      Have a look at the manual for the perl module Test::Harness to
662      see what other HARNESS_* variables there are.
663
664      If you find a problem with OpenSSL itself, try removing any
665      compiler optimization flags from the CFLAGS line in Makefile and
666      run "make clean; make" or corresponding.
667
668      Please send bug reports to <rt@openssl.org>.
669
670      For more details on how the make variables TESTS can be used,
671      see section TESTS in Detail below.
672
673   4. If everything tests ok, install OpenSSL with
674
675        $ make install                                   # Unix
676        $ mms install                                    ! OpenVMS
677        $ nmake install                                  # Windows
678
679      This will install all the software components in this directory
680      tree under PREFIX (the directory given with --prefix or its
681      default):
682
683        Unix:
684
685          bin/           Contains the openssl binary and a few other
686                         utility scripts.
687          include/openssl
688                         Contains the header files needed if you want
689                         to build your own programs that use libcrypto
690                         or libssl.
691          lib            Contains the OpenSSL library files.
692          lib/engines    Contains the OpenSSL dynamically loadable engines.
693
694          share/man/man1 Contains the OpenSSL command line man-pages.
695          share/man/man3 Contains the OpenSSL library calls man-pages.
696          share/man/man5 Contains the OpenSSL configuration format man-pages.
697          share/man/man7 Contains the OpenSSL other misc man-pages.
698
699          share/doc/openssl/html/man1
700          share/doc/openssl/html/man3
701          share/doc/openssl/html/man5
702          share/doc/openssl/html/man7
703                         Contains the HTML rendition of the man-pages.
704
705        OpenVMS ('arch' is replaced with the architecture name, "Alpha"
706        or "ia64", 'sover' is replaced with the shared library version
707        (0101 for 1.1), and 'pz' is replaced with the pointer size
708        OpenSSL was built with):
709
710          [.EXE.'arch']  Contains the openssl binary.
711          [.EXE]         Contains a few utility scripts.
712          [.include.openssl]
713                         Contains the header files needed if you want
714                         to build your own programs that use libcrypto
715                         or libssl.
716          [.LIB.'arch']  Contains the OpenSSL library files.
717          [.ENGINES'sover''pz'.'arch']
718                         Contains the OpenSSL dynamically loadable engines.
719          [.SYS$STARTUP] Contains startup, login and shutdown scripts.
720                         These define appropriate logical names and
721                         command symbols.
722          [.SYSTEST]     Contains the installation verification procedure.
723          [.HTML]        Contains the HTML rendition of the manual pages.
724                         
725
726      Additionally, install will add the following directories under
727      OPENSSLDIR (the directory given with --openssldir or its default)
728      for you convenience:
729
730          certs          Initially empty, this is the default location
731                         for certificate files.
732          private        Initially empty, this is the default location
733                         for private key files.
734          misc           Various scripts.
735
736      Package builders who want to configure the library for standard
737      locations, but have the package installed somewhere else so that
738      it can easily be packaged, can use
739
740        $ make DESTDIR=/tmp/package-root install         # Unix
741        $ mms/macro="DESTDIR=TMP:[PACKAGE-ROOT]" install ! OpenVMS
742
743      The specified destination directory will be prepended to all
744      installation target paths.
745
746   Compatibility issues with previous OpenSSL versions:
747
748   *  COMPILING existing applications
749
750      OpenSSL 1.1.0 hides a number of structures that were previously
751      open.  This includes all internal libssl structures and a number
752      of EVP types.  Accessor functions have been added to allow
753      controlled access to the structures' data.
754
755      This means that some software needs to be rewritten to adapt to
756      the new ways of doing things.  This often amounts to allocating
757      an instance of a structure explicitly where you could previously
758      allocate them on the stack as automatic variables, and using the
759      provided accessor functions where you would previously access a
760      structure's field directly.
761
762      Some APIs have changed as well.  However, older APIs have been
763      preserved when possible.
764
765  Environment Variables
766  ---------------------
767
768  A number of environment variables can be used to provide additional control
769  over the build process. Typically these should be defined prior to running
770  config or Configure. Not all environment variables are relevant to all
771  platforms.
772
773  AR
774                 The name of the ar executable to use.
775
776  BUILDFILE
777                 Use a different build file name than the platform default
778                 ("Makefile" on Unixly platforms, "makefile" on native Windows,
779                 "descrip.mms" on OpenVMS).  This requires that there is a
780                 corresponding build file template.  See Configurations/README
781                 for further information.
782
783  CC
784                 The compiler to use. Configure will attempt to pick a default
785                 compiler for your platform but this choice can be overridden
786                 using this variable. Set it to the compiler executable you wish
787                 to use, e.g. "gcc" or "clang".
788
789  CROSS_COMPILE
790                 This environment variable has the same meaning as for the
791                 "--cross-compile-prefix" Configure flag described above. If both
792                 are set then the Configure flag takes precedence.
793
794  NM
795                 The name of the nm executable to use.
796
797  OPENSSL_LOCAL_CONFIG_DIR
798                 OpenSSL comes with a database of information about how it
799                 should be built on different platforms as well as build file
800                 templates for those platforms. The database is comprised of
801                 ".conf" files in the Configurations directory.  The build
802                 file templates reside there as well as ".tmpl" files. See the
803                 file Configurations/README for further information about the
804                 format of ".conf" files as well as information on the ".tmpl"
805                 files.
806                 In addition to the standard ".conf" and ".tmpl" files, it is
807                 possible to create your own ".conf" and ".tmpl" files and store
808                 them locally, outside the OpenSSL source tree. This environment
809                 variable can be set to the directory where these files are held
810                 and will have Configure to consider them in addition to the
811                 standard ones.
812
813  PERL
814                 The name of the Perl executable to use when building OpenSSL.
815                 This variable is used in config script only. Configure on the
816                 other hand imposes the interpreter by which it itself was
817                 executed on the whole build procedure.
818
819  HASHBANGPERL
820                 The command string for the Perl executable to insert in the
821                 #! line of perl scripts that will be publically installed.
822                 Default: /usr/bin/env perl
823                 Note: the value of this variable is added to the same scripts
824                 on all platforms, but it's only relevant on Unix-like platforms.
825
826  RC
827                 The name of the rc executable to use. The default will be as
828                 defined for the target platform in the ".conf" file. If not
829                 defined then "windres" will be used. The WINDRES environment
830                 variable is synonymous to this. If both are defined then RC
831                 takes precedence.
832
833  RANLIB
834                 The name of the ranlib executable to use.
835
836  WINDRES
837                 See RC.
838
839  Makefile targets
840  ----------------
841
842  The Configure script generates a Makefile in a format relevant to the specific
843  platform. The Makefiles provide a number of targets that can be used. Not all
844  targets may be available on all platforms. Only the most common targets are
845  described here. Examine the Makefiles themselves for the full list.
846
847  all
848                 The default target to build all the software components.
849
850  clean
851                 Remove all build artefacts and return the directory to a "clean"
852                 state.
853
854  depend
855                 Rebuild the dependencies in the Makefiles. This is a legacy
856                 option that no longer needs to be used in OpenSSL 1.1.0.
857
858  install
859                 Install all OpenSSL components.
860
861  install_sw
862                 Only install the OpenSSL software components.
863
864  install_docs
865                 Only install the OpenSSL documentation components.
866
867  install_man_docs
868                 Only install the OpenSSL man pages (Unix only).
869
870  install_html_docs
871                 Only install the OpenSSL html documentation.
872
873  list-tests
874                 Prints a list of all the self test names.
875
876  test
877                 Build and run the OpenSSL self tests.
878
879  uninstall
880                 Uninstall all OpenSSL components.
881
882  update
883                 This is a developer option. If you are developing a patch for
884                 OpenSSL you may need to use this if you want to update
885                 automatically generated files; add new error codes or add new
886                 (or change the visibility of) public API functions. (Unix only).
887
888  TESTS in Detail
889  ---------------
890
891  The make variable TESTS supports a versatile set of space separated tokens
892  with which you can specify a set of tests to be performed.  With a "current
893  set of tests" in mind, initially being empty, here are the possible tokens:
894
895  alltests       The current set of tests becomes the whole set of available
896                 tests (as listed when you do 'make list-tests' or similar).
897  xxx            Adds the test 'xxx' to the current set of tests.
898  -xxx           Removes 'xxx' from the current set of tests.  If this is the
899                 first token in the list, the current set of tests is first
900                 assigned the whole set of available tests, effectively making
901                 this token equivalent to TESTS="alltests -xxx"
902
903  Also, all tokens except for "alltests" may have wildcards, such as *.
904  (on Unix and Windows, BSD style wildcards are supported, while on VMS,
905  it's VMS style wildcards)
906
907  Example: All tests except for the fuzz tests:
908
909  $ make TESTS=-test_fuzz test
910
911  or (if you want to be explicit)
912
913  $ make TESTS='alltests -test_fuzz' test
914
915  Example: All tests that have a name starting with "test_ssl" but not those
916  starting with "test_ssl_":
917
918  $ make TESTS='test_ssl* -test_ssl_*' test
919
920  Note on multi-threading
921  -----------------------
922
923  For some systems, the OpenSSL Configure script knows what compiler options
924  are needed to generate a library that is suitable for multi-threaded
925  applications.  On these systems, support for multi-threading is enabled
926  by default; use the "no-threads" option to disable (this should never be
927  necessary).
928
929  On other systems, to enable support for multi-threading, you will have
930  to specify at least two options: "threads", and a system-dependent option.
931  (The latter is "-D_REENTRANT" on various systems.)  The default in this
932  case, obviously, is not to include support for multi-threading (but
933  you can still use "no-threads" to suppress an annoying warning message
934  from the Configure script.)
935
936  OpenSSL provides built-in support for two threading models: pthreads (found on
937  most UNIX/Linux systems), and Windows threads. No other threading models are
938  supported. If your platform does not provide pthreads or Windows threads then
939  you should Configure with the "no-threads" option.
940
941  Note on shared libraries
942  ------------------------
943
944  For most systems the OpenSSL Configure script knows what is needed to
945  build shared libraries for libcrypto and libssl. On these systems
946  the shared libraries will be created by default. This can be suppressed and
947  only static libraries created by using the "no-shared" option. On systems
948  where OpenSSL does not know how to build shared libraries the "no-shared"
949  option will be forced and only static libraries will be created.
950
951  Note on random number generation
952  --------------------------------
953
954  Availability of cryptographically secure random numbers is required for
955  secret key generation. OpenSSL provides several options to seed the
956  internal PRNG. If not properly seeded, the internal PRNG will refuse
957  to deliver random bytes and a "PRNG not seeded error" will occur.
958  On systems without /dev/urandom (or similar) device, it may be necessary
959  to install additional support software to obtain a random seed.
960  Please check out the manual pages for RAND_add(), RAND_bytes(), RAND_egd(),
961  and the FAQ for more information.
962