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
|
//===----------------------------------------------------------------------===//
//
// 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 Basics
import Dispatch
import Foundation
import PackageModel
import struct TSCUtility.Version
public struct FilePackageSigningEntityStorage: PackageSigningEntityStorage {
let fileSystem: FileSystem
let directoryPath: AbsolutePath
private let encoder: JSONEncoder
private let decoder: JSONDecoder
public init(fileSystem: FileSystem, directoryPath: AbsolutePath) {
self.fileSystem = fileSystem
self.directoryPath = directoryPath
self.encoder = JSONEncoder.makeWithDefaults()
self.decoder = JSONDecoder.makeWithDefaults()
}
public func get(
package: PackageIdentity,
observabilityScope: ObservabilityScope
) throws -> PackageSigners {
try self.withLock {
try self.loadFromDisk(package: package)
}
}
public func put(
package: PackageIdentity,
version: Version,
signingEntity: SigningEntity,
origin: SigningEntity.Origin,
observabilityScope: ObservabilityScope
) throws {
try self.withLock {
var packageSigners = try self.loadFromDisk(package: package)
let otherSigningEntities = packageSigners.signingEntities(of: version).filter { $0 != signingEntity }
// Error if we try to write a different signing entity for a version
guard otherSigningEntities.isEmpty else {
throw PackageSigningEntityStorageError.conflict(
package: package,
version: version,
given: signingEntity,
existing: otherSigningEntities.first! // !-safe because otherSigningEntities is not empty
)
}
try self.add(
packageSigners: &packageSigners,
signingEntity: signingEntity,
origin: origin,
version: version
)
try self.saveToDisk(package: package, packageSigners: packageSigners)
}
}
public func add(
package: PackageIdentity,
version: Version,
signingEntity: SigningEntity,
origin: SigningEntity.Origin,
observabilityScope: ObservabilityScope
) throws {
try self.withLock {
var packageSigners = try self.loadFromDisk(package: package)
try self.add(
packageSigners: &packageSigners,
signingEntity: signingEntity,
origin: origin,
version: version
)
try self.saveToDisk(package: package, packageSigners: packageSigners)
}
}
public func changeSigningEntityFromVersion(
package: PackageIdentity,
version: Version,
signingEntity: SigningEntity,
origin: SigningEntity.Origin,
observabilityScope: ObservabilityScope
) throws {
try self.withLock {
var packageSigners = try self.loadFromDisk(package: package)
packageSigners.expectedSigner = (signingEntity: signingEntity, fromVersion: version)
try self.add(
packageSigners: &packageSigners,
signingEntity: signingEntity,
origin: origin,
version: version
)
try self.saveToDisk(package: package, packageSigners: packageSigners)
}
}
public func changeSigningEntityForAllVersions(
package: PackageIdentity,
version: Version,
signingEntity: SigningEntity,
origin: SigningEntity.Origin,
observabilityScope: ObservabilityScope
) throws {
try self.withLock {
var packageSigners = try self.loadFromDisk(package: package)
packageSigners.expectedSigner = (signingEntity: signingEntity, fromVersion: version)
// Delete all other signers
packageSigners.signers = packageSigners.signers.filter { $0.key == signingEntity }
try self.add(
packageSigners: &packageSigners,
signingEntity: signingEntity,
origin: origin,
version: version
)
try self.saveToDisk(package: package, packageSigners: packageSigners)
}
}
private func add(
packageSigners: inout PackageSigners,
signingEntity: SigningEntity,
origin: SigningEntity.Origin,
version: Version
) throws {
guard case .recognized = signingEntity else {
throw PackageSigningEntityStorageError.unrecognizedSigningEntity(signingEntity)
}
if var existingSigner = packageSigners.signers.removeValue(forKey: signingEntity) {
existingSigner.origins.insert(origin)
existingSigner.versions.insert(version)
packageSigners.signers[signingEntity] = existingSigner
} else {
let signer = PackageSigner(
signingEntity: signingEntity,
origins: [origin],
versions: [version]
)
packageSigners.signers[signingEntity] = signer
}
}
private func loadFromDisk(package: PackageIdentity) throws -> PackageSigners {
let path = self.directoryPath.appending(component: package.signedVersionsFilename)
guard self.fileSystem.exists(path) else {
return .init()
}
let data: Data = try fileSystem.readFileContents(path)
guard data.count > 0 else {
return .init()
}
let container = try self.decoder.decode(StorageModel.Container.self, from: data)
return try container.packageSigners()
}
private func saveToDisk(package: PackageIdentity, packageSigners: PackageSigners) throws {
if !self.fileSystem.exists(self.directoryPath) {
try self.fileSystem.createDirectory(self.directoryPath, recursive: true)
}
let container = try StorageModel.Container(packageSigners)
let buffer = try encoder.encode(container)
let path = self.directoryPath.appending(component: package.signedVersionsFilename)
try self.fileSystem.writeFileContents(path, data: buffer)
}
private func withLock<T>(_ body: () throws -> T) throws -> T {
if !self.fileSystem.exists(self.directoryPath) {
try self.fileSystem.createDirectory(self.directoryPath, recursive: true)
}
return try self.fileSystem.withLock(on: self.directoryPath, type: .exclusive, body)
}
private func makeAsync<T>(
_ closure: @escaping (Result<T, Error>) -> Void,
on queue: DispatchQueue
) -> (Result<T, Error>) -> Void {
{ result in queue.async { closure(result) } }
}
}
private enum StorageModel {
struct Container: Codable {
let expectedSigner: ExpectedSigner?
let signers: [PackageSigner]
init(_ packageSigners: PackageSigners) throws {
self.expectedSigner = packageSigners.expectedSigner.map {
ExpectedSigner(signingEntity: $0.signingEntity, fromVersion: $0.fromVersion)
}
self.signers = Array(packageSigners.signers.values)
}
func packageSigners() throws -> PackageSigners {
let signers = try Dictionary(throwingUniqueKeysWithValues: self.signers.map {
($0.signingEntity, $0)
})
return PackageSigners(
expectedSigner: self.expectedSigner.map { ($0.signingEntity, $0.fromVersion) },
signers: signers
)
}
}
struct ExpectedSigner: Codable {
let signingEntity: SigningEntity
let fromVersion: Version
}
}
extension PackageIdentity {
var signedVersionsFilename: String {
"\(self.description).json"
}
}
|
