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