Update build to use Android NDK r20 toolchain and OpenSSL 1.1.1d

NOTE: The armeabi ABI is no longer supported (due to toolchain update), and
the minimum supported Android API is now 16 (previously 14).

Author: developernotes

.gitignore

@@ -8,6 +8,7 @@ android-database-sqlcipher/.externalNativeBuild/
 android-database-sqlcipher/src/main/libs*
 android-database-sqlcipher/src/main/obj
 android-database-sqlcipher/src/main/external/openssl-*/
+android-database-sqlcipher/src/main/cpp/sqlite3.[c,h]
 .idea/
 *.iml
 local.properties

README.md

@@ -5,7 +5,7 @@ The latest AAR binary package information can be [here](https://www.zetetic.net/
 
 ### Compatibility
 
-SQLCipher for Android runs on Android 4–Android 9, for `armeabi`, `armeabi-v7a`, `x86`, `x86_64`, and `arm64_v8a` architectures.
+SQLCipher for Android runs on Android 4.1–Android 10, for `armeabi-v7a`, `x86`, `x86_64`, and `arm64_v8a` architectures.
 
 ### Contributions
 
@@ -76,6 +76,9 @@ There are two `SupportFactory` constructors:
 for executing SQL statements before or after the passphrase is used to decrypt
 the database
 
+- One constructor option includes a boolean parameter to opt out of the clearing
+the passphrase used to access the SQLCipher database.
+
 Then, pass your `SupportFactory` to `openHelperFactory()` on your `RoomDatabase.Builder`:
 
 ```java
@@ -114,7 +117,7 @@ An article covering both integration of SQLCipher into an Android application as
 
 ### Building
 
-In order to build `android-database-sqlcipher` from source you will need both the Android SDK, Gradle, and the Android NDK. We currently recommend using Android NDK version `r15c`, however we plan to update to a newer NDK release when possible. To complete the `make` command, the `ANDROID_NDK_ROOT` environment variable must be defined which should point to your NDK root. Once you have cloned the repo, change directory into the root of the repository and run the following commands:
+In order to build `android-database-sqlcipher` from source you will need both the Android SDK, Gradle, and the Android NDK. We currently recommend using Android NDK version `r20`. To complete the `make` command, the `ANDROID_NDK_HOME` environment variable must be defined which should point to your NDK root. Once you have cloned the repo, change directory into the root of the repository and run the following commands:
 
 ```
 # this only needs to be done once

android-database-sqlcipher/build-openssl-libraries.sh

@@ -20,22 +20,11 @@ OPENSSL=openssl-$3
      exit 1
  fi
 
- if [[ ! ${ANDROID_NDK_ROOT} ]]; then
-     echo "ANDROID_NDK_ROOT environment variable not set, set and rerun"
+ if [[ ! ${ANDROID_NDK_HOME} ]]; then
+     echo "ANDROID_NDK_HOME environment variable not set, set and rerun"
      exit 1
  fi
 
- NDK_TOOLCHAIN_VERSION=4.9
- ANDROID_LIB_ROOT=../android-libs
- ANDROID_TOOLCHAIN_DIR=/tmp/sqlcipher-android-toolchain
- OPENSSL_CONFIGURE_OPTIONS="-fPIC no-idea no-camellia \
- no-seed no-bf no-cast no-rc2 no-rc4 no-rc5 no-md2 \
- no-md4 no-ecdh no-sock no-ssl3 \
- no-dsa no-dh no-ec no-ecdsa no-tls1 \
- no-rfc3779 no-whirlpool no-srp \
- no-mdc2 no-ecdh no-engine \
- no-srtp"
-
  HOST_INFO=`uname -a`
  case ${HOST_INFO} in
      Darwin*)
@@ -55,97 +44,67 @@ OPENSSL=openssl-$3
          ;;
  esac
 
+ NDK_TOOLCHAIN_VERSION=4.9
+ ANDROID_LIB_ROOT=../android-libs
+ OPENSSL_CONFIGURE_OPTIONS="-fPIC -fstack-protector-all no-idea no-camellia \
+ no-seed no-bf no-cast no-rc2 no-rc4 no-rc5 no-md2 \
+ no-md4 no-ecdh no-sock no-ssl3 \
+ no-dsa no-dh no-ec no-ecdsa no-tls1 \
+ no-rfc3779 no-whirlpool no-srp \
+ no-mdc2 no-ecdh no-engine \
+ no-srtp"
+
  rm -rf ${ANDROID_LIB_ROOT}
 
