Support for embedded provisioning profiles and embedded apps in macOS DMGs (#289)

* added embedded.provisionprofile support for macos apps (#1)

* add more info to errors

* fixed path mistake

* fmt fixes

* clippy fixes

* clippy fixes

* fix arch conditional compilation

* fix arch conditional compilation

* fix arch conditional compilation

* fix arch conditional compilation

* fix arch conditional compilation

* fix arch conditional compilation

* fix arch conditional compilation

* fix arch conditional compilation

* added embedded app support

* fmt

* exclude apps from re-signing

* exclude apps from re-signing

* exclude apps from re-signing

* fixed missing var

* fixed missing var

* comments addressed

* update cargo lock

* fix rpath typo

* change files

* make function available to windows, linux

* removed conditional

* update cargo-deny action to v2

* downgrade cargo-deny action to v1; patch Cargo.lock file

---------

Co-authored-by: Lucas Nogueira <lucas@crabnebula.dev>

Author: mabeledo

.changes/embedded-apps.md

@@ -0,0 +1,6 @@
+---
+"cargo-packager": patch
+"@crabnebula/packager": patch
+---
+
+Added support to embedding additional apps in the macOS app bundle.

.changes/embedded-provisionprofile.md

@@ -0,0 +1,6 @@
+---
+"cargo-packager": patch
+"@crabnebula/packager": patch
+---
+
+Added support to adding an `embedded.provisionprofile` file to the macOS bundle.

.gitignore

@@ -34,4 +34,6 @@ Cargo.lock
 *.node.bak
 
 yarn.lock
-package-lock.json
+package-lock.json
+
+.idea

Cargo.lock

@@ -766,6 +766,23 @@
             "string",
             "null"
           ]
+        },
+        "embeddedProvisionprofilePath": {
+          "description": "Path to the embedded.provisionprofile file for the package.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "embeddedApps": {
+          "description": "Apps that need to be packaged within the app.",
+          "type": [
+            "array",
+            "null"
+          ],
+          "items": {
+            "type": "string"
+          }
         }
       },
       "additionalProperties": false

bindings/packager/nodejs/schema.json

