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