npm - @capgo/capacitor-updater - Versions diffs - 6.0.69 → 6.0.70 - Mend

@capgo/capacitor-updater 6.0.69 → 6.0.70

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (12) hide show

package/CapgoCapacitorUpdater.podspec +1 -0
package/README.md +5 -1
package/android/src/main/java/ee/forgr/capacitor_updater/CapacitorUpdater.java +137 -41
package/android/src/main/java/ee/forgr/capacitor_updater/CapacitorUpdaterPlugin.java +29 -4
package/android/src/main/java/ee/forgr/capacitor_updater/CryptoCipher.java +20 -0
package/android/src/main/java/ee/forgr/capacitor_updater/DownloadService.java +23 -2
package/dist/docs.json +32 -0
package/dist/esm/definitions.d.ts +15 -0
package/dist/esm/definitions.js.map +1 -1
package/ios/Plugin/CapacitorUpdater.swift +81 -4
package/ios/Plugin/CapacitorUpdaterPlugin.swift +26 -3
package/package.json +1 -1

package/CapgoCapacitorUpdater.podspec CHANGED Viewed

@@ -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/README.md CHANGED Viewed

@@ -218,6 +218,7 @@ CapacitorUpdater can be configured with these options:
 | **`localSupaAnon`**      | <code>string</code>  | Configure the CLI to use a local server for testing.                                                                                                                                            | <code>undefined</code>                     | 4.17.48 |
 | **`allowModifyUrl`**     | <code>boolean</code> | Allow the plugin to modify the updateUrl, statsUrl and channelUrl dynamically from the JavaScript side.                                                                                         | <code>false</code>                         | 5.4.0   |
 | **`defaultChannel`**     | <code>string</code>  | Set the default channel for the app in the config.                                                                                                                                              | <code>undefined</code>                     | 5.5.0   |
+| **`signKey`**            | <code>string</code>  | Public key used for bundle signing.                                                                                                                                                             | <code>undefined</code>                     | 6.1.0   |
 ### Examples
@@ -245,7 +246,8 @@ In `capacitor.config.json`:
       "localSupa": undefined,
       "localSupaAnon": undefined,
       "allowModifyUrl": undefined,
-      "defaultChannel": undefined
+      "defaultChannel": undefined,
+      "signKey": undefined
     }
   }
 }
@@ -280,6 +282,7 @@ const config: CapacitorConfig = {
       localSupaAnon: undefined,
       allowModifyUrl: undefined,
       defaultChannel: undefined,
+      signKey: undefined,
     },
   },
 };
@@ -934,6 +937,7 @@ Listen for app ready event in the App, let you know when app is ready to use
 | **`version`**    | <code>string</code> | The version code/name of this bundle/version                                                                                                                     |                        |       |
 | **`sessionKey`** | <code>string</code> | The session key for the update                                                                                                                                   | <code>undefined</code> | 4.0.0 |
 | **`checksum`**   | <code>string</code> | The checksum for the update                                                                                                                                      | <code>undefined</code> | 4.0.0 |
+| **`signature`**  | <code>string</code> | The signature of the update. Can be generated using capgo CLI                                                                                                    | <code>undefined</code> | 6.1.0 |
 #### BundleId

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

@@ -40,9 +40,13 @@ import java.io.InputStream;
 import java.io.UnsupportedEncodingException;
 import java.net.URL;
 import java.net.URLConnection;
+import java.nio.charset.StandardCharsets;
 import java.security.GeneralSecurityException;
+import java.security.MessageDigest;
 import java.security.PrivateKey;
+import java.security.PublicKey;
 import java.security.SecureRandom;
+import java.security.Signature;
 import java.util.ArrayList;
 import java.util.Date;
 import java.util.Iterator;
@@ -51,6 +55,7 @@ import java.util.Objects;
 import java.util.zip.CRC32;
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipInputStream;
+import javax.crypto.Cipher;
 import javax.crypto.SecretKey;
 import org.json.JSONException;
 import org.json.JSONObject;
