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