Update suite to reference SQLCipher for Android 4.0.0

developernotes · developernotes · commit 3992263f4783 · 2018-12-03T08:02:19.000-06:00
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
diff --git a/app/app.iml b/app/app.iml
@@ -88,6 +88,7 @@
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/apk_list" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/blame" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/build-info" />
+      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/builds" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/check-libraries" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/check-manifest" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/checkDebugClasspath" />
@@ -122,6 +123,6 @@
     </content>
     <orderEntry type="jdk" jdkName="Android API 26 Platform" jdkType="Android SDK" />
     <orderEntry type="sourceFolder" forTests="false" />
-    <orderEntry type="library" name="Gradle: android-database-sqlcipher-3.5.9:@aar" level="project" />
+    <orderEntry type="library" name="Gradle: net.zetetic:android-database-sqlcipher-4.0.0" level="project" />
   </component>
 </module>
diff --git a/app/build.gradle b/app/build.gradle
@@ -22,8 +22,11 @@ dependencies {
   implementation fileTree(dir: 'libs', include: ['*.jar'])
 
   // For testing zip-based distributions:
-  // implementation files('libs/sqlcipher.jar')
+  //implementation files('libs/sqlcipher.jar')
 
-  // For testing AAR packages:
-  implementation (name: 'android-database-sqlcipher-3.5.9', ext: 'aar')
+  // For testing local AAR packages:
+  //implementation (name: 'android-database-sqlcipher-4.0.0', ext: 'aar')
+
+  // For testing on remote AAR references:
+  implementation 'net.zetetic:android-database-sqlcipher:4.0.0@aar'
 }
