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