Externalize SQLCipher/OpenSSL sourcing for build

Author: developernotes

Diff for: .gitmodules

@@ -1,4 +0,0 @@
-[submodule "android-database-sqlcipher/src/main/external/sqlcipher"]
-	path = android-database-sqlcipher/src/main/external/sqlcipher
-	url = https://github.com/sqlcipher/sqlcipher.git
-	ignore = untracked

Diff for: Makefile

@@ -3,9 +3,6 @@
 	publish-local-release publish-remote-snapshot public-remote-release check
 GRADLE = ./gradlew
 
-init:
-	git submodule update --init
-
 clean:
 	$(GRADLE) clean
 
@@ -25,9 +22,14 @@ build-debug: check
 	$(GRADLE) android-database-sqlcipher:bundleDebugAar \
 	-PdebugBuild=true
 
-build-release: check
+build-release:
 	$(GRADLE) android-database-sqlcipher:bundleReleaseAar \
-	-PdebugBuild=false
+	-PdebugBuild=false \
+	-PsqlcipherRoot="$(SQLCIPHER_ROOT)" \
+	-PopensslRoot="$(OPENSSL_ROOT)" \
+	-PopensslAndroidLibRoot="$(OPENSSL_ANDROID_LIB_ROOT)" \
+	-PsqlcipherCFlags="$(SQLCIPHER_CFLAGS)" \
+	-PsqlcipherAndroidClientVersion="$(SQLCIPHER_ANDROID_VERSION)"
 
 publish-local-snapshot:
 	@ $(collect-signing-info) \
@@ -74,6 +76,11 @@ publish-remote-release:
 	-PsigningKeyPassword="$$gpgPassword" \
 	-PnexusUsername="$$nexusUsername" \
 	-PnexusPassword="$$nexusPassword" \
+	-PsqlcipherRoot="$(SQLCIPHER_ROOT)" \
+	-PopensslRoot="$(OPENSSL_ROOT)" \
+	-PopensslAndroidLibRoot="$(OPENSSL_ANDROID_LIB_ROOT)" \
+	-PsqlcipherCFlags="$(SQLCIPHER_CFLAGS)" \
+	-PsqlcipherAndroidClientVersion="$(SQLCIPHER_ANDROID_VERSION)"
 	uploadArchives
 
 collect-nexus-info := \

Diff for: README.md

@@ -140,12 +140,9 @@ For applications which utilize ProGuard, a few additional rules must be included
 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
