Merge pull request #1340 from stephencelis/R4N-sqlcipher-spm

SQLCipher package

Author: jberkel

.github/workflows/build.yml

@@ -9,12 +9,15 @@ on:
 concurrency:
   group: ci-${{ github.ref }}
   cancel-in-progress:  ${{ github.ref != 'refs/heads/master' }}
-env:
-  IOS_SIMULATOR: "iPhone 16"
-  IOS_VERSION: "18.4"
 jobs:
   build:
-    runs-on: macos-15
+    strategy:
+      matrix:
+        os: [macos-15, macos-26]
+    runs-on: ${{ matrix.os }}
+    env:
+      IOS_SIMULATOR: ${{ matrix.os == 'macos-15' && 'iPhone 16' || 'iPhone 16e' }}
+      IOS_VERSION: ${{ matrix.os == 'macos-15' && '18.4' || '26.2' }}
     steps:
     - uses: actions/checkout@v4
     - name: "Lint"
@@ -23,6 +26,10 @@ jobs:
       env:
         PACKAGE_MANAGER_COMMAND: test -Xswiftc -warnings-as-errors
       run: ./run-tests.sh
+    - name: "Run tests (PACKAGE_MANAGER_COMMAND: test --traits SQLCipher)"
+      env:
+        PACKAGE_MANAGER_COMMAND: test -Xswiftc -warnings-as-errors --traits SQLCipher
+      run: ./run-tests.sh
     - name: "Run tests (SPM integration test)"
       env:
         SPM: run

.gitignore

@@ -29,3 +29,4 @@ bin/
 .build
 Packages/
 .swiftpm/
+Package.resolved

CHANGELOG.md

