kobako 0.27.0-aarch64-linux → 0.28.0-aarch64-linux

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 (81) hide show
  1. checksums.yaml +4 -4
  2. data/.release-please-manifest.json +1 -1
  3. data/CHANGELOG.md +71 -0
  4. data/README.md +100 -125
  5. data/ROADMAP.md +23 -22
  6. data/SECURITY.md +1 -1
  7. data/crates/kobako-runtime/CHANGELOG.md +31 -0
  8. data/crates/kobako-runtime/README.md +4 -3
  9. data/crates/kobako-transport/CHANGELOG.md +28 -0
  10. data/crates/kobako-transport/README.md +21 -12
  11. data/crates/kobako-wasmtime/CHANGELOG.md +44 -0
  12. data/crates/kobako-wasmtime/README.md +2 -2
  13. data/data/kobako.wasm +0 -0
  14. data/lib/kobako/3.3/kobako.so +0 -0
  15. data/lib/kobako/3.4/kobako.so +0 -0
  16. data/lib/kobako/4.0/kobako.so +0 -0
  17. data/lib/kobako/capture.rb +1 -4
  18. data/lib/kobako/catalog/extensions.rb +21 -59
  19. data/lib/kobako/catalog/flags.rb +41 -0
  20. data/lib/kobako/catalog/handles.rb +7 -54
  21. data/lib/kobako/catalog/services.rb +7 -61
  22. data/lib/kobako/catalog/snippets.rb +42 -66
  23. data/lib/kobako/catalog.rb +2 -10
  24. data/lib/kobako/codec/decoder.rb +9 -28
  25. data/lib/kobako/codec/encoder.rb +3 -22
  26. data/lib/kobako/codec/error.rb +6 -27
  27. data/lib/kobako/codec/ext_types.rb +72 -94
  28. data/lib/kobako/codec/handle_walk.rb +65 -130
  29. data/lib/kobako/codec/nesting.rb +3 -8
  30. data/lib/kobako/codec/state.rb +4 -10
  31. data/lib/kobako/codec/utils.rb +6 -34
  32. data/lib/kobako/codec.rb +3 -22
  33. data/lib/kobako/constant_name.rb +8 -0
  34. data/lib/kobako/context.rb +51 -112
  35. data/lib/kobako/errors.rb +51 -127
  36. data/lib/kobako/execution.rb +16 -21
  37. data/lib/kobako/extension.rb +23 -40
  38. data/lib/kobako/handle.rb +7 -12
  39. data/lib/kobako/outcome.rb +51 -80
  40. data/lib/kobako/payload/arguments.rb +1 -16
  41. data/lib/kobako/payload.rb +4 -12
  42. data/lib/kobako/pool.rb +23 -53
  43. data/lib/kobako/runtime.rb +7 -21
  44. data/lib/kobako/sandbox.rb +96 -133
  45. data/lib/kobako/sandbox_options.rb +38 -84
  46. data/lib/kobako/snippet/binary.rb +1 -16
  47. data/lib/kobako/snippet/source.rb +1 -16
  48. data/lib/kobako/snippet.rb +1 -9
  49. data/lib/kobako/transport/call.rb +1 -14
  50. data/lib/kobako/transport/dispatcher.rb +112 -195
  51. data/lib/kobako/transport/error.rb +6 -20
  52. data/lib/kobako/transport/exposure.rb +5 -10
  53. data/lib/kobako/transport/reflection.rb +39 -50
  54. data/lib/kobako/transport/run.rb +17 -71
  55. data/lib/kobako/transport/yielder.rb +21 -73
  56. data/lib/kobako/transport.rb +3 -15
  57. data/lib/kobako/unresolved.rb +4 -11
  58. data/lib/kobako/usage.rb +2 -6
  59. data/lib/kobako/version.rb +1 -1
  60. data/sig/kobako/catalog/extensions.rbs +2 -2
  61. data/sig/kobako/catalog/flags.rbs +17 -0
  62. data/sig/kobako/catalog/services.rbs +0 -6
  63. data/sig/kobako/catalog/snippets.rbs +4 -4
  64. data/sig/kobako/codec/ext_types.rbs +10 -8
  65. data/sig/kobako/codec/handle_walk.rbs +9 -7
  66. data/sig/kobako/codec/utils.rbs +2 -2
  67. data/sig/kobako/codec.rbs +2 -2
  68. data/sig/kobako/constant_name.rbs +3 -0
  69. data/sig/kobako/context.rbs +2 -3
  70. data/sig/kobako/errors.rbs +6 -0
  71. data/sig/kobako/outcome.rbs +6 -8
  72. data/sig/kobako/runtime.rbs +12 -8
  73. data/sig/kobako/sandbox.rbs +4 -0
  74. data/sig/kobako/sandbox_options.rbs +2 -6
  75. data/sig/kobako/transport/dispatcher.rbs +14 -18
  76. data/sig/kobako/transport/reflection.rbs +5 -3
  77. data/sig/kobako/transport/run.rbs +1 -3
  78. data/sig/kobako/transport/yielder.rbs +3 -3
  79. data/sig/kobako/transport.rbs +7 -6
  80. metadata +6 -3
  81. data/rust-toolchain.toml +0 -15
data/README.md CHANGED
@@ -2,9 +2,9 @@
2
2
 
3
3
  [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/elct9620/kobako)
4
4
 
5
- Kobako is a Ruby gem that embeds a Wasm-isolated mruby interpreter inside your application, so you can execute untrusted Ruby scripts (LLM-generated code, user formulas, student submissions, third-party plugins) in-process without giving them access to host memory, files, network, or credentials. Its home is the Ruby ecosystem; a Rust SDK offers the same sandbox to hosts written in other languages.
5
+ Kobako is a Ruby gem that embeds a Wasm-isolated mruby interpreter inside your application. It runs untrusted Ruby scripts in-process — LLM-generated code, user formulas, student submissions, third-party plugins. Those scripts get no access to host memory, files, network, or credentials. Its home is the Ruby ecosystem; a Rust SDK offers the same sandbox to hosts written in other languages.
6
6
 
7
- The host (`wasmtime`) runs a precompiled `kobako.wasm` guest containing mruby and a Transport proxy. The only way a guest script can reach the outside world is through Host App-declared **Services** — named host objects you explicitly inject into the sandbox; the guest sees each one as a proxy that forwards calls back to the host over the Transport wire.
7
+ The host (`wasmtime`) runs a precompiled `kobako.wasm` guest containing mruby and a Transport proxy. A guest script reaches the outside world only through Host App-declared **Services**, the named host objects you explicitly inject into the sandbox. The guest sees each one as a proxy that forwards calls back to the host over the Transport wire.
8
8
 
9
9
  ```
10
10
  Host process Wasm guest
@@ -35,6 +35,8 @@ The precompiled `kobako.wasm` Guest Binary ships inside the gem, so end users do
35
35
 
36
36
  ## Installation
37
37
 
38
+ Install the gem; it ships its Guest Binary prebuilt.
39
+
38
40
  ```bash
39
41
  bundle add kobako
40
42
  # or
@@ -55,12 +57,12 @@ sandbox.eval("1 + 2").value # => 3
55
57
  ```rust
56
58
  use kobako::{Options, Sandbox};
57
59
 
58
- // Options::default() is secure by default: no caps, hermetic isolation.
60
+ // Options::default() is secure by default: the same caps as Ruby, hermetic isolation.
59
61
  let sandbox = Sandbox::new("kobako.wasm", Options::default())?;
60
62
  sandbox.eval("1 + 2")?.value()?; // => Value::Int(3)
61
63
  ```
62
64
 
