Include stripped config in debugging bundle

Author: elibroftw

apple/client/DebugBundle.swift

@@ -109,21 +109,23 @@ private class DebugBundleBuilder {
     let bundleTimestamp = Date()
     let jsonEncoder = JSONEncoder()
     let logStartTimestamp: Date
+    let appState: AppState?
 
     let dispatchQueue = DispatchQueue.global(qos: .userInitiated)
     var lock = NSLock()
     var pendingTasks = PendingTasks()
     var tasks: [String: TaskResult] = [:]
 
-    init() throws {
+    init(appState: AppState?) throws {
+        self.appState = appState
         self.tmpFolder = try FileManager.default.url(
             for: FileManager.SearchPathDirectory.itemReplacementDirectory,
             in: FileManager.SearchPathDomainMask.userDomainMask,
             appropriateFor: FileManager.default.temporaryDirectory,
             create: true
         )
         self.archiveFolder = self.tmpFolder.appending(
-            component: "Obscura Debuging Archive \(utcDateFormat.string(from: self.bundleTimestamp))"
+            component: "Obscura Debugging Archive \(utcDateFormat.string(from: self.bundleTimestamp))"
         )
         try FileManager.default.createDirectory(
             at: self.archiveFolder,
@@ -371,6 +373,24 @@ private class DebugBundleBuilder {
         }
     }
 
+    func bundleNEDebugInfo() async {
+        guard let manager = self.appState?.manager else {
+            self.writeError(name: "ne-debug-info", error: "appState or manager is nil")
+            return
+        }
+        do {
+            let neDebugInfoJsonString = try await runNeJsonCommand(manager, NeManagerCmd.getDebugInfo.json(), attemptTimeout: .seconds(10))
+            let value = try JSONSerialization.jsonObject(with: Data(neDebugInfoJsonString.utf8))
+            let json = try JSONSerialization.data(
+                withJSONObject: value,
+                options: [.fragmentsAllowed, .prettyPrinted, .sortedKeys]
+            )
+            try self.writeFile(name: "ne-debug-info.json", data: json)
+        } catch {
+            self.writeError(name: "ne-debug-info", error: error)
+        }
+    }
+
     func bundleTask(_ name: String, _ block: @escaping (BundleTask) async throws -> Void) {
         BundleTask(self, name, block)
     }
@@ -395,6 +415,7 @@ private class DebugBundleBuilder {
         }
 
         self.bundleTask("extensions") { _task in try await self.bundleExtensions() }
+        self.bundleTask("ne-debug-info") { _task in await self.bundleNEDebugInfo() }
         self.bundleTask("info") { _task in try self.bundleInfo() }
 
         self.bundleCmd("arp", ["/usr/sbin/arp", "-na"])
@@ -556,7 +577,7 @@ public class DebugBundleRC {
     }
 }
 
-func _createDebuggingArchive() async throws -> String {
+func _createDebuggingArchive(appState: AppState?) async throws -> String {
     let _activity = ProcessInfo.processInfo.beginActivity(
         options: [
             .automaticTerminationDisabled,
@@ -569,7 +590,7 @@ func _createDebuggingArchive() async throws -> String {
 
     var start = SuspendingClock.now
 
-    let builder = try DebugBundleBuilder()
+    let builder = try DebugBundleBuilder(appState: appState)
     await builder.bundleAll()
     let zipPath = try builder.createArchive()
 
@@ -587,7 +608,7 @@ func createDebuggingArchive(appState: AppState?) async throws -> String {
         _debugBundleRc = DebugBundleRC(appState)
     }
     do {
-        let path = try await _createDebuggingArchive()
+        let path = try await _createDebuggingArchive(appState: appState)
         _ = appState?.osStatus.update { value in
             value.debugBundleStatus.setPath(path)
         }

apple/shared/NetworkExtensionIpc.swift

@@ -10,6 +10,7 @@ enum NeManagerCmdResult: Codable {
 }
 
 enum NeManagerCmd: Codable {
+    case getDebugInfo
     case apiGetAccountInfo
     case getStatus(knownVersion: UUID?)
     case getTrafficStats

rustlib/src/config/persistence.rs

@@ -246,6 +246,51 @@ pub struct Config {
     pub cached_account_status: Option<AccountStatus>,
 }
 
+// Redact sensitive fields by default
+#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
+pub struct ConfigDebug {
+    pub api_url: Option<String>,
+    pub local_tunnels_ids: Vec<String>,
+    pub in_new_account_flow: bool,
+    pub pinned_exits: Vec<String>,
+    pub pinned_locations: Option<Vec<PinnedLocation>>,
+    pub last_chosen_exit: Option<String>,
+    pub use_wireguard_key_cache: (),
+    pub has_account_id: bool,
+    pub has_cached_auth_token: bool,
+}
+
+impl From<Config> for ConfigDebug {
+    fn from(config: Config) -> Self {
+        let Config {
+            api_url,
+            account_id,
+            old_account_ids: _,
+            local_tunnels_ids,
+            exit: (),
+            in_new_account_flow,
+            cached_auth_token,
+            pinned_exits,
+            pinned_locations,
+            last_chosen_exit,
+            wireguard_key_cache: _,
+            use_wireguard_key_cache,
+            cached_account_status: _,
+        } = config;
+        Self {
+            api_url,
+            local_tunnels_ids,
+            in_new_account_flow,
+            pinned_exits,
+            pinned_locations,
+            last_chosen_exit,
+            use_wireguard_key_cache,
+            has_account_id: account_id.is_some(),
+            has_cached_auth_token: cached_auth_token.is_some(),
+        }
+    }
+}
+
 #[serde_with::serde_as]
 #[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq)]
 pub struct PinnedLocation {

rustlib/src/manager.rs

@@ -21,7 +21,7 @@ use uuid::Uuid;
 
 use crate::{
     client_state::AccountStatus,
-    config::{Config, ConfigLoadError, ConfigSaveError, PinnedLocation},
+    config::{Config, ConfigDebug, ConfigLoadError, ConfigSaveError, PinnedLocation},
     errors::ApiError,
     tunnel_state::TunnelState,
 };
@@ -307,6 +307,15 @@ impl Manager {
     pub fn rotate_wg_key(&self) -> Result<(), ConfigSaveError> {
         self.client_state.rotate_wg_key()
     }
+
+    pub fn get_debug_info(&self) -> DebugInfo {
+        DebugInfo { config: self.client_state.get_config().into() }
+    }
+}
+
+#[derive(Debug, Serialize, Deserialize)]
+pub struct DebugInfo {
+    config: ConfigDebug,
 }
 
 #[derive(Debug, Copy, Clone, Serialize, Deserialize)]

rustlib/src/manager_cmd.rs

@@ -9,7 +9,7 @@ use serde::{Deserialize, Serialize};
 use strum::IntoStaticStr;
 use uuid::Uuid;
 
-use crate::manager::{Manager, ManagerTrafficStats, Status};
+use crate::manager::{DebugInfo, Manager, ManagerTrafficStats, Status};
 use crate::{config::ConfigSaveError, errors::ApiError};
 use crate::{config::PinnedLocation, manager::TunnelArgs};
 
@@ -75,6 +75,7 @@ impl From<&ApiError> for ManagerCmdErrorCode {
 pub enum ManagerCmd {
     ApiGetAccountInfo {},
     ApiListExit {},
+    GetDebugInfo {},
     GetStatus { known_version: Option<Uuid> },
     GetTrafficStats {},
     Login { account_id: AccountId, validate: bool },
@@ -91,10 +92,11 @@ pub enum ManagerCmd {
 #[serde(untagged)]
 pub enum ManagerCmdOk {
     Empty,
-    GetTrafficStats(ManagerTrafficStats),
     ApiListExit(<ListExits2 as Cmd>::Output),
     ApiGetAccountInfo(<GetAccountInfo as Cmd>::Output),
+    GetDebugInfo(DebugInfo),
     GetStatus(Status),
+    GetTrafficStats(ManagerTrafficStats),
 }
 
 impl ManagerCmd {
@@ -145,6 +147,7 @@ impl ManagerCmd {
                 Ok(()) => Ok(ManagerCmdOk::Empty),
                 Err(err) => Err((&err).into()),
             },
+            ManagerCmd::GetDebugInfo {} => Ok(ManagerCmdOk::GetDebugInfo(manager.get_debug_info())),
         }
     }
 }