@capgo/capacitor-updater 5.0.0-alpha.0 → 7.0.0

package/ios/Plugin/CryptoCipher.swift

@@ -0,0 +1,240 @@
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
+
+import Foundation
+import CommonCrypto
+
+///
+/// Constants
+///
+private enum CryptoCipherConstants {
+    static let rsaKeySizeInBits: NSNumber = 2048
+    static let aesAlgorithm: CCAlgorithm = CCAlgorithm(kCCAlgorithmAES)
+    static let aesOptions: CCOptions = CCOptions(kCCOptionPKCS7Padding)
+    static let rsaAlgorithm: SecKeyAlgorithm = .rsaEncryptionOAEPSHA256
+}
+///
+/// The AES key. Contains both the initialization vector and secret key.
+///
+public struct AES128Key {
+    /// Initialization vector
+    private let iv: Data
+    private let aes128Key: Data
+    #if DEBUG
+    public var __debug_iv: Data { iv }
+    public var __debug_aes128Key: Data { aes128Key }
+    #endif
+    init(iv: Data, aes128Key: Data) {
+        self.iv = iv
+        self.aes128Key = aes128Key
+    }
+    ///
+    /// Takes the data and uses the private key to decrypt it. Will call `CCCrypt` in CommonCrypto
+    /// and provide it `ivData` for the initialization vector. Will use cipher block chaining (CBC) as
+    /// the mode of operation.
+    ///
+    /// Returns the decrypted data.
+    ///
+    public func decrypt(data: Data) -> Data? {
+        let encryptedData: UnsafePointer<UInt8> = (data as NSData).bytes.bindMemory(to: UInt8.self, capacity: data.count)
+        let encryptedDataLength: Int = data.count
+
+        if let result: NSMutableData = NSMutableData(length: encryptedDataLength) {
+            let keyData: UnsafePointer<UInt8> = (self.aes128Key as NSData).bytes.bindMemory(to: UInt8.self, capacity: self.aes128Key.count)
+            let keyLength: size_t = size_t(self.aes128Key.count)
+            let ivData: UnsafePointer<UInt8> = (iv as NSData).bytes.bindMemory(to: UInt8.self, capacity: self.iv.count)
+
+            let decryptedData: UnsafeMutablePointer<UInt8> = UnsafeMutablePointer<UInt8>(result.mutableBytes.assumingMemoryBound(to: UInt8.self))
+            let decryptedDataLength: size_t = size_t(result.length)
+
+            var decryptedLength: size_t = 0
+
+            let status: CCCryptorStatus = CCCrypt(CCOperation(kCCDecrypt), CryptoCipherConstants.aesAlgorithm, CryptoCipherConstants.aesOptions, keyData, keyLength, ivData, encryptedData, encryptedDataLength, decryptedData, decryptedDataLength, &decryptedLength)
+
+            if UInt32(status) == UInt32(kCCSuccess) {
+                result.length = Int(decryptedLength)
+                return result as Data
+            } else {
+                return nil
+            }
+        } else {
+            return nil
+        }
+    }
+}
+
+///
+/// The RSA keypair. Includes both private and public key.
+///
+public struct RSAKeyPair {
+    private let privateKey: SecKey
+    private let publicKey: SecKey
+
+    #if DEBUG
+    public var __debug_privateKey: SecKey { self.privateKey }
+    public var __debug_publicKey: SecKey { self.publicKey }
+    #endif
+
+    fileprivate init(privateKey: SecKey, publicKey: SecKey) {
+        self.privateKey = privateKey
+        self.publicKey = publicKey
+    }
+
+    public func extractPublicKey() -> RSAPublicKey {
+        RSAPublicKey(publicKey: publicKey)
+    }
+
+    ///
+    /// Takes the data and uses the private key to decrypt it.
+    /// Returns the decrypted data.
+    ///
+    public func decrypt(data: Data) -> Data? {
+        var error: Unmanaged<CFError>?
+        if let decryptedData: CFData = SecKeyCreateDecryptedData(self.privateKey, CryptoCipherConstants.rsaAlgorithm, data as CFData, &error) {
+            if error != nil {
+                return nil
+            } else {
+                return decryptedData as Data
+            }
+        } else {
+            return nil
+        }
+    }
+}
+
+///
+/// The RSA public key.
+///
+public struct RSAPublicKey {
+    private let publicKey: SecKey
+
+    #if DEBUG
+    public var __debug_publicKey: SecKey { self.publicKey }
+    #endif
+
+    fileprivate init(publicKey: SecKey) {
+        self.publicKey = publicKey
+    }
+    ///
+    /// Takes the data and uses the public key to encrypt it.
+    /// Returns the encrypted data.
+    ///
+    public func encrypt(data: Data) -> Data? {
+        var error: Unmanaged<CFError>?
+        if let encryptedData: CFData = SecKeyCreateEncryptedData(self.publicKey, CryptoCipherConstants.rsaAlgorithm, data as CFData, &error) {
+            if error != nil {
+                return nil
+            } else {
+                return encryptedData as Data
+            }
+        } else {
+            return nil
+        }
+    }
+    ///
+    /// Allows you to export the RSA public key to a format (so you can send over the net).
+    ///
+    public func export() -> Data? {
+        return publicKey.exportToData()
+    }
+    //
+
+    ///
+    /// Allows you to load an RSA public key (i.e. one downloaded from the net).
+    ///
+    public static func load(rsaPublicKeyData: Data) -> RSAPublicKey? {
+        if let publicKey: SecKey = .loadPublicFromData(rsaPublicKeyData) {
+            return RSAPublicKey(publicKey: publicKey)
+        } else {
+            return nil
+        }
+    }
+}
+///
+/// The RSA public key.
+///
+public struct RSAPrivateKey {
+    private let privateKey: SecKey
+
+    #if DEBUG
+    public var __debug_privateKey: SecKey { self.privateKey }
+    #endif
+
+    fileprivate init(privateKey: SecKey) {
+        self.privateKey = privateKey
+    }
+    ///
+    /// Takes the data and uses the private key to decrypt it.
+    /// Returns the decrypted data.
+    ///
+    public func decrypt(data: Data) -> Data? {
+        var error: Unmanaged<CFError>?
+        if let decryptedData: CFData = SecKeyCreateDecryptedData(self.privateKey, CryptoCipherConstants.rsaAlgorithm, data as CFData, &error) {
+            if error != nil {
+                return nil
+            } else {
+                return decryptedData as Data
+            }
+        } else {
+            return nil
+        }
+    }
+
+    ///
+    /// Allows you to export the RSA public key to a format (so you can send over the net).
+    ///
+    public func export() -> Data? {
+        return privateKey.exportToData()
+    }
+
+    ///
+    /// Allows you to load an RSA public key (i.e. one downloaded from the net).
+    ///
+    public static func load(rsaPrivateKey: String) -> RSAPrivateKey? {
+        var privKey: String = rsaPrivateKey
+        privKey = privKey.replacingOccurrences(of: "-----BEGIN RSA PRIVATE KEY-----", with: "")
+        privKey = privKey.replacingOccurrences(of: "-----END RSA PRIVATE KEY-----", with: "")
+        privKey = privKey.replacingOccurrences(of: "\\n+", with: "", options: .regularExpression)
+        privKey = privKey.trimmingCharacters(in: .whitespacesAndNewlines)
+        let rsaPrivateKeyData: Data = Data(base64Encoded: privKey)!
+        if let privateKey: SecKey = .loadPrivateFromData(rsaPrivateKeyData) {
+            return RSAPrivateKey(privateKey: privateKey)
+        } else {
+            return nil
+        }
+    }
+}
+
+fileprivate extension SecKey {
+    func exportToData() -> Data? {
+        var error: Unmanaged<CFError>?
+        if let cfData: CFData = SecKeyCopyExternalRepresentation(self, &error) {
+            if error != nil {
+                return nil
+            } else {
+                return cfData as Data
+            }
+        } else {
+            return nil
+        }
+    }
+    static func loadPublicFromData(_ data: Data) -> SecKey? {
+        let keyDict: [NSObject: NSObject] = [
+            kSecAttrKeyType: kSecAttrKeyTypeRSA,
+            kSecAttrKeyClass: kSecAttrKeyClassPublic,
+            kSecAttrKeySizeInBits: CryptoCipherConstants.rsaKeySizeInBits
+        ]
+        return SecKeyCreateWithData(data as CFData, keyDict as CFDictionary, nil)
+    }
+    static func loadPrivateFromData(_ data: Data) -> SecKey? {
+        let keyDict: [NSObject: NSObject] = [
+            kSecAttrKeyType: kSecAttrKeyTypeRSA,
+            kSecAttrKeyClass: kSecAttrKeyClassPrivate,
+            kSecAttrKeySizeInBits: CryptoCipherConstants.rsaKeySizeInBits
+        ]
+        return SecKeyCreateWithData(data as CFData, keyDict as CFDictionary, nil)
+    }
+}