@@ -89,6 +94,7 @@ public class CapacitorUpdater {
   public String privateKey = "";
   public String deviceID = "";
   public int timeout = 20000;
+  public PublicKey signKey = null;
   private final FilenameFilter filter = (f, name) -> {
     // ignore directories generated by mac os x
@@ -283,6 +289,7 @@ public class CapacitorUpdater {
           String sessionKey = bundle.getString(DownloadService.SESSIONKEY);
           String checksum = bundle.getString(DownloadService.CHECKSUM);
           String error = bundle.getString(DownloadService.ERROR);
+          String signature = bundle.getString(DownloadService.SIGNATURE);
           Log.i(
             CapacitorUpdater.TAG,
             "res " +
@@ -296,6 +303,8 @@ public class CapacitorUpdater {
             " " +
             checksum +
             " " +
+            signature +
+            " " +
             error
           );
           if (dest == null) {
@@ -318,6 +327,7 @@ public class CapacitorUpdater {
               version,
               sessionKey,
               checksum,
+              signature,
               true
             );
         } else {
@@ -333,14 +343,63 @@ public class CapacitorUpdater {
     String version,
     String sessionKey,
     String checksumRes,
+    String signature,
     Boolean setNext
   ) {
+    File downloaded = null;
+    String checksum;
     try {
-      final File downloaded = new File(this.documentsDir, dest);
+      this.notifyDownload(id, 71);
+      downloaded = new File(this.documentsDir, dest);
+      boolean valid = verifyBundleSignature(version, downloaded, signature);
+      if (!valid) {
+        Log.e(
+          CapacitorUpdater.TAG,
+          "Invalid signature, cannot accept download"
+        );
+        this.sendStats("invalid_signature", version);
+        throw new GeneralSecurityException(
+          "Signature is not valid, cannot accept update"
+        );
+      } else {
+        Log.i(CapacitorUpdater.TAG, "Valid signature");
+      }
       this.decryptFile(downloaded, sessionKey, version);
-      final String checksum;
       checksum = this.calcChecksum(downloaded);
-      this.notifyDownload(id, 71);
+      if (
+        checksumRes != null &&
+        !checksumRes.isEmpty() &&
+        !checksumRes.equals(checksum)
+      ) {
+        Log.e(
+          CapacitorUpdater.TAG,
+          "Error checksum " + checksumRes + " " + checksum
+        );
+        this.sendStats("checksum_fail");
+        throw new IOException("Checksum failed: " + id);
+      }
+    } catch (IOException | GeneralSecurityException e) {
+      final Boolean res = this.delete(id);
+      if (!res) {
+        Log.i(CapacitorUpdater.TAG, "Double error, cannot cleanup: " + version);
+      }
+      final JSObject ret = new JSObject();
+      ret.put(
+        "version",
+        CapacitorUpdater.this.getCurrentBundle().getVersionName()
+      );
+      CapacitorUpdater.this.notifyListeners("downloadFailed", ret);
+      CapacitorUpdater.this.sendStats("download_fail");
+      return false;
+    }
+    try {
       final File unzipped = this.unzip(id, downloaded, this.randomString());
       downloaded.delete();
       this.notifyDownload(id, 91);
@@ -356,25 +415,7 @@ public class CapacitorUpdater {
         checksum
       );
       this.saveBundleInfo(id, next);
-      if (
-        checksumRes != null &&
-        !checksumRes.isEmpty() &&
-        !checksumRes.equals(checksum)
-      ) {
-        Log.e(
-          CapacitorUpdater.TAG,
-          "Error checksum " + checksumRes + " " + checksum
-        );
-        this.sendStats("checksum_fail");
-        final Boolean res = this.delete(id);
-        if (res) {
-          Log.i(
-            CapacitorUpdater.TAG,
-            "Failed bundle deleted: " + next.getVersionName()
-          );
-        }
-        throw new IOException("Checksum failed: " + id);
-      }
       final JSObject ret = new JSObject();
       ret.put("bundle", next.toJSON());
       CapacitorUpdater.this.notifyListeners("updateAvailable", ret);
@@ -406,7 +447,8 @@ public class CapacitorUpdater {
     final String version,
     final String sessionKey,
     final String checksum,
-    final String dest
+    final String dest,
+    final String signature
   ) {
     Intent intent = new Intent(this.activity, DownloadService.class);
     intent.putExtra(DownloadService.URL, url);
@@ -419,6 +461,7 @@ public class CapacitorUpdater {
     intent.putExtra(DownloadService.VERSION, version);
     intent.putExtra(DownloadService.SESSIONKEY, sessionKey);
     intent.putExtra(DownloadService.CHECKSUM, checksum);
+    intent.putExtra(DownloadService.SIGNATURE, signature);
     this.activity.startService(intent);
   }
@@ -502,6 +545,47 @@ public class CapacitorUpdater {
     }
   }
+  private boolean verifyBundleSignature(
+    final String version,
+    final File file,
+    final String signatureStr
+  ) throws GeneralSecurityException, IOException {
+    if (this.signKey == null) {
+      Log.i(TAG, "Signing not configured");
+      return true;
+    }
+    if (signatureStr.isEmpty()) {
+      Log.i(TAG, "Signature required but none provided");
+      this.sendStats("signature_not_provided", version);
+      throw new GeneralSecurityException(
+        "Signature was required but none was provided"
+      );
+    }
+    byte[] providedSignatureBytes = Base64.decode(
+      signatureStr.getBytes(StandardCharsets.UTF_8),
+      Base64.DEFAULT
+    );
+    Signature signature = Signature.getInstance("SHA512withRSA");
+    signature.initVerify(this.signKey);
+    byte[] content = new byte[(int) file.length()];
+    try (
+      final FileInputStream fis = new FileInputStream(file);
+      final BufferedInputStream bis = new BufferedInputStream(fis);
+      final DataInputStream dis = new DataInputStream(bis)
+    ) {
+      dis.readFully(content);
+      dis.close();
+      signature.update(content);
+      return signature.verify(providedSignatureBytes);
+    }
+  }
   private void decryptFile(
     final File file,
     final String ivSessionKey,
@@ -560,7 +644,8 @@ public class CapacitorUpdater {
     final String url,
     final String version,
     final String sessionKey,
-    final String checksum
+    final String checksum,
+    final String signature
   ) {
     final String id = this.randomString();
     this.saveBundleInfo(
@@ -581,7 +666,8 @@ public class CapacitorUpdater {
         version,
         sessionKey,
         checksum,
-        this.randomString()
+        this.randomString(),
+        signature
       );
   }
@@ -589,7 +675,8 @@ public class CapacitorUpdater {
     final String url,
     final String version,
     final String sessionKey,
-    final String checksum
+    final String checksum,
+    final String signature
   ) throws IOException {
     final String id = this.randomString();
     this.saveBundleInfo(
@@ -607,7 +694,15 @@ public class CapacitorUpdater {
     final String dest = this.randomString();
     this.downloadFile(id, url, dest);
     final Boolean finished =
-      this.finishDownload(id, dest, version, sessionKey, checksum, false);
+      this.finishDownload(
+          id,
+          dest,
+          version,
+          sessionKey,
+          checksum,
+          signature,
+          false
+        );
     final BundleStatus status = finished
       ? BundleStatus.PENDING
       : BundleStatus.ERROR;
@@ -659,8 +754,17 @@ public class CapacitorUpdater {
     return false;
   }
-  public Boolean delete(final String id) throws IOException {
-    return this.delete(id, true);
+  public Boolean delete(final String id) {
+    try {
+      return this.delete(id, true);
+    } catch (IOException e) {
+      e.printStackTrace();
+      Log.i(
+        CapacitorUpdater.TAG,
+        "Failed to delete bundle (" + id + ")" + "\nError:\n" + e.toString()
+      );
+      return false;
+    }
   }
   private File getBundleDirectory(final String id) {
@@ -725,19 +829,11 @@ public class CapacitorUpdater {
       "Version successfully loaded: " + bundle.getVersionName()
     );
     if (autoDeletePrevious && !fallback.isBuiltin()) {
-      try {
-        final Boolean res = this.delete(fallback.getId());
-        if (res) {
-          Log.i(
-            CapacitorUpdater.TAG,
-            "Deleted previous bundle: " + fallback.getVersionName()
-          );
-        }
-      } catch (final IOException e) {
-        Log.e(
+      final Boolean res = this.delete(fallback.getId());
+      if (res) {
+        Log.i(
           CapacitorUpdater.TAG,
-          "Failed to delete previous bundle: " + fallback.getVersionName(),
-          e
+          "Deleted previous bundle: " + fallback.getVersionName()
         );
       }
     }

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

@@ -30,6 +30,7 @@ import java.io.IOException;
 import java.lang.reflect.Type;
 import java.net.MalformedURLException;
 import java.net.URL;
+import java.security.PublicKey;
 import java.text.SimpleDateFormat;
 import java.util.ArrayList;
 import java.util.Date;
@@ -55,7 +56,7 @@ public class CapacitorUpdaterPlugin extends Plugin {
   private static final String channelUrlDefault =
     "https://api.capgo.app/channel_self";
-  private final String PLUGIN_VERSION = "6.0.69";
+  private final String PLUGIN_VERSION = "6.0.70";
   private static final String DELAY_CONDITION_PREFERENCES = "";
   private SharedPreferences.Editor editor;
@@ -137,6 +138,13 @@ public class CapacitorUpdaterPlugin extends Plugin {
       this.implementation.requestQueue = Volley.newRequestQueue(
         this.getContext()
       );
+      final String signKeyStr = this.getConfig().getString("signKey", "");
+      if (signKeyStr.length() > 0) {
+        this.implementation.signKey = CryptoCipher.stringToPublicKey(
+          signKeyStr
+        );
+      }
       this.implementation.directUpdate = this.getConfig()
         .getBoolean("directUpdate", false);
       this.currentVersionNative = new Version(
@@ -574,6 +582,7 @@ public class CapacitorUpdaterPlugin extends Plugin {
     final String version = call.getString("version");
     final String sessionKey = call.getString("sessionKey", "");
     final String checksum = call.getString("checksum", "");
+    final String signature = call.getString("signature", "");
     if (url == null) {
       Log.e(CapacitorUpdater.TAG, "Download called without url");
       call.reject("Download called without url");
@@ -584,6 +593,17 @@ public class CapacitorUpdaterPlugin extends Plugin {
       call.reject("Download called without version");
       return;
     }
+    if (
+      this.implementation.signKey != null &&
+      (signature == null || signature.isEmpty())
+    ) {
+      Log.e(
+        CapacitorUpdater.TAG,
+        "Signature required but none provided for download call"
+      );
+      call.reject("Signature required but none provided");
+      return;
+    }
     try {
       Log.i(CapacitorUpdater.TAG, "Downloading " + url);
       startNewThread(() -> {
@@ -593,7 +613,8 @@ public class CapacitorUpdaterPlugin extends Plugin {
                 url,
                 version,
                 sessionKey,
-                checksum
+                checksum,
+                signature
               );
           if (downloaded.isErrorStatus()) {
             throw new RuntimeException(
@@ -834,7 +855,7 @@ public class CapacitorUpdaterPlugin extends Plugin {
       return;
     }
     final Timer timer = new Timer();
-    timer.scheduleAtFixedRate(
+    timer.schedule(
       new TimerTask() {
         @Override
         public void run() {
@@ -1261,11 +1282,15 @@ public class CapacitorUpdaterPlugin extends Plugin {
                     final String checksum = res.has("checksum")
                       ? res.getString("checksum")
                       : "";
+                    final String signature = res.has("signature")
+                      ? res.getString("signature")
+                      : "";
                     CapacitorUpdaterPlugin.this.implementation.downloadBackground(
                         url,
                         latestVersionName,
                         sessionKey,
-                        checksum
+                        checksum,
+                        signature
                       );
                   } catch (final Exception e) {
                     Log.e(CapacitorUpdater.TAG, "error downloading file", e);

package/android/src/main/java/ee/forgr/capacitor_updater/CryptoCipher.java CHANGED Viewed

@@ -12,15 +12,18 @@ package ee.forgr.capacitor_updater;
  * references: http://stackoverflow.com/questions/12471999/rsa-encryption-decryption-in-android
  */
 import android.util.Base64;
+import android.util.Log;
 import java.security.GeneralSecurityException;
 import java.security.InvalidAlgorithmParameterException;
 import java.security.InvalidKeyException;
 import java.security.KeyFactory;
 import java.security.NoSuchAlgorithmException;
 import java.security.PrivateKey;
+import java.security.PublicKey;
 import java.security.spec.InvalidKeySpecException;
 import java.security.spec.MGF1ParameterSpec;
 import java.security.spec.PKCS8EncodedKeySpec;
+import java.security.spec.X509EncodedKeySpec;
 import javax.crypto.BadPaddingException;
 import javax.crypto.Cipher;
 import javax.crypto.IllegalBlockSizeException;
@@ -142,4 +145,21 @@ public class CryptoCipher {
     // extract the private key
     return readPkcs1PrivateKey(pkcs1EncodedBytes);
   }
+  public static PublicKey stringToPublicKey(String publicKey) {
+    byte[] encoded = Base64.decode(publicKey, Base64.DEFAULT);
+    KeyFactory keyFactory = null;
+    try {
+      keyFactory = KeyFactory.getInstance("RSA");
+      X509EncodedKeySpec keySpec = new X509EncodedKeySpec(encoded);
+      return keyFactory.generatePublic(keySpec);
+    } catch (NoSuchAlgorithmException | InvalidKeySpecException e) {
+      Log.i(
+        "Capacitor-updater",
+        "stringToPublicKey fail\nError:\n" + e.toString()
+      );
+      return null;
+    }
+  }
 }

package/android/src/main/java/ee/forgr/capacitor_updater/DownloadService.java CHANGED Viewed

@@ -27,6 +27,7 @@ public class DownloadService extends IntentService {
   public static final String VERSION = "version";
   public static final String SESSIONKEY = "sessionkey";
   public static final String CHECKSUM = "checksum";
+  public static final String SIGNATURE = "signature";
   public static final String NOTIFICATION = "service receiver";
   public static final String PERCENTDOWNLOAD = "percent receiver";
@@ -53,6 +54,7 @@ public class DownloadService extends IntentService {
     String version = intent.getStringExtra(VERSION);
     String sessionKey = intent.getStringExtra(SESSIONKEY);
     String checksum = intent.getStringExtra(CHECKSUM);
+    String signature = intent.getStringExtra(SIGNATURE);
     try {
       final URL u = new URL(url);
@@ -84,12 +86,28 @@ public class DownloadService extends IntentService {
             }
             bytesRead += length;
           }
-          publishResults(dest, id, version, checksum, sessionKey, "");
+          publishResults(
+            dest,
+            id,
+            version,
+            checksum,
+            sessionKey,
+            signature,
+            ""
+          );
         }
       }
     } catch (OutOfMemoryError e) {
       e.printStackTrace();
-      publishResults("", id, version, checksum, sessionKey, "low_mem_fail");
+      publishResults(
+        "",
+        id,
+        version,
+        checksum,
+        sessionKey,
+        signature,
+        "low_mem_fail"
+      );
     } catch (Exception e) {
       e.printStackTrace();
       publishResults(
@@ -98,6 +116,7 @@ public class DownloadService extends IntentService {
         version,
         checksum,
         sessionKey,
+        signature,
         e.getLocalizedMessage()
       );
     }
@@ -117,6 +136,7 @@ public class DownloadService extends IntentService {
     String version,
     String checksum,
     String sessionKey,
+    String signature,
     String error
   ) {
     Intent intent = new Intent(NOTIFICATION);
@@ -132,6 +152,7 @@ public class DownloadService extends IntentService {
     intent.putExtra(SESSIONKEY, sessionKey);
     intent.putExtra(CHECKSUM, checksum);
     intent.putExtra(ERROR, error);
+    intent.putExtra(SIGNATURE, signature);
     sendBroadcast(intent);
   }
 }

package/dist/docs.json CHANGED Viewed

@@ -1091,6 +1091,22 @@
           "docs": "The checksum for the update",
           "complexTypes": [],
           "type": "string | undefined"
+        },
+        {
+          "name": "signature",
+          "tags": [
+            {
+              "text": "6.1.0",
+              "name": "since"
+            },
+            {
+              "text": "undefined",
+              "name": "default"
+            }
+          ],
+          "docs": "The signature of the update. Can be generated using capgo CLI",
+          "complexTypes": [],
+          "type": "string | undefined"
         }
       ]
     },
@@ -2047,6 +2063,22 @@
           "docs": "Set the default channel for the app in the config.",
           "complexTypes": [],
           "type": "string | undefined"
+        },
+        {
+          "name": "signKey",
+          "tags": [
+            {
+              "text": "undefined",
+              "name": "default"
+            },
+            {
+              "text": "6.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Public key used for bundle signing.",
+          "complexTypes": [],
+          "type": "string | undefined"
         }
       ],
       "docs": "CapacitorUpdater can be configured with these options:"

package/dist/esm/definitions.d.ts CHANGED Viewed

@@ -170,6 +170,15 @@ declare module "@capacitor/cli" {
              * @since  5.5.0
              */
             defaultChannel?: string;
+            /**
+             * Public key used for bundle signing.
+             *
+             *
+             *
+             * @default undefined
+             * @since  6.1.0
+             */
+            signKey?: string;
         };
     }
 }
@@ -598,6 +607,12 @@ export interface DownloadOptions {
      * @default undefined
      */
     checksum?: string;
+    /**
+     * The signature of the update. Can be generated using capgo CLI
+     * @since 6.1.0
+     * @default undefined
+     */
+    signature?: string;
 }
 export interface BundleId {
     id: string;

package/dist/esm/definitions.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAAA;;;;GAIG","sourcesContent":["/\n This Source Code Form is subject to the terms of the Mozilla Public\n * License, v. 2.0. If a copy of the MPL was not distributed with this\n * file, You can obtain one at https://mozilla.org/MPL/2.0/.\n /\n\n/// <reference types=\"@capacitor/cli\" />\n\nimport type { PluginListenerHandle } from \"@capacitor/core\";\n\ndeclare module \"@capacitor/cli\" {\n export interface PluginsConfig {\n /\n CapacitorUpdater can be configured with these options:\n /\n CapacitorUpdater?: {\n /\n Configure the number of milliseconds the native plugin should wait before considering an update 'failed'.\n \n Only available for Android and iOS.\n \n @default 10000 // (10 seconds)\n * @example 1000 // (1 second)\n /\n appReadyTimeout?: number;\n /\n Configure the number of milliseconds the native plugin should wait before considering API timeout.\n \n Only available for Android and iOS.\n \n @default 20 // (20 second)\n * @example 10 // (10 second)\n /\n responseTimeout?: number;\n /\n Configure whether the plugin should use automatically delete failed bundles.\n \n Only available for Android and iOS.\n \n @default true\n * @example false\n /\n autoDeleteFailed?: boolean;\n\n /\n Configure whether the plugin should use automatically delete previous bundles after a successful update.\n \n Only available for Android and iOS.\n \n @default true\n * @example false\n /\n autoDeletePrevious?: boolean;\n\n /\n Configure whether the plugin should use Auto Update via an update server.\n \n Only available for Android and iOS.\n \n @default true\n * @example false\n /\n autoUpdate?: boolean;\n\n /\n Automatically delete previous downloaded bundles when a newer native app bundle is installed to the device.\n \n Only available for Android and iOS.\n \n @default true\n * @example false\n /\n resetWhenUpdate?: boolean;\n\n /\n Configure the URL / endpoint to which update checks are sent.\n \n Only available for Android and iOS.\n \n @default https://api.capgo.app/updates\n * @example https://example.com/api/auto_update\n /\n updateUrl?: string;\n\n /\n Configure the URL / endpoint to which update statistics are sent.\n \n Only available for Android and iOS. Set to \"\" to disable stats reporting.\n \n @default https://api.capgo.app/stats\n * @example https://example.com/api/stats\n /\n statsUrl?: string;\n /\n Configure the private key for end to end live update encryption.\n \n Only available for Android and iOS.\n \n @default undefined\n /\n privateKey?: string;\n\n /\n Configure the current version of the app. This will be used for the first update request.\n * If not set, the plugin will get the version from the native code.\n \n Only available for Android and iOS.\n \n @default undefined\n * @since 4.17.48\n /\n version?: string;\n /\n Make the plugin direct install the update when the app what just updated/installed. Only for autoUpdate mode.\n \n Only available for Android and iOS.\n \n @default undefined\n * @since 5.1.0\n /\n directUpdate?: boolean;\n\n /\n Configure the delay period for period update check. the unit is in seconds.\n \n Only available for Android and iOS.\n * Cannot be less than 600 seconds (10 minutes).\n \n @default 600 // (10 minutes)\n /\n periodCheckDelay?: number;\n\n /\n Configure the CLI to use a local server for testing or self-hosted update server.\n \n \n * @default undefined\n * @since 4.17.48\n /\n localS3?: boolean;\n /\n Configure the CLI to use a local server for testing or self-hosted update server.\n \n \n * @default undefined\n * @since 4.17.48\n /\n localHost?: string;\n /\n Configure the CLI to use a local server for testing or self-hosted update server.\n \n \n * @default undefined\n * @since 4.17.48\n /\n localWebHost?: string;\n /\n Configure the CLI to use a local server for testing or self-hosted update server.\n \n \n * @default undefined\n * @since 4.17.48\n /\n localSupa?: string;\n /\n Configure the CLI to use a local server for testing.\n \n \n * @default undefined\n * @since 4.17.48\n /\n localSupaAnon?: string;\n\n /\n Allow the plugin to modify the updateUrl, statsUrl and channelUrl dynamically from the JavaScript side.\n \n \n * @default false\n * @since 5.4.0\n /\n allowModifyUrl?: boolean;\n\n /\n Set the default channel for the app in the config.\n \n \n \n @default undefined\n * @since 5.5.0\n /\n defaultChannel?: string;\n };\n }\n}\n\nexport interface CapacitorUpdaterPlugin {\n /\n Notify Capacitor Updater that the current bundle is working (a rollback will occur if this method is not called on every app launch)\n * By default this method should be called in the first 10 sec after app launch, otherwise a rollback will occur.\n * Change this behaviour with {@link appReadyTimeout}\n \n @returns {Promise<AppReadyResult>} an Promise resolved directly\n * @throws {Error}\n /\n notifyAppReady(): Promise<AppReadyResult>;\n\n /\n Set the updateUrl for the app, this will be used to check for updates.\n \n @param options contains the URL to use for checking for updates.\n * @returns {Promise<void>}\n * @throws {Error}\n * @since 5.4.0\n /\n setUpdateUrl(options: UpdateUrl): Promise<void>;\n\n /\n Set the statsUrl for the app, this will be used to send statistics. Passing an empty string will disable statistics gathering.\n \n @param options contains the URL to use for sending statistics.\n * @returns {Promise<void>}\n * @throws {Error}\n * @since 5.4.0\n /\n setStatsUrl(options: StatsUrl): Promise<void>;\n\n /\n Set the channelUrl for the app, this will be used to set the channel.\n \n @param options contains the URL to use for setting the channel.\n * @returns {Promise<void>}\n * @throws {Error}\n * @since 5.4.0\n /\n setChannelUrl(options: ChannelUrl): Promise<void>;\n\n /\n Download a new bundle from the provided URL, it should be a zip file, with files inside or with a unique id inside with all your files\n \n @example const bundle = await CapacitorUpdater.download({ url: `https://example.com/versions/${version}/dist.zip`, version });\n * @returns {Promise<BundleInfo>} The {@link BundleInfo} for the specified bundle.\n * @param options The {@link DownloadOptions} for downloading a new bundle zip.\n /\n download(options: DownloadOptions): Promise<BundleInfo>;\n\n /\n Set the next bundle to be used when the app is reloaded.\n \n @param options Contains the ID of the next Bundle to set on next app launch. {@link BundleInfo.id}\n * @returns {Promise<BundleInfo>} The {@link BundleInfo} for the specified bundle id.\n * @throws {Error} When there is no index.html file inside the bundle folder.\n /\n next(options: BundleId): Promise<BundleInfo>;\n\n /\n Set the current bundle and immediately reloads the app.\n \n @param options A {@link BundleId} object containing the new bundle id to set as current.\n * @returns {Promise<void>}\n * @throws {Error} When there are is no index.html file inside the bundle folder.\n /\n set(options: BundleId): Promise<void>;\n\n /\n Deletes the specified bundle from the native app storage. Use with {@link list} to get the stored Bundle IDs.\n \n @param options A {@link BundleId} object containing the ID of a bundle to delete (note, this is the bundle id, NOT the version name)\n * @returns {Promise<void>} When the bundle is deleted\n * @throws {Error}\n /\n delete(options: BundleId): Promise<void>;\n\n /\n Get all locally downloaded bundles in your app\n \n @returns {Promise<BundleListResult>} A Promise containing the {@link BundleListResult.bundles}\n * @throws {Error}\n /\n list(): Promise<BundleListResult>;\n\n /\n Reset the app to the `builtin` bundle (the one sent to Apple App Store / Google Play Store ) or the last successfully loaded bundle.\n \n @param options Containing {@link ResetOptions.toLastSuccessful}, `true` resets to the builtin bundle and `false` will reset to the last successfully loaded bundle.\n * @returns {Promise<void>}\n * @throws {Error}\n /\n reset(options?: ResetOptions): Promise<void>;\n\n /\n Get the current bundle, if none are set it returns `builtin`. currentNative is the original bundle installed on the device\n \n @returns {Promise<CurrentBundleResult>} A Promise evaluating to the {@link CurrentBundleResult}\n * @throws {Error}\n /\n current(): Promise<CurrentBundleResult>;\n\n /\n Reload the view\n \n @returns {Promise<void>} A Promise which is resolved when the view is reloaded\n * @throws {Error}\n /\n reload(): Promise<void>;\n\n /\n Sets a {@link DelayCondition} array containing conditions that the Plugin will use to delay the update.\n * After all conditions are met, the update process will run start again as usual, so update will be installed after a backgrounding or killing the app.\n * For the `date` kind, the value should be an iso8601 date string.\n * For the `background` kind, the value should be a number in milliseconds.\n * For the `nativeVersion` kind, the value should be the version number.\n * For the `kill` kind, the value is not used.\n * The function has unconsistent behavior the option kill do trigger the update after the first kill and not after the next background like other options. This will be fixed in a future major release.\n \n @example\n * // Delay the update after the user kills the app or after a background of 300000 ms (5 minutes)\n * await CapacitorUpdater.setMultiDelay({ delayConditions: [{ kind: 'kill' }, { kind: 'background', value: '300000' }] })\n * @example\n * // Delay the update after the specific iso8601 date is expired\n * await CapacitorUpdater.setMultiDelay({ delayConditions: [{ kind: 'date', value: '2022-09-14T06:14:11.920Z' }] })\n * @example\n * // Delay the update after the first background (default behaviour without setting delay)\n * await CapacitorUpdater.setMultiDelay({ delayConditions: [{ kind: 'background' }] })\n * @param options Containing the {@link MultiDelayConditions} array of conditions to set\n * @returns {Promise<void>}\n * @throws {Error}\n * @since 4.3.0\n /\n setMultiDelay(options: MultiDelayConditions): Promise<void>;\n\n /\n Cancels a {@link DelayCondition} to process an update immediately.\n \n @returns {Promise<void>}\n * @throws {Error}\n * @since 4.0.0\n /\n cancelDelay(): Promise<void>;\n\n /\n Get Latest bundle available from update Url\n \n @returns {Promise<LatestVersion>} A Promise resolved when url is loaded\n * @throws {Error}\n * @since 4.0.0\n /\n getLatest(): Promise<LatestVersion>;\n\n /\n Sets the channel for this device. The channel has to allow for self assignment for this to work.\n * Do not use this method to set the channel at boot when `autoUpdate` is enabled in the {@link PluginsConfig}.\n * This method is to set the channel after the app is ready.\n \n @param options Is the {@link SetChannelOptions} channel to set\n * @returns {Promise<ChannelRes>} A Promise which is resolved when the new channel is set\n * @throws {Error}\n * @since 4.7.0\n /\n setChannel(options: SetChannelOptions): Promise<ChannelRes>;\n\n /\n Unset the channel for this device. The device will then return to the default channel\n \n @returns {Promise<ChannelRes>} A Promise resolved when channel is set\n * @throws {Error}\n * @since 4.7.0\n /\n unsetChannel(options: UnsetChannelOptions): Promise<void>;\n\n /\n Get the channel for this device\n \n @returns {Promise<ChannelRes>} A Promise that resolves with the channel info\n * @throws {Error}\n * @since 4.8.0\n /\n getChannel(): Promise<GetChannelRes>;\n\n /\n Set a custom ID for this device\n \n @param options is the {@link SetCustomIdOptions} customId to set\n * @returns {Promise<void>} an Promise resolved instantly\n * @throws {Error}\n * @since 4.9.0\n /\n setCustomId(options: SetCustomIdOptions): Promise<void>;\n\n /\n Get the native app version or the builtin version if set in config\n \n @returns {Promise<BuiltinVersion>} A Promise with version for this device\n * @since 5.2.0\n /\n getBuiltinVersion(): Promise<BuiltinVersion>;\n\n /\n Get unique ID used to identify device (sent to auto update server)\n \n @returns {Promise<DeviceId>} A Promise with id for this device\n * @throws {Error}\n /\n getDeviceId(): Promise<DeviceId>;\n\n /\n Get the native Capacitor Updater plugin version (sent to auto update server)\n \n @returns {Promise<PluginVersion>} A Promise with Plugin version\n * @throws {Error}\n /\n getPluginVersion(): Promise<PluginVersion>;\n\n /\n Get the state of auto update config.\n \n @returns {Promise<AutoUpdateEnabled>} The status for auto update. Evaluates to `false` in manual mode.\n * @throws {Error}\n /\n isAutoUpdateEnabled(): Promise<AutoUpdateEnabled>;\n\n /\n Remove all listeners for this plugin.\n \n @since 1.0.0\n /\n removeAllListeners(): Promise<void>;\n\n /\n Listen for bundle download event in the App. Fires once a download has started, during downloading and when finished.\n \n @since 2.0.11\n /\n addListener(\n eventName: \"download\",\n listenerFunc: (state: DownloadEvent) => void,\n ): Promise<PluginListenerHandle>;\n\n /\n Listen for no need to update event, useful when you want force check every time the app is launched\n \n @since 4.0.0\n /\n addListener(\n eventName: \"noNeedUpdate\",\n listenerFunc: (state: NoNeedEvent) => void,\n ): Promise<PluginListenerHandle>;\n\n /\n Listen for available update event, useful when you want to force check every time the app is launched\n \n @since 4.0.0\n /\n addListener(\n eventName: \"updateAvailable\",\n listenerFunc: (state: UpdateAvailableEvent) => void,\n ): Promise<PluginListenerHandle>;\n\n /\n Listen for downloadComplete events.\n \n @since 4.0.0\n /\n addListener(\n eventName: \"downloadComplete\",\n listenerFunc: (state: DownloadCompleteEvent) => void,\n ): Promise<PluginListenerHandle>;\n\n /\n Listen for Major update event in the App, let you know when major update is blocked by setting disableAutoUpdateBreaking\n \n @since 2.3.0\n /\n addListener(\n eventName: \"majorAvailable\",\n listenerFunc: (state: MajorAvailableEvent) => void,\n ): Promise<PluginListenerHandle>;\n\n /\n Listen for update fail event in the App, let you know when update has fail to install at next app start\n \n @since 2.3.0\n /\n addListener(\n eventName: \"updateFailed\",\n listenerFunc: (state: UpdateFailedEvent) => void,\n ): Promise<PluginListenerHandle>;\n\n /\n Listen for download fail event in the App, let you know when a bundle download has failed\n \n @since 4.0.0\n /\n addListener(\n eventName: \"downloadFailed\",\n listenerFunc: (state: DownloadFailedEvent) => void,\n ): Promise<PluginListenerHandle>;\n\n /\n Listen for reload event in the App, let you know when reload has happened\n \n @since 4.3.0\n /\n addListener(\n eventName: \"appReloaded\",\n listenerFunc: () => void,\n ): Promise<PluginListenerHandle>;\n\n /\n Listen for app ready event in the App, let you know when app is ready to use\n \n @since 5.1.0\n /\n addListener(\n eventName: \"appReady\",\n listenerFunc: (state: AppReadyEvent) => void,\n ): Promise<PluginListenerHandle>;\n}\n\nexport type BundleStatus = \"success\" \| \"error\" \| \"pending\" \| \"downloading\";\n\nexport type DelayUntilNext = \"background\" \| \"kill\" \| \"nativeVersion\" \| \"date\";\n\nexport interface NoNeedEvent {\n /\n Current status of download, between 0 and 100.\n \n @since 4.0.0\n /\n bundle: BundleInfo;\n}\n\nexport interface UpdateAvailableEvent {\n /\n Current status of download, between 0 and 100.\n \n @since 4.0.0\n /\n bundle: BundleInfo;\n}\n\nexport interface ChannelRes {\n /\n Current status of set channel\n \n @since 4.7.0\n /\n status: string;\n error?: any;\n message?: any;\n}\n\nexport interface GetChannelRes {\n /\n Current status of get channel\n \n @since 4.8.0\n /\n channel?: string;\n error?: any;\n message?: any;\n status?: string;\n allowSet?: boolean;\n}\n\nexport interface DownloadEvent {\n /\n Current status of download, between 0 and 100.\n \n @since 4.0.0\n /\n percent: number;\n bundle: BundleInfo;\n}\n\nexport interface MajorAvailableEvent {\n /\n Emit when a new major bundle is available.\n \n @since 4.0.0\n /\n version: string;\n}\n\nexport interface DownloadFailedEvent {\n /\n Emit when a download fail.\n \n @since 4.0.0\n /\n version: string;\n}\n\nexport interface DownloadCompleteEvent {\n /\n Emit when a new update is available.\n \n @since 4.0.0\n /\n bundle: BundleInfo;\n}\n\nexport interface UpdateFailedEvent {\n /\n Emit when a update failed to install.\n \n @since 4.0.0\n /\n bundle: BundleInfo;\n}\n\nexport interface AppReadyEvent {\n /\n Emitted when the app is ready to use.\n \n @since 5.2.0\n /\n bundle: BundleInfo;\n status: string;\n}\n\nexport interface LatestVersion {\n /\n Result of getLatest method\n \n @since 4.0.0\n /\n version: string;\n major?: boolean;\n message?: string;\n sessionKey?: string;\n error?: string;\n old?: string;\n url?: string;\n}\n\nexport interface BundleInfo {\n id: string;\n version: string;\n downloaded: string;\n checksum: string;\n status: BundleStatus;\n}\n\nexport interface SetChannelOptions {\n channel: string;\n triggerAutoUpdate?: boolean;\n}\n\nexport interface UnsetChannelOptions {\n triggerAutoUpdate?: boolean;\n}\n\nexport interface SetCustomIdOptions {\n customId: string;\n}\n\nexport interface DelayCondition {\n /\n Set up delay conditions in setMultiDelay\n * @param value is useless for @param kind \"kill\", optional for \"background\" (default value: \"0\") and required for \"nativeVersion\" and \"date\"\n /\n kind: DelayUntilNext;\n value?: string;\n}\n\nexport interface AppReadyResult {\n bundle: BundleInfo;\n}\n\nexport interface UpdateUrl {\n url: string;\n}\n\nexport interface StatsUrl {\n url: string;\n}\n\nexport interface ChannelUrl {\n url: string;\n}\n\nexport interface DownloadOptions {\n /\n The URL of the bundle zip file (e.g: dist.zip) to be downloaded. (This can be any URL. E.g: Amazon S3, a GitHub tag, any other place you've hosted your bundle.)\n /\n url: string;\n /\n The version code/name of this bundle/version\n /\n version: string;\n /\n The session key for the update\n * @since 4.0.0\n * @default undefined\n /\n sessionKey?: string;\n /\n The checksum for the update\n * @since 4.0.0\n * @default undefined\n */\n checksum?: string;\n}\n\nexport interface BundleId {\n id: string;\n}\n\nexport interface BundleListResult {\n bundles: BundleInfo[];\n}\n\nexport interface ResetOptions {\n toLastSuccessful: boolean;\n}\n\nexport interface CurrentBundleResult {\n bundle: BundleInfo;\n native: string;\n}\n\nexport interface MultiDelayConditions {\n delayConditions: DelayCondition[];\n}\n\nexport interface BuiltinVersion {\n version: string;\n}\n\nexport interface DeviceId {\n deviceId: string;\n}\n\nexport interface PluginVersion {\n version: string;\n}\n\nexport interface AutoUpdateEnabled {\n enabled: boolean;\n}\n"]}
1	+ {"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAAA;;;;GAIG","sourcesContent":["/\n This Source Code Form is subject to the terms of the Mozilla Public\n * License, v. 2.0. If a copy of the MPL was not distributed with this\n * file, You can obtain one at https://mozilla.org/MPL/2.0/.\n /\n\n/// <reference types=\"@capacitor/cli\" />\n\nimport type { PluginListenerHandle } from \"@capacitor/core\";\n\ndeclare module \"@capacitor/cli\" {\n export interface PluginsConfig {\n /\n CapacitorUpdater can be configured with these options:\n /\n CapacitorUpdater?: {\n /\n Configure the number of milliseconds the native plugin should wait before considering an update 'failed'.\n \n Only available for Android and iOS.\n \n @default 10000 // (10 seconds)\n * @example 1000 // (1 second)\n /\n appReadyTimeout?: number;\n /\n Configure the number of milliseconds the native plugin should wait before considering API timeout.\n \n Only available for Android and iOS.\n \n @default 20 // (20 second)\n * @example 10 // (10 second)\n /\n responseTimeout?: number;\n /\n Configure whether the plugin should use automatically delete failed bundles.\n \n Only available for Android and iOS.\n \n @default true\n * @example false\n /\n autoDeleteFailed?: boolean;\n\n /\n Configure whether the plugin should use automatically delete previous bundles after a successful update.\n \n Only available for Android and iOS.\n \n @default true\n * @example false\n /\n autoDeletePrevious?: boolean;\n\n /\n Configure whether the plugin should use Auto Update via an update server.\n \n Only available for Android and iOS.\n \n @default true\n * @example false\n /\n autoUpdate?: boolean;\n\n /\n Automatically delete previous downloaded bundles when a newer native app bundle is installed to the device.\n \n Only available for Android and iOS.\n \n @default true\n * @example false\n /\n resetWhenUpdate?: boolean;\n\n /\n Configure the URL / endpoint to which update checks are sent.\n \n Only available for Android and iOS.\n \n @default https://api.capgo.app/updates\n * @example https://example.com/api/auto_update\n /\n updateUrl?: string;\n\n /\n Configure the URL / endpoint to which update statistics are sent.\n \n Only available for Android and iOS. Set to \"\" to disable stats reporting.\n \n @default https://api.capgo.app/stats\n * @example https://example.com/api/stats\n /\n statsUrl?: string;\n /\n Configure the private key for end to end live update encryption.\n \n Only available for Android and iOS.\n \n @default undefined\n /\n privateKey?: string;\n\n /\n Configure the current version of the app. This will be used for the first update request.\n * If not set, the plugin will get the version from the native code.\n \n Only available for Android and iOS.\n \n @default undefined\n * @since 4.17.48\n /\n version?: string;\n /\n Make the plugin direct install the update when the app what just updated/installed. Only for autoUpdate mode.\n \n Only available for Android and iOS.\n \n @default undefined\n * @since 5.1.0\n /\n directUpdate?: boolean;\n\n /\n Configure the delay period for period update check. the unit is in seconds.\n \n Only available for Android and iOS.\n * Cannot be less than 600 seconds (10 minutes).\n \n @default 600 // (10 minutes)\n /\n periodCheckDelay?: number;\n\n /\n Configure the CLI to use a local server for testing or self-hosted update server.\n \n \n * @default undefined\n * @since 4.17.48\n /\n localS3?: boolean;\n /\n Configure the CLI to use a local server for testing or self-hosted update server.\n \n \n * @default undefined\n * @since 4.17.48\n /\n localHost?: string;\n /\n Configure the CLI to use a local server for testing or self-hosted update server.\n \n \n * @default undefined\n * @since 4.17.48\n /\n localWebHost?: string;\n /\n Configure the CLI to use a local server for testing or self-hosted update server.\n \n \n * @default undefined\n * @since 4.17.48\n /\n localSupa?: string;\n /\n Configure the CLI to use a local server for testing.\n \n \n * @default undefined\n * @since 4.17.48\n /\n localSupaAnon?: string;\n\n /\n Allow the plugin to modify the updateUrl, statsUrl and channelUrl dynamically from the JavaScript side.\n \n \n * @default false\n * @since 5.4.0\n /\n allowModifyUrl?: boolean;\n\n /\n Set the default channel for the app in the config.\n \n \n \n @default undefined\n * @since 5.5.0\n /\n defaultChannel?: string;\n /\n Public key used for bundle signing.\n \n \n \n @default undefined\n * @since 6.1.0\n /\n signKey?: string;\n };\n }\n}\n\nexport interface CapacitorUpdaterPlugin {\n /\n Notify Capacitor Updater that the current bundle is working (a rollback will occur if this method is not called on every app launch)\n * By default this method should be called in the first 10 sec after app launch, otherwise a rollback will occur.\n * Change this behaviour with {@link appReadyTimeout}\n \n @returns {Promise<AppReadyResult>} an Promise resolved directly\n * @throws {Error}\n /\n notifyAppReady(): Promise<AppReadyResult>;\n\n /\n Set the updateUrl for the app, this will be used to check for updates.\n \n @param options contains the URL to use for checking for updates.\n * @returns {Promise<void>}\n * @throws {Error}\n * @since 5.4.0\n /\n setUpdateUrl(options: UpdateUrl): Promise<void>;\n\n /\n Set the statsUrl for the app, this will be used to send statistics. Passing an empty string will disable statistics gathering.\n \n @param options contains the URL to use for sending statistics.\n * @returns {Promise<void>}\n * @throws {Error}\n * @since 5.4.0\n /\n setStatsUrl(options: StatsUrl): Promise<void>;\n\n /\n Set the channelUrl for the app, this will be used to set the channel.\n \n @param options contains the URL to use for setting the channel.\n * @returns {Promise<void>}\n * @throws {Error}\n * @since 5.4.0\n /\n setChannelUrl(options: ChannelUrl): Promise<void>;\n\n /\n Download a new bundle from the provided URL, it should be a zip file, with files inside or with a unique id inside with all your files\n \n @example const bundle = await CapacitorUpdater.download({ url: `https://example.com/versions/${version}/dist.zip`, version });\n * @returns {Promise<BundleInfo>} The {@link BundleInfo} for the specified bundle.\n * @param options The {@link DownloadOptions} for downloading a new bundle zip.\n /\n download(options: DownloadOptions): Promise<BundleInfo>;\n\n /\n Set the next bundle to be used when the app is reloaded.\n \n @param options Contains the ID of the next Bundle to set on next app launch. {@link BundleInfo.id}\n * @returns {Promise<BundleInfo>} The {@link BundleInfo} for the specified bundle id.\n * @throws {Error} When there is no index.html file inside the bundle folder.\n /\n next(options: BundleId): Promise<BundleInfo>;\n\n /\n Set the current bundle and immediately reloads the app.\n \n @param options A {@link BundleId} object containing the new bundle id to set as current.\n * @returns {Promise<void>}\n * @throws {Error} When there are is no index.html file inside the bundle folder.\n /\n set(options: BundleId): Promise<void>;\n\n /\n Deletes the specified bundle from the native app storage. Use with {@link list} to get the stored Bundle IDs.\n \n @param options A {@link BundleId} object containing the ID of a bundle to delete (note, this is the bundle id, NOT the version name)\n * @returns {Promise<void>} When the bundle is deleted\n * @throws {Error}\n /\n delete(options: BundleId): Promise<void>;\n\n /\n Get all locally downloaded bundles in your app\n \n @returns {Promise<BundleListResult>} A Promise containing the {@link BundleListResult.bundles}\n * @throws {Error}\n /\n list(): Promise<BundleListResult>;\n\n /\n Reset the app to the `builtin` bundle (the one sent to Apple App Store / Google Play Store ) or the last successfully loaded bundle.\n \n @param options Containing {@link ResetOptions.toLastSuccessful}, `true` resets to the builtin bundle and `false` will reset to the last successfully loaded bundle.\n * @returns {Promise<void>}\n * @throws {Error}\n /\n reset(options?: ResetOptions): Promise<void>;\n\n /\n Get the current bundle, if none are set it returns `builtin`. currentNative is the original bundle installed on the device\n \n @returns {Promise<CurrentBundleResult>} A Promise evaluating to the {@link CurrentBundleResult}\n * @throws {Error}\n /\n current(): Promise<CurrentBundleResult>;\n\n /\n Reload the view\n \n @returns {Promise<void>} A Promise which is resolved when the view is reloaded\n * @throws {Error}\n /\n reload(): Promise<void>;\n\n /\n Sets a {@link DelayCondition} array containing conditions that the Plugin will use to delay the update.\n * After all conditions are met, the update process will run start again as usual, so update will be installed after a backgrounding or killing the app.\n * For the `date` kind, the value should be an iso8601 date string.\n * For the `background` kind, the value should be a number in milliseconds.\n * For the `nativeVersion` kind, the value should be the version number.\n * For the `kill` kind, the value is not used.\n * The function has unconsistent behavior the option kill do trigger the update after the first kill and not after the next background like other options. This will be fixed in a future major release.\n \n @example\n * // Delay the update after the user kills the app or after a background of 300000 ms (5 minutes)\n * await CapacitorUpdater.setMultiDelay({ delayConditions: [{ kind: 'kill' }, { kind: 'background', value: '300000' }] })\n * @example\n * // Delay the update after the specific iso8601 date is expired\n * await CapacitorUpdater.setMultiDelay({ delayConditions: [{ kind: 'date', value: '2022-09-14T06:14:11.920Z' }] })\n * @example\n * // Delay the update after the first background (default behaviour without setting delay)\n * await CapacitorUpdater.setMultiDelay({ delayConditions: [{ kind: 'background' }] })\n * @param options Containing the {@link MultiDelayConditions} array of conditions to set\n * @returns {Promise<void>}\n * @throws {Error}\n * @since 4.3.0\n /\n setMultiDelay(options: MultiDelayConditions): Promise<void>;\n\n /\n Cancels a {@link DelayCondition} to process an update immediately.\n \n @returns {Promise<void>}\n * @throws {Error}\n * @since 4.0.0\n /\n cancelDelay(): Promise<void>;\n\n /\n Get Latest bundle available from update Url\n \n @returns {Promise<LatestVersion>} A Promise resolved when url is loaded\n * @throws {Error}\n * @since 4.0.0\n /\n getLatest(): Promise<LatestVersion>;\n\n /\n Sets the channel for this device. The channel has to allow for self assignment for this to work.\n * Do not use this method to set the channel at boot when `autoUpdate` is enabled in the {@link PluginsConfig}.\n * This method is to set the channel after the app is ready.\n \n @param options Is the {@link SetChannelOptions} channel to set\n * @returns {Promise<ChannelRes>} A Promise which is resolved when the new channel is set\n * @throws {Error}\n * @since 4.7.0\n /\n setChannel(options: SetChannelOptions): Promise<ChannelRes>;\n\n /\n Unset the channel for this device. The device will then return to the default channel\n \n @returns {Promise<ChannelRes>} A Promise resolved when channel is set\n * @throws {Error}\n * @since 4.7.0\n /\n unsetChannel(options: UnsetChannelOptions): Promise<void>;\n\n /\n Get the channel for this device\n \n @returns {Promise<ChannelRes>} A Promise that resolves with the channel info\n * @throws {Error}\n * @since 4.8.0\n /\n getChannel(): Promise<GetChannelRes>;\n\n /\n Set a custom ID for this device\n \n @param options is the {@link SetCustomIdOptions} customId to set\n * @returns {Promise<void>} an Promise resolved instantly\n * @throws {Error}\n * @since 4.9.0\n /\n setCustomId(options: SetCustomIdOptions): Promise<void>;\n\n /\n Get the native app version or the builtin version if set in config\n \n @returns {Promise<BuiltinVersion>} A Promise with version for this device\n * @since 5.2.0\n /\n getBuiltinVersion(): Promise<BuiltinVersion>;\n\n /\n Get unique ID used to identify device (sent to auto update server)\n \n @returns {Promise<DeviceId>} A Promise with id for this device\n * @throws {Error}\n /\n getDeviceId(): Promise<DeviceId>;\n\n /\n Get the native Capacitor Updater plugin version (sent to auto update server)\n \n @returns {Promise<PluginVersion>} A Promise with Plugin version\n * @throws {Error}\n /\n getPluginVersion(): Promise<PluginVersion>;\n\n /\n Get the state of auto update config.\n \n @returns {Promise<AutoUpdateEnabled>} The status for auto update. Evaluates to `false` in manual mode.\n * @throws {Error}\n /\n isAutoUpdateEnabled(): Promise<AutoUpdateEnabled>;\n\n /\n Remove all listeners for this plugin.\n \n @since 1.0.0\n /\n removeAllListeners(): Promise<void>;\n\n /\n Listen for bundle download event in the App. Fires once a download has started, during downloading and when finished.\n \n @since 2.0.11\n /\n addListener(\n eventName: \"download\",\n listenerFunc: (state: DownloadEvent) => void,\n ): Promise<PluginListenerHandle>;\n\n /\n Listen for no need to update event, useful when you want force check every time the app is launched\n \n @since 4.0.0\n /\n addListener(\n eventName: \"noNeedUpdate\",\n listenerFunc: (state: NoNeedEvent) => void,\n ): Promise<PluginListenerHandle>;\n\n /\n Listen for available update event, useful when you want to force check every time the app is launched\n \n @since 4.0.0\n /\n addListener(\n eventName: \"updateAvailable\",\n listenerFunc: (state: UpdateAvailableEvent) => void,\n ): Promise<PluginListenerHandle>;\n\n /\n Listen for downloadComplete events.\n \n @since 4.0.0\n /\n addListener(\n eventName: \"downloadComplete\",\n listenerFunc: (state: DownloadCompleteEvent) => void,\n ): Promise<PluginListenerHandle>;\n\n /\n Listen for Major update event in the App, let you know when major update is blocked by setting disableAutoUpdateBreaking\n \n @since 2.3.0\n /\n addListener(\n eventName: \"majorAvailable\",\n listenerFunc: (state: MajorAvailableEvent) => void,\n ): Promise<PluginListenerHandle>;\n\n /\n Listen for update fail event in the App, let you know when update has fail to install at next app start\n \n @since 2.3.0\n /\n addListener(\n eventName: \"updateFailed\",\n listenerFunc: (state: UpdateFailedEvent) => void,\n ): Promise<PluginListenerHandle>;\n\n /\n Listen for download fail event in the App, let you know when a bundle download has failed\n \n @since 4.0.0\n /\n addListener(\n eventName: \"downloadFailed\",\n listenerFunc: (state: DownloadFailedEvent) => void,\n ): Promise<PluginListenerHandle>;\n\n /\n Listen for reload event in the App, let you know when reload has happened\n \n @since 4.3.0\n /\n addListener(\n eventName: \"appReloaded\",\n listenerFunc: () => void,\n ): Promise<PluginListenerHandle>;\n\n /\n Listen for app ready event in the App, let you know when app is ready to use\n \n @since 5.1.0\n /\n addListener(\n eventName: \"appReady\",\n listenerFunc: (state: AppReadyEvent) => void,\n ): Promise<PluginListenerHandle>;\n}\n\nexport type BundleStatus = \"success\" \| \"error\" \| \"pending\" \| \"downloading\";\n\nexport type DelayUntilNext = \"background\" \| \"kill\" \| \"nativeVersion\" \| \"date\";\n\nexport interface NoNeedEvent {\n /\n Current status of download, between 0 and 100.\n \n @since 4.0.0\n /\n bundle: BundleInfo;\n}\n\nexport interface UpdateAvailableEvent {\n /\n Current status of download, between 0 and 100.\n \n @since 4.0.0\n /\n bundle: BundleInfo;\n}\n\nexport interface ChannelRes {\n /\n Current status of set channel\n \n @since 4.7.0\n /\n status: string;\n error?: any;\n message?: any;\n}\n\nexport interface GetChannelRes {\n /\n Current status of get channel\n \n @since 4.8.0\n /\n channel?: string;\n error?: any;\n message?: any;\n status?: string;\n allowSet?: boolean;\n}\n\nexport interface DownloadEvent {\n /\n Current status of download, between 0 and 100.\n \n @since 4.0.0\n /\n percent: number;\n bundle: BundleInfo;\n}\n\nexport interface MajorAvailableEvent {\n /\n Emit when a new major bundle is available.\n \n @since 4.0.0\n /\n version: string;\n}\n\nexport interface DownloadFailedEvent {\n /\n Emit when a download fail.\n \n @since 4.0.0\n /\n version: string;\n}\n\nexport interface DownloadCompleteEvent {\n /\n Emit when a new update is available.\n \n @since 4.0.0\n /\n bundle: BundleInfo;\n}\n\nexport interface UpdateFailedEvent {\n /\n Emit when a update failed to install.\n \n @since 4.0.0\n /\n bundle: BundleInfo;\n}\n\nexport interface AppReadyEvent {\n /\n Emitted when the app is ready to use.\n \n @since 5.2.0\n /\n bundle: BundleInfo;\n status: string;\n}\n\nexport interface LatestVersion {\n /\n Result of getLatest method\n \n @since 4.0.0\n /\n version: string;\n major?: boolean;\n message?: string;\n sessionKey?: string;\n error?: string;\n old?: string;\n url?: string;\n}\n\nexport interface BundleInfo {\n id: string;\n version: string;\n downloaded: string;\n checksum: string;\n status: BundleStatus;\n}\n\nexport interface SetChannelOptions {\n channel: string;\n triggerAutoUpdate?: boolean;\n}\n\nexport interface UnsetChannelOptions {\n triggerAutoUpdate?: boolean;\n}\n\nexport interface SetCustomIdOptions {\n customId: string;\n}\n\nexport interface DelayCondition {\n /\n Set up delay conditions in setMultiDelay\n * @param value is useless for @param kind \"kill\", optional for \"background\" (default value: \"0\") and required for \"nativeVersion\" and \"date\"\n /\n kind: DelayUntilNext;\n value?: string;\n}\n\nexport interface AppReadyResult {\n bundle: BundleInfo;\n}\n\nexport interface UpdateUrl {\n url: string;\n}\n\nexport interface StatsUrl {\n url: string;\n}\n\nexport interface ChannelUrl {\n url: string;\n}\n\nexport interface DownloadOptions {\n /\n The URL of the bundle zip file (e.g: dist.zip) to be downloaded. (This can be any URL. E.g: Amazon S3, a GitHub tag, any other place you've hosted your bundle.)\n /\n url: string;\n /\n The version code/name of this bundle/version\n /\n version: string;\n /\n The session key for the update\n * @since 4.0.0\n * @default undefined\n /\n sessionKey?: string;\n /\n The checksum for the update\n * @since 4.0.0\n * @default undefined\n /\n checksum?: string;\n /\n The signature of the update. Can be generated using capgo CLI\n * @since 6.1.0\n * @default undefined\n */\n signature?: string;\n}\n\nexport interface BundleId {\n id: string;\n}\n\nexport interface BundleListResult {\n bundles: BundleInfo[];\n}\n\nexport interface ResetOptions {\n toLastSuccessful: boolean;\n}\n\nexport interface CurrentBundleResult {\n bundle: BundleInfo;\n native: string;\n}\n\nexport interface MultiDelayConditions {\n delayConditions: DelayCondition[];\n}\n\nexport interface BuiltinVersion {\n version: string;\n}\n\nexport interface DeviceId {\n deviceId: string;\n}\n\nexport interface PluginVersion {\n version: string;\n}\n\nexport interface AutoUpdateEnabled {\n enabled: boolean;\n}\n"]}

package/ios/Plugin/CapacitorUpdater.swift CHANGED Viewed

@@ -8,7 +8,13 @@ import Foundation
 import SSZipArchive
 import Alamofire
 import zlib
+import SwiftyRSA
+extension Collection {
+  subscript(safe index: Index) -> Element? {
+      return indices.contains(index) ? self[index] : nil
+  }
+}
 extension URL {
     var isDirectory: Bool {
         (try? resourceValues(forKeys: [.isDirectoryKey]))?.isDirectory == true
@@ -91,6 +97,7 @@ struct AppVersionDec: Decodable {
     let session_key: String?
     let major: Bool?
     let data: [String: String]?
+    let signature: String?
 }
 public class AppVersion: NSObject {
     var version: String = ""
@@ -101,6 +108,7 @@ public class AppVersion: NSObject {
     var sessionKey: String?
     var major: Bool?
     var data: [String: String]?
+    var signature: String?
 }
 extension AppVersion {
@@ -169,6 +177,8 @@ enum CustomError: Error {
     case cannotUnflat
     case cannotCreateDirectory
     case cannotDeleteDirectory
+    case signatureNotProvided
+    case invalidSignature
     // Throw in all other cases
     case unexpected(code: Int)
@@ -177,6 +187,16 @@ enum CustomError: Error {
 extension CustomError: LocalizedError {
     public var errorDescription: String? {
         switch self {
+        case .signatureNotProvided:
+            return NSLocalizedString(
+                "Signature was required but none was provided",
+                comment: "Signature not provided"
+            )
+        case .invalidSignature:
+            return NSLocalizedString(
+                "Signature is not valid, cannot accept update",
+                comment: "Invalid signature"
+            )
         case .cannotUnzip:
             return NSLocalizedString(
                 "The file cannot be unzip",
@@ -240,6 +260,7 @@ extension CustomError: LocalizedError {
     public var appId: String = ""
     public var deviceID = UIDevice.current.identifierForVendor?.uuidString ?? ""
     public var privateKey: String = ""
+    public var signKey: PublicKey?
     public var notifyDownload: (String, Int) -> Void = { _, _  in }
@@ -363,6 +384,32 @@ extension CustomError: LocalizedError {
             return ""
         }
     }
+    private func verifyBundleSignature(version: String, filePath: URL, signature: String?) throws -> Bool {
+        if (self.signKey == nil) {
+            print("\(self.TAG) Signing not configured")
+            return true
+        }
+        if (self.signKey != nil && (signature == nil || signature?.isEmpty == true)) {
+            print("\(self.TAG) Signature required but none provided")
+            self.sendStats(action: "signature_not_provided", versionName: version)
+            throw CustomError.signatureNotProvided
+        }
+        do {
+            // let publicKey = try PublicKey(pemEncoded: self.signKey)
+            let signatureObj = try Signature(base64Encoded: signature!) // I THINK I can unwrap safely here (?)
+            let clear = try ClearMessage(data: Data(contentsOf: filePath))
+            let isSuccessful = try clear.verify(with: self.signKey!, signature: signatureObj, digestType: .sha512)
+            return isSuccessful
+        } catch {
+            print("\(self.TAG) Signature validation failed", error)
+            self.sendStats(action: "signature_validation_failed", versionName: version)
+            throw error
+        }
+    }
     private func decryptFile(filePath: URL, sessionKey: String, version: String) throws {
         if self.privateKey.isEmpty || sessionKey.isEmpty  || sessionKey.components(separatedBy: ":").count != 2 {
@@ -539,6 +586,9 @@ extension CustomError: LocalizedError {
                 if let data = response.value?.data {
                     latest.data = data
                 }
+                if let signature = response.value?.signature {
+                    latest.signature = signature
+                }
             case let .failure(error):
                 print("\(self.TAG) Error getting Latest", response.value ?? "", error )
                 latest.message = "Error getting Latest \(String(describing: response.value))"
@@ -556,7 +606,7 @@ extension CustomError: LocalizedError {
         print("\(self.TAG) Current bundle set to: \((bundle ).isEmpty ? BundleInfo.ID_BUILTIN : bundle)")
     }
-    public func download(url: URL, version: String, sessionKey: String) throws -> BundleInfo {
+    public func download(url: URL, version: String, sessionKey: String, signature: String?) throws -> BundleInfo {
         let semaphore: DispatchSemaphore = DispatchSemaphore(value: 0)
         let id: String = self.randomString(length: 10)
         var checksum: String = ""
@@ -579,12 +629,39 @@ extension CustomError: LocalizedError {
                 switch response.result {
                 case .success:
                     self.notifyDownload(id, 71)
+                    // The reason we do 2 blocks of try/catch is that in the first one we will try to cleanup afterwards. Cleanup wlll NOT happen in the second one
                     do {
+                        let valid = try self.verifyBundleSignature(version: version, filePath: fileURL, signature: signature)
+                        if (!valid) {
+                            print("\(self.TAG) Invalid signature, cannot accept download")
+                            self.sendStats(action: "invalid_signature", versionName: version)
+                            throw CustomError.invalidSignature
+                        } else {
+                            print("\(self.TAG) Valid signature")
+                        }
                         try self.decryptFile(filePath: fileURL, sessionKey: sessionKey, version: version)
                         checksum = self.calcChecksum(filePath: fileURL)
-                        try self.saveDownloaded(sourceZip: fileURL, id: id, base: self.libraryDir.appendingPathComponent(self.bundleDirectory), notify: true)
-                        try self.deleteFolder(source: fileURL)
-                        self.notifyDownload(id, 100)
+                    } catch {
+                        print("\(self.TAG) downloaded file verification error", error)
+                        mainError = error as NSError
+                        // Cleanup
+                        do {
+                            try self.deleteFolder(source: fileURL)
+                        } catch {
+                            print("\(self.TAG) Double error, cannot cleanup", error)
+                        }
+                    }
+                    do {
+                        if (mainError == nil) {
+                            try self.saveDownloaded(sourceZip: fileURL, id: id, base: self.libraryDir.appendingPathComponent(self.bundleDirectory), notify: true)
+                            try self.deleteFolder(source: fileURL)
+                            self.notifyDownload(id, 100)
+                        }
                     } catch {
                         print("\(self.TAG) download unzip error", error)
                         mainError = error as NSError

package/ios/Plugin/CapacitorUpdaterPlugin.swift CHANGED Viewed

@@ -7,6 +7,7 @@
 import Foundation
 import Capacitor
 import Version
+import SwiftyRSA
 /**
  * Please read the Capacitor iOS Plugin Development Guide
@@ -15,7 +16,7 @@ import Version
 @objc(CapacitorUpdaterPlugin)
 public class CapacitorUpdaterPlugin: CAPPlugin {
     public var implementation = CapacitorUpdater()
-    private let PLUGIN_VERSION: String = "6.0.69"
+    private let PLUGIN_VERSION: String = "6.0.70"
     static let updateUrlDefault = "https://api.capgo.app/updates"
     static let statsUrlDefault = "https://api.capgo.app/stats"
     static let channelUrlDefault = "https://api.capgo.app/channel_self"
@@ -38,6 +39,11 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
     let semaphoreReady = DispatchSemaphore(value: 0)
     override public func load() {
+        #if targetEnvironment(simulator)
+            print("\(self.implementation.TAG) ::::: SIMULATOR :::::")
+            print("\(self.implementation.TAG) Application directory: \(NSHomeDirectory())")
+        #endif
         self.semaphoreUp()
         print("\(self.implementation.TAG) init for device \(self.implementation.deviceID)")
         guard let versionName = getConfig().getString("version", Bundle.main.versionName) else {
@@ -81,6 +87,15 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
         implementation.statsUrl = getConfig().getString("statsUrl", CapacitorUpdaterPlugin.statsUrlDefault)!
         implementation.channelUrl = getConfig().getString("channelUrl", CapacitorUpdaterPlugin.channelUrlDefault)!
         implementation.defaultChannel = getConfig().getString("defaultChannel", "")!
+        do {
+            let signKeyString = getConfig().getString("signKey", "")!
+            if (!signKeyString.isEmpty) {
+                implementation.signKey = try PublicKey(base64Encoded: signKeyString)
+            }
+        } catch {
+            print("\(self.implementation.TAG) Cannot get signKey, invalid key")
+            fatalError("Invalid signKey in capacitor config")
+        }
         self.implementation.autoReset()
         // Load the server
@@ -237,13 +252,20 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
             call.reject("Download called without version")
             return
         }
+        let signature = call.getString("signature", "")
+        if (self.implementation.signKey != nil && signature.isEmpty) {
+            print("\(self.implementation.TAG) Signature required but none provided for download call")
+            call.reject("Signature required but none provided")
+            return
+        }
         let sessionKey = call.getString("sessionKey", "")
         let checksum = call.getString("checksum", "")
         let url = URL(string: urlString)
         print("\(self.implementation.TAG) Downloading \(String(describing: url))")
         DispatchQueue.global(qos: .background).async {
             do {
-                let next = try self.implementation.download(url: url!, version: version, sessionKey: sessionKey)
+                let next = try self.implementation.download(url: url!, version: version, sessionKey: sessionKey, signature: signature)
                 if checksum != "" && next.getChecksum() != checksum {
                     print("\(self.implementation.TAG) Error checksum", next.getChecksum(), checksum)
                     self.implementation.sendStats(action: "checksum_fail", versionName: next.getVersionName())
@@ -678,6 +700,7 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
                 return
             }
             let sessionKey = res.sessionKey ?? ""
+            let signature = res.signature
             guard let downloadUrl = URL(string: res.url) else {
                 print("\(self.implementation.TAG) Error no url or wrong format")
                 self.endBackGroundTaskWithNotif(msg: "Error no url or wrong format", latestVersionName: res.version, current: current)
@@ -698,7 +721,7 @@ public class CapacitorUpdaterPlugin: CAPPlugin {
                                 print("\(self.implementation.TAG) Failed to delete failed bundle: \(nextImpl!.toString())")
                             }
                         }
-                        nextImpl = try self.implementation.download(url: downloadUrl, version: latestVersionName, sessionKey: sessionKey)
+                        nextImpl = try self.implementation.download(url: downloadUrl, version: latestVersionName, sessionKey: sessionKey, signature: signature)
                     }
                     guard let next = nextImpl else {
                         print("\(self.implementation.TAG) Error downloading file")

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/capacitor-updater",
-  "version": "6.0.69",
+  "version": "6.0.70",
   "license": "MPL-2.0",
   "description": "Live update for capacitor apps",
   "main": "dist/plugin.cjs.js",