diff --git a/app/libs/android-database-sqlcipher-3.5.9.aar b/app/libs/android-database-sqlcipher-3.5.9.aar
diff --git a/app/src/main/assets/sqlcipher-3.0-testkey.db b/app/src/main/assets/sqlcipher-3.0-testkey.db
diff --git a/app/src/main/java/net/zetetic/ZeteticApplication.java b/app/src/main/java/net/zetetic/ZeteticApplication.java
@@ -115,7 +115,7 @@ public void postKey(SQLiteDatabase database) {
   SQLiteDatabaseHook keyHook = new SQLiteDatabaseHook() {
     @Override
     public void preKey(SQLiteDatabase database) {
-      //database.rawExecSQL("PRAGMA cipher_license = '';");
+      database.rawExecSQL("PRAGMA cipher_license = '';");
     }
     public void postKey(SQLiteDatabase database) {
     }
diff --git a/app/src/main/java/net/zetetic/activities/TestScrollingCursorActivity.java b/app/src/main/java/net/zetetic/activities/TestScrollingCursorActivity.java
@@ -14,6 +14,7 @@
 import net.sqlcipher.CustomCursorWindowAllocation;
 import net.sqlcipher.database.SQLiteCursor;
 import net.sqlcipher.database.SQLiteDatabase;
+import net.sqlcipher.database.SQLiteDatabaseHook;
 import net.zetetic.R;
 import net.zetetic.ScrollingCursorAdapter;
 import net.zetetic.ZeteticApplication;
@@ -29,6 +30,16 @@ public class TestScrollingCursorActivity extends Activity {
   RadioGroup options;
   Cursor cursor;
 
+  SQLiteDatabaseHook hook = new SQLiteDatabaseHook() {
+    public void preKey(SQLiteDatabase database) {}
+    public void postKey(SQLiteDatabase database) {
+      database.execSQL("PRAGMA kdf_iter = 64000;");
+      database.execSQL("PRAGMA cipher_page_size = 1024;");
+      database.execSQL("PRAGMA cipher_hmac_algorithm = HMAC_SHA1;");
+      database.execSQL("PRAGMA cipher_kdf_algorithm = PBKDF2_HMAC_SHA1;");
+    }
+  };
+
   @Override
   protected void onCreate(Bundle savedInstanceState) {
     super.onCreate(savedInstanceState);
@@ -86,7 +97,7 @@ void initializeEnvironment(){
       File databasePath = getDatabasePath(databaseFilename);
       ZeteticApplication.getInstance().extractAssetToDatabaseDirectory(databaseFilename);
       database = SQLiteDatabase.openDatabase(databasePath.getAbsolutePath(),
-          ZeteticApplication.DATABASE_PASSWORD, null, SQLiteDatabase.OPEN_READWRITE);
+          ZeteticApplication.DATABASE_PASSWORD, null, SQLiteDatabase.OPEN_READWRITE, hook);
     } catch (Exception e){
       Log.e(getClass().getSimpleName(), e.toString());
     }
diff --git a/app/src/main/java/net/zetetic/tests/AES256GCMCipherTest.java b/app/src/main/java/net/zetetic/tests/AES256GCMCipherTest.java
diff --git a/app/src/main/java/net/zetetic/tests/AttachExistingDatabaseTest.java b/app/src/main/java/net/zetetic/tests/AttachExistingDatabaseTest.java
@@ -19,6 +19,9 @@ protected SQLiteDatabase createDatabase(File databasePath) {
             public void preKey(SQLiteDatabase database) {}
             public void postKey(SQLiteDatabase database) {
                 database.execSQL("PRAGMA cipher_default_kdf_iter = 4000;");
+                database.execSQL("PRAGMA cipher_default_page_size = 1024;");
+                database.execSQL("PRAGMA cipher_default_hmac_algorithm = HMAC_SHA1;");
+                database.execSQL("PRAGMA cipher_default_kdf_algorithm = PBKDF2_HMAC_SHA1;");
             }
         };
         return SQLiteDatabase.openOrCreateDatabase(databasePath,
@@ -58,6 +61,10 @@ protected void tearDown(SQLiteDatabase database) {
         ZeteticApplication.getInstance().delete1xDatabase();
         database.rawExecSQL(String.format("PRAGMA cipher_default_kdf_iter = %s", originalKdfLength));
         database.rawExecSQL("pragma cipher_default_use_hmac = on");
+        database.execSQL("PRAGMA cipher_default_kdf_iter = 256000;");
+        database.execSQL("PRAGMA cipher_default_page_size = 4096;");
+        database.execSQL("PRAGMA cipher_default_hmac_algorithm = HMAC_SHA512;");
+        database.execSQL("PRAGMA cipher_default_kdf_algorithm = PBKDF2_HMAC_SHA512;");
     }
 
     @Override
diff --git a/app/src/main/java/net/zetetic/tests/CompileStatementSyntaxErrorMessageTest.java b/app/src/main/java/net/zetetic/tests/CompileStatementSyntaxErrorMessageTest.java
@@ -21,7 +21,7 @@ public boolean execute(SQLiteDatabase database) {
             String message = e.getMessage();
             setMessage(message);
             // TBD missing error code etc.
-            if (!message.matches("near \"VALUES\": syntax error: .*\\, while compiling: INSERT INTO mytable \\(mydata\\) VALUES")) {
+            if (!message.matches("incomplete input: , while compiling: INSERT INTO mytable \\(mydata\\) VALUES")) {
                 Log.e(ZeteticApplication.TAG, "NOT EXPECTED: INCORRECT exception message: " + message);
                 return false;
             }
diff --git a/app/src/main/java/net/zetetic/tests/JavaClientLibraryVersionTest.java b/app/src/main/java/net/zetetic/tests/JavaClientLibraryVersionTest.java
@@ -4,7 +4,7 @@
 
 public class JavaClientLibraryVersionTest extends SQLCipherTest {
 
-  String expectedClientLibraryVersion = "3.5.9";
+  String expectedClientLibraryVersion = "4.0.0";
 
   @Override
   public boolean execute(SQLiteDatabase database) {
diff --git a/app/src/main/java/net/zetetic/tests/MUTF8ToUTF8WithNullMigrationTest.java b/app/src/main/java/net/zetetic/tests/MUTF8ToUTF8WithNullMigrationTest.java
@@ -16,10 +16,15 @@ public class MUTF8ToUTF8WithNullMigrationTest extends SQLCipherTest {
     String filename = "mutf8.db";
     char[] password = new char[]{'t', 'e', 's', 't', '\u0000', '1', '2', '3'};
     SQLiteDatabaseHook hook = new SQLiteDatabaseHook() {
-        public void preKey(SQLiteDatabase sqLiteDatabase) {
+        public void preKey(SQLiteDatabase database) {
             keyCount++;
         }
-        public void postKey(SQLiteDatabase sqLiteDatabase) {}
+        public void postKey(SQLiteDatabase database) {
+            database.execSQL("PRAGMA kdf_iter = 64000;");
+            database.execSQL("PRAGMA cipher_page_size = 1024;");
+            database.execSQL("PRAGMA cipher_hmac_algorithm = HMAC_SHA1;");
+            database.execSQL("PRAGMA cipher_kdf_algorithm = PBKDF2_HMAC_SHA1;");
+        }
     };
 
     @Override
diff --git a/app/src/main/java/net/zetetic/tests/OpenSQLCipher3DatabaseTest.java b/app/src/main/java/net/zetetic/tests/OpenSQLCipher3DatabaseTest.java
@@ -0,0 +1,46 @@
+package net.zetetic.tests;
+
+import net.sqlcipher.Cursor;
+import net.sqlcipher.database.SQLiteDatabase;
+import net.sqlcipher.database.SQLiteDatabaseHook;
+import net.zetetic.ZeteticApplication;
+
+import java.io.File;
+
+public class OpenSQLCipher3DatabaseTest extends SQLCipherTest {
+
+  String databaseFile = "sqlcipher-3.0-testkey.db";
+
+  @Override
+  public boolean execute(SQLiteDatabase database) {
+    boolean result = false;
+    try {
+      database.close();
+      SQLiteDatabaseHook hook = new SQLiteDatabaseHook() {
+        public void preKey(SQLiteDatabase database) {}
+        public void postKey(SQLiteDatabase database) {
+          database.execSQL("PRAGMA kdf_iter = 64000;");
+          database.execSQL("PRAGMA cipher_page_size = 1024;");
+          database.execSQL("PRAGMA cipher_hmac_algorithm = HMAC_SHA1;");
+          database.execSQL("PRAGMA cipher_kdf_algorithm = PBKDF2_HMAC_SHA1;");
+        }
+      };
+      ZeteticApplication.getInstance().extractAssetToDatabaseDirectory(databaseFile);
+      File databasePath = ZeteticApplication.getInstance().getDatabasePath(databaseFile);
+      database = SQLiteDatabase.openDatabase(databasePath.getAbsolutePath(), "testkey",
+          null, SQLiteDatabase.OPEN_READWRITE, hook);
+      Cursor cursor = database.rawQuery("SELECT COUNT(*) FROM sqlite_master;", null);
+      if(cursor != null){
+        cursor.moveToFirst();
+        int count = cursor.getInt(0);
+        result = count > 0;
+      }
+    } catch (Exception ex) {}
+    return result;
+  }
+
+  @Override
+  public String getName() {
+    return "Open SQLCipher 3 Database";
+  }
+}
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 = "3.4.2";
+    private final String CURRENT_CIPHER_VERSION = "4.0.0";
 
     @Override
     public boolean execute(SQLiteDatabase database) {
diff --git a/app/src/main/java/net/zetetic/tests/SQLCipherTest.java b/app/src/main/java/net/zetetic/tests/SQLCipherTest.java
@@ -3,6 +3,7 @@
 import android.util.Log;
 import net.sqlcipher.database.SQLiteDatabase;
 import net.sqlcipher.database.SQLiteDatabaseHook;
+import net.zetetic.QueryHelper;
 import net.zetetic.ZeteticApplication;
 
 import java.io.File;
@@ -140,6 +141,21 @@ protected void log(String message){
         Log.i(TAG, message);
     }
 
+    protected void logPragmaSetting(SQLiteDatabase database) {
+        String[] pragmas = new String[]{"cipher_version", "kdf_iter", "cipher_page_size", "cipher_use_hmac",
+            "cipher_hmac_algorithm", "cipher_kdf_algorithm"};
+        String[] defaultPragmas = new String[]{"cipher_default_kdf_iter", "cipher_default_page_size",
+            "cipher_default_use_hmac", "cipher_default_hmac_algorithm", "cipher_default_kdf_algorithm"};
+        for (String pragma : pragmas) {
+            String value = QueryHelper.singleValueFromQuery(database, String.format("PRAGMA %s;", pragma));
+            log(String.format("PRAGMA %s set to %s", pragma, value));
+        }
+        for (String defaultPragma : defaultPragmas) {
+            String value = QueryHelper.singleValueFromQuery(database, String.format("PRAGMA %s;", defaultPragma));
+            log(String.format("PRAGMA %s set to %s", defaultPragma, value));
+        }
+    }
+
     protected List<String> ReservedWords = Arrays.asList(new String[]{
         "ABORT",
         "ACTION",
diff --git a/app/src/main/java/net/zetetic/tests/TestSuiteRunner.java b/app/src/main/java/net/zetetic/tests/TestSuiteRunner.java
@@ -71,6 +71,11 @@ private void runSuite() {
 
   private List<SQLCipherTest> getTestsToRun() {
     List<SQLCipherTest> tests = new ArrayList<>();
+    tests.add(new FIPSTest());
+    tests.add(new PragmaCipherVersionTest());
+    tests.add(new VerifyCipherProviderTest());
+    tests.add(new VerifyCipherProviderVersionTest());
+    tests.add(new JavaClientLibraryVersionTest());
     tests.add(new ReadWriteUserVersionTest());
     tests.add(new QueryDataSizeTest());
     tests.add(new FixedCursorWindowAllocationTest());
@@ -104,12 +109,9 @@ private List<SQLCipherTest> getTestsToRun() {
     tests.add(new QueryTenThousandDataTest());
     tests.add(new CompileBeginTest());
     tests.add(new TimeQueryExecutionTest());
-    tests.add(new VerifyCipherProviderTest());
-    tests.add(new VerifyCipherProviderVersionTest());
-    tests.add(new PragmaCipherVersionTest());
-    tests.add(new JavaClientLibraryVersionTest());
+
     tests.add(new UnicodeTest());
-    tests.add(new FIPSTest());
+
     tests.add(new QueryIntegerToStringTest());
     tests.add(new QueryFloatToStringTest());
     tests.add(new ClosedDatabaseTest());
@@ -167,8 +169,8 @@ private List<SQLCipherTest> getTestsToRun() {
     tests.add(new CopyStringToBufferTestStringSmallBuffer());
     tests.add(new CopyStringToBufferTestStringLargeBuffer());
     tests.add(new CopyStringToBufferNullTest());
+    tests.add(new OpenSQLCipher3DatabaseTest());
     tests.add(new MUTF8ToUTF8WithNullMigrationTest());
-    tests.add(new AES256GCMCipherTest());
     tests.add(new RawQuerySyntaxErrorMessageTest());
     tests.add(new RawQueryNonsenseStatementErrorMessageTest());
     tests.add(new RawQueryNoSuchFunctionErrorMessageTest());
diff --git a/app/src/main/java/net/zetetic/tests/VerifyCipherProviderVersionTest.java b/app/src/main/java/net/zetetic/tests/VerifyCipherProviderVersionTest.java
@@ -10,8 +10,8 @@ public boolean execute(SQLiteDatabase database) {
         String provider = QueryHelper.singleValueFromQuery(database,
                 "PRAGMA cipher_provider_version;");
         setMessage(String.format("Reported:%s", provider));
-        return provider.contains("OpenSSL 1.1.0g") ||
-            provider.contains("OpenSSL 1.0.2m-fips");
+        return provider.contains("OpenSSL 1.1.1") ||
+            provider.contains("OpenSSL 1.0.2p-fips");
     }
 
     @Override
diff --git a/sqlcipher-android-tests.iml b/sqlcipher-android-tests.iml
@@ -1,13 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <module external.linked.project.id="sqlcipher-android-tests" external.linked.project.path="$MODULE_DIR$" external.root.project.path="$MODULE_DIR$" external.system.id="GRADLE" type="JAVA_MODULE" version="4">
-  <component name="FacetManager">
-    <facet type="java-gradle" name="Java-Gradle">
-      <configuration>
-        <option name="BUILD_FOLDER_PATH" value="$MODULE_DIR$/build" />
-        <option name="BUILDABLE" value="false" />
-      </configuration>
-    </facet>
-  </component>
   <component name="NewModuleRootManager" LANGUAGE_LEVEL="JDK_1_7" inherit-compiler-output="true">
     <exclude-output />
     <content url="file://$MODULE_DIR$">

Original file line number	Diff line number	Diff line change
`@@ -115,7 +115,7 @@ public void postKey(SQLiteDatabase database) {`
`115`	`115`	`SQLiteDatabaseHook keyHook = new SQLiteDatabaseHook() {`
`116`	`116`	`@Override`
`117`	`117`	`public void preKey(SQLiteDatabase database) {`
`118`		`- //database.rawExecSQL("PRAGMA cipher_license = '';");`
	`118`	`+ database.rawExecSQL("PRAGMA cipher_license = '';");`
`119`	`119`	`}`
`120`	`120`	`public void postKey(SQLiteDatabase database) {`
`121`	`121`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ public boolean execute(SQLiteDatabase database) {`
`21`	`21`	`String message = e.getMessage();`
`22`	`22`	`setMessage(message);`
`23`	`23`	`// TBD missing error code etc.`
`24`		`- if (!message.matches("near \"VALUES\": syntax error: .*\\, while compiling: INSERT INTO mytable \\(mydata\\) VALUES")) {`
	`24`	`+ if (!message.matches("incomplete input: , while compiling: INSERT INTO mytable \\(mydata\\) VALUES")) {`
`25`	`25`	`Log.e(ZeteticApplication.TAG, "NOT EXPECTED: INCORRECT exception message: " + message);`
`26`	`26`	`return false;`
`27`	`27`	`}`