package/ios/Plugin/DelayCondition.swift

@@ -0,0 +1,74 @@
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
+
+//
+//  DelayCondition.swift
+//  Plugin
+//
+//  Created by Luca Peruzzo on 12/09/22.
+//  Copyright © 2022 Capgo. All rights reserved.
+//
+
+import Foundation
+
+private func delayUntilNextValue(value: String) -> DelayUntilNext {
+    switch value {
+    case "background": return .background
+    case "kill": return .kill
+    case "nativeVersion": return .nativeVersion
+    case "date": return .date
+    default:
+        return .background
+    }
+}
+
+@objc public class DelayCondition: NSObject, Decodable, Encodable {
+    private let kind: DelayUntilNext
+    private let value: String?
+
+    convenience init(kind: String, value: String?) {
+        self.init(kind: delayUntilNextValue(value: kind), value: value)
+    }
+
+    init(kind: DelayUntilNext, value: String?) {
+        self.kind = kind
+        self.value = value
+    }
+
+    public required init(from decoder: Decoder) throws {
+        let values: KeyedDecodingContainer<DelayCondition.CodingKeys> = try decoder.container(keyedBy: CodingKeys.self)
+        kind = try values.decode(DelayUntilNext.self, forKey: .kind)
+        value = try values.decode(String.self, forKey: .value)
+    }
+
+    enum CodingKeys: String, CodingKey {
+        case kind, value
+    }
+
+    public func getKind() -> String {
+        return self.kind.description
+    }
+
+    public func getValue() -> String? {
+        return self.value
+    }
+
+    public func toJSON() -> [String: String] {
+        return [
+            "kind": self.getKind(),
+            "value": self.getValue() ?? ""
+        ]
+    }
+
+    public static func == (lhs: DelayCondition, rhs: DelayCondition) -> Bool {
+        return lhs.getKind() == rhs.getKind() && lhs.getValue() == rhs.getValue()
+    }
+
+    public func toString() -> String {
+        return "{ \"kind\": \"\(self.getKind())\", \"value\": \"\(self.getValue() ?? "")\"}"
+    }
+
+}

