Strip configuration file before attaching

Of sensitive or private data.

Passepartout-iOS/Global/IssueReporter.swift

@@ -24,6 +24,7 @@
 //
 
 import Foundation
+import TunnelKit
 import MessageUI
 
 class IssueReporter: NSObject {
@@ -86,8 +87,15 @@ class IssueReporter: NSObject {
             let attachment = DebugLog(raw: raw).decoratedData()
             vc.addAttachmentData(attachment, mimeType: AppConstants.IssueReporter.MIME.debugLog, fileName: AppConstants.IssueReporter.Filenames.debugLog)
         }
-        if let cfg = configurationURL, let attachment = try? Data(contentsOf: cfg) {
+        if let url = configurationURL {
-            vc.addAttachmentData(attachment, mimeType: AppConstants.IssueReporter.MIME.configuration, fileName: AppConstants.IssueReporter.Filenames.configuration)
+            var lines: [String] = []
+            do {
+                _ = try TunnelKitProvider.Configuration.parsed(from: url, stripped: &lines)
+                if let attachment = lines.joined(separator: "\n").data(using: .utf8) {
+                    vc.addAttachmentData(attachment, mimeType: AppConstants.IssueReporter.MIME.configuration, fileName: AppConstants.IssueReporter.Filenames.configuration)
+                }
+            } catch {
+            }
         }
         vc.mailComposeDelegate = self
         vc.apply(Theme.current)

Passepartout/Sources/VPN/TunnelKitProvider+FileConfiguration.swift

@@ -62,7 +62,7 @@ extension TunnelKitProvider.Configuration {
         static let blockEnd = Utils.regex("^<\\/[\\w\\-]+>")
     }
     
-    static func parsed(from url: URL) throws -> (String, TunnelKitProvider.Configuration) {
+    static func parsed(from url: URL, stripped: UnsafeMutablePointer<[String]>? = nil) throws -> (String, TunnelKitProvider.Configuration) {
         let lines = try String(contentsOf: url).trimmedLines()
 
         var defaultProto: TunnelKitProvider.SocketType?
@@ -90,7 +90,16 @@ extension TunnelKitProvider.Configuration {
         for line in lines {
             log.verbose(line)
 
+            var isHandled = false
+            var strippedLine = line
+            defer {
+                if isHandled {
+                    stripped?.pointee.append(strippedLine)
+                }
+            }
+
             Regex.blockBegin.enumerateComponents(in: line) {
+                isHandled = true
                 let tag = $0.first!
                 let from = tag.index(after: tag.startIndex)
                 let to = tag.index(before: tag.endIndex)
@@ -99,6 +108,7 @@ extension TunnelKitProvider.Configuration {
                 currentBlock = []
             }
             Regex.blockEnd.enumerateComponents(in: line) {
+                isHandled = true
                 let tag = $0.first!
                 let from = tag.index(tag.startIndex, offsetBy: 2)
                 let to = tag.index(before: tag.endIndex)
@@ -140,6 +150,7 @@ extension TunnelKitProvider.Configuration {
             }
             
             Regex.proto.enumerateArguments(in: line) {
+                isHandled = true
                 guard let str = $0.first else {
                     return
                 }
@@ -149,26 +160,35 @@ extension TunnelKitProvider.Configuration {
                 }
             }
             Regex.port.enumerateArguments(in: line) {
+                isHandled = true
                 guard let str = $0.first else {
                     return
                 }
                 defaultPort = UInt16(str)
             }
             Regex.remote.enumerateArguments(in: line) {
+                isHandled = true
                 guard let hostname = $0.first else {
                     return
                 }
                 var port: UInt16?
                 var proto: TunnelKitProvider.SocketType?
+                var strippedComponents = ["remote", "<hostname>"]
                 if $0.count > 1 {
                     port = UInt16($0[1])
+                    strippedComponents.append($0[1])
                 }
                 if $0.count > 2 {
                     proto = TunnelKitProvider.SocketType(protoString: $0[2])
+                    strippedComponents.append($0[2])
                 }
                 remotes.append((hostname, port, proto))
+
+                // replace private data
+                strippedLine = strippedComponents.joined(separator: " ")
             }
             Regex.cipher.enumerateArguments(in: line) {
+                isHandled = true
                 guard let rawValue = $0.first else {
                     return
                 }
@@ -178,6 +198,7 @@ extension TunnelKitProvider.Configuration {
                 }
             }
             Regex.auth.enumerateArguments(in: line) {
+                isHandled = true
                 guard let rawValue = $0.first else {
                     return
                 }
@@ -187,24 +208,29 @@ extension TunnelKitProvider.Configuration {
                 }
             }
             Regex.compLZO.enumerateComponents(in: line) { _ in
+                isHandled = true
                 compressionFraming = .compLZO
             }
             Regex.compress.enumerateComponents(in: line) { _ in
+                isHandled = true
                 compressionFraming = .compress
             }
             Regex.keyDirection.enumerateArguments(in: line) {
+                isHandled = true
                 guard let arg = $0.first, let value = Int(arg) else {
                     return
                 }
                 keyDirection = StaticKey.Direction(rawValue: value)
             }
             Regex.ping.enumerateArguments(in: line) {
+                isHandled = true
                 guard let arg = $0.first else {
                     return
                 }
                 keepAliveSeconds = TimeInterval(arg)
             }
             Regex.renegSec.enumerateArguments(in: line) {
+                isHandled = true
                 guard let arg = $0.first else {
                     return
                 }

PassepartoutTests-iOS/FileConfigurationTests.swift

@@ -44,6 +44,13 @@ class FileConfigurationTests: XCTestCase {
         XCTAssertEqual(cfg.sessionConfiguration.digest, .sha1)
     }
 
+    func testStripped() throws {
+        var lines: [String] = []
+        _ = try TunnelKitProvider.Configuration.parsed(from: url(withName: "pia-hungary"), stripped: &lines)
+        let cfg = lines.joined(separator: "\n")
+        print(cfg)
+    }
+    
     private func url(withName name: String) -> URL {
         return Bundle(for: FileConfigurationTests.self).url(forResource: name, withExtension: "ovpn")!
     }