View source for Android

This document will provide instructions for building the OpenSSL library for Android devices. If you need the FIPS Validated Object Module and the FIPS Capable Library, see [[FIPS Library and Android]].

==Executive Summary==

Use the following commands to build and install the OpenSSL library for Android. Before running the commands download openssl-1.0.1g.tar.gz and [[Media:setenv-android.sh|setenv-android.sh]]; place the files in the same directory (the 'root' directory mentioned below); ensure <tt>ANDROID_NDK_ROOT</tt> is set; and verify setenv-android.sh suites your taste. <tt>ANDROID_API</tt> and <tt>ANDROID_TOOLCHAIN</tt> will be set by the <tt>setenv-android.sh</tt> script. The files can be obtained from http://www.openssl.org/source/, http://openssl.com/fips/2.0/platforms/android/, and below (see Downloads section).

=== Prepare the OpenSSL Sources ===

<pre># From the 'root' directory
$ rm -rf openssl-1.0.1g/
$ tar xzf openssl-1.0.1g.tar.gz
$ chmod a+x setenv-android.sh</pre>

=== Build the OpenSSL Library ===

<pre># From the 'root' directory
$ . ./setenv-android.sh
$ cd openssl-1.0.1g/

$ perl -pi -e 's/install: all install_docs install_sw/install: install_docs install_sw/g' Makefile.org
$ ./config shared -no-ssl2 -no-ssl3 -no-comp -no-hw -no-engine --openssldir=/usr/local/ssl/$ANDROID_API

$ make depend
$ make all</pre>

=== Install the OpenSSL Library ===

<pre>$ sudo -E make install CC=$ANDROID_TOOLCHAIN/arm-linux-androideabi-gcc RANLIB=$ANDROID_TOOLCHAIN/arm-linux-androideabi-ranlib</pre>

== OpenSSL Library ==

While the Executive Summary provided the whirlwind instructions for building and installing the OpenSSL library, this sections provides detailed instructions. There are six steps to building the OpenSSL Library for use in various projects, and they are listed below. Projects range from simple NDK based command line programs to Android activities using the JNI bridge.

# Acquire the required files
# Adjust the cross-compilation script
# Prepare the OpenSSL sources
# Build the OpenSSL Library
# Install the OpenSSL Library

=== Acquire the Required Files ===

First, obtain the base files from http://www.openssl.org/source/:
* openssl-1.0.1g.tar.gz

Next, acquire the auxiliary files which can be obtained from below (see Downloads section) or http://openssl.com/fips/2.0/platforms/android/. You won't need all the files from the location.
* [[Media:setenv-android.sh|setenv-android.sh]]

<tt>openssl-1.0.1g.tar.gz</tt> is the OpenSSL Library. <tt>setenv-android.sh</tt> is used to set the cross-compilation environment.

After collecting the required files, your working directory will look similar to below.

<pre>android-openssl $ ls -l 
-rw-r--r-- 1   4459777 Jun 15 03:32 openssl-1.0.1g.tar.gz
-rwxr-xr-x 1      6760 Jun 23 01:52 setenv-android.sh</pre>

=== Adjust the Cross-Compilation Script ===

<tt>setenv-android.sh</tt> is used to set the cross-compilation environment. Open the script an ensure the following match your needs. If you are using android-ndk-r8e, android-14, and <tt>ANDROID_NDK_ROOT</tt> is set, then the script should be ready to use as-is.

* <tt>_ANDROID_NDK</tt> – the version of the NDK. For example, android-ndk-r8e
* <tt>_ANDROID_EABI</tt> – the version of the EABI tools. For example, arm-linux-androideabi-4.6
* <tt>_ANDROID_API</tt> – the API level. For example, android-14

You should also set <tt>ANDROID_SDK_ROOT</tt> and <tt>ANDROID_NDK_ROOT</tt>. The environmental variables are used internally by the Android platform tools and scripts. For details, see [https://groups.google.com/d/msg/android-ndk/qZjhOaynHXc/2ux2ZZdxy2MJ Recommended NDK Directory?].

Additional environmental variables which are set by <tt>setenv-android.sh</tt>  and used by <tt>Configure</tt> and <tt>config</tt> include:

* <tt>MACHINE</tt> – set to <tt>armv7</tt>
* <tt>RELEASE</tt> – set to <tt>2.6.37</tt>
* <tt>SYSTEM</tt> – set to <tt>android</tt>
* <tt>ARCH</tt> – set to <tt>arm</tt>
* <tt>CROSS_COMPILE</tt> – set to <tt>arm-linux-androideabi-</tt>
* <tt>ANDROID_DEV</tt> – set to <tt>$ANDROID_NDK_ROOT/platforms/$_ANDROID_API/arch-arm/usr</tt>
* <tt>HOSTCC</tt> – set to <tt>gcc</tt>

=== Prepare the OpenSSL Sources ===

Remove stale versions of the OpenSSL Library, and then unpack fresh files. Also ensure the script is executable.

<pre>$ rm -rf openssl-1.0.1g/
$ tar xzf openssl-1.0.1g.tar.gz
$ chmod a+x setenv-android.sh</pre>

=== Build the OpenSSL Library ===

This section of the document will guide you through the creation of the the OpenSSL Library. The OpenSSL Library (and Makefile.org) needs its install rule modified. The install rule includes the all target, which causes items to be built during install. A bug in the process when running as root results in an empty signature for the shared object (the signature is a string of zeros).

To build the OpenSSL Library, you must issue <tt>config</tt>, but other options are up to you. Some suggested options for configure include: shared, -no-ssl2, -no-ssl3, -no-comp, -no-hw, and -no-engine. <tt>shared</tt> will build and install both the shared object and static archive. You should specify --openssldir to ensure the build system installs the android version of the library in a distinct location (other than <tt>/usr/local/ss;</tt>).

Begin building the OpenSSL library by setting the cross-compilation environment. Note the leading '.' when running the <tt>setenv-android.sh</tt> script. If you have any errors from the script, then you should fix them before proceeding.

<pre>$ . ./setenv-android.sh
$ cd openssl-1.0.1g/</pre>

Next, fix the makefile and run configure.

<pre>$ perl -pi -e 's/install: all install_docs install_sw/install: install_docs install_sw/g' Makefile.org
$ ./config shared -no-ssl2 -no-ssl3 -no-comp -no-hw -no-engine --openssldir=/usr/local/ssl/android-14/</pre>

Then run make depend and make all:

<pre>$ make depend
$ make all</pre>

After make completes, verify libcrypto.a and libssl.a were built for the embedded architecture.

<pre>$ find . -name libcrypto.a
./libcrypto.a
$ readelf -h ./libcrypto.a | grep -i 'class\|machine' | head -2
  Class:                   ELF32
  Machine:                 ARM</pre>

=== Install the OpenSSL Library ===

Finally, install the library. The makefile's install rule uses both CC and RANLIB, so you will need to fully specify the command variables on the command line (during install, sudo drops the user's path). You must also use sudo's -E option; otherwise ANDROID_TOOLCHAIN will be empty and tools such as arm-linux-androideabi-gcc and  arm-linux-androideabi-ranlib will not be found.