- for SQLCIPHER_TARGET_PLATFORM in armeabi armeabi-v7a x86 x86_64 arm64-v8a
+ for SQLCIPHER_TARGET_PLATFORM in armeabi-v7a x86 x86_64 arm64-v8a
  do
      echo "Building libcrypto.a for ${SQLCIPHER_TARGET_PLATFORM}"
      case "${SQLCIPHER_TARGET_PLATFORM}" in
-         armeabi)
-             TOOLCHAIN_ARCH=arm
-             TOOLCHAIN_PREFIX=arm-linux-androideabi
-             TOOLCHAIN_FOLDER=arm-linux-androideabi
-             CONFIGURE_ARCH=android-arm
-             ANDROID_API_VERSION=${MINIMUM_ANDROID_SDK_VERSION}
-             OFFSET_BITS=32
-             TOOLCHAIN_DIR=${ANDROID_TOOLCHAIN_DIR}-armeabi
-             ;;
          armeabi-v7a)
-             TOOLCHAIN_ARCH=arm
-             TOOLCHAIN_PREFIX=arm-linux-androideabi
-             TOOLCHAIN_FOLDER=arm-linux-androideabi
              CONFIGURE_ARCH="android-arm -march=armv7-a"
              ANDROID_API_VERSION=${MINIMUM_ANDROID_SDK_VERSION}
              OFFSET_BITS=32
-             TOOLCHAIN_DIR=${ANDROID_TOOLCHAIN_DIR}-armeabi-v7a
              ;;
          x86)
-             TOOLCHAIN_ARCH=x86
-             TOOLCHAIN_PREFIX=i686-linux-android
-             TOOLCHAIN_FOLDER=x86
              CONFIGURE_ARCH=android-x86
              ANDROID_API_VERSION=${MINIMUM_ANDROID_SDK_VERSION}
              OFFSET_BITS=32
-             TOOLCHAIN_DIR=${ANDROID_TOOLCHAIN_DIR}-x86
              ;;
          x86_64)
-             TOOLCHAIN_ARCH=x86_64
-             TOOLCHAIN_PREFIX=x86_64-linux-android
-             TOOLCHAIN_FOLDER=x86_64
              CONFIGURE_ARCH=android64-x86_64
              ANDROID_API_VERSION=${MINIMUM_ANDROID_64_BIT_SDK_VERSION}
              OFFSET_BITS=64
-             TOOLCHAIN_DIR=${ANDROID_TOOLCHAIN_DIR}-x86_64
              ;;
          arm64-v8a)
-             TOOLCHAIN_ARCH=arm64
-             TOOLCHAIN_PREFIX=aarch64-linux-android
-             TOOLCHAIN_FOLDER=aarch64-linux-android
              CONFIGURE_ARCH=android-arm64
              ANDROID_API_VERSION=${MINIMUM_ANDROID_64_BIT_SDK_VERSION}
              OFFSET_BITS=64
-             TOOLCHAIN_DIR=${ANDROID_TOOLCHAIN_DIR}-arm64-v8a
              ;;
          *)
              echo "Unsupported build platform:${SQLCIPHER_TARGET_PLATFORM}"
              exit 1
      esac
