INSTALL.md 58.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13
Build and Install
=================

This document describes installation on all supported operating
systems (the Unix/Linux family, including macOS), OpenVMS,
and Windows).

Table of Contents
=================

 - [Prerequisites](#prerequisites)
 - [Notational Conventions](#notational-conventions)
 - [Quick Installation Guide](#quick-installation-guide)
R
Rich Salz 已提交
14 15
   - [Building OpenSSL](#building-openssl)
   - [Installing OpenSSL](#installing-openssl)
16
 - [Configuration Options](#configuration-options)
R
Rich Salz 已提交
17 18 19 20 21 22 23
   - [API Level](#api-level)
   - [Cross Compile Prefix](#cross-compile-prefix)
   - [Build Type](#build-type)
   - [Directories](#directories)
   - [Compiler Warnings](#compiler-warnings)
   - [ZLib Flags](#zlib-flags)
   - [Seeding the Random Generator](#seeding-the-random-generator)
24
   - [Setting the FIPS HMAC key](#setting-the-FIPS-HMAC-key)
R
Rich Salz 已提交
25 26
   - [Enable and Disable Features](#enable-and-disable-features)
   - [Displaying configuration data](#displaying-configuration-data)
27
 - [Installation Steps in Detail](#installation-steps-in-detail)
R
Rich Salz 已提交
28 29 30 31
   - [Configure](#configure-openssl)
   - [Build](#build-openssl)
   - [Test](#test-openssl)
   - [Install](#install-openssl)
32
 - [Advanced Build Options](#advanced-build-options)
R
Rich Salz 已提交
33 34 35
   - [Environment Variables](#environment-variables)
   - [Makefile Targets](#makefile-targets)
   - [Running Selected Tests](#running-selected-tests)
36
 - [Troubleshooting](#troubleshooting)
R
Rich Salz 已提交
37 38 39
   - [Configuration Problems](#configuration-problems)
   - [Build Failures](#build-failures)
   - [Test Failures](#test-failures)
40
 - [Notes](#notes)
R
Rich Salz 已提交
41 42 43
   - [Notes on multi-threading](#notes-on-multi-threading)
   - [Notes on shared libraries](#notes-on-shared-libraries)
   - [Notes on random number generation](#notes-on-random-number-generation)
44

45 46
Prerequisites
=============
47

48
To install OpenSSL, you will need:
49

50
 * A "make" implementation
51 52
 * Perl 5 with core modules (please read [NOTES-Perl.md](NOTES-Perl.md))
 * The Perl module `Text::Template` (please read [NOTES-PERL.md](NOTES-Perl.md))
53 54 55 56
 * an ANSI C compiler
 * a development environment in the form of development libraries and C
   header files
 * a supported operating system
57

58 59
For additional platform specific requirements, solutions to specific
issues and other details, please read one of these:
60

61 62 63 64 65 66 67
 * [NOTES-Unix.md](NOTES-Unix.md) - notes for Unix like systems
 * [NOTES-VMS.md](NOTES-VMS.md) - notes related to OpenVMS
 * [NOTES-Windows.txt](NOTES-Windows.txt) - notes related to the Windows platform
 * [NOTES-DJGPP.md](NOTES-DJGPP.md) - building for DOS with DJGPP
 * [NOTES-Android.md](NOTES-Android.md) - building for Android platforms (using NDK)
 * [NOTES-Valgrind.md](NOTES-Valgrind.md) - testing with Valgrind
 * [NOTES-Perl.m](NOTES-Perl.md) - some notes on Perl
68

69 70
Notational conventions
======================
71

72
Throughout this document, we use the following conventions.
73

74 75
Commands
--------
76

77
Any line starting with a dollar sign is a command line.
78

79
    $ command
80

81 82
The dollar sign indicates the shell prompt and is not to be entered as
part of the command.
83

84 85
Choices
-------
86

87 88 89
Several words in curly braces separated by pipe characters indicate a
**mandatory choice**, to be replaced with one of the given words.
For example, the line
90

91
    $ echo { WORD1 | WORD2 | WORD3 }
92

93
represents one of the following three commands
94

95 96 97 98 99
    $ echo WORD1
    - or -
    $ echo WORD2
    - or -
    $ echo WORD3
100

101 102 103
One or several words in square brackets separated by pipe characters
denote an **optional choice**.  It is similar to the mandatory choice,
but it can also be omitted entirely.
104

105
So the line
106

107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
    $ echo [ WORD1 | WORD2 | WORD3 ]

represents one of the four commands

    $ echo WORD1
    - or -
    $ echo WORD2
    - or -
    $ echo WORD3
    - or -
    $ echo

Arguments
---------

**Mandatory arguments** are enclosed in double curly braces.
A simple example would be

    $ type {{ filename }}

which is to be understood to use the command `type` on some file name
determined by the user.

**Optional Arguments** are enclosed in double square brackets.

    [[ options ]]

134 135
Note that the notation assumes spaces around `{`, `}`, `[`, `]`, `{{`, `}}` and
`[[`, `]]`.  This is to differentiate from OpenVMS directory
136 137 138 139 140 141 142 143
specifications, which also use [ and ], but without spaces.

Quick Installation Guide
========================

If you just want to get OpenSSL installed without bothering too much
about the details, here is the short version of how to build and install
OpenSSL.  If any of the following steps fails, please consult the
144
[Installation in Detail](#installation-steps-in-detail) section below.
145 146 147 148 149 150 151 152

Building OpenSSL
----------------

Use the following commands to configure, build and test OpenSSL.
The testing is optional, but recommended if you intend to install
OpenSSL for production use.

R
Rich Salz 已提交
153
### Unix / Linux / macOS
154

155
    $ ./Configure
156 157 158
    $ make
    $ make test

R
Rich Salz 已提交
159
### OpenVMS
160 161

Use the following commands to build OpenSSL:
162

163
    $ perl Configure
164 165
    $ mms
    $ mms test
166

R
Rich Salz 已提交
167
### Windows
168 169

If you are using Visual Studio, open a Developer Command Prompt and
G
Gustaf Neumann 已提交
170
issue the following commands to build OpenSSL.
171

172
    $ perl Configure
173 174
    $ nmake
    $ nmake test
175 176 177 178

As mentioned in the [Choices](#choices) section, you need to pick one
of the four Configure targets in the first command.

179 180 181 182
Most likely you will be using the `VC-WIN64A` target for 64bit Windows
binaries (AMD64) or `VC-WIN32` for 32bit Windows binaries (X86).
The other two options are `VC-WIN64I` (Intel IA64, Itanium) and
`VC-CE` (Windows CE) are rather uncommon nowadays.
183 184 185 186 187 188 189 190 191 192 193 194

Installing OpenSSL
------------------

The following commands will install OpenSSL to a default system location.

**Danger Zone:** even if you are impatient, please read the following two
paragraphs carefully before you install OpenSSL.

For security reasons the default system location is by default not writable
for unprivileged users.  So for the final installation step administrative
privileges are required.  The default system location and the procedure to
G
Gustaf Neumann 已提交
195
obtain administrative privileges depends on the operating system.
196 197 198 199 200 201 202 203 204 205
It is recommended to compile and test OpenSSL with normal user privileges
and use administrative privileges only for the final installation step.

On some platforms OpenSSL is preinstalled as part of the Operating System.
In this case it is highly recommended not to overwrite the system versions,
because other applications or libraries might depend on it.
To avoid breaking other applications, install your copy of OpenSSL to a
[different location](#installing-to-a-different-location) which is not in
the global search path for system libraries.

206 207 208
Finally, if you plan on using the FIPS module, you need to read the
[Post-installation Notes](#post-installation-notes) further down.

R
Rich Salz 已提交
209
### Unix / Linux / macOS
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228

Depending on your distribution, you need to run the following command as
root user or prepend `sudo` to the command:

    $ make install

By default, OpenSSL will be installed to

    /usr/local

More precisely, the files will be installed into the  subdirectories

    /usr/local/bin
    /usr/local/lib
    /usr/local/include
    ...

depending on the file type, as it is custom on Unix-like operating systems.

R
Rich Salz 已提交
229
### OpenVMS
230 231 232 233 234 235 236 237 238 239 240 241

Use the following command to install OpenSSL.

    $ mms install

By default, OpenSSL will be installed to

    SYS$COMMON:[OPENSSL-'version'...]

where 'version' is the OpenSSL version number with underscores instead
of periods.

R
Rich Salz 已提交
242
### Windows
243 244 245 246

If you are using Visual Studio, open the Developer Command Prompt _elevated_
and issue the following command.

247
    $ nmake install
248

249 250 251 252 253 254 255
The easiest way to elevate the Command Prompt is to press and hold down
the both the `<CTRL>` and `<SHIFT>` key while clicking the menu item in the
task menu.

The default installation location is

    C:\Program Files\OpenSSL
M
Matt Caswell 已提交
256

257
for native binaries, or
U
Ulf Möller 已提交
258

259
    C:\Program Files (x86)\OpenSSL
260

261
for 32bit binaries on 64bit Windows (WOW64).
262

R
Rich Salz 已提交
263
#### Installing to a different location
264

265
To install OpenSSL to a different location (for example into your home
266
directory for testing purposes) run `Configure` as shown in the following
267
examples.
268

269
On Unix:
270

271
    $ ./Configure --prefix=/opt/openssl --openssldir=/usr/local/ssl
272

273
On OpenVMS:
274

275
    $ perl Configure --prefix=PROGRAM:[INSTALLS] --openssldir=SYS$MANAGER:[OPENSSL]
276

277
Note: if you do add options to the configuration command, please make sure
278
you've read more than just this Quick Start, such as relevant `NOTES-*` files,
279 280 281 282 283 284
the options outline below, as configuration options may change the outcome
in otherwise unexpected ways.

Configuration Options
=====================

285 286
There are several options to `./Configure` to customize the build (note that
for Windows, the defaults for `--prefix` and `--openssldir` depend on what
287
configuration is used and what Windows implementation OpenSSL is built on.
288
More notes on this in [NOTES-Windows.txt](NOTES-Windows.txt):
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310

API Level
---------

    --api=x.y[.z]

Build the OpenSSL libraries to support the API for the specified version.
If [no-deprecated](#no-deprecated) is also given, don't build with support
for deprecated APIs in or below the specified version number.  For example,
addding

    --api=1.1.0 no-deprecated

will remove support for all APIs that were deprecated in OpenSSL version
1.1.0 or below.  This is a rather specialized option for developers.
If you just intend to remove all deprecated APIs up to the current version
entirely, just specify [no-deprecated](#no-deprecated).
If `--api` isn't given, it defaults to the current (minor) OpenSSL version.

Cross Compile Prefix
--------------------

311
    --cross-compile-prefix=<PREFIX>
312

313
The `<PREFIX>` to include in front of commands for your toolchain.
314

315 316
It is likely to have to end with dash, e.g. `a-b-c-` would invoke GNU compiler
as `a-b-c-gcc`, etc.  Unfortunately cross-compiling is too case-specific to put
317
together one-size-fits-all instructions.  You might have to pass more flags or
318 319 320 321 322 323 324 325 326 327 328 329 330
set up environment variables to actually make it work.  Android and iOS cases
are discussed in corresponding `Configurations/15-*.conf` files.  But there are
cases when this option alone is sufficient.  For example to build the mingw64
target on Linux `--cross-compile-prefix=x86_64-w64-mingw32-` works.  Naturally
provided that mingw packages are installed.  Today Debian and Ubuntu users
have option to install a number of prepackaged cross-compilers along with
corresponding run-time and development packages for "alien" hardware.  To give
another example `--cross-compile-prefix=mipsel-linux-gnu-` suffices in such
case.

For cross compilation, you must [configure manually](#manual-configuration).
Also, note that `--openssldir` refers to target's file system, not one you are
building on.
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345

Build Type
----------

    --debug

Build OpenSSL with debugging symbols and zero optimization level.

    --release

Build OpenSSL without debugging symbols.  This is the default.

Directories
-----------

R
Rich Salz 已提交
346
### libdir
347 348 349 350 351

    --libdir=DIR

The name of the directory under the top of the installation directory tree
(see the `--prefix` option) where libraries will be installed.  By default
352
this is `lib/`. Note that on Windows only static libraries (`*.lib`) will
353
be stored in this location. Shared libraries (`*.dll`) will always be
354
installed to the `bin/` directory.
355

R
Rich Salz 已提交
356
### openssldir
357 358 359 360 361 362 363 364 365 366 367 368 369

    --openssldir=DIR

Directory for OpenSSL configuration files, and also the default certificate
and key store.  Defaults are:

    Unix:           /usr/local/ssl
    Windows:        C:\Program Files\Common Files\SSL
    OpenVMS:        SYS$COMMON:[OPENSSL-COMMON]

For 32bit Windows applications on Windows 64bit (WOW64), always replace
`C:\Program Files` by `C:\Program Files (x86)`.

R
Rich Salz 已提交
370
### prefix
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392

    --prefix=DIR

The top of the installation directory tree.  Defaults are:

    Unix:           /usr/local
    Windows:        C:\Program Files\OpenSSL
    OpenVMS:        SYS$COMMON:[OPENSSL-'version']

Compiler Warnings
-----------------

    --strict-warnings

This is a developer flag that switches on various compiler options recommended
for OpenSSL development.  It only works when using gcc or clang as the compiler.
If you are developing a patch for OpenSSL then it is recommended that you use
this option where possible.

ZLib Flags
----------

R
Rich Salz 已提交
393
### with-zlib-include
394 395 396 397

    --with-zlib-include=DIR

The directory for the location of the zlib include file.  This option is only
398
necessary if [zlib](#zlib) is used and the include file is not
399 400
already on the system include path.

R
Rich Salz 已提交
401
### with-zlib-lib
402 403 404 405 406 407 408 409

    --with-zlib-lib=LIB

**On Unix**: this is the directory containing the zlib library.
If not provided the system library path will be used.

**On Windows:** this is the filename of the zlib library (with or
without a path).  This flag must be provided if the
410 411
[zlib-dynamic](#zlib-dynamic) option is not also used. If `zlib-dynamic` is used
then this flag is optional and defaults to `ZLIB1` if not provided.
412 413

**On VMS:** this is the filename of the zlib library (with or without a path).
414 415
This flag is optional and if not provided then `GNV$LIBZSHR`, `GNV$LIBZSHR32`
or `GNV$LIBZSHR64` is used by default depending on the pointer size chosen.
416 417 418 419 420 421 422 423 424 425 426

Seeding the Random Generator
----------------------------

    --with-rand-seed=seed1[,seed2,...]

A comma separated list of seeding methods which will be tried by OpenSSL
in order to obtain random input (a.k.a "entropy") for seeding its
cryptographically secure random number generator (CSPRNG).
The current seeding methods are:

R
Rich Salz 已提交
427
### os
428 429 430 431

Use a trusted operating system entropy source.
This is the default method if such an entropy source exists.

R
Rich Salz 已提交
432
### getrandom
433 434 435 436 437

Use the [getrandom(2)][man-getrandom] or equivalent system call.

[man-getrandom]: http://man7.org/linux/man-pages/man2/getrandom.2.html

R
Rich Salz 已提交
438
### devrandom
439

440 441
Use the first device from the `DEVRANDOM` list which can be opened to read
random bytes.  The `DEVRANDOM` preprocessor constant expands to
442 443 444 445 446

    "/dev/urandom","/dev/random","/dev/srandom"

on most unix-ish operating systems.

R
Rich Salz 已提交
447
### egd
448 449

Check for an entropy generating daemon.
450
This source is ignored by the FIPS provider.
451

R
Rich Salz 已提交
452
### rdcpu
453

454
Use the `RDSEED` or `RDRAND` command if provided by the CPU.
455

R
Rich Salz 已提交
456
### librandom
457 458

Use librandom (not implemented yet).
459
This source is ignored by the FIPS provider.
460

R
Rich Salz 已提交
461
### none
462 463 464

Disable automatic seeding.  This is the default on some operating systems where
no suitable entropy source exists, or no support for it is implemented yet.
465
This option is ignored by the FIPS provider.
466 467 468 469 470 471

For more information, see the section [Notes on random number generation][rng]
at the end of this document.

[rng]: #notes-on-random-number-generation

472 473 474 475 476 477 478 479 480 481 482 483 484
Setting the FIPS HMAC key
-------------------------

    --fips-key=value

As part of its self-test validation, the FIPS module must verify itself
by performing a SHA-256 HMAC computation on itself. The default key is
the SHA256 value of "the holy handgrenade of antioch" and is sufficient
for meeting the FIPS requirements.

To change the key to a different value, use this flag. The value should
be a hex string no more than 64 characters.

485 486 487
Enable and Disable Features
---------------------------

G
Gustaf Neumann 已提交
488 489
Feature options always come in pairs, an option to enable feature
`xxxx`, and an option to disable it:
490 491 492 493 494

    [ enable-xxxx | no-xxxx ]

Whether a feature is enabled or disabled by default, depends on the feature.
In the following list, always the non-default variant is documented: if
495 496
feature `xxxx` is disabled by default then `enable-xxxx` is documented and
if feature `xxxx` is enabled by default then `no-xxxx` is documented.
497

R
Rich Salz 已提交
498
### no-afalgeng
499 500 501 502 503

Don't build the AFALG engine.

This option will be forced on a platform that does not support AFALG.

R
Rich Salz 已提交
504
### enable-ktls
505 506 507 508 509 510 511 512 513

Build with Kernel TLS support.

This option will enable the use of the Kernel TLS data-path, which can improve
performance and allow for the use of sendfile and splice system calls on
TLS sockets.  The Kernel may use TLS accelerators if any are available on the
system.  This option will be forced off on systems that do not support the
Kernel TLS data-path.

R
Rich Salz 已提交
514
### enable-asan
515 516 517 518 519 520 521 522

Build with the Address sanitiser.

This is a developer option only.  It may not work on all platforms and should
never be used in production environments.  It will only work when used with
gcc or clang and should be used in conjunction with the [no-shared](#no-shared)
option.

S
Shane Lontis 已提交
523 524 525 526 527 528 529 530 531 532
### no-acvp_tests

Do not build support for Automated Cryptographic Validation Protocol (ACVP)
tests.

This is required for FIPS validation purposes. Certain ACVP tests require
access to algorithm internals that are not normally accessible.
Additional information related to ACVP can be found at
<https://github.com/usnistgov/ACVP>.

R
Rich Salz 已提交
533
### no-asm
534 535 536 537 538 539 540

Do not use assembler code.

This should be viewed as debugging/troubleshooting option rather than for
production use.  On some platforms a small amount of assembler code may still
be used even with this option.

R
Rich Salz 已提交
541
### no-async
542 543 544

Do not build support for async operations.

R
Rich Salz 已提交
545
### no-autoalginit
546 547 548 549 550 551

Don't automatically load all supported ciphers and digests.

Typically OpenSSL will make available all of its supported ciphers and digests.
For a statically linked application this may be undesirable if small executable
size is an objective.  This only affects libcrypto.  Ciphers and digests will
552 553
have to be loaded manually using `EVP_add_cipher()` and `EVP_add_digest()`
if this option is used.  This option will force a non-shared build.
554

R
Rich Salz 已提交
555
### no-autoerrinit
556 557 558 559 560 561 562

Don't automatically load all libcrypto/libssl error strings.

Typically OpenSSL will automatically load human readable error strings.  For a
statically linked application this may be undesirable if small executable size
is an objective.

R
Rich Salz 已提交
563
### no-autoload-config
564

565
Don't automatically load the default `openssl.cnf` file.
566 567 568 569

Typically OpenSSL will automatically load a system config file which configures
default SSL options.

R
Rich Salz 已提交
570
### enable-buildtest-c++
571 572 573 574 575 576 577

While testing, generate C++ buildtest files that simply check that the public
OpenSSL header files are usable standalone with C++.

Enabling this option demands extra care.  For any compiler flag given directly
as configuration option, you must ensure that it's valid for both the C and
the C++ compiler.  If not, the C++ build test will most likely break.  As an
578
alternative, you can use the language specific variables, `CFLAGS` and `CXXFLAGS`.
579

580 581 582 583 584
### no-bulk

Build only some minimal set of features.
This is a developer option used internally for CI build tests of the project.

R
Rich Salz 已提交
585
### no-capieng
586 587 588 589 590

Don't build the CAPI engine.

This option will be forced if on a platform that does not support CAPI.

R
Rich Salz 已提交
591
### no-cmp
592

593 594
Don't build support for Certificate Management Protocol (CMP)
and Certificate Request Message Format (CRMF).
595

R
Rich Salz 已提交
596
### no-cms
597 598 599

Don't build support for Cryptographic Message Syntax (CMS).

R
Rich Salz 已提交
600
### no-comp
601 602 603 604

Don't build support for SSL/TLS compression.

If this option is enabled (the default), then compression will only work if
605
the zlib or `zlib-dynamic` options are also chosen.
606

R
Rich Salz 已提交
607
### enable-crypto-mdebug
608

609
This now only enables the `failed-malloc` feature.
610

R
Rich Salz 已提交
611
### enable-crypto-mdebug-backtrace
612 613 614

This is a no-op; the project uses the compiler's address/leak sanitizer instead.

R
Rich Salz 已提交
615
### no-ct
616 617 618

Don't build support for Certificate Transparency (CT).

R
Rich Salz 已提交
619
### no-deprecated
620 621 622 623

Don't build with support for deprecated APIs up until and including the version
given with `--api` (or the current version, if `--api` wasn't specified).

R
Rich Salz 已提交
624
### no-dgram
625 626 627 628 629

Don't build support for datagram based BIOs.

Selecting this option will also force the disabling of DTLS.

R
Rich Salz 已提交
630
### no-dso
631 632 633

Don't build support for loading Dynamic Shared Objects (DSO)

R
Rich Salz 已提交
634
### enable-devcryptoeng
635 636 637 638

Build the `/dev/crypto` engine.

This option is automatically selected on the BSD platform, in which case it can
639
be disabled with `no-devcryptoeng`.
640

R
Rich Salz 已提交
641
### no-dynamic-engine
642 643 644 645 646

Don't build the dynamically loaded engines.

This only has an effect in a shared build.

R
Rich Salz 已提交
647
### no-ec
648 649 650

Don't build support for Elliptic Curves.

R
Rich Salz 已提交
651
### no-ec2m
652 653 654

Don't build support for binary Elliptic Curves

R
Rich Salz 已提交
655
### enable-ec_nistp_64_gcc_128
656 657 658 659 660 661 662 663 664 665 666 667

Enable support for optimised implementations of some commonly used NIST
elliptic curves.

This option is only supported on platforms:

 - with little-endian storage of non-byte types
 - that tolerate misaligned memory references
 - where the compiler:
   - supports the non-standard type `__uint128_t`
   - defines the built-in macro `__SIZEOF_INT128__`

R
Rich Salz 已提交
668
### enable-egd
669 670 671

Build support for gathering entropy from the Entropy Gathering Daemon (EGD).

R
Rich Salz 已提交
672
### no-engine
673 674 675

Don't build support for loading engines.

R
Rich Salz 已提交
676
### no-err
677 678 679

Don't compile in any error strings.

R
Rich Salz 已提交
680
### enable-external-tests
681 682 683 684 685 686 687 688 689 690

Enable building of integration with external test suites.

This is a developer option and may not work on all platforms.  The following
external test suites are currently supported:

 - BoringSSL test suite
 - Python PYCA/Cryptography test suite
 - krb5 test suite

691 692
See the file [test/README-external.md](test/README-external.md)
for further details.
693

R
Rich Salz 已提交
694
### no-filenames
695 696 697 698

Don't compile in filename and line number information (e.g.  for errors and
memory allocation).

R
Rich Salz 已提交
699
### no-fips
700 701 702

Don't compile the FIPS provider

703 704 705 706 707
### no-fips-securitychecks

Don't perform FIPS module run-time checks related to enforcement of security
parameters such as minimum security strength of keys.

R
Rich Salz 已提交
708
### enable-fuzz-libfuzzer, enable-fuzz-afl
709 710 711 712 713 714 715 716

Build with support for fuzzing using either libfuzzer or AFL.

These are developer options only.  They may not work on all  platforms and
should never be used in production environments.

See the file [fuzz/README.md](fuzz/README.md) for further details.

R
Rich Salz 已提交
717
### no-gost
718 719 720 721 722 723 724

Don't build support for GOST based ciphersuites.

Note that if this feature is enabled then GOST ciphersuites are only available
if the GOST algorithms are also available through loading an externally supplied
engine.

R
Rich Salz 已提交
725
### no-legacy
726 727 728 729 730

Don't build the legacy provider.

Disabling this also disables the legacy algorithms: MD2 (already disabled by default).

R
Rich Salz 已提交
731
### no-makedepend
732 733 734

Don't generate dependencies.

R
Rich Salz 已提交
735
### no-module
736

737
Don't build any dynamically loadable engines.
738

739
This also implies `no-dynamic-engine`.
740

R
Rich Salz 已提交
741
### no-multiblock
742

743
Don't build support for writing multiple records in one go in libssl
744

745
Note: this is a different capability to the pipelining functionality.
746

R
Rich Salz 已提交
747
### no-nextprotoneg
748

749
Don't build support for the Next Protocol Negotiation (NPN) TLS extension.
750

R
Rich Salz 已提交
751
### no-ocsp
752

753
Don't build support for Online Certificate Status Protocol (OCSP).
754

R
Rich Salz 已提交
755
### no-padlockeng
756

757
Don't build the padlock engine.
758

R
Rich Salz 已提交
759
### no-hw-padlock
760

761
As synonym for `no-padlockeng`.  Deprecated and should not be used.
762

R
Rich Salz 已提交
763
### no-pic
U
Ulf Möller 已提交
764

765
Don't build with support for Position Independent Code.
U
Ulf Möller 已提交
766

R
Rich Salz 已提交
767
### no-pinshared
768

769
Don't pin the shared libraries.
770

771 772
By default OpenSSL will attempt to stay in memory until the process exits.
This is so that libcrypto and libssl can be properly cleaned up automatically
773 774
via an `atexit()` handler.  The handler is registered by libcrypto and cleans
up both libraries.  On some platforms the `atexit()` handler will run on unload of
775 776 777 778
libcrypto (if it has been dynamically loaded) rather than at process exit.  This
option can be used to stop OpenSSL from attempting to stay in memory until the
process exits.  This could lead to crashes if either libcrypto or libssl have
already been unloaded at the point that the atexit handler is invoked, e.g.  on a
779
platform which calls `atexit()` on unload of the library, and libssl is unloaded
780
before libcrypto then a crash is likely to happen.  Applications can suppress
781 782 783
running of the `atexit()` handler at run time by using the
`OPENSSL_INIT_NO_ATEXIT` option to `OPENSSL_init_crypto()`.
See the man page for it for further details.
784

R
Rich Salz 已提交
785
### no-posix-io
786

787
Don't use POSIX IO capabilities.
788

R
Rich Salz 已提交
789
### no-psk
790

791
Don't build support for Pre-Shared Key based ciphersuites.
792

R
Rich Salz 已提交
793
### no-rdrand
794

795
Don't use hardware RDRAND capabilities.
796

R
Rich Salz 已提交
797
### no-rfc3779
798

799 800
Don't build support for RFC3779, "X.509 Extensions for IP Addresses and
AS Identifiers".
801

R
Rich Salz 已提交
802
### sctp
803

804
Build support for Stream Control Transmission Protocol (SCTP).
805

R
Rich Salz 已提交
806
### no-shared
807

808
Do not create shared libraries, only static ones.
809

810
See [Notes on shared libraries](#notes-on-shared-libraries) below.
811

R
Rich Salz 已提交
812
### no-sock
813

814
Don't build support for socket BIOs.
815

R
Rich Salz 已提交
816
### no-srp
817

818 819
Don't build support for Secure Remote Password (SRP) protocol or
SRP based ciphersuites.
820

R
Rich Salz 已提交
821
### no-srtp
822

823
Don't build Secure Real-Time Transport Protocol (SRTP) support.
824

R
Rich Salz 已提交
825
### no-sse2
826

827
Exclude SSE2 code paths from 32-bit x86 assembly modules.
828

829 830 831 832 833
Normally SSE2 extension is detected at run-time, but the decision whether or not
the machine code will be executed is taken solely on CPU capability vector.  This
means that if you happen to run OS kernel which does not support SSE2 extension
on Intel P4 processor, then your application might be exposed to "illegal
instruction" exception.  There might be a way to enable support in kernel, e.g.
834
FreeBSD kernel can be compiled with `CPU_ENABLE_SSE`, and there is a way to
835
disengage SSE2 code paths upon application start-up, but if you aim for wider
836 837
"audience" running such kernel, consider `no-sse2`.  Both the `386` and `no-asm`
options imply `no-sse2`.
838

R
Rich Salz 已提交
839
### enable-ssl-trace
840

841
Build with the SSL Trace capabilities.
842

843
This adds the `-trace` option to `s_client` and `s_server`.
844

R
Rich Salz 已提交
845
### no-static-engine
846

847
Don't build the statically linked engines.
848

849
This only has an impact when not built "shared".
850

R
Rich Salz 已提交
851
### no-stdio
852

853
Don't use anything from the C header file `stdio.h` that makes use of the `FILE`
854 855 856
type.  Only libcrypto and libssl can be built in this way.  Using this option will
suppress building the command line applications.  Additionally, since the OpenSSL
tests also use the command line applications, the tests will also be skipped.
U
Ulf Möller 已提交
857

R
Rich Salz 已提交
858
### no-tests
859

860
Don't build test programs or run any tests.
861

R
Rich Salz 已提交
862
### no-threads
863

864
Don't build with support for multi-threaded applications.
865

R
Rich Salz 已提交
866
### threads
867

868
Build with support for multi-threaded applications.  Most platforms will enable
G
Gustaf Neumann 已提交
869
this by default.  However, if on a platform where this is not the case then this
870
will usually require additional system-dependent options!
871

872
See [Notes on multi-threading](#notes-on-multi-threading) below.
873

R
Rich Salz 已提交
874
### enable-trace
875

876
Build with support for the integrated tracing api.
877

878
See manual pages OSSL_trace_set_channel(3) and OSSL_trace_enabled(3) for details.
879

R
Rich Salz 已提交
880
### no-ts
881

882
Don't build Time Stamping (TS) Authority support.
883

R
Rich Salz 已提交
884
### enable-ubsan
885

886
Build with the Undefined Behaviour sanitiser (UBSAN).
887

888
This is a developer option only.  It may not work on all platforms and should
889 890
never be used in production environments.  It will only work when used with
gcc or clang and should be used in conjunction with the `-DPEDANTIC` option
891
(or the `--strict-warnings` option).
892

R
Rich Salz 已提交
893
### no-ui-console
894

895
Don't build with the User Interface (UI) console method
U
Ulf Möller 已提交
896

897
The User Interface console method enables text based console prompts.
898

R
Rich Salz 已提交
899
### enable-unit-test
900

901
Enable additional unit test APIs.
902

903
This should not typically be used in production deployments.
M
Matt Caswell 已提交
904

R
Rich Salz 已提交
905
### no-uplink
906

907
Don't build support for UPLINK interface.
908

R
Rich Salz 已提交
909
### enable-weak-ssl-ciphers
910

911
Build support for SSL/TLS ciphers that are considered "weak"
M
Matt Caswell 已提交
912

913
Enabling this includes for example the RC4 based ciphersuites.
M
Matt Caswell 已提交
914

R
Rich Salz 已提交
915
### zlib
M
Matt Caswell 已提交
916

917
Build with support for zlib compression/decompression.
M
Matt Caswell 已提交
918

R
Rich Salz 已提交
919
### zlib-dynamic
M
Matt Caswell 已提交
920

921 922
Like the zlib option, but has OpenSSL load the zlib library dynamically
when needed.
M
Matt Caswell 已提交
923

924
This is only supported on systems where loading of shared libraries is supported.
M
Matt Caswell 已提交
925

R
Rich Salz 已提交
926
### 386
M
Matt Caswell 已提交
927

928
In 32-bit x86 builds, use the 80386 instruction set only in assembly modules
M
Matt Caswell 已提交
929

930 931 932
The default x86 code is more efficient, but requires at least an 486 processor.
Note: This doesn't affect compiler generated code, so this option needs to be
accompanied by a corresponding compiler-specific option.
M
Matt Caswell 已提交
933

R
Rich Salz 已提交
934
### no-{protocol}
935

936
    no-{ssl|ssl3|tls|tls1|tls1_1|tls1_2|tls1_3|dtls|dtls1|dtls1_2}
937

938
Don't build support for negotiating the specified SSL/TLS protocol.
939

940 941 942 943
If `no-tls` is selected then all of `tls1`, `tls1_1`, `tls1_2` and `tls1_3`
are disabled.
Similarly `no-dtls` will disable `dtls1` and `dtls1_2`.  The `no-ssl` option is
synonymous with `no-ssl3`.  Note this only affects version negotiation.
944 945
OpenSSL will still provide the methods for applications to explicitly select
the individual protocol versions.
946

R
Rich Salz 已提交
947
### no-{protocol}-method
948

949
    no-{ssl|ssl3|tls|tls1|tls1_1|tls1_2|tls1_3|dtls|dtls1|dtls1_2}-method
950

951
Analogous to `no-{protocol}` but in addition do not build the methods for
952
applications to explicitly select individual protocol versions.  Note that there
953
is no `no-tls1_3-method` option because there is no application method for
954
TLSv1.3.
955

956
Using individual protocol methods directly is deprecated.  Applications should
957
use `TLS_method()` instead.
958

R
Rich Salz 已提交
959
### enable-{algorithm}
960

961
    enable-{md2|rc5}
962

963
Build with support for the specified algorithm.
964

R
Rich Salz 已提交
965
### no-{algorithm}
966

967 968 969 970
    no-{aria|bf|blake2|camellia|cast|chacha|cmac|
        des|dh|dsa|ecdh|ecdsa|idea|md4|mdc2|ocb|
        poly1305|rc2|rc4|rmd160|scrypt|seed|
        siphash|siv|sm2|sm3|sm4|whirlpool}
971

972
Build without support for the specified algorithm.
973

974
The `ripemd` algorithm is deprecated and if used is synonymous with `rmd160`.
975

R
Rich Salz 已提交
976
### Compiler-specific options
977

978
    -Dxxx, -Ixxx, -Wp, -lxxx, -Lxxx, -Wl, -rpath, -R, -framework, -static
979

980 981 982 983 984 985 986 987 988 989 990 991 992 993 994
These system specific options will be recognised and passed through to the
compiler to allow you to define preprocessor symbols, specify additional
libraries, library directories or other compiler options.  It might be worth
noting that some compilers generate code specifically for processor the
compiler currently executes on.  This is not necessarily what you might have
in mind, since it might be unsuitable for execution on other, typically older,
processor.  Consult your compiler documentation.

Take note of the [Environment Variables](#environment-variables) documentation
below and how these flags interact with those variables.

    -xxx, +xxx, /xxx

Additional options that are not otherwise recognised are passed through as
they are to the compiler as well.  Unix-style options beginning with a
995
`-` or `+` and Windows-style options beginning with a `/` are recognized.
996 997 998
Again, consult your compiler documentation.

If the option contains arguments separated by spaces, then the URL-style
999 1000
notation `%20` can be used for the space character in order to avoid having
to quote the option.  For example, `-opt%20arg` gets expanded to `-opt arg`.
1001 1002 1003 1004 1005 1006
In fact, any ASCII character can be encoded as %xx using its hexadecimal
encoding.

Take note of the [Environment Variables](#environment-variables) documentation
below and how these flags interact with those variables.

R
Rich Salz 已提交
1007
### Environment Variables
1008 1009 1010

    VAR=value

1011
Assign the given value to the environment variable `VAR` for `Configure`.
1012 1013 1014 1015 1016 1017

These work just like normal environment variable assignments, but are supported
on all platforms and are confined to the configuration scripts only.
These assignments override the corresponding value in the inherited environment,
if there is one.

1018
The following variables are used as "`make` variables" and can be used as an
1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061
alternative to giving preprocessor, compiler and linker options directly as
configuration.  The following variables are supported:

    AR              The static library archiver.
    ARFLAGS         Flags for the static library archiver.
    AS              The assembler compiler.
    ASFLAGS         Flags for the assembler compiler.
    CC              The C compiler.
    CFLAGS          Flags for the C compiler.
    CXX             The C++ compiler.
    CXXFLAGS        Flags for the C++ compiler.
    CPP             The C/C++ preprocessor.
    CPPFLAGS        Flags for the C/C++ preprocessor.
    CPPDEFINES      List of CPP macro definitions, separated
                    by a platform specific character (':' or
                    space for Unix, ';' for Windows, ',' for
                    VMS).  This can be used instead of using
                    -D (or what corresponds to that on your
                    compiler) in CPPFLAGS.
    CPPINCLUDES     List of CPP inclusion directories, separated
                    the same way as for CPPDEFINES.  This can
                    be used instead of -I (or what corresponds
                    to that on your compiler) in CPPFLAGS.
    HASHBANGPERL    Perl invocation to be inserted after '#!'
                    in public perl scripts (only relevant on
                    Unix).
    LD              The program linker (not used on Unix, $(CC)
                    is used there).
    LDFLAGS         Flags for the shared library, DSO and
                    program linker.
    LDLIBS          Extra libraries to use when linking.
                    Takes the form of a space separated list
                    of library specifications on Unix and
                    Windows, and as a comma separated list of
                    libraries on VMS.
    RANLIB          The library archive indexer.
    RC              The Windows resource compiler.
    RCFLAGS         Flags for the Windows resource compiler.
    RM              The command to remove files and directories.

These cannot be mixed with compiling/linking flags given on the command line.
In other words, something like this isn't permitted.

1062
    $ ./Configure -DFOO CPPFLAGS=-DBAR -DCOOKIE
1063 1064 1065 1066 1067 1068 1069 1070 1071

Backward compatibility note:

To be compatible with older configuration scripts, the environment variables
are ignored if compiling/linking flags are given on the command line, except
for the following:

    AR, CC, CXX, CROSS_COMPILE, HASHBANGPERL, PERL, RANLIB, RC, and WINDRES

1072
For example, the following command will not see `-DBAR`:
1073

1074
    $ CPPFLAGS=-DBAR ./Configure -DCOOKIE
1075 1076 1077

However, the following will see both set variables:

1078
    $ CC=gcc CROSS_COMPILE=x86_64-w64-mingw32- ./Configure -DCOOKIE
1079

1080
If `CC` is set, it is advisable to also set `CXX` to ensure both the C and C++
1081
compiler are in the same "family".  This becomes relevant with
1082
`enable-external-tests` and `enable-buildtest-c++`.
1083

R
Rich Salz 已提交
1084
### Reconfigure
1085 1086 1087 1088 1089 1090

    reconf
    reconfigure

Reconfigure from earlier data.

1091
This fetches the previous command line options and environment from data
1092
saved in `configdata.pm` and runs the configuration process again, using
1093
these options and environment.  Note: NO other option is permitted together
1094
with `reconf`.  Note: The original configuration saves away values for ALL
1095 1096 1097 1098
environment variables that were used, and if they weren't defined, they are
still saved away with information that they weren't originally defined.
This information takes precedence over environment variables that are
defined when reconfiguring.
1099 1100 1101 1102 1103

Displaying configuration data
-----------------------------

The configuration script itself will say very little, and finishes by
1104
creating `configdata.pm`.  This perl module can be loaded by other scripts
1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121
to find all the configuration data, and it can also be used as a script to
display all sorts of configuration data in a human readable form.

For more information, please do:

    $ ./configdata.pm --help                         # Unix

or

    $ perl configdata.pm --help                      # Windows and VMS

Installation Steps in Detail
============================

Configure OpenSSL
-----------------

R
Rich Salz 已提交
1122
### Automatic Configuration
1123 1124 1125 1126 1127 1128 1129

On some platform a `config` script is available which attempts to guess
your operating system (and compiler, if necessary) and calls the `Configure`
Perl script with appropriate target based on its guess.  Further options can
be supplied to the `config` script, which will be passed on to the `Configure`
script.

R
Rich Salz 已提交
1130
#### Unix / Linux / macOS
1131

1132
    $ ./Configure [[ options ]]
1133

R
Rich Salz 已提交
1134
#### OpenVMS
1135

1136
    $ perl Configure [[ options ]]
1137

R
Rich Salz 已提交
1138
#### Windows
1139

1140
    $ perl Configure [[ options ]]
1141

R
Rich Salz 已提交
1142
### Manual Configuration
1143 1144 1145 1146

OpenSSL knows about a range of different operating system, hardware and
compiler combinations.  To see the ones it knows about, run

1147
    $ ./Configure LIST                               # Unix
1148 1149 1150

or

1151
    $ perl Configure LIST                            # All other platforms
1152 1153 1154 1155 1156

For the remainder of this text, the Unix form will be used in all examples.
Please use the appropriate form for your platform.

Pick a suitable name from the list that matches your system.  For most
1157
operating systems there is a choice between using cc or gcc.
1158
When you have identified your system (and if necessary compiler) use this
1159
name as the argument to `Configure`.  For example, a `linux-elf` user would
1160 1161 1162 1163
run:

    $ ./Configure linux-elf [[ options ]]

R
Rich Salz 已提交
1164
### Creating your own Configuration
1165 1166

If your system isn't listed, you will have to create a configuration
1167
file named `Configurations/{{ something }}.conf` and add the correct
1168
configuration for your system.  See the available configs as examples
1169 1170
and read [Configurations/README.md](Configurations/README.md) and
[Configurations/README-design.md](Configurations/README-design.md)
1171
for more information.
1172

1173
The generic configurations `cc` or `gcc` should usually work on 32 bit
1174 1175
Unix-like systems.

1176 1177 1178 1179
`Configure` creates a build file (`Makefile` on Unix, `makefile` on Windows
and `descrip.mms` on OpenVMS) from a suitable template in `Configurations/`,
and defines various macros in `include/openssl/configuration.h` (generated
from `include/openssl/configuration.h.in`.
1180

R
Rich Salz 已提交
1181
### Out of Tree Builds
1182 1183 1184 1185 1186

OpenSSL can be configured to build in a build directory separate from the
source code directory.  It's done by placing yourself in some other
directory and invoking the configuration commands from there.

R
Rich Salz 已提交
1187
#### Unix example
1188 1189 1190

    $ mkdir /var/tmp/openssl-build
    $ cd /var/tmp/openssl-build
1191
    $ /PATH/TO/OPENSSL/SOURCE/Configure [[ options ]]
1192

R
Rich Salz 已提交
1193
#### OpenVMS example
1194 1195 1196 1197

    $ set default sys$login:
    $ create/dir [.tmp.openssl-build]
    $ set default [.tmp.openssl-build]
1198
    $ perl D:[PATH.TO.OPENSSL.SOURCE]Configure [[ options ]]
1199

R
Rich Salz 已提交
1200
#### Windows example
1201 1202 1203 1204

    $ C:
    $ mkdir \temp-openssl
    $ cd \temp-openssl
1205
    $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure [[ options ]]
1206

1207
Paths can be relative just as well as absolute.  `Configure` will do its best
1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218
to translate them to relative paths whenever possible.

Build OpenSSL
-------------

Build OpenSSL by running:

    $ make                                           # Unix
    $ mms                                            ! (or mmk) OpenVMS
    $ nmake                                          # Windows

1219
This will build the OpenSSL libraries (`libcrypto.a` and `libssl.a` on
1220
Unix, corresponding on other platforms) and the OpenSSL binary
1221 1222
(`openssl`).  The libraries will be built in the top-level directory,
and the binary will be in the `apps/` subdirectory.
1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239

If the build fails, take a look at the [Build Failures](#build-failures)
subsection of the [Troubleshooting](#troubleshooting) section.

Test OpenSSL
------------

After a successful build, and before installing, the libraries should
be tested.  Run:

    $ make test                                      # Unix
    $ mms test                                       ! OpenVMS
    $ nmake test                                     # Windows

**Warning:** you MUST run the tests from an unprivileged account (or disable
your privileges temporarily if your platform allows it).

1240 1241 1242
See [test/README.md](test/README.md) for further details how run tests.

See [test/README-dev.md](test/README-dev.md) for guidelines on adding tests.
1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256

Install OpenSSL
---------------

If everything tests ok, install OpenSSL with

    $ make install                                   # Unix
    $ mms install                                    ! OpenVMS
    $ nmake install                                  # Windows

Note that in order to perform the install step above you need to have
appropriate permissions to write to the installation directory.

The above commands will install all the software components in this
1257
directory tree under `<PREFIX>` (the directory given with `--prefix` or
1258 1259
its default):

R
Rich Salz 已提交
1260
### Unix / Linux / macOS
1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281

    bin/           Contains the openssl binary and a few other
                   utility scripts.
    include/openssl
                   Contains the header files needed if you want
                   to build your own programs that use libcrypto
                   or libssl.
    lib            Contains the OpenSSL library files.
    lib/engines    Contains the OpenSSL dynamically loadable engines.

    share/man/man1 Contains the OpenSSL command line man-pages.
    share/man/man3 Contains the OpenSSL library calls man-pages.
    share/man/man5 Contains the OpenSSL configuration format man-pages.
    share/man/man7 Contains the OpenSSL other misc man-pages.

    share/doc/openssl/html/man1
    share/doc/openssl/html/man3
    share/doc/openssl/html/man5
    share/doc/openssl/html/man7
                   Contains the HTML rendition of the man-pages.

R
Rich Salz 已提交
1282
### OpenVMS
1283

1284 1285
'arch' is replaced with the architecture name, `Alpha` or `ia64`,
'sover' is replaced with the shared library version (`0101` for 1.1), and
1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302
'pz' is replaced with the pointer size OpenSSL was built with:

    [.EXE.'arch']  Contains the openssl binary.
    [.EXE]         Contains a few utility scripts.
    [.include.openssl]
                   Contains the header files needed if you want
                   to build your own programs that use libcrypto
                   or libssl.
    [.LIB.'arch']  Contains the OpenSSL library files.
    [.ENGINES'sover''pz'.'arch']
                   Contains the OpenSSL dynamically loadable engines.
    [.SYS$STARTUP] Contains startup, login and shutdown scripts.
                   These define appropriate logical names and
                   command symbols.
    [.SYSTEST]     Contains the installation verification procedure.
    [.HTML]        Contains the HTML rendition of the manual pages.

R
Rich Salz 已提交
1303
### Additional Directories
1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324

Additionally, install will add the following directories under
OPENSSLDIR (the directory given with `--openssldir` or its default)
for you convenience:

    certs          Initially empty, this is the default location
                   for certificate files.
    private        Initially empty, this is the default location
                   for private key files.
    misc           Various scripts.

The installation directory should be appropriately protected to ensure
unprivileged users cannot make changes to OpenSSL binaries or files, or
install engines.  If you already have a pre-installed version of OpenSSL as
part of your Operating System it is recommended that you do not overwrite
the system version and instead install to somewhere else.

Package builders who want to configure the library for standard locations,
but have the package installed somewhere else so that it can easily be
packaged, can use

1325 1326
    $ make DESTDIR=/tmp/package-root install         # Unix
    $ mms/macro="DESTDIR=TMP:[PACKAGE-ROOT]" install ! OpenVMS
1327 1328 1329 1330

The specified destination directory will be prepended to all installation
target paths.

R
Rich Salz 已提交
1331 1332
Compatibility issues with previous OpenSSL versions
---------------------------------------------------
1333

R
Rich Salz 已提交
1334
### COMPILING existing applications
1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349

Starting with version 1.1.0, OpenSSL hides a number of structures that were
previously open.  This includes all internal libssl structures and a number
of EVP types.  Accessor functions have been added to allow controlled access
to the structures' data.

This means that some software needs to be rewritten to adapt to the new ways
of doing things.  This often amounts to allocating an instance of a structure
explicitly where you could previously allocate them on the stack as automatic
variables, and using the provided accessor functions where you would previously
access a structure's field directly.

Some APIs have changed as well.  However, older APIs have been preserved when
possible.

1350 1351 1352 1353 1354 1355 1356
Post-installation Notes
-----------------------

With the default OpenSSL installation comes a FIPS provider module, which
needs some post-installation attention, without which it will not be usable.
This involves using the following command:

1357
    $ openssl fipsinstall
1358 1359 1360

See the openssl-fipsinstall(1) manual for details and examples.

1361 1362 1363 1364 1365 1366 1367 1368
Advanced Build Options
======================

Environment Variables
---------------------

A number of environment variables can be used to provide additional control
over the build process.  Typically these should be defined prior to running
1369
`Configure`.  Not all environment variables are relevant to all platforms.
1370 1371 1372 1373 1374 1375 1376 1377

    AR
                   The name of the ar executable to use.

    BUILDFILE
                   Use a different build file name than the platform default
                   ("Makefile" on Unix-like platforms, "makefile" on native Windows,
                   "descrip.mms" on OpenVMS).  This requires that there is a
1378 1379
                   corresponding build file template.
                   See [Configurations/README.md](Configurations/README.md)
1380 1381 1382 1383 1384 1385
                   for further information.

    CC
                   The compiler to use. Configure will attempt to pick a default
                   compiler for your platform but this choice can be overridden
                   using this variable. Set it to the compiler executable you wish
1386
                   to use, e.g. gcc or clang.
1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401

    CROSS_COMPILE
                   This environment variable has the same meaning as for the
                   "--cross-compile-prefix" Configure flag described above. If both
                   are set then the Configure flag takes precedence.

    NM
                   The name of the nm executable to use.

    OPENSSL_LOCAL_CONFIG_DIR
                   OpenSSL comes with a database of information about how it
                   should be built on different platforms as well as build file
                   templates for those platforms. The database is comprised of
                   ".conf" files in the Configurations directory.  The build
                   file templates reside there as well as ".tmpl" files. See the
1402 1403 1404
                   file [Configurations/README.md](Configurations/README.md)
                   for further information about the format of ".conf" files
                   as well as information on the ".tmpl" files.
1405
                   In addition to the standard ".conf" and ".tmpl" files, it is
1406 1407 1408 1409 1410
                   possible to create your own ".conf" and ".tmpl" files and
                   store them locally, outside the OpenSSL source tree.
                   This environment variable can be set to the directory where
                   these files are held and will be considered by Configure
                   before it looks in the standard directories.
1411 1412 1413

    PERL
                   The name of the Perl executable to use when building OpenSSL.
1414 1415
                   Only needed if builing should use a different Perl executable
                   than what is used to run the Configure script.
1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439

    HASHBANGPERL
                   The command string for the Perl executable to insert in the
                   #! line of perl scripts that will be publicly installed.
                   Default: /usr/bin/env perl
                   Note: the value of this variable is added to the same scripts
                   on all platforms, but it's only relevant on Unix-like platforms.

    RC
                   The name of the rc executable to use. The default will be as
                   defined for the target platform in the ".conf" file. If not
                   defined then "windres" will be used. The WINDRES environment
                   variable is synonymous to this. If both are defined then RC
                   takes precedence.

    RANLIB
                   The name of the ranlib executable to use.

    WINDRES
                   See RC.

Makefile Targets
----------------

1440
The `Configure` script generates a Makefile in a format relevant to the specific
1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476
platform.  The Makefiles provide a number of targets that can be used.  Not all
targets may be available on all platforms.  Only the most common targets are
described here.  Examine the Makefiles themselves for the full list.

    all
                   The target to build all the software components and
                   documentation.

    build_sw
                   Build all the software components.
                   THIS IS THE DEFAULT TARGET.

    build_docs
                   Build all documentation components.

    clean
                   Remove all build artefacts and return the directory to a "clean"
                   state.

    depend
                   Rebuild the dependencies in the Makefiles. This is a legacy
                   option that no longer needs to be used since OpenSSL 1.1.0.

    install
                   Install all OpenSSL components.

    install_sw
                   Only install the OpenSSL software components.

    install_docs
                   Only install the OpenSSL documentation components.

    install_man_docs
                   Only install the OpenSSL man pages (Unix only).

    install_html_docs
G
Gustaf Neumann 已提交
1477
                   Only install the OpenSSL HTML documentation.
1478

1479 1480
    install_fips
                   Install the FIPS provider module configuration file.
1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504

    list-tests
                   Prints a list of all the self test names.

    test
                   Build and run the OpenSSL self tests.

    uninstall
                   Uninstall all OpenSSL components.

    reconfigure
    reconf
                   Re-run the configuration process, as exactly as the last time
                   as possible.

    update
                   This is a developer option. If you are developing a patch for
                   OpenSSL you may need to use this if you want to update
                   automatically generated files; add new error codes or add new
                   (or change the visibility of) public API functions. (Unix only).

Running Selected Tests
----------------------

1505 1506
You can specify a set of tests to be performed
using the `make` variable `TESTS`.
1507

1508 1509
See the section [Running Selected Tests of
test/README.md](test/README.md#running-selected-tests).
1510 1511 1512 1513 1514 1515 1516

Troubleshooting
===============

Configuration Problems
----------------------

R
Rich Salz 已提交
1517
### Selecting the correct target
1518

1519
The `./Configure` script tries hard to guess your operating system, but in some
1520 1521
cases it does not succeed. You will see a message like the following:

1522
    $ ./Configure
1523
    Operating system: x86-whatever-minix
1524
    This system (minix) is not supported. See file INSTALL.md for details.
1525

1526 1527 1528 1529
Even if the automatic target selection by the `./Configure` script fails,
chances are that you still might find a suitable target in the `Configurations`
directory, which you can supply to the `./Configure` command,
possibly after some adjustment.
1530

1531
The `Configurations/` directory contains a lot of examples of such targets.
1532
The main configuration file is [10-main.conf], which contains all targets that
1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548
are officially supported by the OpenSSL team. Other configuration files contain
targets contributed by other OpenSSL users. The list of targets can be found in
a Perl list `my %targets = ( ... )`.

    my %targets = (
    ...
    "target-name" => {
        inherit_from     => [ "base-target" ],
        CC               => "...",
        cflags           => add("..."),
        asm_arch         => '...',
        perlasm_scheme   => "...",
    },
    ...
    )

1549
If you call `./Configure` without arguments, it will give you a list of all
1550
known targets. Using `grep`, you can lookup the target definition in the
1551 1552
`Configurations/` directory. For example the `android-x86_64` can be found in
[Configurations/15-android.conf](Configurations/15-android.conf).
1553 1554

The directory contains two README files, which explain the general syntax and
1555
design of the configuration files.
1556

1557 1558
 - [Configurations/README.md](Configurations/README.md)
 - [Configurations/README-design.md](Configurations/README-design.md)
1559

1560 1561 1562
If you need further help, try to search the [openssl-users] mailing list
or the [GitHub Issues] for existing solutions. If you don't find anything,
you can [raise an issue] to ask a question yourself.
1563

1564
More about our support resources can be found in the [SUPPORT] file.
1565

R
Rich Salz 已提交
1566
### Configuration Errors
1567

1568
If the `./Configure` or `./Configure` command fails with an error message,
1569 1570 1571
read the error message carefully and try to figure out whether you made
a mistake (e.g., by providing a wrong option), or whether the script is
working incorrectly. If you think you encountered a bug, please
1572
[raise an issue] on GitHub to file a bug report.
1573 1574 1575 1576 1577 1578 1579 1580

Along with a short description of the bug, please provide the complete
configure command line and the relevant output including the error message.

Note: To make the output readable, pleace add a 'code fence' (three backquotes
` ``` ` on a separate line) before and after your output:

     ```
1581
     ./Configure [your arguments...]
1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600

     [output...]

     ```

Build Failures
--------------

If the build fails, look carefully at the output. Try to locate and understand
the error message. It might be that the compiler is already telling you
exactly what you need to do to fix your problem.

There may be reasons for the failure that aren't problems in OpenSSL itself,
for example if the compiler reports missing standard or third party headers.

If the build succeeded previously, but fails after a source or configuration
change, it might be helpful to clean the build tree before attempting another
build.  Use this command:

1601 1602 1603
    $ make clean                                     # Unix
    $ mms clean                                      ! (or mmk) OpenVMS
    $ nmake clean                                    # Windows
1604 1605

Assembler error messages can sometimes be sidestepped by using the
1606
`no-asm` configuration option.
1607 1608 1609 1610

Compiling parts of OpenSSL with gcc and others with the system compiler will
result in unresolved symbols on some systems.

1611 1612 1613
If you are still having problems, try to search the [openssl-users] mailing
list or the [GitHub Issues] for existing solutions. If you think you
encountered an OpenSSL bug, please [raise an issue] to file a bug report.
1614 1615 1616 1617 1618 1619 1620
Please take the time to review the existing issues first; maybe the bug was
already reported or has already been fixed.

Test Failures
-------------

If some tests fail, look at the output.  There may be reasons for the failure
1621
that isn't a problem in OpenSSL itself (like an OS malfunction or a Perl issue).
1622

1623 1624
You may want increased verbosity, that can be accomplished as described in
section [Test Failures of test/README.md](test/README.md#test-failures).
1625

1626 1627 1628
You may also want to selectively specify which test(s) to perform. This can be
done using the `make` variable `TESTS` as described in section [Running
Selected Tests of test/README.md](test/README.md#running-selected-tests).
1629 1630

If you find a problem with OpenSSL itself, try removing any
1631 1632
compiler optimization flags from the `CFLAGS` line in the Makefile and
run `make clean; make` or corresponding.
1633 1634

To report a bug please open an issue on GitHub, at
R
Rich Salz 已提交
1635
<https://github.com/openssl/openssl/issues>.
1636 1637 1638 1639 1640 1641 1642

Notes
=====

Notes on multi-threading
------------------------

1643
For some systems, the OpenSSL `Configure` script knows what compiler options
1644 1645
are needed to generate a library that is suitable for multi-threaded
applications.  On these systems, support for multi-threading is enabled
1646
by default; use the `no-threads` option to disable (this should never be
1647 1648 1649
necessary).

On other systems, to enable support for multi-threading, you will have
1650 1651
to specify at least two options: `threads`, and a system-dependent option.
(The latter is `-D_REENTRANT` on various systems.)  The default in this
1652
case, obviously, is not to include support for multi-threading (but
1653 1654
you can still use `no-threads` to suppress an annoying warning message
from the `Configure` script.)
1655 1656 1657 1658

OpenSSL provides built-in support for two threading models: pthreads (found on
most UNIX/Linux systems), and Windows threads.  No other threading models are
supported.  If your platform does not provide pthreads or Windows threads then
1659
you should use `Configure` with the `no-threads` option.
1660 1661 1662 1663

Notes on shared libraries
-------------------------

1664
For most systems the OpenSSL `Configure` script knows what is needed to
1665 1666
build shared libraries for libcrypto and libssl.  On these systems
the shared libraries will be created by default.  This can be suppressed and
1667 1668
only static libraries created by using the `no-shared` option.  On systems
where OpenSSL does not know how to build shared libraries the `no-shared`
1669 1670 1671 1672
option will be forced and only static libraries will be created.

Shared libraries are named a little differently on different platforms.
One way or another, they all have the major OpenSSL version number as
1673
part of the file name, i.e.  for OpenSSL 1.1.x, `1.1` is somehow part of
1674 1675
the name.

1676 1677
On most POSIX platforms, shared libraries are named `libcrypto.so.1.1`
and `libssl.so.1.1`.
1678

1679 1680
on Cygwin, shared libraries are named `cygcrypto-1.1.dll` and `cygssl-1.1.dll`
with import libraries `libcrypto.dll.a` and `libssl.dll.a`.
1681 1682

On Windows build with MSVC or using MingW, shared libraries are named
1683 1684 1685 1686 1687
`libcrypto-1_1.dll` and `libssl-1_1.dll` for 32-bit Windows,
`libcrypto-1_1-x64.dll` and `libssl-1_1-x64.dll` for 64-bit x86_64 Windows,
and `libcrypto-1_1-ia64.dll` and `libssl-1_1-ia64.dll` for IA64 Windows.
With MSVC, the import libraries are named `libcrypto.lib` and `libssl.lib`,
while with MingW, they are named `libcrypto.dll.a` and `libssl.dll.a`.
1688 1689

On VMS, shareable images (VMS speak for shared libraries) are named
1690
`ossl$libcrypto0101_shr.exe` and `ossl$libssl0101_shr.exe`.  However, when
1691
OpenSSL is specifically built for 32-bit pointers, the shareable images
1692
are named `ossl$libcrypto0101_shr32.exe` and `ossl$libssl0101_shr32.exe`
1693
instead, and when built for 64-bit pointers, they are named
1694
`ossl$libcrypto0101_shr64.exe` and `ossl$libssl0101_shr64.exe`.
1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705

Notes on random number generation
---------------------------------

Availability of cryptographically secure random numbers is required for
secret key generation.  OpenSSL provides several options to seed the
internal CSPRNG.  If not properly seeded, the internal CSPRNG will refuse
to deliver random bytes and a "PRNG not seeded error" will occur.

The seeding method can be configured using the `--with-rand-seed` option,
which can be used to specify a comma separated list of seed methods.
G
Gustaf Neumann 已提交
1706
However, in most cases OpenSSL will choose a suitable default method,
1707
so it is not necessary to explicitly provide this option.  Note also
1708 1709
that not all methods are available on all platforms.  The FIPS provider will
silently ignore seed sources that were not validated.
1710 1711 1712 1713 1714 1715 1716

I) On operating systems which provide a suitable randomness source (in
form  of a system call or system device), OpenSSL will use the optimal
available  method to seed the CSPRNG from the operating system's
randomness sources.  This corresponds to the option `--with-rand-seed=os`.

II) On systems without such a suitable randomness source, automatic seeding
1717
and reseeding is disabled (`--with-rand-seed=none`) and it may be necessary
1718
to install additional support software to obtain a random seed and reseed
1719 1720
the CSPRNG manually.  Please check out the manual pages for `RAND_add()`,
`RAND_bytes()`, `RAND_egd()`, and the FAQ for more information.
1721 1722 1723 1724

<!-- Links  -->

[openssl-users]:
R
Rich Salz 已提交
1725
    <https://mta.openssl.org/mailman/listinfo/openssl-users>
1726 1727 1728 1729 1730

[SUPPORT]:
    ./SUPPORT.md

[GitHub Issues]:
R
Rich Salz 已提交
1731
    <https://github.com/openssl/openssl/issues>
1732 1733

[raise an issue]:
R
Rich Salz 已提交
1734
    <https://github.com/openssl/openssl/issues/new/choose>
1735 1736 1737

[10-main.conf]:
    Configurations/10-main.conf