1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
|
//
// ConsolidatedApplicationLog.swift
// MullvadVPN
//
// Created by pronebird on 29/10/2020.
// Copyright © 2025 Mullvad VPN AB. All rights reserved.
//
import Foundation
private let kLogDelimiter = "===================="
private let kRedactedPlaceholder = "[REDACTED]"
private let kRedactedAccountPlaceholder = "[REDACTED ACCOUNT NUMBER]"
private let kRedactedContainerPlaceholder = "[REDACTED CONTAINER PATH]"
class ConsolidatedApplicationLog: TextOutputStreamable, @unchecked Sendable {
typealias Metadata = KeyValuePairs<MetadataKey, String>
private let bufferSize: UInt64
enum MetadataKey: String {
case id, os
case productVersion = "mullvad-product-version"
}
struct LogAttachment {
let label: String
let content: String
}
let redactCustomStrings: [String]?
let applicationGroupContainers: [URL]
let metadata: Metadata
private let logQueue = DispatchQueue(label: "com.mullvad.consolidation.logs.queue")
private var logs: [LogAttachment] = []
init(
redactCustomStrings: [String]? = nil,
redactContainerPathsForSecurityGroupIdentifiers securityGroupIdentifiers: [String],
bufferSize: UInt64
) {
metadata = Self.makeMetadata()
self.redactCustomStrings = redactCustomStrings
self.bufferSize = bufferSize
applicationGroupContainers =
securityGroupIdentifiers
.compactMap { securityGroupIdentifier -> URL? in
FileManager.default
.containerURL(forSecurityApplicationGroupIdentifier: securityGroupIdentifier)
}
}
func addLogFiles(fileURLs: [URL], completion: (@Sendable () -> Void)? = nil) {
logQueue.async(flags: .barrier) {
for fileURL in fileURLs {
self.addSingleLogFile(fileURL)
}
DispatchQueue.main.async {
completion?()
}
}
}
func addError(message: String, error: String, completion: (@Sendable () -> Void)? = nil) {
let redactedError = redact(string: error)
logQueue.async(flags: .barrier) {
self.logs.append(LogAttachment(label: message, content: redactedError))
DispatchQueue.main.async {
completion?()
}
}
}
var string: String {
var logsCopy: [LogAttachment] = []
var metadataCopy: Metadata = [:]
logQueue.sync {
logsCopy = logs
metadataCopy = metadata
}
guard !logsCopy.isEmpty else { return "" }
return formatLog(logs: logsCopy, metadata: metadataCopy)
}
func write(to stream: inout some TextOutputStream) {
var logsCopy: [LogAttachment] = []
var metadataCopy: Metadata = [:]
logQueue.sync {
logsCopy = logs
metadataCopy = metadata
}
let localOutput = formatLog(logs: logsCopy, metadata: metadataCopy)
stream.write(localOutput)
}
private func formatLog(logs: [LogAttachment], metadata: Metadata) -> String {
var result = "System information:\n"
for (key, value) in metadata {
result += "\(key.rawValue): \(value)\n"
}
result += "\n"
for attachment in logs {
result += "\(kLogDelimiter)\n"
result += "\(attachment.label)\n"
result += "\(kLogDelimiter)\n"
result += "\(attachment.content)\n\n"
}
return result
}
private func addSingleLogFile(_ fileURL: URL) {
guard fileURL.isFileURL else {
addError(
message: fileURL.absoluteString,
error: "Invalid log file URL: \(fileURL.absoluteString)."
)
return
}
let path = fileURL.path
let redactedPath = redact(string: path)
if let lossyString = readFileLossy(path: path, maxBytes: bufferSize) {
let redactedString = redact(string: lossyString)
logQueue.async(flags: .barrier) {
self.logs.append(LogAttachment(label: redactedPath, content: redactedString))
}
} else {
addError(message: redactedPath, error: "Log file does not exist: \(path).")
}
}
private static func makeMetadata() -> Metadata {
let osVersion = ProcessInfo.processInfo.operatingSystemVersion
let osVersionString =
"iOS \(osVersion.majorVersion).\(osVersion.minorVersion).\(osVersion.patchVersion)"
return [
.id: UUID().uuidString,
.productVersion: Bundle.main.productVersion,
.os: osVersionString,
]
}
private func readFileLossy(path: String, maxBytes: UInt64) -> String? {
guard let fileHandle = FileHandle(forReadingAtPath: path) else {
return nil
}
let endOfFileOffset = fileHandle.seekToEndOfFile()
if endOfFileOffset > maxBytes {
fileHandle.seek(toFileOffset: endOfFileOffset - maxBytes)
} else {
fileHandle.seek(toFileOffset: 0)
}
let replacementCharacter = Character(UTF8.decode(UTF8.encodedReplacementCharacter))
if let data = try? fileHandle.read(upToCount: Int(bufferSize)),
let lossyString = String(bytes: data, encoding: .utf8)
{
let resultString = lossyString.drop { ch in
// Drop leading replacement characters produced when decoding data
ch == replacementCharacter
}
return String(resultString)
} else {
return nil
}
}
private func redactCustomStrings(in string: String) -> String {
guard let customStrings = redactCustomStrings,
!customStrings.isEmpty
else {
return string
}
return customStrings.reduce(string) { resultString, redact in
resultString.replacingOccurrences(of: redact, with: kRedactedPlaceholder)
}
}
private func redact(string: String) -> String {
var result = string
result = redactContainerPaths(string: result)
result = redactAccountNumber(string: result)
result = redactIPv4Address(string: result)
result = redactIPv6Address(string: result)
result = redactCustomStrings(in: result)
return result
}
private func redactContainerPaths(string: String) -> String {
applicationGroupContainers.reduce(string) { resultString, containerURL -> String in
resultString.replacingOccurrences(
of: containerURL.path,
with: kRedactedContainerPlaceholder
)
}
}
private func redactAccountNumber(string: String) -> String {
// swift-format-ignore: NeverUseForceTry
redact(
regularExpression: try! NSRegularExpression(pattern: #"\d{16}"#),
string: string,
replacementString: kRedactedAccountPlaceholder
)
}
private func redactIPv4Address(string: String) -> String {
redact(
regularExpression: NSRegularExpression.ipv4RegularExpression,
string: string,
replacementString: kRedactedPlaceholder
)
}
private func redactIPv6Address(string: String) -> String {
redact(
regularExpression: NSRegularExpression.ipv6RegularExpression,
string: string,
replacementString: kRedactedPlaceholder
)
}
private func redact(
regularExpression: NSRegularExpression,
string: String,
replacementString: String
) -> String {
let nsRange = NSRange(string.startIndex..<string.endIndex, in: string)
let template = NSRegularExpression.escapedTemplate(for: replacementString)
return regularExpression.stringByReplacingMatches(
in: string,
options: [],
range: nsRange,
withTemplate: template
)
}
}
|
