Fix typo in INSTALL file
[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 any C "stdio" features. Only libcrypto and libssl
416                    can be built in this way. Using this option will suppress
417                    building the command line applications. Additionally since
418                    the OpenSSL tests also use the command line applications the
419                    tests will also be skipped.
420
421   no-tests
422                    Don't build test programs or run any test.
423
424   no-threads
425                    Don't try to build with support for multi-threaded
426                    applications.
427
428   threads
429                    Build with support for multi-threaded applications. Most
430                    platforms will enable this by default. However if on a
431                    platform where this is not the case then this will usually
432                    require additional system-dependent options! See "Note on
433                    multi-threading" below.
434
435   enable-tls13downgrade
436                    TODO(TLS1.3): Make this enabled by default and remove the
437                    option when TLSv1.3 is out of draft
438                    TLSv1.3 offers a downgrade protection mechanism. This is
439                    implemented but disabled by default. It should not typically
440                    be enabled except for testing purposes. Otherwise this could
441                    cause problems if a pre-RFC version of OpenSSL talks to an
442                    RFC implementation (it will erroneously be detected as a
443                    downgrade).
444
445   no-ts
446                    Don't build Time Stamping Authority support.
447
448   enable-ubsan
449                    Build with the Undefined Behaviour sanitiser. This is a
450                    developer option only. It may not work on all platforms and
451                    should never be used in production environments. It will only
452                    work when used with gcc or clang and should be used in
453                    conjunction with the "-DPEDANTIC" option (or the
454                    --strict-warnings option).
455
456   no-ui
457                    Don't build with the "UI" capability (i.e. the set of
458                    features enabling text based prompts).
459
460   enable-unit-test
461                    Enable additional unit test APIs. This should not typically
462                    be used in production deployments.
463
464   enable-weak-ssl-ciphers
465                    Build support for SSL/TLS ciphers that are considered "weak"
466                    (e.g. RC4 based ciphersuites).
467
468   zlib
469                    Build with support for zlib compression/decompression.
470
471   zlib-dynamic
472                    Like "zlib", but has OpenSSL load the zlib library
473                    dynamically when needed.  This is only supported on systems
474                    where loading of shared libraries is supported.
475
476   386
477                    In 32-bit x86 builds, when generating assembly modules,
478                    use the 80386 instruction set only (the default x86 code
479                    is more efficient, but requires at least a 486). Note:
480                    This doesn't affect code generated by compiler, you're
481                    likely to complement configuration command line with
482                    suitable compiler-specific option.
483
484   enable-tls1_3
485                    TODO(TLS1.3): Make this enabled by default
486                    Build support for TLS1.3. Note: This is a WIP feature and
487                    does not currently interoperate with other TLS1.3
488                    implementations! Use with caution!!
489
490   no-<prot>
491                    Don't build support for negotiating the specified SSL/TLS
492                    protocol (one of ssl, ssl3, tls, tls1, tls1_1, tls1_2, dtls,
493                    dtls1 or dtls1_2). If "no-tls" is selected then all of tls1,
494                    tls1_1 and tls1_2 are disabled. Similarly "no-dtls" will
495                    disable dtls1 and dtls1_2. The "no-ssl" option is synonymous
496                    with "no-ssl3". Note this only affects version negotiation.
497                    OpenSSL will still provide the methods for applications to
498                    explicitly select the individual protocol versions.
499
500   no-<prot>-method
501                    As for no-<prot> but in addition do not build the methods for
502                    applications to explicitly select individual protocol
503                    versions.
504
505   enable-<alg>
506                    Build with support for the specified algorithm, where <alg>
507                    is one of: md2 or rc5.
508
509   no-<alg>
510                    Build without support for the specified algorithm, where
511                    <alg> is one of: bf, blake2, camellia, cast, chacha, cmac,
512                    des, dh, dsa, ecdh, ecdsa, idea, md4, mdc2, ocb, poly1305,
513                    rc2, rc4, rmd160, scrypt, seed, siphash or whirlpool. The
514                    "ripemd" algorithm is deprecated and if used is synonymous
515                    with rmd160.
516
517   -Dxxx, lxxx, -Lxxx, -Wl, -rpath, -R, -framework, -static
518                    These system specific options will be recognised and
519                    passed through to the compiler to allow you to define
520                    preprocessor symbols, specify additional libraries, library
521                    directories or other compiler options. It might be worth
522                    noting that some compilers generate code specifically for
523                    processor the compiler currently executes on. This is not
524                    necessarily what you might have in mind, since it might be
525                    unsuitable for execution on other, typically older,
526                    processor. Consult your compiler documentation.
527
528   -xxx, +xxx
529                    Additional options that are not otherwise recognised are
530                    passed through as they are to the compiler as well.  Again,
531                    consult your compiler documentation.
532
533
534  Installation in Detail
535  ----------------------
536
537  1a. Configure OpenSSL for your operation system automatically:
538
539      NOTE: This is not available on Windows.
540
541        $ ./config [[ options ]]                         # Unix
542
543        or
544
545        $ @config [[ options ]]                          ! OpenVMS
546
547      For the remainder of this text, the Unix form will be used in all
548      examples, please use the appropriate form for your platform.
549
550      This guesses at your operating system (and compiler, if necessary) and
551      configures OpenSSL based on this guess. Run ./config -t to see
552      if it guessed correctly. If you want to use a different compiler, you
553      are cross-compiling for another platform, or the ./config guess was
554      wrong for other reasons, go to step 1b. Otherwise go to step 2.
555
556      On some systems, you can include debugging information as follows:
557
558        $ ./config -d [[ options ]]
559
560  1b. Configure OpenSSL for your operating system manually
561
562      OpenSSL knows about a range of different operating system, hardware and
563      compiler combinations. To see the ones it knows about, run
564
565        $ ./Configure                                    # Unix
566
567        or
568
569        $ perl Configure                                 # All other platforms
570
571      For the remainder of this text, the Unix form will be used in all
572      examples, please use the appropriate form for your platform.
573
574      Pick a suitable name from the list that matches your system. For most
575      operating systems there is a choice between using "cc" or "gcc".  When
576      you have identified your system (and if necessary compiler) use this name
577      as the argument to Configure. For example, a "linux-elf" user would
578      run:
579
580        $ ./Configure linux-elf [[ options ]]
581
582      If your system isn't listed, you will have to create a configuration
583      file named Configurations/{{ something }}.conf and add the correct
584      configuration for your system. See the available configs as examples
585      and read Configurations/README and Configurations/README.design for
586      more information.
587
588      The generic configurations "cc" or "gcc" should usually work on 32 bit
589      Unix-like systems.
590
591      Configure creates a build file ("Makefile" on Unix, "makefile" on Windows
592      and "descrip.mms" on OpenVMS) from a suitable template in Configurations,
593      and defines various macros in include/openssl/opensslconf.h (generated from
594      include/openssl/opensslconf.h.in).
595
596  1c. Configure OpenSSL for building outside of the source tree.
597
598      OpenSSL can be configured to build in a build directory separate from
599      the directory with the source code.  It's done by placing yourself in
600      some other directory and invoking the configuration commands from
601      there.
602
603      Unix example:
604
605        $ mkdir /var/tmp/openssl-build
606        $ cd /var/tmp/openssl-build
607        $ /PATH/TO/OPENSSL/SOURCE/config [[ options ]]
608
609        or
610
611        $ /PATH/TO/OPENSSL/SOURCE/Configure {{ target }} [[ options ]]
612
613      OpenVMS example:
614
615        $ set default sys$login:
616        $ create/dir [.tmp.openssl-build]
617        $ set default [.tmp.openssl-build]
618        $ @[PATH.TO.OPENSSL.SOURCE]config [[ options ]]
619
620        or
621
622        $ @[PATH.TO.OPENSSL.SOURCE]Configure {{ target }} [[ options ]]
623
624      Windows example:
625
626        $ C:
627        $ mkdir \temp-openssl
628        $ cd \temp-openssl
629        $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure {{ target }} [[ options ]]
630
631      Paths can be relative just as well as absolute.  Configure will
632      do its best to translate them to relative paths whenever possible.
633
634   2. Build OpenSSL by running:
635
636        $ make                                           # Unix
637        $ mms                                            ! (or mmk) OpenVMS
638        $ nmake                                          # Windows
639
640      This will build the OpenSSL libraries (libcrypto.a and libssl.a on
641      Unix, corresponding on other platforms) and the OpenSSL binary
642      ("openssl"). The libraries will be built in the top-level directory,
643      and the binary will be in the "apps" subdirectory.
644
645      If the build fails, look at the output.  There may be reasons
646      for the failure that aren't problems in OpenSSL itself (like
647      missing standard headers).  If you are having problems you can
648      get help by sending an email to the openssl-users email list (see
649      https://www.openssl.org/community/mailinglists.html for details). If
650      it is a bug with OpenSSL itself, please open an issue on GitHub, at
651      https://github.com/openssl/openssl/issues. Please review the existing
652      ones first; maybe the bug was already reported or has already been
653      fixed.
654
655      (If you encounter assembler error messages, try the "no-asm"
656      configuration option as an immediate fix.)
657
658      Compiling parts of OpenSSL with gcc and others with the system
659      compiler will result in unresolved symbols on some systems.
660
661   3. After a successful build, the libraries should be tested. Run:
662
663        $ make test                                      # Unix
664        $ mms test                                       ! OpenVMS
665        $ nmake test                                     # Windows
666
667      NOTE: you MUST run the tests from an unprivileged account (or
668      disable your privileges temporarily if your platform allows it).
669
670      If some tests fail, look at the output.  There may be reasons for
671      the failure that isn't a problem in OpenSSL itself (like a
672      malfunction with Perl).  You may want increased verbosity, that
673      can be accomplished like this:
674
675        $ make VERBOSE=1 test                            # Unix
676
677        $ mms /macro=(VERBOSE=1) test                    ! OpenVMS
678
679        $ nmake VERBOSE=1 test                           # Windows
680
681      If you want to run just one or a few specific tests, you can use
682      the make variable TESTS to specify them, like this:
683
684        $ make TESTS='test_rsa test_dsa' test            # Unix
685        $ mms/macro="TESTS=test_rsa test_dsa" test       ! OpenVMS
686        $ nmake TESTS='test_rsa test_dsa' test           # Windows
687
688      And of course, you can combine (Unix example shown):
689        
690        $ make VERBOSE=1 TESTS='test_rsa test_dsa' test
691
692      You can find the list of available tests like this:
693
694        $ make list-tests                                # Unix
695        $ mms list-tests                                 ! OpenVMS
696        $ nmake list-tests                               # Windows
697
698      Have a look at the manual for the perl module Test::Harness to
699      see what other HARNESS_* variables there are.
700
701      If you find a problem with OpenSSL itself, try removing any
702      compiler optimization flags from the CFLAGS line in Makefile and
703      run "make clean; make" or corresponding.
704
705      Please send bug reports to <rt@openssl.org>.
706
707      For more details on how the make variables TESTS can be used,
708      see section TESTS in Detail below.
709
710   4. If everything tests ok, install OpenSSL with
711
712        $ make install                                   # Unix
713        $ mms install                                    ! OpenVMS
714        $ nmake install                                  # Windows
715
716      This will install all the software components in this directory
717      tree under PREFIX (the directory given with --prefix or its
718      default):
719
720        Unix:
721
722          bin/           Contains the openssl binary and a few other
723                         utility scripts.
724          include/openssl
725                         Contains the header files needed if you want
726                         to build your own programs that use libcrypto
727                         or libssl.
728          lib            Contains the OpenSSL library files.
729          lib/engines    Contains the OpenSSL dynamically loadable engines.
730
731          share/man/man1 Contains the OpenSSL command line man-pages.
732          share/man/man3 Contains the OpenSSL library calls man-pages.
733          share/man/man5 Contains the OpenSSL configuration format man-pages.
734          share/man/man7 Contains the OpenSSL other misc man-pages.
735
736          share/doc/openssl/html/man1
737          share/doc/openssl/html/man3
738          share/doc/openssl/html/man5
739          share/doc/openssl/html/man7
740                         Contains the HTML rendition of the man-pages.
741
742        OpenVMS ('arch' is replaced with the architecture name, "Alpha"
743        or "ia64", 'sover' is replaced with the shared library version
744        (0101 for 1.1), and 'pz' is replaced with the pointer size
745        OpenSSL was built with):
746
747          [.EXE.'arch']  Contains the openssl binary.
748          [.EXE]         Contains a few utility scripts.
749          [.include.openssl]
750                         Contains the header files needed if you want
751                         to build your own programs that use libcrypto
752                         or libssl.
753          [.LIB.'arch']  Contains the OpenSSL library files.
754          [.ENGINES'sover''pz'.'arch']
755                         Contains the OpenSSL dynamically loadable engines.
756          [.SYS$STARTUP] Contains startup, login and shutdown scripts.
757                         These define appropriate logical names and
758                         command symbols.
759          [.SYSTEST]     Contains the installation verification procedure.
760          [.HTML]        Contains the HTML rendition of the manual pages.
761                         
762
763      Additionally, install will add the following directories under
764      OPENSSLDIR (the directory given with --openssldir or its default)
765      for you convenience:
766
767          certs          Initially empty, this is the default location
768                         for certificate files.
769          private        Initially empty, this is the default location
770                         for private key files.
771          misc           Various scripts.
772
773      Package builders who want to configure the library for standard
774      locations, but have the package installed somewhere else so that
775      it can easily be packaged, can use
776
777        $ make DESTDIR=/tmp/package-root install         # Unix
778        $ mms/macro="DESTDIR=TMP:[PACKAGE-ROOT]" install ! OpenVMS
779
780      The specified destination directory will be prepended to all
781      installation target paths.
782
783   Compatibility issues with previous OpenSSL versions:
784
785   *  COMPILING existing applications
786
787      OpenSSL 1.1.0 hides a number of structures that were previously
788      open.  This includes all internal libssl structures and a number
789      of EVP types.  Accessor functions have been added to allow
790      controlled access to the structures' data.
791
792      This means that some software needs to be rewritten to adapt to
793      the new ways of doing things.  This often amounts to allocating
794      an instance of a structure explicitly where you could previously
795      allocate them on the stack as automatic variables, and using the
796      provided accessor functions where you would previously access a
797      structure's field directly.
798
799      Some APIs have changed as well.  However, older APIs have been
800      preserved when possible.
801
802  Environment Variables
803  ---------------------
804
805  A number of environment variables can be used to provide additional control
806  over the build process. Typically these should be defined prior to running
807  config or Configure. Not all environment variables are relevant to all
808  platforms.
809
810  AR
811                 The name of the ar executable to use.
812
813  BUILDFILE
814                 Use a different build file name than the platform default
815                 ("Makefile" on Unixly platforms, "makefile" on native Windows,
816                 "descrip.mms" on OpenVMS).  This requires that there is a
817                 corresponding build file template.  See Configurations/README
818                 for further information.
819
820  CC
821                 The compiler to use. Configure will attempt to pick a default
822                 compiler for your platform but this choice can be overridden
823                 using this variable. Set it to the compiler executable you wish
824                 to use, e.g. "gcc" or "clang".
825
826  CROSS_COMPILE
827                 This environment variable has the same meaning as for the
828                 "--cross-compile-prefix" Configure flag described above. If both
829                 are set then the Configure flag takes precedence.
830
831  NM
832                 The name of the nm executable to use.
833
834  OPENSSL_LOCAL_CONFIG_DIR
835                 OpenSSL comes with a database of information about how it
836                 should be built on different platforms as well as build file
837                 templates for those platforms. The database is comprised of
838                 ".conf" files in the Configurations directory.  The build
839                 file templates reside there as well as ".tmpl" files. See the
840                 file Configurations/README for further information about the
841                 format of ".conf" files as well as information on the ".tmpl"
842                 files.
843                 In addition to the standard ".conf" and ".tmpl" files, it is
844                 possible to create your own ".conf" and ".tmpl" files and store
845                 them locally, outside the OpenSSL source tree. This environment
846                 variable can be set to the directory where these files are held
847                 and will be considered by Configure before it looks in the
848                 standard directories.
849
850  PERL
851                 The name of the Perl executable to use when building OpenSSL.
852                 This variable is used in config script only. Configure on the
853                 other hand imposes the interpreter by which it itself was
854                 executed on the whole build procedure.
855
856  HASHBANGPERL
857                 The command string for the Perl executable to insert in the
858                 #! line of perl scripts that will be publically installed.
859                 Default: /usr/bin/env perl
860                 Note: the value of this variable is added to the same scripts
861                 on all platforms, but it's only relevant on Unix-like platforms.
862
863  RC
864                 The name of the rc executable to use. The default will be as
865                 defined for the target platform in the ".conf" file. If not
866                 defined then "windres" will be used. The WINDRES environment
867                 variable is synonymous to this. If both are defined then RC
868                 takes precedence.
869
870  RANLIB
871                 The name of the ranlib executable to use.
872
873  WINDRES
874                 See RC.
875
876  Makefile targets
877  ----------------
878
879  The Configure script generates a Makefile in a format relevant to the specific
880  platform. The Makefiles provide a number of targets that can be used. Not all
881  targets may be available on all platforms. Only the most common targets are
882  described here. Examine the Makefiles themselves for the full list.
883
884  all
885                 The default target to build all the software components.
886
887  clean
888                 Remove all build artefacts and return the directory to a "clean"
889                 state.
890
891  depend
892                 Rebuild the dependencies in the Makefiles. This is a legacy
893                 option that no longer needs to be used in OpenSSL 1.1.0.
894
895  install
896                 Install all OpenSSL components.
897
898  install_sw
899                 Only install the OpenSSL software components.
900
901  install_docs
902                 Only install the OpenSSL documentation components.
903
904  install_man_docs
905                 Only install the OpenSSL man pages (Unix only).
906
907  install_html_docs
908                 Only install the OpenSSL html documentation.
909
910  list-tests
911                 Prints a list of all the self test names.
912
913  test
914                 Build and run the OpenSSL self tests.
915
916  uninstall
917                 Uninstall all OpenSSL components.
918
919  update
920                 This is a developer option. If you are developing a patch for
921                 OpenSSL you may need to use this if you want to update
922                 automatically generated files; add new error codes or add new
923                 (or change the visibility of) public API functions. (Unix only).
924
925  TESTS in Detail
926  ---------------
927
928  The make variable TESTS supports a versatile set of space separated tokens
929  with which you can specify a set of tests to be performed.  With a "current
930  set of tests" in mind, initially being empty, here are the possible tokens:
931
932  alltests       The current set of tests becomes the whole set of available
933                 tests (as listed when you do 'make list-tests' or similar).
934  xxx            Adds the test 'xxx' to the current set of tests.
935  -xxx           Removes 'xxx' from the current set of tests.  If this is the
936                 first token in the list, the current set of tests is first
937                 assigned the whole set of available tests, effectively making
938                 this token equivalent to TESTS="alltests -xxx".
939  nn             Adds the test group 'nn' (which is a number) to the current
940                 set of tests.
941  -nn            Removes the test group 'nn' from the current set of tests.
942                 If this is the first token in the list, the current set of
943                 tests is first assigned the whole set of available tests,
944                 effectively making this token equivalent to
945                 TESTS="alltests -xxx".
946
947  Also, all tokens except for "alltests" may have wildcards, such as *.
948  (on Unix and Windows, BSD style wildcards are supported, while on VMS,
949  it's VMS style wildcards)
950
951  Example: All tests except for the fuzz tests:
952
953  $ make TESTS=-test_fuzz test
954
955  or (if you want to be explicit)
956
957  $ make TESTS='alltests -test_fuzz' test
958
959  Example: All tests that have a name starting with "test_ssl" but not those
960  starting with "test_ssl_":
961
962  $ make TESTS='test_ssl* -test_ssl_*' test
963
964  Example: Only test group 10:
965
966  $ make TESTS='10'
967
968  Example: All tests except the slow group (group 99):
969
970  $ make TESTS='-99'
971
972  Example: All tests in test groups 80 to 99 except for tests in group 90:
973
974  $ make TESTS='[89]? -90'
975
976  Note on multi-threading
977  -----------------------
978
979  For some systems, the OpenSSL Configure script knows what compiler options
980  are needed to generate a library that is suitable for multi-threaded
981  applications.  On these systems, support for multi-threading is enabled
982  by default; use the "no-threads" option to disable (this should never be
983  necessary).
984
985  On other systems, to enable support for multi-threading, you will have
986  to specify at least two options: "threads", and a system-dependent option.
987  (The latter is "-D_REENTRANT" on various systems.)  The default in this
988  case, obviously, is not to include support for multi-threading (but
989  you can still use "no-threads" to suppress an annoying warning message
990  from the Configure script.)
991
992  OpenSSL provides built-in support for two threading models: pthreads (found on
993  most UNIX/Linux systems), and Windows threads. No other threading models are
994  supported. If your platform does not provide pthreads or Windows threads then
995  you should Configure with the "no-threads" option.
996
997  Notes on shared libraries
998  -------------------------
999
1000  For most systems the OpenSSL Configure script knows what is needed to
1001  build shared libraries for libcrypto and libssl. On these systems
1002  the shared libraries will be created by default. This can be suppressed and
1003  only static libraries created by using the "no-shared" option. On systems
1004  where OpenSSL does not know how to build shared libraries the "no-shared"
1005  option will be forced and only static libraries will be created.
1006
1007  Shared libraries are named a little differently on different platforms.
1008  One way or another, they all have the major OpenSSL version number as
1009  part of the file name, i.e. for OpenSSL 1.1.x, 1.1 is somehow part of
1010  the name.
1011
1012  On most POSIXly platforms, shared libraries are named libcrypto.so.1.1
1013  and libssl.so.1.1.
1014
1015  on Cygwin, shared libraries are named cygcrypto-1.1.dll and cygssl-1.1.dll
1016  with import libraries libcrypto.dll.a and libssl.dll.a.
1017
1018  On Windows build with MSVC or using MingW, shared libraries are named
1019  libcrypto-1_1.dll and libssl-1_1.dll for 32-bit Windows, libcrypto-1_1-x64.dll
1020  and libssl-1_1-x64.dll for 64-bit x86_64 Windows, and libcrypto-1_1-ia64.dll
1021  and libssl-1_1-ia64.dll for IA64 Windows.  With MSVC, the import libraries
1022  are named libcrypto.lib and libssl.lib, while with MingW, they are named
1023  libcrypto.dll.a and libssl.dll.a.
1024
1025  On VMS, shareable images (VMS speak for shared libraries) are named
1026  ossl$libcrypto0101_shr.exe and ossl$libssl0101_shr.exe.  However, when
1027  OpenSSL is specifically built for 32-bit pointers, the shareable images
1028  are named ossl$libcrypto0101_shr32.exe and ossl$libssl0101_shr32.exe
1029  instead, and when built for 64-bit pointers, they are named
1030  ossl$libcrypto0101_shr64.exe and ossl$libssl0101_shr64.exe.
1031
1032  Note on random number generation
1033  --------------------------------
1034
1035  Availability of cryptographically secure random numbers is required for
1036  secret key generation. OpenSSL provides several options to seed the
1037  internal PRNG. If not properly seeded, the internal PRNG will refuse
1038  to deliver random bytes and a "PRNG not seeded error" will occur.
1039  On systems without /dev/urandom (or similar) device, it may be necessary
1040  to install additional support software to obtain a random seed.
1041  Please check out the manual pages for RAND_add(), RAND_bytes(), RAND_egd(),
1042  and the FAQ for more information.
1043