-make init
-
-# to build the source for debug:
-make build-debug
-# or for a release build:
+SQLCIPHER_ROOT=/some/path/to/sqlcipher-folder \
+OPENSSL_ROOT=/some/path/to/openssl-folder \
+SQLCIPHER_ANDROID_VERSION="4.4.1" \
 make build-release
 ```
 

Diff for: android-database-sqlcipher/build-openssl-libraries.sh

@@ -2,13 +2,10 @@
 
 MINIMUM_ANDROID_SDK_VERSION=$1
 MINIMUM_ANDROID_64_BIT_SDK_VERSION=$2
-OPENSSL=openssl-$3
+OPENSSL_DIR=$3
+ANDROID_LIB_ROOT=$4
 
-(cd src/main/external/;
- gunzip -c ${OPENSSL}.tar.gz | tar xf -
-)
-
-(cd src/main/external/${OPENSSL};
+(cd ${OPENSSL_DIR};
 
  if [[ ! ${MINIMUM_ANDROID_SDK_VERSION} ]]; then
      echo "MINIMUM_ANDROID_SDK_VERSION was not provided, include and rerun"
@@ -45,7 +42,6 @@ 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 \

Diff for: android-database-sqlcipher/build.gradle

@@ -51,5 +51,6 @@ android {
     check.dependsOn editorconfigCheck
     buildNative.mustRunAfter buildAmalgamation
     buildAmalgamation.mustRunAfter buildOpenSSL
-    preBuild.dependsOn([buildOpenSSL, buildAmalgamation, buildNative])
+    preBuild.dependsOn([buildOpenSSL, buildAmalgamation, copyAmalgamation, buildNative])
+    buildNative.mustRunAfter(copyAmalgamation)
 }

Diff for: android-database-sqlcipher/native.gradle

@@ -16,34 +16,40 @@ task buildOpenSSL() {
       commandLine "./build-openssl-libraries.sh",
         "${minimumAndroidSdkVersion}",
         "${minimumAndroid64BitSdkVersion}",
-        "${opensslVersion}"
+        "${opensslDir}",
+        "${androidNativeRootDir}"
     }
   }
 }
 
 task buildAmalgamation() {
   onlyIf {
-    def amalgamation = new File("${projectDir}/src/main/cpp/sqlite3.c")
+    def amalgamation = new File("${sqlcipherDir}/sqlite3.c")
     return !amalgamation.exists()
   }
   doLast {
     exec {
-      workingDir "${projectDir}/src/main/external/sqlcipher"
+      workingDir "${sqlcipherDir}"
       environment("CFLAGS", "${sqlcipherCFlags}")
       commandLine "./configure", "--enable-tempstore=yes", "--with-crypto-lib=none"
     }
     exec {
-      workingDir "${projectDir}/src/main/external/sqlcipher"
+      workingDir "${sqlcipherDir}"
       environment("CFLAGS", "${sqlcipherCFlags}")
       commandLine "make", "sqlite3.c"
     }
-    exec {
-      workingDir "${projectDir}/src/main/external/sqlcipher"
-      commandLine "cp", "sqlite3.c", "sqlite3.h", "${nativeRootOutputDir}/cpp/"
-    }
   }
 }
 
+task copyAmalgamation() {
+    doLast {
+        exec {
+            workingDir "${sqlcipherDir}"
+            commandLine "cp", "sqlite3.c", "sqlite3.h", "${nativeRootOutputDir}/cpp/"
+        }
+    }
+}
+
 task buildNative() {
   description "Build the native SQLCipher binaries"
   doLast {
@@ -76,25 +82,27 @@ task cleanOpenSSL() {
   description "Clean the OpenSSL source"
   doLast {
     logger.info "Cleaning OpenSSL source"
-    File file = new File("${opensslDir}")
-    if (file.exists()) {
-      file.deleteDir()
+    exec {
+      workingDir "${opensslDir}"
+      ignoreExitValue true
+      commandLine "make", "clean"
     }
   }
 }
 
 task cleanSQLCipher() {
-  description "Clean the SQLCipher source"
-  gitClean("${sqlcipherDir}")
-  exec {
-    workingDir "${sqlcipherDir}"
-    ignoreExitValue true
-    commandLine "make", "clean"
-  }
-  File amalgamationDestinationSource = new File("${nativeRootOutputDir}/cpp/sqlite3.c")
-  File amalgamationDestinationHeader = new File("${nativeRootOutputDir}/cpp/sqlite3.h")
-  if (amalgamationDestinationSource.exists()) amalgamationDestinationSource.delete()
-  if (amalgamationDestinationHeader.exists()) amalgamationDestinationHeader.delete()
+    description "Clean the SQLCipher source"
+    doLast {
+        exec {
+            workingDir "${sqlcipherDir}"
+            ignoreExitValue true
+            commandLine "make", "clean"
+        }
+        File amalgamationDestinationSource = new File("${nativeRootOutputDir}/cpp/sqlite3.c")
+        File amalgamationDestinationHeader = new File("${nativeRootOutputDir}/cpp/sqlite3.h")
+        if (amalgamationDestinationSource.exists()) amalgamationDestinationSource.delete()
+        if (amalgamationDestinationHeader.exists()) amalgamationDestinationHeader.delete()
+    }
 }
 
 task cleanNative() {
@@ -110,8 +118,9 @@ task cleanNative() {
   }
 }
 
-task distclean(dependsOn: [clean, cleanSQLCipher, cleanOpenSSL]) {
+task distclean() {
   description "Clean build, SQLCipher, and OpenSSL artifacts"
+  dependsOn clean, cleanSQLCipher, cleanOpenSSL
   doLast {
     new File("${androidNativeRootDir}/").deleteDir()
   }
@@ -132,7 +141,6 @@ def gitClean(directory) {
 def executeNdkBuild(outputDir, androidMkDirectory, applicationMkFile,
                     cflags, otherSqlcipherCFlags, androidVersion) {
   logger.info "Executing NDK build command"
-
   def out = services.get(StyledTextOutputFactory).create("")
   out.style(Style.Normal).text("SQLCIPHER_CFLAGS=").style(Style.Info).println("${cflags}")
   out.style(Style.Normal).text("OPENSSL_DIR=").style(Style.Info).println("${opensslDir}")

Diff for: android-database-sqlcipher/src/main/external/openssl-1.1.1g.tar.gz

@@ -20,7 +20,11 @@ allprojects {
 }
 
 ext {
-  clientVersionNumber = "4.4.0"
+  if(project.hasProperty('sqlcipherAndroidClientVersion')) {
+    clientVersionNumber = "${sqlcipherAndroidClientVersion}"
+  } else {
+    clientVersionNumber = "UndefinedBuildNumber"
+  }
   mavenPackaging = "aar"
   mavenGroup = "net.zetetic"
   mavenArtifactId = "android-database-sqlcipher"
@@ -60,38 +64,50 @@ ext {
   compileAndroidSdkVersion = 26
   mainProjectName = "android-database-sqlcipher"
   nativeRootOutputDir = "${projectDir}/${mainProjectName}/src/main"
-  androidNativeRootDir = "${nativeRootOutputDir}/external/android-libs"
-  sqlcipherDir = "${projectDir}/${mainProjectName}/src/main/external/sqlcipher"
   opensslVersion = "1.1.1g"
-  opensslDir = "${projectDir}/${mainProjectName}/src/main/external/openssl-${opensslVersion}"
+  if(project.hasProperty('sqlcipherRoot')) {
+    sqlcipherDir = "${sqlcipherRoot}"
+  }
+  if(project.hasProperty('opensslAndroidLibRoot')) {
+    androidNativeRootDir = "${opensslAndroidLibRoot}"
+  } else {
+    androidNativeRootDir = "${nativeRootOutputDir}/external/android-libs"
+  }
+  if(project.hasProperty('opensslRoot')) {
+    opensslDir = "${opensslRoot}"
+  }
   if(project.hasProperty('debugBuild') && debugBuild.toBoolean()) {
     otherSqlcipherCFlags = "-fstack-protector-all"
     ndkBuildType="NDK_DEBUG=1"
   } else {
     otherSqlcipherCFlags = "-DLOG_NDEBUG -fstack-protector-all"
     ndkBuildType="NDK_DEBUG=0"
   }
-  sqlcipherCFlags = "-DSQLITE_HAS_CODEC " +
-    "-DSQLITE_SOUNDEX " +
-    "-DHAVE_USLEEP=1 " +
-    "-DSQLITE_MAX_VARIABLE_NUMBER=99999 " +
-    "-DSQLITE_TEMP_STORE=3 " +
-    "-DSQLITE_THREADSAFE=1 " +
-    "-DSQLITE_DEFAULT_JOURNAL_SIZE_LIMIT=1048576 " +
-    "-DNDEBUG=1 " +
-    "-DSQLITE_ENABLE_MEMORY_MANAGEMENT=1 " +
-    "-DSQLITE_ENABLE_LOAD_EXTENSION " +
-    "-DSQLITE_ENABLE_COLUMN_METADATA " +
-    "-DSQLITE_ENABLE_UNLOCK_NOTIFY " +
-    "-DSQLITE_ENABLE_RTREE " +
-    "-DSQLITE_ENABLE_STAT3 " +
-    "-DSQLITE_ENABLE_STAT4 " +
-    "-DSQLITE_ENABLE_JSON1 " +
-    "-DSQLITE_ENABLE_FTS3_PARENTHESIS " +
-    "-DSQLITE_ENABLE_FTS4 " +
-    "-DSQLITE_ENABLE_FTS5 " +
-    "-DSQLCIPHER_CRYPTO_OPENSSL " +
-    "-DSQLITE_ENABLE_DBSTAT_VTAB"
+  if(project.hasProperty('sqlcipherCFlags')) {
+         sqlcipherCFlags = "${sqlcipherCFlags}"
+  } else {
+         sqlcipherCFlags = "-DSQLITE_HAS_CODEC " +
+                "-DSQLITE_SOUNDEX " +
+                "-DHAVE_USLEEP=1 " +
+                "-DSQLITE_MAX_VARIABLE_NUMBER=99999 " +
+                "-DSQLITE_TEMP_STORE=3 " +
+                "-DSQLITE_THREADSAFE=1 " +
+                "-DSQLITE_DEFAULT_JOURNAL_SIZE_LIMIT=1048576 " +
+                "-DNDEBUG=1 " +
+                "-DSQLITE_ENABLE_MEMORY_MANAGEMENT=1 " +
+                "-DSQLITE_ENABLE_LOAD_EXTENSION " +
+                "-DSQLITE_ENABLE_COLUMN_METADATA " +
+                "-DSQLITE_ENABLE_UNLOCK_NOTIFY " +
+                "-DSQLITE_ENABLE_RTREE " +
+                "-DSQLITE_ENABLE_STAT3 " +
+                "-DSQLITE_ENABLE_STAT4 " +
+                "-DSQLITE_ENABLE_JSON1 " +
+                "-DSQLITE_ENABLE_FTS3_PARENTHESIS " +
+                "-DSQLITE_ENABLE_FTS4 " +
+                "-DSQLITE_ENABLE_FTS5 " +
+                "-DSQLCIPHER_CRYPTO_OPENSSL " +
+                "-DSQLITE_ENABLE_DBSTAT_VTAB"
+  }
 }
 
 task clean(type: Delete) {