package/ios/Plugin/DelayUntilNext.swift

@@ -0,0 +1,30 @@
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
+
+//
+//  DelayUntilNext.swift
+//  Plugin
+//
+//  Created by Luca Peruzzo on 12/09/22.
+//  Copyright © 2022 Capgo. All rights reserved.
+//
+
+import Foundation
+enum DelayUntilNext: Decodable, Encodable, CustomStringConvertible {
+    case background
+    case kill
+    case nativeVersion
+    case date
+
+    var description: String {
+        switch self {
+        case .background: return "background"
+        case .kill: return "kill"
+        case .nativeVersion: return "nativeVersion"
+        case .date: return "date"
+        }
+    }
+}

package/ios/Plugin/UserDefaultsExtension.swift

@@ -0,0 +1,48 @@
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
+
+import Foundation
+
+protocol ObjectSavable {
+    func setObj<Object>(_ object: Object, forKey: String) throws where Object: Encodable
+    func getObj<Object>(forKey: String, castTo type: Object.Type) throws -> Object where Object: Decodable
+}
+
+enum ObjectSavableError: String, LocalizedError {
+    case unableToEncode = "Unable to encode object into data"
+    case noValue = "No data object found for the given key"
+    case unableToDecode = "Unable to decode object into given type"
+    case checksum = "Checksum failed"
+
+    var errorDescription: String? {
+        rawValue
+    }
+}
+
+extension UserDefaults: ObjectSavable {
+    func setObj<Object>(_ object: Object, forKey: String) throws where Object: Encodable {
+        let encoder: JSONEncoder = JSONEncoder()
+        do {
+            let data: Data = try encoder.encode(object)
+            set(data, forKey: forKey)
+        } catch {
+            throw ObjectSavableError.unableToEncode
+        }
+    }
+
+    func getObj<Object>(forKey: String, castTo type: Object.Type) throws -> Object where Object: Decodable {
+        // print("forKey", forKey)
+        guard let data: Data = data(forKey: forKey) else { throw ObjectSavableError.noValue }
+        // print("data", data)
+        let decoder: JSONDecoder = JSONDecoder()
+        do {
+            let object: Object = try decoder.decode(type, from: data)
+            return object
+        } catch {
+            throw ObjectSavableError.unableToDecode
+        }
+    }
+}

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@capgo/capacitor-updater",
-  "version": "5.0.0-alpha.0",
-  "license": "AGPL-3.0-only",
-  "description": "OTA update for capacitor apps",
+  "version": "7.0.0",
+  "packageManager": "pnpm@8.5.1",
+  "license": "MPL-2.0",
+  "description": "Live update for capacitor apps",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
   "types": "dist/esm/index.d.ts",
