@capacitor-community/sqlite 3.4.0-1 → 3.4.0

package/ios/Plugin/CapacitorSQLite.swift

@@ -1,4 +1,6 @@
 import Foundation
+import Capacitor
+
 enum CapacitorSQLiteError: Error {
     case failed(message: String)
 }
@@ -7,17 +9,72 @@ enum CapacitorSQLiteError: Error {
 @objc public class CapacitorSQLite: NSObject {
     private var config: SqliteConfig
     private var dbDict: [String: Database] = [:]
-    private var databaseLocation: String
+    private var databaseLocation: String = "Documents"
     private var initMessage: String = ""
     private var isInit: Bool = false
+    private var isBiometricAuth: Bool = false
+    private var biometricTitle: String = ""
+    private var bioIdAuth: BiometricIDAuthentication =
+        BiometricIDAuthentication()
+    private var authMessage: String = ""
+    private var internalBiometricObserver: Any?
+    private var intBioMessage: String = ""
+    private var call: CAPPluginCall?
+    private var account: String = oldAccount
+    private var prefixKeychain: String = ""
 
+    // swiftlint:disable function_body_length
+    // swiftlint:disable cyclomatic_complexity
     init(config: SqliteConfig) {
         self.config = config
-        if let isLocation = config.iosDatabaseLocation {
-            self.databaseLocation = isLocation
+        super.init()
+        if let kcPrefix: String = config.iosKeychainPrefix {
+            account = "\(kcPrefix)_\(oldAccount)"
+            prefixKeychain = kcPrefix
+        }
+        if let isBioAuth = config.biometricAuth {
+            if isBioAuth == 1 {
+                if let bTitle = config.biometricTitle {
+                    biometricTitle = bTitle
+                    bioIdAuth.biometricTitle = bTitle
+                }
+                do {
+                    let bioType: BiometricType = try
+                        bioIdAuth.biometricType()
+                    if bioType == BiometricType.faceID ||
+                        bioType == BiometricType.touchID {
+                        isBiometricAuth = true
+                        isInit = true
+                        bioIdAuth.authenticateUser { [weak self] message in
+                            if let message = message {
+                                self?.notifyBiometricEvents(name: .biometricEvent,
+                                                            result: false,
+                                                            msg: message)
+                            } else {
+                                self?.notifyBiometricEvents(name: .biometricEvent,
+                                                            result: true,
+                                                            msg: "")
+                            }
+                        }
+                    } else {
+                        self.notifyBiometricEvents(name: .biometricEvent,
+                                                   result: false,
+                                                   msg: "Biometric not set-up")
+                    }
+                } catch BiometricIDAuthenticationError
+                            .biometricType(let message) {
+                    initMessage =  message
+                } catch let error {
+                    initMessage = "Init Plugin failed :"
+                    initMessage.append(" \(error.localizedDescription)")
+                }
+            }
+        }
+        if let dbLocation = config.iosDatabaseLocation {
+            self.databaseLocation = dbLocation
             // create the databaseLocation directory
             do {
-                try UtilsFile.createDatabaseLocation(location: isLocation)
+                try UtilsFile.createDatabaseLocation(location: dbLocation)
                 isInit = true
             } catch UtilsFileError.createDatabaseLocationFailed(let message) {
                 initMessage =  message
@@ -30,8 +87,9 @@ enum CapacitorSQLiteError: Error {
             self.databaseLocation = "Documents"
             isInit = true
         }
-        super.init()
     }
+    // swiftlint:enable cyclomatic_complexity
+    // swiftlint:enable function_body_length
 
     // MARK: - Echo
 
@@ -43,12 +101,18 @@ enum CapacitorSQLiteError: Error {
 
     @objc public func isSecretStored()  throws -> NSNumber {
         if isInit {
-            let isSecretExists: Bool = UtilsSecret.isPassphrase()
-            if isSecretExists {
-                return 1
-            } else {
-                return 0
+            do {
+                let isSecretExists: Bool = try UtilsSecret.isPassphrase(
+                    account: account)
+                if isSecretExists {
+                    return 1
+                } else {
+                    return 0
+                }
+            } catch UtilsSecretError.prefixPassphrase(let message) {
+                throw CapacitorSQLiteError.failed(message: message)
             }
+
         } else {
             throw CapacitorSQLiteError.failed(message: initMessage)
         }
@@ -63,7 +127,8 @@ enum CapacitorSQLiteError: Error {
                 try closeAllConnections()
                 // set encryption secret
                 try UtilsSecret
-                    .setEncryptionSecret(passphrase: passphrase,
+                    .setEncryptionSecret(prefix: prefixKeychain,
+                                         passphrase: passphrase,
                                          databaseLocation: databaseLocation)
                 return
             } catch UtilsSecretError.setEncryptionSecret(let message) {
@@ -78,28 +143,70 @@ enum CapacitorSQLiteError: Error {
 
     // MARK: - ChangeEncryptionSecret
 
-    @objc public func changeEncryptionSecret(passphrase: String,
+    // swiftlint:disable function_body_length
+    @objc public func changeEncryptionSecret(call: CAPPluginCall, passphrase: String,
                                              oldPassphrase: String) throws {
         if isInit {
+            self.call = call
+            let retHandler: ReturnHandler = ReturnHandler()
             do {
                 // close all connections
                 try closeAllConnections()
-                // set encryption secret
-                try UtilsSecret
-                    .changeEncryptionSecret(passphrase: passphrase,
-                                            oldPassphrase: oldPassphrase,
-                                            databaseLocation: databaseLocation)
-                return
+                if isBiometricAuth {
+                    let dbLocation = databaseLocation
+                    let mPrefixKeychain = prefixKeychain
+                    bioIdAuth.authenticateUser { [weak self] message in
+                        if let message = message {
+                            self?.intBioMessage = message
+                            return
+                        } else {
+                            do {
+                                try UtilsSecret.changeEncryptionSecret(
+                                    prefix: mPrefixKeychain,
+                                    passphrase: passphrase,
+                                    oldPassphrase: oldPassphrase,
+                                    databaseLocation: dbLocation)
+                                retHandler.rResult(call: call)
+                                return
+                            } catch UtilsSecretError.changeEncryptionSecret(let message) {
+                                let msg = "ChangeEncryptionSecret: \(message)"
+                                retHandler.rResult(call: call, message: msg)
+                                return
+                            } catch let error {
+                                retHandler.rResult(
+                                    call: call,
+                                    message: "ChangeEncryptionSecret: \(error.localizedDescription)")
+                                return
+                            }
+                        }
+                    }
+                } else {
+                    // set encryption secret
+                    try UtilsSecret
+                        .changeEncryptionSecret(prefix: prefixKeychain,
+                                                passphrase: passphrase,
+                                                oldPassphrase: oldPassphrase,
+                                                databaseLocation: databaseLocation)
+                    retHandler.rResult(call: call)
+                    return
+                }
             } catch UtilsSecretError.changeEncryptionSecret(let message) {
-                throw CapacitorSQLiteError.failed(message: message)
+                let msg = "ChangeEncryptionSecret: \(message)"
+                retHandler.rResult(call: call, message: msg)
+                return
             } catch let error {
-                throw CapacitorSQLiteError.failed(message: "\(error)")
+                retHandler.rResult(
+                    call: call,
+                    message: "ChangeEncryptionSecret: \(error.localizedDescription)")
+                return
             }
         } else {
             throw CapacitorSQLiteError.failed(message: initMessage)
         }
 
     }
+    // swiftlint:enable function_body_length
+
     // MARK: - getNCDatabasePath
 
     @objc public func getNCDatabasePath(_ folderPath: String, dbName: String ) throws -> String {
@@ -140,7 +247,8 @@ enum CapacitorSQLiteError: Error {
                 let mDb: Database = try Database(
                     databaseLocation: databaseLocation,
                     databaseName: databasePath,
-                    encrypted: false, mode: "no-encryption", version: version,
+                    encrypted: false, account: account,
+                    mode: "no-encryption", version: version,
                     vUpgDict: [:])
                 dbDict[databasePath] = mDb
                 return
@@ -194,7 +302,8 @@ enum CapacitorSQLiteError: Error {
                 let mDb: Database = try Database(
                     databaseLocation: databaseLocation,
                     databaseName: "\(mDbName)SQLite.db",
-                    encrypted: encrypted, mode: mode, version: version,
+                    encrypted: encrypted, account: account,
+                    mode: mode, version: version,
                     vUpgDict: vUpgDict)
                 dbDict[mDbName] = mDb
                 return
@@ -699,8 +808,8 @@ enum CapacitorSQLiteError: Error {
                 // open the database
                 do {
                     mDb = try Database(
-                        databaseLocation: databaseLocation,
-                        databaseName: dbName, encrypted: encrypted,
+                        databaseLocation: databaseLocation, databaseName: dbName,
+                        encrypted: encrypted, account: account,
                         mode: inMode, version: version, vUpgDict: [:])
                     try mDb.open()
                 } catch DatabaseError.open(let message) {
@@ -1087,6 +1196,17 @@ enum CapacitorSQLiteError: Error {
         }
         return
     }
+
+    func notifyBiometricEvents(name: Notification.Name, result: Bool, msg: String) {
+        var vId: [String: Any] = [:]
+        vId["result"] = result
+        if msg.count > 0 {
+            vId["message"] = msg
+        }
+        NotificationCenter.default.post(name: name, object: nil,
+                                        userInfo: vId)
+    }
+
 }
 // swiftlint:enable type_body_length
 // swiftlint:enable file_length

package/ios/Plugin/CapacitorSQLitePlugin.swift

@@ -11,14 +11,23 @@ public class CapacitorSQLitePlugin: CAPPlugin {
     private var versionUpgrades: [String: [Int: [String: Any]]] = [:]
     var importObserver: Any?
     var exportObserver: Any?
+    var biometricObserver: Any?
+    var config: SqliteConfig?
 
     override public func load() {
-        self.implementation = CapacitorSQLite(config: sqliteConfig())
+        let mConfig = sqliteConfig()
+        self.config = mConfig
         self.addObserversToNotificationCenter()
+        self.implementation = CapacitorSQLite(config: mConfig)
     }
     deinit {
         NotificationCenter.default.removeObserver(importObserver as Any)
         NotificationCenter.default.removeObserver(exportObserver as Any)
+        if let biometricAuth = config?.biometricAuth {
+            if biometricAuth == 1 {
+                NotificationCenter.default.removeObserver(biometricObserver as Any)
+            }
+        }
     }
 
     // MARK: - Echo
@@ -99,8 +108,7 @@ public class CapacitorSQLitePlugin: CAPPlugin {
             return
         }
         do {
-            try implementation?.changeEncryptionSecret(passphrase: passphrase, oldPassphrase: oldPassphrase)
-            retHandler.rResult(call: call)
+            try implementation?.changeEncryptionSecret(call: call, passphrase: passphrase, oldPassphrase: oldPassphrase)
             return
         } catch CapacitorSQLiteError.failed(let message) {
             let msg = "ChangeEncryptionSecret: \(message)"
@@ -1167,10 +1175,19 @@ public class CapacitorSQLitePlugin: CAPPlugin {
 
     @objc func addObserversToNotificationCenter() {
         // add Observers
-        importObserver = NotificationCenter.default.addObserver(forName: .importJsonProgress, object: nil, queue: nil,
-                                                                using: importJsonProgress)
-        exportObserver = NotificationCenter.default.addObserver(forName: .exportJsonProgress, object: nil, queue: nil,
-                                                                using: exportJsonProgress)
+        importObserver = NotificationCenter.default.addObserver(
+            forName: .importJsonProgress, object: nil, queue: nil,
+            using: importJsonProgress)
+        exportObserver = NotificationCenter.default.addObserver(
+            forName: .exportJsonProgress, object: nil, queue: nil,
+            using: exportJsonProgress)
+        if let biometricAuth = config?.biometricAuth {
+            if biometricAuth == 1 {
+                biometricObserver = NotificationCenter.default.addObserver(
+                    forName: .biometricEvent, object: nil, queue: nil,
+                    using: biometricEvent)
+            }
+        }
     }
 
     // MARK: - Handle Notifications
@@ -1189,12 +1206,38 @@ public class CapacitorSQLitePlugin: CAPPlugin {
             return
         }
     }
+    @objc func biometricEvent(notification: Notification) {
+        guard let info = notification.userInfo as? [String: Any] else { return }
+        DispatchQueue.main.async {
+            self.notifyListeners("sqliteBiometricEvent", data: info, retainUntilConsumed: true)
+            return
+        }
+    }
     private func sqliteConfig() -> SqliteConfig {
         var config = SqliteConfig()
-
-        if let iosDatabaseLocation = getConfigValue("iosDatabaseLocation") as? String {
+        config.biometricAuth = 0
+        config.iosKeychainPrefix = ""
+        if let keychainPrefix = getConfigValue("iosKeychainPrefix") as? String {
+            config.iosKeychainPrefix = keychainPrefix
+        }
+        if let iosDatabaseLocation = getConfigValue("iosDatabaseLocation")
+            as? String {
             config.iosDatabaseLocation = iosDatabaseLocation
         }
+
+        if let iosBiometric = getConfigValue("iosBiometric") as? [String: Any] {
+            if let bioAuth = iosBiometric["biometricAuth"] as? Bool {
+                if bioAuth {
+                    config.biometricAuth = 1
+                    if let bioTitle = iosBiometric["biometricTitle"] as? String {
+                        config.biometricTitle = bioTitle.count > 0
+                            ? bioTitle
+                            : "Biometric login for capacitor sqlite"
+                    }
+                }
+            }
+
+        }
         return config
     }
 

package/ios/Plugin/Database.swift

@@ -34,6 +34,7 @@ class Database {
     var mode: String
     var vUpgDict: [Int: [String: Any]]
     var databaseLocation: String
+    var account: String
     var path: String = ""
     var mDb: OpaquePointer?
     let globalData: GlobalSQLite = GlobalSQLite()
@@ -43,10 +44,11 @@ class Database {
 
     // MARK: - Init
     init(databaseLocation: String, databaseName: String, encrypted: Bool,
-         mode: String, version: Int,
+         account: String, mode: String, version: Int,
          vUpgDict: [Int: [String: Any]] = [:]) throws {
         self.dbVersion = version
         self.encrypted = encrypted
+        self.account = account
         self.dbName = databaseName
         self.mode = mode
         self.vUpgDict = vUpgDict
@@ -94,7 +96,7 @@ class Database {
     func open () throws {
         var password: String = ""
         if encrypted && (mode == "secret" || mode == "encryption") {
-            password = UtilsSecret.getPassphrase()
+            password = UtilsSecret.getPassphrase(account: account)
         }
         if mode == "encryption" {
             do {
@@ -367,6 +369,7 @@ class Database {
             }
             msg.append(" \(message)")
             lastId = -1
+            throw DatabaseError.runSQL(message: msg )
         }
 
         if lastId != -1 {

package/ios/Plugin/Extensions/Notification.Name.swift

@@ -7,6 +7,10 @@
 //
 import Foundation
 extension NSNotification.Name {
-    static var importJsonProgress: Notification.Name {return .init(rawValue: "importJsonProgress")}
-    static var exportJsonProgress: Notification.Name {return .init(rawValue: "exportJsonProgress")}
+    static var importJsonProgress: Notification.Name {
+        return .init(rawValue: "importJsonProgress")}
+    static var exportJsonProgress: Notification.Name {
+        return .init(rawValue: "exportJsonProgress")}
+    static var biometricEvent: Notification.Name {
+        return .init(rawValue: "biometricEvent")}
 }

package/ios/Plugin/Models/KeychainServices.swift

@@ -52,7 +52,6 @@ class KeychainWrapper {
             print("Error converting value to data.")
             throw KeychainWrapperError(type: .badData)
         }
-
         // 1
         let query: [String: Any] = [
             // 2
@@ -91,6 +90,7 @@ class KeychainWrapper {
             // 2
             kSecMatchLimit as String: kSecMatchLimitOne,
             kSecReturnAttributes as String: true,
+
             // 3
             kSecReturnData as String: true
         ]

package/ios/Plugin/SqliteConfig.swift

@@ -7,4 +7,7 @@
 
 public struct SqliteConfig {
     var iosDatabaseLocation: String?
+    var biometricAuth: Int?
+    var biometricTitle: String?
+    var iosKeychainPrefix: String?
 }

package/ios/Plugin/Utils/UtilsSQLCipher.swift

@@ -44,7 +44,8 @@ enum State: String {
 class UtilsSQLCipher {
 
     class func getDatabaseState(databaseLocation: String,
-                                databaseName: String) -> State {
+                                databaseName: String,
+                                account: String) -> State {
         do {
             let path: String  = try UtilsFile
                 .getFilePath(databaseLocation: databaseLocation,
@@ -56,7 +57,7 @@ class UtilsSQLCipher {
                 } catch UtilsSQLCipherError.openDBNoPassword(let message) {
                     if message == "Open" {
                         do {
-                            try openDBStoredPassword(dBPath: path)
+                            try openDBStoredPassword(dBPath: path, account: account)
                             return State.ENCRYPTEDSECRET
                         } catch UtilsSQLCipherError.openDBStoredPassword(let message) {
                             if message == "Open" {
@@ -100,9 +101,9 @@ class UtilsSQLCipher {
         }
 
     }
-    class func openDBStoredPassword(dBPath: String) throws {
+    class func openDBStoredPassword(dBPath: String, account: String) throws {
         do {
-            let password: String = UtilsSecret.getPassphrase()
+            let password: String = UtilsSecret.getPassphrase(account: account)
             let oDb: OpaquePointer? = try openOrCreateDatabase(
                 filename: dBPath, password: password, readonly: true)
             try close(oDB: oDb)

package/ios/Plugin/Utils/UtilsSecret.swift

@@ -9,30 +9,42 @@
 import Foundation
 
 enum UtilsSecretError: Error {
+    case prefixPassphrase(message: String)
     case setPassphrase(message: String)
     case changePassphrase(message: String)
     case setEncryptionSecret(message: String)
     case  changeEncryptionSecret(message: String)
 }
 
+let oldAccount: String = "CapacitorSQLitePlugin"
+
 class UtilsSecret {
 
     // MARK: - IsPassphrase
 
-    class func isPassphrase() -> Bool {
-        var ret: Bool = false
-        if getPassphrase() != "" {
-            ret = true
+    class func isPassphrase(account: String) throws -> Bool {
+
+        if !getPassphrase(account: account).isEmpty {
+            return true
         }
-        return ret
+        if !getPassphrase(account: oldAccount).isEmpty {
+            let passphrase = getPassphrase(account: oldAccount)
+            do {
+                try setPassphrase(account: account, passphrase: passphrase)
+                return true
+            } catch UtilsSecretError.prefixPassphrase(let message) {
+                throw UtilsSecretError.changePassphrase(message: message)
+            }
+        }
+        return false
     }
 
     // MARK: - GetPassphrase
 
-    class func getPassphrase() -> String {
+    class func getPassphrase(account: String) -> String {
         let kcw = KeychainWrapper()
         if let password = try? kcw.getGenericPasswordFor(
-            account: "CapacitorSQLitePlugin",
+            account: account,
             service: "unlockSecret") {
             return password
         }
@@ -41,11 +53,11 @@ class UtilsSecret {
 
     // MARK: - SetPassphrase
 
-    class func setPassphrase(passphrase: String) throws {
+    class func setPassphrase(account: String, passphrase: String) throws {
         let kcw = KeychainWrapper()
         do {
             try kcw.storeGenericPasswordFor(
-                account: "CapacitorSQLitePlugin",
+                account: account,
                 service: "unlockSecret",
                 password: passphrase)
         } catch let error as KeychainWrapperError {
@@ -62,9 +74,9 @@ class UtilsSecret {
 
     // MARK: - ValidatePassphrase
 
-    class func validatePassphrase(_ passphrase: String) -> Bool {
+    class func validatePassphrase(account: String, passphrase: String) -> Bool {
         var ret: Bool = false
-        let currentPassphrase = getPassphrase()
+        let currentPassphrase = getPassphrase(account: account)
         if passphrase == currentPassphrase {
             ret = true
         }
@@ -73,10 +85,12 @@ class UtilsSecret {
 
     // MARK: - ChangePassphrase
 
-    class func changePassphrase(oldPassphrase: String, passphrase: String) throws -> Bool {
-        guard validatePassphrase(oldPassphrase) == true else { return false }
+    class func changePassphrase(account: String, oldPassphrase: String,
+                                passphrase: String) throws -> Bool {
+        guard validatePassphrase(account: account,
+                                 passphrase: oldPassphrase) == true else { return false }
         do {
-            try setPassphrase(passphrase: passphrase)
+            try setPassphrase(account: account, passphrase: passphrase)
             return true
         } catch UtilsSecretError.setPassphrase(let message) {
             throw UtilsSecretError.changePassphrase(message: message)
@@ -86,15 +100,25 @@ class UtilsSecret {
     // MARK: - SetEncryptionSecret
 
     // swiftlint:disable function_body_length
-    class func setEncryptionSecret(passphrase: String,
+    // swiftlint:disable cyclomatic_complexity
+    class func setEncryptionSecret(prefix: String, passphrase: String,
                                    databaseLocation: String) throws {
         do {
+            if prefix.isEmpty {
+                let msg: String = "keychain prefix must not be empty"
+                throw UtilsSecretError.setEncryptionSecret(message: msg)
+            }
             if passphrase.isEmpty {
                 let msg: String = "passphrase must not be empty"
                 throw UtilsSecretError.setEncryptionSecret(message: msg)
             }
             // store encrypted passphrase
-            try setPassphrase(passphrase: passphrase)
+            let account = "\(prefix)_\(oldAccount)"
+            if !getPassphrase(account: account).isEmpty {
+                let msg: String = "passphrase already stored in keychain"
+                throw UtilsSecretError.setEncryptionSecret(message: msg)
+            }
+            try setPassphrase(account: account, passphrase: passphrase)
 
             // get the list of databases
             let databaseURL: URL = try UtilsFile.getDatabasesUrl().absoluteURL
@@ -106,7 +130,7 @@ class UtilsSecret {
                 for file: String in dbList {
                     let state: State = UtilsSQLCipher
                         .getDatabaseState(databaseLocation: databaseLocation,
-                                          databaseName: file)
+                                          databaseName: file, account: account)
                     if state.rawValue == "ENCRYPTEDGLOBALSECRET" {
                         let globalData: GlobalSQLite = GlobalSQLite()
                         let password: String = globalData.secret
@@ -140,25 +164,33 @@ class UtilsSecret {
         }
 
     }
+    // swiftlint:enable cyclomatic_complexity
     // swiftlint:enable function_body_length
 
     // MARK: - ChangeEncryptionSecret
 
     // swiftlint:disable function_body_length
-    class func changeEncryptionSecret(passphrase: String,
+    class func changeEncryptionSecret(prefix: String, passphrase: String,
                                       oldPassphrase: String,
                                       databaseLocation: String) throws {
         do {
+            if prefix.isEmpty {
+                let msg: String = "Keychain prefix must not " +
+                    "be empty"
+                throw UtilsSecretError.changeEncryptionSecret(message: msg)
+            }
             if passphrase.isEmpty ||  oldPassphrase.isEmpty {
                 let msg: String = "Passphrase and/or oldpassphrase must not " +
                     "be empty"
                 throw UtilsSecretError.changeEncryptionSecret(message: msg)
             }
-            guard isPassphrase() == true else {
+            let account = "\(prefix)_\(oldAccount)"
+            guard try isPassphrase(account: account) == true else {
                 let msg: String = "Encryption secret has not been set"
                 throw UtilsSecretError.changeEncryptionSecret(message: msg)
             }
-            guard validatePassphrase(oldPassphrase) == true else {
+            guard validatePassphrase(account: account,
+                                     passphrase: oldPassphrase) == true else {
                 let msg: String = "Given oldpassphrase is wrong"
                 throw UtilsSecretError.changeEncryptionSecret(message: msg)
             }
@@ -173,7 +205,7 @@ class UtilsSecret {
                 for file: String in dbList {
                     let state: State = UtilsSQLCipher
                         .getDatabaseState(databaseLocation: databaseLocation,
-                                          databaseName: file)
+                                          databaseName: file, account: account)
                     if state.rawValue == "ENCRYPTEDSECRET" {
                         let dbPath: String  = try UtilsFile
                             .getFilePath(databaseLocation: databaseLocation,
@@ -199,7 +231,7 @@ class UtilsSecret {
             }
 
             // store encrypted passphrase
-            try setPassphrase(passphrase: passphrase)
+            try setPassphrase(account: account, passphrase: passphrase)
 
         } catch UtilsSecretError.setPassphrase(let message) {
             throw UtilsSecretError.setEncryptionSecret(message: message)