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