Merge pull request #1845 from R4N/sqlcipher-spm-upstream

SQLCipher organizational/import adjustments
This commit is contained in:
Gwendal Roué authored and GitHub committed 2026-02-03 08:19:11 +01:00
commit e784b10314
49 files changed
+482 -211

No files matched your search

+2 -2
View File
@@ -4,8 +4,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
+257
View File
@@ -0,0 +1,257 @@
#if SQLITE_HAS_CODEC
#if GRDBCIPHER // CocoaPods (SQLCipher subspec)
import SQLCipher
#elseif SQLCipher
import SQLCipher
#else
#error("No SQLCipher library configured")
#endif
import Foundation
extension Database {
/// Destination of SQLCipher logs.
///
/// See <https://www.zetetic.net/sqlcipher/sqlcipher-api/#cipher_log>
public struct SQLCipherLogTarget: Sendable {
public var rawValue: String
public init(rawValue: String) {
self.rawValue = rawValue
}
public static let stdout = Self(rawValue: "stdout")
public static let stderr = Self(rawValue: "stderr")
public static let device = Self(rawValue: "device")
public static func file(_ path: String) -> Self { Self(rawValue: path) }
}
/// Granularitly of SQLCipher log outputs.
///
/// Each log level is more verbose than the last. With ``debug`` and
/// ``trace`` the logging system will generate a significant log volume.
///
/// See <https://www.zetetic.net/sqlcipher/sqlcipher-api/#cipher_log_level>
///
/// ## Topics
///
/// ### Log Levels
///
/// - ``none``
/// - ``error``
/// - ``warn``
/// - ``info``
/// - ``debug``
/// - ``trace``
public struct SQLCipherLogLevel: RawRepresentable, Sendable {
public var rawValue: String
public init(rawValue: String) {
self.rawValue = rawValue
}
public static let none = Self(rawValue: "NONE")
public static let error = Self(rawValue: "ERROR")
public static let warn = Self(rawValue: "WARN")
public static let info = Self(rawValue: "INFO")
public static let debug = Self(rawValue: "DEBUG")
public static let trace = Self(rawValue: "TRACE")
}
/// - Returns: the SQLCipher version
///
/// See <https://www.zetetic.net/sqlcipher/sqlcipher-api/#cipher_version>
public var cipherVersion: String {
get throws { try String.fetchOne(self, sql: "PRAGMA cipher_version")! }
}
/// - Returns: the SQLCipher fips status: 1 for fips mode, 0 for non-fips mode
/// The FIPS status will not be initialized until the database connection has been keyed
///
/// See <https://www.zetetic.net/sqlcipher/sqlcipher-api/#cipher_fips_status>
public var cipherFipsStatus: String? {
get throws { try String.fetchOne(self, sql: "PRAGMA cipher_fips_status") }
}
/// - Returns: The compiled crypto provider.
/// The database must be keyed before requesting the name of the crypto provider.
///
/// See <https://www.zetetic.net/sqlcipher/sqlcipher-api/#cipher_provider>
public var cipherProvider: String? {
get throws { try String.fetchOne(self, sql: "PRAGMA cipher_provider") }
}
/// - Returns: the version number provided from the compiled crypto provider.
/// This value, if known, is available only after the database has been keyed.
///
/// See <https://www.zetetic.net/sqlcipher/sqlcipher-api/#cipher_provider_version>
public var cipherProviderVersion: String? {
get throws { try String.fetchOne(self, sql: "PRAGMA cipher_provider_version") }
}
/// Sets the passphrase used to crypt and decrypt an SQLCipher database.
///
/// Call this method from `Configuration.prepareDatabase`,
/// as in the example below:
///
/// var config = Configuration()
/// config.prepareDatabase { db in
/// try db.usePassphrase("secret")
/// }
public func usePassphrase(_ passphrase: String) throws {
guard var data = passphrase.data(using: .utf8) else {
throw DatabaseError(message: "invalid passphrase")
}
defer {
data.resetBytes(in: 0..<data.count)
}
try usePassphrase(data)
}
/// Sets the passphrase used to crypt and decrypt an SQLCipher database.
///
/// Call this method from `Configuration.prepareDatabase`,
/// as in the example below:
///
/// var config = Configuration()
/// config.prepareDatabase { db in
/// try db.usePassphrase(passphraseData)
/// }
public func usePassphrase(_ passphrase: Data) throws {
let code = passphrase.withUnsafeBytes {
sqlite3_key(sqliteConnection, $0.baseAddress, CInt($0.count))
}
guard code == SQLITE_OK else {
throw DatabaseError(resultCode: code, message: String(cString: sqlite3_errmsg(sqliteConnection)))
}
}
/// Changes the passphrase used by an SQLCipher encrypted database.
public func changePassphrase(_ passphrase: String) throws {
guard var data = passphrase.data(using: .utf8) else {
throw DatabaseError(message: "invalid passphrase")
}
defer {
data.resetBytes(in: 0..<data.count)
}
try changePassphrase(data)
}
/// Changes the passphrase used by an SQLCipher encrypted database.
public func changePassphrase(_ passphrase: Data) throws {
// FIXME: sqlite3_rekey is discouraged.
//
// https://github.com/ccgus/fmdb/issues/547#issuecomment-259219320
//
// > We (Zetetic) have been discouraging the use of sqlite3_rekey in
// > favor of attaching a new database with the desired encryption
// > options and using sqlcipher_export() to migrate the contents and
// > schema of the original db into the new one:
// > https://discuss.zetetic.net/t/how-to-encrypt-a-plaintext-sqlite-database-to-use-sqlcipher-and-avoid-file-is-encrypted-or-is-not-a-database-errors/
let code = passphrase.withUnsafeBytes {
sqlite3_rekey(sqliteConnection, $0.baseAddress, CInt($0.count))
}
guard code == SQLITE_OK else {
throw DatabaseError(resultCode: code, message: lastErrorMessage)
}
}
/// When using Commercial or Enterprise SQLCipher packages you must call
/// `PRAGMA cipher_license` with a valid license code prior to executing
/// cryptographic operations on an encrypted database.
/// Failure to provide a license code, or use of an expired trial code,
/// will result in an `SQLITE_AUTH (23)` error code reported from the SQLite API
/// License Codes will activate SQLCipher Commercial or Enterprise packages
/// from Zetetic: <https://www.zetetic.net/sqlcipher/buy/>
/// 15-day free trials are available by request: <https://www.zetetic.net/sqlcipher/trial/>
///
/// Call this method from ``Configuration/prepareDatabase(_:)``,
/// as in the example below:
///
/// ```swift
/// var config = Configuration()
/// config.prepareDatabase { db in
/// try db.applySQLCipherLicense(license)
/// }
/// ```
///
/// See <https://www.zetetic.net/sqlcipher/sqlcipher-api/#cipher_license>
/// - Parameter license: base64 SQLCipher license code to activate SQLCipher commercial
public func applySQLCipherLicense(_ license: String) throws {
try execute(sql: "PRAGMA cipher_license = '\(license)'")
}
/// Instructs SQLCipher to log internal debugging and operational information.
///
/// The supplied ``logLevel`` determines the granularity of the logs output.
///
/// See <https://www.zetetic.net/sqlcipher/sqlcipher-api/#cipher_log>
/// - Parameter logLevel: The granularity to use for the logging system - defaults to `DEBUG`.
/// - Parameter target: The destination of SQLCipher logs - defaults to `.device`.
public func enableCipherLogging(
logLevel: SQLCipherLogLevel = .debug,
target: SQLCipherLogTarget = .device
) throws {
// Pragma do not support SQL arguments. We need to generate SQL that contains literal values:
// PRAGMA cipher_log = '/path/to/file'
// PRAGMA cipher_log_level = 'xxx'
let context = SQLGenerationContext(self, argumentsSink: .literalValues)
try execute(sql: SQL("PRAGMA cipher_log = \(target.rawValue)").sql(context))
try execute(sql: SQL("PRAGMA cipher_log_level = \(logLevel.rawValue.uppercased())").sql(context))
}
/// Instructs SQLCipher to disable logging internal debugging and operational information.
///
/// See <https://www.zetetic.net/sqlcipher/sqlcipher-api/#cipher_log>
public func disableCipherLogging() throws {
try execute(sql: "PRAGMA cipher_log_level = NONE")
}
internal func validateSQLCipher() throws {
// https://discuss.zetetic.net/t/important-advisory-sqlcipher-with-xcode-8-and-new-sdks/1688
//
// > In order to avoid situations where SQLite might be used
// > improperly at runtime, we strongly recommend that
// > applications institute a runtime test to ensure that the
// > application is actually using SQLCipher on the active
// > connection.
if try String.fetchOne(self, sql: "PRAGMA cipher_version") == nil {
throw DatabaseError(resultCode: .SQLITE_MISUSE, message: """
GRDB is not linked against SQLCipher. \
Check https://discuss.zetetic.net/t/important-advisory-sqlcipher-with-xcode-8-and-new-sdks/1688
""")
}
}
internal func dropAllDatabaseObjects() throws {
// SQLCipher does not support the backup API:
// https://discuss.zetetic.net/t/using-the-sqlite-online-backup-api/2631
// So we'll drop all database objects one after the other.
// Prevent foreign keys from messing with drop table statements
let foreignKeysEnabled = try Bool.fetchOne(self, sql: "PRAGMA foreign_keys")!
if foreignKeysEnabled {
try execute(sql: "PRAGMA foreign_keys = OFF")
}
try throwingFirstError(
execute: {
// Remove all database objects, one after the other
try inTransaction {
let sql = "SELECT type, name FROM sqlite_master WHERE name NOT LIKE 'sqlite_%'"
while let row = try Row.fetchOne(self, sql: sql) {
let type: String = row["type"]
let name: String = row["name"]
try execute(sql: "DROP \(type) \(name.quotedDatabaseIdentifier)")
}
return .commit
}
},
finally: {
// Restore foreign keys if needed
if foreignKeysEnabled {
try execute(sql: "PRAGMA foreign_keys = ON")
}
})
}
}
#endif
+2 -2
View File
@@ -4,8 +4,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
+2 -2
View File
@@ -4,8 +4,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
+4 -123
View File
@@ -4,8 +4,9 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
import GRDBSQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
@@ -641,24 +642,6 @@ public final class Database: CustomStringConvertible, CustomDebugStringConvertib
}
}
#if SQLITE_HAS_CODEC
private func validateSQLCipher() throws {
// https://discuss.zetetic.net/t/important-advisory-sqlcipher-with-xcode-8-and-new-sdks/1688
//
// > In order to avoid situations where SQLite might be used
// > improperly at runtime, we strongly recommend that
// > applications institute a runtime test to ensure that the
// > application is actually using SQLCipher on the active
// > connection.
if try String.fetchOne(self, sql: "PRAGMA cipher_version") == nil {
throw DatabaseError(resultCode: .SQLITE_MISUSE, message: """
GRDB is not linked against SQLCipher. \
Check https://discuss.zetetic.net/t/important-advisory-sqlcipher-with-xcode-8-and-new-sdks/1688
""")
}
}
#endif
private func validateFormat() throws {
// Users are surprised when they open a picture as a database and
// see no error (https://github.com/groue/GRDB.swift/issues/54).
@@ -1852,35 +1835,7 @@ public final class Database: CustomStringConvertible, CustomDebugStringConvertib
func erase() throws {
#if SQLITE_HAS_CODEC
// SQLCipher does not support the backup API:
// https://discuss.zetetic.net/t/using-the-sqlite-online-backup-api/2631
// So we'll drop all database objects one after the other.
// Prevent foreign keys from messing with drop table statements
let foreignKeysEnabled = try Bool.fetchOne(self, sql: "PRAGMA foreign_keys")!
if foreignKeysEnabled {
try execute(sql: "PRAGMA foreign_keys = OFF")
}
try throwingFirstError(
execute: {
// Remove all database objects, one after the other
try inTransaction {
let sql = "SELECT type, name FROM sqlite_master WHERE name NOT LIKE 'sqlite_%'"
while let row = try Row.fetchOne(self, sql: sql) {
let type: String = row["type"]
let name: String = row["name"]
try execute(sql: "DROP \(type) \(name.quotedDatabaseIdentifier)")
}
return .commit
}
},
finally: {
// Restore foreign keys if needed
if foreignKeysEnabled {
try execute(sql: "PRAGMA foreign_keys = ON")
}
})
try dropAllDatabaseObjects()
#else
try DatabaseQueue().backup(to: self)
#endif
@@ -2003,80 +1958,6 @@ public final class Database: CustomStringConvertible, CustomDebugStringConvertib
@available(*, unavailable)
extension Database: Sendable { }
#if SQLITE_HAS_CODEC
extension Database {
// MARK: - Encryption
/// Sets the passphrase used to crypt and decrypt an SQLCipher database.
///
/// Call this method from `Configuration.prepareDatabase`,
/// as in the example below:
///
/// var config = Configuration()
/// config.prepareDatabase { db in
/// try db.usePassphrase("secret")
/// }
public func usePassphrase(_ passphrase: String) throws {
guard var data = passphrase.data(using: .utf8) else {
throw DatabaseError(message: "invalid passphrase")
}
defer {
data.resetBytes(in: 0..<data.count)
}
try usePassphrase(data)
}
/// Sets the passphrase used to crypt and decrypt an SQLCipher database.
///
/// Call this method from `Configuration.prepareDatabase`,
/// as in the example below:
///
/// var config = Configuration()
/// config.prepareDatabase { db in
/// try db.usePassphrase(passphraseData)
/// }
public func usePassphrase(_ passphrase: Data) throws {
let code = passphrase.withUnsafeBytes {
sqlite3_key(sqliteConnection, $0.baseAddress, CInt($0.count))
}
guard code == SQLITE_OK else {
throw DatabaseError(resultCode: code, message: String(cString: sqlite3_errmsg(sqliteConnection)))
}
}
/// Changes the passphrase used by an SQLCipher encrypted database.
public func changePassphrase(_ passphrase: String) throws {
guard var data = passphrase.data(using: .utf8) else {
throw DatabaseError(message: "invalid passphrase")
}
defer {
data.resetBytes(in: 0..<data.count)
}
try changePassphrase(data)
}
/// Changes the passphrase used by an SQLCipher encrypted database.
public func changePassphrase(_ passphrase: Data) throws {
// FIXME: sqlite3_rekey is discouraged.
//
// https://github.com/ccgus/fmdb/issues/547#issuecomment-259219320
//
// > We (Zetetic) have been discouraging the use of sqlite3_rekey in
// > favor of attaching a new database with the desired encryption
// > options and using sqlcipher_export() to migrate the contents and
// > schema of the original db into the new one:
// > https://discuss.zetetic.net/t/how-to-encrypt-a-plaintext-sqlite-database-to-use-sqlcipher-and-avoid-file-is-encrypted-or-is-not-a-database-errors/
let code = passphrase.withUnsafeBytes {
sqlite3_rekey(sqliteConnection, $0.baseAddress, CInt($0.count))
}
guard code == SQLITE_OK else {
throw DatabaseError(resultCode: code, message: lastErrorMessage)
}
}
}
#endif
extension Database {
/// Returns the count of changes executed by one statement execution.
func countChanges<T>(_ count: inout Int, forTable tableName: String, updates: () throws -> T) throws -> T {
+2 -2
View File
@@ -4,8 +4,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
+2 -2
View File
@@ -4,8 +4,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
+2 -2
View File
@@ -4,8 +4,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
+4 -4
View File
@@ -5,8 +5,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
@@ -140,7 +140,7 @@ public final class DatabaseSnapshotPool {
let walSnapshot = try db.isolated(readOnly: true) {
try WALSnapshot(db)
}
var holderConfig = Configuration()
var holderConfig = configuration
holderConfig.allowsUnsafeTransactions = true
snapshotHolder = try DatabaseQueue(path: path, configuration: holderConfig)
try snapshotHolder.inDatabase { db in
@@ -199,7 +199,7 @@ public final class DatabaseSnapshotPool {
var configuration = Self.configure(configuration)
// Acquire and hold WAL snapshot
var holderConfig = Configuration()
var holderConfig = configuration
holderConfig.allowsUnsafeTransactions = true
snapshotHolder = try DatabaseQueue(path: path, configuration: holderConfig)
let walSnapshot = try snapshotHolder.inDatabase { db in
+2 -2
View File
@@ -4,8 +4,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
+2 -2
View File
@@ -4,8 +4,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
+2 -2
View File
@@ -4,8 +4,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
+2 -2
View File
@@ -4,8 +4,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
+2 -2
View File
@@ -4,8 +4,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
+2 -2
View File
@@ -4,8 +4,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
+2 -2
View File
@@ -4,8 +4,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
@@ -4,8 +4,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
+2 -2
View File
@@ -4,8 +4,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
+2 -2
View File
@@ -4,8 +4,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
+2 -2
View File
@@ -4,8 +4,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
@@ -4,8 +4,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
@@ -4,8 +4,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
+2 -2
View File
@@ -4,8 +4,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
+2 -2
View File
@@ -5,8 +5,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
+2 -2
View File
@@ -4,8 +4,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
+2 -2
View File
@@ -4,8 +4,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
+2 -2
View File
@@ -4,8 +4,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
+2 -2
View File
@@ -4,8 +4,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
+2 -2
View File
@@ -4,8 +4,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
+2 -2
View File
@@ -5,8 +5,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
+2 -2
View File
@@ -5,8 +5,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
+2 -2
View File
@@ -5,8 +5,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
+2 -2
View File
@@ -5,8 +5,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
+2 -2
View File
@@ -4,8 +4,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
+18
View File
@@ -38,6 +38,12 @@ if ProcessInfo.processInfo.environment["SPI_BUILDER"] == "1" {
dependencies.append(.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"))
}
// GRDB+SQLCipher: Uncomment those lines
//dependencies.append(.package(url: "https://github.com/sqlcipher/SQLCipher.swift.git", from: "4.11.0"))
//cSettings.append(.define("SQLITE_HAS_CODEC"))
//swiftSettings.append(.define("SQLITE_HAS_CODEC"))
//swiftSettings.append(.define("SQLCipher"))
let package = Package(
name: "GRDB",
defaultLocalization: "en", // for tests
@@ -48,19 +54,30 @@ let package = Package(
.watchOS(.v7),
],
products: [
// GRDB+SQLCipher: Delete the GRDBSQLite library
.library(name: "GRDBSQLite", targets: ["GRDBSQLite"]),
.library(name: "GRDB", targets: ["GRDB"]),
.library(name: "GRDB-dynamic", type: .dynamic, targets: ["GRDB"]),
],
dependencies: dependencies,
targets: [
// GRDB+SQLCipher: Delete the GRDBSQLite target
.systemLibrary(
name: "GRDBSQLite",
providers: [.apt(["libsqlite3-dev"])]),
// GRDB+SQLCipher: Uncomment the GRDBSQLCipher target
//.target(
// name: "GRDBSQLCipher",
// dependencies: [.product(name: "SQLCipher", package: "SQLCipher.swift")]
//),
.target(
name: "GRDB",
dependencies: [
// GRDB+SQLCipher: Delete the GRDBSQLite dependency
.target(name: "GRDBSQLite"),
// GRDB+SQLCipher: Uncomment the SQLCipher and GRDBSQLCipher dependencies
//.product(name: "SQLCipher", package: "SQLCipher.swift"),
//.target(name: "GRDBSQLCipher"),
],
path: "GRDB",
resources: [.copy("PrivacyInfo.xcprivacy")],
@@ -87,6 +104,7 @@ let package = Package(
.copy("GRDBTests/Betty.jpeg"),
.copy("GRDBTests/InflectionsTests.json"),
.copy("GRDBTests/Issue1383.sqlite"),
.copy("GRDBTests/db.SQLCipher3"),
],
cSettings: cSettings,
swiftSettings: swiftSettings + [
+3 -1
View File
@@ -4589,7 +4589,9 @@ Encryption
**GRDB can encrypt your database with [SQLCipher](http://sqlcipher.net) v3.4+.**
Use [CocoaPods](http://cocoapods.org/), and specify in your `Podfile`:
To use SQLCipher with the [Swift Package Manager](https://swift.org/package-manager/), you must fork GRDB, and modify `Package.swift`. Instructions are in the file itself, in comments that contain "GRDB+SQLCipher".
To use SQLCipher with [CocoaPods](http://cocoapods.org/), specify in your `Podfile`:
```ruby
# GRDB with SQLCipher 4
+1
View File
@@ -0,0 +1 @@
// empty c-file
@@ -0,0 +1,32 @@
#ifndef grdb_config_h
#define grdb_config_h
#include <SQLCipher/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) {
sqlite3_config(SQLITE_CONFIG_LOG, callback, 0);
}
#if SQLITE_VERSION_NUMBER >= 3029000
/// Wrapper around sqlite3_db_config() which is a variadic function that can't
/// be used from Swift.
static inline void _disableDoubleQuotedStringLiterals(sqlite3 *db) {
sqlite3_db_config(db, SQLITE_DBCONFIG_DQS_DDL, 0, (void *)0);
sqlite3_db_config(db, SQLITE_DBCONFIG_DQS_DML, 0, (void *)0);
}
/// Wrapper around sqlite3_db_config() which is a variadic function that can't
/// be used from Swift.
static inline void _enableDoubleQuotedStringLiterals(sqlite3 *db) {
sqlite3_db_config(db, SQLITE_DBCONFIG_DQS_DDL, 1, (void *)0);
sqlite3_db_config(db, SQLITE_DBCONFIG_DQS_DML, 1, (void *)0);
}
#else
static inline void _disableDoubleQuotedStringLiterals(sqlite3 *db) { }
static inline void _enableDoubleQuotedStringLiterals(sqlite3 *db) { }
#endif
#endif /* grdb_config_h */
@@ -0,0 +1,4 @@
module GRDBSQLCipher {
header "SQLCipher_config.h"
export *
}
@@ -4,8 +4,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
+2 -2
View File
@@ -4,8 +4,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
@@ -12,24 +12,32 @@ class DatabaseConfigurationTests: GRDBTestCase {
connectionCountMutex.increment()
}
connectionCountMutex.store(0)
_ = try DatabaseQueue(configuration: configuration)
XCTAssertEqual(connectionCountMutex.load(), 1)
connectionCountMutex.store(0)
_ = try makeDatabaseQueue(configuration: configuration)
XCTAssertEqual(connectionCountMutex.load(), 2)
XCTAssertEqual(connectionCountMutex.load(), 1)
connectionCountMutex.store(0)
let pool = try makeDatabasePool(configuration: configuration)
XCTAssertEqual(connectionCountMutex.load(), 3)
XCTAssertEqual(connectionCountMutex.load(), 1) // writer
connectionCountMutex.store(0)
try pool.read { _ in }
XCTAssertEqual(connectionCountMutex.load(), 4)
XCTAssertEqual(connectionCountMutex.load(), 1) // 1st reader
connectionCountMutex.store(0)
try pool.makeSnapshot().read { _ in }
XCTAssertEqual(connectionCountMutex.load(), 5)
XCTAssertEqual(connectionCountMutex.load(), 1) // snapshot
#if SQLITE_ENABLE_SNAPSHOT && !SQLITE_DISABLE_SNAPSHOT
try pool.makeSnapshotPool().read { _ in }
XCTAssertEqual(connectionCountMutex.load(), 6)
connectionCountMutex.store(0)
let snapshotPool = try pool.makeSnapshotPool()
XCTAssertEqual(connectionCountMutex.load(), 1) // snapshot
try snapshotPool.read { _ in }
XCTAssertEqual(connectionCountMutex.load(), 2) // 1st reader
#endif
}
@@ -4,8 +4,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
+2 -2
View File
@@ -4,8 +4,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
+69 -1
View File
@@ -4,6 +4,12 @@ import GRDB
class EncryptionTests: GRDBTestCase {
#if SWIFT_PACKAGE
let testBundle = Bundle.module
#else
let testBundle = Bundle(for: GRDBTestCase.self)
#endif
func testDatabaseQueueWithPassphraseToDatabaseQueueWithPassphrase() throws {
do {
var config = Configuration()
@@ -707,7 +713,6 @@ class EncryptionTests: GRDBTestCase {
else { XCTFail("Unknown SQLCipher version"); return }
if cipherMajorVersion >= 4 {
let testBundle = Bundle(for: type(of: self))
let path = testBundle.url(forResource: "db", withExtension: "SQLCipher3")!.path
var configuration = Configuration()
configuration.prepareDatabase { db in
@@ -728,5 +733,68 @@ class EncryptionTests: GRDBTestCase {
}
}
}
func testCipherVersion() throws {
try DatabaseQueue().inDatabase { db in
_ = try db.cipherVersion
}
}
func testCipherFipsStatus() throws {
var config = Configuration()
config.prepareDatabase { db in
try db.usePassphrase("secret")
}
let dbQueue = try makeDatabaseQueue(configuration: config)
try dbQueue.inDatabase { db in
XCTAssertEqual("0", try db.cipherFipsStatus)
}
}
func testCipherProvider() throws {
var config = Configuration()
config.prepareDatabase { db in
try db.usePassphrase("secret")
}
let dbQueue = try makeDatabaseQueue(configuration: config)
try dbQueue.inDatabase { db in
XCTAssertEqual("commoncrypto", try db.cipherProvider)
}
}
func testCipherProviderVersion() throws {
var config = Configuration()
config.prepareDatabase { db in
try db.usePassphrase("secret")
}
let dbQueue = try makeDatabaseQueue(configuration: config)
let cipherVersion = try dbQueue.read { try $0.cipherVersion }
if "4.10.0".compare(cipherVersion, options: .numeric) == .orderedDescending {
throw XCTSkip("cipher_provider_version isn't available until SQLCipher 4.10.0")
}
try dbQueue.inDatabase { db in
XCTAssertNotNil(try db.cipherProviderVersion)
}
}
func test_enableCipherLogging() throws {
let dbQueue = try makeDatabaseQueue()
let cipherVersion = try dbQueue.read { try $0.cipherVersion }
if "4.0.0".compare(cipherVersion, options: .numeric) == .orderedDescending {
throw XCTSkip("SQLCipher logging is not available")
}
try dbQueue.inDatabase { db in
try db.enableCipherLogging()
try db.enableCipherLogging(logLevel: .error)
try db.enableCipherLogging(target: .stdout)
let logFilePath = (NSTemporaryDirectory() as NSString).appendingPathComponent(ProcessInfo.processInfo.globallyUniqueString)
defer {
try? FileManager.default.removeItem(atPath: logFilePath)
}
try db.enableCipherLogging(target: .file(logFilePath))
XCTAssert(FileManager.default.fileExists(atPath: logFilePath))
}
}
}
#endif
+2 -2
View File
@@ -4,8 +4,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
@@ -4,8 +4,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
+2 -2
View File
@@ -4,8 +4,8 @@ import SQLCipher
#elseif GRDBFRAMEWORK // GRDB.xcodeproj or CocoaPods (standard subspec)
import SQLite3
#elseif GRDBCUSTOMSQLITE // GRDBCustom Framework
// #elseif SomeTrait
// import ...
#elseif SQLCipher
import SQLCipher
#else // Default SPM trait must be the default. It impossible to detect from Xcode.
import GRDBSQLite
#endif
Binary file not shown.