ios: SOCKS proxy UI (#4893)

* ios: SOCKS proxy UI * update network config * proxy * adapt * move, dont default to localhost:9050 * move socks proxy to defaults * sock proxy preference * rename * rename * fix * fix --------- Co-authored-by: Avently <7953703+avently@users.noreply.github.com>
2026-03-31 22:46:13 +00:00 · 2024-09-17 17:34:24 +01:00
parent c13c7baaaf
commit 665d9dcd00
7 changed files with 197 additions and 17 deletions
--- a/apps/ios/Shared/Views/ChatList/ServersSummaryView.swift
+++ b/apps/ios/Shared/Views/ChatList/ServersSummaryView.swift
@@ -407,12 +407,18 @@ struct ServersSummaryView: View {

 struct SubscriptionStatusIndicatorView: View {
    @EnvironmentObject var m: ChatModel
+    @EnvironmentObject var theme: AppTheme
    var subs: SMPServerSubs
    var hasSess: Bool

    var body: some View {
-        let onionHosts = networkUseOnionHostsGroupDefault.get()
-        let (color, variableValue, opacity, _) = subscriptionStatusColorAndPercentage(m.networkInfo.online, onionHosts, subs, hasSess)
+        let (color, variableValue, opacity, _) = subscriptionStatusColorAndPercentage(
+            online: m.networkInfo.online,
+            usesProxy: networkUseOnionHostsGroupDefault.get() != .no || groupDefaults.string(forKey: GROUP_DEFAULT_NETWORK_SOCKS_PROXY) != nil,
+            subs: subs,
+            hasSess: hasSess,
+            primaryColor: theme.colors.primary
+        )
        if #available(iOS 16.0, *) {
            Image(systemName: "dot.radiowaves.up.forward", variableValue: variableValue)
                .foregroundColor(color)
@@ -425,26 +431,32 @@ struct SubscriptionStatusIndicatorView: View {

 struct SubscriptionStatusPercentageView: View {
    @EnvironmentObject var m: ChatModel
+    @EnvironmentObject var theme: AppTheme
    var subs: SMPServerSubs
    var hasSess: Bool

    var body: some View {
-        let onionHosts = networkUseOnionHostsGroupDefault.get()
-        let (_, _, _, statusPercent) = subscriptionStatusColorAndPercentage(m.networkInfo.online, onionHosts, subs, hasSess)
+        let (_, _, _, statusPercent) = subscriptionStatusColorAndPercentage(
+            online: m.networkInfo.online,
+            usesProxy: networkUseOnionHostsGroupDefault.get() != .no || groupDefaults.string(forKey: GROUP_DEFAULT_NETWORK_SOCKS_PROXY) != nil,
+            subs: subs,
+            hasSess: hasSess,
+            primaryColor: theme.colors.primary
+        )
        Text(verbatim: "\(Int(floor(statusPercent * 100)))%")
            .foregroundColor(.secondary)
            .font(.caption)
    }
 }

-func subscriptionStatusColorAndPercentage(_ online: Bool, _ onionHosts: OnionHosts, _ subs: SMPServerSubs, _ hasSess: Bool) -> (Color, Double, Double, Double) {
+func subscriptionStatusColorAndPercentage(online: Bool, usesProxy: Bool, subs: SMPServerSubs, hasSess: Bool, primaryColor: Color) -> (Color, Double, Double, Double) {
    func roundedToQuarter(_ n: Double) -> Double {
        n >= 1 ? 1
        : n <= 0 ? 0
        : (n * 4).rounded() / 4
    }

-    let activeColor: Color = onionHosts == .require ? .indigo : .accentColor
+    let activeColor: Color = usesProxy ? .indigo : primaryColor
    let noConnColorAndPercent: (Color, Double, Double, Double) = (Color(uiColor: .tertiaryLabel), 1, 1, 0)
    let activeSubsRounded = roundedToQuarter(subs.shareOfActive)

--- a/apps/ios/Shared/Views/Migration/MigrateFromDevice.swift
+++ b/apps/ios/Shared/Views/Migration/MigrateFromDevice.swift
@@ -529,9 +529,15 @@ struct MigrateFromDevice: View {
                        }
                    case let .sndStandaloneFileComplete(_, fileTransferMeta, rcvURIs):
                        let cfg = getNetCfg()
+                        let proxy: NetworkProxy? = if cfg.socksProxy == nil {
+                            nil
+                        } else {
+                            networkProxyDefault.get()
+                        }
                        let data = MigrationFileLinkData.init(
                            networkConfig: MigrationFileLinkData.NetworkConfig(
                                socksProxy: cfg.socksProxy,
+                                networkProxy: proxy,
                                hostMode: cfg.hostMode,
                                requiredHostMode: cfg.requiredHostMode
                            )
--- a/apps/ios/Shared/Views/UserSettings/AdvancedNetworkSettings.swift
+++ b/apps/ios/Shared/Views/UserSettings/AdvancedNetworkSettings.swift
@@ -36,6 +36,10 @@ struct AdvancedNetworkSettings: View {
    @State private var showSettingsAlert: NetworkSettingsAlert?
    @State private var onionHosts: OnionHosts = .no
    @State private var showSaveDialog = false
+    @State private var netProxy = networkProxyDefault.get()
+    @State private var currentNetProxy = networkProxyDefault.get()
+    @State private var useNetProxy = false
+    @State private var netProxyAuth = false

    var body: some View {
        VStack {
@@ -102,6 +106,76 @@ struct AdvancedNetworkSettings: View {
                    .foregroundColor(theme.colors.secondary)
                }

+                Section {
+                    Toggle("Use SOCKS proxy", isOn: $useNetProxy)
+                    Group {
+                        TextField("IP address", text: $netProxy.host)
+                        TextField(
+                            "Port",
+                            text: Binding(
+                                get: { netProxy.port > 0 ? "\(netProxy.port)" : "" },
+                                set: { s in
+                                    netProxy.port = if let port = Int(s), port > 0 {
+                                        port
+                                    } else {
+                                        0
+                                    }
+                                }
+                            )
+                        )
+                        Toggle("Proxy requires password", isOn: $netProxyAuth)
+                        if netProxyAuth {
+                            TextField("Username", text: $netProxy.username)
+                            PassphraseField(
+                                key: $netProxy.password,
+                                placeholder: "Password",
+                                valid: NetworkProxy.validCredential(netProxy.password)
+                            )
+                        }
+                    }
+                    .if(!useNetProxy) { $0.foregroundColor(theme.colors.secondary) }
+                    .disabled(!useNetProxy)
+                } header: {
+                    HStack {
+                        Text("SOCKS proxy").foregroundColor(theme.colors.secondary)
+                        if useNetProxy && !netProxy.valid {
+                            Spacer()
+                            Image(systemName: "exclamationmark.circle.fill").foregroundColor(.red)
+                        }
+                    }
+                } footer: {
+                    if netProxyAuth {
+                        Text("Your credentials may be sent unencrypted.")
+                            .foregroundColor(theme.colors.secondary)
+                    } else {
+                        Text("Do not use credentials with proxy.")
+                            .foregroundColor(theme.colors.secondary)
+                    }
+                }
+                .onChange(of: useNetProxy) { useNetProxy in
+                    netCfg.socksProxy = useNetProxy && currentNetProxy.valid
+                        ? currentNetProxy.toProxyString()
+                        : nil
+                    netProxy = currentNetProxy
+                    netProxyAuth = netProxy.username != "" || netProxy.password != ""
+                }
+                .onChange(of: netProxyAuth) { netProxyAuth in
+                    if netProxyAuth {
+                        netProxy.auth = currentNetProxy.auth
+                        netProxy.username = currentNetProxy.username
+                        netProxy.password = currentNetProxy.password
+                    } else {
+                        netProxy.auth = .username
+                        netProxy.username = ""
+                        netProxy.password = ""
+                    }
+                }
+                .onChange(of: netProxy) { netProxy in
+                    netCfg.socksProxy = useNetProxy && netProxy.valid
+                        ? netProxy.toProxyString()
+                        : nil
+                }
+
                Section {
                    Picker("Use .onion hosts", selection: $onionHosts) {
                        ForEach(OnionHosts.values, id: \.self) { Text($0.text) }
@@ -156,19 +230,19 @@ struct AdvancedNetworkSettings: View {
                
                Section {
                    Button("Reset to defaults") {
-                        updateNetCfgView(NetCfg.defaults)
+                        updateNetCfgView(NetCfg.defaults, NetworkProxy.def)
                    }
                    .disabled(netCfg == NetCfg.defaults)

                    Button("Set timeouts for proxy/VPN") {
-                        updateNetCfgView(netCfg.withProxyTimeouts)
+                        updateNetCfgView(netCfg.withProxyTimeouts, netProxy)
                    }
                    .disabled(netCfg.hasProxyTimeouts)
                    
                    Button("Save and reconnect") {
                        showSettingsAlert = .update
                    }
-                    .disabled(netCfg == currentNetCfg)
+                    .disabled(netCfg == currentNetCfg || (useNetProxy && !netProxy.valid))
                }
            }
        }
@@ -182,7 +256,8 @@ struct AdvancedNetworkSettings: View {
            if cfgLoaded { return }
            cfgLoaded = true
            currentNetCfg = getNetCfg()
-            updateNetCfgView(currentNetCfg)
+            currentNetProxy = networkProxyDefault.get()
+            updateNetCfgView(currentNetCfg, currentNetProxy)
        }
        .alert(item: $showSettingsAlert) { a in
            switch a {
@@ -206,7 +281,7 @@ struct AdvancedNetworkSettings: View {
            if netCfg == currentNetCfg {
                dismiss()
                cfgLoaded = false
-            } else {
+            } else if !useNetProxy || netProxy.valid {
                showSaveDialog = true
            }
        })
@@ -221,18 +296,26 @@ struct AdvancedNetworkSettings: View {
        }
    }

-    private func updateNetCfgView(_ cfg: NetCfg) {
+    private func updateNetCfgView(_ cfg: NetCfg, _ proxy: NetworkProxy) {
        netCfg = cfg
+        netProxy = proxy
        onionHosts = OnionHosts(netCfg: netCfg)
        enableKeepAlive = netCfg.enableKeepAlive
        keepAliveOpts = netCfg.tcpKeepAlive ?? KeepAliveOpts.defaults
+        useNetProxy = netCfg.socksProxy != nil
+        netProxyAuth = switch netProxy.auth {
+        case .username: netProxy.username != "" || netProxy.password != ""
+        case .isolate: false
+        }
    }

    private func saveNetCfg() -> Bool {
        do {
            try setNetworkConfig(netCfg)
            currentNetCfg = netCfg
-            setNetCfg(netCfg)
+            setNetCfg(netCfg, networkProxy: useNetProxy ? netProxy : nil)
+            currentNetProxy = netProxy
+            networkProxyDefault.set(netProxy)
            return true
        } catch let error {
            let err = responseError(error)
--- a/apps/ios/Shared/Views/UserSettings/AppSettings.swift
+++ b/apps/ios/Shared/Views/UserSettings/AppSettings.swift
@@ -19,9 +19,15 @@ extension AppSettings {
                val.hostMode = .publicHost
                val.requiredHostMode = true
            }
-            val.socksProxy = nil
-            setNetCfg(val)
+            if val.socksProxy != nil {
+                val.socksProxy = networkProxy?.toProxyString()
+                setNetCfg(val, networkProxy: networkProxy)
+            } else {
+                val.socksProxy = nil
+                setNetCfg(val, networkProxy: nil)
+            }
        }
+        if let val = networkProxy { networkProxyDefault.set(val) }
        if let val = privacyEncryptLocalFiles { privacyEncryptLocalFilesGroupDefault.set(val) }
        if let val = privacyAskToApproveRelays { privacyAskToApproveRelaysGroupDefault.set(val) }
        if let val = privacyAcceptImages {
@@ -63,6 +69,7 @@ extension AppSettings {
        let def = UserDefaults.standard
        var c = AppSettings.defaults
        c.networkConfig = getNetCfg()
+        c.networkProxy = networkProxyDefault.get()
        c.privacyEncryptLocalFiles = privacyEncryptLocalFilesGroupDefault.get()
        c.privacyAskToApproveRelays = privacyAskToApproveRelaysGroupDefault.get()
        c.privacyAcceptImages = privacyAcceptImagesGroupDefault.get()
--- a/apps/ios/Shared/Views/UserSettings/SettingsView.swift
+++ b/apps/ios/Shared/Views/UserSettings/SettingsView.swift
@@ -75,6 +75,8 @@ let DEFAULT_SYSTEM_DARK_THEME = "systemDarkTheme"
 let DEFAULT_CURRENT_THEME_IDS = "currentThemeIds"
 let DEFAULT_THEME_OVERRIDES = "themeOverrides"

+let DEFAULT_NETWORK_PROXY = "networkProxy"
+
 let ANDROID_DEFAULT_CALL_ON_LOCK_SCREEN = "androidCallOnLockScreen"

 let defaultChatItemRoundness: Double = 0.75
@@ -251,6 +253,7 @@ public class CodableDefault<T: Codable> {
    }
 }

+let networkProxyDefault: CodableDefault<NetworkProxy> = CodableDefault(defaults: UserDefaults.standard, forKey: DEFAULT_NETWORK_PROXY, withDefault: NetworkProxy.def)

 struct SettingsView: View {
    @Environment(\.colorScheme) var colorScheme
--- a/apps/ios/SimpleXChat/APITypes.swift
+++ b/apps/ios/SimpleXChat/APITypes.swift
@@ -8,6 +8,7 @@

 import Foundation
 import SwiftUI
+import Network

 public let jsonDecoder = getJSONDecoder()
 public let jsonEncoder = getJSONEncoder()
@@ -1497,6 +1498,63 @@ public struct KeepAliveOpts: Codable, Equatable {
    public static let defaults: KeepAliveOpts = KeepAliveOpts(keepIdle: 30, keepIntvl: 15, keepCnt: 4)
 }

+public struct NetworkProxy: Equatable, Codable {
+    public var host: String = ""
+    public var port: Int = 0
+    public var auth: NetworkProxyAuth = .username
+    public var username: String = ""
+    public var password: String = ""
+
+    public static var def: NetworkProxy {
+        NetworkProxy()
+    }
+    
+    public var valid: Bool {
+        let hostOk = switch NWEndpoint.Host(host) {
+        case .ipv4: true
+        case .ipv6: true
+        default: false
+        }
+        return hostOk &&
+                port > 0 && port <= 65535 &&
+                NetworkProxy.validCredential(username) && NetworkProxy.validCredential(password)
+    }
+    
+    public static func validCredential(_ s: String) -> Bool {
+        !s.contains(":") && !s.contains("@")
+    }
+
+    public func toProxyString() -> String? {
+        if !valid { return nil }
+        var res = ""
+        switch auth {
+        case .username:
+            let usernameTrimmed = username.trimmingCharacters(in: .whitespaces)
+            let passwordTrimmed = password.trimmingCharacters(in: .whitespaces)
+            if usernameTrimmed != "" || passwordTrimmed != "" {
+                res += usernameTrimmed + ":" + passwordTrimmed + "@"
+            } else {
+                res += "@"
+            }
+        case .isolate: ()
+        }
+        if host != "" {
+            if host.contains(":") {
+                res += "[\(host.trimmingCharacters(in: [" ", "[", "]"]))]"
+            } else {
+                res += host.trimmingCharacters(in: .whitespaces)
+            }
+        }
+        res += ":\(port)"
+        return res
+    }
+}
+
+public enum NetworkProxyAuth: String, Codable {
+    case username
+    case isolate
+}
+
 public enum NetworkStatus: Decodable, Equatable {
    case unknown
    case connected
@@ -2120,11 +2178,13 @@ public struct MigrationFileLinkData: Codable {

    public struct NetworkConfig: Codable {
        let socksProxy: String?
+        let networkProxy: NetworkProxy?
        let hostMode: HostMode?
        let requiredHostMode: Bool?

-        public init(socksProxy: String?, hostMode: HostMode?, requiredHostMode: Bool?) {
+        public init(socksProxy: String?, networkProxy: NetworkProxy?, hostMode: HostMode?, requiredHostMode: Bool?) {
            self.socksProxy = socksProxy
+            self.networkProxy = networkProxy
            self.hostMode = hostMode
            self.requiredHostMode = requiredHostMode
        }
@@ -2133,6 +2193,7 @@ public struct MigrationFileLinkData: Codable {
            return if let hostMode, let requiredHostMode {
                NetworkConfig(
                    socksProxy: nil,
+                    networkProxy: nil,
                    hostMode: hostMode == .onionViaSocks ? .onionHost : hostMode,
                    requiredHostMode: requiredHostMode
                )
@@ -2152,6 +2213,7 @@ public struct MigrationFileLinkData: Codable {

 public struct AppSettings: Codable, Equatable {
    public var networkConfig: NetCfg? = nil
+    public var networkProxy: NetworkProxy? = nil
    public var privacyEncryptLocalFiles: Bool? = nil
    public var privacyAskToApproveRelays: Bool? = nil
    public var privacyAcceptImages: Bool? = nil
@@ -2183,6 +2245,7 @@ public struct AppSettings: Codable, Equatable {
        var empty = AppSettings()
        let def = AppSettings.defaults
        if networkConfig != def.networkConfig { empty.networkConfig = networkConfig }
+        if networkProxy != def.networkProxy { empty.networkProxy = networkProxy }
        if privacyEncryptLocalFiles != def.privacyEncryptLocalFiles { empty.privacyEncryptLocalFiles = privacyEncryptLocalFiles }
        if privacyAskToApproveRelays != def.privacyAskToApproveRelays { empty.privacyAskToApproveRelays = privacyAskToApproveRelays }
        if privacyAcceptImages != def.privacyAcceptImages { empty.privacyAcceptImages = privacyAcceptImages }
@@ -2215,6 +2278,7 @@ public struct AppSettings: Codable, Equatable {
    public static var defaults: AppSettings {
        AppSettings (
            networkConfig: NetCfg.defaults,
+            networkProxy: NetworkProxy.def,
            privacyEncryptLocalFiles: true,
            privacyAskToApproveRelays: true,
            privacyAcceptImages: true,
--- a/apps/ios/SimpleXChat/AppGroup.swift
+++ b/apps/ios/SimpleXChat/AppGroup.swift
@@ -35,6 +35,7 @@ public let GROUP_DEFAULT_PRIVACY_ASK_TO_APPROVE_RELAYS = "privacyAskToApproveRel
 // replaces DEFAULT_PROFILE_IMAGE_CORNER_RADIUS
 public let GROUP_DEFAULT_PROFILE_IMAGE_CORNER_RADIUS = "profileImageCornerRadius"
 let GROUP_DEFAULT_NTF_BADGE_COUNT = "ntgBadgeCount"
+public let GROUP_DEFAULT_NETWORK_SOCKS_PROXY = "networkSocksProxy"
 let GROUP_DEFAULT_NETWORK_USE_ONION_HOSTS = "networkUseOnionHosts"
 let GROUP_DEFAULT_NETWORK_SESSION_MODE = "networkSessionMode"
 let GROUP_DEFAULT_NETWORK_SMP_PROXY_MODE = "networkSMPProxyMode"
@@ -327,6 +328,7 @@ public class Default<T> {
 }

 public func getNetCfg() -> NetCfg {
+    let socksProxy = groupDefaults.string(forKey: GROUP_DEFAULT_NETWORK_SOCKS_PROXY)
    let onionHosts = networkUseOnionHostsGroupDefault.get()
    let (hostMode, requiredHostMode) = onionHosts.hostMode
    let sessionMode = networkSessionModeGroupDefault.get()
@@ -349,6 +351,7 @@ public func getNetCfg() -> NetCfg {
        tcpKeepAlive = nil
    }
    return NetCfg(
+        socksProxy: socksProxy,
        hostMode: hostMode,
        requiredHostMode: requiredHostMode,
        sessionMode: sessionMode,
@@ -365,11 +368,13 @@ public func getNetCfg() -> NetCfg {
    )
 }

-public func setNetCfg(_ cfg: NetCfg) {
+public func setNetCfg(_ cfg: NetCfg, networkProxy: NetworkProxy?) {
    networkUseOnionHostsGroupDefault.set(OnionHosts(netCfg: cfg))
    networkSessionModeGroupDefault.set(cfg.sessionMode)
    networkSMPProxyModeGroupDefault.set(cfg.smpProxyMode)
    networkSMPProxyFallbackGroupDefault.set(cfg.smpProxyFallback)
+    let socksProxy = networkProxy?.toProxyString()
+    groupDefaults.set(socksProxy, forKey: GROUP_DEFAULT_NETWORK_SOCKS_PROXY)
    groupDefaults.set(cfg.tcpConnectTimeout, forKey: GROUP_DEFAULT_NETWORK_TCP_CONNECT_TIMEOUT)
    groupDefaults.set(cfg.tcpTimeout, forKey: GROUP_DEFAULT_NETWORK_TCP_TIMEOUT)
    groupDefaults.set(cfg.tcpTimeoutPerKb, forKey: GROUP_DEFAULT_NETWORK_TCP_TIMEOUT_PER_KB)