More tweaks to the installation instructions
A few things were out of date and a few things were missing. Also some formatting updates. Reviewed-by: Richard Levitte <levitte@openssl.org>
This commit is contained in:
Matt Caswell
157
INSTALL
157
INSTALL
@@ -1,13 +1,13 @@
|
|||||||
|
|
||||||
INSTALLATION ON THE UNIX PLATFORM
|
OPENSSL INSTALLATION
|
||||||
---------------------------------
|
--------------------
|
||||||
|
|
||||||
[Installation on DOS (with djgpp), Windows, MacOS (before MacOS X)
|
[Installation on DOS (with djgpp), MacOS (before MacOS X)
|
||||||
and NetWare is described in INSTALL.DJGPP, INSTALL.MacOS
|
and NetWare is described in INSTALL.DJGPP, INSTALL.MacOS
|
||||||
and INSTALL.NW.
|
and INSTALL.NW.
|
||||||
|
|
||||||
This document describes installation on the main supported operating
|
This document describes installation on the main supported operating
|
||||||
systems, currently the Unix family and OpenVMS.]
|
systems, currently the Linux/Unix family, OpenVMS and Windows.]
|
||||||
|
|
||||||
To install OpenSSL, you will need:
|
To install OpenSSL, you will need:
|
||||||
|
|
||||||
@@ -15,7 +15,7 @@
|
|||||||
* Perl 5 with core modules (please read README.PERL)
|
* Perl 5 with core modules (please read README.PERL)
|
||||||
* The perl module Text::Template (please read README.PERL)
|
* The perl module Text::Template (please read README.PERL)
|
||||||
* an ANSI C compiler
|
* an ANSI C compiler
|
||||||
* a development environment in form of development libraries and C
|
* a development environment in the form of development libraries and C
|
||||||
header files
|
header files
|
||||||
* a supported operating system
|
* a supported operating system
|
||||||
|
|
||||||
@@ -76,83 +76,91 @@
|
|||||||
There are several options to ./config (or ./Configure) to customize
|
There are several options to ./config (or ./Configure) to customize
|
||||||
the build:
|
the build:
|
||||||
|
|
||||||
--prefix=DIR The top of the installation directory tree. Defaults are:
|
--prefix=DIR The top of the installation directory tree. Defaults are:
|
||||||
|
|
||||||
Unix: /usr/local
|
Unix: /usr/local
|
||||||
OpenVMS: SYS$COMMON:[OPENSSL-'version']
|
OpenVMS: SYS$COMMON:[OPENSSL-'version']
|
||||||
|
|
||||||
--openssldir=DIR Directory for OpenSSL configuration files, and also the
|
--openssldir=DIR Directory for OpenSSL configuration files, and also the
|
||||||
default certificate and key store. Defaults are:
|
default certificate and key store. Defaults are:
|
||||||
|
|
||||||
Unix: PREFIX/ssl (PREFIX is given by --prefix)
|
Unix: PREFIX/ssl (PREFIX is given by --prefix)
|
||||||
OpenVMS: SYS$COMMON:[SSL]
|
OpenVMS: SYS$COMMON:[SSL]
|
||||||
|
|
||||||
no-autoalginit Don't automatically load all supported ciphers and digests.
|
--api=x.y.z Don't build with support for deprecated APIs below the
|
||||||
Typically OpenSSL will make available all of its supported
|
specified version number. For example "--api=1.1.0" will
|
||||||
ciphers and digests. For a statically linked application this
|
remove support for all APIS that were deprecated in OpenSSL
|
||||||
may be undesirable if small executable size is an objective.
|
version 1.1.0 or below.
|
||||||
This only affects libcrypto. Ciphers and digests will have to be
|
|
||||||
loaded manually using EVP_add_cipher() and EVP_add_digest() if
|
|
||||||
this option is used.
|
|
||||||
|
|
||||||
no-autoerrinit Don't automatically load all libcrypto/libssl error strings.
|
no-deprecated Don't build with support for any deprecated APIs. This is the
|
||||||
Typically OpenSSL will automatically load human readable error
|
same as using "--api" and supplying the latest version
|
||||||
strings. For a statically linked application this may be
|
number.
|
||||||
undesirable if small executable size is an objective.
|
|
||||||
|
|
||||||
no-threads Don't try to build with support for multi-threaded
|
no-autoalginit Don't automatically load all supported ciphers and digests.
|
||||||
applications.
|
Typically OpenSSL will make available all of its supported
|
||||||
|
ciphers and digests. For a statically linked application this
|
||||||
|
may be undesirable if small executable size is an objective.
|
||||||
|
This only affects libcrypto. Ciphers and digests will have to
|
||||||
|
be loaded manually using EVP_add_cipher() and
|
||||||
|
EVP_add_digest() if this option is used.
|
||||||
|
|
||||||
threads Build with support for multi-threaded applications.
|
no-autoerrinit Don't automatically load all libcrypto/libssl error strings.
|
||||||
This will usually require additional system-dependent options!
|
Typically OpenSSL will automatically load human readable
|
||||||
See "Note on multi-threading" below.
|
error strings. For a statically linked application this may
|
||||||
|
be undesirable if small executable size is an objective.
|
||||||
|
|
||||||
no-zlib Don't try to build with support for zlib compression and
|
no-threads Don't try to build with support for multi-threaded
|
||||||
decompression.
|
applications.
|
||||||
|
|
||||||
zlib Build with support for zlib compression/decompression.
|
threads Build with support for multi-threaded applications.
|
||||||
|
This will usually require additional system-dependent
|
||||||
|
options! See "Note on multi-threading" below.
|
||||||
|
|
||||||
zlib-dynamic Like "zlib", but has OpenSSL load the zlib library dynamically
|
no-zlib Don't try to build with support for zlib compression and
|
||||||
when needed. This is only supported on systems where loading
|
decompression.
|
||||||
of shared libraries is supported. This is the default choice.
|
|
||||||
|
|
||||||
no-shared Don't try to create shared libraries.
|
zlib Build with support for zlib compression/decompression.
|
||||||
|
|
||||||
shared In addition to the usual static libraries, create shared
|
zlib-dynamic Like "zlib", but has OpenSSL load the zlib library
|
||||||
libraries on platforms where it's supported. See "Note on
|
dynamically when needed. This is only supported on systems
|
||||||
shared libraries" below.
|
where loading of shared libraries is supported. This is the
|
||||||
|
default choice.
|
||||||
|
|
||||||
no-asm Do not use assembler code.
|
no-shared Don't try to create shared libraries.
|
||||||
|
|
||||||
386 On Intel hardware, use the 80386 instruction set only
|
shared In addition to the usual static libraries, create shared
|
||||||
(the default x86 code is more efficient, but requires at
|
libraries on platforms where it's supported. See "Note on
|
||||||
least a 486). Note: Use compiler flags for any other CPU
|
shared libraries" below.
|
||||||
specific configuration, e.g. "-m32" to build x86 code on
|
|
||||||
an x64 system.
|
|
||||||
|
|
||||||
no-sse2 Exclude SSE2 code pathes. Normally SSE2 extension is
|
no-asm Do not use assembler code.
|
||||||
detected at run-time, but the decision whether or not the
|
|
||||||
machine code will be executed is taken solely on CPU
|
|
||||||
capability vector. This means that if you happen to run OS
|
|
||||||
kernel which does not support SSE2 extension on Intel P4
|
|
||||||
processor, then your application might be exposed to
|
|
||||||
"illegal instruction" exception. There might be a way
|
|
||||||
to enable support in kernel, e.g. FreeBSD kernel can be
|
|
||||||
compiled with CPU_ENABLE_SSE, and there is a way to
|
|
||||||
disengage SSE2 code pathes upon application start-up,
|
|
||||||
but if you aim for wider "audience" running such kernel,
|
|
||||||
consider no-sse2. Both 386 and no-asm options above imply
|
|
||||||
no-sse2.
|
|
||||||
|
|
||||||
no-<cipher> Build without the specified cipher (bf, cast, des, dh, dsa,
|
386 On Intel hardware, use the 80386 instruction set only
|
||||||
hmac, md2, md5, mdc2, rc2, rc4, rc5, rsa, sha).
|
(the default x86 code is more efficient, but requires at
|
||||||
The crypto/<cipher> directory can be removed after running
|
least a 486). Note: Use compiler flags for any other CPU
|
||||||
"make depend".
|
specific configuration, e.g. "-m32" to build x86 code on
|
||||||
|
an x64 system.
|
||||||
|
|
||||||
-Dxxx, -lxxx, -Lxxx, -fxxx, -mXXX, -Kxxx These system specific options will
|
no-sse2 Exclude SSE2 code pathes. Normally SSE2 extension is
|
||||||
be passed through to the compiler to allow you to
|
detected at run-time, but the decision whether or not the
|
||||||
define preprocessor symbols, specify additional libraries,
|
machine code will be executed is taken solely on CPU
|
||||||
library directories or other compiler options.
|
capability vector. This means that if you happen to run OS
|
||||||
|
kernel which does not support SSE2 extension on Intel P4
|
||||||
|
processor, then your application might be exposed to
|
||||||
|
"illegal instruction" exception. There might be a way
|
||||||
|
to enable support in kernel, e.g. FreeBSD kernel can be
|
||||||
|
compiled with CPU_ENABLE_SSE, and there is a way to
|
||||||
|
disengage SSE2 code pathes upon application start-up,
|
||||||
|
but if you aim for wider "audience" running such kernel,
|
||||||
|
consider no-sse2. Both 386 and no-asm options above imply
|
||||||
|
no-sse2.
|
||||||
|
|
||||||
|
no-<alg> Build without the specified algorithm (bf, cast, des, dh,
|
||||||
|
dsa, hmac, md2, md5, mdc2, rc2, rc4, rc5, rsa, sha).
|
||||||
|
|
||||||
|
-Dxxx, -lxxx, These system specific options will be passed through to the
|
||||||
|
-Lxxx, -fxxx, compiler to allow you to define preprocessor symbols, specify
|
||||||
|
-mXXX, -Kxxx additional libraries, library directories or other compiler
|
||||||
|
options.
|
||||||
|
|
||||||
|
|
||||||
Installation in Detail
|
Installation in Detail
|
||||||
@@ -272,9 +280,9 @@
|
|||||||
report the problem to <rt@openssl.org> (note that your message
|
report the problem to <rt@openssl.org> (note that your message
|
||||||
will be recorded in the request tracker publicly readable at
|
will be recorded in the request tracker publicly readable at
|
||||||
https://www.openssl.org/community/index.html#bugs and will be
|
https://www.openssl.org/community/index.html#bugs and will be
|
||||||
forwarded to a public mailing list). Include the output of "make
|
forwarded to a public mailing list). Please check out the request
|
||||||
report" in your message. Please check out the request tracker. Maybe
|
tracker. Maybe the bug was already reported or has already been
|
||||||
the bug was already reported or has already been fixed.
|
fixed.
|
||||||
|
|
||||||
[If you encounter assembler error messages, try the "no-asm"
|
[If you encounter assembler error messages, try the "no-asm"
|
||||||
configuration option as an immediate fix.]
|
configuration option as an immediate fix.]
|
||||||
@@ -325,11 +333,7 @@
|
|||||||
compiler optimization flags from the CFLAGS line in Makefile and
|
compiler optimization flags from the CFLAGS line in Makefile and
|
||||||
run "make clean; make" or corresponding.
|
run "make clean; make" or corresponding.
|
||||||
|
|
||||||
Please send a bug report to <openssl-bugs@openssl.org>, and when
|
Please send a bug reports to <rt@openssl.org>.
|
||||||
you do, please run the following and include the output in your
|
|
||||||
report:
|
|
||||||
|
|
||||||
$ make report
|
|
||||||
|
|
||||||
4. If everything tests ok, install OpenSSL with
|
4. If everything tests ok, install OpenSSL with
|
||||||
|
|
||||||
@@ -352,7 +356,7 @@
|
|||||||
lib/engines Contains the OpenSSL dynamically loadable engines.
|
lib/engines Contains the OpenSSL dynamically loadable engines.
|
||||||
share/man/{man1,man3,man5,man7}
|
share/man/{man1,man3,man5,man7}
|
||||||
Contains the OpenSSL man-pages.
|
Contains the OpenSSL man-pages.
|
||||||
share/doc/openssl/html{man1,man3,man5,man7}
|
share/doc/openssl/html/{man1,man3,man5,man7}
|
||||||
Contains the HTML rendition of the man-pages.
|
Contains the HTML rendition of the man-pages.
|
||||||
|
|
||||||
OpenVMS ('arch' is replaced with the architecture name, "Alpha"
|
OpenVMS ('arch' is replaced with the architecture name, "Alpha"
|
||||||
@@ -443,13 +447,10 @@
|
|||||||
use them would be to conserve memory on systems where several programs
|
use them would be to conserve memory on systems where several programs
|
||||||
are using OpenSSL.
|
are using OpenSSL.
|
||||||
|
|
||||||
For some systems, the OpenSSL Configure script knows what is needed to
|
For most systems, the OpenSSL Configure script knows what is needed to
|
||||||
build shared libraries for libcrypto and libssl. On these systems,
|
build shared libraries for libcrypto and libssl. On these systems,
|
||||||
the shared libraries are currently not created by default, but giving
|
the shared libraries are currently not created by default, but giving
|
||||||
the option "shared" will get them created. This method supports Makefile
|
the option "shared" will get them created.
|
||||||
targets for shared library creation, like linux-shared. Those targets
|
|
||||||
can currently be used on their own just as well, but this is expected
|
|
||||||
to change in future versions of OpenSSL.
|
|
||||||
|
|
||||||
Note on random number generation
|
Note on random number generation
|
||||||
--------------------------------
|
--------------------------------
|
||||||
|
|||||||
Reference in New Issue
Block a user