-     SOURCE_TOOLCHAIN_DIR=${ANDROID_NDK_ROOT}/toolchains/${TOOLCHAIN_FOLDER}-${NDK_TOOLCHAIN_VERSION}/prebuilt/${TOOLCHAIN_SYSTEM}
-     rm -rf ${TOOLCHAIN_DIR}
-     mkdir -p "${ANDROID_LIB_ROOT}/${SQLCIPHER_TARGET_PLATFORM}"
-     python ${ANDROID_NDK_ROOT}/build/tools/make_standalone_toolchain.py \
-            --arch ${TOOLCHAIN_ARCH} \
-            --api ${ANDROID_API_VERSION} \
-            --install-dir ${TOOLCHAIN_DIR} \
-            --unified-headers
-
-     if [[ $? -ne 0 ]]; then
-         echo "Error executing make_standalone_toolchain.py for ${TOOLCHAIN_ARCH}"
-         exit 1
-     fi
-
-     export PATH=${TOOLCHAIN_DIR}/bin:${PATH}
-
-     ANDROID_NDK=${ANDROID_NDK_ROOT} \
-                PATH=${SOURCE_TOOLCHAIN_DIR}/bin:${PATH} \
-                ./Configure ${CONFIGURE_ARCH} \
-                -D__ANDROID_API__=${ANDROID_API_VERSION} \
-                -D_FILE_OFFSET_BITS=${OFFSET_BITS} \
-                ${OPENSSL_CONFIGURE_OPTIONS} \
-                --sysroot=${TOOLCHAIN_DIR}/sysroot
+     TOOLCHAIN_BIN_PATH=${ANDROID_NDK_HOME}/toolchains/llvm/prebuilt/${TOOLCHAIN_SYSTEM}/bin
+     PATH=${TOOLCHAIN_BIN_PATH}:${PATH} \
+     ./Configure ${CONFIGURE_ARCH} \
+                 -D__ANDROID_API__=${ANDROID_API_VERSION} \
+                 -D_FILE_OFFSET_BITS=${OFFSET_BITS} \
+                 ${OPENSSL_CONFIGURE_OPTIONS}
 
      if [[ $? -ne 0 ]]; then
          echo "Error executing:./Configure ${CONFIGURE_ARCH} ${OPENSSL_CONFIGURE_OPTIONS}"
          exit 1
      fi
 
      make clean
-     make build_libs
+     PATH=${TOOLCHAIN_BIN_PATH}:${PATH} \
+         make build_libs
 
      if [[ $? -ne 0 ]]; then
          echo "Error executing make for platform:${SQLCIPHER_TARGET_PLATFORM}"
          exit 1
      fi
+     mkdir -p ${ANDROID_LIB_ROOT}/${SQLCIPHER_TARGET_PLATFORM}
      mv libcrypto.a ${ANDROID_LIB_ROOT}/${SQLCIPHER_TARGET_PLATFORM}
  done
 )

android-database-sqlcipher/build.gradle

@@ -41,6 +41,12 @@ android {
         implementation "androidx.sqlite:sqlite:2.0.1"
     }
 
+    editorconfig {
+        excludes = ['src/main/cpp/sqlite3.*',
+                    'src/main/external/sqlcipher/**',
+                    'src/main/external/openssl-*/**']
+    }
+
     clean.dependsOn cleanNative
     check.dependsOn editorconfigCheck
     buildNative.mustRunAfter buildAmalgamation

android-database-sqlcipher/native.gradle

@@ -3,10 +3,10 @@ import static org.gradle.internal.logging.text.StyledTextOutput.Style
 
 task buildOpenSSL() {
   onlyIf {
-    def armNativeFile = new File("${androidNativeRootDir}/armeabi/libcrypto.a")
+    def armNativeFile = new File("${androidNativeRootDir}/armeabi-v7a/libcrypto.a")
     if (armNativeFile.exists()) {
       def out = services.get(StyledTextOutputFactory).create("")
-      out.style(Style.Normal).text("${androidNativeRootDir}/armeabi/libcrypto.a exists").style(Style.Info).println(' SKIPPED')
+      out.style(Style.Normal).text("${androidNativeRootDir}/armeabi-v7a/libcrypto.a exists").style(Style.Info).println(' SKIPPED')
     }
     return !armNativeFile.exists()
   }
@@ -23,7 +23,7 @@ task buildOpenSSL() {
 
 task buildAmalgamation() {
   onlyIf {
-    def amalgamation = new File("${projectDir}/src/main/external/sqlcipher/sqlite3.c")
+    def amalgamation = new File("${projectDir}/src/main/cpp/sqlite3.c")
     return !amalgamation.exists()
   }
   doLast {
@@ -37,6 +37,10 @@ task buildAmalgamation() {
       environment("CFLAGS", "${sqlcipherCFlags}")
       commandLine "make", "sqlite3.c"
     }
+    exec {
+      workingDir "${projectDir}/src/main/external/sqlcipher"
+      commandLine "cp", "sqlite3.c", "sqlite3.h", "${nativeRootOutputDir}/cpp/"
+    }
   }
 }
 
@@ -86,8 +90,12 @@ task cleanSQLCipher() {
     gitClean("${sqlcipherDir}")
     File amalgamationSource = new File("${sqlcipherDir}/sqlite3.c")
     File amalgamationHeader = new File("${sqlcipherDir}/sqlite3.h")
+    File amalgamationDestinationSource = new File("${nativeRootOutputDir}/cpp/sqlite3.c")
+    File amalgamationDestinationHeader = new File("${nativeRootOutputDir}/cpp/sqlite3.h")
     if (amalgamationSource.exists()) amalgamationSource.delete()
     if (amalgamationHeader.exists()) amalgamationHeader.delete()
+    if (amalgamationDestinationSource.exists()) amalgamationDestinationSource.delete()
+    if (amalgamationDestinationHeader.exists()) amalgamationDestinationHeader.delete()
   }
 }
 
@@ -145,7 +153,7 @@ def executeNdkBuild(outputDir, androidMkDirectory, applicationMkFile,
                                 "ANDROID_NATIVE_ROOT_DIR": "${androidNativeRootDir}",
                                 "NDK_APP_PLATFORM"       : "${androidVersion}"]
     environment(environmentVariables)
-    commandLine "ndk-build", "${ndkBuildType}",
+      commandLine "ndk-build", "V=1", "${ndkBuildType}",
       "--environment-overrides", outputDirectory,
       "-C", androidMkDirectory, applicationFile
   }

