Difference between revisions of "Compilation and Installation"

From OpenSSLWiki
Jump to navigationJump to search
m (Added info on no-ec2m option when using openssl-fips-ecp-2.0.N.)
m (Correct "its" -> "it's")
 
(133 intermediate revisions by 12 users not shown)
Line 1: Line 1:
 +
The following page is a combination of the <tt>INSTALL</tt> file provided with the OpenSSL library and notes from the field. If you have questions about what you are doing or seeing, then you should consult <tt>INSTALL</tt> since it contains the commands and specifies the behavior by the development team.
 +
 +
OpenSSL uses a custom build system to configure the library. Configuration will allow the library to set up the recursive makefiles from <tt>makefile.org</tt>. Once configured, you use <tt>make</tt> to build the library. You should avoid custom build systems because they often miss details, like each architecture and platform has a unique <tt>opensslconf.h</tt> and <tt>bn.h</tt> generated by <tt>Configure</tt>.
 +
 +
You must use a C compiler to build the OpenSSL library. You cannot use a C++ compiler. Later, once the library is built, it is OK to create user programs with a C++ compiler. But the library proper must be built with a C compiler.
 +
 +
There are two generations of build system. First is the build system used in OpenSSL 1.0.2 and below. The instructions below apply to it. Second is the build system for OpenSSL 1.1.0 and above. The instructions are similar, but not the same. For example, the second generation abandons the monolithic <tt>Configure</tt> and places individual configurations in the <tt>Configurations</tt> directory.  Also, the second generation is more platform agnostic and uses templates to produce a final, top level build file (<tt>Makefile</tt>, <tt>descrip.mms</tt>, what have you).
 +
 +
After you configure and build the library, you should always perform a <tt>make test</tt> to ensure the library performs as expected under its self tests. If you are building OpenSSL 1.1.0 and above, then you will also need PERL 5.10 or higher (see <tt>README.PERL</tt> for details).
 +
 +
OpenSSL's build system does not rely upon <tt>autotools</tt> or <tt>libtool</tt>. Also see [http://www.openssl.org/support/faq.html#MISC5 Why aren't tools like 'autoconf' and 'libtool' used?] in the OpenSSL FAQ.
 +
 
== Retrieve source code ==
 
== Retrieve source code ==
  
