@capgo/capacitor-updater 4.11.12 → 4.12.2

package/CapgoCapacitorUpdater.podspec

@@ -16,5 +16,6 @@ Pod::Spec.new do |s|
   s.dependency 'SSZipArchive'
   s.dependency 'Alamofire'
   s.dependency 'Version'
+  s.dependency 'SwiftyRSA'
   s.swift_version = '5.1'
 end

package/android/src/main/java/ee/forgr/capacitor_updater/CapacitorUpdater.java

@@ -1,5 +1,7 @@
 package ee.forgr.capacitor_updater;
 
+import static ee.forgr.capacitor_updater.RSACipher.stringToPrivateKey;
+
 import android.content.SharedPreferences;
 import android.os.Build;
 import android.util.Log;
@@ -9,6 +11,7 @@ import com.android.volley.Response;
 import com.android.volley.VolleyError;
 import com.android.volley.toolbox.JsonObjectRequest;
 import com.getcapacitor.JSObject;
+import com.getcapacitor.android.BuildConfig;
 import com.getcapacitor.plugin.WebView;
 import java.io.BufferedInputStream;
 import java.io.DataInputStream;
@@ -21,6 +24,9 @@ import java.io.IOException;
 import java.io.InputStream;
 import java.net.URL;
 import java.net.URLConnection;
+import java.security.InvalidKeyException;
+import java.security.NoSuchAlgorithmException;
+import java.security.PrivateKey;
 import java.security.SecureRandom;
 import java.util.ArrayList;
 import java.util.Date;
@@ -29,6 +35,9 @@ import java.util.List;
 import java.util.zip.CRC32;
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipInputStream;
+import javax.crypto.BadPaddingException;
+import javax.crypto.IllegalBlockSizeException;
+import javax.crypto.NoSuchPaddingException;
 import org.json.JSONException;
 import org.json.JSONObject;
 
