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