@@ -40,35 +41,40 @@
     "verify:android": "cd android && ./gradlew clean build test && cd ..",
     "verify:web": "npm run build",
     "lint": "npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint",
-    "fmt": "npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- autocorrect --format",
+    "fmt": "npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --autocorrect --format",
     "eslint": "eslint . --ext ts",
-    "prettier": "prettier \"**/*.{css,html,ts,js,java}\"",
+    "prettier": "prettier --config .prettierrc.js \"**/*.{css,html,ts,js,java}\"",
     "swiftlint": "node-swiftlint",
     "docgen": "docgen --api CapacitorUpdaterPlugin --output-readme README.md --output-json dist/docs.json",
-    "build": "npm run clean && npm run docgen && tsc && rollup -c rollup.config.js",
+    "docgen:api": "docgen --api CapacitorUpdaterPlugin --output-readme api.md --output-json dist/docs.json && awk '{sub(/###/,\"##\")}1' api.md > temp.txt && mv temp.txt api.md",
+    "build": "npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs",
     "clean": "rimraf ./dist",
     "watch": "tsc --watch",
     "prepublishOnly": "npm run build"
   },
   "devDependencies": {
-    "@capacitor/android": "^3.4.3",
-    "@capacitor/core": "^3.4.3",
-    "@capacitor/cli": "^3.4.3",
-    "@capacitor/docgen": "^0.1.1",
-    "@capacitor/ios": "^3.4.3",
+    "@capacitor/android": "^5.0.3",
+    "@capacitor/cli": "^5.0.3",
+    "@capacitor/core": "^5.0.3",
+    "@capacitor/docgen": "^0.2.1",
+    "@capacitor/ios": "^5.0.3",
     "@ionic/eslint-config": "^0.3.0",
-    "@ionic/prettier-config": "^2.0.0",
+    "@ionic/prettier-config": "^3.0.0",
     "@ionic/swiftlint-config": "^1.1.2",
-    "eslint": "^7.32.0",
-    "prettier": "^2.5.1",
-    "prettier-plugin-java": "^1.6.1",
-    "rimraf": "^3.0.2",
-    "rollup": "^2.70.0",
-    "swiftlint": "^1.0.1",
-    "typescript": "^4.6.2"
+    "@types/node": "^20.2.3",
+    "@typescript-eslint/eslint-plugin": "^5.59.7",
+    "@typescript-eslint/parser": "^5.59.7",
+    "eslint": "^8.41.0",
+    "eslint-plugin-import": "^2.27.5",
+    "prettier": "^2.8.8",
+    "prettier-plugin-java": "^2.1.0",
+    "rimraf": "^5.0.1",
+    "rollup": "^3.23.0",
+    "swiftlint": "^1.0.2",
+    "typescript": "^5.0.4"
   },
   "peerDependencies": {
-    "@capacitor/core": "^3.0.0"
+    "@capacitor/core": "^5.0.0"
   },
   "prettier": "@ionic/prettier-config",
   "swiftlint": "@ionic/swiftlint-config",

