Update to use SQLCipher for Android 4.4.1

developernotes · developernotes · commit aec6435098b3 · 2020-11-06T13:06:01.000-06:00
diff --git a/app/build.gradle b/app/build.gradle
@@ -22,13 +22,12 @@ dependencies {
   // For testing JAR-based distribution:
   // implementation files('libs/sqlcipher.jar')
 
-  // For testing local AAR package:
-  // implementation (name: 'android-database-sqlcipher-4.4.0-release', ext: 'aar')
+  // For testing local AAR packages:
+  //implementation (name: 'android-database-sqlcipher-4.4.1-release', ext: 'aar')
 
-  // For testing on remote AAR reference:
-  implementation 'net.zetetic:android-database-sqlcipher:4.4.0@aar'
+  // For testing on remote AAR references:
+  implementation 'net.zetetic:android-database-sqlcipher:4.4.1@aar'
 
-  // Mandatory dependency:
   implementation "androidx.sqlite:sqlite:2.0.1"
 
   // For Room tests:
diff --git a/app/src/main/java/net/zetetic/NativeInitializer.java b/app/src/main/java/net/zetetic/NativeInitializer.java
@@ -0,0 +1,16 @@
+package net.zetetic;
+import android.util.Log;
+
+import net.sqlcipher.database.SQLiteDatabase;
+
+public class NativeInitializer {
+
+  static {
+    Log.i("NativeInitializer", "Before loadLibs");
+    SQLiteDatabase.loadLibs(ZeteticApplication.getInstance());
+    Log.i("NativeInitializer", "After loadLibs");
+  }
+
+  public static void initialize(){}
+
+}
diff --git a/app/src/main/java/net/zetetic/ZeteticApplication.java b/app/src/main/java/net/zetetic/ZeteticApplication.java
@@ -28,6 +28,12 @@ public static ZeteticApplication getInstance() {
     return instance;
   }
 
+  @Override
+  public void onCreate() {
+    super.onCreate();
+    NativeInitializer.initialize();
+  }
+
   public void setCurrentActivity(Activity activity) {
     this.activity = activity;
   }
diff --git a/app/src/main/java/net/zetetic/ZeteticContentProvider.java b/app/src/main/java/net/zetetic/ZeteticContentProvider.java
@@ -28,11 +28,8 @@ public boolean onCreate() {
 
     @Override
     public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder) {
-
-        SQLiteDatabase.loadLibs(ZeteticApplication.getInstance());
         File databasePath = ZeteticApplication.getInstance().getDatabasePath(ZeteticApplication.DATABASE_NAME);
         database = ZeteticApplication.getInstance().createDatabase(databasePath, null);
-
         createDatabaseWithData(database);
         SQLiteQueryBuilder builder = new SQLiteQueryBuilder();
         builder.setTables("t1");
diff --git a/app/src/main/java/net/zetetic/ZeteticContentProvider2.java b/app/src/main/java/net/zetetic/ZeteticContentProvider2.java
@@ -29,7 +29,6 @@ public boolean onCreate() {
 
     @Override
     public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder) {
-        SQLiteDatabase.loadLibs(ZeteticApplication.getInstance());
         File databasePath = ZeteticApplication.getInstance().getDatabasePath(DATABASE_NAME);
         database = ZeteticApplication.getInstance().createDatabase(databasePath);
 
diff --git a/app/src/main/java/net/zetetic/activities/TestScrollingCursorActivity.java b/app/src/main/java/net/zetetic/activities/TestScrollingCursorActivity.java
@@ -93,7 +93,6 @@ public void run() {
 
   void initializeEnvironment(){
     try{
-      SQLiteDatabase.loadLibs(this);
       File databasePath = getDatabasePath(databaseFilename);
       ZeteticApplication.getInstance().extractAssetToDatabaseDirectory(databaseFilename);
       database = SQLiteDatabase.openDatabase(databasePath.getAbsolutePath(),
diff --git a/app/src/main/java/net/zetetic/tests/JavaClientLibraryVersionTest.java b/app/src/main/java/net/zetetic/tests/JavaClientLibraryVersionTest.java
@@ -2,9 +2,10 @@
 
 import net.sqlcipher.database.SQLiteDatabase;
 
-public class JavaClientLibraryVersionTest extends SQLCipherTest {
+public class
+JavaClientLibraryVersionTest extends SQLCipherTest {
 
-  private final String EXPECTED_SQLCIPHER_ANDROID_VERSION = "4.4.0";
+  private final String EXPECTED_SQLCIPHER_ANDROID_VERSION = "4.4.1";
 
   @Override
   public boolean execute(SQLiteDatabase database) {
diff --git a/app/src/main/java/net/zetetic/tests/JsonCastTest.java b/app/src/main/java/net/zetetic/tests/JsonCastTest.java
@@ -0,0 +1,23 @@
+package net.zetetic.tests;
+
+import net.sqlcipher.Cursor;
+import net.sqlcipher.database.SQLiteDatabase;
+
+public class JsonCastTest extends SQLCipherTest {
+  @Override
+  public boolean execute(SQLiteDatabase database) {
+    String name = "Bob Smith", queryName = "";
+    String query = String.format("select cast(json_extract('{\"user\":\"%s\"}','$.user') as TEXT);", name);
+    Cursor cursor = database.rawQuery(query, new Object[]{});
+    if(cursor != null && cursor.moveToFirst()){
+      queryName = cursor.getString(0);
+      cursor.close();
+    }
+    return name.equals(queryName);
+  }
+
+  @Override
+  public String getName() {
+    return "JSON cast test";
+  }
+}
diff --git a/app/src/main/java/net/zetetic/tests/PragmaCipherVersionTest.java b/app/src/main/java/net/zetetic/tests/PragmaCipherVersionTest.java
@@ -6,7 +6,7 @@
 
 public class PragmaCipherVersionTest extends SQLCipherTest {
 
-    private final String CURRENT_CIPHER_VERSION = "4.4.0";
+    private final String CURRENT_CIPHER_VERSION = "4.4.1";
 
     @Override
     public boolean execute(SQLiteDatabase database) {
diff --git a/app/src/main/java/net/zetetic/tests/TestSuiteRunner.java b/app/src/main/java/net/zetetic/tests/TestSuiteRunner.java
@@ -49,8 +49,6 @@ protected void onPostExecute(Void aVoid) {
   }
 
   private void runSuite() {
-
-    SQLiteDatabase.loadLibs(ZeteticApplication.getInstance());
     CursorWindowAllocation defaultAllocation = CursorWindow.getCursorWindowAllocation();
     for (SQLCipherTest test : getTestsToRun()) {
       try {
@@ -71,10 +69,11 @@ private void runSuite() {
 
   private List<SQLCipherTest> getTestsToRun() {
     List<SQLCipherTest> tests = new ArrayList<>();
+    tests.add(new JsonCastTest());
     tests.add(new SimpleQueryTest());
-    //tests.add(new DefaultCursorWindowAllocationTest());
+    tests.add(new DefaultCursorWindowAllocationTest());
 
-    //tests.add(new DeleteTableWithNullWhereArgsTest());
+    tests.add(new DeleteTableWithNullWhereArgsTest());
     tests.add(new LoopingInsertTest());
     tests.add(new FIPSTest());
     tests.add(new PragmaCipherVersionTest());
@@ -106,7 +105,7 @@ private List<SQLCipherTest> getTestsToRun() {
     tests.add(new TransactionNonExclusiveTest());
     tests.add(new TransactionWithListenerTest());
     tests.add(new LargeDatabaseCursorAccessTest());
-    
+
 ////    tests.add(new TimeLargeByteArrayQueryTest());
 
     tests.add(new QueryLimitTest());
diff --git a/app/src/main/java/net/zetetic/tests/VerifyCipherProviderVersionTest.java b/app/src/main/java/net/zetetic/tests/VerifyCipherProviderVersionTest.java
@@ -11,7 +11,7 @@ public boolean execute(SQLiteDatabase database) {
                 "PRAGMA cipher_provider_version;");
         setMessage(String.format("Reported:%s", provider));
         return provider.contains("OpenSSL 1.1.1") ||
-            provider.contains("OpenSSL 1.0.2t-fips");
+            provider.contains("OpenSSL 1.0.2u-fips");
     }
 
     @Override
diff --git a/app/src/main/java/net/zetetic/tests/support/EncryptBytesTest.java b/app/src/main/java/net/zetetic/tests/support/EncryptBytesTest.java
@@ -0,0 +1,131 @@
+package net.zetetic.tests.support;
+
+import android.app.Activity;
+import android.database.Cursor;
+
+import androidx.room.Dao;
+import androidx.room.Database;
+import androidx.room.Entity;
+import androidx.room.PrimaryKey;
+import androidx.room.RawQuery;
+import androidx.room.Room;
+import androidx.room.RoomDatabase;
+import androidx.sqlite.db.SimpleSQLiteQuery;
+
+import net.sqlcipher.database.SQLiteDatabase;
+import net.sqlcipher.database.SupportFactory;
+import net.zetetic.ZeteticApplication;
+import net.zetetic.tests.TestResult;
+
+import java.security.SecureRandom;
+import java.util.Arrays;
+import java.util.Random;
+
+public class EncryptBytesTest implements ISupportTest {
+
+  Activity activity;
+
+  public EncryptBytesTest(Activity activity) {
+    this.activity = activity;
+  }
+
+  @Dao
+  public interface BlobDao {
+    @RawQuery
+    byte[] blobRawGet(SimpleSQLiteQuery query);
+  }
+
+  public static class Encryptor {
+    BlobDao dao;
+    byte[] encryptionKey;
+
+    public Encryptor(BlobDao dao, byte[] encryptionKey) {
+      this.dao = dao;
+      this.encryptionKey = encryptionKey;
+    }
+
+    public byte[] encryptBytes(byte[] material) {
+      return dao.blobRawGet(new SimpleSQLiteQuery("select sqlcipher_vle_encrypt(?, ?)",
+          new Object[]{material, encryptionKey}));
+    }
+
+    public byte[] decryptBytes(byte[] material) {
+      return dao.blobRawGet(new SimpleSQLiteQuery("select sqlcipher_vle_decrypt(?, ?)",
+          new Object[]{material, encryptionKey}));
+    }
+  }
+
+  public static class Encryptor2 {
+    RoomDatabase roomDatabase;
+    byte[] encryptionKey;
+
+    public Encryptor2(RoomDatabase roomDatabase, byte[] encryptionKey) {
+      this.roomDatabase = roomDatabase;
+      this.encryptionKey = encryptionKey;
+    }
+
+    public byte[] encryptBytes(byte[] material) {
+      byte[] result = null;
+      Cursor cursor = roomDatabase.getOpenHelper().getReadableDatabase().query("select sqlcipher_vle_encrypt(?, ?)",
+          new Object[]{material, encryptionKey});
+      if(cursor != null && cursor.moveToNext()){
+        result = cursor.getBlob(0);
+        cursor.close();
+      }
+      return result;
+    }
+
+    public byte[] decryptBytes(byte[] material) {
+      byte[] result = null;
+      Cursor cursor = roomDatabase.getOpenHelper().getReadableDatabase().query("select sqlcipher_vle_decrypt(?, ?)",
+          new Object[]{material, encryptionKey});
+      if(cursor != null && cursor.moveToNext()){
+        result = cursor.getBlob(0);
+        cursor.close();
+      }
+      return result;
+    }
+  }
+
+  @Entity
+  public static class BlobEntity {
+    @PrimaryKey(autoGenerate = true)
+    long id;
+  }
+
+  @Database(entities = {BlobEntity.class}, version = 1)
+  public static abstract class BlobDatabase extends RoomDatabase {
+    abstract BlobDao blobDao();
+  }
+
+
+  public TestResult run() {
+    TestResult result = new TestResult(getName(), false);
+    byte[] passphrase = SQLiteDatabase.getBytes(ZeteticApplication.DATABASE_PASSWORD.toCharArray());
+    SupportFactory factory = new SupportFactory(passphrase, ZeteticApplication.getInstance().wrapHook(null));
+    BlobDatabase room = Room.databaseBuilder(activity, BlobDatabase.class, "test.db")
+        .openHelperFactory(factory)
+        .build();
+
+    byte[] key = generateRandomBytes(64);
+    //Encryptor encryptor = new Encryptor(room.blobDao(), key);
+    Encryptor2 encryptor = new Encryptor2(room, key);
+
+    byte[] source = "hi".getBytes();
+    byte[] encrypted = encryptor.encryptBytes(source);
+    byte[] decrypted = encryptor.decryptBytes(encrypted);
+    result.setResult(Arrays.equals(source, decrypted));
+    return result;
+  }
+
+  private byte[] generateRandomBytes(int length) {
+    Random random = new SecureRandom();
+    byte[] value = new byte[length];
+    random.nextBytes(value);
+    return value;
+  }
+
+  public String getName() {
+    return "Encrypt Bytes Test";
+  }
+}
diff --git a/app/src/main/java/net/zetetic/tests/support/JavaClientLibraryVersionTest.java b/app/src/main/java/net/zetetic/tests/support/JavaClientLibraryVersionTest.java
@@ -5,7 +5,7 @@
 
 public class JavaClientLibraryVersionTest extends SupportTest {
 
-  private final String EXPECTED_SQLCIPHER_ANDROID_VERSION = "4.4.0";
+  private final String EXPECTED_SQLCIPHER_ANDROID_VERSION = "4.4.1";
 
   @Override
   public boolean execute(SQLiteDatabase database) {
diff --git a/app/src/main/java/net/zetetic/tests/support/PragmaCipherVersionTest.java b/app/src/main/java/net/zetetic/tests/support/PragmaCipherVersionTest.java
@@ -7,7 +7,7 @@
 
 public class PragmaCipherVersionTest extends SupportTest {
 
-    private final String CURRENT_CIPHER_VERSION = "4.4.0";
+    private final String CURRENT_CIPHER_VERSION = "4.4.1";
 
     @Override
     public boolean execute(SQLiteDatabase database) {
diff --git a/app/src/main/java/net/zetetic/tests/support/SQLiteCompiledSqlExceptionTest.java b/app/src/main/java/net/zetetic/tests/support/SQLiteCompiledSqlExceptionTest.java
diff --git a/app/src/main/java/net/zetetic/tests/support/SupportSuiteRunner.java b/app/src/main/java/net/zetetic/tests/support/SupportSuiteRunner.java
diff --git a/app/src/main/java/net/zetetic/tests/support/VerifyCipherProviderVersionTest.java b/app/src/main/java/net/zetetic/tests/support/VerifyCipherProviderVersionTest.java
diff --git a/build.gradle b/build.gradle

Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,12 @@ public static ZeteticApplication getInstance() {`
`28`	`28`	`return instance;`
`29`	`29`	`}`
`30`	`30`
	`31`	`+ @Override`
	`32`	`+ public void onCreate() {`
	`33`	`+ super.onCreate();`
	`34`	`+ NativeInitializer.initialize();`
	`35`	`+ }`
	`36`	`+`
`31`	`37`	`public void setCurrentActivity(Activity activity) {`
`32`	`38`	`this.activity = activity;`
`33`	`39`	`}`