android-database-sqlcipher/src/main/cpp/Android.mk

@@ -3,14 +3,13 @@ MY_PATH := $(LOCAL_PATH)
 include $(CLEAR_VARS)
 LOCAL_PATH := $(MY_PATH)
 
-SQLCIPHER_SRC := $(SQLCIPHER_DIR)/sqlite3.c
 LOCAL_CFLAGS +=  $(SQLCIPHER_CFLAGS) $(SQLCIPHER_OTHER_CFLAGS)
-LOCAL_C_INCLUDES := $(SQLCIPHER_DIR) $(LOCAL_PATH)
-LOCAL_LDLIBS := -llog -latomic
+LOCAL_C_INCLUDES += $(LOCAL_PATH)
+LOCAL_LDLIBS := -llog
 LOCAL_LDFLAGS += -L$(ANDROID_NATIVE_ROOT_DIR)/$(TARGET_ARCH_ABI) -fuse-ld=bfd
 LOCAL_STATIC_LIBRARIES += static-libcrypto
 LOCAL_MODULE    := libsqlcipher
-LOCAL_SRC_FILES := $(SQLCIPHER_SRC) \
+LOCAL_SRC_FILES := sqlite3.c \
 	jni_exception.cpp \
 	net_sqlcipher_database_SQLiteCompiledSql.cpp \
 	net_sqlcipher_database_SQLiteDatabase.cpp \

android-database-sqlcipher/src/main/cpp/Application32.mk

@@ -1,7 +1,7 @@
 APP_PROJECT_PATH := $(shell pwd)
-APP_ABI := armeabi armeabi-v7a x86
+APP_ABI := armeabi-v7a x86
 APP_PLATFORM := android-$(NDK_APP_PLATFORM)
 APP_BUILD_SCRIPT := $(APP_PROJECT_PATH)/Android.mk
-APP_STL := stlport_static
+APP_STL := c++_static
 APP_CFLAGS := -D_FILE_OFFSET_BITS=32
 APP_LDFLAGS += -Wl,--exclude-libs,ALL

android-database-sqlcipher/src/main/cpp/Application64.mk

@@ -2,6 +2,6 @@ APP_PROJECT_PATH := $(shell pwd)
 APP_ABI := x86_64 arm64-v8a
 APP_PLATFORM := android-$(NDK_APP_PLATFORM)
 APP_BUILD_SCRIPT := $(APP_PROJECT_PATH)/Android.mk
-APP_STL := stlport_static
+APP_STL := c++_static
 APP_CFLAGS := -D_FILE_OFFSET_BITS=64
 APP_LDFLAGS += -Wl,--exclude-libs,ALL

android-database-sqlcipher/src/main/cpp/CursorWindow.h

@@ -55,7 +55,7 @@
 #define WINDOW_STORAGE_INLINE_NUMERICS 1
 
 using std::make_pair;
-using std::tr1::unordered_map;
+using std::unordered_map;
 
 namespace sqlcipher {
 

android-database-sqlcipher/src/main/cpp/jni_exception.cpp

@@ -1,4 +1,3 @@
-#include <cstddef>
 #include "jni_exception.h"
 
 void jniThrowException(JNIEnv* env, const char* exceptionClass, const char* sqlite3Message) {