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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2023 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
import Dispatch
import Basics
import PackageFingerprint
import PackageModel
import struct TSCUtility.Version
struct PackageVersionChecksumTOFU {
private let fingerprintStorage: PackageFingerprintStorage?
private let fingerprintCheckingMode: FingerprintCheckingMode
private let versionMetadataProvider: (PackageIdentity.RegistryIdentity, Version) throws -> RegistryClient
.PackageVersionMetadata
init(
fingerprintStorage: PackageFingerprintStorage?,
fingerprintCheckingMode: FingerprintCheckingMode,
versionMetadataProvider: @escaping (PackageIdentity.RegistryIdentity, Version) throws -> RegistryClient
.PackageVersionMetadata
) {
self.fingerprintStorage = fingerprintStorage
self.fingerprintCheckingMode = fingerprintCheckingMode
self.versionMetadataProvider = versionMetadataProvider
}
// MARK: - source archive
func validateSourceArchive(
registry: Registry,
package: PackageIdentity.RegistryIdentity,
version: Version,
checksum: String,
timeout: DispatchTimeInterval?,
observabilityScope: ObservabilityScope,
callbackQueue: DispatchQueue
) async throws {
try await safe_async {
self.validateSourceArchive(
registry: registry,
package: package,
version: version,
checksum: checksum,
timeout: timeout,
observabilityScope: observabilityScope,
callbackQueue: callbackQueue,
completion: $0
)
}
}
@available(*, noasync, message: "Use the async alternative")
func validateSourceArchive(
registry: Registry,
package: PackageIdentity.RegistryIdentity,
version: Version,
checksum: String,
timeout: DispatchTimeInterval?,
observabilityScope: ObservabilityScope,
callbackQueue: DispatchQueue,
completion: @escaping (Result<Void, Error>) -> Void
) {
self.getExpectedChecksum(
registry: registry,
package: package,
version: version,
timeout: timeout,
observabilityScope: observabilityScope,
callbackQueue: callbackQueue
) { result in
completion(
result.tryMap { expectedChecksum in
if checksum != expectedChecksum {
switch self.fingerprintCheckingMode {
case .strict:
throw RegistryError.invalidChecksum(expected: expectedChecksum, actual: checksum)
case .warn:
observabilityScope
.emit(
warning: "the checksum \(checksum) for source archive of \(package) \(version) does not match previously recorded value \(expectedChecksum)"
)
}
}
}
)
}
}
private func getExpectedChecksum(
registry: Registry,
package: PackageIdentity.RegistryIdentity,
version: Version,
timeout: DispatchTimeInterval?,
observabilityScope: ObservabilityScope,
callbackQueue: DispatchQueue,
completion: @escaping (Result<String, Error>) -> Void
) {
// We either use a previously recorded checksum, or fetch it from the registry.
self.readFromStorage(
package: package,
version: version,
contentType: .sourceCode,
observabilityScope: observabilityScope,
callbackQueue: callbackQueue
) { result in
switch result {
case .success(.some(let savedChecksum)):
completion(.success(savedChecksum))
default:
// Try fetching checksum from registry if:
// - No storage available
// - Checksum not found in storage
// - Reading from storage resulted in error
do {
let versionMetadata = try self.versionMetadataProvider(package, version)
guard let sourceArchiveResource = versionMetadata.sourceArchive else {
throw RegistryError.missingSourceArchive
}
guard let checksum = sourceArchiveResource.checksum else {
throw RegistryError.sourceArchiveMissingChecksum(
registry: registry,
package: package.underlying,
version: version
)
}
self.writeToStorage(
registry: registry,
package: package,
version: version,
checksum: checksum,
contentType: .sourceCode,
observabilityScope: observabilityScope,
callbackQueue: callbackQueue
) { writeResult in
completion(writeResult.tryMap { _ in checksum })
}
} catch {
completion(.failure(RegistryError.failedRetrievingReleaseChecksum(
registry: registry,
package: package.underlying,
version: version,
error: error
)))
}
}
}
}
// MARK: - manifests
func validateManifest(
registry: Registry,
package: PackageIdentity.RegistryIdentity,
version: Version,
toolsVersion: ToolsVersion?,
checksum: String,
timeout: DispatchTimeInterval?,
observabilityScope: ObservabilityScope,
callbackQueue: DispatchQueue
) async throws {
try await safe_async {
self.validateManifest(
registry: registry,
package: package,
version: version,
toolsVersion: toolsVersion,
checksum: checksum,
timeout: timeout,
observabilityScope: observabilityScope,
callbackQueue: callbackQueue,
completion: $0
)
}
}
@available(*, noasync, message: "Use the async alternative")
func validateManifest(
registry: Registry,
package: PackageIdentity.RegistryIdentity,
version: Version,
toolsVersion: ToolsVersion?,
checksum: String,
timeout: DispatchTimeInterval?,
observabilityScope: ObservabilityScope,
callbackQueue: DispatchQueue,
completion: @escaping (Result<Void, Error>) -> Void
) {
let contentType = Fingerprint.ContentType.manifest(toolsVersion)
self.readFromStorage(
package: package,
version: version,
contentType: .manifest(toolsVersion),
observabilityScope: observabilityScope,
callbackQueue: callbackQueue
) { result in
switch result {
case .success(.some(let expectedChecksum)):
// Previously recorded checksum
do {
if checksum != expectedChecksum {
switch self.fingerprintCheckingMode {
case .strict:
throw RegistryError.invalidChecksum(expected: expectedChecksum, actual: checksum)
case .warn:
observabilityScope
.emit(
warning: "the checksum \(checksum) for \(contentType) of \(package) \(version) does not match previously recorded value \(expectedChecksum)"
)
}
}
completion(.success(()))
} catch {
completion(.failure(error))
}
default:
self.writeToStorage(
registry: registry,
package: package,
version: version,
checksum: checksum,
contentType: .manifest(toolsVersion),
observabilityScope: observabilityScope,
callbackQueue: callbackQueue
) { writeResult in
completion(writeResult.tryMap { _ in () })
}
}
}
}
// MARK: - storage helpers
private func readFromStorage(
package: PackageIdentity.RegistryIdentity,
version: Version,
contentType: Fingerprint.ContentType,
observabilityScope: ObservabilityScope,
callbackQueue: DispatchQueue,
completion: @escaping (Result<String?, Error>) -> Void
) {
guard let fingerprintStorage else {
return completion(.success(nil))
}
fingerprintStorage.get(
package: package.underlying,
version: version,
kind: .registry,
contentType: contentType,
observabilityScope: observabilityScope,
callbackQueue: callbackQueue
) { result in
switch result {
case .success(let fingerprint):
completion(.success(fingerprint.value))
case .failure(PackageFingerprintStorageError.notFound):
completion(.success(nil))
case .failure(let error):
observabilityScope
.emit(
error: "failed to get registry fingerprint for \(contentType) of \(package) \(version) from storage",
underlyingError: error
)
completion(.failure(error))
}
}
}
private func writeToStorage(
registry: Registry,
package: PackageIdentity.RegistryIdentity,
version: Version,
checksum: String,
contentType: Fingerprint.ContentType,
observabilityScope: ObservabilityScope,
callbackQueue: DispatchQueue,
completion: @escaping (Result<Void, Error>) -> Void
) {
guard let fingerprintStorage else {
return completion(.success(()))
}
let fingerprint = Fingerprint(origin: .registry(registry.url), value: checksum, contentType: contentType)
fingerprintStorage.put(
package: package.underlying,
version: version,
fingerprint: fingerprint,
observabilityScope: observabilityScope,
callbackQueue: callbackQueue
) { result in
switch result {
case .success:
completion(.success(()))
case .failure(PackageFingerprintStorageError.conflict(_, let existing)):
switch self.fingerprintCheckingMode {
case .strict:
completion(.failure(RegistryError.checksumChanged(latest: checksum, previous: existing.value)))
case .warn:
observabilityScope
.emit(
warning: "the checksum \(checksum) for \(contentType) of \(package) \(version) from \(registry.url.absoluteString) does not match previously recorded value \(existing.value) from \(String(describing: existing.origin.url?.absoluteString))"
)
completion(.success(()))
}
case .failure(let error):
completion(.failure(error))
}
}
}
}
|
