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