OpenSSL实践-Android下的编译和使用

1. 概述

openssl可以编译成ARM下面的二进制代码（动态库或者静态库），方便APP使用，APP在使用的时候，需要使用JNI来进行调用。

官方WIKI有写如何为android编译openssl，地址是：https://wiki.openssl.org/index.php/Android

因此也是参考这篇文章实现的。

编译不太复杂，基本步骤如下：

1. 下载NDK
2. 下载openssl源码和设置环境变量所需要的setenv-android.sh
3. 配置编译参数
4. 编译

2. 准备工作

2.1 环境准备

官方给的方法，是linux下的，因此这里建议使用下面三种方式来实现编译：

• ubuntu物理机或者虚拟机
• windows上使用docker，然后使用ubuntu/debian一类的image来编译(建议使用Android SDK/NDK一类的image，省去环境部署的麻烦)
• windows 10上面使用WSL

上述三种其实配置和编译过程都是一致的，只是后两者方便使用windows为主的用户。因此我这里给出的WSL上的配置和编译过程（实际上和前两种没什么区别）。

2.2 安装linux版本的NDK

编译Openssl需要使用NDK，先下载NDK：

# 在D盘下建立NDK目录 mkdir /mnt/d/ndk cd /mnt/d/ndk wget https://dl.google.com/android/repository/android-ndk-r14b-linux-x86_64.zip

下载还是挺快的，不需要翻墙，网速慢的朋友可以使用迅雷来进行下载。

# 解压 unzip android-ndk-r14b-linux-x86_64.zip # 如果提示unzip为无效命令，可以使用apt-get进行安装 sudo apt-get install unzip

注意：请勿在windows下直接解压，因为内部会有同名文件（只是大小写不同），引发文件覆盖

最后：NDK被解压在： D盘的NDK目录下，也就是：/mnt/d/ndk/android-ndk-r14b

2.3 准备openssl源码

# 下载源码 cd /mnt/d wget https://www.openssl.org/source/openssl-1.1.0f.tar.gz # 解压源码 tar -zxvf openssl-1.1.0f.tar.gz #拉取setenv-android.sh，我们需要这个脚本来给我们配置环境 cd /mnt/d/openssl-1.1.0f wget https://wiki.openssl.org/images/7/70/Setenv-android.sh # 注意这个文件是大写开头的，我们稍微修改一下名称，方便使用 mv Setenv-android.sh setenv-android.sh

最后，openssl的源码所在位置是：/mnt/d/openssl-1.1.0f

3. 配置环境

用编辑器编辑（可以使用windows下的编辑器，我这里使用 notepad++） setenv-android.sh， 修改以下参数：

_ANDROID_NDK="android-ndk-r9" # 修改为： _ANDROID_NDK="android-ndk-r14b" # 因为我们使用的是R14B这个版本的NDK

_ANDROID_EABI="arm-linux-androideabi-4.8" 修改为GCC 4.9 _ANDROID_EABI="arm-linux-androideabi-4.9"

注意，这个脚本在WSL上执行可能存在一些问题，我下载下来的是 换行的，在WSL上执行会报错，我们可以使用notepad++来替换掉 ，具体做法如下图所示：

替换掉

4. 开始编译

设置环境变量
我们需要通过环境变量来指定NDK所在的位置，按照之前的安装位置，我们只需要执行：
export ANDROID_NDK_ROOT=/mnt/d/ndk/android-ndk-r14b
source ./setenv-android.sh
# 输出
ANDROID_NDK_ROOT: /mnt/d/ndk/android-ndk-r14b
ANDROID_ARCH: arch-arm
ANDROID_EABI: arm-linux-androideabi-4.9
ANDROID_API: android-18
ANDROID_SYSROOT: /mnt/d/ndk/android-ndk-r14b/platforms/android-18/arch-arm
ANDROID_TOOLCHAIN: /mnt/d/ndk/android-ndk-r14b/toolchains/arm-linux-androideabi-4.9/prebuilt/linux-x86_64/bin
FIPS_SIG: /mnt/d/openssl-1.1.0f/util/incore
CROSS_COMPILE: arm-linux-androideabi-
ANDROID_DEV: /mnt/d/ndk/android-ndk-r14b/platforms/android-18/arch-arm/usr

注意，这一步之后，请勿关闭cmd/终端窗口，因为编译器等参数是通过环境变量传递给make的
创建输出目录
mkdir /mnt/d/openssl-output

配置和编译
# 配置openssl
./config no-shared no-ssl2 no-ssl3 no-comp no-hw no-engine 
     --openssldir=/mnt/d/openssl-output/$ANDROID_API --prefix=/mnt/d/openssl-output/$ANDROID_API

