INSTALL

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