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:
no-<alg>
Build without support for the specified algorithm, where
<alg> is one of: bf, blake2, camellia, cast, chacha, cmac,
- des, dh, dsa, ecdh, ecdsa, idea, md4, md5, mdc2, ocb,
- ploy1305, rc2, rc4, rmd160, scrypt, seed or whirlpool. The
- "ripemd" algorithm is deprecated and if used is synonymous
- with rmd160.
+ des, dh, dsa, ecdh, ecdsa, idea, md4, mdc2, ocb, poly1305,
+ rc2, rc4, rmd160, scrypt, seed or whirlpool. The "ripemd"
+ algorithm is deprecated and if used is synonymous with rmd160.
-Dxxx, -lxxx, -Lxxx, -fxxx, -mXXX, -Kxxx
These system specific options will be passed through to the
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.
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"
AR
The name of the ar executable to use.
+ BUILDFILE
+ Use a different build file name than the platform default
+ ("Makefile" on Unixly platforms, "makefile" on native Windows,
+ "descrip.mms" on OpenVMS). This requires that there is a
+ corresponding build file template. See Configurations/README
+ for further information.
+
CC
The compiler to use. Configure will attempt to pick a default
compiler for your platform but this choice can be overridden
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 when building OpenSSL.
projects / openssl.git / blobdiff