kobako 0.30.0 → 0.31.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (266) hide show
  1. checksums.yaml +4 -4
  2. data/.release-please-manifest.json +1 -1
  3. data/CHANGELOG.md +335 -0
  4. data/Cargo.lock +469 -11
  5. data/README.md +43 -3
  6. data/ROADMAP.md +1 -1
  7. data/crates/kobako-runtime/CHANGELOG.md +219 -0
  8. data/crates/kobako-runtime/Cargo.toml +51 -3
  9. data/crates/kobako-runtime/README.md +7 -4
  10. data/crates/kobako-runtime/src/cred.rs +124 -0
  11. data/crates/kobako-runtime/src/dispatch.rs +4 -5
  12. data/crates/kobako-runtime/src/endpoint/buffer.rs +153 -44
  13. data/crates/kobako-runtime/src/endpoint/dispatch.rs +80 -41
  14. data/crates/kobako-runtime/src/endpoint/invoke.rs +23 -36
  15. data/crates/kobako-runtime/src/endpoint.rs +137 -36
  16. data/crates/kobako-runtime/src/errno.rs +391 -0
  17. data/crates/kobako-runtime/src/error.rs +31 -10
  18. data/crates/kobako-runtime/src/filesystem/anon_inodes.rs +52 -0
  19. data/crates/kobako-runtime/src/filesystem/bind/lookup.rs +52 -14
  20. data/crates/kobako-runtime/src/filesystem/bind/walk.rs +19 -20
  21. data/crates/kobako-runtime/src/filesystem/bind.rs +437 -245
  22. data/crates/kobako-runtime/src/filesystem/overlay/file.rs +6 -6
  23. data/crates/kobako-runtime/src/filesystem/overlay/path.rs +43 -65
  24. data/crates/kobako-runtime/src/filesystem/overlay/stack/copy_up.rs +9 -16
  25. data/crates/kobako-runtime/src/filesystem/overlay/stack/dir.rs +47 -72
  26. data/crates/kobako-runtime/src/filesystem/overlay/stack/namei.rs +12 -12
  27. data/crates/kobako-runtime/src/filesystem/overlay/stack/readdir.rs +4 -7
  28. data/crates/kobako-runtime/src/filesystem/overlay/stack.rs +121 -37
  29. data/crates/kobako-runtime/src/filesystem/overlay.rs +302 -343
  30. data/crates/kobako-runtime/src/filesystem/pipe.rs +12 -9
  31. data/crates/kobako-runtime/src/filesystem/rdir.rs +15 -32
  32. data/crates/kobako-runtime/src/filesystem/tmpfs/seed.rs +32 -0
  33. data/crates/kobako-runtime/src/filesystem/tmpfs/tmpfile.rs +3 -3
  34. data/crates/kobako-runtime/src/filesystem/tmpfs/whiteout.rs +57 -35
  35. data/crates/kobako-runtime/src/filesystem/tmpfs/xattr.rs +2 -2
  36. data/crates/kobako-runtime/src/filesystem/tmpfs.rs +172 -160
  37. data/crates/kobako-runtime/src/filesystem/wrap.rs +36 -52
  38. data/crates/kobako-runtime/src/filesystem.rs +6 -3
  39. data/crates/kobako-runtime/src/fork.rs +96 -0
  40. data/crates/kobako-runtime/src/grant.rs +3 -0
  41. data/crates/kobako-runtime/src/hashtable.rs +4 -2
  42. data/crates/kobako-runtime/src/lib.rs +18 -7
  43. data/crates/kobako-runtime/src/limits.rs +195 -0
  44. data/crates/kobako-runtime/src/locking.rs +10 -0
  45. data/crates/kobako-runtime/src/memcg.rs +383 -0
  46. data/crates/kobako-runtime/src/mount.rs +67 -9
  47. data/crates/kobako-runtime/src/net/backends.rs +43 -0
  48. data/crates/kobako-runtime/src/net/connections.rs +179 -0
  49. data/crates/kobako-runtime/src/net/credential.rs +125 -0
  50. data/crates/kobako-runtime/src/net/egress.rs +160 -0
  51. data/crates/kobako-runtime/src/net/family.rs +181 -0
  52. data/crates/kobako-runtime/src/net/http.rs +2733 -0
  53. data/crates/kobako-runtime/src/net/lookup.rs +285 -0
  54. data/crates/kobako-runtime/src/net/mock.rs +251 -0
  55. data/crates/kobako-runtime/src/net/namespace.rs +1366 -0
  56. data/crates/kobako-runtime/src/net/reactor.rs +531 -0
  57. data/crates/kobako-runtime/src/net/resolv/darwin.rs +275 -0
  58. data/crates/kobako-runtime/src/net/resolv/stub/tests.rs +469 -0
  59. data/crates/kobako-runtime/src/net/resolv/stub.rs +536 -0
  60. data/crates/kobako-runtime/src/net/resolv/windows.rs +248 -0
  61. data/crates/kobako-runtime/src/net/resolv.rs +227 -0
  62. data/crates/kobako-runtime/src/net/socket.rs +870 -0
  63. data/crates/kobako-runtime/src/net/tcp.rs +1588 -0
  64. data/crates/kobako-runtime/src/net/tls.rs +58 -0
  65. data/crates/kobako-runtime/src/net/transport.rs +279 -0
  66. data/crates/kobako-runtime/src/net/udp.rs +1003 -0
  67. data/crates/kobako-runtime/src/net.rs +42 -0
  68. data/crates/kobako-runtime/src/network/builder.rs +177 -0
  69. data/crates/kobako-runtime/src/network/ruleset.rs +777 -0
  70. data/crates/kobako-runtime/src/network.rs +551 -0
  71. data/crates/kobako-runtime/src/policy.rs +16 -0
  72. data/crates/kobako-runtime/src/profile.rs +29 -144
  73. data/crates/kobako-runtime/src/runtime.rs +3 -5
  74. data/crates/kobako-runtime/src/sched.rs +130 -29
  75. data/crates/kobako-runtime/src/security/entry_policy.rs +22 -0
  76. data/crates/kobako-runtime/src/{vfs/cred.rs → security/hooks.rs} +52 -144
  77. data/crates/kobako-runtime/src/security/mount_policy.rs +158 -0
  78. data/crates/kobako-runtime/src/security.rs +101 -196
  79. data/crates/kobako-runtime/src/snapshot.rs +121 -2
  80. data/crates/kobako-runtime/src/vfs/attr.rs +5 -5
  81. data/crates/kobako-runtime/src/vfs/dentry.rs +143 -89
  82. data/crates/kobako-runtime/src/vfs/file.rs +199 -203
  83. data/crates/kobako-runtime/src/vfs/inode.rs +41 -45
  84. data/crates/kobako-runtime/src/vfs/kern_path.rs +38 -42
  85. data/crates/kobako-runtime/src/vfs/mount.rs +10 -9
  86. data/crates/kobako-runtime/src/vfs/namei.rs +829 -700
  87. data/crates/kobako-runtime/src/vfs/namespace.rs +162 -0
  88. data/crates/kobako-runtime/src/vfs/open_files.rs +69 -0
  89. data/crates/kobako-runtime/src/vfs/openat2.rs +3 -3
  90. data/crates/kobako-runtime/src/vfs/path.rs +6 -6
  91. data/crates/kobako-runtime/src/vfs/readdir.rs +6 -6
  92. data/crates/kobako-runtime/src/vfs/stat.rs +159 -23
  93. data/crates/kobako-runtime/src/vfs/super_block.rs +18 -14
  94. data/crates/kobako-runtime/src/vfs/utimes.rs +37 -27
  95. data/crates/kobako-runtime/src/vfs.rs +9 -6
  96. data/crates/kobako-runtime/src/wait.rs +356 -0
  97. data/crates/kobako-transport/CHANGELOG.md +31 -0
  98. data/crates/kobako-transport/Cargo.toml +1 -1
  99. data/crates/kobako-transport/README.md +3 -4
  100. data/crates/kobako-transport/src/abi.rs +78 -72
  101. data/crates/kobako-transport/src/envelope/bytes.rs +17 -6
  102. data/crates/kobako-transport/src/envelope/call.rs +32 -4
  103. data/crates/kobako-transport/src/envelope/error_record.rs +21 -0
  104. data/crates/kobako-transport/src/envelope/name.rs +99 -0
  105. data/crates/kobako-transport/src/envelope/outcome.rs +9 -9
  106. data/crates/kobako-transport/src/envelope/preamble.rs +24 -21
  107. data/crates/kobako-transport/src/envelope/reply.rs +27 -27
  108. data/crates/kobako-transport/src/envelope/unsupported.rs +10 -10
  109. data/crates/kobako-transport/src/envelope.rs +13 -8
  110. data/crates/kobako-wasmtime/CHANGELOG.md +161 -0
  111. data/crates/kobako-wasmtime/Cargo.toml +26 -7
  112. data/crates/kobako-wasmtime/README.md +3 -2
  113. data/crates/kobako-wasmtime/build/preview2.rs +1339 -0
  114. data/crates/kobako-wasmtime/build.rs +16 -0
  115. data/crates/kobako-wasmtime/src/abi.rs +17 -37
  116. data/crates/kobako-wasmtime/src/ambient.rs +33 -18
  117. data/crates/kobako-wasmtime/src/cache.rs +23 -15
  118. data/crates/kobako-wasmtime/src/config.rs +52 -68
  119. data/crates/kobako-wasmtime/src/driver.rs +48 -63
  120. data/crates/kobako-wasmtime/src/exports.rs +143 -17
  121. data/crates/kobako-wasmtime/src/guest.rs +12 -6
  122. data/crates/kobako-wasmtime/src/guest_binary.rs +14 -0
  123. data/crates/kobako-wasmtime/src/imports.rs +42 -18
  124. data/crates/kobako-wasmtime/src/instance_pre.rs +4 -4
  125. data/crates/kobako-wasmtime/src/invocation.rs +74 -12
  126. data/crates/kobako-wasmtime/src/lib.rs +5 -3
  127. data/crates/kobako-wasmtime/src/limiter.rs +70 -5
  128. data/crates/kobako-wasmtime/src/preview1/descriptors.rs +309 -0
  129. data/crates/kobako-wasmtime/src/preview1/differential/mount.rs +5 -15
  130. data/crates/kobako-wasmtime/src/preview1/differential.rs +27 -31
  131. data/crates/kobako-wasmtime/src/preview1/errno.rs +55 -66
  132. data/crates/kobako-wasmtime/src/preview1/fd.rs +327 -296
  133. data/crates/kobako-wasmtime/src/preview1/memory.rs +21 -12
  134. data/crates/kobako-wasmtime/src/preview1/mount_view/wrap.rs +34 -53
  135. data/crates/kobako-wasmtime/src/preview1/mount_view.rs +231 -217
  136. data/crates/kobako-wasmtime/src/preview1/path.rs +56 -121
  137. data/crates/kobako-wasmtime/src/preview1/poll.rs +244 -120
  138. data/crates/kobako-wasmtime/src/preview1/sock.rs +10 -8
  139. data/crates/kobako-wasmtime/src/preview1/testsuite.rs +5 -15
  140. data/crates/kobako-wasmtime/src/preview1.rs +46 -42
  141. data/crates/kobako-wasmtime/src/preview2/abi.rs +227 -0
  142. data/crates/kobako-wasmtime/src/preview2/error.rs +118 -0
  143. data/crates/kobako-wasmtime/src/preview2/filesystem.rs +122 -0
  144. data/crates/kobako-wasmtime/src/preview2/host.rs +3959 -0
  145. data/crates/kobako-wasmtime/src/preview2/http.rs +1503 -0
  146. data/crates/kobako-wasmtime/src/preview2/io.rs +315 -0
  147. data/crates/kobako-wasmtime/src/preview2/sockets.rs +379 -0
  148. data/crates/kobako-wasmtime/src/preview2/table.rs +305 -0
  149. data/crates/kobako-wasmtime/src/preview2.rs +57 -0
  150. data/crates/kobako-wasmtime/src/trap.rs +24 -9
  151. data/crates/kobako-wasmtime/src/wasi.rs +210 -81
  152. data/crates/kobako-wasmtime/wit/deps/cli.wit +233 -0
  153. data/crates/kobako-wasmtime/wit/deps/clocks.wit +162 -0
  154. data/crates/kobako-wasmtime/wit/deps/filesystem.wit +589 -0
  155. data/crates/kobako-wasmtime/wit/deps/http.wit +733 -0
  156. data/crates/kobako-wasmtime/wit/deps/io.wit +299 -0
  157. data/crates/kobako-wasmtime/wit/deps/random.wit +92 -0
  158. data/crates/kobako-wasmtime/wit/deps/sockets.wit +949 -0
  159. data/data/kobako.wasm +0 -0
  160. data/ext/kobako/Cargo.toml +1 -1
  161. data/ext/kobako/src/{runtime/errors.rs → errors.rs} +34 -26
  162. data/ext/kobako/src/{runtime/escape.rs → escape.rs} +42 -11
  163. data/ext/kobako/src/{runtime/filesystem → filesystem}/grants.rs +30 -26
  164. data/ext/kobako/src/{runtime/filesystem → filesystem}/ruby.rs +149 -168
  165. data/ext/kobako/src/{runtime/filesystem.rs → filesystem.rs} +24 -15
  166. data/ext/kobako/src/gvl.rs +306 -0
  167. data/ext/kobako/src/lib.rs +64 -3
  168. data/ext/kobako/src/network/mock.rs +187 -0
  169. data/ext/kobako/src/network.rs +591 -0
  170. data/ext/kobako/src/runtime/bridge.rs +30 -29
  171. data/ext/kobako/src/runtime/snapshot.rs +4 -4
  172. data/ext/kobako/src/runtime.rs +221 -143
  173. data/ext/kobako/src/wire.rs +42 -0
  174. data/lib/kobako/catalog/extensions.rb +14 -2
  175. data/lib/kobako/catalog/flags.rb +3 -5
  176. data/lib/kobako/catalog/grants.rb +5 -4
  177. data/lib/kobako/catalog/handles.rb +5 -27
  178. data/lib/kobako/catalog/mount.rb +11 -3
  179. data/lib/kobako/catalog/network.rb +35 -0
  180. data/lib/kobako/catalog/replacements.rb +28 -0
  181. data/lib/kobako/catalog/services.rb +5 -19
  182. data/lib/kobako/catalog/snippets.rb +3 -18
  183. data/lib/kobako/catalog.rb +3 -0
  184. data/lib/kobako/codec/{utils.rb → boundary.rb} +4 -2
  185. data/lib/kobako/codec/decoder.rb +4 -4
  186. data/lib/kobako/codec/ext_types.rb +3 -3
  187. data/lib/kobako/codec/handle_walk.rb +3 -43
  188. data/lib/kobako/codec/value_budget.rb +132 -40
  189. data/lib/kobako/codec.rb +1 -1
  190. data/lib/kobako/context.rb +24 -11
  191. data/lib/kobako/errors.rb +15 -12
  192. data/lib/kobako/extension.rb +3 -2
  193. data/lib/kobako/filesystem.rb +9 -2
  194. data/lib/kobako/handle.rb +2 -2
  195. data/lib/kobako/names.rb +28 -0
  196. data/lib/kobako/network.rb +210 -0
  197. data/lib/kobako/outcome.rb +7 -7
  198. data/lib/kobako/pool.rb +45 -23
  199. data/lib/kobako/runtime.rb +3 -2
  200. data/lib/kobako/sandbox.rb +92 -35
  201. data/lib/kobako/sandbox_options.rb +41 -106
  202. data/lib/kobako/transport/argument_wrap.rb +64 -0
  203. data/lib/kobako/transport/block_failure.rb +1 -1
  204. data/lib/kobako/transport/dispatcher.rb +6 -6
  205. data/lib/kobako/transport/exposure.rb +26 -15
  206. data/lib/kobako/transport/reflection.rb +21 -4
  207. data/lib/kobako/transport/run.rb +8 -23
  208. data/lib/kobako/transport/yielder.rb +2 -9
  209. data/lib/kobako/transport.rb +1 -0
  210. data/lib/kobako/version.rb +1 -1
  211. data/lib/kobako.rb +6 -2
  212. data/release-please-config.json +15 -0
  213. data/sig/core/thread.rbs +6 -0
  214. data/sig/kobako/catalog/extensions.rbs +2 -0
  215. data/sig/kobako/catalog/grants.rbs +7 -4
  216. data/sig/kobako/catalog/handles.rbs +0 -2
  217. data/sig/kobako/catalog/mount.rbs +3 -1
  218. data/sig/kobako/catalog/network.rbs +20 -0
  219. data/sig/kobako/catalog/replacements.rbs +14 -0
  220. data/sig/kobako/catalog/services.rbs +0 -4
  221. data/sig/kobako/catalog/snippets.rbs +0 -2
  222. data/sig/kobako/codec/{utils.rbs → boundary.rbs} +2 -2
  223. data/sig/kobako/codec/handle_walk.rbs +0 -6
  224. data/sig/kobako/codec/value_budget.rbs +47 -4
  225. data/sig/kobako/context.rbs +3 -1
  226. data/sig/kobako/errors.rbs +4 -4
  227. data/sig/kobako/filesystem.rbs +21 -3
  228. data/sig/kobako/network.rbs +115 -0
  229. data/sig/kobako/outcome.rbs +1 -1
  230. data/sig/kobako/pool.rbs +7 -3
  231. data/sig/kobako/runtime.rbs +32 -3
  232. data/sig/kobako/sandbox.rbs +19 -2
  233. data/sig/kobako/sandbox_options.rbs +29 -38
  234. data/sig/kobako/transport/argument_wrap.rbs +15 -0
  235. data/sig/kobako/transport/error.rbs +1 -1
  236. data/sig/kobako/transport/exposure.rbs +2 -4
  237. data/sig/kobako/transport/reflection.rbs +10 -0
  238. data/sig/kobako/transport/run.rbs +0 -2
  239. data/sig/kobako/transport/yielder.rbs +0 -3
  240. data/sig/kobako/transport.rbs +1 -1
  241. data/sig/kobako.rbs +13 -0
  242. metadata +84 -35
  243. data/crates/kobako-runtime/src/endpoint/capture.rs +0 -115
  244. data/crates/kobako-runtime/src/endpoint/memory_cap.rs +0 -238
  245. data/crates/kobako-runtime/src/filesystem/path.rs +0 -21
  246. data/crates/kobako-runtime/src/vfs/errno.rs +0 -153
  247. data/crates/kobako-runtime/tests/linux_baseline/calls.rs +0 -171
  248. data/crates/kobako-runtime/tests/linux_baseline/concurrent.rs +0 -276
  249. data/crates/kobako-runtime/tests/linux_baseline/kobako.rs +0 -323
  250. data/crates/kobako-runtime/tests/linux_baseline/linux-baseline-expected.txt +0 -16
  251. data/crates/kobako-runtime/tests/linux_baseline/linux.rs +0 -449
  252. data/crates/kobako-runtime/tests/linux_baseline/main.rs +0 -611
  253. data/crates/kobako-runtime/tests/linux_baseline/permissions.rs +0 -236
  254. data/crates/kobako-wasmtime/src/descriptors.rs +0 -200
  255. data/crates/kobako-wasmtime/tests/integration/compile_posture.rs +0 -43
  256. data/crates/kobako-wasmtime/tests/integration/guest_file.rs +0 -1085
  257. data/crates/kobako-wasmtime/tests/integration/main.rs +0 -29
  258. data/crates/kobako-wasmtime/tests/integration/preamble_flags.rs +0 -70
  259. data/crates/kobako-wasmtime/tests/integration/snippet_compile.rs +0 -95
  260. data/crates/kobako-wasmtime/tests/integration/support/mod.rs +0 -30
  261. data/crates/kobako-wasmtime/tests/integration/unanswered_call.rs +0 -86
  262. data/crates/kobako-wasmtime/tests/integration/unsupported_call.rs +0 -51
  263. data/ext/kobako/src/runtime/gvl.rs +0 -147
  264. data/lib/kobako/constant_name.rb +0 -8
  265. data/sig/kobako/constant_name.rbs +0 -3
  266. /data/ext/kobako/src/{runtime/pinned_value.rs → pinned_value.rs} +0 -0
