SQLCipher support (GRDB 5.26.0, SQLCipher 4.5.1)

Author: ayoy

.gitattributes

@@ -0,0 +1,3 @@
+GRDB/Export.swift merge=ours
+Sources/CSQLite merge=ours
+Sources/SQLCipher/include/SQLCipher_config.h merge=ours

.github/README.md

@@ -0,0 +1,59 @@
+# GRBD + SQLCipher 
+
+## What is this?
+This is a fork of [GRBD](https://github.com/groue/GRDB.swift) which contains a [SQLCipher Community Edition](https://www.zetetic.net/sqlcipher/open-source/) amalgamation packaged so that it can be consumed as a Swift Package.
+
+The default branch for this repository is `SQLCipher` so that we can more easily pull upstream changes if we need to.
+
+## Versioning
+
+* This Package: *1.2.1*
+* GRDB: *5.26.0*
+* SQLCipher: *4.5.1*
+
+## Contributions
+We do not accept contributions to this repository at this time.  However, feel free to open an issue in order to start a discussion.
+
+## We are hiring!
+DuckDuckGo is growing fast and we continue to expand our fully distributed team. We embrace diverse perspectives, and seek out passionate, self-motivated people, committed to our shared vision of raising the standard of trust online. If you are a senior software engineer capable in either iOS or Android, visit our [careers](https://duckduckgo.com/hiring/#open) page to find out more about our openings!
+
+## Updating from Upstream
+
+Add remote upstream:
+
+* `git remote add upstream [email protected]:groue/GRDB.swift.git`
+
+Check out upstream's master branch locally:
+
+* `git fetch upstream +master:upstream-master && git checkout upstream-master`
+
+Branch off upstream's branch:
+
+* `git checkout -b relase/x.y.z-grdb-a.b.c-sqlcipher-i.j.k`
+
+where `x.y.z` is the new version, `a.b.c` is the upstream GRDB version and `i.j.k` is the SQLCipher version.
+
+Apply the original version of the SQLCipher patch:
+
+* `git am -3 0001-SQLCipher-support.patch`
+
+Compile SQLCipher amalgamation package [see general instructions](https://github.com/sqlcipher/sqlcipher#compiling-for-unix-like-systems):
+
+* Use `./configure --with-crypto-lib=none`
+* Remember to use `make sqlite3.c` and not `make`.
+* Copy `sqlite3.c` and `sqlite3.h` to `Sources/SQLCipher/sqlite3.c` and `Sources/SQLCipher/include/sqlite3.h`
+
+Then update the README to state the versions used. Commit and push your branch, create PR for BSK referencing your new branch,
+and then create PRs for iOS and macOS apps referencing your BSK branch.
+
+Once merged, tag the branch with a version according to how the version of GRDB was updated,
+i.e. maintaining [Semantic Versioning Rules](https://semver.org), but note you don't need
+to follow the version number of GRDB directly.
+
+Examples:
+
+* Upstream GRDB 5.6.0, after merge -> 5.12.0
+  * This project 1.0.0 -> 1.1.0
+
+* Upstream GRDB 5.12.0, after merge -> 6.0.0
+  * This project 1.1.0 -> 2.0.0

GRDB/Export.swift

@@ -1,8 +1 @@
-// Export the underlying SQLite library
-#if SWIFT_PACKAGE
-@_exported import CSQLite
-#elseif GRDBCIPHER
 @_exported import SQLCipher
-#elseif !GRDBCUSTOMSQLITE && !GRDBCIPHER
-@_exported import SQLite3
-#endif

Package.swift

@@ -18,13 +18,62 @@ let package = Package(
     dependencies: [
     ],
     targets: [
-        .systemLibrary(
-            name: "CSQLite",
-            providers: [.apt(["libsqlite3-dev"])]),
         .target(
             name: "GRDB",
-            dependencies: ["CSQLite"],
-            path: "GRDB"),
+            dependencies: ["SQLCipher"],
+            path: "GRDB",
+            cSettings: [
+                 .define("SQLITE_HAS_CODEC"),
+                 .define("SQLITE_TEMP_STORE", to: "2"),
+                 .define("SQLITE_SOUNDEX"),
+                 .define("SQLITE_THREADSAFE"),
+                 .define("SQLITE_ENABLE_RTREE"),
+                 .define("SQLITE_ENABLE_STAT3"),
+                 .define("SQLITE_ENABLE_STAT4"),
+                 .define("SQLITE_ENABLE_COLUMN_METADATA"),
+                 .define("SQLITE_ENABLE_MEMORY_MANAGEMENT"),
+                 .define("SQLITE_ENABLE_LOAD_EXTENSION"),
+                 .define("SQLITE_ENABLE_FTS4"),
+                 .define("SQLITE_ENABLE_FTS4_UNICODE61"),
+                 .define("SQLITE_ENABLE_FTS3_PARENTHESIS"),
+                 .define("SQLITE_ENABLE_UNLOCK_NOTIFY"),
+                 .define("SQLITE_ENABLE_JSON1"),
+                 .define("SQLITE_ENABLE_FTS5"),
+                 .define("SQLCIPHER_CRYPTO_CC"),
+                 .define("HAVE_USLEEP", to: "1"),
+                 .define("SQLITE_MAX_VARIABLE_NUMBER", to: "99999")
+             ],
+             swiftSettings: [
+                 .define("SQLITE_HAS_CODEC"),
+                 .define("GRDBCIPHER"),
+                 .define("SQLITE_ENABLE_FTS5")
+             ]),
+        .target(
+             name: "SQLCipher",
+             cSettings: [
+                 .define("NDEBUG"),
+                 .define("SQLITE_HAS_CODEC"),
+                 .define("SQLITE_TEMP_STORE", to: "2"),
+                 .define("SQLITE_SOUNDEX"),
+                 .define("SQLITE_THREADSAFE"),
+                 .define("SQLITE_ENABLE_RTREE"),
+                 .define("SQLITE_ENABLE_STAT3"),
+                 .define("SQLITE_ENABLE_STAT4"),
+                 .define("SQLITE_ENABLE_COLUMN_METADATA"),
+                 .define("SQLITE_ENABLE_MEMORY_MANAGEMENT"),
+                 .define("SQLITE_ENABLE_LOAD_EXTENSION"),
+                 .define("SQLITE_ENABLE_FTS4"),
+                 .define("SQLITE_ENABLE_FTS4_UNICODE61"),
+                 .define("SQLITE_ENABLE_FTS3_PARENTHESIS"),
+                 .define("SQLITE_ENABLE_UNLOCK_NOTIFY"),
+                 .define("SQLITE_ENABLE_JSON1"),
+                 .define("SQLITE_ENABLE_FTS5"),
+                 .define("SQLCIPHER_CRYPTO_CC"),
+                 .define("HAVE_USLEEP", to: "1"),
+                 .define("SQLITE_MAX_VARIABLE_NUMBER", to: "99999"),
+                 .define("HAVE_GETHOSTUUID", to: "0"),
+                 // .unsafeFlags(["-w"])
+             ]),
         .testTarget(
             name: "GRDBTests",
             dependencies: ["GRDB"],

Sources/CSQLite/module.modulemap

@@ -1,10 +1,13 @@
-#include <sqlite3.h>
+#ifndef grdb_config_h
+#define grdb_config_h
 
-typedef void(*errorLogCallback)(void *pArg, int iErrCode, const char *zMsg);
+#include "sqlite3.h"
+
+typedef void(*_errorLogCallback)(void *pArg, int iErrCode, const char *zMsg);
 
 /// Wrapper around sqlite3_config(SQLITE_CONFIG_LOG, ...) which is a variadic
 /// function that can't be used from Swift.
-static inline void registerErrorLogCallback(errorLogCallback callback) {
+static inline void registerErrorLogCallback(_errorLogCallback callback) {
     sqlite3_config(SQLITE_CONFIG_LOG, callback, 0);
 }
 
@@ -26,3 +29,4 @@ static inline void enableDoubleQuotedStringLiterals(sqlite3 *db) {
 static inline void disableDoubleQuotedStringLiterals(sqlite3 *db) { }
 static inline void enableDoubleQuotedStringLiterals(sqlite3 *db) { }
 #endif
+#endif /* grdb_config_h */