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