@@ -1,3 +1,7 @@
+0.15.5 (tbd), [diff][diff-0.15.5]
+========================================
+* SQLCipher package manager integration ([#1336][], [#1340][])
+
 0.15.4 (13-06-2025), [diff][diff-0.15.4]
 ========================================
 * Fix cross compilation for linux on macOS fails ([#1317][])
@@ -271,4 +275,6 @@ For breaking changes, see [Upgrading.md](Documentation/Upgrading.md).
 [#1279]: https://github.com/stephencelis/SQLite.swift/pull/1279
 [#1280]: https://github.com/stephencelis/SQLite.swift/pull/1280
 [#1315]: https://github.com/stephencelis/SQLite.swift/pull/1315
-[#1317]: https://github.com/stephencelis/SQLite.swift/pull/1317
+[#1317]: https://github.com/stephencelis/SQLite.swift/pull/1317
+[#1336]: https://github.com/stephencelis/SQLite.swift/pull/1336
+[#1340]: https://github.com/stephencelis/SQLite.swift/pull/1340

Documentation/Index.md

@@ -3,10 +3,10 @@
 - [SQLite.swift Documentation](#sqliteswift-documentation)
   - [Installation](#installation)
     - [Swift Package Manager](#swift-package-manager)
+        - [Using SQLite.swift with SQLCipher](#using-sqliteswift-with-sqlcipher)
     - [Carthage](#carthage)
     - [CocoaPods](#cocoapods)
       - [Requiring a specific version of SQLite](#requiring-a-specific-version-of-sqlite)
-      - [Using SQLite.swift with SQLCipher](#using-sqliteswift-with-sqlcipher)
     - [Manual](#manual)
   - [Getting Started](#getting-started)
     - [Connecting to a Database](#connecting-to-a-database)
@@ -119,7 +119,79 @@ process of downloading, compiling, and linking dependencies.
   $ swift build
   ```
 
+#### Using SQLite.swift with SQLCipher
+
+If you want to use [SQLCipher][] with SQLite.swift you can specify the `SQLCipher` trait when consuming SQLite.swift.
+
+```swift
+depdencies: [
+  .package(url: "https://github.com/stephencelis/SQLite.swift.git", from: "0.15.4", traits: ["SQLCipher"])
+]
+```
+
+As of Xcode 26.2 (17C52), there's no direct way in the Xcode UI to select trait variations so you'll need to use a local wrapper package to pull in the SQLite.swift dependency with the `SQLCipher` trait enabled:
+
+```swift
+// swift-tools-version: 6.1
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+    name: "AppDependencies",
+    platforms: [
+        .macOS(.v10_14),
+        .iOS(.v13),
+        .macCatalyst(.v13),
+        .watchOS(.v8),
+        .tvOS(.v15),
+        .visionOS(.v1)
+    ],
+    products: [
+        .library(
+            name: "AppDependencies",
+            targets: ["AppDependencies"]),
+    ],
+    dependencies: [
+        .package(
+            url: "https://github.com/stephencelis/SQLite.swift.git",
+            from: "0.15.4",
+            traits: ["SQLCipher"])
+    ],
+    targets: [
+        .target(
+            name: "AppDependencies",
+            dependencies: [
+                .product(
+                    name: "SQLite",
+                    package: "SQLite.swift")
+            ]
+        )
+    ]
+)
+```
+
+Within Xcode add your local `AppDependencies` wrapper package as a package dependency and SQLite.swift with SQLCipher functionality will be accessible.
+
+Using the `SQLCipher` trait will cause SQLite.swift to include a dependency on SQLCipher.swift and enable `Connection` methods to set and change the database key:
+
+```swift
+import SQLite
+
+let db = try Connection("path/to/encrypted.sqlite3")
+try db.key("secret")
+try db.rekey("new secret") // changes encryption key on already encrypted db
+```
+
+To encrypt an existing database:
+
+```swift
+let db = try Connection("path/to/unencrypted.sqlite3")
+try db.sqlcipher_export(.uri("encrypted.sqlite3"), key: "secret")
+```
+
 [Swift Package Manager]: https://swift.org/package-manager
+[SQLCipher]: https://www.zetetic.net/sqlcipher/
 
 ### Carthage
 
@@ -191,41 +263,9 @@ end
 
 See the [sqlite3 podspec][sqlite3pod] for more details.
 
-#### Using SQLite.swift with SQLCipher
-
-If you want to use [SQLCipher][] with SQLite.swift you can require the
-`SQLCipher` subspec in your Podfile (SPM is not supported yet, see [#1084](https://github.com/stephencelis/SQLite.swift/issues/1084)):
-
-```ruby
-target 'YourAppTargetName' do
-  # Make sure you only require the subspec, otherwise you app might link against
-  # the system SQLite, which means the SQLCipher-specific methods won't work.
-  pod 'SQLite.swift/SQLCipher', '~> 0.15.4'
-end
-```
-
-This will automatically add a dependency to the SQLCipher pod as well as
-extend `Connection` with methods to change the database key:
-
-```swift
-import SQLite
-
-let db = try Connection("path/to/encrypted.sqlite3")
-try db.key("secret")
-try db.rekey("new secret") // changes encryption key on already encrypted db
-```
-
-To encrypt an existing database:
-
-```swift
-let db = try Connection("path/to/unencrypted.sqlite3")
-try db.sqlcipher_export(.uri("encrypted.sqlite3"), key: "secret")
-```
-
 [CocoaPods]: https://cocoapods.org
 [CocoaPods Installation]: https://guides.cocoapods.org/using/getting-started.html#getting-started
 [sqlite3pod]: https://github.com/clemensg/sqlite3pod
-[SQLCipher]: https://www.zetetic.net/sqlcipher/
 
 ### Manual
 

Package.swift

@@ -1,35 +1,37 @@
-// swift-tools-version:5.9
+// swift-tools-version: 6.1
 import PackageDescription
 
 let deps: [Package.Dependency] = [
-    .github("swiftlang/swift-toolchain-sqlite", exact: "1.0.7")
+    .package(url: "https://github.com/swiftlang/swift-toolchain-sqlite", from: "1.0.7"),
+    .package(url: "https://github.com/sqlcipher/SQLCipher.swift.git", from: "4.11.0")
 ]
 
+let applePlatforms: [PackageDescription.Platform] = [.iOS, .macOS, .watchOS, .tvOS, .visionOS]
+let sqlcipherTraitBuildSettingCondition: BuildSettingCondition? = .when(platforms: applePlatforms, traits: ["SQLCipher"])
+let cSettings: [CSetting] = [.define("SQLITE_HAS_CODEC", to: nil, sqlcipherTraitBuildSettingCondition)]
+let swiftSettings: [SwiftSetting] = [.define("SQLITE_HAS_CODEC", sqlcipherTraitBuildSettingCondition)]
+
 let targets: [Target] = [
     .target(
         name: "SQLite",
         dependencies: [
-            .product(name: "SwiftToolchainCSQLite", package: "swift-toolchain-sqlite", condition: .when(platforms: [.linux, .windows, .android]))
+            .product(name: "SwiftToolchainCSQLite", package: "swift-toolchain-sqlite", condition: .when(platforms: [.linux, .windows, .android])),
+            .product(name: "SQLCipher", package: "SQLCipher.swift", condition: .when(platforms: applePlatforms, traits: ["SQLCipher"]))
         ],
-        exclude: [
-            "Info.plist"
-        ]
+        exclude: ["Info.plist"],
+        cSettings: cSettings,
+        swiftSettings: swiftSettings
     )
 ]
 
 let testTargets: [Target] = [
     .testTarget(
         name: "SQLiteTests",
-        dependencies: [
-            "SQLite"
-        ],
+        dependencies: ["SQLite"],
         path: "Tests/SQLiteTests",
-        exclude: [
-            "Info.plist"
-        ],
-        resources: [
-            .copy("Resources")
-        ]
+        exclude: ["Info.plist"],
+        resources: [.copy("Resources")],
+        swiftSettings: swiftSettings
     )
 ]
 
@@ -48,13 +50,10 @@ let package = Package(
             targets: ["SQLite"]
         )
     ],
+    traits: [
+        .trait(name: "SQLCipher", description: "Enables SQLCipher encryption when a key is supplied to Connection")
+    ],
     dependencies: deps,
-    targets: targets + testTargets
+    targets: targets + testTargets,
+    swiftLanguageModes: [.v5],
 )
-
-extension Package.Dependency {
-
-    static func github(_ repo: String, exact ver: Version) -> Package.Dependency {
-        .package(url: "https://github.com/\(repo)", exact: ver)
-    }
-}

README.md

@@ -18,7 +18,7 @@ syntax _and_ intent.
  - [Full-text search][] support
  - [Well-documented][See Documentation]
  - Extensively tested
- - [SQLCipher][] support via CocoaPods
+ - [SQLCipher][] support via Swift Package Manager
  - [Schema query/migration][]
  - Works on [Linux](Documentation/Linux.md) (with some limitations)
  - Active support at

SQLite.swift.podspec

@@ -29,7 +29,7 @@ Pod::Spec.new do |s|
     ss.exclude_files = 'Sources/**/Cipher.swift'
     ss.library = 'sqlite3'
     ss.resource_bundle = { 'SQLite.swift' => 'Sources/SQLite/PrivacyInfo.xcprivacy' }
-    
+
     ss.test_spec 'tests' do |test_spec|
       test_spec.resources = 'Tests/SQLiteTests/Resources/*'
       test_spec.source_files = 'Tests/SQLiteTests/**/*.swift'
@@ -46,7 +46,7 @@ Pod::Spec.new do |s|
       'GCC_PREPROCESSOR_DEFINITIONS' => '$(inherited) SQLITE_SWIFT_STANDALONE=1'
     }
     ss.dependency 'sqlite3'
-    
+
     ss.test_spec 'tests' do |test_spec|
       test_spec.resources = 'Tests/SQLiteTests/Resources/*'
       test_spec.source_files = 'Tests/SQLiteTests/**/*.swift'
@@ -65,11 +65,11 @@ Pod::Spec.new do |s|
     ss.resource_bundle = { 'SQLite.swift' => 'Sources/SQLite/PrivacyInfo.xcprivacy' }
 
     ss.xcconfig = {
-      'OTHER_SWIFT_FLAGS' => '$(inherited) -DSQLITE_SWIFT_SQLCIPHER',
-      'GCC_PREPROCESSOR_DEFINITIONS' => '$(inherited) SQLITE_HAS_CODEC=1 SQLITE_SWIFT_SQLCIPHER=1'
+      'OTHER_SWIFT_FLAGS' => '$(inherited) -DSQLITE_HAS_CODEC',
+      'GCC_PREPROCESSOR_DEFINITIONS' => '$(inherited) SQLITE_HAS_CODEC=1'
     }
     ss.dependency 'SQLCipher', '>= 4.0.0'
-    
+
     ss.test_spec 'tests' do |test_spec|
       test_spec.resources = 'Tests/SQLiteTests/Resources/*'
       test_spec.source_files = 'Tests/SQLiteTests/**/*.swift'

Sources/SQLite/Core/Connection+Attach.swift

@@ -1,7 +1,7 @@
 import Foundation
 
 extension Connection {
-    #if SQLITE_SWIFT_SQLCIPHER
+    #if SQLITE_HAS_CODEC
     /// See https://www.zetetic.net/sqlcipher/sqlcipher-api/#attach
     public func attach(_ location: Location, as schemaName: String, key: String? = nil) throws {
         if let key {