The OpenSSL source code can be downloaded from [http://www.openssl.org/source/ www.openssl.org/source/] or any suitable [http://www.openssl.org/source/mirror.html ftp mirror]. There are various versions including stable as well as unstable versions.  
+
The OpenSSL source code can be downloaded from [http://www.openssl.org/source/ OpenSSL Source Tarballs] or any suitable [http://www.openssl.org/source/mirror.html ftp mirror]. There are various versions including stable as well as unstable versions.  
  
The source code is manged via Git, the repository is
+
The source code is managed via Git. It's referred to as Master. The repository is
  
 
: git://git.openssl.org/openssl.git
 
: git://git.openssl.org/openssl.git
Line 9: Line 21:
 
The source is also available via a [https://github.com/openssl/openssl GitHub] mirror. This repository is updated every 15 minutes.
 
The source is also available via a [https://github.com/openssl/openssl GitHub] mirror. This repository is updated every 15 minutes.
  
If you don't know what Git is or how to use it, see the introduction at the [http://git-scm.com/documentation Git documentation] page. Once you installed git you can use
+
* [[Use_of_Git|Accessing OpenSSL source code via Git]]
<pre>
 
$ git clone git://git.openssl.org/openssl.git
 
</pre>
 
 
 
in an empty directory to download the latest (development) version. There are other branches available as well.
 
  
 
== Configuration ==
 
== Configuration ==
  
 
OpenSSL is configured for a particular platform with protocol and behavior options using <tt>Configure</tt> and <tt>config</tt>.
 
OpenSSL is configured for a particular platform with protocol and behavior options using <tt>Configure</tt> and <tt>config</tt>.
 +
 +
You should avoid custom build systems because they often miss details, like each architecture and platform has a unique <tt>opensslconf.h</tt> and <tt>bn.h</tt> generated by <tt>Configure</tt>.
 +
 +
=== Supported Platforms ===
 +
 +
You can run <tt>Configure LIST</tt> to see a list of available platforms.
 +
 +
<pre>$ ./Configure LIST
 +
BC-32
 +
BS2000-OSD
 +
BSD-generic32
 +
BSD-generic64
 +
BSD-ia64
 +
BSD-sparc64
 +
BSD-sparcv8
 +
BSD-x86
 +
BSD-x86-elf
 +
BSD-x86_64
 +
Cygwin
 +
Cygwin-x86_64
 +
DJGPP
 +
...</pre>
 +
 +
If your platform is not listed, then use a similar platform and tune the <tt>$cflags</tt> and <tt>$ldflags</tt> by making a copy of the configure line and giving it its own name. <tt>$cflags</tt> and <tt>$ldflags</tt> correspond to fields 2 and 6 in a configure line. An example of using a similar configure line is presented in [[Compilation_and_Installation#Using_RPATHs|Using RPATHs]].
  
 
=== Configure & Config ===
 
=== Configure & Config ===
  
You use <tt>Configure</tt> and <tt>config</tt> to tune the compile and installation process through options and switches. The difference between is <tt>Configure</tt> properly handles the host-arch-compiler triplet, and <tt>config</tt> does not. <tt>config</tt> attempts to guess the triplet, so its a lot like autotool's <tt>config.guess</tt>.
+
You use <tt>Configure</tt> and <tt>config</tt> to tune the compile and installation process through options and switches. The difference between is <tt>Configure</tt> properly handles the host-arch-compiler triplet, and <tt>config</tt> does not. <tt>config</tt> attempts to guess the triplet, so it's a lot like autotool's <tt>config.guess</tt>.
  
 
You can usually use <tt>config</tt> and it will do the right thing (from Ubuntu 13.04, x64):
 
You can usually use <tt>config</tt> and it will do the right thing (from Ubuntu 13.04, x64):
Line 34: Line 65:
 
     no-jpake        [experimental] OPENSSL_NO_JPAKE (skip dir)
 
     no-jpake        [experimental] OPENSSL_NO_JPAKE (skip dir)
 
     no-krb5        [krb5-flavor not specified] OPENSSL_NO_KRB5
 
     no-krb5        [krb5-flavor not specified] OPENSSL_NO_KRB5
    no-md2          [default]  OPENSSL_NO_MD2 (skip dir)
 
    no-rc5          [default]  OPENSSL_NO_RC5 (skip dir)
 
    no-rfc3779      [default]  OPENSSL_NO_RFC3779 (skip dir)
 
    no-sctp        [default]  OPENSSL_NO_SCTP (skip dir)
 
    no-shared      [default]
 
    no-store        [experimental] OPENSSL_NO_STORE (skip dir)
 
    no-zlib        [default]
 
    no-zlib-dynamic [default]
 
 
     ...</pre>
 
     ...</pre>
  
Mac OSX is a problem (its often a neglected platform), and you will have to use <tt>Configure</tt>:
+
Mac OS X can have issues (it's often a neglected platform), and you will have to use <tt>Configure</tt>:
  
 
<pre> ./Configure darwin64-x86_64-cc
 
<pre> ./Configure darwin64-x86_64-cc
Line 52: Line 75:
 
     no-jpake        [experimental] OPENSSL_NO_JPAKE (skip dir)
 
     no-jpake        [experimental] OPENSSL_NO_JPAKE (skip dir)
 
     no-krb5        [krb5-flavor not specified] OPENSSL_NO_KRB5
 
     no-krb5        [krb5-flavor not specified] OPENSSL_NO_KRB5
    no-md2          [default]  OPENSSL_NO_MD2 (skip dir)
 
    no-rc5          [default]  OPENSSL_NO_RC5 (skip dir)
 
    no-rfc3779      [default]  OPENSSL_NO_RFC3779 (skip dir)
 
    no-sctp        [default]  OPENSSL_NO_SCTP (skip dir)
 
    no-shared      [default]
 
    no-store        [experimental] OPENSSL_NO_STORE (skip dir)
 
    no-zlib        [default]
 
    no-zlib-dynamic [default]
 
 
     ...</pre>
 
     ...</pre>
  
Running the same command with <tt>config</tt> results in:
+
You can also configure on Darwin by exporting <tt>KERNEL_BITS</tt>:
  
<pre>$ ./config darwin64-x86_64-cc
+
<pre>$ export KERNEL_BITS=64
 +
$ ./config shared no-ssl2 no-ssl3 enable-ec_nistp_64_gcc_128 --openssldir=/usr/local/ssl/macosx-x64/
 
Operating system: i686-apple-darwinDarwin Kernel Version 12.5.0: Sun Sep 29 13:33:47 PDT 2013; root:xnu-2050.48.12~1/RELEASE_X86_64
 
Operating system: i686-apple-darwinDarwin Kernel Version 12.5.0: Sun Sep 29 13:33:47 PDT 2013; root:xnu-2050.48.12~1/RELEASE_X86_64
WARNING! If you wish to build 64-bit library, then you have to
+
Configuring for darwin64-x86_64-cc
        invoke './Configure darwin64-x86_64-cc' *manually*.
+
Configuring for darwin64-x86_64-cc
        You have about 5 seconds to press Ctrl-C to abort.
+
    no-gmp          [default]  OPENSSL_NO_GMP (skip dir)
Configuring for darwin-i386-cc
+
    no-jpake        [experimental] OPENSSL_NO_JPAKE (skip dir)
target already defined - darwin-i386-cc (offending arg: darwin64-x86_64-cc)</pre>
+
    no-krb5        [krb5-flavor not specified] OPENSSL_NO_KRB5
 +
    ...</pre>
  
 
If you provide a option not known to configure or ask for help, then you get a brief help message:
 
If you provide a option not known to configure or ask for help, then you get a brief help message:
Line 92: Line 109:
 
BC-32 BS2000-OSD BSD-generic32 BSD-generic64 BSD-ia64 BSD-sparc64 BSD-sparcv8  
 
BC-32 BS2000-OSD BSD-generic32 BSD-generic64 BSD-ia64 BSD-sparc64 BSD-sparcv8  
 
BSD-x86 BSD-x86-elf BSD-x86_64 Cygwin Cygwin-pre1.3 DJGPP MPE/iX-gcc OS2-EMX  
 
BSD-x86 BSD-x86-elf BSD-x86_64 Cygwin Cygwin-pre1.3 DJGPP MPE/iX-gcc OS2-EMX  
OS390-Unix QNX6 QNX6-i386 ReliantUNIX SINIX SINIX-N UWIN VC-CE VC-WIN32
 
VC-WIN64A VC-WIN64I aix-cc aix-gcc aix3-cc aix64-cc aix64-gcc android
 
android-armv7 android-x86 aux3-gcc beos-x86-bone beos-x86-r5 bsdi-elf-gcc cc
 
cray-j90 cray-t3e darwin-i386-cc darwin-ppc-cc darwin64-ppc-cc
 
darwin64-x86_64-cc dgux-R3-gcc dgux-R4-gcc dgux-R4-x86-gcc dist gcc hpux-cc
 
hpux-gcc hpux-ia64-cc hpux-ia64-gcc hpux-parisc-cc hpux-parisc-cc-o4
 
hpux-parisc-gcc hpux-parisc1_1-cc hpux-parisc1_1-gcc hpux-parisc2-cc
 
hpux-parisc2-gcc hpux64-ia64-cc hpux64-ia64-gcc hpux64-parisc2-cc
 
hpux64-parisc2-gcc hurd-x86 iphoneos-cross irix-cc irix-gcc irix-mips3-cc
 
irix-mips3-gcc irix64-mips4-cc irix64-mips4-gcc linux-alpha+bwx-ccc
 
linux-alpha+bwx-gcc linux-alpha-ccc linux-alpha-gcc linux-aout linux-armv4
 
linux-elf linux-generic32 linux-generic64 linux-ia32-icc linux-ia64
 
linux-ia64-ecc linux-ia64-icc linux-ppc linux-ppc64 linux-sparcv8
 
linux-sparcv9 linux-x86_64 linux32-s390x linux64-s390x linux64-sparcv9 mingw
 
mingw64 ncr-scde netware-clib netware-clib-bsdsock netware-clib-bsdsock-gcc
 
 
...
 
...
  
 
NOTE: If in doubt, on Unix-ish systems use './config'.</pre>
 
NOTE: If in doubt, on Unix-ish systems use './config'.</pre>
  
Finally, to delete a configuration and start anew, run <tt>make dclean</tt>.
+
=== Dependencies ===
  
=== Library Options ===
+
If you are prompted to run <tt>make depend</tt>, then you must do so. For OpenSSL 1.0.2 and below, it's required to update the standard distribution once configuration options change.
 +
 
 +
<pre>Since you've disabled or enabled at least one algorithm, you need to do
 +
the following before building:
 +
 
 +
make depend
 +
</pre>
 +
 
 +
OpenSSL 1.1.0 and above performs the dependency step for you, so you should not see the message. However, you should perform a <tt>make clean</tt> to ensure the list of objects files is accurate after a reconfiguration.
 +
 
 +
== Configure Options ==
  
 
OpenSSL has been around a long time, and it carries around a lot of cruft. For example, from above, SSLv2 is enabled by default. SSLv2 is completely broken, and you should disable it during configuration. You can disable protocols and provide other options through <tt>Configure</tt> and <tt>config</tt>, and the following lists some of them.
 
OpenSSL has been around a long time, and it carries around a lot of cruft. For example, from above, SSLv2 is enabled by default. SSLv2 is completely broken, and you should disable it during configuration. You can disable protocols and provide other options through <tt>Configure</tt> and <tt>config</tt>, and the following lists some of them.
  
'''Note''': if you specify a non-existent option, then the configure scripts will proceed without warning. For example, if you inadvertently specify '''-no-sslv2''' rather than '''-no-ssl2''', the script will configure ''with'' SSLv2 and ''without'' warning for the unknown -no-sslv2.
+
'''Note''': if you specify a non-existent option, then the configure scripts will proceed without warning. For example, if you inadvertently specify '''no-sslv2''' rather than '''no-ssl2 no-ssl3''', the script will configure ''with'' SSLv2 and ''without'' warning for the unknown no-sslv2.
 +
 
 +
'''Note''': when building a shared object, both the static archive and shared objects are built. You do not need to do anything special to build both when '''shared''' is specified.
  
 
{| class="wikitable sortable" border="1"
 
{| class="wikitable sortable" border="1"
Line 125: Line 139:
 
! scope="col" class="unsortable" | Description
 
! scope="col" class="unsortable" | Description
 
|-
 
|-
| --openssldir=XXX || The installation directory. If not specified, the library will be installed at <tt>/usr/local/ssl</tt>. Header will be located at <tt>/usr/local/ssl/include/openssl</tt>, and libraries located at <tt>/usr/local/ssl/lib</tt>.
+
| --prefix=XXX || See [[#PREFIX_and_OPENSSLDIR|PREFIX and OPENSSLDIR]] in the next section (below).
 +
|-
 +
| --openssldir=XXX || See [[#PREFIX_and_OPENSSLDIR|PREFIX and OPENSSLDIR]] in the next section (below).
 +
|-
 +
| -d || Debug build of the library. Optimizations are disabled (no <tt>-O3</tt> or similar) and <tt>libefence</tt> is used (<tt>apt-get install electric-fence</tt> or <tt>yum install electric-fence</tt>). TODO: Any other features?
 +
|-
 +
| shared || Build a shared object in addition to the static archive. You probably need a [[#Using_RPATHs|RPATH]] when enabling <tt>shared</tt> to ensure <tt>openssl</tt> uses the correct <tt>libssl</tt> and <tt>libcrypto</tt> after installation.
 +
|-
 +
| enable-ec_nistp_64_gcc_128 || Use on little endian platforms when GCC supports <tt>__uint128_t</tt>. ECDH is about 2 to 4 times faster. Not enabled by default because <tt>Configure</tt> can't determine it. Enable it if your compiler defines <tt>__SIZEOF_INT128__</tt>, the CPU is little endian and it tolerates unaligned data access.
 +
|-
 +
| enable-capieng || Enables the Microsoft CAPI engine on Windows platforms. Used to access the Windows Certificate Store. Also see [http://openssl.6102.n7.nabble.com/Using-Windows-certificate-store-through-OpenSSL-td46788.html Using Windows certificate store through OpenSSL] on the OpenSSL developer list.
 +
|-
 +
| no-ssl2 || Disables SSLv2. <tt>OPENSSL_NO_SSL2</tt> will be defined in the OpenSSL headers.
 +
|-
 +
| no-ssl3 || Disables SSLv3. <tt>OPENSSL_NO_SSL3</tt> will be defined in the OpenSSL headers.
 +
|-
 +
| no-comp || Disables compression independent of <tt>zlib</tt>. <tt>OPENSSL_NO_COMP</tt> will be defined in the OpenSSL headers.
 +
|-
 +
| no-idea || Disables IDEA algorithm. Unlike RC5 and MDC2, IDEA is enabled by default
 +
|-
 +
| no-asm || Disables assembly language routines (and uses C routines)
 
|-
 
|-
| -no-ssl2 || Disables SSLv2
+
| no-dtls || Disables DTLS in OpenSSL 1.1.0 and above
 
|-
 
|-
| -no-ssl3 || Disables SSLv3
+
| no-dtls1 || Disables DTLS in OpenSSL 1.0.2 and below
 
|-
 
|-
| -no-comp || Disables compression independent of <tt>zlib</tt>
+
| no-shared || Disables shared objects (only a static library is created)
 
|-
 
|-
| -no-asm || Disables assembly language routines (and uses C routines)
+
| no-hw || Disables hardware support (useful on mobile devices)
 
|-
 
|-
| -no-dtls || Disables DTLS (useful on mobile devices since carries often block UDP)
+
| no-engine || Disables hardware support (useful on mobile devices)
 
|-
 
|-
| -no-shared || Disables shared objects (only a static library is created)
+
| no-threads || Disables threading support.
 
|-
 
|-
| -no-hw || Disables hardware support (useful on mobile devices)
+
| no-dso || Disables the OpenSSL DSO API (the library offers a shared object abstraction layer). If you disable DSO, then you must disable Engines also
 
|-
 
|-
| -no-engines || Disables hardware support (useful on mobile devices)
+
| no-err || Removes all error function names and error reason text to reduce footprint
 
|-
 
|-
| -no-dso || Disable the OpenSSL DSO API (the library offers a shared object abstraction layer)
+
| no-npn/no-nextprotoneg || Disables Next Protocol Negotiation (NPN). Use <tt>no-nextprotoneg</tt> for 1.1.0 and above; and <tt>no-npn</tt> otherwise
 +
|-
 +
| no-psk || Disables Preshared Key (PSK). PSK provides mutual authentication independent of trusted authorities, but it's rarely offered or used
 +
|-
 +
| no-srp || Disables Secure Remote Password (SRP). SRP provides mutual authentication independent of trusted authorities, but it's rarely offered or used
 +
|-
 +
| no-ec2m || Used when configuring FIPS Capable Library with a FIPS Object Module that only includes prime curves. That is, use this switch if you use <tt>openssl-fips-ecp-2.0.5</tt>.
 +
|-
 +
| no-weak-ssl-ciphers || Disables RC4. Available in OpenSSL 1.1.0 and above.
 +
|-
 +
| -DXXX || Defines XXX. For example, <tt>-DOPENSSL_NO_HEARTBEATS</tt>.
 +
|-
 +
| -DPEDANTIC || Defines PEDANTIC. The library will avoid some undefined behavior, like casting an unaligned byte array to a different pointer type. This define should be used if building OpenSSL with undefined behavior sanitizer (<tt>-fsanitize=undefined</tt>).
 +
|-
 +
| -DOPENSSL_USE_IPV6=0 || Disables IPv6. Useful if OpenSSL encounters incorrect or inconsistent platform headers and mistakenly enables IPv6. Must be passed to <tt>Configure</tt> manually.
 +
|-
 +
| -DNO_FORK || Defines NO_FORK. Disables calls to <tt>fork</tt>. Useful for operating systems like AppleTVOS, WatchOS, AppleTVSimulator and WatchSimulator.
 +
|-
 +
| -L''something'', -l''something'', -K''something'', -Wl,''something'' || Linker options, will become part of LDFLAGS.
 +
|-
 +
| -''anythingelse'', +''anythingelse'' || Compiler options, will become part of CFLAGS.
 
|}
 
|}
  
After disabling an option, your configure output will look similar to below (notice the lack of SSLv2 and SSLv3 support).
+
'''''Note''''': on older OSes, like CentOS 5, BSD 5, and Windows XP or Vista, you will need to configure with <tt>no-async</tt> when building OpenSSL 1.1.0 and above. The configuration system does not detect lack of the Posix feature on the platforms.
 +
 
 +
'''''Note''''': you can verify compiler support for <tt>__uint128_t</tt> with the following:
 +
 
 +
<pre># gcc -dM -E - </dev/null | grep __SIZEOF_INT128__ 
 +
#define __SIZEOF_INT128__ 16</pre>
 +
 
 +
=== PREFIX and OPENSSLDIR ===
 +
 
 +
<tt>--prefix</tt> and <tt>--openssldir</tt> control the configuration of installed components. The behavior and interactions of <tt>--prefix</tt> and <tt>--openssldir</tt> are slightly different between OpenSSL 1.0.2 and below, and OpenSSL 1.1.0 and above.
 +
 
 +
The '''''rule of thumb''''' to use when you want something that "just works" for all recent versions of OpenSSL, including OpenSSL 1.0.2 and 1.1.0, is:
 +
 
 +
* specify ''both'' <tt>--prefix</tt> and <tt>--openssldir</tt>
 +
* set <tt>--prefix</tt> and <tt>--openssldir</tt> to the same location
 +
 
 +
One word of caution is ''avoid'' <tt>--prefix=/usr</tt> when OpenSSL versions are '''''not''''' [[Binary_Compatibility|binary compatible]]. You will replace the distro's version of OpenSSL with your version of OpenSSL. It will most likely break everything, including the package management system.
 +
 
 +
 
 +
'''OpenSSL 1.0.2 and below'''
 +
 
 +
It is usually ''not'' necessary to specify <tt>--prefix</tt>. If <tt>--prefix</tt> is ''not'' specified, then <tt>--openssldir</tt> is used. However, specifying ''only'' <tt>--prefix</tt> may result in broken builds because the 1.0.2 build system attempts to build in a FIPS configuration.
 +
 
 +
You can ''omit'' If <tt>--prefix</tt> and use <tt>--openssldir</tt>. In this case, the paths for <tt>--openssldir</tt> will be used during configuration. If <tt>--openssldir</tt> is not specified, the the default <tt>/usr/local/ssl</tt> is used.
 +
 
 +
The takeaway is <tt>/usr/local/ssl</tt> is used by default, and it can be overridden with <tt>--openssldir</tt>. The rule of thumb applies for path overrides: specify ''both'' <tt>--prefix</tt> and <tt>--openssldir</tt>.
 +
 
 +
 
 +
'''OpenSSL 1.1.0 and above'''
 +
 
 +
OpenSSL 1.1.0 changed the behavior of install rules. You should specify both <tt>--prefix</tt> and <tt>--openssldir</tt> to ensure <tt>make install</tt> works as expected.
  
<pre>$ ./Configure darwin64-x86_64-cc -no-ssl2 -no-ssl3
+
The takeaway is <tt>/usr/local/ssl</tt> is used by default, and it can be overridden with ''both'' <tt>--prefix</tt> and <tt>--openssldir</tt>. The rule of thumb applies for path overrides: specify ''both'' <tt>--prefix</tt> and <tt>--openssldir</tt>.
Configuring for darwin64-x86_64-cc
+
 
    no-ec_nistp_64_gcc_128 [default]  OPENSSL_NO_EC_NISTP_64_GCC_128 (skip dir)
+
=== Debug Configuration ===
    no-gmp          [default]  OPENSSL_NO_GMP (skip dir)
 
    no-jpake        [experimental] OPENSSL_NO_JPAKE (skip dir)
 
    no-krb5        [krb5-flavor not specified] OPENSSL_NO_KRB5
 
    no-md2          [default]  OPENSSL_NO_MD2 (skip dir)
 
    no-rc5          [default]  OPENSSL_NO_RC5 (skip dir)
 
    no-rfc3779      [default]  OPENSSL_NO_RFC3779 (skip dir)
 
    no-sctp        [default]  OPENSSL_NO_SCTP (skip dir)
 
    no-shared      [default]
 
    no-ssl2        [option]  OPENSSL_NO_SSL2 (skip dir)
 
    no-ssl3        [option]  OPENSSL_NO_SSL3 (skip dir)
 
    no-store        [experimental] OPENSSL_NO_STORE (skip dir)
 
    no-zlib        [default]
 
    no-zlib-dynamic [default]
 
    ...</pre>
 
  
=== Compile Time Checking ===
+
From the list above, it's possible to quickly configure a "debug" build with <tt>./config -d</tt>. However, you can often get into a more amicable state ''without'' the [http://en.wikipedia.org/wiki/Electric_Fence Electric Fence] dependency by issuing:
  
If you disable an option during configure, you can check if its available through <tt>OPENSSL_NO_*</tt> defines. OpenSSL writes the configure options to <tt><openssl/opensslconf.h></tt>. For example, if you want to know if SSLv3 is available, then you would perform the following in your code:
+
<pre>$ ./config no-asm -g3 -O0 -fno-omit-frame-pointer -fno-inline-functions
 +
Operating system: x86_64-whatever-linux2
 +
Configuring for linux-x86_64
 +
Configuring OpenSSL version 1.1.0-pre5-dev (0x0x10100005L)
 +
    no-asm          [option]  OPENSSL_NO_ASM
 +
    ...
 +
Configuring for linux-x86_64
 +
IsMK1MF      =no
 +
CC            =gcc
 +
CFLAG        =-Wall -O3 -pthread -m64 -DL_ENDIAN  -g3 -O0 -fno-omit-frame-pointer
 +
...</pre>
  
<pre>#include <openssl/opensslconf.h>
+
Don't be alarmed about both <tt>-O3</tt> and <tt>-O0</tt>. The last setting ''"sticks"'', and that's the <tt>-O0</tt>.
...
 
  
#if !defined(OPENSSL_NO_SSL3)
+
If you are working in Visual Studio and you can't step into library calls, then see [http://stackoverflow.com/q/38249235 Step into not working, but can force stepping after some asm steps] on Stack Overflow.
  /* SSLv3 is available */
 
#endif</pre>
 
  
 
=== Modifying Build Settings ===
 
=== Modifying Build Settings ===
Line 181: Line 258:
 
Sometimes you need to work around OpenSSL's selections for building the library. For example, you might want to use <tt>-Os</tt> for a mobile device (rather than <tt>-O3</tt>), or you might want to use the <tt>clang</tt> compiler (rather than <tt>gcc</tt>).
 
Sometimes you need to work around OpenSSL's selections for building the library. For example, you might want to use <tt>-Os</tt> for a mobile device (rather than <tt>-O3</tt>), or you might want to use the <tt>clang</tt> compiler (rather than <tt>gcc</tt>).
  
In case like these, its often easier to modify <tt>Configure</tt> <tt>Makefile.org</tt> rather than trying to add targets to the configure scripts. Below is a patch that modifies <tt>Configure</tt> and <tt>Makefile.org</tt> for use under the iOS 7.0 SDK (which lacks <tt>gcc</tt> in <tt>/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/</tt>):
+
In case like these, its' often easier to modify <tt>Configure</tt> and <tt>Makefile.org</tt> rather than trying to add targets to the configure scripts. Below is a patch that modifies <tt>Configure</tt> and <tt>Makefile.org</tt> for use under the iOS 7.0 SDK (which lacks <tt>gcc</tt> in <tt>/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/</tt>):
  
 
* Modifies <tt>Configure</tt> to use <tt>clang</tt>
 
* Modifies <tt>Configure</tt> to use <tt>clang</tt>
Line 209: Line 286:
 
...</pre>
 
...</pre>
  
=== Fedora and Red Hat ===
+
=== Using RPATHs ===
  
On Fedora and Red Hat systems, be sure to export <tt>CFLAGS="-fPIC"</tt> and explicitly specify <tt>shared</tt> to <tt>config</tt>. Failing to do so will result in static libraries only.That is, you will be missing the shared objects and engines. The commands would look similar to below.
+
<tt>RPATH</tt>'s are supported by default on the BSD platforms, but not others. If you are working on Linux and compatibles, then you have to manually add an RPATH. One of the easiest ways to add a <tt>RPATH</tt> is to configure with it as shown below.
  
<pre>$ export CFLAGS="-fPIC"
+
<pre>./config -Wl,-rpath=/usr/local/ssl/lib</pre>
$ ./config shared -no-ssl2 -no-ssl3 --openssldir=/usr/local/ssl
+
 
 +
For modern Linux you should also use <tt>-Wl,--enable-new-dtags</tt>. The linker option sets a <tt>RUNPATH</tt> as opposed to a <tt>RPATH</tt>. A <tt>RUNPATH</tt> allows library path overrides at runtime, while a <tt>RPATH</tt> does not.
 +
 
 +
<pre>./config -Wl,-rpath=/usr/local/ssl/lib -Wl,--enable-new-dtags</pre>
 +
 
 +
'''''Note well''''': you should use a <tt>RPATH</tt> or <tt>RUNPATH</tt> when building both OpenSSL and your program. If you don't add a <tt>RPATH</tt> or <tt>RUNPATH</tt> to both, then your program could runtime-link to the wrong version of OpenSSL. Linking against random versions of a security library is ''not'' a good idea.
 +
 
 +
You can also add an <tt>RPATH</tt> or <tt>RUNPATH</tt> by hard coding the <tt>RPATH</tt> into a configure line. For example, on Debian x86_64 open the file <tt>Configure</tt> in an editor, copy <tt>linux-x86_64</tt>, name it <tt>linux-x86_64-rpath</tt>, and make the following change to add the <tt>-rpath</tt> option. Notice the addition of <tt>-Wl,-rpath=...</tt> in two places.
 +
 
 +
<pre>"linux-x86_64-rpath", "gcc:-m64 -DL_ENDIAN -O3 -Wall -Wl,-rpath=/usr/local/ssl/lib::
 +
  -D_REENTRANT::-Wl,-rpath=/usr/local/ssl/lib -ldl:SIXTY_FOUR_BIT_LONG RC4_CHUNK DES_INT DES_UNROLL:
 +
  ${x86_64_asm}:elf:dlfcn:linux-shared:-fPIC:-m64:.so.\$(SHLIB_MAJOR).\$(SHLIB_MINOR):::64",</pre>
 +
 
 +
Above, fields 2 and 6 were changed. They correspond to <tt>$cflag</tt> and <tt>$ldflag</tt> in OpenSSL's builds system.
 +
 
 +
Then, Configure with the new configuration:
 +
 
 +
<pre>$ ./Configure linux-x86_64-rpath shared no-ssl2 no-ssl3 no-comp \
 +
    --openssldir=/usr/local/ssl enable-ec_nistp_64_gcc_128</pre>
 +
 
 +
Finally, after <tt>make</tt>, verify the settings stuck:
 +
 
 +
<pre>$ readelf -d ./libssl.so | grep -i -E 'rpath|runpath'
 +
0x000000000000000f (RPATH)              Library rpath: [/usr/local/ssl/lib]
 +
$ readelf -d ./libcrypto.so | grep -i rpath
 +
0x000000000000000f (RPATH)              Library rpath: [/usr/local/ssl/lib]
 +
$ readelf -d ./apps/openssl | grep -i rpath
 +
0x000000000000000f (RPATH)              Library rpath: [/usr/local/ssl/lib]</pre>
 +
 
 +
Once you perform <tt>make install</tt>, then <tt>ldd</tt> will produce expected results:
 +
 
 +
<pre>$ ldd /usr/local/ssl/lib/libssl.so
 +
linux-vdso.so.1 =>  (0x00007ffceff6c000)
 +
ibcrypto.so.1.0.0 => /usr/local/ssl/lib/libcrypto.so.1.0.0 (0x00007ff5eff96000)
 
...
 
...
$ make depend
+
   
...
+
$ ldd /usr/local/ssl/bin/openssl
$ make all
+
linux-vdso.so.1 =>  (0x00007ffc30d3a000)
...
+
libssl.so.1.0.0 => /usr/local/ssl/lib/libssl.so.1.0.0 (0x00007f9e8372e000)
$ sudo -E make install</pre>
+
libcrypto.so.1.0.0 => /usr/local/ssl/lib/libcrypto.so.1.0.0 (0x00007f9e832c0000)
 +
...</pre>
  
 
=== FIPS Capable Library ===
 
=== FIPS Capable Library ===
Line 234: Line 345:
 
<pre>./config fips no-ec2m <other options ...></pre>
 
<pre>./config fips no-ec2m <other options ...></pre>
  
== Compilation ==
+
=== Compile Time Checking ===
  
Once you untar the source files (or fetched them from source control), its a good idea to look at README provided in it.
+
If you disable an option during configure, you can check if it's available through <tt>OPENSSL_NO_*</tt> defines. OpenSSL writes the configure options to <tt><openssl/opensslconf.h></tt>. For example, if you want to know if SSLv3 is available, then you would perform the following in your code:
  
cat README
+
<pre>#include <openssl/opensslconf.h>
 +
...
  
where you will understand that you have to read another file INSTALL :
+
#if !defined(OPENSSL_NO_SSL3)
 +
  /* SSLv3 is available */
 +
#endif</pre>
  
cat INSTALL
+
== Compilation ==
  
Depending on your platform you will have to pick up the right INSTALL by example INSTALL.W64.
+
After configuring the library, you should run <tt>make</tt>. If prompted, there's usually no need to <tt>make depend</tt> since you are building from a clean download.
Default is for Unix based systems.
 
  
 
==== Quick ====
 
==== Quick ====
  
<pre>./config <nowiki><options ...></nowiki>
+
<pre>./config <nowiki><options ...> --openssldir=/usr/local/ssl</nowiki>
make depend
 
 
make
 
make
 
make test
 
make test
make install</pre>
+
sudo make install</pre>
  
Various options can be found examining the <tt>Configure</tt> file (there is a well commented block at its top). OpenSSL ships with SSLv2, SSLv3 and Compression enabled by default (see <tt>my $disabled</tt>), so you might want to use <tt>-no-ssl2</tt>, <tt>-no-ssl3</tt>, and <tt>-no-comp</tt>.
+
Various options can be found examining the <tt>Configure</tt> file (there is a well commented block at its top). OpenSSL ships with SSLv2, SSLv3 and Compression enabled by default (see <tt>my $disabled</tt>), so you might want to use <tt>no-ssl2 no-ssl3</tt>, <tt>no-ssl3</tt>, and <tt>no-comp</tt>.
  
 
== Platfom specific ==
 
== Platfom specific ==
Line 264: Line 376:
  
 
==== ARM ====
 
==== ARM ====
 +
 +
==== X32 (ILP32) ====
 +
 +
X32 uses the 32-bit data model (ILP32) on x86_64/amd64. To properly configure for X32 under current OpenSSL distributions, you must use <tt>Configure</tt> and use the x32 triplet:
 +
 +
<pre># ./Configure LIST | grep x32
 +
linux-x32
 +
...</pre>
 +
 +
Then:
 +
 +
<pre># ./Configure linux-x32     
 +
Configuring OpenSSL version 1.1.0-pre6-dev (0x0x10100006L)
 +
    no-asan        [default]  OPENSSL_NO_ASAN (skip dir)
 +
    ...
 +
Configuring for linux-x32
 +
CC            =gcc
 +
CFLAG        =-Wall -O3 -pthread -mx32 -DL_ENDIAN
 +
SHARED_CFLAG  =-fPIC
 +
...</pre>
 +
 +
If using an amd64-compatible processor and GCC with that supports <tt>__uint128_t</tt>, then you usually add <tt>enable-ec_nistp_64_gcc_128 </tt> in addition to your other flags.
  
 
=== Windows ===
 
=== Windows ===
 +
3noch wrote a VERY good guide in 2012 [https://web.archive.org/web/20161123004257/http://developer.covenanteyes.com/building-openssl-for-visual-studio// here] (PLEASE NOTE: the guide was written in 2012 and is no longer available at the original location; the link now points to an archived version at the Internet Archive Wayback Machine).
 +
 +
Like he said in his article, make absolutely sure to create separate directories for 32 and 64 bit versions.
  
 
==== W32 / Windows NT - Windows 9x ====
 
==== W32 / Windows NT - Windows 9x ====
Line 280: Line 417:
 
==== W64 ====
 
==== W64 ====
  
type INSTALL.W64
+
Read first the INSTALL.W64 documentation note containing some specific 64bits information.
 +
See also INSTALL.W32 that still provides additonnal build information common to both the 64 and 32 bit versions.
 +
 
 +
You may be surprised: the 64bit artefacts are indeed output in the out32* sub-directories and bear names ending *32.dll. Fact is the 64 bit compile target is so far an incremental change over the legacy 32bit windows target. Numerous compile flags are still labelled "32" although those do apply to both 32 and 64bit targets.
 +
 
 +
The important pre-requisites are to have PERL available (for essential file processing so as to prepare sources and scripts for the target OS) and of course a C compiler like Microsoft Visual Studio for C/C++. Also note the procedure changed at OpenSSL 1.1.0 and is more streamlined. Also see [https://stackoverflow.com/q/39076244/608639 Why there is no ms\do_ms.bat after perl Configure VC-WIN64A] on Stack Overflow.
 +
 
 +
=== OpenSSL 1.1.0 ===
 +
 
 +
For OpenSSL 1.1.0 and above perform these steps:
 +
 
 +
# Ensure you have perl installed on your machine (e.g. ActiveState or Strawberry), and available on your %PATH%
 +
# Ensure you have NASM installed on your machine, and available on your %PATH%
 +
# Extract the source files to your folder, here <code>cd c:\myPath\openssl</code>
 +
# Launch Visual Studio tool x64 Cross Tools Command prompt
 +
# Goto your defined folder <code>cd c:\myPath\openssl</code>
 +
# Configure for the target OS with <code>perl Configure VC-WIN64A</code> or other configurations to be found in the INSTALL file (e.g. UNIX targets).
 +
## For instance: <code>perl Configure VC-WIN64A</code>.
 +
# (''Optional'') In case you compiled before on 32 or 64-bits, make sure you run <code>nmake clean</code> to prevent trouble across 32 and 64-bits which share output folder.
 +
# Now build with: <code>nmake</code>
 +
# Output can be found in the '''root''' of your folder as '''libcrypto-1_1x64.dll''' and '''libssl-1_1-x64.dll''' (with all the build additionals such as .pdb .lik or static .lib). You may check this is true 64bit code using the Visual Studio tool 'dumpbin'. For instance <code>dumpbin  /headers libcrypto-1_1x64.dll | more</code>, and look at the FILE HEADER section.
 +
# Test the code using the 'test' make target, by running <code>nmake test</code>.
 +
# Reminder, clean your code to prevent issues the next time you compile for a different target. See step 7.
 +
 
 +
==== Windows CE ====
 +
'' Not specified ''
 +
 
 +
=== OpenSSL 1.0.2 ===
 +
 
 +
For OpenSSL 1.0.2 and earlier the procedure is as follows.
  
basically some specific 64bits information, default Windows build information is still in INSTALL.W32
+
# Ensure you have perl installed on your machine (e.g. ActiveState or Strawberry), and available on your %PATH%
 +
# Ensure you have NASM installed on your machine, and available on your %PATH%
 +
# launch a Visual Studio tool x64 Cross Tools Command prompt
 +
# change to the directory where you have copied openssl sources <code>cd c:\myPath\openssl</code>
 +
# configure for the target OS with the command <code>perl Configure VC-WIN64A</code>. You may also be interested to set more configuration options as documented in the general INSTALL note (for UNIX targets). For instance: <code>perl Configure VC-WIN64A</code>.
 +
# prepare the target environment with the command: <code>ms\do_win64a</code>
 +
# ensure you start afresh and notably without linkable products from a previous 32bit compile (as 32 and 64 bits compiling still share common directories) with the command: <code>nmake -f ms\ntdll.mak clean</code> for the DLL target and <code>nmake -f ms\nt.mak clean</code> for static libraries.
 +
# build the code with: <code>nmake -f ms\ntdll.mak</code> (respectively <code>nmake -f ms\nt.mak</code> )
 +
# the artefacts will be found in sub directories out32dll and out32dll.dbg (respectively out32 and out32.dbg for static libraries). The libcrypto and ssl libraries are still named libeay32.lib and ssleay32.lib, and associated includes in inc32 ! You may check this is true 64bit code using the Visual Studio tool 'dumpbin'. For instance <code>dumpbin  /headers out32dll/libeay32.lib | more</code>, and look at the FILE HEADER section.
 +
# test the code using the various *test.exe programs in out32dll. Use the 'test' make target to run all tests as in <code>nmake -f ms\ntdll.mak test</code>
 +
# we recommend that you move/copy needed includes and libraries from the "32" directories under a new explicit directory tree for 64bit applications from where you will import and link your target applications, similar to that explained in INSTALL.W32.
  
 
==== Windows CE ====
 
==== Windows CE ====
  
=== Mac ===
+
=== OS X ===
 +
 
 +
The earlier discussion presented a lot of information (and some of it had OS X information). Here are the TLDR versions to configure, build and install the library.
 +
 
 +
If configuring for 64-bit OS X, then use a command similar to:
 +
 
 +
<pre>./Configure darwin64-x86_64-cc shared enable-ec_nistp_64_gcc_128 no-ssl2 no-ssl3 no-comp --openssldir=/usr/local/ssl/macos-x86_64
 +
make depend
 +
sudo make install</pre>
 +
 
 +
If configuring for 32-bit OS X, then use a command similar to:
 +
 
 +
<pre>./Configure darwin-i386-cc shared no-ssl2 no-ssl3 no-comp --openssldir=/usr/local/ssl/macosx-i386
 +
make depend
 +
sudo make install</pre>
 +
 
 +
If you want to build a multiarch OpenSSL library, then see this answer on Stack Overflow: [http://stackoverflow.com/a/25531033/608639 Build Multiarch OpenSSL on OS X].
 +
 
 +
=== iOS ===
 +
 
 +
The following builds OpenSSL for iOS using the iPhoneOS SDK. The configuration avoids the dynamic library the DSO interface and engines.
 +
 
 +
If you run <tt>make install</tt>, then the headers will be installed in <tt>/usr/local/openssl-ios/include</tt> and libraries will be installed in <tt>/usr/local/openssl-ios/lib</tt>.
 +
 
 +
==== 32-bit ====
 +
 
 +
For OpenSSL 1.1.0 and above, a 32-bit iOS cross-compiles uses the <tt>ios-cross</tt> target, and options similar to <tt>--prefix=/usr/local/openssl-ios</tt>.
 +
 
 +
<pre>$ export CC=clang;
 +
$ export CROSS_TOP=/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer
 +
$ export CROSS_SDK=iPhoneOS.sdk
 +
$ export PATH="/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin:$PATH"
 +
 
 +
$ ./Configure ios-cross no-shared no-dso no-hw no-engine --prefix=/usr/local/openssl-ios
 +
 
 +
Configuring OpenSSL version 1.1.1-dev (0x10101000L)
 +
    no-afalgeng    [forced]  OPENSSL_NO_AFALGENG
 +
    no-asan        [default]  OPENSSL_NO_ASAN
 +
    no-dso          [option]
 +
    no-dynamic-engine [forced]
 +
    ...
 +
    no-weak-ssl-ciphers [default]  OPENSSL_NO_WEAK_SSL_CIPHERS
 +
    no-zlib        [default]
 +
    no-zlib-dynamic [default]
 +
Configuring for ios-cross
 +
 
 +
PERL          =perl
 +
PERLVERSION  =5.16.2 for darwin-thread-multi-2level
 +
HASHBANGPERL  =/usr/bin/env perl
 +
CC            =clang
 +
CFLAG        =-O3 -D_REENTRANT -arch armv7 -mios-version-min=6.0.0 -isysroot $(CROSS_TOP)/SDKs/$(CROSS_SDK) -fno-common
 +
CXX          =c++
 +
CXXFLAG      =-O3 -D_REENTRANT -arch armv7 -mios-version-min=6.0.0 -isysroot $(CROSS_TOP)/SDKs/$(CROSS_SDK) -fno-common
 +
DEFINES      =NDEBUG OPENSSL_THREADS OPENSSL_NO_DYNAMIC_ENGINE OPENSSL_PIC OPENSSL_BN_ASM_MONT OPENSSL_BN_ASM_GF2m SHA1_ASM SHA256_ASM SHA512_ASM AES_ASM BSAES_ASM GHASH_ASM ECP_NISTZ256_ASM POLY1305_ASM
 +
...</pre>
 +
 
 +
If you are working with OpenSSL 1.0.2 or below, then use the <tt>iphoneos-cross</tt> target.
 +
 
 +
<pre>$ export CC=clang;
 +
$ export CROSS_TOP=/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer
 +
$ export CROSS_SDK=iPhoneOS.sdk
 +
$ export PATH="/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin:$PATH"
 +
 
 +
$ ./Configure iphoneos-cross no-shared no-dso no-hw no-engine --prefix=/usr/local/openssl-ios
 +
Configuring for iphoneos-cross
 +
    no-dso          [option]
 +
    no-engine      [option]  OPENSSL_NO_ENGINE (skip dir)
 +
    no-gmp          [default]  OPENSSL_NO_GMP (skip dir)
 +
    no-hw          [option]  OPENSSL_NO_HW
 +
    ...
 +
    no-weak-ssl-ciphers [default]  OPENSSL_NO_WEAK_SSL_CIPHERS (skip dir)
 +
    no-zlib        [default]
 +
    no-zlib-dynamic [default]
 +
IsMK1MF=0
 +
CC            =clang
 +
CFLAG        =-DOPENSSL_THREADS -D_REENTRANT -O3 -isysroot $(CROSS_TOP)/SDKs/$(CROSS_SDK) -fomit-frame-pointer -fno-common
 +
...</pre>
 +
 
 +
==== 64-bit ====
 +
 
 +
For OpenSSL 1.1.0 , a 64-bit iOS cross-compiles uses the <tt>ios64-cross</tt> target, and <tt>--prefix=/usr/local/openssl-ios64</tt>. <tt>ios64-cross</tt>. There is no built-in 64-bit iOS support for OpenSSL 1.0.2 or below.
 +
 
 +
<pre>$ export CC=clang;
 +
$ export CROSS_TOP=/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer
 +
$ export CROSS_SDK=iPhoneOS.sdk
 +
$ export PATH="/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin:$PATH"
 +
 
 +
$ ./Configure ios64-cross no-shared no-dso no-hw no-engine --prefix=/usr/local/openssl-ios64
 +
 
 +
Configuring OpenSSL version 1.1.1-dev (0x10101000L)
 +
    no-afalgeng    [forced]  OPENSSL_NO_AFALGENG
 +
    no-asan        [default]  OPENSSL_NO_ASAN
 +
    no-dso          [option]
 +
    no-dynamic-engine [forced]
 +
    ...
 +
    no-weak-ssl-ciphers [default]  OPENSSL_NO_WEAK_SSL_CIPHERS
 +
    no-zlib        [default]
 +
    no-zlib-dynamic [default]
 +
Configuring for ios64-cross
  
 +
PERL          =perl
 +
PERLVERSION  =5.16.2 for darwin-thread-multi-2level
 +
HASHBANGPERL  =/usr/bin/env perl
 +
CC            =clang
 +
CFLAG        =-O3 -D_REENTRANT -arch arm64 -mios-version-min=7.0.0 -isysroot $(CROSS_TOP)/SDKs/$(CROSS_SDK) -fno-common
 +
CXX          =c++
 +
CXXFLAG      =-O3 -D_REENTRANT -arch arm64 -mios-version-min=7.0.0 -isysroot $(CROSS_TOP)/SDKs/$(CROSS_SDK) -fno-common
 +
DEFINES      =NDEBUG OPENSSL_THREADS OPENSSL_NO_DYNAMIC_ENGINE OPENSSL_PIC OPENSSL_BN_ASM_MONT SHA1_ASM SHA256_ASM SHA512_ASM VPAES_ASM ECP_NISTZ256_ASM POLY1305_ASM
 +
...</pre>
 +
 +
=== Android ===
 +
 +
Visit [[Android]] and [[FIPS Library and Android]].
  
 
=== More ===
 
=== More ===
Line 299: Line 586:
  
 
==== NetWare ====
 
==== NetWare ====
 +
5.x 6.x
 +
 +
==== HP-UX ====
 +
[[HP-UX Itanium FIPS and OpenSSL build]]
  
5.x 6.x
+
==Autoconf==
 +
 
 +
OpenSSL uses its own configuration system, and does not use Autoconf. However, a number of popular projects use both OpenSSL and Autoconf, and it would be useful to detect either <tt>OPENSSL_init_ssl</tt> or <tt>SSL_library_init</tt> from <tt>libssl</tt>. To craft a feature test for OpenSSL that recognizes both <tt>OPENSSL_init_ssl</tt> and <tt>SSL_library_init</tt>, you can use the following.
 +
 
 +
<pre>if test "$with_openssl" = yes ; then
 +
  dnl Order matters!
 +
  if test "$PORTNAME" != "win32"; then
 +
    AC_CHECK_LIB(crypto, CRYPTO_new_ex_data, [], [AC_MSG_ERROR([library 'crypto' is required for OpenSSL])])
 +
    FOUND_SSL_LIB="no"
 +
    AC_CHECK_LIB(ssl, OPENSSL_init_ssl, [FOUND_SSL_LIB="yes"])
 +
    AC_CHECK_LIB(ssl, SSL_library_init, [FOUND_SSL_LIB="yes"])
 +
    AS_IF([test "x$FOUND_SSL_LIB" = xno], [AC_MSG_ERROR([library 'ssl' is required for OpenSSL])])
 +
  else
 +
    AC_SEARCH_LIBS(CRYPTO_new_ex_data, eay32 crypto, [], [AC_MSG_ERROR([library 'eay32' or 'crypto' is required for OpenSSL])])
 +
    FOUND_SSL_LIB="no"
 +
    AC_SEARCH_LIBS(OPENSSL_init_ssl, ssleay32 ssl, [FOUND_SSL_LIB="yes"])
 +
    AC_SEARCH_LIBS(SSL_library_init, ssleay32 ssl, [FOUND_SSL_LIB="yes"])
 +
    AS_IF([test "x$FOUND_SSL_LIB" = xno], [AC_MSG_ERROR([library 'ssleay32' or 'ssl' is required for OpenSSL])])
 +
  fi
 +
fi</pre>
 +
 
 +
Many thanks to the Postgres folks for donating part of their <tt>configure.in</tt>. Also see [http://stackoverflow.com/q/39285733 How to tell Autoconf “require symbol A or B” from LIB?] on Stack Overflow.
  
 
[[Category:Shell level]]
 
[[Category:Shell level]]
 
[[Category:Installation]]
 
[[Category:Installation]]
 
[[Category:Compilation]]
 
[[Category:Compilation]]

Latest revision as of 13:58, 16 April 2021

The following page is a combination of the INSTALL file provided with the OpenSSL library and notes from the field. If you have questions about what you are doing or seeing, then you should consult INSTALL since it contains the commands and specifies the behavior by the development team.

OpenSSL uses a custom build system to configure the library. Configuration will allow the library to set up the recursive makefiles from makefile.org. Once configured, you use make to build the library. You should avoid custom build systems because they often miss details, like each architecture and platform has a unique opensslconf.h and bn.h generated by Configure.

You must use a C compiler to build the OpenSSL library. You cannot use a C++ compiler. Later, once the library is built, it is OK to create user programs with a C++ compiler. But the library proper must be built with a C compiler.

There are two generations of build system. First is the build system used in OpenSSL 1.0.2 and below. The instructions below apply to it. Second is the build system for OpenSSL 1.1.0 and above. The instructions are similar, but not the same. For example, the second generation abandons the monolithic Configure and places individual configurations in the Configurations directory. Also, the second generation is more platform agnostic and uses templates to produce a final, top level build file (Makefile, descrip.mms, what have you).

After you configure and build the library, you should always perform a make test to ensure the library performs as expected under its self tests. If you are building OpenSSL 1.1.0 and above, then you will also need PERL 5.10 or higher (see README.PERL for details).

OpenSSL's build system does not rely upon autotools or libtool. Also see Why aren't tools like 'autoconf' and 'libtool' used? in the OpenSSL FAQ.

Retrieve source code[edit]

The OpenSSL source code can be downloaded from OpenSSL Source Tarballs or any suitable ftp mirror. There are various versions including stable as well as unstable versions.

The source code is managed via Git. It's referred to as Master. The repository is

git://git.openssl.org/openssl.git

The source is also available via a GitHub mirror. This repository is updated every 15 minutes.

Configuration[edit]

OpenSSL is configured for a particular platform with protocol and behavior options using Configure and config.

You should avoid custom build systems because they often miss details, like each architecture and platform has a unique opensslconf.h and bn.h generated by Configure.

Supported Platforms[edit]

You can run Configure LIST to see a list of available platforms.

$ ./Configure LIST
BC-32
BS2000-OSD
BSD-generic32
BSD-generic64
BSD-ia64
BSD-sparc64
BSD-sparcv8
BSD-x86
BSD-x86-elf
BSD-x86_64
Cygwin
Cygwin-x86_64
DJGPP
...

If your platform is not listed, then use a similar platform and tune the $cflags and $ldflags by making a copy of the configure line and giving it its own name. $cflags and $ldflags correspond to fields 2 and 6 in a configure line. An example of using a similar configure line is presented in Using RPATHs.

Configure & Config[edit]

You use Configure and config to tune the compile and installation process through options and switches. The difference between is Configure properly handles the host-arch-compiler triplet, and config does not. config attempts to guess the triplet, so it's a lot like autotool's config.guess.

You can usually use config and it will do the right thing (from Ubuntu 13.04, x64):

$ ./config 
Operating system: x86_64-whatever-linux2
Configuring for linux-x86_64
Configuring for linux-x86_64
    no-ec_nistp_64_gcc_128 [default]  OPENSSL_NO_EC_NISTP_64_GCC_128 (skip dir)
    no-gmp          [default]  OPENSSL_NO_GMP (skip dir)
    no-jpake        [experimental] OPENSSL_NO_JPAKE (skip dir)
    no-krb5         [krb5-flavor not specified] OPENSSL_NO_KRB5
    ...

Mac OS X can have issues (it's often a neglected platform), and you will have to use Configure:

 ./Configure darwin64-x86_64-cc
Configuring for darwin64-x86_64-cc
    no-ec_nistp_64_gcc_128 [default]  OPENSSL_NO_EC_NISTP_64_GCC_128 (skip dir)
    no-gmp          [default]  OPENSSL_NO_GMP (skip dir)
    no-jpake        [experimental] OPENSSL_NO_JPAKE (skip dir)
    no-krb5         [krb5-flavor not specified] OPENSSL_NO_KRB5
    ...

You can also configure on Darwin by exporting KERNEL_BITS:

$ export KERNEL_BITS=64
$ ./config shared no-ssl2 no-ssl3 enable-ec_nistp_64_gcc_128 --openssldir=/usr/local/ssl/macosx-x64/
Operating system: i686-apple-darwinDarwin Kernel Version 12.5.0: Sun Sep 29 13:33:47 PDT 2013; root:xnu-2050.48.12~1/RELEASE_X86_64
Configuring for darwin64-x86_64-cc
Configuring for darwin64-x86_64-cc
    no-gmp          [default]  OPENSSL_NO_GMP (skip dir)
    no-jpake        [experimental] OPENSSL_NO_JPAKE (skip dir)
    no-krb5         [krb5-flavor not specified] OPENSSL_NO_KRB5
    ...

If you provide a option not known to configure or ask for help, then you get a brief help message:

$ ./Configure --help
Usage: Configure [no-<cipher> ...] [enable-<cipher> ...] [experimental-<cipher> ...]
[-Dxxx] [-lxxx] [-Lxxx] [-fxxx] [-Kxxx] [no-hw-xxx|no-hw] [[no-]threads] [[no-]shared]
[[no-]zlib|zlib-dynamic] [no-asm] [no-dso] [no-krb5] [sctp] [386] [--prefix=DIR]
[--openssldir=OPENSSLDIR] [--with-xxx[=vvv]] [--test-sanity] os/compiler[:flags]

And if you supply an unknown triplet:

$ ./Configure darwin64-x86_64-clang
Configuring for darwin64-x86_64-clang
Usage: Configure [no-<cipher> ...] [enable-<cipher> ...] [experimental-<cipher> ...]
[-Dxxx] [-lxxx] [-Lxxx] [-fxxx] [-Kxxx] [no-hw-xxx|no-hw] [[no-]threads] [[no-]shared]
[[no-]zlib|zlib-dynamic] [no-asm] [no-dso] [no-krb5] [sctp] [386] [--prefix=DIR]
[--openssldir=OPENSSLDIR] [--with-xxx[=vvv]] [--test-sanity] os/compiler[:flags]

pick os/compiler from:
BC-32 BS2000-OSD BSD-generic32 BSD-generic64 BSD-ia64 BSD-sparc64 BSD-sparcv8 
BSD-x86 BSD-x86-elf BSD-x86_64 Cygwin Cygwin-pre1.3 DJGPP MPE/iX-gcc OS2-EMX 
...

NOTE: If in doubt, on Unix-ish systems use './config'.

Dependencies[edit]

If you are prompted to run make depend, then you must do so. For OpenSSL 1.0.2 and below, it's required to update the standard distribution once configuration options change.

Since you've disabled or enabled at least one algorithm, you need to do
the following before building:

	make depend

OpenSSL 1.1.0 and above performs the dependency step for you, so you should not see the message. However, you should perform a make clean to ensure the list of objects files is accurate after a reconfiguration.

Configure Options[edit]

OpenSSL has been around a long time, and it carries around a lot of cruft. For example, from above, SSLv2 is enabled by default. SSLv2 is completely broken, and you should disable it during configuration. You can disable protocols and provide other options through Configure and config, and the following lists some of them.

Note: if you specify a non-existent option, then the configure scripts will proceed without warning. For example, if you inadvertently specify no-sslv2 rather than no-ssl2 no-ssl3, the script will configure with SSLv2 and without warning for the unknown no-sslv2.

Note: when building a shared object, both the static archive and shared objects are built. You do not need to do anything special to build both when shared is specified.

OpenSSL Library Options
Option Description
--prefix=XXX See PREFIX and OPENSSLDIR in the next section (below).
--openssldir=XXX See PREFIX and OPENSSLDIR in the next section (below).
-d Debug build of the library. Optimizations are disabled (no -O3 or similar) and libefence is used (apt-get install electric-fence or yum install electric-fence). TODO: Any other features?
shared Build a shared object in addition to the static archive. You probably need a RPATH when enabling shared to ensure openssl uses the correct libssl and libcrypto after installation.
enable-ec_nistp_64_gcc_128 Use on little endian platforms when GCC supports __uint128_t. ECDH is about 2 to 4 times faster. Not enabled by default because Configure can't determine it. Enable it if your compiler defines __SIZEOF_INT128__, the CPU is little endian and it tolerates unaligned data access.
enable-capieng Enables the Microsoft CAPI engine on Windows platforms. Used to access the Windows Certificate Store. Also see Using Windows certificate store through OpenSSL on the OpenSSL developer list.
no-ssl2 Disables SSLv2. OPENSSL_NO_SSL2 will be defined in the OpenSSL headers.
no-ssl3 Disables SSLv3. OPENSSL_NO_SSL3 will be defined in the OpenSSL headers.
no-comp Disables compression independent of zlib. OPENSSL_NO_COMP will be defined in the OpenSSL headers.
no-idea Disables IDEA algorithm. Unlike RC5 and MDC2, IDEA is enabled by default
no-asm Disables assembly language routines (and uses C routines)
no-dtls Disables DTLS in OpenSSL 1.1.0 and above
no-dtls1 Disables DTLS in OpenSSL 1.0.2 and below
no-shared Disables shared objects (only a static library is created)
no-hw Disables hardware support (useful on mobile devices)
no-engine Disables hardware support (useful on mobile devices)
no-threads Disables threading support.
no-dso Disables the OpenSSL DSO API (the library offers a shared object abstraction layer). If you disable DSO, then you must disable Engines also
no-err Removes all error function names and error reason text to reduce footprint
no-npn/no-nextprotoneg Disables Next Protocol Negotiation (NPN). Use no-nextprotoneg for 1.1.0 and above; and no-npn otherwise
no-psk Disables Preshared Key (PSK). PSK provides mutual authentication independent of trusted authorities, but it's rarely offered or used
no-srp Disables Secure Remote Password (SRP). SRP provides mutual authentication independent of trusted authorities, but it's rarely offered or used
no-ec2m Used when configuring FIPS Capable Library with a FIPS Object Module that only includes prime curves. That is, use this switch if you use openssl-fips-ecp-2.0.5.
no-weak-ssl-ciphers Disables RC4. Available in OpenSSL 1.1.0 and above.
-DXXX Defines XXX. For example, -DOPENSSL_NO_HEARTBEATS.
-DPEDANTIC Defines PEDANTIC. The library will avoid some undefined behavior, like casting an unaligned byte array to a different pointer type. This define should be used if building OpenSSL with undefined behavior sanitizer (-fsanitize=undefined).
-DOPENSSL_USE_IPV6=0 Disables IPv6. Useful if OpenSSL encounters incorrect or inconsistent platform headers and mistakenly enables IPv6. Must be passed to Configure manually.
-DNO_FORK Defines NO_FORK. Disables calls to fork. Useful for operating systems like AppleTVOS, WatchOS, AppleTVSimulator and WatchSimulator.
-Lsomething, -lsomething, -Ksomething, -Wl,something Linker options, will become part of LDFLAGS.
-anythingelse, +anythingelse Compiler options, will become part of CFLAGS.

Note: on older OSes, like CentOS 5, BSD 5, and Windows XP or Vista, you will need to configure with no-async when building OpenSSL 1.1.0 and above. The configuration system does not detect lack of the Posix feature on the platforms.

Note: you can verify compiler support for __uint128_t with the following:

# gcc -dM -E - </dev/null | grep __SIZEOF_INT128__  
#define __SIZEOF_INT128__ 16

PREFIX and OPENSSLDIR[edit]

--prefix and --openssldir control the configuration of installed components. The behavior and interactions of --prefix and --openssldir are slightly different between OpenSSL 1.0.2 and below, and OpenSSL 1.1.0 and above.

The rule of thumb to use when you want something that "just works" for all recent versions of OpenSSL, including OpenSSL 1.0.2 and 1.1.0, is:

  • specify both --prefix and --openssldir
  • set --prefix and --openssldir to the same location

One word of caution is avoid --prefix=/usr when OpenSSL versions are not binary compatible. You will replace the distro's version of OpenSSL with your version of OpenSSL. It will most likely break everything, including the package management system.


OpenSSL 1.0.2 and below

It is usually not necessary to specify --prefix. If --prefix is not specified, then --openssldir is used. However, specifying only --prefix may result in broken builds because the 1.0.2 build system attempts to build in a FIPS configuration.

You can omit If --prefix and use --openssldir. In this case, the paths for --openssldir will be used during configuration. If --openssldir is not specified, the the default /usr/local/ssl is used.

The takeaway is /usr/local/ssl is used by default, and it can be overridden with --openssldir. The rule of thumb applies for path overrides: specify both --prefix and --openssldir.


OpenSSL 1.1.0 and above

OpenSSL 1.1.0 changed the behavior of install rules. You should specify both --prefix and --openssldir to ensure make install works as expected.

The takeaway is /usr/local/ssl is used by default, and it can be overridden with both --prefix and --openssldir. The rule of thumb applies for path overrides: specify both --prefix and --openssldir.

Debug Configuration[edit]

From the list above, it's possible to quickly configure a "debug" build with ./config -d. However, you can often get into a more amicable state without the Electric Fence dependency by issuing:

$ ./config no-asm -g3 -O0 -fno-omit-frame-pointer -fno-inline-functions
Operating system: x86_64-whatever-linux2
Configuring for linux-x86_64
Configuring OpenSSL version 1.1.0-pre5-dev (0x0x10100005L)
    no-asm          [option]   OPENSSL_NO_ASM
    ...
Configuring for linux-x86_64
IsMK1MF       =no
CC            =gcc
CFLAG         =-Wall -O3 -pthread -m64 -DL_ENDIAN  -g3 -O0 -fno-omit-frame-pointer
...

Don't be alarmed about both -O3 and -O0. The last setting "sticks", and that's the -O0.

If you are working in Visual Studio and you can't step into library calls, then see Step into not working, but can force stepping after some asm steps on Stack Overflow.

Modifying Build Settings[edit]

Sometimes you need to work around OpenSSL's selections for building the library. For example, you might want to use -Os for a mobile device (rather than -O3), or you might want to use the clang compiler (rather than gcc).

In case like these, its' often easier to modify Configure and Makefile.org rather than trying to add targets to the configure scripts. Below is a patch that modifies Configure and Makefile.org for use under the iOS 7.0 SDK (which lacks gcc in /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/):

  • Modifies Configure to use clang
  • Modifies Makefile.org to use clang
  • Modifies CFLAG to use -Os
  • Modifies MAKEDEPPROG to use $(CC) -M

Setting and resetting of LANG is required on Mac OSX to work around a sed bug or limitation.

OLD_LANG=$LANG
unset LANG

sed -i "" 's|\"iphoneos-cross\"\,\"llvm-gcc\:-O3|\"iphoneos-cross\"\,\"clang\:-Os|g' Configure
sed -i "" 's/CC= cc/CC= clang/g' Makefile.org
sed -i "" 's/CFLAG= -O/CFLAG= -Os/g' Makefile.org
sed -i "" 's/MAKEDEPPROG=makedepend/MAKEDEPPROG=$(CC) -M/g' Makefile.org

export LANG=$OLD_LANG

After modification, be sure to dclean and configure again so the new settings are picked up:

make dclean

./config
make depend
make all
...

Using RPATHs[edit]

RPATH's are supported by default on the BSD platforms, but not others. If you are working on Linux and compatibles, then you have to manually add an RPATH. One of the easiest ways to add a RPATH is to configure with it as shown below.

./config -Wl,-rpath=/usr/local/ssl/lib

For modern Linux you should also use -Wl,--enable-new-dtags. The linker option sets a RUNPATH as opposed to a RPATH. A RUNPATH allows library path overrides at runtime, while a RPATH does not.

./config -Wl,-rpath=/usr/local/ssl/lib -Wl,--enable-new-dtags

Note well: you should use a RPATH or RUNPATH when building both OpenSSL and your program. If you don't add a RPATH or RUNPATH to both, then your program could runtime-link to the wrong version of OpenSSL. Linking against random versions of a security library is not a good idea.

You can also add an RPATH or RUNPATH by hard coding the RPATH into a configure line. For example, on Debian x86_64 open the file Configure in an editor, copy linux-x86_64, name it linux-x86_64-rpath, and make the following change to add the -rpath option. Notice the addition of -Wl,-rpath=... in two places.

"linux-x86_64-rpath", "gcc:-m64 -DL_ENDIAN -O3 -Wall -Wl,-rpath=/usr/local/ssl/lib::
  -D_REENTRANT::-Wl,-rpath=/usr/local/ssl/lib -ldl:SIXTY_FOUR_BIT_LONG RC4_CHUNK DES_INT DES_UNROLL:
  ${x86_64_asm}:elf:dlfcn:linux-shared:-fPIC:-m64:.so.\$(SHLIB_MAJOR).\$(SHLIB_MINOR):::64",

Above, fields 2 and 6 were changed. They correspond to $cflag and $ldflag in OpenSSL's builds system.

Then, Configure with the new configuration:

$ ./Configure linux-x86_64-rpath shared no-ssl2 no-ssl3 no-comp \
    --openssldir=/usr/local/ssl enable-ec_nistp_64_gcc_128

Finally, after make, verify the settings stuck:

$ readelf -d ./libssl.so | grep -i -E 'rpath|runpath'
0x000000000000000f (RPATH)              Library rpath: [/usr/local/ssl/lib]
$ readelf -d ./libcrypto.so | grep -i rpath
0x000000000000000f (RPATH)              Library rpath: [/usr/local/ssl/lib]
$ readelf -d ./apps/openssl | grep -i rpath 
0x000000000000000f (RPATH)              Library rpath: [/usr/local/ssl/lib]

Once you perform make install, then ldd will produce expected results:

$ ldd /usr/local/ssl/lib/libssl.so
linux-vdso.so.1 =>  (0x00007ffceff6c000)
 ibcrypto.so.1.0.0 => /usr/local/ssl/lib/libcrypto.so.1.0.0 (0x00007ff5eff96000)
...
    
$ ldd /usr/local/ssl/bin/openssl 
linux-vdso.so.1 =>  (0x00007ffc30d3a000)
libssl.so.1.0.0 => /usr/local/ssl/lib/libssl.so.1.0.0 (0x00007f9e8372e000)
libcrypto.so.1.0.0 => /usr/local/ssl/lib/libcrypto.so.1.0.0 (0x00007f9e832c0000)
...

FIPS Capable Library[edit]

If you want to use FIPS validated cryptography, you download, build and install the FIPS Object Module (openssl-fips-2.0.5.tar.gz) according to the FIPS User Guide 2.0 and FIPS 140-2 Security Policy. You then download, build and install the FIPS Capable Library (openssl-1.0.1e.tar.gz).

When configuring the FIPS Capable Library, you must use fips as an option:

./config fips <other options ...>

If you are configuring the FIPS Capable Library with only prime curves (openssl-fips-ecp-2.0.5.tar.gz), then you must configure with no-ec2m:

./config fips no-ec2m <other options ...>

Compile Time Checking[edit]

If you disable an option during configure, you can check if it's available through OPENSSL_NO_* defines. OpenSSL writes the configure options to <openssl/opensslconf.h>. For example, if you want to know if SSLv3 is available, then you would perform the following in your code:

#include <openssl/opensslconf.h>
...

#if !defined(OPENSSL_NO_SSL3)
  /* SSLv3 is available */
#endif

Compilation[edit]

After configuring the library, you should run make. If prompted, there's usually no need to make depend since you are building from a clean download.

Quick[edit]

./config <options ...> --openssldir=/usr/local/ssl
make
make test
sudo make install

Various options can be found examining the Configure file (there is a well commented block at its top). OpenSSL ships with SSLv2, SSLv3 and Compression enabled by default (see my $disabled), so you might want to use no-ssl2 no-ssl3, no-ssl3, and no-comp.

Platfom specific[edit]

Linux[edit]

Intel[edit]

ARM[edit]

X32 (ILP32)[edit]

X32 uses the 32-bit data model (ILP32) on x86_64/amd64. To properly configure for X32 under current OpenSSL distributions, you must use Configure and use the x32 triplet:

# ./Configure LIST | grep x32
linux-x32
...

Then:

# ./Configure linux-x32      
Configuring OpenSSL version 1.1.0-pre6-dev (0x0x10100006L)
    no-asan         [default]  OPENSSL_NO_ASAN (skip dir)
    ...
Configuring for linux-x32
CC            =gcc
CFLAG         =-Wall -O3 -pthread -mx32 -DL_ENDIAN 
SHARED_CFLAG  =-fPIC
...

If using an amd64-compatible processor and GCC with that supports __uint128_t, then you usually add enable-ec_nistp_64_gcc_128 in addition to your other flags.

Windows[edit]

3noch wrote a VERY good guide in 2012 here (PLEASE NOTE: the guide was written in 2012 and is no longer available at the original location; the link now points to an archived version at the Internet Archive Wayback Machine).

Like he said in his article, make absolutely sure to create separate directories for 32 and 64 bit versions.

W32 / Windows NT - Windows 9x[edit]

type INSTALL.W32

  • you need Perl for Win32. Unless you will build on Cygwin, you will need ActiveState Perl, available from http://www.activestate.com/ActivePerl.
  • one of the following C compilers:
    • Visual C++
    • Borland C
    • GNU C (Cygwin or MinGW)
  • Netwide Assembler, a.k.a. NASM, available from http://nasm.sourceforge.net/ is required if you intend to utilize assembler modules. Note that NASM is now the only supported assembler.

W64[edit]

Read first the INSTALL.W64 documentation note containing some specific 64bits information. See also INSTALL.W32 that still provides additonnal build information common to both the 64 and 32 bit versions.

You may be surprised: the 64bit artefacts are indeed output in the out32* sub-directories and bear names ending *32.dll. Fact is the 64 bit compile target is so far an incremental change over the legacy 32bit windows target. Numerous compile flags are still labelled "32" although those do apply to both 32 and 64bit targets.

The important pre-requisites are to have PERL available (for essential file processing so as to prepare sources and scripts for the target OS) and of course a C compiler like Microsoft Visual Studio for C/C++. Also note the procedure changed at OpenSSL 1.1.0 and is more streamlined. Also see Why there is no ms\do_ms.bat after perl Configure VC-WIN64A on Stack Overflow.

OpenSSL 1.1.0[edit]

For OpenSSL 1.1.0 and above perform these steps:

  1. Ensure you have perl installed on your machine (e.g. ActiveState or Strawberry), and available on your %PATH%
  2. Ensure you have NASM installed on your machine, and available on your %PATH%
  3. Extract the source files to your folder, here cd c:\myPath\openssl
  4. Launch Visual Studio tool x64 Cross Tools Command prompt
  5. Goto your defined folder cd c:\myPath\openssl
  6. Configure for the target OS with perl Configure VC-WIN64A or other configurations to be found in the INSTALL file (e.g. UNIX targets).
    1. For instance: perl Configure VC-WIN64A.
  7. (Optional) In case you compiled before on 32 or 64-bits, make sure you run nmake clean to prevent trouble across 32 and 64-bits which share output folder.
  8. Now build with: nmake
  9. Output can be found in the root of your folder as libcrypto-1_1x64.dll and libssl-1_1-x64.dll (with all the build additionals such as .pdb .lik or static .lib). You may check this is true 64bit code using the Visual Studio tool 'dumpbin'. For instance dumpbin /headers libcrypto-1_1x64.dll | more, and look at the FILE HEADER section.
  10. Test the code using the 'test' make target, by running nmake test.
  11. Reminder, clean your code to prevent issues the next time you compile for a different target. See step 7.

Windows CE[edit]

Not specified

OpenSSL 1.0.2[edit]

For OpenSSL 1.0.2 and earlier the procedure is as follows.

  1. Ensure you have perl installed on your machine (e.g. ActiveState or Strawberry), and available on your %PATH%
  2. Ensure you have NASM installed on your machine, and available on your %PATH%
  3. launch a Visual Studio tool x64 Cross Tools Command prompt
  4. change to the directory where you have copied openssl sources cd c:\myPath\openssl
  5. configure for the target OS with the command perl Configure VC-WIN64A. You may also be interested to set more configuration options as documented in the general INSTALL note (for UNIX targets). For instance: perl Configure VC-WIN64A.
  6. prepare the target environment with the command: ms\do_win64a
  7. ensure you start afresh and notably without linkable products from a previous 32bit compile (as 32 and 64 bits compiling still share common directories) with the command: nmake -f ms\ntdll.mak clean for the DLL target and nmake -f ms\nt.mak clean for static libraries.
  8. build the code with: nmake -f ms\ntdll.mak (respectively nmake -f ms\nt.mak )
  9. the artefacts will be found in sub directories out32dll and out32dll.dbg (respectively out32 and out32.dbg for static libraries). The libcrypto and ssl libraries are still named libeay32.lib and ssleay32.lib, and associated includes in inc32 ! You may check this is true 64bit code using the Visual Studio tool 'dumpbin'. For instance dumpbin /headers out32dll/libeay32.lib | more, and look at the FILE HEADER section.
  10. test the code using the various *test.exe programs in out32dll. Use the 'test' make target to run all tests as in nmake -f ms\ntdll.mak test
  11. we recommend that you move/copy needed includes and libraries from the "32" directories under a new explicit directory tree for 64bit applications from where you will import and link your target applications, similar to that explained in INSTALL.W32.

Windows CE[edit]

OS X[edit]

The earlier discussion presented a lot of information (and some of it had OS X information). Here are the TLDR versions to configure, build and install the library.

If configuring for 64-bit OS X, then use a command similar to:

./Configure darwin64-x86_64-cc shared enable-ec_nistp_64_gcc_128 no-ssl2 no-ssl3 no-comp --openssldir=/usr/local/ssl/macos-x86_64
make depend
sudo make install

If configuring for 32-bit OS X, then use a command similar to:

./Configure darwin-i386-cc shared no-ssl2 no-ssl3 no-comp --openssldir=/usr/local/ssl/macosx-i386
make depend
sudo make install

If you want to build a multiarch OpenSSL library, then see this answer on Stack Overflow: Build Multiarch OpenSSL on OS X.

iOS[edit]

The following builds OpenSSL for iOS using the iPhoneOS SDK. The configuration avoids the dynamic library the DSO interface and engines.

If you run make install, then the headers will be installed in /usr/local/openssl-ios/include and libraries will be installed in /usr/local/openssl-ios/lib.

32-bit[edit]

For OpenSSL 1.1.0 and above, a 32-bit iOS cross-compiles uses the ios-cross target, and options similar to --prefix=/usr/local/openssl-ios.

$ export CC=clang;
$ export CROSS_TOP=/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer
$ export CROSS_SDK=iPhoneOS.sdk
$ export PATH="/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin:$PATH"

$ ./Configure ios-cross no-shared no-dso no-hw no-engine --prefix=/usr/local/openssl-ios

Configuring OpenSSL version 1.1.1-dev (0x10101000L)
    no-afalgeng     [forced]   OPENSSL_NO_AFALGENG
    no-asan         [default]  OPENSSL_NO_ASAN
    no-dso          [option]
    no-dynamic-engine [forced]
    ...
    no-weak-ssl-ciphers [default]  OPENSSL_NO_WEAK_SSL_CIPHERS
    no-zlib         [default]
    no-zlib-dynamic [default]
Configuring for ios-cross

PERL          =perl
PERLVERSION   =5.16.2 for darwin-thread-multi-2level
HASHBANGPERL  =/usr/bin/env perl
CC            =clang
CFLAG         =-O3 -D_REENTRANT -arch armv7 -mios-version-min=6.0.0 -isysroot $(CROSS_TOP)/SDKs/$(CROSS_SDK) -fno-common
CXX           =c++
CXXFLAG       =-O3 -D_REENTRANT -arch armv7 -mios-version-min=6.0.0 -isysroot $(CROSS_TOP)/SDKs/$(CROSS_SDK) -fno-common
DEFINES       =NDEBUG OPENSSL_THREADS OPENSSL_NO_DYNAMIC_ENGINE OPENSSL_PIC OPENSSL_BN_ASM_MONT OPENSSL_BN_ASM_GF2m SHA1_ASM SHA256_ASM SHA512_ASM AES_ASM BSAES_ASM GHASH_ASM ECP_NISTZ256_ASM POLY1305_ASM
...

If you are working with OpenSSL 1.0.2 or below, then use the iphoneos-cross target.

$ export CC=clang;
$ export CROSS_TOP=/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer
$ export CROSS_SDK=iPhoneOS.sdk
$ export PATH="/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin:$PATH"

$ ./Configure iphoneos-cross no-shared no-dso no-hw no-engine --prefix=/usr/local/openssl-ios
Configuring for iphoneos-cross
    no-dso          [option]
    no-engine       [option]   OPENSSL_NO_ENGINE (skip dir)
    no-gmp          [default]  OPENSSL_NO_GMP (skip dir)
    no-hw           [option]   OPENSSL_NO_HW
    ...
    no-weak-ssl-ciphers [default]  OPENSSL_NO_WEAK_SSL_CIPHERS (skip dir)
    no-zlib         [default]
    no-zlib-dynamic [default]
IsMK1MF=0
CC            =clang
CFLAG         =-DOPENSSL_THREADS -D_REENTRANT -O3 -isysroot $(CROSS_TOP)/SDKs/$(CROSS_SDK) -fomit-frame-pointer -fno-common
...

64-bit[edit]

For OpenSSL 1.1.0 , a 64-bit iOS cross-compiles uses the ios64-cross target, and --prefix=/usr/local/openssl-ios64. ios64-cross. There is no built-in 64-bit iOS support for OpenSSL 1.0.2 or below.

$ export CC=clang;
$ export CROSS_TOP=/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer
$ export CROSS_SDK=iPhoneOS.sdk
$ export PATH="/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin:$PATH"

$ ./Configure ios64-cross no-shared no-dso no-hw no-engine --prefix=/usr/local/openssl-ios64

Configuring OpenSSL version 1.1.1-dev (0x10101000L)
    no-afalgeng     [forced]   OPENSSL_NO_AFALGENG
    no-asan         [default]  OPENSSL_NO_ASAN
    no-dso          [option]
    no-dynamic-engine [forced]
    ...
    no-weak-ssl-ciphers [default]  OPENSSL_NO_WEAK_SSL_CIPHERS
    no-zlib         [default]
    no-zlib-dynamic [default]
Configuring for ios64-cross

PERL          =perl
PERLVERSION   =5.16.2 for darwin-thread-multi-2level
HASHBANGPERL  =/usr/bin/env perl
CC            =clang
CFLAG         =-O3 -D_REENTRANT -arch arm64 -mios-version-min=7.0.0 -isysroot $(CROSS_TOP)/SDKs/$(CROSS_SDK) -fno-common
CXX           =c++
CXXFLAG       =-O3 -D_REENTRANT -arch arm64 -mios-version-min=7.0.0 -isysroot $(CROSS_TOP)/SDKs/$(CROSS_SDK) -fno-common
DEFINES       =NDEBUG OPENSSL_THREADS OPENSSL_NO_DYNAMIC_ENGINE OPENSSL_PIC OPENSSL_BN_ASM_MONT SHA1_ASM SHA256_ASM SHA512_ASM VPAES_ASM ECP_NISTZ256_ASM POLY1305_ASM
...

Android[edit]

Visit Android and FIPS Library and Android.

More[edit]

VAX/VMS[edit]

I you wonder what are files ending with .com like test/testca.com those are VAX/VMX scripts. This code is still maintained.

OS/2[edit]

NetWare[edit]

5.x 6.x

HP-UX[edit]

HP-UX Itanium FIPS and OpenSSL build

Autoconf[edit]

OpenSSL uses its own configuration system, and does not use Autoconf. However, a number of popular projects use both OpenSSL and Autoconf, and it would be useful to detect either OPENSSL_init_ssl or SSL_library_init from libssl. To craft a feature test for OpenSSL that recognizes both OPENSSL_init_ssl and SSL_library_init, you can use the following.

if test "$with_openssl" = yes ; then
  dnl Order matters!
  if test "$PORTNAME" != "win32"; then
     AC_CHECK_LIB(crypto, CRYPTO_new_ex_data, [], [AC_MSG_ERROR([library 'crypto' is required for OpenSSL])])
     FOUND_SSL_LIB="no"
     AC_CHECK_LIB(ssl, OPENSSL_init_ssl, [FOUND_SSL_LIB="yes"])
     AC_CHECK_LIB(ssl, SSL_library_init, [FOUND_SSL_LIB="yes"])
     AS_IF([test "x$FOUND_SSL_LIB" = xno], [AC_MSG_ERROR([library 'ssl' is required for OpenSSL])])
  else
     AC_SEARCH_LIBS(CRYPTO_new_ex_data, eay32 crypto, [], [AC_MSG_ERROR([library 'eay32' or 'crypto' is required for OpenSSL])])
     FOUND_SSL_LIB="no"
     AC_SEARCH_LIBS(OPENSSL_init_ssl, ssleay32 ssl, [FOUND_SSL_LIB="yes"])
     AC_SEARCH_LIBS(SSL_library_init, ssleay32 ssl, [FOUND_SSL_LIB="yes"])
     AS_IF([test "x$FOUND_SSL_LIB" = xno], [AC_MSG_ERROR([library 'ssleay32' or 'ssl' is required for OpenSSL])])
  fi
fi

Many thanks to the Postgres folks for donating part of their configure.in. Also see How to tell Autoconf “require symbol A or B” from LIB? on Stack Overflow.