@@ -429,6 +429,16 @@ export interface MacOsConfig {
    * Path to the Info.plist file for the package.
    */
   infoPlistPath?: string | null;
+
+  /**
+   * Path to the embedded.provisionprofile file for the package.
+   */
+  embeddedProvisionprofilePath?: string | null;
+
+  /**
+   * Apps that need to be packaged within the app.
+   */
+  embeddedApps?: string[] | null;
 }
 /**
  * The Linux Debian configuration.

bindings/packager/nodejs/src-ts/config.d.ts

@@ -766,6 +766,23 @@
             "string",
             "null"
           ]
+        },
+        "embeddedProvisionprofilePath": {
+          "description": "Path to the embedded.provisionprofile file for the package.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "embeddedApps": {
+          "description": "Apps that need to be packaged within the app.",
+          "type": [
+            "array",
+            "null"
+          ],
+          "items": {
+            "type": "string"
+          }
         }
       },
       "additionalProperties": false

crates/packager/schema.json

@@ -162,7 +162,7 @@ impl DeepLinkProtocol {
         }
     }
 
-    /// Set he name. Maps to `CFBundleTypeName` on macOS. Defaults to the first item in `ext`
+    /// Set the name. Maps to `CFBundleTypeName` on macOS. Defaults to the first item in `ext`
     pub fn name<S: Into<String>>(mut self, name: S) -> Self {
         self.name.replace(name.into());
         self
@@ -736,6 +736,15 @@ pub struct MacOsConfig {
     /// Path to the Info.plist file for the package.
     #[serde(alias = "info-plist-path", alias = "info_plist_path")]
     pub info_plist_path: Option<PathBuf>,
+    /// Path to the embedded.provisionprofile file for the package.
+    #[serde(
+        alias = "embedded-provisionprofile-path",
+        alias = "embedded_provisionprofile_path"
+    )]
+    pub embedded_provisionprofile_path: Option<PathBuf>,
+    /// Apps that need to be packaged within the app.
+    #[serde(alias = "embedded-apps", alias = "embedded_apps")]
+    pub embedded_apps: Option<Vec<String>>,
 }
 
 impl MacOsConfig {
@@ -803,6 +812,27 @@ impl MacOsConfig {
         self.info_plist_path.replace(info_plist_path.into());
         self
     }
+
+    /// Path to the embedded.provisionprofile file for the package.
+    pub fn embedded_provisionprofile_path<S: Into<PathBuf>>(
+        mut self,
+        embedded_provisionprofile_path: S,
+    ) -> Self {
+        self.embedded_provisionprofile_path
+            .replace(embedded_provisionprofile_path.into());
+        self
+    }
+
+    /// Apps that need to be packaged within the app.
+    pub fn embedded_apps<I, S>(mut self, embedded_apps: I) -> Self
+    where
+        I: IntoIterator<Item = S>,
+        S: Into<String>,
+    {
+        self.embedded_apps
+            .replace(embedded_apps.into_iter().map(Into::into).collect());
+        self
+    }
 }
 
 /// A wix language.

crates/packager/src/config/mod.rs

@@ -100,7 +100,7 @@ pub enum Error {
     AppImageScriptFailed(std::io::Error),
     /// Failed to get parent directory of a path
     #[error("Failed to get parent directory of {0}")]
-    ParentDirNotFound(std::path::PathBuf),
+    ParentDirNotFound(PathBuf),
     /// A hook, for example `beforePackagaingCommand`, has failed.
     #[error("{0} `{1}` failed: {2}")]
     HookCommandFailure(String, String, std::io::Error),
@@ -235,6 +235,12 @@ pub enum Error {
     #[error("Failed to remove extended attributes from app bundle: {0}")]
     #[cfg(target_os = "macos")]
     FailedToRemoveExtendedAttributes(std::io::Error),
+    /// Could not find the embedded.provisionprofile file.
+    #[error("Embedded provision profile file {0} not found")]
+    EmbeddedProvisionprofileFileNotFound(PathBuf),
+    /// Could not copy the embedded.provisionprofile file to the Contents directory.
+    #[error("Could not copy embedded provision profile file {0}: {1}")]
+    FailedToCopyEmbeddedProvisionprofile(PathBuf, std::io::Error),
 }
 
 /// Convenient type alias of Result type for cargo-packager.

crates/packager/src/error.rs

@@ -20,7 +20,7 @@ use crate::{
 #[tracing::instrument(level = "trace", skip(ctx))]
 pub(crate) fn package(ctx: &Context) -> crate::Result<Vec<PathBuf>> {
     let Context { config, .. } = ctx;
-    // we should use the bundle name (App name) as a MacOS standard.
+    // we should use the bundle name (App name) as a macOS standard.
     // version or platform shouldn't be included in the App name.
     let app_product_name = format!("{}.app", config.product_name);
     let app_bundle_path = config.out_dir().join(&app_product_name);
@@ -72,6 +72,12 @@ pub(crate) fn package(ctx: &Context) -> crate::Result<Vec<PathBuf>> {
     tracing::debug!("Copying resources");
     config.copy_resources(&resources_dir)?;
 
+    tracing::debug!("Copying embedded.provisionprofile");
+    copy_embedded_provisionprofile_file(&contents_directory, config)?;
+
+    tracing::debug!("Copying embedded apps");
+    let embedded_apps = copy_embedded_apps(&contents_directory, config)?;
+
     tracing::debug!("Copying external binaries");
     config.copy_external_binaries(&bin_dir)?;
     tracing::debug!("Copying binaries");
@@ -90,7 +96,8 @@ pub(crate) fn package(ctx: &Context) -> crate::Result<Vec<PathBuf>> {
     let files = walkdir::WalkDir::new(&app_bundle_path)
         .into_iter()
         .flatten()
-        .map(|dir| dir.into_path());
+        .map(|dir| dir.into_path())
+        .filter(|path| !embedded_apps.iter().any(|x| path.starts_with(x)));
 
     // Filter all files for Mach-O headers. This will target all .dylib and native executable files
     for file in files {
@@ -203,7 +210,7 @@ fn create_info_plist(
         plist.insert(
             "CFBundleIconFile".into(),
             path.file_name()
-                .ok_or_else(|| crate::Error::FailedToExtractFilename(path.clone()))?
+                .ok_or_else(|| Error::FailedToExtractFilename(path.clone()))?
                 .to_string_lossy()
                 .into_owned()
                 .into(),
@@ -349,18 +356,18 @@ fn create_info_plist(
 #[tracing::instrument(level = "trace")]
 fn copy_dir(from: &Path, to: &Path) -> crate::Result<()> {
     if !from.exists() {
-        return Err(crate::Error::DoesNotExist(from.to_path_buf()));
+        return Err(Error::DoesNotExist(from.to_path_buf()));
     }
     if !from.is_dir() {
-        return Err(crate::Error::IsNotDirectory(from.to_path_buf()));
+        return Err(Error::IsNotDirectory(from.to_path_buf()));
     }
     if to.exists() {
-        return Err(crate::Error::AlreadyExists(to.to_path_buf()));
+        return Err(Error::AlreadyExists(to.to_path_buf()));
     }
 
     let parent = to
         .parent()
-        .ok_or_else(|| crate::Error::ParentDirNotFound(to.to_path_buf()))?;
+        .ok_or_else(|| Error::ParentDirNotFound(to.to_path_buf()))?;
     fs::create_dir_all(parent).map_err(|e| Error::IoWithPath(parent.to_path_buf(), e))?;
     for entry in walkdir::WalkDir::new(from) {
         let entry = entry?;
@@ -425,27 +432,27 @@ fn copy_frameworks_to_bundle(
                 let src_path = PathBuf::from(framework);
                 let src_name = src_path
                     .file_name()
-                    .ok_or_else(|| crate::Error::FailedToExtractFilename(src_path.clone()))?;
+                    .ok_or_else(|| Error::FailedToExtractFilename(src_path.clone()))?;
                 let dest_path = dest_dir.join(src_name);
                 copy_dir(&src_path, &dest_path)?;
                 paths.push(dest_path);
                 continue;
             } else if framework.ends_with(".dylib") {
                 let src_path = PathBuf::from(&framework);
                 if !src_path.exists() {
-                    return Err(crate::Error::FrameworkNotFound(framework.to_string()));
+                    return Err(Error::FrameworkNotFound(framework.to_string()));
                 }
                 let src_name = src_path
                     .file_name()
-                    .ok_or_else(|| crate::Error::FailedToExtractFilename(src_path.clone()))?;
+                    .ok_or_else(|| Error::FailedToExtractFilename(src_path.clone()))?;
                 fs::create_dir_all(&dest_dir)?;
                 let dest_path = dest_dir.join(src_name);
                 fs::copy(&src_path, &dest_path)
                     .map_err(|e| Error::CopyFile(src_path.clone(), dest_path.clone(), e))?;
                 paths.push(dest_path);
                 continue;
             } else if framework.contains('/') {
-                return Err(crate::Error::InvalidFramework {
+                return Err(Error::InvalidFramework {
                     framework: framework.to_string(),
                     reason: "framework extension should be either .framework, .dylib or .app",
                 });
@@ -466,7 +473,7 @@ fn copy_frameworks_to_bundle(
                 continue;
             }
 
-            return Err(crate::Error::FrameworkNotFound(framework.to_string()));
+            return Err(Error::FrameworkNotFound(framework.to_string()));
         }
     }
 
@@ -482,3 +489,55 @@ fn remove_extra_attr(app_bundle_path: &Path) -> crate::Result<()> {
         .map(|_| ())
         .map_err(crate::Error::FailedToRemoveExtendedAttributes)
 }
+
+// Copies the embedded.provisionprofile file to the Contents directory, if needed.
+fn copy_embedded_provisionprofile_file(
+    contents_directory: &Path,
+    config: &Config,
+) -> crate::Result<()> {
+    if let Some(embedded_provisionprofile_file) = config
+        .macos()
+        .and_then(|m| m.embedded_provisionprofile_path.as_ref())
+    {
+        if !embedded_provisionprofile_file.exists() {
+            return Err(crate::Error::EmbeddedProvisionprofileFileNotFound(
+                embedded_provisionprofile_file.to_path_buf(),
+            ));
+        }
+
+        fs::copy(
+            embedded_provisionprofile_file,
+            contents_directory.join("embedded.provisionprofile"),
+        )
+        .map_err(|e| {
+            crate::Error::FailedToCopyEmbeddedProvisionprofile(
+                embedded_provisionprofile_file.to_path_buf(),
+                e,
+            )
+        })?;
+    }
+    Ok(())
+}
+
+// Copies app structures that may need to be embedded inside this app.
+#[tracing::instrument(level = "trace", skip(config))]
+fn copy_embedded_apps(contents_directory: &Path, config: &Config) -> crate::Result<Vec<PathBuf>> {
+    let mut paths = Vec::new();
+
+    if let Some(embedded_apps) = config.macos().and_then(|m| m.embedded_apps.as_ref()) {
+        let dest_dir = contents_directory.join("MacOS");
+
+        for embedded_app in embedded_apps {
+            let src_path = PathBuf::from(embedded_app);
+            let src_name = src_path
+                .file_name()
+                .ok_or_else(|| Error::FailedToExtractFilename(src_path.clone()))?;
+            let dest_path = dest_dir.join(src_name);
+            copy_dir(&src_path, &dest_path)?;
+
+            tracing::debug!("Copied embedded app: {:?}", dest_path);
+            paths.push(dest_path);
+        }
+    }
+    Ok(paths)
+}