#编译
make depend
make all -j8 
# -j8 表示并发的编译"线程数"，建议设置成CPU线程数一致

这里需要注意的是，no-shared表示不编译动态库，这样编译出来的openssl命令，不依赖动态库，同时也没有so产生。更多的编译参数，详见源码目录下的：INSTALL（该文件没有后缀）
安装
make install

执行完上面的命令，openssl的头文件、库文件、文档以及命令就被复制在： /mnt/d/openssl-output 目录里了。
目录主要结构是：
bin 存放openssl命令
include 头文件
lib 库文件
share 文档一类的

5. 测试APP

新建一个测试APP，并勾选 include C++ support
把include下的openssl目录，整个复制到项目src下的cpp子目录
把lib下的libcrypto.a和libssl.a复制到src->cpp->libs子目录
最终目录结构如下：
├─androidTest
│  └─java
│      └─com
│          └─example
│              └─summer
│                  └─myapplication
├─main
│  ├─cpp
│  │  ├─libs
│  │  └─openssl
│  ├─java
│  │  └─com
│  │      └─example
│  │          └─summer

修改CMakeLists.txt，在 cmake_minimum_required(VERSION 3.4.1) 后面加：
# 表示把src/main/cpp加入include目录，这样在代码中，使用：#include <...>就能访问到头文件
include_directories(src/main/cpp)

# 添加两个预编译库
add_library(openssl-crypto
    STATIC
    IMPORTED)

set_target_properties(openssl-crypto
                      PROPERTIES IMPORTED_LOCATION
                      ${CMAKE_SOURCE_DIR}/src/main/cpp/libs/libcrypto.a )

add_library(openssl-ssl
  STATIC
  IMPORTED)

set_target_properties(openssl-ssl
                    PROPERTIES IMPORTED_LOCATION
                    ${CMAKE_SOURCE_DIR}/src/main/cpp/libs/libssl.a )

把最后的：
target_link_libraries( # Specifies the target library.
                       native-lib

                       # Links the target library to the log library
                       # included in the NDK.
                       ${log-lib})

修改成：
target_link_libraries( # Specifies the target library.
                       native-lib

                       # Links the target library to the log library
                       # included in the NDK.
                       ${log-lib} openssl-ssl openssl-crypto)

修改app目录下的：build.gradle
android {
    compileSdkVersion 25
    buildToolsVersion "26.0.0"
    defaultConfig {
        applicationId "com.example.summer.myapplication"
        minSdkVersion 15
        targetSdkVersion 25
        versionCode 1
        versionName "1.0"
        testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
        externalNativeBuild {
            cmake {
                cppFlags "-std=c++11 -frtti -fexceptions"
                // 下面这样是增加的
                arguments "-DANDROID_ABI=armeabi-v7a"
            }
        }
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
    externalNativeBuild {
        cmake {
            path "CMakeLists.txt"
        }
    }
}

实际上增加的只是一行代码： ** arguments "-DANDROID_ABI=armeabi-v7a"。默认情况下，gradle会通过多次调用，通过传递ABI类型来让cmake产生各个ABI下nija构建脚本，从而编译出各个ABI下的二进制文件。因为openssl默认编译出来的只有armeabi-v7a的，因此我们留下这个ABI**就行了。
修改native-lib.cpp
在第一行增加：
#include "openssl/crypto.h"

下面的代码替换一下：
    std::string hello = "Hello from C++";
    return env->NewStringUTF(hello.c_str());

替换为：
return env->NewStringUTF(OpenSSL_version(OPENSSL_VERSION));

启动APP
编译之后，如无意外，可以直接在手机上运行了，会到看主界面上输入openssl的版本信息：

openssl test app

6. 其他

• 编译器兼容性

细心的朋友可能发现了，我编译的时候使用的是GCC 4.9，而APP在链接的时候，默认使用了CLANG，在google的文档里，GCC已经是不推荐的工具链了（详见：https://developer.android.com/ndk/guides/cmake.html ） ， 至于两者的ABI兼容性，我也没发现一个比较权威的答案，可以看看这篇讨论： https://stackoverflow.com/questions/20875924/can-clang-compile-code-with-gcc-compiled-a-libs 鉴于C++的复杂性，建议C++不要这样做。 可以在build.gradle里面设置成GCC编译，这样工具链就一致了。

• android的abi

目前默认构建出来的是armea-v7a的，基本上大部分CPU都是这个类型了。而目前这个脚本不能直接构建出64位的arm64-v8a，有需要的朋友，可以参考：http://doc.qt.io/qt-5/opensslsupport.html。 至于X86，可以通过修改：setenv-android.sh里面的：** _ANDROID_ARCH=arch-x86** 来实现。至于MIPS目前不能直接编译。