@@ -1,26 +1,34 @@
1
- //! The security modules an Invocation registers: kobako's own rules, and the
2
- //! Host App's Policy for each Mount that has one. Linux has neither, so they
1
+ //! The security modules an Invocation registers: kobako's own rules, the Host
2
+ //! App's Policy for each Mount that has one, and each network entry's connect
3
+ //! policy. Linux has neither, so they
3
4
  //! answer through the hooks it leaves for such modules, and the VFS never
4
5
  //! learns what they decide.
5
6
 
7
+ use std::net::SocketAddr;
6
8
  use std::sync::Arc;
7
9
 
8
- use crate::mount::{Access, Mount, Policy};
9
- use crate::vfs::{
10
- d_revalidate, Cred, Dentry, FMode, FileSecurity, FileType, FilesystemError, OpenHow, Path,
11
- SecurityOperations, SecurityPath, VfsMount, VmCommitted, PATH_MAX,
12
- };
10
+ use crate::cred::Cred;
11
+ use crate::grant::Grant;
12
+ use crate::memcg::MemoryBudget;
13
+ use crate::mount::{Mount, UnplacedMountError};
14
+ use crate::vfs::{d_revalidate, Dentry, FMode, FileType, MntNamespace, OpenHow, Path, VfsMount};
15
+ use crate::Errno;
13
16
 