63
- Each invocation returns the record of that one run — `Kobako::Execution` in Ruby, `Execution` in Rust — carrying the guest value alongside the run's output and resource usage. Nothing a run observes is stored on the Sandbox, so the same Sandbox serves concurrent invocations without them seeing each other.
65
+ Each invocation returns the record of that one run: `Kobako::Execution` in Ruby, `Execution` in Rust. It carries the guest value alongside the run's output and resource usage. Nothing a run observes is stored on the Sandbox, so the same Sandbox serves concurrent invocations without them seeing each other.
64
66
 
65
67
  The gem bundles its Guest Binary; a Rust host loads one explicitly — see [Frontends & Guest Binaries](#frontends--guest-binaries) for the packages and the Guest Binary variants.
66
68
 
@@ -75,31 +77,23 @@ host frontend Guest Binary
75
77
  your own ──┘ └── kobako+json.wasm · your own
76
78
  ```
77
79
 
78
- They compose freely — any frontend loads any Guest Binary, so a Ruby host can run a JSON-enabled guest and a Rust host can run the pure default. How far down those choices go — and which ones a given starting point quietly makes for you — is laid out in [`docs/architecture.md`](docs/architecture.md).
80
+ They compose freely, since any frontend loads any Guest Binary. A Ruby host can run a JSON-enabled guest, and a Rust host can run the pure default. How far down those choices go — and which ones a given starting point quietly makes for you — is laid out in [`docs/guides/assembly-levels.md`](docs/guides/assembly-levels.md).
79
81
 
80
82
  ### Host frontends
81
83
 
82
- The host embeds the sandbox and owns the SPEC wire codec. Choose by your host language and how much of the contract you want pre-assembled.
84
+ The host embeds the sandbox and owns the wire codec. Choose by your host language and how much of the contract you want pre-assembled.
83
85
 
84
86
  | Frontend | Package | Add it | Best for |
85
87
  |----------|---------|--------|----------|
86
88
  | Ruby gem | `kobako` (RubyGems) | `gem install kobako` | A Ruby host — Services, Handles, snippets, and pooling out of the box |
87
- | Rust SDK | `kobako` (crates.io) | `kobako = "0.12"` | A Rust host — the same behavior contract behind an idiomatic Rust API |
88
- | Low-level crates | `kobako-wasmtime` + `kobako-runtime` + `kobako-transport` + `kobako-codec` | Cargo deps | A custom host, or driving the wire directly in another language |
89
+ | Rust SDK | `kobako` (crates.io) | `cargo add kobako` | A Rust host — the same behavior contract behind an idiomatic Rust API |
90
+ | Low-level crates | `kobako-wasmtime` + `kobako-runtime` + `kobako-transport` + `kobako-codec` | `cargo add` each | A custom host, or driving the wire directly in another language |
89
91
 
90
- The Rust crates are documented on [crates.io](https://crates.io/crates/kobako); the Ruby gem is this README. Three runnable Rust hosts show the choice: [`plugin-rs`](examples/plugin-rs) builds on the SDK, [`wire-rs`](examples/wire-rs) assembles a host by hand on the low-level crates, and [`fixed-schema-rs`](examples/fixed-schema-rs) replaces what both of those keep — the payload schema — with a guest and a host that agree on protobuf.
92
+ The Rust crates are documented on [crates.io](https://crates.io/crates/kobako); the Ruby gem is this README. Three runnable Rust hosts show the choice. [`plugin-rs`](examples/plugin-rs) builds on the SDK, and [`wire-rs`](examples/wire-rs) assembles a host by hand on the low-level crates. [`fixed-schema-rs`](examples/fixed-schema-rs) replaces the payload schema both of those keep, with a guest and a host that agree on protobuf.
91
93
 
92
94
  ### Pre-built Guest Binaries
93
95
 
94
- The gem bundles the pure `kobako.wasm`. Regexp and JSON are opt-in capabilities compiled into separate variants, each attached to every [GitHub Release](https://github.com/elct9620/kobako/releases). Download a variant and point your host at it — `Sandbox.new(wasm_path:)` in Ruby, `Sandbox::new(path, ...)` in Rust.
95
-
96
- | Variant | File | Adds | Distribution |
97
- |---------|------|------|--------------|
98
- | Pure (default) | `kobako.wasm` | mruby + IO | Bundled in the gem, and a Release asset |
99
- | +regexp | `kobako+regexp.wasm` | Regexp / MatchData (ASCII) | Release asset |
100
- | +regexp-unicode | `kobako+regexp-unicode.wasm` | Regexp / MatchData (Unicode) | Release asset |
101
- | +json | `kobako+json.wasm` | JSON | Release asset |
102
- | +full | `kobako+full.wasm` | JSON + Regexp (ASCII) | Release asset |
96
+ The gem bundles the pure `kobako.wasm`. Regexp and JSON are opt-in capabilities compiled into separate variants, each attached to every [GitHub Release](https://github.com/elct9620/kobako/releases). Download a variant and point your host at it — `Sandbox.new(wasm_path:)` in Ruby, `Sandbox::new(path, ...)` in Rust. [`docs/guides/variants.md`](docs/guides/variants.md) lists every variant and what it adds.
103
97
 
104
98
  ```ruby
105
99
  sandbox = Kobako::Sandbox.new(wasm_path: "kobako+full.wasm")
@@ -108,54 +102,39 @@ sandbox.eval('JSON.generate({ n: "42".to_i })').value # => "{\"n\":42}"
108
102
 
109
103
  ### Custom Guest Binaries
110
104
 
111
- When no pre-built variant matches your capability set, assemble a guest in Rust. `kobako-mruby` is the harness; its `init_gems` hook is where you install exactly the capability gems you want — the shipped `kobako-io` / `kobako-regexp` / `kobako-json`, or your own `beni::Gem`. `kobako-core`'s `export_guest!` emits the wasm ABI. `wasm/kobako-wasm/src/guest.rs` is the worked example.
105
+ When no variant matches your capability set, build a Guest Binary of your own in Rust. A shell over `kobako-mruby` installs exactly the capability gems you choose: the shipped `kobako-io`, `kobako-regexp`, and `kobako-json`, or your own `beni::Gem`. `kobako-core` exports the wasm ABI. The Ruby gem drives it unchanged.
112
106
 
113
- | Guest crate | Role |
114
- |-------------|------|
115
- | `kobako-mruby` | mruby guest harness — the `MrbGuest` trait and provided flows |
116
- | `kobako-core` | Guest ABI contract — the `Guest` trait and the `export_guest!` macro |
117
- | `kobako-io` | IO / Kernel capability gem |
118
- | `kobako-regexp` | Regexp / MatchData capability gem |
119
- | `kobako-json` | JSON capability gem |
107
+ | To decide | Read |
108
+ |---|---|
109
+ | which parts you own at each level | [`docs/guides/assembly-levels.md`](docs/guides/assembly-levels.md) |
110
+ | what a guest shell implements | [`docs/guides/customization.md`](docs/guides/customization.md) |
111
+ | a working shell | [`wasm/kobako-wasm/src/guest.rs`](wasm/kobako-wasm/src/guest.rs) |
120
112
 
121
- ```rust
122
- use beni::{Error, Mrb};
123
-
124
- struct MyGuest;
125
-
126
- // Pick the capability gems the guest exposes.
127
- impl kobako_mruby::MrbGuest for MyGuest {
128
- fn init_gems(mrb: &Mrb) -> Result<(), Error> {
129
- mrb.init_gem::<kobako_io::KobakoIo>()?;
130
- mrb.init_gem::<kobako_json::KobakoJson>()?;
131
- Ok(())
132
- }
133
- }
134
-
135
- // Forward the ABI contract to the harness flows.
136
- impl kobako_core::Guest for MyGuest {
137
- fn eval() { <MyGuest as kobako_mruby::MrbGuest>::eval() }
138
- fn run(env: &[u8]) { <MyGuest as kobako_mruby::MrbGuest>::run(env) }
139
- fn yield_to_block(req: &[u8]) -> u64 { <MyGuest as kobako_mruby::MrbGuest>::yield_to_block(req) }
140
- }
141
-
142
- kobako_core::export_guest!(MyGuest);
143
- ```
113
+ Build the shell as a `cdylib` for `wasm32-wasip1`, then bake its boot state into the artifact with `kobako-baker input.wasm output.wasm`.
144
114
 
145
- Build the crate as a `cdylib` for `wasm32-wasip1`, then bake the canonical boot state into the artifact (see [`CLAUDE.md`](CLAUDE.md) § Build Pipeline).
115
+ A shell may also define flags, switches the Host App sets for every invocation. A flag is critical by default, so a Guest Binary that does not recognise it raises `Kobako::UnsupportedFlagError` rather than run without it. Mark it `advisory: true` only when a script cannot tell the flag was skipped.
116
+
117
+ ```ruby
118
+ sandbox.flag(:strict_mode) # critical: refused where unrecognised
119
+ sandbox.flag(:compile_cache, "on", advisory: true) # skipped where unrecognised
120
+ ```
146
121
 
147
122
  ## Glossary
148
123
 
149
- | Term | Meaning |
150
- |------|---------|
151
- | Sandbox | The reusable unit (`Kobako::Sandbox`) that runs guest code and returns a result or raises a typed error. It holds configuration only — no state from any run. |
152
- | Service | A host object bound at a constant-path name (`MyService::KV`) — the guest's only path to host resources. |
153
- | Invocation | One `#eval` or `#run`; capability state is scoped to it and ends with it. |
154
- | Execution | The frozen record one invocation returns (`Kobako::Execution`): its `#value`, output captures, and `#usage`. A failed run raises, carrying the same record on the error's `#execution`. |
155
- | Context | The per-invocation object the optional `#eval` / `#run` block receives; its `ctx.bind` supplies a Service object for that one run. |
156
- | Snippet | Named mruby code (source or bytecode) replayed into a fresh state before every invocation. |
157
- | Handle | An opaque token the guest holds for a host object the wire cannot transmit directly. |
158
- | Block | A guest mruby block passed to a Service; each `yield` is a synchronous round-trip into the guest. |
124
+ These terms name the concepts the rest of this README builds on.
125
+
126
+ | Term | Ruby class | Meaning |
127
+ |------|------------|---------|
128
+ | Sandbox | `Kobako::Sandbox` | The unit you configure once and invoke many times. |
129
+ | Invocation | — | One run of guest code, by `#eval` or `#run`. |
130
+ | Execution | `Kobako::Execution` | The frozen record an Invocation leaves. |
131
+ | Service | — | A host object the guest reaches by name, such as `MyService::KV`. |
132
+ | Context | `Kobako::Context` | The per-Invocation object the optional block receives. |
133
+ | Snippet | — | Guest source or bytecode replayed at the start of every Invocation. |
134
+ | Handle | `Kobako::Handle` | An opaque reference to a host object the wire cannot carry by value. |
135
+ | Block | — | Guest code passed alongside a Service call. |
136
+
137
+ A Sandbox keeps nothing from one Invocation to the next. An Execution holds what the run produced, wrote, and consumed: `#value`, output captures, and `#usage`. A failed run raises, carrying its Execution on the error's `#execution`. A Service is the guest's only route to a host resource. A Context's `ctx.bind` supplies a Service object for that one run. A Handle names its object only within the Invocation that issued it. A Block stays in the guest; each `yield` to it is a synchronous round-trip.
159
138
 
160
139
  ## Usage
161
140
 
@@ -171,7 +150,7 @@ Each section below stands on its own; this is the order they build in.
171
150
 
172
151
  ### Services
173
152
 
174
- `bind` any Ruby object as a Service at a constant-path name; the guest reaches it as a `MyService::KV` (or top-level `File`) proxy and invokes the public methods its own class defines through the Transport wire. See [`SV-006`](docs/spec/behavior/services.md) and [`SV-007`](docs/spec/behavior/services.md).
153
+ `bind` any Ruby object as a Service at a constant-path name. The guest reaches it as a `MyService::KV` (or top-level `File`) proxy. Through the Transport wire, the guest invokes the public methods the object's own class defines.
175
154
 
176
155
  ```ruby
177
156
  class User
@@ -191,11 +170,11 @@ sandbox.eval(<<~RUBY)
191
170
  RUBY
192
171
  ```
193
172
 
194
- Each `::`-separated path segment must match `/\A[A-Z]\w*\z/`. Symbol kwargs travel transparently to the host method's keyword arguments. The registry seals at the first invocation (see [Invocation Lifecycle](#invocation-lifecycle)); later `#bind` raises `ArgumentError`.
173
+ Each `::`-separated path segment must match `/\A[A-Z]\w{0,65533}\z/`. Symbol kwargs travel transparently to the host method's keyword arguments. The registry seals at the first invocation (see [Invocation Lifecycle](#invocation-lifecycle)); later `#bind` raises `ArgumentError`.
195
174
 
196
175
  ### Per-Invocation Bindings
197
176
 
198
- A setup-time `bind` fixes one object for the Sandbox's life. When the object belongs to a single run instead — the current request, the acting user, a per-tenant store — declare the path at setup and fill it per invocation. `bind(path)` with no object reserves the name as a *fillable*: the guest sees the constant, while an unfilled dispatch fails closed as `Kobako::ServiceError`. The optional `#eval` / `#run` block fills it ([`SV-017`](docs/spec/behavior/services.md), [`SV-024`](docs/spec/behavior/services.md)).
177
+ A setup-time `bind` fixes one object for the Sandbox's life. Some objects belong to a single run instead: the current request, the acting user, a per-tenant store. For those, declare the path at setup and fill it per invocation. `bind(path)` with no object reserves the name as a *fillable*: the guest sees the constant, while an unfilled dispatch fails closed as `Kobako::ServiceError`. The optional `#eval` / `#run` block fills it.
199
178
 
200
179
  ```ruby
201
180
  sandbox.bind("Req::Current") # declared, unfilled — stands for Kobako::Unresolved
@@ -203,11 +182,11 @@ sandbox.bind("Req::Current") # declared, unfilled — stands for Kobako::Unreso
203
182
  sandbox.eval("Req::Current.user_id") { |ctx| ctx.bind("Req::Current", request) }
204
183
  ```
205
184
 
206
- `ctx.bind` also shadows an already-bound path for that one run. The Context is spent once the block returns, so a `ctx` captured out of it raises `ArgumentError`. Choosing the object per invocation instead of sharing one is what lets concurrent Threads invoke a single Sandbox and still keep their identities apart — the [multi-tenant example](examples/multi-tenant/) runs that shape end to end.
185
+ `ctx.bind` also shadows an already-bound path for that one run. The Context is spent once the block returns, so a `ctx` captured out of it raises `ArgumentError`. Choosing the object per invocation lets concurrent Threads invoke a single Sandbox and still keep their identities apart. The [multi-tenant example](examples/multi-tenant/) runs that shape end to end.
207
186
 
208
187
  ### Output Capture
209
188
 
210
- Guest writes through `puts` / `print` / `p` / `$stdout` / `$stderr` are buffered per-channel and read off the run's Execution, independently of its `#value` ([`S-023`](docs/spec/behavior/sandbox.md), [`S-028`](docs/spec/behavior/sandbox.md)). Each invocation captures its own; overflow is clipped at the cap and flagged by `#stdout_truncated?` / `#stderr_truncated?`.
189
+ Guest writes through `puts` / `print` / `p` / `$stdout` / `$stderr` are buffered per-channel and read off the run's Execution, independently of its `#value`. Each invocation captures its own; overflow is clipped at the cap and flagged by `#stdout_truncated?` / `#stderr_truncated?`.
211
190
 
212
191
  ```ruby
213
192
  execution = sandbox.eval(<<~RUBY)
@@ -229,30 +208,34 @@ Every invocation either returns an Execution or raises exactly one of three clas
229
208
  begin
230
209
  sandbox.eval(script)
231
210
  rescue Kobako::TrapError
232
- # Wasm engine fault or cap exhaustion. Discard the Sandbox.
211
+ # Wasm engine fault or cap exhaustion. The invocation is over.
233
212
  rescue Kobako::ServiceError
234
213
  # A host Service call failed and the script did not rescue it.
235
214
  rescue Kobako::SandboxError => e
236
- # The script raised, failed to compile, or returned an unrepresentable value.
215
+ # The script raised, failed to compile, or returned an unrepresentable value,
216
+ # or the Guest Binary could not start the run.
237
217
  logger.warn(e.execution.stderr) # the failed run's own captures and usage
238
218
  end
239
219
  ```
240
220
 
241
- Each of these carries the failed run's Execution on `#execution`, so a rescue reads that run's output and usage exactly as a successful caller reads them off the returned one. `#failed?` keeps the two apart when both `#value` are `nil` — a script whose last expression was `nil` versus one that never produced a value. A failure caught before the guest ran at all — a host pre-flight refusal — leaves `#execution` `nil`, since there is no run to report.
221
+ Each of these carries the failed run's Execution on `#execution`. A rescue reads that run's output and usage exactly as a successful caller reads them off the returned one. `#failed?` keeps the two apart when both `#value` are `nil` — a script whose last expression was `nil` versus one that never produced a value. A failure caught before the guest ran at all — a host pre-flight refusal — leaves `#execution` `nil`, since there is no run to report.
242
222
 
243
223
  | Class | Parent | Trigger |
244
224
  |---------------------------------|----------------|------------------------------------------------------|
245
225
  | `Kobako::TimeoutError` | `TrapError` | Per-invocation `timeout` exhausted |
246
226
  | `Kobako::MemoryLimitError` | `TrapError` | Per-invocation `memory_limit` exhausted |
227
+ | `Kobako::NoServiceError` | `ServiceError` | Nothing bound there, a dead Handle, or a method the guest may not call |
228
+ | `Kobako::ServiceArgumentError` | `ServiceError` | The arguments did not fit the Service method |
247
229
  | `Kobako::HandleExhaustedError` | `SandboxError` | Handle counter reached its 2³¹ − 1 cap |
248
230
  | `Kobako::BytecodeError` | `SandboxError` | `#preload(binary:)` failed RITE validation at replay |
231
+ | `Kobako::UnsupportedFlagError` | `SandboxError` | The Guest Binary does not recognise a critical `#flag`; no script ran |
249
232
  | `Kobako::UndefinedEntrypointError` | `SandboxError` | `#run` named a constant no snippet defined; carries `#name` and `#available` |
250
233
 
251
234
  `SandboxError` and `ServiceError` carry structured `origin` / `klass` / `backtrace_lines` fields when the guest produced a panic envelope.
252
235
 
253
236
  ### Resource Limits
254
237
 
255
- Each invocation enforces a wall-clock `timeout` and a per-invocation linear-memory `memory_limit`; exhaustion raises a `TrapError` subclass. Pass `nil` to `timeout` / `memory_limit` to disable that cap. Read [`Execution#usage`](lib/kobako/execution.rb) for actual consumption — populated on every outcome, so a rescued trap reports it just as a completed run does ([`S-058`](docs/spec/behavior/sandbox.md), [`S-061`](docs/spec/behavior/sandbox.md)).
238
+ Each invocation enforces a wall-clock `timeout` and a per-invocation linear-memory `memory_limit`; exhaustion raises a `TrapError` subclass. Pass `nil` to `timeout` / `memory_limit` to disable that cap. Read [`Execution#usage`](lib/kobako/execution.rb) for actual consumption — populated on every outcome, so a rescued trap reports it just as a completed run does.
256
239
 
257
240
  ```ruby
258
241
  sandbox = Kobako::Sandbox.new(
@@ -272,26 +255,26 @@ sandbox = Kobako::Sandbox.new(
272
255
 
273
256
  `memory_limit` covers the per-invocation `memory.grow` delta from the entry baseline, so a Sandbox reused across invocations does not silently accumulate against a global budget.
274
257
 
275
- Beyond the four caps, `profile:` requests the Sandbox's isolation posture on the `:permissive` < `:hermetic` ladder (default `:hermetic`). `:hermetic` denies the guest ambient time and entropy; `:permissive` lets the guest's `wasi:clocks` / `wasi:random` read live host sources — an explicit trade of reproducibility, with filesystem, environment, and network still unreachable. The request is also a floor: construction fails with `Kobako::SetupError` on a runtime that declares a weaker posture than requested. See [`docs/security-model.md`](docs/security-model.md) § Isolation profiles.
258
+ Beyond the four caps, `profile:` requests the Sandbox's isolation posture on the `:permissive` < `:hermetic` ladder (default `:hermetic`). `:hermetic` denies the guest ambient time and entropy; `:permissive` lets the guest's `wasi:clocks` / `wasi:random` read live host sources, an explicit trade of reproducibility. Filesystem, environment, and network stay unreachable under either. The request is also a floor: construction fails with `Kobako::SetupError` on a runtime that declares a weaker posture than requested. See [`docs/guides/security.md`](docs/guides/security.md) § Isolation Profiles.
276
259
 
277
260
  ### Concurrency
278
261
 
279
- A Sandbox keeps no state from any run, so concurrent Threads may invoke distinct Sandboxes or share a single one; each invocation owns its Handles, captures, and usage either way ([`RT-001`](docs/spec/behavior/runtime.md), [`RT-002`](docs/spec/behavior/runtime.md)). One Thread still runs one invocation at a time. Sharing a Sandbox adds a single obligation.
262
+ A Sandbox keeps no state from any run, so concurrent Threads may invoke distinct Sandboxes or share a single one. Each invocation owns its Handles, captures, and usage either way. One Thread still runs one invocation at a time. Sharing a Sandbox adds a single obligation.
280
263
 
281
264
  | What you bind | Who reaches it | What it owes |
282
265
  |---|---|---|
283
266
  | Bound once at setup | every Thread sharing the Sandbox | it must itself be thread-safe |
284
267
  | Supplied per invocation — `ctx.bind`, or an Extension `provider:` | that invocation alone | nothing |
285
268
 
286
- #### Choosing a GVL mode
269
+ #### GVL Modes
287
270
 
288
- By default an invocation holds Ruby's GVL for its whole span, so guest execution across Threads serializes. `gvl: :release` drops the GVL for the guest span and re-acquires it for each guest→host dispatch, running guest code in parallel across Threads ([`RT-024`](docs/spec/behavior/runtime.md), [`RT-026`](docs/spec/behavior/runtime.md)).
271
+ By default an invocation holds Ruby's GVL for its whole span, so guest execution across Threads serializes. `gvl: :release` drops the GVL for the guest span and re-acquires it for each guest→host dispatch, running guest code in parallel across Threads.
289
272
 
290
273
  ```ruby
291
274
  sandbox = Kobako::Sandbox.new(gvl: :release)
292
275
  ```
293
276
 
294
- The mode is per-Sandbox and fixed at construction; it changes scheduling only, leaving isolation, Handle lifetimes, captures, and outcomes identical. `:hold` remains the default because releasing pays a handoff cost at every dispatch: compute-bound scripts scale with Thread count, while dispatch-heavy ones match or trail `:hold`. `rake bench:gvl_scheduling` measures both ends on your own hardware.
277
+ The mode is per-Sandbox and fixed at construction; it changes scheduling only, leaving isolation, Handle lifetimes, captures, and outcomes identical. `:hold` remains the default because releasing pays a handoff cost at every dispatch. Compute-bound scripts scale with Thread count, while dispatch-heavy ones match or trail `:hold`. `rake bench:gvl_scheduling` measures both ends on your own hardware.
295
278
 
296
279
  ### Invocation Lifecycle
297
280
 
@@ -342,11 +325,11 @@ One Sandbox serves many invocations. Service bindings and preloaded snippets per
342
325
  Services + snippets persist; invocation N+1 repeats.
343
326
  ```
344
327
 
345
- For workloads that must be isolated from each other (one Sandbox per tenant, per student submission, per agent session), construct a fresh `Kobako::Sandbox` per scope — wasmtime's Engine and the compiled Module are cached at process scope, so additional Sandboxes amortize cold-start cost automatically.
328
+ For workloads that must be isolated from each other, construct a fresh `Kobako::Sandbox` per scope: per tenant, per student submission, per agent session. wasmtime's Engine and the compiled Module are cached at process scope, so additional Sandboxes amortize cold-start cost automatically.
346
329
 
347
330
  ### Pooling
348
331
 
349
- For hosts that serve many short invocations, `Kobako::Pool` keeps a bounded set of warm, identically set-up Sandboxes and hands each one to a single exclusive holder at a time ([`PL-003`](docs/spec/behavior/pool.md), [`PL-011`](docs/spec/behavior/pool.md)). Construction forwards every `Sandbox.new` keyword verbatim; the optional block is the per-Sandbox setup window and runs exactly once per constructed Sandbox.
332
+ For hosts that serve many short invocations, `Kobako::Pool` keeps a bounded set of warm, identically set-up Sandboxes. It hands each one to a single exclusive holder at a time. Construction forwards every `Sandbox.new` keyword verbatim; the optional block is the per-Sandbox setup window and runs exactly once per constructed Sandbox.
350
333
 
351
334
  ```ruby
352
335
  pool = Kobako::Pool.new(slots: 4) do |sandbox|
@@ -363,19 +346,19 @@ pool.with { |sandbox| sandbox.eval(%(KV::Lookup.call("user_42"))).value }
363
346
  | `slots:` | Upper bound on constructed Sandboxes | required |
364
347
  | `checkout_timeout:` | Seconds `#with` waits for a free Sandbox; `nil` waits indefinitely | 5.0 |
365
348
 
366
- Sandboxes construct lazily on first demand. `#with` yields a Sandbox and returns the block's value; at block exit the Sandbox returns to the pool, except a block that raises `Kobako::TrapError` discards its Sandbox and the slot refills by a fresh construction on next demand. A checkout that waits past `checkout_timeout` raises `Kobako::PoolTimeoutError`. There is no teardown verb — a Pool releases everything with its own reachability.
349
+ Sandboxes construct lazily on first demand. `#with` yields a Sandbox and returns the block's value, and at block exit the Sandbox returns to the pool, whatever the block raised. A checkout that waits past `checkout_timeout` raises `Kobako::PoolTimeoutError`. There is no teardown verb — a Pool releases everything with its own reachability.
367
350
 
368
- #### What a Pool buys
351
+ #### Pool Trade-offs
369
352
 
370
353
  | It gives you | It does not give you |
371
354
  |---|---|
372
- | warm, pre-configured Sandboxes and exclusive checkout | isolation — a Sandbox holds no state from any run, so Threads sharing one are equally safe (see [Concurrency](#concurrency)) |
355
+ | warm, pre-configured Sandboxes and exclusive checkout | isolation (see [Concurrency](#concurrency)) |
373
356
 
374
- `Kobako::Pool` is experimental today and is best treated as a convenience for warm, pre-configured reuse rather than a throughput optimisation. The build bakes the shared boot state into the artifact ([`mruby.md`](docs/spec/behavior/mruby.md)) and every dynamic script still compiles and runs per invocation, so all a pool actually saves is the host-side `Sandbox.new` — now about 3 µs, an order of magnitude below the invocation that follows it. For the workload kobako is built for — many small, short-lived Sandboxes running dynamic scripts — that is not a gain worth the coupling.
357
+ A Sandbox holds no state from any run, so Threads sharing one are equally safe. `Kobako::Pool` is experimental today and is best treated as a convenience for warm, pre-configured reuse rather than a throughput optimisation. The build bakes the shared boot state into the artifact, and every dynamic script still compiles and runs per invocation. All a pool actually saves is the host-side `Sandbox.new` — now about 3 µs, an order of magnitude below the invocation that follows it. For the workload kobako is built for — many small, short-lived Sandboxes running dynamic scripts — that is not a gain worth the coupling.
375
358
 
376
359
  ### Service Blocks
377
360
 
378
- A Service method can accept a guest-supplied block via `&blk` and `yield` into it. The block body runs inside the Wasm guest; `break` / `next` / exceptions follow normal Ruby semantics, scoped to the single dispatch. See [`T-085`](docs/spec/behavior/transport-yield.md) and [`T-089`](docs/spec/behavior/transport-yield.md).
361
+ A Service method can accept a guest-supplied block via `&blk` and `yield` into it. The block body runs inside the Wasm guest; `break` / `next` / exceptions follow normal Ruby semantics, scoped to the single dispatch.
379
362
 
380
363
  ```ruby
381
364
  sandbox.bind("Seq::Map", ->(items, &blk) { items.map(&blk) })
@@ -384,9 +367,17 @@ sandbox.eval('Seq::Map.call([1, 2, 3]) { |x| x * 2 }').value
384
367
  # => [2, 4, 6]
385
368
  ```
386
369
 
370
+ A `yield` that cannot complete raises at the Service's call site, so the Service may rescue it. Left unrescued, a `BlockError` hands the guest its own exception back; the other two fail the Service call.
371
+
372
+ | Class | Trigger at `yield` |
373
+ |----------------------------|---------------------------------------|
374
+ | `Kobako::BlockError` | The guest block raised |
375
+ | `Kobako::YieldValueError` | An argument cannot cross to the guest |
376
+ | `Kobako::UnsupportedError` | The Guest Binary serves no block |
377
+
387
378
  ### Handle Management
388
379
 
389
- A non-wire-representable host object — returned from a Service ([`T-001`](docs/spec/behavior/transport-dispatch.md)), passed to `#run` ([`T-066`](docs/spec/behavior/transport-dispatch.md)), or handed back from the guest ([`T-054`](docs/spec/behavior/transport-dispatch.md)) — crosses the boundary as an opaque `Kobako::Handle` proxy and is restored to the original object before host code sees it; any other unrepresentable value raises `Kobako::SandboxError`. Handles are scoped to a single invocation ([`T-038`](docs/spec/behavior/transport-dispatch.md)).
380
+ A host object the wire cannot represent may be returned from a Service, passed to `#run`, or handed back from the guest. It crosses the boundary as an opaque `Kobako::Handle` proxy and is restored to the original object before host code sees it. Any other unrepresentable value raises `Kobako::SandboxError`. Handles are scoped to a single invocation.
390
381
 
391
382
  ```ruby
392
383
  class Greeter
@@ -400,11 +391,11 @@ sandbox.eval('Factory::Make.call("Bob").greet').value # => "hi, Bob" (Handle r
400
391
  sandbox.eval('Factory::Make.call("Bob")').value # => #<Greeter @name="Bob"> (Handle restoration)
401
392
  ```
402
393
 
403
- A `break` value from a guest block is the one exception: it unwinds back to the guest Service call rather than to host code, so a Handle in it stays a Handle — restoring would just re-wrap the same object into a new id on the return trip.
394
+ A `break` value from a guest block is the one exception. It unwinds back to the guest Service call rather than to host code, so a Handle in it stays a Handle. Restoring would just re-wrap the same object into a new id on the return trip.
404
395
 
405
- #### One Handle per dispatch
396
+ #### Per-dispatch Handles
406
397
 
407
- Each dispatch that hands back a non-wire-representable object allocates a *new* Handle — kobako never deduplicates by object identity ([`T-007`](docs/spec/behavior/transport-dispatch.md), [`T-009`](docs/spec/behavior/transport-dispatch.md)). This is most visible with fluent / builder APIs. An `ActiveRecord::Relation` chain `spawn`s a fresh relation at each step, so every hop is an independent dispatch that binds its own Handle:
398
+ Each dispatch that hands back a non-wire-representable object allocates a *new* Handle — kobako never deduplicates by object identity. This is most visible with fluent / builder APIs. An `ActiveRecord::Relation` chain `spawn`s a fresh relation at each step, so every hop is an independent dispatch that binds its own Handle:
408
399
 
409
400
  ```
410
401
  guest chain host (Catalog::Handles, one invocation)
@@ -420,11 +411,11 @@ Each dispatch that hands back a non-wire-representable object allocates a *new*
420
411
  all stay live until the invocation ends, then reset together
421
412
  ```
422
413
 
423
- This is deliberate, not a leak. Handle IDs run to 2³¹ − 1 per invocation and reset between invocations, so even deep chains stay far inside the range. Two consequences are worth keeping in mind: the same host object handed back twice yields two *different* Handles — the guest cannot tell they alias — and every intermediate Handle stays live until the invocation ends, since there is no per-Handle release ([`transport-dispatch.md`](docs/spec/behavior/transport-dispatch.md)).
414
+ This is deliberate, not a leak. Handle IDs run to 2³¹ − 1 per invocation and reset between invocations, so even deep chains stay far inside the range. Two consequences are worth keeping in mind. The same host object handed back twice yields two *different* Handles, and the guest cannot tell they alias. Every intermediate Handle stays live until the invocation ends, since there is no per-Handle release.
424
415
 
425
416
  ### Snippets & Entrypoints
426
417
 
427
- `Sandbox#preload` registers named mruby snippets that replay into every invocation's canonical boot state; `Sandbox#run(:Target, *args, **kwargs)` dispatches into a top-level `Object` constant defined by those snippets ([`S-053`](docs/spec/behavior/sandbox.md), [`S-045`](docs/spec/behavior/sandbox.md)).
418
+ `Sandbox#preload` registers named mruby snippets that replay into every invocation's canonical boot state; `Sandbox#run(:Target, *args, **kwargs)` dispatches into a top-level `Object` constant defined by those snippets.
428
419
 
429
420
  ```ruby
430
421
  sandbox = Kobako::Sandbox.new
@@ -435,9 +426,9 @@ sandbox.run(:Adder, 2, 3).value # => 5
435
426
  sandbox.run(:Greeter, name: "world").value # => "hello, world"
436
427
  ```
437
428
 
438
- An entrypoint's `kwargs` arrive as a trailing positional Hash — mruby's C-side call path carries no keyword arguments — so declare a Hash parameter and unpack it yourself.
429
+ An entrypoint's `kwargs` arrive as a trailing positional Hash, because mruby's C-side call path carries no keyword arguments. Declare a Hash parameter and unpack it yourself.
439
430
 
440
- A target no snippet defined raises `Kobako::UndefinedEntrypointError`, whose `#available` lists the top-level constants the snippets did contribute — so the name is corrected from the error rather than by reading the guest source.
431
+ A target no snippet defined raises `Kobako::UndefinedEntrypointError`. Its `#available` lists the top-level constants the snippets did contribute, so the name is corrected from the error rather than by reading the guest source.
441
432
 
442
433
  ```
443
434
  per-invocation replay (every #eval / #run, snippets in insertion order):
@@ -454,7 +445,7 @@ A target no snippet defined raises `Kobako::UndefinedEntrypointError`, whose `#a
454
445
  return the Execution, then discard the instance
455
446
  ```
456
447
 
457
- #### Choosing a payload form
448
+ #### Payload Forms
458
449
 
459
450
  `#preload` accepts two payload forms:
460
451
 
@@ -463,11 +454,11 @@ A target no snippet defined raises `Kobako::UndefinedEntrypointError`, whose `#a
463
454
  | Source | `preload(code: "...", name: :Const)` | The `name:` keyword | First invocation's replay; compile errors raise `Kobako::SandboxError` |
464
455
  | Bytecode | `preload(binary: bytes)` | Read from the bytecode's `debug_info` | First invocation's replay; structural failure raises `Kobako::BytecodeError` |
465
456
 
466
- Use the source form for snippets authored in your repo; use the bytecode form when snippets ship as build artifacts from a separate `mrbc` pipeline. Both replay through the same per-invocation path, so no snippet content failure surfaces at `#preload` — force the first replay with a no-op invocation (e.g. `sandbox.eval("nil")`) when you want validation before real traffic.
457
+ Use the source form for snippets authored in your repo; use the bytecode form when snippets ship as build artifacts from a separate `mrbc` pipeline. Source is compiled once, before the first invocation, and replays as bytecode from then on, so the bytecode form saves only that one compile. Both replay through the same per-invocation path, so no snippet content failure surfaces at `#preload` — force the first replay with a no-op invocation (e.g. `sandbox.eval("nil")`) when you want validation before real traffic.
467
458
 
468
459
  ### Extensions
469
460
 
470
- An Extension teaches the guest a native-style constant by pairing a guest idiom (`source`) with an optional host `backend`. `Sandbox#install` composes the two through the existing `#preload` and `#bind` verbs, adding no wire or Guest Binary surface: pure operations run in-guest with no round-trip, while the rest dispatch to the backend under the same isolation and reflection guarantees as any bound Service ([`docs/extensions.md`](docs/extensions.md), [`EX-005`](docs/spec/behavior/extension.md), [`EX-006`](docs/spec/behavior/extension.md)).
461
+ An Extension teaches the guest a native-style constant by pairing a guest idiom (`source`) with an optional host `backend`. `Sandbox#install` composes the two through the existing `#preload` and `#bind` verbs, adding no wire or Guest Binary surface. Pure operations run in-guest with no round-trip. The rest dispatch to the backend under the same isolation and reflection guarantees as any bound Service ([`docs/guides/extensions.md`](docs/guides/extensions.md)).
471
462
 
472
463
  ```ruby
473
464
  FILE = <<~'MRUBY'
@@ -497,17 +488,17 @@ A backend declares the bound object's lifetime by keyword, never by inference
497
488
  | Keyword | Lifetime |
498
489
  |-------------|-----------------------------------------------------------------------------|
499
490
  | `object:` | One object, shared by every invocation |
500
- | `provider:` | A no-argument callable invoked per invocation — what a writable backend needs, so its state cannot leak across runs |
491
+ | `provider:` | A no-argument callable invoked per invocation |
501
492
  | neither | A fillable, standing for `Kobako::Unresolved` until `ctx.bind` supplies the run's object |
502
493
 
503
- kobako ships no concrete Extension; the idiom and backend are yours. The [overlay VFS example](examples/vfs/) is a worked `File` that reads through to disk while protecting it from guest writes.
494
+ A writable backend takes `provider:`, so its state cannot leak across runs. kobako ships no concrete Extension; the idiom and backend are yours. The [overlay VFS example](examples/vfs/) is a worked `File` that reads through to disk while protecting it from guest writes.
504
495
 
505
496
  ## Security
506
497
 
507
498
  kobako isolates the guest, but **what it may reach is whatever you `bind`** — and `bind`
508
499
  exposes every public method the object's own class defines. Inherited, mixed-in, and built-in
509
- methods stay out of reach, but the class's own surface does not, so bind a purpose-built
510
- object scoped to the task, not a capable one whose other methods leak more than you intend.
500
+ methods stay out of reach, but the class's own surface does not. Bind a purpose-built object
501
+ scoped to the task, not a capable one whose other methods leak more than you intend.
511
502
 
512
503
  ```ruby
513
504
  class ThemeReader # only #color is reachable; AppConfig.secret_key is not
@@ -517,30 +508,14 @@ end
517
508
  sandbox = Kobako::Sandbox.new
518
509
  sandbox.bind("Cfg::Settings", ThemeReader.new) # not: bind("Cfg::Settings", AppConfig)
519
510
 
520
- sandbox.eval('Cfg::Settings.color').value # => "#3366ff" — every other method raises NoMethodError
521
- ```
522
-
523
- #### Gating an object's own surface
524
-
525
- When a purpose-built wrapper is more than you need, an object can gate its own surface in
526
- place: a private `respond_to_guest?(name)` answers, per method, whether the guest may call
527
- it. Returning `false` for every name makes the object opaque — a credential the guest
528
- forwards to another Service but never reads — while permitting a named subset exposes exactly those.
529
-
530
- ```ruby
531
- class Credential
532
- def initialize(token) = @token = token
533
- def to_s = @token
534
-
535
- private def respond_to_guest?(_name) = false # forwardable, never readable
536
- end
511
+ sandbox.eval('Cfg::Settings.color').value # => "#3366ff" — any other method raises Kobako::NoServiceError
537
512
  ```
538
513
 
539
514
  Guest code can name any `MyService::KV` path, but a forged name only resolves to
540
- something you bound — the real authorization gate is this host-side allowlist. Give each
541
- trust context its own Sandbox, and see [`docs/security-model.md`](docs/security-model.md) for the rest
542
- as security-design concerns: validating untrusted input, default-deny external effects,
543
- and controlling the return surface.
515
+ something you bound. What you bind is the real authorization gate. An object can also
516
+ narrow its own surface with a private `respond_to_guest?`. Give each trust context its own
517
+ Sandbox. [`docs/guides/security.md`](docs/guides/security.md) covers the rest: self-gating
518
+ objects, validating untrusted input, default-deny external effects, and the return surface.
544
519
 
545
520
  ## Performance
546
521
 
@@ -555,19 +530,19 @@ Order-of-magnitude figures on macOS arm64, Ruby 3.4.7, YJIT off. Absolute values
555
530
  | Warm `#run(:Entrypoint, ...)` dispatch | ~79 µs |
556
531
  | Service call amortized inside one invocation | ~5.8 µs |
557
532
  | Snippet replay per invocation | ~7.0 µs each |
558
- | Per additional idle Sandbox (RSS) | ~1 KB |
533
+ | Per additional idle Sandbox (RSS) | < 1 KB |
559
534
 
560
- The Cranelift JIT runs once per machine and gem version — the compiled artifact persists in a `.cwasm` disk cache, so later processes deserialize in milliseconds. An idle Sandbox holds no wasm instance (the canonical boot state is baked into the artifact and instantiated per invocation), which is why a thousand idle tenants cost ~34 MB total. A +10% regression on any SPEC-mandated benchmark blocks release.
535
+ The Cranelift JIT runs once per machine and gem version — the compiled artifact persists in a `.cwasm` disk cache, so later processes deserialize in milliseconds. An idle Sandbox holds no wasm instance, which is why a thousand idle tenants cost ~34 MB total. The canonical boot state is baked into the artifact and instantiated per invocation. A +10% regression on any gated benchmark blocks release.
561
536
 
562
- #### What moves the ceiling
537
+ #### Throughput Levers
563
538
 
564
539
  | Choice | What it changes |
565
540
  |---|---|
566
- | `gvl: :hold` (default) | wasm work is GVL-serialized: aggregate throughput stays around 16k `#eval`/s regardless of Thread count, though Ruby-side `#eval` setup still overlaps |
541
+ | `gvl: :hold` (default) | ~16k `#eval`/s in aggregate, at any Thread count |
567
542
  | `gvl: :release` | lifts that ceiling for compute-bound scripts (see [Concurrency](#concurrency)) |
568
- | `match?` over `=~` | `=~` (~5 µs/match) costs about 5× `match?` (~1.0 µs), because it eagerly builds the `MatchData` and match globals — prefer `match?` for boolean tests |
543
+ | `match?` over `=~` | `=~` (~5 µs/match) costs about 5× `match?` (~1.0 µs) |
569
544
 
570
- Regexp is an opt-in capability gem, excluded from the default binary and the gated set; its throughput is tracked in a separate non-gated characterization (`#11` in [`benchmark/README.md`](benchmark/README.md)).
545
+ Under `:hold` the GVL serializes wasm work, though Ruby-side `#eval` setup still overlaps. `=~` eagerly builds the `MatchData` and match globals, so prefer `match?` for boolean tests. Regexp is an opt-in capability gem, excluded from the default binary and the gated set. Its throughput is tracked in a separate non-gated characterization (`#11` in [`benchmark/README.md`](benchmark/README.md)).
571
546
 
572
547
  ```bash
573
548
  bundle exec rake bench # every gated regression benchmark (~5-8 min)
@@ -579,10 +554,10 @@ After checking out the repo:
579
554
 
580
555
  ```bash
581
556
  bin/setup # install dependencies
582
- bundle exec rake # default: compile + test + rubocop + steep
557
+ bundle exec rake # the release gate: compile, tests, rubocop, steep, gate checks
583
558
  ```
584
559
 
585
- Building from source requires a WASI-capable Rust toolchain in addition to the standard host toolchain; the first compile walks the full chain — the [beni](https://github.com/elct9620/beni) gem vendors wasi-sdk + mruby and builds `libmruby.a` (`rake beni:build`), then `rake wasm:build` produces the Guest Binary. See [`CLAUDE.md`](CLAUDE.md) for the rake task map and pipeline layout. `bin/console` opens an IRB session with the gem preloaded; `bundle exec rake install` installs the local checkout as a gem.
560
+ Building from source requires a WASI-capable Rust toolchain in addition to the standard host toolchain. The first compile walks the full chain. The [beni](https://github.com/elct9620/beni) gem vendors wasi-sdk + mruby and builds `libmruby.a` (`rake beni:build`), then `rake wasm:build` produces the Guest Binary. See [`AGENTS.md`](AGENTS.md) for the rake task map and pipeline layout. `bin/console` opens an IRB session with the gem preloaded; `bundle exec rake install` installs the local checkout as a gem.
586
561
 
587
562
  ## Contributing
588
563
 
data/ROADMAP.md CHANGED
@@ -1,25 +1,26 @@
1
1
  # Roadmap
2
2
 
3
- kobako is a Ruby gem providing an in-process Wasm sandbox for untrusted mruby
4
- code: a wasmtime host runs a precompiled `kobako.wasm` guest, with host↔guest
5
- Transport over a MessagePack wire. Features cover one-shot `#eval`, preload +
6
- `#run` dispatch, Service injection at constant-path names, opaque
7
- Capability Handles, block yield re-entry, three-class error attribution,
8
- output capture, and a warm Sandbox pool.
3
+ kobako runs untrusted mruby code in an in-process Wasm sandbox. A wasmtime
4
+ host drives a precompiled `kobako.wasm` guest over a MessagePack wire. Each
5
+ row below links a feature to its scenarios and to where its code starts.
9
6
 
10
- | Feature | Entry Points | Notes |
11
- |---------|-------------|-------|
12
- | ✅ [F-01 Sandbox instantiation](docs/spec/behavior/sandbox.md) | [lib/kobako/sandbox.rb](lib/kobako/sandbox.rb) | — |
13
- | ✅ [F-02 Service binding](docs/spec/behavior/services.md) | [lib/kobako/catalog/services.rb](lib/kobako/catalog/services.rb) | — |
14
- | ✅ [F-04 Synchronous mruby source execution (`#eval`)](docs/spec/behavior/sandbox.md) | [lib/kobako/sandbox.rb](lib/kobako/sandbox.rb) | — |
15
- | ✅ [F-05 Guest-initiated Transport dispatch](docs/spec/behavior/transport-dispatch.md) | [lib/kobako/transport/dispatcher.rb](lib/kobako/transport/dispatcher.rb) | — |
16
- | ✅ [F-06 Capability Handle encoding and referencing](docs/spec/behavior/transport-dispatch.md) | [lib/kobako/catalog/handles.rb](lib/kobako/catalog/handles.rb) | — |
17
- | ✅ [F-07 Three-class error attribution and raising](docs/spec/behavior/outcome.md) | [lib/kobako/outcome.rb](lib/kobako/outcome.rb) | A guest-entry decode failure is exercised only through its payload half ([`CD-003`](docs/spec/behavior/codec.md)); a Run envelope that does not frame is not reachable through the public API |
18
- | ✅ [F-08 Guest output capture](docs/spec/behavior/sandbox.md) | [lib/kobako/capture.rb](lib/kobako/capture.rb) | — |
19
- | ✅ [F-09 Host–guest message codec](docs/wire-codec.md) | [crates/kobako-transport/](crates/kobako-transport/) (core envelope + ABI, one implementation), [lib/kobako/codec/](lib/kobako/codec/) (host payload codec) | The payload layer has a second implementation in `crates/kobako-codec`; the envelope layer is pinned by golden vectors instead |
20
- | ✅ [F-10 Reproducible build pipeline](SPEC.md#code-organization) | [tasks/wasm/build.rake](tasks/wasm/build.rake) | Verified by build-time gates (double-bake byte-identity, gemspec whitelist), not `test/` |
21
- | ✅ [F-11 Multi-layer test and benchmark suite](SPEC.md#testing-style) | [test/](test/) | Benchmarks live in [benchmark/](benchmark/) with the gate in `tasks/bench/`; the anchor baseline advances only by deliberate re-bless |
22
- | ✅ [F-12 Guest block reception and yield re-entry](docs/spec/behavior/transport-yield.md) | [lib/kobako/transport/yielder.rb](lib/kobako/transport/yielder.rb) | — |
23
- | ✅ [F-13 Snippet preloading (`#preload`)](docs/spec/behavior/sandbox.md) | [lib/kobako/catalog/snippets.rb](lib/kobako/catalog/snippets.rb) | — |
24
- | ✅ [F-14 Synchronous entrypoint dispatch (`#run`)](docs/spec/behavior/sandbox.md) | [lib/kobako/sandbox.rb](lib/kobako/sandbox.rb) | — |
25
- | ✅ [F-15 Warm Sandbox pool checkout (`Kobako::Pool`)](docs/spec/behavior/pool.md) | [lib/kobako/pool.rb](lib/kobako/pool.rb) | — |
7
+ | Feature | Entry Points |
8
+ |---------|-------------|
9
+ | ✅ [Sandbox](docs/spec/behavior/sandbox.md) | [lib/kobako/sandbox.rb](lib/kobako/sandbox.rb) |
10
+ | ✅ [Service registration](docs/spec/behavior/services.md) | [lib/kobako/catalog/services.rb](lib/kobako/catalog/services.rb) |
11
+ | ✅ [Runtime](docs/spec/behavior/runtime.md) | [lib/kobako/runtime.rb](lib/kobako/runtime.rb) |
12
+ | ✅ [Pool](docs/spec/behavior/pool.md) | [lib/kobako/pool.rb](lib/kobako/pool.rb) |
13
+ | ✅ [Extension](docs/spec/behavior/extension.md) | [lib/kobako/extension.rb](lib/kobako/extension.rb) |
14
+ | ✅ [Outcome attribution](docs/spec/behavior/outcome.md) | [lib/kobako/outcome.rb](lib/kobako/outcome.rb) |
15
+ | ✅ [Transport dispatch](docs/spec/behavior/transport-dispatch.md) | [lib/kobako/transport/dispatcher.rb](lib/kobako/transport/dispatcher.rb) |
16
+ | ✅ [Yield re-entry](docs/spec/behavior/transport-yield.md) | [lib/kobako/transport/yielder.rb](lib/kobako/transport/yielder.rb) |
17
+ | ✅ [Dispatch boundary](docs/spec/behavior/transport-boundary.md) | [lib/kobako/transport/exposure.rb](lib/kobako/transport/exposure.rb) |
18
+ | ✅ [Payload encoding](docs/spec/behavior/payload-encoding.md) | [lib/kobako/payload/](lib/kobako/payload/) |
19
+ | ✅ [Payload wire](docs/spec/behavior/codec.md) | [lib/kobako/codec/](lib/kobako/codec/) |
20
+ | ✅ [Core envelope](docs/spec/behavior/envelope.md) | [crates/kobako-transport/](crates/kobako-transport/) |
21
+ | ✅ [mruby guest](docs/spec/behavior/mruby.md) | [wasm/kobako-mruby/](wasm/kobako-mruby/) |
22
+ | ✅ [Guest IO](docs/spec/behavior/io.md) | [wasm/kobako-io/](wasm/kobako-io/) |
23
+ | ✅ [Guest JSON](docs/spec/behavior/json.md) | [wasm/kobako-json/](wasm/kobako-json/) |
24
+ | ✅ [Regexp](docs/spec/behavior/regexp.md) | [wasm/kobako-regexp/src/regexp.rs](wasm/kobako-regexp/src/regexp.rs) |
25
+ | ✅ [Regexp over String](docs/spec/behavior/regexp-string.md) | [wasm/kobako-regexp/src/string_ext.rs](wasm/kobako-regexp/src/string_ext.rs) |
26
+ | ✅ [MatchData](docs/spec/behavior/regexp-matchdata.md) | [wasm/kobako-regexp/src/matchdata.rs](wasm/kobako-regexp/src/matchdata.rs) |
data/SECURITY.md CHANGED
@@ -3,7 +3,7 @@
3
3
  kobako runs untrusted guest code inside an in-process Wasm sandbox, so a break in
4
4
  its isolation boundary is treated as a security issue. This file is about **reporting
5
5
  such an issue**; for how the boundary is meant to work and where your
6
- responsibilities as a host begin, see [`docs/security-model.md`](docs/security-model.md).
6
+ responsibilities as a host begin, see [`docs/guides/security.md`](docs/guides/security.md).
7
7
 
8
8
  ## Supported versions
9
9