Merge branch 'master' of https://github.com/sqlcipher/android-database-sqlcipher into patch-1

Author: Christopher J. Brody

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,14 @@
+blank_issues_enabled: false
+contact_links:
+  - name: 💬 Community support
+    url: https://discuss.zetetic.net/c/sqlcipher/5
+    about: Integration problem or question about SQLCipher for Android, feel free to ask here.
+  - name: 🔨 Build issue
+    url: https://discuss.zetetic.net/c/sqlcipher/5
+    about: Experience an issue building SQLCipher for Android? Start here.
+  - name: 📃 SQLCipher documentation
+    url: https://www.zetetic.net/sqlcipher/sqlcipher-api/
+    about: SQLCipher documentation can be found here.
+  - name: 📖 Contribution instructions
+    url: https://www.zetetic.net/contributions/
+    about: Want to contribute to SQLCipher for Android? Start here.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,21 @@
+---
+name: 🛠️ Bug report
+about: Create a report about a software defect
+title: ''
+labels: ''
+assignees: ''
+---
+
+### Expected Behavior
+
+### Actual Behavior
+
+### Steps to Reproduce
+
+SQLCipher version (can be identified by executing `PRAGMA cipher_version;`):
+
+SQLCipher for Android version:
+
+Are you able to reproduce this issue within the SQLCipher for Android [test suite](https://github.com/sqlcipher/sqlcipher-android-tests)?
+
+*Note:* If you are not posting a specific issue for the SQLCipher library, please post your question to the SQLCipher [discuss site](https://discuss.zetetic.net/c/sqlcipher). Thanks!

.github/ISSUE_TEMPLATE/issue.md

@@ -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

.gitmodules

@@ -3,28 +3,39 @@
 	publish-local-release publish-remote-snapshot public-remote-release check
 GRADLE = ./gradlew
 
-init:
-	git submodule update --init
-
 clean:
 	$(GRADLE) clean
 
 distclean:
-	$(GRADLE) distclean
+	$(GRADLE) distclean \
+	-PsqlcipherRoot="$(SQLCIPHER_ROOT)"
 
 build-openssl:
 	$(GRADLE) buildOpenSSL
 
 check:
 	$(GRADLE) check
 
-build-debug: check
+format:
+	$(GRADLE) editorconfigFormat
+
+build-debug:
 	$(GRADLE) android-database-sqlcipher:bundleDebugAar \
-	-PdebugBuild=true
+	-PdebugBuild=true \
+	-PsqlcipherRoot="$(SQLCIPHER_ROOT)" \
+	-PopensslRoot="$(OPENSSL_ROOT)" \
+	-PopensslAndroidNativeRoot="$(OPENSSL_ANDROID_LIB_ROOT)" \
+	-PsqlcipherCFlags="$(SQLCIPHER_CFLAGS)" \
+	-PsqlcipherAndroidClientVersion="$(SQLCIPHER_ANDROID_VERSION)"
 
-build-release: check
+build-release:
 	$(GRADLE) android-database-sqlcipher:bundleReleaseAar \
-	-PdebugBuild=false
+	-PdebugBuild=false \
+	-PsqlcipherRoot="$(SQLCIPHER_ROOT)" \
+	-PopensslRoot="$(OPENSSL_ROOT)" \
+	-PopensslAndroidNativeRoot="$(OPENSSL_ANDROID_LIB_ROOT)" \
+	-PsqlcipherCFlags="$(SQLCIPHER_CFLAGS)" \
+	-PsqlcipherAndroidClientVersion="$(SQLCIPHER_ANDROID_VERSION)"
 
 publish-local-snapshot:
 	@ $(collect-signing-info) \
@@ -71,7 +82,12 @@ publish-remote-release:
 	-PsigningKeyPassword="$$gpgPassword" \
 	-PnexusUsername="$$nexusUsername" \
 	-PnexusPassword="$$nexusPassword" \
-	uploadArchives
+	-PsqlcipherRoot="$(SQLCIPHER_ROOT)" \
+	-PopensslRoot="$(OPENSSL_ROOT)" \
+	-PopensslAndroidLibRoot="$(OPENSSL_ANDROID_LIB_ROOT)" \
+	-PsqlcipherCFlags="$(SQLCIPHER_CFLAGS)" \
+	-PsqlcipherAndroidClientVersion="$(SQLCIPHER_ANDROID_VERSION)" \
+	android-database-sqlcipher:publish
 
 collect-nexus-info := \
 	read -p "Enter Nexus username:" nexusUsername; \

Makefile

@@ -5,8 +5,8 @@ The latest AAR binary package information can be [here](https://www.zetetic.net/
 
 ### Compatibility
 
-SQLCipher for Android runs on Android 4.1–Android 10, for `armeabi-v7a`, `x86`, `x86_64`, and `arm64_v8a` architectures.
-    
+SQLCipher for Android runs on Android 4.1–Android 13, for `armeabi-v7a`, `x86`, `x86_64`, and `arm64_v8a` architectures.
+
 ### Contributions
 
 We welcome contributions, to contribute to SQLCipher for Android, a [contributor agreement](https://www.zetetic.net/contributions/) needs to be submitted. All submissions should be based on the `master` branch.
@@ -44,7 +44,7 @@ Error: file is encrypted or is not a database
 
 ### Application Integration
 
-You have a two main options for using SQLCipher for Android in your app: 
+You have a two main options for using SQLCipher for Android in your app:
 
 - Using it with Room or other consumers of the `androidx.sqlite` API
 
@@ -55,11 +55,11 @@ such as having the following line in your module's `build.gradle` `dependencies`
 closure:
 
 ```gradle
-implementation 'net.zetetic:android-database-sqlcipher:4.3.0'
+implementation "net.zetetic:android-database-sqlcipher:4.5.2"
 implementation "androidx.sqlite:sqlite:2.0.1"
 ```
 
-(replacing `4.3.0` with the version you want)
+(replacing `4.5.2` with the version you want)
 
 <a title="Latest version from Maven Central" href="https://maven-badges.herokuapp.com/maven-central/net.zetetic/android-database-sqlcipher"><img src="https://maven-badges.herokuapp.com/maven-central/net.zetetic/android-database-sqlcipher/badge.svg"></a>
 
@@ -126,20 +126,31 @@ The rest of your code may not need any changes.
 
 An article covering both integration of SQLCipher into an Android application as well as building the source can be found [here](https://www.zetetic.net/sqlcipher/sqlcipher-for-android/).
 
-### Building
+### ProGuard
 
-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:
+For applications which utilize ProGuard, a few additional rules must be included when using SQLCipher for Android. These rules instruct ProGuard to omit the renaming of the internal SQLCipher classes which are used via lookup from the JNI layer. It is worth noting that since SQLCipher or Android is based on open source code there is little value in obfuscating the library anyway. The more important use of ProGuard is to protect your application code and business logic.
 
 ```
-# this only needs to be done once
-make init
+-keep,includedescriptorclasses class net.sqlcipher.** { *; }
+-keep,includedescriptorclasses interface net.sqlcipher.** { *; }
+```
+
+### Building
 
-# to build the source for debug:
-make build-debug
-# or for a release build:
+In order to build `android-database-sqlcipher` from source you will need both the Android SDK, Gradle, Android NDK, SQLCipher core source directory, and an OpenSSL source directory. We currently recommend using Android NDK LTS version `23.0.7599858`.
+
+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:
+
+```
+SQLCIPHER_ROOT=/some/path/to/sqlcipher-folder \
+OPENSSL_ROOT=/some/path/to/openssl-folder \
+SQLCIPHER_CFLAGS="-DSQLITE_HAS_CODEC -DSQLITE_TEMP_STORE=2" \
+SQLCIPHER_ANDROID_VERSION="4.5.2" \
 make build-release
 ```
 
+You may specify other build flags/features within `SQLCIPHER_CFLAGS`, however, specifying `-DSQLITE_HAS_CODEC` and `-DSQLITE_TEMP_STORE` is necessary in the list of flags.
+
 ### License
 
 The Android support libraries are licensed under Apache 2.0, in line with the Android OS code on which they are based. The SQLCipher code itself is licensed under a BSD-style license from Zetetic LLC. Finally, the original SQLite code itself is in the public domain.

README.md

@@ -2,7 +2,7 @@ http://sqlcipher.net
 
  Copyright (c) 2010 Zetetic LLC
             All rights reserved.
-            
+
             Redistribution and use in source and binary forms, with or without
             modification, are permitted provided that the following conditions are met:
                 * Redistributions of source code must retain the above copyright
@@ -13,7 +13,7 @@ http://sqlcipher.net
                 * Neither the name of the ZETETIC LLC nor the
                   names of its contributors may be used to endorse or promote products
                   derived from this software without specific prior written permission.
-            
+
             THIS SOFTWARE IS PROVIDED BY ZETETIC LLC ''AS IS'' AND ANY
             EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
             WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

SQLCIPHER_LICENSE

@@ -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 \
@@ -55,7 +51,7 @@ OPENSSL=openssl-$3
  no-srtp"
 
  rm -rf ${ANDROID_LIB_ROOT}
- 
+
  for SQLCIPHER_TARGET_PLATFORM in armeabi-v7a x86 x86_64 arm64-v8a
  do
      echo "Building libcrypto.a for ${SQLCIPHER_TARGET_PLATFORM}"
@@ -99,7 +95,7 @@ OPENSSL=openssl-$3
      make clean
      PATH=${TOOLCHAIN_BIN_PATH}:${PATH} \
          make build_libs
-     
+
      if [[ $? -ne 0 ]]; then
          echo "Error executing make for platform:${SQLCIPHER_TARGET_PLATFORM}"
          exit 1

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

@@ -24,10 +24,12 @@ android {
     buildTypes {
         debug {
             debuggable true
+            buildConfigField("String", "VERSION_NAME", "\"${clientVersionNumber}\"")
         }
         release {
             debuggable false
             minifyEnabled false
+            buildConfigField("String", "VERSION_NAME", "\"${clientVersionNumber}\"")
         }
     }
 
@@ -51,5 +53,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)
 }

android-database-sqlcipher/build.gradle

@@ -1,4 +1,4 @@
-apply plugin: "maven"
+apply plugin: "maven-publish"
 apply plugin: "signing"
 import org.gradle.plugins.signing.Sign
 
@@ -36,57 +36,56 @@ gradle.taskGraph.whenReady { taskGraph ->
   }
 }
 
-afterEvaluate { project ->
-  uploadArchives {
-    repositories {
-      mavenDeployer {
-        beforeDeployment { MavenDeployment deployment -> signing.signPom(deployment) }
-
-        pom.groupId = mavenGroup
-        pom.artifactId = mavenArtifactId
-        pom.version = mavenVersionName
 
-        repository(url: getReleaseRepositoryUrl()) {
-          authentication(userName: getRepositoryUsername(), password: getRepositoryPassword())
-        }
-        snapshotRepository(url: getSnapshotRepositoryUrl()) {
-          authentication(userName: getRepositoryUsername(), password: getRepositoryPassword())
-        }
-
-        pom.project {
-          name mavenArtifactId
-          packaging mavenPackaging
-          description mavenPomDescription
-          url mavenPomUrl
-
-          scm {
-            url mavenScmUrl
-            connection mavenScmConnection
-            developerConnection mavenScmDeveloperConnection
-          }
 
+afterEvaluate { project ->
+  publishing {
+    publications {
+      mavenJava(MavenPublication) {
+        from components.release
+        groupId = mavenGroup
+        artifactId = mavenArtifactId
+        version = mavenVersionName
+        pom {
+          name = mavenArtifactId
+          description = mavenPomDescription
+          url = mavenPomUrl
           licenses {
             license {
-              url mavenLicenseUrl
+              url = mavenLicenseUrl
             }
           }
-
           developers {
             developer {
-              name mavenDeveloperName
-              email mavenDeveloperEmail
-              organization mavenDeveloperOrganization
-              organizationUrl mavenDeveloperUrl
+              name = mavenDeveloperName
+              email = mavenDeveloperEmail
             }
           }
+          scm {
+            connection = mavenScmConnection
+            developerConnection = mavenScmDeveloperConnection
+            url = mavenScmUrl
+          }
         }
       }
     }
+    repositories {
+        maven {
+            def repoUrl = isReleaseBuild()
+                ? getReleaseRepositoryUrl()
+                : getSnapshotRepositoryUrl()
+            url = repoUrl
+            credentials {
+                    username = getRepositoryUsername()
+                    password = getRepositoryPassword()
+            }
+        }
+      }
   }
 
   signing {
-    required { isReleaseBuild() && gradle.taskGraph.hasTask("uploadArchives") }
-    sign configurations.archives
+    required { isReleaseBuild() && gradle.taskGraph.hasTask("publish") }
+    sign publishing.publications.mavenJava
   }
 
   task androidSourcesJar(type: Jar) {