package/ios/Plugin/ObjectPreferences.swift

@@ -1,97 +0,0 @@
-import Foundation
-
-protocol ObjectSavable {
-    func setObj<Object>(_ object: Object, forKey: String) throws where Object: Encodable
-    func getObj<Object>(forKey: String, castTo type: Object.Type) throws -> Object where Object: Decodable
-}
-
-enum ObjectSavableError: String, LocalizedError {
-    case unableToEncode = "Unable to encode object into data"
-    case noValue = "No data object found for the given key"
-    case unableToDecode = "Unable to decode object into given type"
-
-    var errorDescription: String? {
-        rawValue
-    }
-}
-
-extension UserDefaults: ObjectSavable {
-    func setObj<Object>(_ object: Object, forKey: String) throws where Object: Encodable {
-        let encoder = JSONEncoder()
-        do {
-            let data = try encoder.encode(object)
-            set(data, forKey: forKey)
-        } catch {
-            throw ObjectSavableError.unableToEncode
-        }
-    }
-
-    func getObj<Object>(forKey: String, castTo type: Object.Type) throws -> Object where Object: Decodable {
-        print("forKey", forKey)
-        guard let data = data(forKey: forKey) else { throw ObjectSavableError.noValue }
-        print("data", data)
-        let decoder = JSONDecoder()
-        do {
-            let object = try decoder.decode(type, from: data)
-            return object
-        } catch {
-            throw ObjectSavableError.unableToDecode
-        }
-    }
-}
-
-//
-//// MARK: - Methods
-//public extension UserDefaults {
-//    /// SwifterSwift: get object from UserDefaults by using subscript.
-//    ///
-//    /// - Parameter key: key in the current user's defaults database.
-//    subscript(key: String) -> Any? {
-//        get {
-//            return object(forKey: key)
-//        }
-//        set {
-//            set(newValue, forKey: key)
-//        }
-//    }
-//
-//    /// SwifterSwift: Float from UserDefaults.
-//    ///
-//    /// - Parameter key: key to find float for.
-//    /// - Returns: Float object for key (if exists).
-//    func float(forKey key: String) -> Float? {
-//        return object(forKey: key) as? Float
-//    }
-//
-//    /// SwifterSwift: Date from UserDefaults.
-//    ///
-//    /// - Parameter key: key to find date for.
-//    /// - Returns: Date object for key (if exists).
-//    func date(forKey key: String) -> Date? {
-//        return object(forKey: key) as? Date
-//    }
-//
-//    /// SwifterSwift: Retrieves a Codable object from UserDefaults.
-//    ///
-//    /// - Parameters:
-//    ///   - type: Class that conforms to the Codable protocol.
-//    ///   - key: Identifier of the object.
-//    ///   - decoder: Custom JSONDecoder instance. Defaults to `JSONDecoder()`.
-//    /// - Returns: Codable object for key (if exists).
-//    func object<T: Codable>(_ type: T.Type, with key: String, usingDecoder decoder: JSONDecoder = JSONDecoder()) -> T? {
-//        guard let data = value(forKey: key) as? Data else { return nil }
-//        return try? decoder.decode(type.self, from: data)
-//    }
-//
-//    /// SwifterSwift: Allows storing of Codable objects to UserDefaults.
-//    ///
-//    /// - Parameters:
-//    ///   - object: Codable object to store.
-//    ///   - key: Identifier of the object.
-//    ///   - encoder: Custom JSONEncoder instance. Defaults to `JSONEncoder()`.
-//    func set<T: Codable>(object: T, forKey key: String, usingEncoder encoder: JSONEncoder = JSONEncoder()) {
-//        let data = try? encoder.encode(object)
-//        set(data, forKey: key)
-//    }
-//}
-//