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
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2021-2024 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
//
//===----------------------------------------------------------------------===//
@testable import Basics
import _InternalTestSupport
import XCTest
#if canImport(Darwin)
import Darwin
#endif
final class SandboxTest: XCTestCase {
func testSandboxOnAllPlatforms() throws {
try withTemporaryDirectory { path in
#if os(Windows)
let command = try Sandbox.apply(command: ["tar.exe", "-h"], strictness: .default, writableDirectories: [])
#else
let command = try Sandbox.apply(command: ["echo", "0"], strictness: .default, writableDirectories: [])
#endif
XCTAssertNoThrow(try AsyncProcess.checkNonZeroExit(arguments: command))
}
}
#if canImport(Darwin)
// _CS_DARWIN_USER_CACHE_DIR is only on Darwin, will fail to compile on other platforms.
func testUniformTypeIdentifiers() throws {
#if !os(macOS)
try XCTSkipIf(true, "test is only supported on macOS")
#endif
let testProgram = """
import Foundation
let file = URL(fileURLWithPath:"\(#file)", isDirectory:false)
guard let resourceValues = try? file.resourceValues(forKeys: [.contentTypeKey]) else {
fputs("Failed to get content type/type identifier for '\(#file)'", stderr)
exit(EXIT_FAILURE)
}
"""
let cacheDirectory = String(unsafeUninitializedCapacity: Int(PATH_MAX)) { buffer in
return confstr(_CS_DARWIN_USER_CACHE_DIR, buffer.baseAddress, Int(PATH_MAX))
}
let command = try Sandbox.apply(command: ["swift", "-"], strictness: .writableTemporaryDirectory, writableDirectories: [try AbsolutePath(validating: cacheDirectory)])
let process = AsyncProcess(arguments: command)
let stdin = try process.launch()
stdin.write(sequence: testProgram.utf8)
try stdin.close()
let processResult = try process.waitUntilExit()
XCTAssertEqual(processResult.exitStatus, .terminated(code: 0), (try? processResult.utf8stderrOutput()) ?? "")
}
#endif
func testNetworkNotAllowed() throws {
#if !os(macOS)
try XCTSkipIf(true, "test is only supported on macOS")
#endif
let command = try Sandbox.apply(command: ["ping", "-t", "1", "localhost"], strictness: .default, writableDirectories: [])
XCTAssertThrowsError(try AsyncProcess.checkNonZeroExit(arguments: command)) { error in
guard case AsyncProcessResult.Error.nonZeroExit(let result) = error else {
return XCTFail("invalid error \(error)")
}
XCTAssertMatch(try! result.utf8stderrOutput(), .contains("Operation not permitted"))
}
}
func testWritableAllowed() throws {
#if !os(macOS)
try XCTSkipIf(true, "test is only supported on macOS")
#endif
try withTemporaryDirectory { path in
let command = try Sandbox.apply(command: ["touch", path.appending(component: UUID().uuidString).pathString], strictness: .default, writableDirectories: [path])
XCTAssertNoThrow(try AsyncProcess.checkNonZeroExit(arguments: command))
}
}
func testWritableNotAllowed() throws {
#if !os(macOS)
try XCTSkipIf(true, "test is only supported on macOS")
#endif
try withTemporaryDirectory { path in
let command = try Sandbox.apply(command: ["touch", path.appending(component: UUID().uuidString).pathString], strictness: .default, writableDirectories: [])
XCTAssertThrowsError(try AsyncProcess.checkNonZeroExit(arguments: command)) { error in
guard case AsyncProcessResult.Error.nonZeroExit(let result) = error else {
return XCTFail("invalid error \(error)")
}
XCTAssertMatch(try! result.utf8stderrOutput(), .contains("Operation not permitted"))
}
}
}
func testRemoveNotAllowed() throws {
#if !os(macOS)
try XCTSkipIf(true, "test is only supported on macOS")
#endif
try withTemporaryDirectory { path in
let file = path.appending(component: UUID().uuidString)
XCTAssertNoThrow(try AsyncProcess.checkNonZeroExit(arguments: ["touch", file.pathString]))
let command = try Sandbox.apply(command: ["rm", file.pathString], strictness: .default, writableDirectories: [])
XCTAssertThrowsError(try AsyncProcess.checkNonZeroExit(arguments: command)) { error in
guard case AsyncProcessResult.Error.nonZeroExit(let result) = error else {
return XCTFail("invalid error \(error)")
}
XCTAssertMatch(try! result.utf8stderrOutput(), .contains("Operation not permitted"))
}
}
}
// FIXME: rdar://75707545 this should not be allowed outside very specific read locations
func testReadAllowed() throws {
#if !os(macOS)
try XCTSkipIf(true, "test is only supported on macOS")
#endif
try withTemporaryDirectory { path in
let file = path.appending(component: UUID().uuidString)
XCTAssertNoThrow(try AsyncProcess.checkNonZeroExit(arguments: ["touch", file.pathString]))
let command = try Sandbox.apply(command: ["cat", file.pathString], strictness: .default, writableDirectories: [])
XCTAssertNoThrow(try AsyncProcess.checkNonZeroExit(arguments: command))
}
}
// FIXME: rdar://75707545 this should not be allowed outside very specific programs
func testExecuteAllowed() throws {
#if !os(macOS)
try XCTSkipIf(true, "test is only supported on macOS")
#endif
try withTemporaryDirectory { path in
let file = path.appending(component: UUID().uuidString)
XCTAssertNoThrow(try AsyncProcess.checkNonZeroExit(arguments: ["touch", file.pathString]))
XCTAssertNoThrow(try AsyncProcess.checkNonZeroExit(arguments: ["chmod", "+x", file.pathString]))
let command = try Sandbox.apply(command: [file.pathString], strictness: .default, writableDirectories: [])
XCTAssertNoThrow(try AsyncProcess.checkNonZeroExit(arguments: command))
}
}
func testWritingToTemporaryDirectoryAllowed() throws {
#if !os(macOS)
try XCTSkipIf(true, "test is only supported on macOS")
#endif
// Try writing to the per-user temporary directory, which is under /var/folders/.../TemporaryItems.
let tmpFile1 = NSTemporaryDirectory() + "/" + UUID().uuidString
let command1 = try Sandbox.apply(command: ["touch", tmpFile1], strictness: .writableTemporaryDirectory)
XCTAssertNoThrow(try AsyncProcess.checkNonZeroExit(arguments: command1))
try? FileManager.default.removeItem(atPath: tmpFile1)
let tmpFile2 = "/tmp" + "/" + UUID().uuidString
let command2 = try Sandbox.apply(command: ["touch", tmpFile2], strictness: .writableTemporaryDirectory)
XCTAssertNoThrow(try AsyncProcess.checkNonZeroExit(arguments: command2))
try? FileManager.default.removeItem(atPath: tmpFile2)
}
func testWritingToReadOnlyInsideWritableNotAllowed() throws {
#if !os(macOS)
try XCTSkipIf(true, "sandboxing is only supported on macOS")
#endif
try withTemporaryDirectory { tmpDir in
// Check that we can write into the temporary directory, but not into a read-only directory underneath it.
let writableDir = tmpDir.appending("ShouldBeWritable")
try localFileSystem.createDirectory(writableDir)
let allowedCommand = try Sandbox.apply(command: ["touch", writableDir.pathString], strictness: .default, writableDirectories: [writableDir])
XCTAssertNoThrow(try AsyncProcess.checkNonZeroExit(arguments: allowedCommand))
// Check that we cannot write into a read-only directory inside a writable temporary directory.
let readOnlyDir = writableDir.appending("ShouldBeReadOnly")
try localFileSystem.createDirectory(readOnlyDir)
let deniedCommand = try Sandbox.apply(command: ["touch", readOnlyDir.pathString], strictness: .writableTemporaryDirectory, readOnlyDirectories: [readOnlyDir])
XCTAssertThrowsError(try AsyncProcess.checkNonZeroExit(arguments: deniedCommand)) { error in
guard case AsyncProcessResult.Error.nonZeroExit(let result) = error else {
return XCTFail("invalid error \(error)")
}
XCTAssertMatch(try! result.utf8stderrOutput(), .contains("Operation not permitted"))
}
}
}
func testWritingToWritableInsideReadOnlyAllowed() throws {
#if !os(macOS)
try XCTSkipIf(true, "sandboxing is only supported on macOS")
#endif
try withTemporaryDirectory { tmpDir in
// Check that we cannot write into a read-only directory, but into a writable directory underneath it.
let readOnlyDir = tmpDir.appending("ShouldBeReadOnly")
try localFileSystem.createDirectory(readOnlyDir)
let deniedCommand = try Sandbox.apply(command: ["touch", readOnlyDir.pathString], strictness: .writableTemporaryDirectory, readOnlyDirectories: [readOnlyDir])
XCTAssertThrowsError(try AsyncProcess.checkNonZeroExit(arguments: deniedCommand)) { error in
guard case AsyncProcessResult.Error.nonZeroExit(let result) = error else {
return XCTFail("invalid error \(error)")
}
XCTAssertMatch(try! result.utf8stderrOutput(), .contains("Operation not permitted"))
}
// Check that we can write into a writable directory underneath it.
let writableDir = readOnlyDir.appending("ShouldBeWritable")
try localFileSystem.createDirectory(writableDir)
let allowedCommand = try Sandbox.apply(command: ["touch", writableDir.pathString], strictness: .default, writableDirectories:[writableDir], readOnlyDirectories: [readOnlyDir])
XCTAssertNoThrow(try AsyncProcess.checkNonZeroExit(arguments: allowedCommand))
}
}
func testDeterministicOrdering() throws {
#if !os(macOS)
try XCTSkipIf(true, "test is only supported on macOS")
#endif
try withTemporaryDirectory { path in
// Ensure the contents of the produced sandbox directory is deterministic, in order
// to avoid spurious incremental rebuilds. This test is not guaranteed to catch rare
// cases of nondeterminism, but in practice guards well against past issues in this area.
let writeable1 = path.appending(component: "w1")
let writeable2 = path.appending(component: "w2")
let writeable3 = path.appending(component: "w3")
let writeable4 = path.appending(component: "w4")
let readable1 = path.appending(component: "r1")
let readable2 = path.appending(component: "r2")
let readable3 = path.appending(component: "r3")
let readable4 = path.appending(component: "r4")
let command = try Sandbox.apply(command: ["echo", "hello"], strictness: .default, writableDirectories: [writeable1, writeable2, writeable3, writeable4], readOnlyDirectories: [readable1, readable2, readable3, readable4], fileSystem: localFileSystem)
for _ in 0..<10 {
let newCommand = try Sandbox.apply(command: ["echo", "hello"], strictness: .default, writableDirectories: [writeable1, writeable2, writeable3, writeable4], readOnlyDirectories: [readable1, readable2, readable3, readable4],fileSystem: localFileSystem)
XCTAssertEqual(command, newCommand)
}
}
}
}
extension Sandbox {
public static func apply(
command: [String],
strictness: Strictness = .default,
writableDirectories: [AbsolutePath] = [],
readOnlyDirectories: [AbsolutePath] = [],
allowNetworkConnections: [SandboxNetworkPermission] = [],
fileSystem: FileSystem = InMemoryFileSystem()
) throws -> [String] {
return try self.apply(
command: command,
fileSystem: fileSystem,
strictness: strictness,
writableDirectories: writableDirectories,
readOnlyDirectories: readOnlyDirectories,
allowNetworkConnections: allowNetworkConnections
)
}
}
|
