OPENSSL INSTALLATION
--------------------
- [This document describes installation on all supported operating
- systems (currently mainly the Linux/Unix family, OpenVMS and
- Windows)]
+ This document describes installation on all supported operating
+ systems (the Linux/Unix family, OpenVMS and Windows)
To install OpenSSL, you will need:
header files
* a supported operating system
- For additional platform specific requirements and other details,
- please read one of these:
+ For additional platform specific requirements, solutions to specific
+ issues and other details, please read one of these:
* NOTES.VMS (OpenVMS)
* NOTES.WIN (any supported Windows)
* NOTES.DJGPP (DOS platform with DJGPP)
+ Notational conventions in this document
+ ---------------------------------------
+
+ Throughout this document, we use the following conventions in command
+ examples:
+
+ $ command Any line starting with a dollar sign
+ ($) is a command line.
+
+ { word1 | word2 | word3 } This denotes a mandatory choice, to be
+ replaced with one of the given words.
+ A simple example would be this:
+
+ $ echo { FOO | BAR | COOKIE }
+
+ which is to be understood as one of
+ these:
+
+ $ echo FOO
+ - or -
+ $ echo BAR
+ - or -
+ $ echo COOKIE
+
+ [ word1 | word2 | word3 ] Similar to { word1 | word2 | word3 }
+ except it's optional to give any of
+ those. In addition to the examples
+ above, this would also be valid:
+
+ $ echo
+
+ {{ target }} This denotes a mandatory word or
+ sequence of words of some sort. A
+ simple example would be this:
+
+ $ type {{ filename }}
+
+ which is to be understood to use the
+ command 'type' on some file name
+ determined by the user.
+
+ [[ options ]] Similar to {{ target }}, but is
+ optional.
+
+ Note that the notation assumes spaces around {, }, [, ], {{, }} and
+ [[, ]]. This is to differentiate from OpenVMS directory
+ specifications, which also use [ and ], but without spaces.
+
Quick Start
-----------
$ nmake test
$ nmake install
- [If any of these steps fails, see section Installation in Detail below.]
+ If any of these steps fails, see section Installation in Detail below.
This will build and install OpenSSL in the default location, which is:
--cross-compile-prefix=PREFIX
The PREFIX to include in front of commands for your
- toolchain. For example to build the mingw64 target on Linux
- you might use "--cross-compile-prefix=x86_64-w64-mingw32-".
- If the compiler is gcc, then this will attempt to run
- x86_64-w64-mingw32-gcc when compiling.
+ toolchain. It's likely to have to end with dash, e.g.
+ a-b-c- would invoke GNU compiler as a-b-c-gcc, etc.
+ Unfortunately cross-compiling is too case-specific to
+ put together one-size-fits-all instructions. You might
+ have to pass more flags or set up environment variables
+ to actually make it work. Android and iOS cases are
+ discussed in corresponding Configurations/10-main.cf
+ sections. But there are cases when this option alone is
+ sufficient. For example to build the mingw64 target on
+ Linux "--cross-compile-prefix=x86_64-w64-mingw32-"
+ works. Naturally provided that mingw packages are
+ installed. Today Debian and Ubuntu users have option to
+ install a number of prepackaged cross-compilers along
+ with corresponding run-time and development packages for
+ "alien" hardware. To give another example
+ "--cross-compile-prefix=mipsel-linux-gnu-" suffices
+ in such case. Needless to mention that you have to
+ invoke ./Configure, not ./config, and pass your target
+ name explicitly.
--debug
Build OpenSSL with debugging symbols.
on a platform that does not support AFALG.
enable-asan
- Build with the Address sanitser. This is a developer option
+ Build with the Address sanitiser. This is a developer option
only. It may not work on all platforms and should never be
used in production environments. It will only work when used
with gcc or clang and should be used in conjunction with the
Don't compile in filename and line number information (e.g.
for errors and memory allocation).
- enable-fuzz
- Build with support for fuzzing. This is a developer option
- only. It may not work on all platforms and should never be
- used in production environments. See the file fuzz/README.md
- for further details.
+ enable-fuzz-libfuzzer, enable-fuzz-afl
+ Build with support for fuzzing using either libfuzzer or AFL.
+ These are developer options only. They may not work on all
+ platforms and should never be used in production environments.
+ See the file fuzz/README.md for further details.
no-gost
Don't build support for GOST based ciphersuites. Note that
"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,
+ disengage SSE2 code paths upon application start-up,
but if you aim for wider "audience" running such kernel,
consider no-sse2. Both the 386 and no-asm options imply
no-sse2.
Don't build Time Stamping Authority support.
enable-ubsan
- Build with the Undefined Behaviour sanitser. This is a
+ Build with the Undefined Behaviour sanitiser. This is a
developer option only. It may not work on all platforms and
should never be used in production environments. It will only
work when used with gcc or clang and should be used in
NOTE: This is not available on Windows.
- $ ./config [options] # Unix
+ $ ./config [[ options ]] # Unix
or
- $ @config [options] ! OpenVMS
+ $ @config [[ options ]] ! OpenVMS
For the remainder of this text, the Unix form will be used in all
examples, please use the appropriate form for your platform.
On some systems, you can include debugging information as follows:
- $ ./config -d [options]
+ $ ./config -d [[ options ]]
1b. Configure OpenSSL for your operating system manually
as the argument to Configure. For example, a "linux-elf" user would
run:
- $ ./Configure linux-elf [options]
+ $ ./Configure linux-elf [[ options ]]
If your system isn't listed, you will have to create a configuration
- file named Configurations/{something}.conf and add the correct
+ file named Configurations/{{ something }}.conf and add the correct
configuration for your system. See the available configs as examples
and read Configurations/README and Configurations/README.design for
more information.
$ mkdir /var/tmp/openssl-build
$ cd /var/tmp/openssl-build
- $ /PATH/TO/OPENSSL/SOURCE/config [options]
+ $ /PATH/TO/OPENSSL/SOURCE/config [[ options ]]
or
- $ /PATH/TO/OPENSSL/SOURCE/Configure [target] [options]
+ $ /PATH/TO/OPENSSL/SOURCE/Configure {{ target }} [[ options ]]
OpenVMS example:
$ set default sys$login:
$ create/dir [.tmp.openssl-build]
$ set default [.tmp.openssl-build]
- $ @[PATH.TO.OPENSSL.SOURCE]config {options}
+ $ @[PATH.TO.OPENSSL.SOURCE]config [[ options ]]
or
- $ @[PATH.TO.OPENSSL.SOURCE]Configure {target} {options}
+ $ @[PATH.TO.OPENSSL.SOURCE]Configure {{ target }} [[ options ]]
Windows example:
$ C:
$ mkdir \temp-openssl
$ cd \temp-openssl
- $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure {target} {options}
+ $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure {{ target }} [[ options ]]
Paths can be relative just as well as absolute. Configure will
do its best to translate them to relative paths whenever possible.
tracker. Maybe the bug was already reported or has already been
fixed.
- [If you encounter assembler error messages, try the "no-asm"
- configuration option as an immediate fix.]
+ (If you encounter assembler error messages, try the "no-asm"
+ configuration option as an immediate fix.)
Compiling parts of OpenSSL with gcc and others with the system
compiler will result in unresolved symbols on some systems.
$ nmake test # Windows
NOTE: you MUST run the tests from an unprivileged account (or
- disable your privileges temporarly if your platform allows it).
+ disable your privileges temporarily if your platform allows it).
If some tests fail, look at the output. There may be reasons for
the failure that isn't a problem in OpenSSL itself (like a
or libssl.
lib Contains the OpenSSL library files.
lib/engines Contains the OpenSSL dynamically loadable engines.
- share/man/{man1,man3,man5,man7}
- Contains the OpenSSL man-pages.
- share/doc/openssl/html/{man1,man3,man5,man7}
+
+ share/man/man1 Contains the OpenSSL command line man-pages.
+ share/man/man3 Contains the OpenSSL library calls man-pages.
+ share/man/man5 Contains the OpenSSL configuration format man-pages.
+ share/man/man7 Contains the OpenSSL other misc man-pages.
+
+ share/doc/openssl/html/man1
+ share/doc/openssl/html/man3
+ share/doc/openssl/html/man5
+ share/doc/openssl/html/man7
Contains the HTML rendition of the man-pages.
OpenVMS ('arch' is replaced with the architecture name, "Alpha"
- or "ia64"):
+ or "ia64", 'sover' is replaced with the shared library version
+ (0101 for 1.1), and 'pz' is replaced with the pointer size
+ OpenSSL was built with):
- [.EXE.'arch'] Contains the openssl binary and a few other
- utility scripts.
+ [.EXE.'arch'] Contains the openssl binary.
+ [.EXE] Contains a few utility scripts.
[.include.openssl]
Contains the header files needed if you want
to build your own programs that use libcrypto
or libssl.
[.LIB.'arch'] Contains the OpenSSL library files.
- [.ENGINES.'arch']
+ [.ENGINES'sover''pz'.'arch']
Contains the OpenSSL dynamically loadable engines.
[.SYS$STARTUP] Contains startup, login and shutdown scripts.
These define appropriate logical names and
command symbols.
+ [.SYSTEST] Contains the installation verification procedure.
+ [.HTML] Contains the HTML rendition of the manual pages.
Additionally, install will add the following directories under
OPENSSL_LOCAL_CONFIG_DIR
OpenSSL comes with a database of information about how it
- should be built on different platforms. This information is
- held in ".conf" files in the Configurations directory. See the
+ should be built on different platforms as well as build file
+ templates for those platforms. The database is comprised of
+ ".conf" files in the Configurations directory. The build
+ file templates reside there as well as ".tmpl" files. See the
file Configurations/README for further information about the
- format of ".conf" files. As well as the standard ".conf" files
- it is possible to create your own ".conf" files and store them
- locally, outside the OpenSSL source tree. This environment
- variable can be set to the directory where these files are held.
+ format of ".conf" files as well as information on the ".tmpl"
+ files.
+ In addition to the standard ".conf" and ".tmpl" files, it is
+ possible to create your own ".conf" and ".tmpl" files and store
+ them locally, outside the OpenSSL source tree. This environment
+ variable can be set to the directory where these files are held
+ and will have Configure to consider them in addition to the
+ standard ones.
PERL
- The name of the Perl executable to use.
+ The name of the Perl executable to use when building OpenSSL.
+
+ HASHBANGPERL
+ The command string for the Perl executable to insert in the
+ #! line of perl scripts that will be publically installed.
+ Default: /usr/bin/env perl
+ Note: the value of this variable is added to the same scripts
+ on all platforms, but it's only relevant on Unix-like platforms.
RC
The name of the rc executable to use. The default will be as
projects / openssl.git / blobdiff