<pre>$ sudo -E make install CC=$ANDROID_TOOLCHAIN/arm-linux-androideabi-gcc RANLIB=$ANDROID_TOOLCHAIN/arm-linux-androideabi-ranlib</pre>

== Testing the OpenSSL Library ==

Testing the installation consists of building a sample program, installing it with adb, and then running the program using a remote shell. Both the static and dynamic version of the OpenSSL library can be tested. Instructions for testing the OpenSSL library are given at [[FIPS Library and Android]]. The same basic steps apply.

== Using OpenSSL in an Application ==

In the real world, you probably aren't using C and therefore still need a dynamic library, but Android probably already has non-FIPS Library called libssl.so and libcrypto.so loaded into memory.  Due to issues with the Android loader, the LD_LIBRARY_PATH trick doesn't work for normal applications.  Because we can't change the build to output different names to avoid the namespace clash, the solution to getting the code into a differently-named shared library is to wrap up the static Library into a separate dynamic library.  To do this, write a short c wrapper library with references to functions in both the Library (so the linker doesn't discard them as unnecessary) and link the static Library as above.  You don't need to wrap all the functions, as the Library themselves become part of the interface. For these instructions, I'll assume your c file is called wrapper.c

<pre>$ export OPENSSL_ANDROID = /usr/local/ssl/android-14
$ $(CC) wrapper.c -fPIC -shared -I$(OPENSSL_ANDROID)/include -Wl,-Bstatic -lcrypto -lssl -L$(OPENSSL_ANDROID)/lib -o wrapper.so -Wl,-Bdynamic</pre>

The <tt>-Wl,-Bstatic</tt> tells the linker to use the static Library for the Library after it and the <tt>-Wl,-Bdynamic</tt> tells the linker to use dynamic Library for anything else it might need, like <tt>libc</tt>.

Using <tt>-Bstatic</tt> and <tt>-Bshared</tt> can cause link problems on occasion. For example, see [http://stackoverflow.com/questions/22667953/error-when-trying-to-compile-wrapper-for-openssl-library-libcrypto-a Android: error when trying to compile wrapper for openssl library libcrypto.a]. To avoid the problem with the linker, specify the full path to the static archive (for example, <tt>/usr/local/ssl/android-14/lib/libcrypto.a</tt>). If you suspect the wrong OpenSSL library is being linked, then use the fully qualified archive path.

You can then use wrapper.so as per normal.

== Miscellaneous ==

The NDK supplies headers for each major platform - for example, API 18, API 14, API 9, API 8, and API 5. If you are building for Android 4.2 (API 17), Android 4.1 (API 16) and Android 4.0 (API 14), then you would use the NDK's API 14 (android-14 platform).

Specify the full library name when calling Java's System.load. That is, call System.load(“libcrypto.so.1.0.0”). Also note that some Android routines expect the prefix of “lib” and suffix of “so”, so you might have to rename the library.

Some versions of the Android Java system loader will load the system's version of the OpenSSL library, even though you built and included a copy with your application. In this case, you might need to write a wrapper shared object and link to the static version of the OpenSSL library. See, for example, ''[https://groups.google.com/forum/#!topic/android-ndk/rAf5tt4UEug "Unable to find native library" error in Native Activity app]''.

If you compile with -fPIE and -pie, then you will core dump unless using Android 4.1 and above. Logcat shows the linker (/system/bin/linker) is the problem.
<pre>shell@android: $ ./fips_hmac.exe -v fips_hmac.exe
[2] + Stopped (signal)     ./fips_hmac.exe -v fips_hmac.exe
[1] - Segmentation fault   ./fips_hmac.exe -v fips_hmac.exe</pre>

When building the OpenSSL library for Android, take care to specify <tt>-mfloat-abi=softfp</tt>. If you specify <tt>-mfloat-abi=hard</tt> or <tt>-mhard-float</tt> (even if the hardware support a floating point unit), then the entropy estimate passed through the Java VM to <tt>RAND_add</tt> will always be 0.0f. See [https://groups.google.com/d/msg/android-ndk/NbUq9FDDZOo/TJJsAS6nM7wJ Hard-float and JNI] for details.

== Downloads ==

[[Media:setenv-android.sh|setenv-android.sh]] - script to set Android cross-compile environment.