@@ -52,7 +61,7 @@ public class CapacitorUpdater {
     private static final String bundleDirectory = "versions";
 
     public static final String TAG = "Capacitor-updater";
-    public static final String pluginVersion = "4.11.12";
+    public static final String pluginVersion = "4.12.2";
 
     public SharedPreferences.Editor editor;
     public SharedPreferences prefs;
@@ -68,6 +77,7 @@ public class CapacitorUpdater {
     public String statsUrl = "";
     public String channelUrl = "";
     public String appId = "";
+    public String privateKey = "";
     public String deviceID = "";
 
     private final FilenameFilter filter = new FilenameFilter() {
@@ -254,6 +264,44 @@ public class CapacitorUpdater {
         return enc.toLowerCase();
     }
 
+    private void decodeFile(File file) throws IOException {
+        if (this.privateKey.equals("")) {
+            return;
+        }
+        try {
+            PrivateKey pKey = RSACipher.stringToPrivateKey(this.privateKey);
+            FileInputStream fis = new FileInputStream(file.getAbsolutePath());
+            byte[] buffer = new byte[10];
+            StringBuilder sb = new StringBuilder();
+            while (fis.read(buffer) != -1) {
+                sb.append(new String(buffer));
+                buffer = new byte[10];
+            }
+            fis.close();
+            String content = sb.toString();
+            String decrypted = RSACipher.decryptRSA(content, pKey);
+            // write the decrypted string to the file
+            FileOutputStream fos = new FileOutputStream(file.getAbsolutePath());
+            fos.write(decrypted.getBytes());
+            fos.close();
+        } catch (NoSuchPaddingException e) {
+            e.printStackTrace();
+            throw new IOException("NoSuchPaddingException");
+        } catch (IllegalBlockSizeException e) {
+            e.printStackTrace();
+            throw new IOException("IllegalBlockSizeException");
+        } catch (NoSuchAlgorithmException e) {
+            e.printStackTrace();
+            throw new IOException("NoSuchAlgorithmException");
+        } catch (BadPaddingException e) {
+            e.printStackTrace();
+            throw new IOException("BadPaddingException");
+        } catch (InvalidKeyException e) {
+            e.printStackTrace();
+            throw new IOException("InvalidKeyException");
+        }
+    }
+
     public BundleInfo download(final String url, final String version) throws IOException {
         final String id = this.randomString(10);
         this.saveBundleInfo(id, new BundleInfo(id, version, BundleStatus.DOWNLOADING, new Date(System.currentTimeMillis()), ""));
@@ -262,6 +310,7 @@ public class CapacitorUpdater {
         this.notifyDownload(id, 5);
         final File downloaded = this.downloadFile(id, url, this.randomString(10));
         final String checksum = this.getChecksum(downloaded);
+        this.decodeFile(downloaded);
         this.notifyDownload(id, 71);
         final File unzipped = this.unzip(id, downloaded, this.randomString(10));
         downloaded.delete();
@@ -420,7 +469,7 @@ public class CapacitorUpdater {
                 new Response.ErrorListener() {
                     @Override
                     public void onErrorResponse(VolleyError error) {
-                        Log.e(TAG, "Error getting Latest", error);
+                        Log.e(TAG, "Error getting Latest" + error.toString());
                     }
                 }
             );
@@ -467,7 +516,7 @@ public class CapacitorUpdater {
                 new Response.ErrorListener() {
                     @Override
                     public void onErrorResponse(VolleyError error) {
-                        Log.e(TAG, "Error set channel: " + error);
+                        Log.e(TAG, "Error set channel: " + error.toString());
                     }
                 }
             );
@@ -513,7 +562,7 @@ public class CapacitorUpdater {
                 new Response.ErrorListener() {
                     @Override
                     public void onErrorResponse(VolleyError error) {
-                        Log.e(TAG, "Error get channel: " + error);
+                        Log.e(TAG, "Error get channel: " + error.toString());
                     }
                 }
             );
@@ -547,7 +596,7 @@ public class CapacitorUpdater {
                 new Response.ErrorListener() {
                     @Override
                     public void onErrorResponse(VolleyError error) {
-                        Log.e(TAG, "Error sending stats: " + error);
+                        Log.e(TAG, "Error sending stats: " + error.toString());
                     }
                 }
             );

package/android/src/main/java/ee/forgr/capacitor_updater/CapacitorUpdaterPlugin.java

@@ -88,6 +88,7 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
 
         final CapConfig config = CapConfig.loadDefault(this.getActivity());
         this.implementation.appId = config.getString("appId", "");
+        this.implementation.privateKey = this.getConfig().getString("privateKey", "");
         this.implementation.statsUrl = this.getConfig().getString("statsUrl", statsUrlDefault);
         this.implementation.channelUrl = this.getConfig().getString("channelUrl", channelUrlDefault);
         this.implementation.documentsDir = this.getContext().getFilesDir();
@@ -771,6 +772,10 @@ public class CapacitorUpdaterPlugin extends Plugin implements Application.Activi
                                                                     CapacitorUpdater.TAG,
                                                                     "Error checksum " + next.getChecksum() + " " + checksum
                                                                 );
+                                                                CapacitorUpdaterPlugin.this.implementation.sendStats(
+                                                                        "checksum_fail",
+                                                                        current.getVersionName()
+                                                                    );
                                                                 final Boolean res =
                                                                     CapacitorUpdaterPlugin.this.implementation.delete(next.getId());
                                                                 if (res) {

package/android/src/main/java/ee/forgr/capacitor_updater/RSACipher.java

@@ -0,0 +1,57 @@
+package ee.forgr.capacitor_updater;
+
+/**
+ * Created by Awesometic
+ * It's encrypt returns Base64 encoded, and also decrypt for Base64 encoded cipher
+ * references: http://stackoverflow.com/questions/12471999/rsa-encryption-decryption-in-android
+ */
+import android.util.Base64;
+import java.security.InvalidKeyException;
+import java.security.KeyFactory;
+import java.security.NoSuchAlgorithmException;
+import java.security.PrivateKey;
+import java.security.spec.InvalidKeySpecException;
+import java.security.spec.PKCS8EncodedKeySpec;
+import javax.crypto.BadPaddingException;
+import javax.crypto.Cipher;
+import javax.crypto.IllegalBlockSizeException;
+import javax.crypto.NoSuchPaddingException;
+
+public class RSACipher {
+
+    public static String decryptRSA(String source, PrivateKey privateKey)
+        throws NoSuchAlgorithmException, NoSuchPaddingException, InvalidKeyException, IllegalBlockSizeException, BadPaddingException {
+        Cipher cipher = Cipher.getInstance("RSA/ECB/OAEPWithSHA1AndMGF1Padding");
+        cipher.init(Cipher.DECRYPT_MODE, privateKey);
+        byte[] decryptedBytes = cipher.doFinal(Base64.decode(source, Base64.DEFAULT));
+        String decrypted = new String(decryptedBytes);
+
+        return decrypted;
+    }
+
+    public static PrivateKey stringToPrivateKey(String private_key)
+        throws NoSuchAlgorithmException, NoSuchPaddingException, InvalidKeyException, IllegalBlockSizeException, BadPaddingException {
+        try {
+            // Remove the "BEGIN" and "END" lines, as well as any whitespace
+            String pkcs8Pem = private_key.toString();
+            pkcs8Pem = pkcs8Pem.replace("-----BEGIN PRIVATE KEY-----", "");
+            pkcs8Pem = pkcs8Pem.replace("-----END PRIVATE KEY-----", "");
+            pkcs8Pem = pkcs8Pem.replaceAll("\\s+", "");
+
+            // Base64 decode the result
+
+            byte[] pkcs8EncodedBytes = Base64.decode(pkcs8Pem, Base64.DEFAULT);
+
+            // extract the private key
+
+            PKCS8EncodedKeySpec keySpec = new PKCS8EncodedKeySpec(pkcs8EncodedBytes);
+            KeyFactory kf = KeyFactory.getInstance("RSA");
+            PrivateKey privKey = kf.generatePrivate(keySpec);
+            return privKey;
+        } catch (NoSuchAlgorithmException | InvalidKeySpecException e) {
+            e.printStackTrace();
+
+            return null;
+        }
+    }
+}

package/dist/docs.json

@@ -1442,6 +1442,18 @@
           "docs": "Configure the URL / endpoint to which update statistics are sent.\n\nOnly available for Android and iOS. Set to \"\" to disable stats reporting.",
           "complexTypes": [],
           "type": "string | undefined"
+        },
+        {
+          "name": "privateKey",
+          "tags": [
+            {
+              "text": "undefined",
+              "name": "default"
+            }
+          ],
+          "docs": "Configure the private key for end to end live update encryption.\n\nOnly available for Android and iOS.",
+          "complexTypes": [],
+          "type": "string | undefined"
         }
       ],
       "docs": "These configuration values are available:"

package/dist/esm/definitions.d.ts

@@ -68,6 +68,14 @@ declare module '@capacitor/cli' {
              * @example https://example.com/api/stats
              */
             statsUrl?: string;
+            /**
+             * Configure the private key for end to end live update encryption.
+             *
+             * Only available for Android and iOS.
+             *
+             * @default undefined
+             */
+            privateKey?: string;
         };
     }
 }

package/ios/Plugin/CapacitorUpdater.swift

@@ -2,6 +2,7 @@ import Foundation
 import SSZipArchive
 import Alamofire
 import zlib
+import SwiftyRSA
 
 extension URL {
     var isDirectory: Bool {
@@ -151,6 +152,8 @@ extension String {
 enum CustomError: Error {
     // Throw when an unzip fail
     case cannotUnzip
+    case cannotWrite
+    case cannotDecode
     case cannotUnflat
     case cannotCreateDirectory
     case cannotDeleteDirectory
@@ -187,6 +190,16 @@ extension CustomError: LocalizedError {
                 "An unexpected error occurred.",
                 comment: "Unexpected Error"
             )
+        case .cannotDecode:
+            return NSLocalizedString(
+                "Decoding the zip failed with this key",
+                comment: "Invalid private key"
+            )
+        case .cannotWrite:
+            return NSLocalizedString(
+                "Cannot write to the destination",
+                comment: "Invalid destination"
+            )
         }
     }
 }
@@ -208,11 +221,12 @@ extension CustomError: LocalizedError {
     public let TAG = "✨  Capacitor-updater:"
     public let CAP_SERVER_PATH = "serverBasePath"
     public var customId = ""
-    public let pluginVersion = "4.11.12"
+    public let pluginVersion = "4.12.2"
     public var statsUrl = ""
     public var channelUrl = ""
     public var appId = ""
     public var deviceID = UIDevice.current.identifierForVendor?.uuidString ?? ""
+    public var privateKey = ""
 
     public var notifyDownload: (String, Int) -> Void = { _, _  in }
 
@@ -311,6 +325,23 @@ extension CustomError: LocalizedError {
         }
     }
 
+    private func decodeFile(filePath: URL) throws {
+        if self.privateKey == "" {
+            return
+        }
+        do {
+            let privateKey = try PrivateKey(base64Encoded: self.privateKey)
+            let base64String = try Data(contentsOf: filePath).base64EncodedString()
+            let encrypted = try EncryptedMessage(base64Encoded: base64String)
+            let clear = try encrypted.decrypted(with: privateKey, padding: .PKCS1)
+            let str = try clear.string(encoding: String.Encoding.utf8)
+            try str.write(to: filePath, atomically: true, encoding: String.Encoding.utf8)
+        } catch {
+            print("\(self.TAG) Cannot decode: \(filePath.path)", error)
+            throw CustomError.cannotDecode
+        }
+    }
+
     private func saveDownloaded(sourceZip: URL, id: String, base: URL) throws {
         try prepareFolder(source: base)
         let destHot = base.appendingPathComponent(id)
@@ -405,6 +436,7 @@ extension CustomError: LocalizedError {
                     self.notifyDownload(id, 71)
                     do {
                         checksum = self.getChecksum(filePath: fileURL)
+                        try self.decodeFile(filePath: fileURL)
                         try self.saveDownloaded(sourceZip: fileURL, id: id, base: self.documentsDir.appendingPathComponent(self.bundleDirectoryHot))
                         self.notifyDownload(id, 85)
                         try self.saveDownloaded(sourceZip: fileURL, id: id, base: self.libraryDir.appendingPathComponent(self.bundleDirectory))

package/ios/Plugin/CapacitorUpdaterPlugin.swift

@@ -39,7 +39,7 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
         appReadyTimeout = getConfig().getInt("appReadyTimeout", 10000)
         resetWhenUpdate = getConfig().getBoolean("resetWhenUpdate", true)
 
-        implementation.appId = Bundle.main.bundleIdentifier ?? ""
+        implementation.privateKey = getConfig().getString("privateKey", "")!
         implementation.notifyDownload = notifyDownload
         let config = (self.bridge?.viewController as? CAPBridgeViewController)?.instanceDescriptor().legacyConfig
         if config?["appId"] != nil {
@@ -85,8 +85,7 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
         if percent == 100 {
             self.notifyListeners("downloadComplete", data: ["bundle": bundle.toJSON()])
             self.implementation.sendStats(action: "download_complete", versionName: bundle.getVersionName())
-        }
-        else if percent.isMultiple(of: 10) {
+        } else if percent.isMultiple(of: 10) {
             self.implementation.sendStats(action: "download_\(percent)", versionName: bundle.getVersionName())
         }
     }
@@ -513,6 +512,7 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
                         let next = try self.implementation.download(url: downloadUrl, version: latestVersionName)
                         if res.checksum != "" && next.getChecksum() != res.checksum {
                             print("\(self.implementation.TAG) Error checksum", next.getChecksum(), res.checksum)
+                            self.implementation.sendStats(action: "checksum_fail", versionName: next.getVersionName())
                             let resDel = self.implementation.delete(id: next.getId())
                             if !resDel {
                                 print("\(self.implementation.TAG) Delete failed, id \(next.getId()) doesn't exist")

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/capacitor-updater",
-  "version": "4.11.12",
+  "version": "4.12.2",
   "license": "LGPL-3.0-only",
   "description": "OTA update for capacitor apps",
   "main": "dist/plugin.cjs.js",