14
- /// What a Mount's Policy allowed a file as it opened, kept on the open file, as
15
- /// Landlock's file blob keeps `allowed_access`.
16
- struct AllowedAccess(Access);
17
+ mod entry_policy;
18
+ mod hooks;
19
+ mod mount_policy;
20
+
21
+ use entry_policy::EntryPolicy;
22
+ pub(crate) use hooks::on_path;
23
+ pub use hooks::{FileSecurity, SecurityOperations, SecurityPath};
24
+ use mount_policy::MountPolicy;
17
25
 
18
26
  /// Whether each name from the root down to `path` still names what the runtime
19
27
  /// recorded, as gVisor's `revalidatePath` walks one. Linux asks only names a walk
20
28
  /// passes through, so a `WalkGuard` asks this of where a call starts. A name moved
21
29
  /// while it was asked answers EAGAIN, as a scoped walk's `..` answers a move it
22
30
  /// met, and the caller makes the call again.
23
- fn revalidate_path(path: &Path) -> Result<bool, FilesystemError> {
31
+ fn revalidate_path(path: &Path) -> Result<bool, Errno> {
24
32
  let mut chain = vec![path.dentry().clone()];
25
33
  while let Some(at) = chain.last().filter(|at| !at.is_root()) {
26
34
  let above = at.parent();
@@ -30,7 +38,7 @@ fn revalidate_path(path: &Path) -> Result<bool, FilesystemError> {
30
38
  let [name, above] = pair else { continue };
31
39
  let _held = above.inode_lock_shared()?;
32
40
  if !Arc::ptr_eq(&name.parent(), above) {
33
- return Err(FilesystemError::WouldBlock);
41
+ return Err(Errno::WouldBlock);
34
42
  }
35
43
  if !d_revalidate(path.mnt().sb(), above, name)? {
36
44
  return Ok(false);
@@ -51,150 +59,25 @@ impl SecurityOperations for KobakoSecurity {
51
59
  kind: FileType,
52
60
  _mode: FMode,
53
61
  _how: &OpenHow,
54
- ) -> Result<FileSecurity, FilesystemError> {
62
+ ) -> Result<FileSecurity, Errno> {
55
63
  match kind {
56
64
  FileType::RegFile | FileType::Dir => Ok(None),
57
- _ => Err(FilesystemError::PermissionDenied),
65
+ _ => Err(Errno::PermissionDenied),
58
66
  }
59
67
  }
60
68
 
61
69
  /// A guest never reads where a link points.
62
- fn inode_readlink(&self, _dentry: &Dentry) -> Result<(), FilesystemError> {
63
- Err(FilesystemError::Unsupported)
64
- }
65
- }
66
-
67
- /// A Mount's Policy, answering only for that Mount.
68
- struct MountPolicy {
69
- mnt: Arc<VfsMount>,
70
- at: String,
71
- policy: Arc<dyn Policy>,
72
- }
73
-
74
- impl MountPolicy {
75
- fn guards(&self, mnt: &Arc<VfsMount>) -> bool {
76
- Arc::ptr_eq(&self.mnt, mnt)
70
+ fn inode_readlink(&self, _dentry: &Dentry) -> Result<(), Errno> {
71
+ Err(Errno::Unsupported)
77
72
  }
78
73
 
79
- /// The absolute guest path `path`, from the Mount's root, stands for.
80
- fn guest_path(&self, path: &str) -> String {
81
- match (self.at.as_str(), path) {
82
- (at, "/") => at.to_string(),
83
- ("/", path) => path.to_string(),
84
- (at, path) => format!("{at}{path}"),
85
- }
86
- }
87
-
88
- /// Judge `path` as AppArmor's `aa_path_perm` judges a whole path once, each
89
- /// hook below reaching it as AppArmor's do. The Policy judges the path as the
90
- /// Filesystem stores its names, so a host folding case or Unicode form cannot
91
- /// hand it one spelling of an entry it refuses by another. One a Policy could
92
- /// not be handed within `PATH_MAX` is refused as too long, as AppArmor's
93
- /// `aa_path_name` refuses one past its buffer.
94
- fn path_perm(&self, path: SecurityPath<'_>, access: Access) -> Result<(), FilesystemError> {
95
- if !self.guards(path.mnt) {
96
- return Ok(());
97
- }
98
- let path = self.guest_path(&(path.name)());
99
- if path.len() >= PATH_MAX {
100
- return Err(FilesystemError::InvalidFilename);
101
- }
102
- match self.policy.allows(&path, access) {
74
+ /// A guest only reaches out, so it binds the unspecified address and port
75
+ /// 0 alone, as Landlock's `hook_socket_bind` refuses a bind no
76
+ /// `BIND_TCP` right allows.
77
+ fn socket_bind(&self, address: SocketAddr) -> Result<(), Errno> {
78
+ match address.ip().is_unspecified() && address.port() == 0 {
103
79
  true => Ok(()),
104
- false => Err(FilesystemError::PermissionDenied),
105
- }
106
- }
107
- }
108
-
109
- impl SecurityOperations for MountPolicy {
110
- fn path_mknod(&self, path: SecurityPath<'_>) -> Result<(), FilesystemError> {
111
- self.path_perm(path, Access::ReadWrite)
112
- }
113
-
114
- fn path_mkdir(&self, path: SecurityPath<'_>) -> Result<(), FilesystemError> {
115
- self.path_perm(path, Access::ReadWrite)
116
- }
117
-
118
- fn path_rmdir(&self, path: SecurityPath<'_>) -> Result<(), FilesystemError> {
119
- self.path_perm(path, Access::ReadWrite)
120
- }
121
-
122
- fn path_unlink(&self, path: SecurityPath<'_>) -> Result<(), FilesystemError> {
123
- self.path_perm(path, Access::ReadWrite)
124
- }
125
-
126
- fn path_symlink(&self, path: SecurityPath<'_>) -> Result<(), FilesystemError> {
127
- self.path_perm(path, Access::ReadWrite)
128
- }
129
-
130
- fn path_link(
131
- &self,
132
- old: SecurityPath<'_>,
133
- new: SecurityPath<'_>,
134
- ) -> Result<(), FilesystemError> {
135
- self.path_perm(old, Access::ReadWrite)?;
136
- self.path_perm(new, Access::ReadWrite)
137
- }
138
-
139
- /// Asked once for each open, for what the open may change, and kept on the
140
- /// file, as Landlock keeps the rights it allowed. A file the open made was
141
- /// judged as a change already, through `path_mknod`.
142
- fn file_open(
143
- &self,
144
- path: SecurityPath<'_>,
145
- _kind: FileType,
146
- mode: FMode,
147
- how: &OpenHow,
148
- ) -> Result<FileSecurity, FilesystemError> {
149
- if !self.guards(path.mnt) {
150
- return Ok(None);
151
- }
152
- let created = mode.contains(FMode::CREATED);
153
- let access = match created || mode.contains(FMode::WRITE) || how.truncate {
154
- true => Access::ReadWrite,
155
- false => Access::Read,
156
- };
157
- if !created {
158
- self.path_perm(path, access)?;
159
- }
160
- Ok(Some(Arc::new(AllowedAccess(access))))
161
- }
162
-
163
- /// A truncate follows what the Policy allowed as the file opened, wherever
164
- /// the file stands now, as Landlock's `hook_file_truncate` reads the file's
165
- /// rights.
166
- fn file_truncate(&self, kept: &FileSecurity) -> Result<(), FilesystemError> {
167
- match kept
168
- .as_deref()
169
- .and_then(|kept| kept.downcast_ref::<AllowedAccess>())
170
- {
171
- Some(AllowedAccess(Access::Read)) => Err(FilesystemError::PermissionDenied),
172
- _ => Ok(()),
173
- }
174
- }
175
-
176
- fn path_utimes(&self, path: SecurityPath<'_>) -> Result<(), FilesystemError> {
177
- self.path_perm(path, Access::ReadWrite)
178
- }
179
-
180
- /// Both paths are judged. Everything beneath a directory would take paths the
181
- /// Policy never judged, and a Policy answers for one path, not a tree, so its
182
- /// move is refused as one across devices and the guest copies entry by entry
183
- /// instead, as Landlock answers a move it cannot show keeps each right beneath.
184
- /// A move onto its own name takes no new path.
185
- fn path_rename(
186
- &self,
187
- old: SecurityPath<'_>,
188
- new: SecurityPath<'_>,
189
- (old_dentry, new_dentry): (&Arc<Dentry>, &Arc<Dentry>),
190
- ) -> Result<(), FilesystemError> {
191
- self.path_perm(old, Access::ReadWrite)?;
192
- self.path_perm(new, Access::ReadWrite)?;
193
- let moves_dir =
194
- old_dentry.kind() == Ok(FileType::Dir) && !Arc::ptr_eq(old_dentry, new_dentry);
195
- match moves_dir && self.guards(old.mnt) {
196
- true => Err(FilesystemError::CrossesDevices),
197
- false => Ok(()),
80
+ false => Err(Errno::PermissionDenied),
198
81
  }
199
82
  }
200
83
  }
@@ -226,7 +109,7 @@ impl WalkGuard {
226
109
  /// so it is refused too. This keeps a host or another Filesystem instance moving
227
110
  /// a directory behind the runtime's back from having a Policy judge a path it no
228
111
  /// longer stands at.
229
- pub fn check(&self, path: &Path) -> Result<(), FilesystemError> {
112
+ pub fn check(&self, path: &Path) -> Result<(), Errno> {
230
113
  if !self.guarded.iter().any(|mnt| Arc::ptr_eq(mnt, path.mnt())) {
231
114
  return Ok(());
232
115
  }
@@ -238,46 +121,63 @@ impl WalkGuard {
238
121
  .inode()
239
122
  .is_some_and(|inode| inode.identity().is_some());
240
123
  if path.mnt().sb().dentries().unlinked(dentry) || !told_apart || !revalidate_path(path)? {
241
- return Err(FilesystemError::NotFound);
124
+ return Err(Errno::NotFound);
242
125
  }
243
126
  Ok(())
244
127
  }
245
128
  }
246
129
 
247
- /// The Cred an Invocation opens its Mounts' roots with, its Filesystems holding at
248
- /// most `memory_limit` bytes on its behalf, or without bound for `None`: kobako's
130
+ /// The Cred an Invocation opens its Mounts' roots with, charging what the host
131
+ /// holds on its behalf to one budget of `memory_limit` bytes, or without bound
132
+ /// for `None`: kobako's
249
133
  /// own rules, then each of `modules` in order, before any Mount's Policy applies,
250
134
  /// as a Linux task opens the files it keeps before `landlock_restrict_self`.
251
135
  /// The modules are those the Wasm Driver was built with, as Linux stacks the LSMs
252
136
  /// `lsm=` names at boot after the capability module.
253
- pub fn prepare_creds_within(
137
+ pub fn prepare_creds(
254
138
  modules: &[Arc<dyn SecurityOperations>],
255
139
  memory_limit: Option<usize>,
256
140
  ) -> Arc<Cred> {
257
141
  let mut security: Vec<Arc<dyn SecurityOperations>> = vec![Arc::new(KobakoSecurity)];
258
142
  security.extend(modules.iter().cloned());
259
- Cred::within(security, memory_limit.map(VmCommitted::new))
143
+ Cred::within(security, MemoryBudget::new(memory_limit))
260
144
  }
261
145
 
262
- /// `cred` with each Mount's Policy added, the modules it held and the memory
263
- /// held on its behalf shared, so what either Cred charges counts against one
264
- /// limit, as `landlock_restrict_self` adds a domain to the task's Cred.
265
- pub fn restrict_self<'a>(cred: &Cred, mounts: impl IntoIterator<Item = &'a Mount>) -> Arc<Cred> {
266
- cred.with_modules(policies_of(mounts))
146
+ /// `cred` with each Mount's Policy and each network entry's connect policy
147
+ /// added, the modules it held and the memory held on its behalf shared, so
148
+ /// what either Cred charges counts against one limit, as
149
+ /// `landlock_restrict_self` adds a domain ruling both paths and ports. Its
150
+ /// mount namespace holds the Mounts among `grants`, each where Linux's `mount`
151
+ /// would place it, so a walk reaching one by any spelling steps onto it. A
152
+ /// Mount Linux's `mount` refuses makes no Cred, as a container fails to start.
153
+ pub fn restrict_self<'a>(
154
+ cred: &Cred,
155
+ grants: impl IntoIterator<Item = &'a Grant>,
156
+ ) -> Result<Arc<Cred>, UnplacedMountError> {
157
+ let grants: Vec<&Grant> = grants.into_iter().collect();
158
+ let mounts = grants.iter().filter_map(|grant| match grant {
159
+ Grant::Mount(mount) => Some((mount.at(), mount.mnt())),
160
+ Grant::Network(_) => None,
161
+ });
162
+ let mnt_ns = MntNamespace::new(&cred.with_modules(Vec::new()), mounts)?;
163
+ Ok(cred
164
+ .with_modules(policies_of(grants.iter().copied()))
165
+ .with_mnt_ns(Arc::new(mnt_ns)))
267
166
  }
268
167
 
269
168
  fn policies_of<'a>(
270
- mounts: impl IntoIterator<Item = &'a Mount>,
169
+ grants: impl IntoIterator<Item = &'a Grant>,
271
170
  ) -> Vec<Arc<dyn SecurityOperations>> {
272
- mounts
171
+ grants
273
172
  .into_iter()
274
- .filter_map(|mount| {
275
- let policy = mount.policy()?;
276
- Some(Arc::new(MountPolicy {
277
- mnt: mount.mnt().clone(),
278
- at: mount.at().to_string(),
279
- policy: policy.clone(),
280
- }) as Arc<dyn SecurityOperations>)
173
+ .filter_map(|grant| match grant {
174
+ Grant::Mount(mount) => {
175
+ Some(Arc::new(MountPolicy::of(mount)?) as Arc<dyn SecurityOperations>)
176
+ }
177
+ Grant::Network(network) => {
178
+ let policy = network.policies().connect?;
179
+ Some(Arc::new(EntryPolicy(policy)) as Arc<dyn SecurityOperations>)
180
+ }
281
181
  })
282
182
  .collect()
283
183
  }
@@ -287,13 +187,15 @@ mod tests {
287
187
  use super::*;
288
188
  use crate::filesystem::wrap::{Hook, Wrap};
289
189
  use crate::filesystem::{DentryOperations, Filesystem, InodeOperations, Tmpfs};
190
+ use crate::mount::{Access, MountRequest};
191
+ use crate::policy::Policy;
290
192
 
291
193
  /// A Policy allowing everything, counting how often it is asked.
292
194
  #[derive(Default)]
293
195
  struct Counts(std::sync::atomic::AtomicUsize);
294
196
 
295
- impl Policy for Counts {
296
- fn allows(&self, _path: &str, _access: Access) -> bool {
197
+ impl Policy<MountRequest<'_>> for Counts {
198
+ fn allows(&self, _request: &MountRequest<'_>) -> bool {
297
199
  self.0.fetch_add(1, std::sync::atomic::Ordering::SeqCst);
298
200
  true
299
201
  }
@@ -302,9 +204,9 @@ mod tests {
302
204
  /// A Policy refusing every change beneath `/guarded/q`.
303
205
  struct RefusesChangesInQ;
304
206
 
305
- impl Policy for RefusesChangesInQ {
306
- fn allows(&self, path: &str, access: Access) -> bool {
307
- access == Access::Read || !path.starts_with("/guarded/q/")
207
+ impl Policy<MountRequest<'_>> for RefusesChangesInQ {
208
+ fn allows(&self, request: &MountRequest<'_>) -> bool {
209
+ request.access == Access::Read || !request.path.starts_with("/guarded/q/")
308
210
  }
309
211
  }
310
212
 
@@ -314,18 +216,19 @@ mod tests {
314
216
  // @behavior RT-272
315
217
  #[test]
316
218
  fn a_truncate_follows_what_the_policy_allowed_as_the_file_opened() {
317
- let filesystem = Filesystem::new(Arc::new(
219
+ let filesystem = Filesystem::new(
318
220
  [("p/f", "x"), ("q/keep", "x")]
319
221
  .into_iter()
320
222
  .collect::<Tmpfs>(),
321
- ))
223
+ )
322
224
  .expect("the instance must stand");
323
225
  let guarded = Mount::new("/guarded", filesystem.clone(), Access::ReadWrite)
324
226
  .expect("/guarded is a guest path")
325
227
  .with_policy(Arc::new(RefusesChangesInQ));
326
228
  let plain =
327
229
  Mount::new("/plain", filesystem, Access::ReadWrite).expect("/plain is a guest path");
328
- let cred = restrict_self(&prepare_creds_within(&[], None), [&guarded]);
230
+ let cred = restrict_self(&prepare_creds(&[], None), [&Grant::Mount(guarded.clone())])
231
+ .expect("every Mount stands");
329
232
  let write = OpenHow {
330
233
  write: true,
331
234
  ..Default::default()
@@ -335,7 +238,7 @@ mod tests {
335
238
  .unwrap_or_else(|_| panic!("the file must open"));
336
239
  let root = Path::root(plain.mnt());
337
240
  crate::vfs::filename_renameat2(
338
- &restrict_self(&prepare_creds_within(&[], None), []),
241
+ &restrict_self(&prepare_creds(&[], None), []).expect("every Mount stands"),
339
242
  &root,
340
243
  "p/f",
341
244
  &root,
@@ -356,12 +259,13 @@ mod tests {
356
259
  #[test]
357
260
  fn an_open_standing_for_a_path_asks_no_policy() {
358
261
  let policy = Arc::new(Counts::default());
359
- let filesystem = Filesystem::new(Arc::new([("f", "x")].into_iter().collect::<Tmpfs>()))
262
+ let filesystem = Filesystem::new([("f", "x")].into_iter().collect::<Tmpfs>())
360
263
  .expect("the instance must stand");
361
264
  let mount = Mount::new("/data", filesystem, Access::ReadWrite)
362
265
  .expect("/data is a guest path")
363
266
  .with_policy(policy.clone());
364
- let cred = restrict_self(&prepare_creds_within(&[], None), [&mount]);
267
+ let cred = restrict_self(&prepare_creds(&[], None), [&Grant::Mount(mount.clone())])
268
+ .expect("every Mount stands");
365
269
  let opened = crate::vfs::kern_path::filp_open(
366
270
  &cred,
367
271
  &Path::root(mount.mnt()),
@@ -382,7 +286,7 @@ mod tests {
382
286
 
383
287
  /// What making an entry answers through a directory moved past
384
288
  /// `PATH_MAX`, beneath a mount `prepare` finishes.
385
- fn made_past_the_limit(prepare: impl FnOnce(Mount) -> Mount) -> Result<(), FilesystemError> {
289
+ fn made_past_the_limit(prepare: impl FnOnce(Mount) -> Mount) -> Result<(), Errno> {
386
290
  let (deep, seed) = (vec!["a"; 2000].join("/"), "x");
387
291
  let tmpfs: Tmpfs = [
388
292
  (format!("c0/{deep}/file"), seed),
@@ -392,12 +296,13 @@ mod tests {
392
296
  .collect();
393
297
  let mount = Mount::new(
394
298
  "/data",
395
- Filesystem::new(Arc::new(tmpfs)).expect("the instance must stand"),
299
+ Filesystem::new(tmpfs).expect("the instance must stand"),
396
300
  Access::ReadWrite,
397
301
  )
398
302
  .expect("/data is a guest path");
399
303
  let mount = prepare(mount);
400
- let cred = restrict_self(&prepare_creds_within(&[], None), [&mount]);
304
+ let cred = restrict_self(&prepare_creds(&[], None), [&Grant::Mount(mount.clone())])
305
+ .expect("every Mount stands");
401
306
  let root = Path::root(mount.mnt());
402
307
  let how = crate::vfs::OpenHow {
403
308
  read: true,
@@ -439,7 +344,7 @@ mod tests {
439
344
  let asked_past_the_limit = asked.0.load(std::sync::atomic::Ordering::SeqCst);
440
345
  assert_eq!(
441
346
  (made, asked_past_the_limit),
442
- (Err(FilesystemError::InvalidFilename), 1),
347
+ (Err(Errno::InvalidFilename), 1),
443
348
  "vfs::filename_mkdirat through a directory moved past PATH_MAX, beneath a Policy, \
444
349
  must answer ENAMETOOLONG, the Policy asked only of the open before the move"
445
350
  );
@@ -456,7 +361,7 @@ mod tests {
456
361
  ops: &dyn DentryOperations,
457
362
  dir: &dyn InodeOperations,
458
363
  dentry: &Dentry,
459
- ) -> Result<bool, FilesystemError> {
364
+ ) -> Result<bool, Errno> {
460
365
  let reached = match dentry.name() == "d" {
461
366
  true => self.0.lock().expect("the sender").take(),
462
367
  false => None,
@@ -479,7 +384,8 @@ mod tests {
479
384
  .with_policy(Arc::new(Counts::default()));
480
385
  let plain =
481
386
  Mount::new("/plain", filesystem, Access::ReadWrite).expect("/plain is a guest path");
482
- let cred = restrict_self(&prepare_creds_within(&[], None), [&guarded]);
387
+ let cred = restrict_self(&prepare_creds(&[], None), [&Grant::Mount(guarded.clone())])
388
+ .expect("every Mount stands");
483
389
  let how = crate::vfs::OpenHow {
484
390
  read: true,
485
391
  directory: true,
@@ -500,7 +406,7 @@ mod tests {
500
406
  let tmpfs: Tmpfs = [("p/d/f", "x"), ("q/keep", "x")].into_iter().collect();
501
407
  let (reached, asked) = std::sync::mpsc::channel();
502
408
  let hook = Arc::new(PausesRevalidate(std::sync::Mutex::new(None)));
503
- let filesystem = Filesystem::new(Arc::new(Wrap::new(Arc::new(tmpfs), hook.clone())))
409
+ let filesystem = Filesystem::new(Wrap::new(Arc::new(tmpfs), hook.clone()))
504
410
  .expect("the instance must stand");
505
411
  let (cred, held, plain, guard) = held_beneath_a_policy(filesystem);
506
412
  *hook.0.lock().expect("the sender") = Some(reached);
@@ -512,7 +418,7 @@ mod tests {
512
418
  .expect("the call must ask revalidate");
513
419
  let root = Path::root(plain.mnt());
514
420
  crate::vfs::filename_renameat2(
515
- &restrict_self(&prepare_creds_within(&[], None), []),
421
+ &restrict_self(&prepare_creds(&[], None), []).expect("every Mount stands"),
516
422
  &root,
517
423
  "p/d",
518
424
  &root,
@@ -550,7 +456,7 @@ mod tests {
550
456
  ops: &dyn crate::vfs::DentryOperations,
551
457
  dir: &dyn crate::filesystem::InodeOperations,
552
458
  dentry: &Dentry,
553
- ) -> Result<bool, FilesystemError> {
459
+ ) -> Result<bool, Errno> {
554
460
  use std::sync::atomic::Ordering;
555
461
  let guarding = self.guarding.get() == Some(&std::thread::current().id());
556
462
  let from = dentry.name();
@@ -562,7 +468,7 @@ mod tests {
562
468
  let root = self.plain.get().expect("the plain Mount stands").clone();
563
469
  std::thread::spawn(move || {
564
470
  crate::vfs::filename_renameat2(
565
- &restrict_self(&prepare_creds_within(&[], None), []),
471
+ &restrict_self(&prepare_creds(&[], None), []).expect("every Mount stands"),
566
472
  &root,
567
473
  &format!("{from}/d"),
568
474
  &root,
@@ -592,14 +498,14 @@ mod tests {
592
498
  plain: std::sync::OnceLock::new(),
593
499
  moved: std::sync::atomic::AtomicUsize::new(0),
594
500
  });
595
- let filesystem = Filesystem::new(Arc::new(Wrap::new(Arc::new(tmpfs), hook.clone())))
501
+ let filesystem = Filesystem::new(Wrap::new(Arc::new(tmpfs), hook.clone()))
596
502
  .expect("the instance must stand");
597
503
  let (_cred, held, plain, guard) = held_beneath_a_policy(filesystem);
598
504
  hook.plain.set(Path::root(plain.mnt())).ok();
599
505
  hook.guarding.set(std::thread::current().id()).ok();
600
506
  assert_eq!(
601
507
  (guard.check(held.path()), hook.moved.load(Ordering::SeqCst)),
602
- (Err(FilesystemError::WouldBlock), 1),
508
+ (Err(Errno::WouldBlock), 1),
603
509
  "WalkGuard::check of a directory another Mount moves while it is asked, beneath a \
604
510
  Policy, must answer EAGAIN from the pass that met the move"
605
511
  );
@@ -619,16 +525,15 @@ mod tests {
619
525
  #[ignore = "a stress witness; run by rake crates:stress"]
620
526
  fn a_directory_moving_while_calls_start_from_it_stays_reachable_beneath_a_policy() {
621
527
  let tmpfs: Tmpfs = [("p/d/f", "x"), ("q/keep", "x")].into_iter().collect();
622
- let (cred, held, plain, guard) = held_beneath_a_policy(
623
- Filesystem::new(Arc::new(tmpfs)).expect("the instance must stand"),
624
- );
528
+ let (cred, held, plain, guard) =
529
+ held_beneath_a_policy(Filesystem::new(tmpfs).expect("the instance must stand"));
625
530
  let stop = AtomicBool::new(false);
626
531
  let start = held.path().clone();
627
532
  let refused = std::thread::scope(|scope| {
628
533
  scope.spawn(|| {
629
534
  let (root, cred) = (
630
535
  Path::root(plain.mnt()),
631
- restrict_self(&prepare_creds_within(&[], None), []),
536
+ restrict_self(&prepare_creds(&[], None), []).expect("every Mount stands"),
632
537
  );
633
538
  while !stop.load(Ordering::SeqCst) {
634
539
  for (from, to) in [("p/d", "q/d"), ("q/d", "p/d")] {
@@ -642,7 +547,7 @@ mod tests {
642
547
  crate::vfs::vfs_fstatat(&cred, &start, "f", false)
643
548
  };
644
549
  let refused = (0..200_000)
645
- .filter(|_| call().is_err_and(|error| error != FilesystemError::WouldBlock))
550
+ .filter(|_| call().is_err_and(|error| error != Errno::WouldBlock))
646
551
  .count();
647
552
  stop.store(true, Ordering::SeqCst);
648
553
  refused
@@ -662,7 +567,7 @@ mod tests {
662
567
  fn only_a_file_or_a_directory_opens() {
663
568
  let mount = Mount::new(
664
569
  "/data",
665
- crate::filesystem::Filesystem::new(Arc::new(crate::filesystem::Tmpfs::new()))
570
+ crate::filesystem::Filesystem::new(crate::filesystem::Tmpfs::new())
666
571
  .expect("the instance must stand"),
667
572
  Access::Read,
668
573
  )
@@ -24,6 +24,29 @@ pub struct Capture {
24
24
  pub truncated: bool,
25
25
  }
26
26
 
27
+ impl Capture {
28
+ /// What a channel the guest wrote `bytes` into keeps under `limit`: the
29
+ /// bytes clipped to it, marked when they passed it. The pipe holds one
30
+ /// byte past the limit, so a channel written to exactly the limit stays
31
+ /// unmarked.
32
+ pub fn new(mut bytes: Vec<u8>, limit: Option<usize>) -> Self {
33
+ let truncated = limit.is_some_and(|limit| bytes.len() > limit);
34
+ if let Some(limit) = limit.filter(|_| truncated) {
35
+ bytes.truncate(limit);
36
+ }
37
+ Self { bytes, truncated }
38
+ }
39
+
40
+ /// The room a channel's pipe takes for `limit`: one byte past it, so
41
+ /// writing exactly the limit and passing it stay apart.
42
+ pub fn pipe_capacity_of(limit: Option<usize>) -> usize {
43
+ match limit {
44
+ Some(limit) => limit.saturating_add(1),
45
+ None => usize::MAX,
46
+ }
47
+ }
48
+ }
49
+
27
50
  /// How the guest invocation completed: `Outcome` is the result the guest
28
51
  /// left, already framed; `Trap` is an engine fault after the export call
29
52
  /// started, kept as a value so the rest of the `Snapshot` survives it.
@@ -43,8 +66,9 @@ pub enum Completion {
43
66
  /// Resource usage of one guest invocation, each measured across the span
44
67
  /// its cap governs: `wall_time` is the seconds from setting the guest up to
45
68
  /// its export call returning, the span the deadline covers; `memory_peak`
46
- /// is the high-water `memory.grow` delta in bytes past the entry-time
47
- /// baseline. `Default` (all zeros) is the pre-invocation sentinel.
69
+ /// is the most `memory_limit` counted at once, in bytes: the guest's growth
70
+ /// past the entry-time baseline and what the host held for it.
71
+ /// `Default` (all zeros) is the pre-invocation sentinel.
48
72
  #[derive(Clone, Copy, Default)]
49
73
  #[non_exhaustive]
50
74
  pub struct Usage {
@@ -75,3 +99,98 @@ impl Snapshot {
75
99
  }
76
100
  }
77
101
  }
102
+
103
+ #[cfg(test)]
104
+ mod tests {
105
+ //! Channel-agnostic, a function of `limit` rather than of which channel,
106
+ //! so a regression that breaks one channel cannot slip past.
107
+ use super::Capture;
108
+
109
+ fn kept(bytes: &[u8], limit: Option<usize>) -> (Vec<u8>, bool) {
110
+ let capture = Capture::new(bytes.to_vec(), limit);
111
+ (capture.bytes, capture.truncated)
112
+ }
113
+
114
+ // @behavior S-108
115
+ #[test]
116
+ fn a_pipe_holds_one_byte_past_its_limit() {
117
+ assert_eq!(
118
+ (
119
+ Capture::pipe_capacity_of(Some(5)),
120
+ Capture::pipe_capacity_of(Some(0))
121
+ ),
122
+ (6, 1),
123
+ "a limit of 5 and of 0 through Capture::pipe_capacity_of must size the pipe 6 and 1"
124
+ );
125
+ }
126
+
127
+ // @behavior S-109
128
+ #[test]
129
+ fn a_pipe_without_a_limit_holds_usize_max() {
130
+ assert_eq!(
131
+ Capture::pipe_capacity_of(None),
132
+ usize::MAX,
133
+ "no limit through Capture::pipe_capacity_of must size the pipe usize::MAX"
134
+ );
135
+ }
136
+
137
+ // @behavior S-110
138
+ #[test]
139
+ fn a_pipe_past_usize_max_saturates() {
140
+ assert_eq!(
141
+ Capture::pipe_capacity_of(Some(usize::MAX)),
142
+ usize::MAX,
143
+ "a limit of usize::MAX through Capture::pipe_capacity_of must saturate at usize::MAX"
144
+ );
145
+ }
146
+
147
+ // @behavior S-111
148
+ #[test]
149
+ fn a_capture_under_its_limit_stays_whole() {
150
+ assert_eq!(
151
+ kept(b"abc", Some(5)),
152
+ (b"abc".to_vec(), false),
153
+ "3 bytes under a limit of 5 through Capture::new must stay whole and untruncated"
154
+ );
155
+ }
156
+
157
+ // @behavior S-112
158
+ #[test]
159
+ fn a_capture_at_its_limit_is_not_truncated() {
160
+ assert_eq!(
161
+ kept(b"abcde", Some(5)),
162
+ (b"abcde".to_vec(), false),
163
+ "5 bytes at a limit of 5 through Capture::new must stay whole and untruncated"
164
+ );
165
+ }
166
+
167
+ // @behavior S-024
168
+ #[test]
169
+ fn a_capture_past_its_limit_is_clipped_and_truncated() {
170
+ assert_eq!(
171
+ kept(b"abcdef", Some(5)),
172
+ (b"abcde".to_vec(), true),
173
+ "6 bytes past a limit of 5 through Capture::new must clip to 5 and flag truncation"
174
+ );
175
+ }
176
+
177
+ // @behavior S-033
178
+ #[test]
179
+ fn a_capture_without_a_limit_stays_whole() {
180
+ assert_eq!(
181
+ kept(b"abcdef", None),
182
+ (b"abcdef".to_vec(), false),
183
+ "6 bytes with no limit through Capture::new must stay whole and untruncated"
184
+ );
185
+ }
186
+
187
+ // @behavior S-100 S-101
188
+ #[test]
189
+ fn an_empty_capture_stays_empty() {
190
+ assert_eq!(
191
+ kept(b"", Some(5)),
192
+ (Vec::new(), false),
193
+ "no bytes under a limit of 5 through Capture::new must stay empty and untruncated"
194
+ );
195
+ }
196
+ }