Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9c674e541d | ||
|
|
5f06c955cb | ||
|
|
7ca42b0e9f | ||
|
|
149d3faac1 | ||
|
|
8ab77ec9dc | ||
|
|
b50e846b11 | ||
|
|
56762648e3 | ||
|
|
2231e4efe1 | ||
|
|
37c58cb5b2 | ||
|
|
2f053b8a5b | ||
|
|
fb6efa1558 | ||
|
|
3879b4cc4d | ||
|
|
b816e435df | ||
|
|
ae91de745e | ||
|
|
687cafb392 | ||
|
|
1ac5193b0e | ||
|
|
230927d8db |
Generated
+78
-79
@@ -78,18 +78,18 @@ checksum = "3ded4057c258ba199e2d26386d3af3780957ecaee6c4ef4041c6b4b8b97c0b06"
|
||||
|
||||
[[package]]
|
||||
name = "block-buffer"
|
||||
version = "0.10.4"
|
||||
version = "0.12.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "3078c7629b62d3f0439517fa394996acacc5cbc91c5a20d8c658e77abd503a71"
|
||||
checksum = "d2f6c7dbe95a6ed67ad9f18e57daf93a2f034c524b99fd2b76d18fdfeb6660aa"
|
||||
dependencies = [
|
||||
"generic-array",
|
||||
"hybrid-array",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "cc"
|
||||
version = "1.5.1"
|
||||
version = "1.9.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "f360145194ee8e21db5ee7f3fcd4fe52210864c75c985dae33218202c8bbe040"
|
||||
checksum = "877bf67ac8e52449eb2f9e98a344ea163beb70dd1f9eebe3cc5357dcfeaee4df"
|
||||
dependencies = [
|
||||
"find-msvc-tools",
|
||||
"shlex",
|
||||
@@ -148,40 +148,46 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "1d07550c9036bf2ae0c684c4297d503f838287c83c53686d05370d0e139ae570"
|
||||
|
||||
[[package]]
|
||||
name = "cpufeatures"
|
||||
version = "0.2.17"
|
||||
name = "const-oid"
|
||||
version = "0.10.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "59ed5838eebb26a2bb2e58f6d5b5316989ae9d08bab10e0e6d103e656d1b0280"
|
||||
checksum = "a6ef517f0926dd24a1582492c791b6a4818a4d94e789a334894aa15b0d12f55c"
|
||||
|
||||
[[package]]
|
||||
name = "cpufeatures"
|
||||
version = "0.3.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "5ca28b0ae3115b884660db4118d803791fd6756b6e88f39c0f3f7859060d7566"
|
||||
dependencies = [
|
||||
"libc",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "crc32fast"
|
||||
version = "1.5.2"
|
||||
version = "1.5.3"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "01a7799fd6b852db0e61728dde9a204c423b44d689dbd432522543614b490e78"
|
||||
checksum = "0ba106e844045ddc02c20768ac4b0b7cb45f2cc2ecbd833ac9f5dacb183c2055"
|
||||
dependencies = [
|
||||
"cfg-if",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "crypto-common"
|
||||
version = "0.1.7"
|
||||
version = "0.2.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "78c8292055d1c1df0cce5d180393dc8cce0abec0a7102adb6c7b1eef6016d60a"
|
||||
checksum = "ce6e4c961d6cd6c9a86db418387425e8bdeaf05b3c8bc1411e6dca4c252f1453"
|
||||
dependencies = [
|
||||
"generic-array",
|
||||
"typenum",
|
||||
"hybrid-array",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "digest"
|
||||
version = "0.10.7"
|
||||
version = "0.11.3"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "9ed9a281f7bc9b7576e61468ba615a66a5c8cfdff42420a70aa82701a3b1e292"
|
||||
checksum = "f1dd6dbb5841937940781866fa1281a1ff7bd3bf827091440879f9994983d5c2"
|
||||
dependencies = [
|
||||
"block-buffer",
|
||||
"const-oid",
|
||||
"crypto-common",
|
||||
]
|
||||
|
||||
@@ -218,9 +224,9 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "find-msvc-tools"
|
||||
version = "0.1.14"
|
||||
version = "0.1.15"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "aedcfb3409746eddb02b9e19ebda1c3394f759a152e48ee875a0844d1b955484"
|
||||
checksum = "1c66915cc5391097de7a2b0b972e8505aa33c0df401fd3a6811dbdb32881ba48"
|
||||
|
||||
[[package]]
|
||||
name = "flate2"
|
||||
@@ -242,16 +248,6 @@ dependencies = [
|
||||
"percent-encoding",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "generic-array"
|
||||
version = "0.14.7"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "85649ca51fd72272d7821adaf274ad91c288277713d9c18820d8499a7ff69e9a"
|
||||
dependencies = [
|
||||
"typenum",
|
||||
"version_check",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "getrandom"
|
||||
version = "0.2.17"
|
||||
@@ -276,10 +272,19 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "7f24254aa9a54b5c858eaee2f5bccdb46aaf0e486a595ed5fd8f86ba55232a70"
|
||||
|
||||
[[package]]
|
||||
name = "icu_collections"
|
||||
version = "2.3.0"
|
||||
name = "hybrid-array"
|
||||
version = "0.4.15"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "fa68d21081c4a05d5a901a1c62add574c77048b6a1c67be3b50ce0b60d4ca513"
|
||||
checksum = "27f864f10dfb56725ce5ce5472bc52252c8f93a4ab86327122cebf62c5f59a17"
|
||||
dependencies = [
|
||||
"typenum",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "icu_collections"
|
||||
version = "2.4.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "fe090a42a0d3140fed8c63263ed1fecc02422cb2f4bfe55cd8de2de1b8e105dd"
|
||||
dependencies = [
|
||||
"displaydoc",
|
||||
"potential_utf",
|
||||
@@ -291,9 +296,9 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "icu_locale_core"
|
||||
version = "2.3.0"
|
||||
version = "2.4.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "d56e28588da92eee5c3201a6eff33fabdd49b62269c8938d4ff050ce4d900deb"
|
||||
checksum = "25d29b57c17c6528d0dc4c2141cfa2d08200465acb537a3909c8b9b8a4a984c0"
|
||||
dependencies = [
|
||||
"displaydoc",
|
||||
"litemap",
|
||||
@@ -304,9 +309,9 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "icu_normalizer"
|
||||
version = "2.3.0"
|
||||
version = "2.4.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "12f9cf5f235641ed274641dd81c3f28d870e276763d0797aeeab72317b1c646f"
|
||||
checksum = "404a3b8c486f205c87fe7f23ab6894d84a4ad76d6e4671ae1981ba7def87c599"
|
||||
dependencies = [
|
||||
"icu_collections",
|
||||
"icu_normalizer_data",
|
||||
@@ -318,15 +323,15 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "icu_normalizer_data"
|
||||
version = "2.3.0"
|
||||
version = "2.4.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "1563da1ed3e0b3bf3d74c9b85917ac9c56464d2f57242270c09c9e752f8021a0"
|
||||
checksum = "20f0088bfb7441f7a37fa0c9e20cb1e9cba1cac6b9ce8cd2a6dc44294f8e8cbc"
|
||||
|
||||
[[package]]
|
||||
name = "icu_properties"
|
||||
version = "2.3.0"
|
||||
version = "2.4.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "7e7ca276ad3145661a65914e6daf131ca5120cd3dcee8f8f3214b8875184a148"
|
||||
checksum = "2ea83d991c56158f7cf898bf86436c1dfe7c07ee82fe88951f2695c9f37a379f"
|
||||
dependencies = [
|
||||
"displaydoc",
|
||||
"icu_collections",
|
||||
@@ -339,15 +344,15 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "icu_properties_data"
|
||||
version = "2.3.0"
|
||||
version = "2.4.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "e590f038c1464a96894fd6d10127e90a8be4509f56ff7ecef851b15cee0b7caa"
|
||||
checksum = "b98f29af82d02b163fe50161388350e743bb3107cc8e8c2f7314cb505faddfcf"
|
||||
|
||||
[[package]]
|
||||
name = "icu_provider"
|
||||
version = "2.3.1"
|
||||
version = "2.4.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "d27bbb9d3abbefac45d55f647c9de1d44aafcd1186eb91879afef17c396c3e73"
|
||||
checksum = "413099315636c588ee8f011190b329b971a09a8fae9d157e01dcae8379468514"
|
||||
dependencies = [
|
||||
"displaydoc",
|
||||
"icu_locale_core",
|
||||
@@ -393,9 +398,9 @@ checksum = "8f42a60cbdf9a97f5d2305f08a87dc4e09308d1276d28c869c684d7777685682"
|
||||
|
||||
[[package]]
|
||||
name = "libc"
|
||||
version = "0.2.189"
|
||||
version = "0.2.191"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "3eaf3ede3fee6db1a4c2ee091bf8a8b4dccdc6d17f656fb07896ee72867612f2"
|
||||
checksum = "65cd87c9a6d60536580b316ad985726104730a5151c99845f2490428ef91240a"
|
||||
|
||||
[[package]]
|
||||
name = "linux-raw-sys"
|
||||
@@ -505,9 +510,9 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "rustls"
|
||||
version = "0.23.45"
|
||||
version = "0.23.46"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "0d41d731c7d2f962d1ccc364cec258de3c0e93b38c2fb3ba97ac74513048d634"
|
||||
checksum = "48e13bd8c0e9365c43cfa5c9e8f9ad49d3c8444926c9aac819e0e4dc503c8fdf"
|
||||
dependencies = [
|
||||
"log",
|
||||
"once_cell",
|
||||
@@ -529,9 +534,9 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "rustls-webpki"
|
||||
version = "0.103.15"
|
||||
version = "0.103.16"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "f3c3cf1d8b1e7d4927e2d154c3fcb02979afb9939629c62cd9048d4f07b60ac2"
|
||||
checksum = "4443b1b6d39d7c663139942cc4558262562d2c84123bb6282ef177009ca8b281"
|
||||
dependencies = [
|
||||
"ring",
|
||||
"rustls-pki-types",
|
||||
@@ -569,9 +574,9 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "serde_json"
|
||||
version = "1.0.151"
|
||||
version = "1.0.154"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "c841b55ecdae098c80dcae9cf767f6f8a0c2cdb3416bbef72181df4d0fe73f14"
|
||||
checksum = "e7e9cc8b1b85264074fbcc02a88680c4096b1e47df8f739dceb03bf482f04bd6"
|
||||
dependencies = [
|
||||
"itoa",
|
||||
"memchr",
|
||||
@@ -582,9 +587,9 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "sha2"
|
||||
version = "0.10.9"
|
||||
version = "0.11.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "a7507d819769d01a365ab707794a4084392c824f54a7a6a7862f8c3d0892b283"
|
||||
checksum = "47d7069beb7d6ac7b9acd1039986e73443f24234f41074da099d6f994ac9ad19"
|
||||
dependencies = [
|
||||
"cfg-if",
|
||||
"cpufeatures",
|
||||
@@ -605,9 +610,9 @@ checksum = "3a219298ac11a56ea9a6d2120044824d6f01aeb034955e7af7bc16858527deea"
|
||||
|
||||
[[package]]
|
||||
name = "smallvec"
|
||||
version = "1.16.2"
|
||||
version = "1.16.3"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "f9395f0f0eee849a9b707b2f06bb92a6a422090e2123bb2ef8e87a0e61892a8e"
|
||||
checksum = "5b3dc8af474f516a851ff4bd12db780f948b9250ad37211e4eec0bccea54e01b"
|
||||
|
||||
[[package]]
|
||||
name = "stable_deref_trait"
|
||||
@@ -629,9 +634,9 @@ checksum = "13c2bddecc57b384dee18652358fb23172facb8a2c51ccc10d74c157bdea3292"
|
||||
|
||||
[[package]]
|
||||
name = "syn"
|
||||
version = "3.0.6"
|
||||
version = "3.0.9"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "8593e8e72159ed2257d083c7a454a85cbf854f37a0966d8d483aff8c8a3ebcee"
|
||||
checksum = "d78c8dee4c7bf0e14673097256fed6142ce9d3b85a408189d07482442145823b"
|
||||
dependencies = [
|
||||
"proc-macro2",
|
||||
"quote",
|
||||
@@ -662,9 +667,9 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "tinystr"
|
||||
version = "0.8.4"
|
||||
version = "0.8.5"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "b1e27c91459209c2986af3dcf603a5a74a4368754ce37414f59acc971167f643"
|
||||
checksum = "abc840c238154d58f9e86b2792261edfde565a17696e1cda1a449de27979801a"
|
||||
dependencies = [
|
||||
"displaydoc",
|
||||
"zerovec",
|
||||
@@ -678,9 +683,9 @@ checksum = "b6f5e870be6c3b371b77fe0ee0bafb859fa4964b4404c27de1d380043c4dda20"
|
||||
|
||||
[[package]]
|
||||
name = "unicode-ident"
|
||||
version = "1.0.26"
|
||||
version = "1.0.27"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "d245f478577f809a851594d02313b640fb437e0bb33866753cff937863096954"
|
||||
checksum = "a2c754d6c33795a1c324727428e5a7dedb5b06195f9890bdbcba760d3e246563"
|
||||
|
||||
[[package]]
|
||||
name = "untrusted"
|
||||
@@ -728,12 +733,6 @@ version = "0.2.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "06abde3611657adf66d383f00b093d7faecc7fa57071cce2578660c9f1010821"
|
||||
|
||||
[[package]]
|
||||
name = "version_check"
|
||||
version = "0.9.5"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "0b928f33d975fc6ad9f86c8f283853ad26bdd5b10b7f1542aa2fa15e2289105a"
|
||||
|
||||
[[package]]
|
||||
name = "wasi"
|
||||
version = "0.11.1+wasi-snapshot-preview1"
|
||||
@@ -746,14 +745,14 @@ version = "0.26.11"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "521bc38abb08001b01866da9f51eb7c5d647a19260e00054a8c7fd5f9e57f7a9"
|
||||
dependencies = [
|
||||
"webpki-roots 1.0.9",
|
||||
"webpki-roots 1.0.10",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "webpki-roots"
|
||||
version = "1.0.9"
|
||||
version = "1.0.10"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "7dcd9d09a39985f5344844e66b0c530a33843579125f23e21e9f0f220850f22a"
|
||||
checksum = "1c1c8e20c8a38fc7d65abfe74eb7280e4aa667e8eec8bc84996d2874810748d9"
|
||||
dependencies = [
|
||||
"rustls-pki-types",
|
||||
]
|
||||
@@ -854,7 +853,7 @@ checksum = "3ad82d2a33cdc9674dc7465672f271e096168fcdbe0f799d9e6db8c5892679dc"
|
||||
|
||||
[[package]]
|
||||
name = "wsbx"
|
||||
version = "0.1.2"
|
||||
version = "0.2.2"
|
||||
dependencies = [
|
||||
"anyhow",
|
||||
"clap",
|
||||
@@ -879,9 +878,9 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "yoke"
|
||||
version = "0.8.3"
|
||||
version = "0.8.4"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "709fe23a0424b6a435d82152b1bd3fdfb0833487d5fa90d05d42762a9891fef5"
|
||||
checksum = "417ef3fcf6c300b7dbd25c85531a746931c02ad536f3cf4786ed1e88223340b3"
|
||||
dependencies = [
|
||||
"stable_deref_trait",
|
||||
"yoke-derive",
|
||||
@@ -923,9 +922,9 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "zeroize"
|
||||
version = "1.9.0"
|
||||
version = "1.9.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "e13c156562582aa81c60cb29407084cdb54c4164760106ab78e6c5b0858cf64e"
|
||||
checksum = "e13084392c5e4bc371903e2935a5eaeed24905a7511356b883835e18a78f6879"
|
||||
|
||||
[[package]]
|
||||
name = "zerotrie"
|
||||
@@ -940,9 +939,9 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "zerovec"
|
||||
version = "0.11.8"
|
||||
version = "0.11.9"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "bb0464e17806c1d976d5cba29399c7f08e516e279e2ba493f63123b5fca67dd8"
|
||||
checksum = "f58a2799cfe9a1670c7ea8edbd52ef8edb93cb37a7f83bf31ba9e35d9dae6a40"
|
||||
dependencies = [
|
||||
"yoke",
|
||||
"zerofrom",
|
||||
@@ -951,9 +950,9 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "zerovec-derive"
|
||||
version = "0.11.6"
|
||||
version = "0.11.7"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "34df6fc39dbd26ddc9c10e6a2984476e13acce22e64e4487636ef494369225da"
|
||||
checksum = "c3743ddbf47738d929cd1ae2e199d40d0162979dfe31aef8ae646d2bf00bf97a"
|
||||
dependencies = [
|
||||
"proc-macro2",
|
||||
"quote",
|
||||
|
||||
+2
-2
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "wsbx"
|
||||
version = "0.1.2"
|
||||
version = "0.2.2"
|
||||
edition = "2024"
|
||||
|
||||
[dependencies]
|
||||
@@ -10,6 +10,6 @@ flate2 = "1"
|
||||
hex = "0.4"
|
||||
libc = "0.2"
|
||||
serde_json = "1"
|
||||
sha2 = "0.10"
|
||||
sha2 = "0.11"
|
||||
tar = "0.4"
|
||||
ureq = "2"
|
||||
|
||||
@@ -1,77 +1,111 @@
|
||||
# wsbx
|
||||
|
||||
Docker-Sandboxes-style microVMs on Apple Silicon macOS. Each sandbox is a real Linux VM
|
||||
(Virtualization.framework via [vfkit]), booted from any OCI image with a Kata Containers kernel.
|
||||
Linux microVMs for coding agents on Apple Silicon macOS. Each sandbox is a real VM
|
||||
(Virtualization.framework via [vfkit]) booted from any OCI image with a Kata Containers kernel.
|
||||
|
||||
## Install
|
||||
|
||||
```sh
|
||||
brew install vfkit e2fsprogs go # go: builds the static guest tunnel helper
|
||||
cargo install --path . # or grab wsbx-*-darwin-arm64.tar.gz from a release (push a v* tag to build one)
|
||||
|
||||
wsbx claude # Claude Code in a VM, current dir mounted at the same path
|
||||
wsbx codex | wsbx gemini # other agents (Docker's sandbox-templates images)
|
||||
wsbx pi # pi coding agent, same version + config as on the host
|
||||
wsbx run alpine # bare VM, interactive shell
|
||||
wsbx run -w . ubuntu -- make test # one-off command, exit code propagated
|
||||
wsbx run -p 8000 alpine # host's localhost:8000 reachable as localhost:8000 in the VM
|
||||
wsbx exec NAME # shell in a running sandbox (alias: sh), as the image's user
|
||||
wsbx exec -u root NAME -- apk add git # command, exit code propagated
|
||||
wsbx forward NAME 3000 8080:80 # sandbox's localhost:3000 on the Mac's localhost:3000 (until Ctrl-C; alias fwd)
|
||||
wsbx ps # sandboxes: running/stopped, image, disk use, workspace (alias: ls)
|
||||
wsbx rm NAME... # delete stopped sandboxes; --disk deletes only the disk (fresh on next start)
|
||||
wsbx pull IMAGE
|
||||
wsbx gc # delete cached images no sandbox uses
|
||||
wsbx kernel [--update | --version TAG] # latest Kata release by default, sha256-verified
|
||||
brew install vfkit e2fsprogs
|
||||
curl -fsSL https://git.nhaiden.io/niklas/woiken-sandboxes/raw/branch/main/install.sh | sh
|
||||
```
|
||||
|
||||
Defaults for `--cpus`/`--memory` come from the host (half the cores, a quarter of RAM up to 8 GiB). Image tags
|
||||
are re-resolved after 24 h (cached copy used when offline); the superseded image is deleted automatically. `WSBX_KATA_VERSION` pins the kernel release.
|
||||
Installs the latest release to `~/.local/bin` (sha256-checked). `WSBX_VERSION=v0.2.1` pins a release,
|
||||
`WSBX_INSTALL_DIR` changes the target. From source: `brew install go && cargo install --path .`.
|
||||
|
||||
Options: `--name --workspace --cpus --memory --disk --env K[=V] --host-port/-p PORT --fresh --pull --kernel`.
|
||||
## Usage
|
||||
|
||||
**exec**: host → vfkit unix socket (`exec.sock`) → vsock → guest helper. It runs in the workspace dir with the sandbox's env.
|
||||
You get a pty (with resize) when stdin and stdout are terminals, plain pipes otherwise, so `wsbx exec x -- cat f > out` is byte-exact.
|
||||
```sh
|
||||
wsbx claude | codex | gemini | pi # agent in a VM, current dir mounted at the same path
|
||||
wsbx run -w . ubuntu -- make test # any image, one-off command, exit code propagated
|
||||
wsbx run -p 8000 alpine # host localhost:8000 reachable inside the VM
|
||||
wsbx exec NAME [-- cmd] # shell/command in a running sandbox (-u root)
|
||||
wsbx forward NAME 3000 8080:80 # guest localhost ports on the Mac's localhost
|
||||
wsbx code NAME [--desktop] # VS Code in the browser, or desktop via Remote-SSH (ssh NAME.wsbx)
|
||||
wsbx ps [-f] # status, CPU, memory, I/O, disk
|
||||
wsbx rm NAME... [--disk] | wsbx pull IMAGE | wsbx gc | wsbx kernel [--update]
|
||||
```
|
||||
|
||||
**forward**: host `127.0.0.1:HOSTPORT` → `exec.sock` → vsock → guest helper → guest `localhost:PORT`, one exec-style session
|
||||
per connection. Works for services bound only to the guest's loopback, on running sandboxes, no restart. `0:PORT` picks a free host port.
|
||||
Run options: `--name --workspace --cpus --memory --disk --env K[=V] -p PORT --fresh --pull --kernel`.
|
||||
Agents: `--keys` forwards API keys; `pi` mirrors the host's pi version and config (`--pi-auth` adds `auth.json`).
|
||||
|
||||
**Host tunnel** (`-p PORT`): guest `localhost:PORT` → vsock → vfkit → unix socket → host `localhost:PORT`.
|
||||
Nothing listens on a host network interface, and only the listed ports are reachable.
|
||||
## Architecture
|
||||
|
||||
**pi**: installs `@earendil-works/pi-coding-agent` at the host's `pi --version` (reinstalls when it changes).
|
||||
On every start it copies these from `~/.pi/agent` with symlinks resolved: settings, models, keybindings, mcp, AGENTS/CLAUDE/SYSTEM md files,
|
||||
extensions, skills, prompts, themes. They're linked into the guest's own `~/.pi/agent`, so host edits
|
||||
win and in-VM edits are discarded. `npm/`, `bin/` (macOS binaries) and sessions stay in the VM. `auth.json` is only
|
||||
copied with `--pi-auth`. Local `baseUrl`s in `models.json` (127.0.0.1/localhost) are tunneled automatically.
|
||||
Agent API keys (`ANTHROPIC_API_KEY`, `OPENAI_API_KEY`, …) are only forwarded with `--keys`. Code in the VM can read them.
|
||||
Sandboxes persist per name (disk under `~/.wsbx/sandboxes`); `--fresh` rebuilds. See `PLAN.md` for design.
|
||||
```mermaid
|
||||
flowchart LR
|
||||
reg[("OCI registry")]
|
||||
subgraph host["macOS host"]
|
||||
cli["wsbx"]
|
||||
img[("~/.wsbx/images<br/>flattened rootfs.tar")]
|
||||
sbx[("~/.wsbx/sandboxes/NAME<br/>disk.img · meta.json")]
|
||||
share["share/<br/>init · run.sh · guest helper"]
|
||||
ws["workspace"]
|
||||
socks["exec.sock · pPORT.sock"]
|
||||
end
|
||||
subgraph vm["Linux microVM"]
|
||||
init["busybox init (PID 1)"]
|
||||
run["run.sh (root)"]
|
||||
cmd["agent / command<br/>(image user)"]
|
||||
helper["guest helper"]
|
||||
end
|
||||
reg -->|"verify, flatten"| cli --> img
|
||||
cli -->|"spawns vfkit"| vm
|
||||
img -.->|"virtio-blk ro, first boot only"| init
|
||||
sbx -->|"virtio-blk /"| init
|
||||
share -->|"virtio-fs /.wsbx/host"| init
|
||||
init --> run --> cmd
|
||||
run --> helper
|
||||
ws -->|"virtio-fs, same path"| cmd
|
||||
socks <-->|"vsock"| helper
|
||||
```
|
||||
|
||||
[vfkit]: https://github.com/crc-org/vfkit
|
||||
```mermaid
|
||||
sequenceDiagram
|
||||
participant H as wsbx (host)
|
||||
participant V as vfkit
|
||||
participant G as guest
|
||||
H->>H: pull image (cache, tags re-resolved after 24 h)
|
||||
H->>H: first start: write meta.json, mke2fs disk seeded with busybox + stub init
|
||||
H->>H: recreate share/ (init, run.sh, guest helper)
|
||||
H->>V: boot kernel, disk, share, workspace, vsock
|
||||
V->>G: stub init mounts share, execs current init
|
||||
G->>G: first boot: untar image from read-only disk
|
||||
G->>G: run.sh: env, mounts, start helper, drop to image user
|
||||
G-->>H: exit code via share/exit, then poweroff
|
||||
```
|
||||
|
||||
- **One process per VM.** The VM lives as long as its command; the exit code comes back through the share.
|
||||
- **Persistent disk, fresh plumbing.** `disk.img` (sparse ext4) keeps the guest's state between runs; init, `run.sh`
|
||||
and the guest helper are rewritten into the share on every start, so upgrading wsbx upgrades existing sandboxes.
|
||||
- **Own OCI client.** Anonymous pulls of linux/arm64 images, layers flattened on the host (whiteouts applied),
|
||||
cached by digest. No Docker needed.
|
||||
- **No host network exposure.** `exec`, `forward`, `code` and `-p` tunnels all run over vsock through unix
|
||||
sockets in the sandbox dir; host-side listeners bind loopback only. Guest egress is vfkit NAT.
|
||||
- **Code layout.** Host: `src/*.rs`. Guest helper (exec, port forwarding, SSH for VS Code): `guest/*.go`,
|
||||
cross-compiled by `build.rs` and embedded in the binary. Design notes: `PLAN.md`.
|
||||
|
||||
## Security model
|
||||
|
||||
The VM is the boundary. The guest (including a prompt-injected agent or a malicious image) is assumed hostile.
|
||||
The VM is the boundary. The guest, including a prompt-injected agent or a malicious image, is assumed hostile.
|
||||
|
||||
- **Control share** (`/.wsbx/host`): the guest can write to it, so it's recreated empty on every start while the VM is stopped and
|
||||
deleted after exit. Guest outputs are read only as regular files with a size cap; persistent state lives in the host-only
|
||||
`meta.json`.
|
||||
- **vfkit arguments**: paths containing `,` `"` or control characters are refused (vfkit splits options on commas).
|
||||
Workspaces overlapping `~/.wsbx` are refused.
|
||||
- **Registry**: references are validated before any request, digest pins are enforced, and every blob/manifest is sha256-verified.
|
||||
Auth realms must be https. For public registries, connections to loopback/private/link-local addresses are refused
|
||||
(token realms and redirects included).
|
||||
- **pi config**: allowlisted items only. Symlinks are followed only into `~/.pi/agent` or `~/.agents/skills`, with no cycles
|
||||
and no special files, capped at 256 MB.
|
||||
- **exec**: sessions run as root before dropping to the user, so the guest helper accepts them only from the host's vsock CID,
|
||||
not from guest processes via vsock loopback.
|
||||
- **forward**: listens on the host's loopback only. Browsers don't isolate `localhost` cookies by port, so a forwarded guest
|
||||
page can read non-HttpOnly cookies your other localhost apps set. Forward only what you need.
|
||||
- **Host tunnel**: only the ports you pass with `-p` (or the local `baseUrl`s in pi's `models.json`), over vsock.
|
||||
- **Control share**: guest-writable, so it's recreated empty on every start and deleted after exit. Guest outputs are
|
||||
read only as small regular files; persistent state lives in host-only `meta.json`.
|
||||
- **Image**: env keys must be shell identifiers; the command runs as the image's user.
|
||||
- **vfkit arguments**: paths with `,` `"` or control characters are refused. Workspaces overlapping `~/.wsbx` are refused.
|
||||
- **Registry**: references validated, digest pins enforced, every blob/manifest sha256-verified, auth realms https-only.
|
||||
Connections to loopback/private/link-local addresses are refused, including auth realms, redirects and IPv6 forms (NAT64, 6to4).
|
||||
A registry is local only if named `localhost` or a private IP literal; use the IP for LAN registries. 30 s network timeouts.
|
||||
- **Guest base**: busybox (PID 1) is pinned by digest; the kernel is sha256-checked against the Kata release.
|
||||
- **exec**: the guest helper accepts sessions only from the host's vsock CID, not from guest processes.
|
||||
- **code**: the in-guest SSH server is reachable only through `wsbx exec`, allows no `-R` or agent forwarding.
|
||||
- **pi config**: allowlisted files only; symlinks only into `~/.pi/agent` or `~/.agents/skills`, capped at 256 MB.
|
||||
|
||||
Remaining risks:
|
||||
- The workspace is read-write. A guest can plant files that run later on the host (`.git/hooks`, `.envrc`,
|
||||
IDE tasks, package scripts). Review changes before running them on the host.
|
||||
- Egress is unrestricted NAT. Anything the VM holds (keys passed with `--keys`, API keys in pi's `models.json`, `--pi-auth`)
|
||||
can be exfiltrated. A host-side credential-injecting egress proxy would fix this; it isn't built yet.
|
||||
- A kernel panic before the root disk mounts (e.g. a corrupt `disk.img`) still restart-loops; panics after boot stop
|
||||
the VM (exit 1).
|
||||
- Image layers are unpacked on the host into one tar, so a decompression bomb can fill the disk.
|
||||
- The workspace is read-write: a guest can plant files that later run on the host (`.git/hooks`, `.envrc`, package scripts).
|
||||
- Egress is unrestricted, so anything in the VM (`--keys`, pi's `models.json`, `--pi-auth`) can be exfiltrated.
|
||||
- Browsers share `localhost` cookies across ports: a page served via `forward` or `code` can read your other localhost apps' cookies.
|
||||
Desktop VS Code also auto-forwards guest ports (`remote.autoForwardPorts`).
|
||||
- Image layers are unpacked on the host, so a decompression bomb can fill the disk.
|
||||
- A kernel panic before the root disk mounts restart-loops; later panics stop the VM.
|
||||
|
||||
[vfkit]: https://github.com/crc-org/vfkit
|
||||
|
||||
@@ -2,15 +2,13 @@
|
||||
use std::process::Command;
|
||||
|
||||
fn main() {
|
||||
const SRC: [&str; 2] = ["guest/fwd.go", "guest/exec.go"];
|
||||
for f in SRC {
|
||||
println!("cargo:rerun-if-changed={f}");
|
||||
}
|
||||
println!("cargo:rerun-if-changed=guest"); // a directory: cargo watches everything in it
|
||||
let out = std::path::PathBuf::from(std::env::var("OUT_DIR").unwrap()).join("wsbx-guest");
|
||||
let ok = Command::new("go")
|
||||
.args(["build", "-trimpath", "-ldflags=-s -w", "-o"])
|
||||
.arg(&out)
|
||||
.args(SRC)
|
||||
.arg(".")
|
||||
.current_dir("guest")
|
||||
.env("GOOS", "linux")
|
||||
.env("GOARCH", "arm64")
|
||||
.env("CGO_ENABLED", "0")
|
||||
|
||||
+10
-4
@@ -1,8 +1,10 @@
|
||||
// `wsbx exec` server: host -> vfkit unix socket -> vsock -> here.
|
||||
//
|
||||
// Protocol: the host sends one JSON request line, then frames go both ways: kind byte, u32 BE length, payload.
|
||||
//
|
||||
// host -> guest: 'd' stdin data, 'e' stdin EOF, 'w' window size (rows, cols: u16 BE)
|
||||
// guest -> host: 'o' stdout, 'r' stderr, 'k' keepalive (ignored), 'x' exit status (u32 BE), always last
|
||||
//
|
||||
// With Tty the command gets a pty (stdout carries everything); otherwise plain pipes.
|
||||
// With Connect (`wsbx forward`) there's no command: 'd'/'e' go to the guest's localhost:Connect, its output
|
||||
// comes back as 'o', and 'x' marks its EOF (status 0) or a failed dial (1, after an 'r' message).
|
||||
@@ -174,11 +176,15 @@ func session(c *os.File) {
|
||||
case <-output:
|
||||
case <-time.After(500 * time.Millisecond): // a background job still holds the pty
|
||||
}
|
||||
code := uint32(cmd.ProcessState.ExitCode())
|
||||
if ws, ok := cmd.ProcessState.Sys().(syscall.WaitStatus); ok && ws.Signaled() {
|
||||
code = 128 + uint32(ws.Signal())
|
||||
send('x', binary.BigEndian.AppendUint32(nil, exitCode(cmd.ProcessState)))
|
||||
}
|
||||
send('x', binary.BigEndian.AppendUint32(nil, code))
|
||||
|
||||
// exitCode like a shell's $?: 128+N for a signal.
|
||||
func exitCode(ps *os.ProcessState) uint32 {
|
||||
if ws, ok := ps.Sys().(syscall.WaitStatus); ok && ws.Signaled() {
|
||||
return 128 + uint32(ws.Signal())
|
||||
}
|
||||
return uint32(ps.ExitCode())
|
||||
}
|
||||
|
||||
// forward pipes a session to the guest's localhost:port until both sides sent EOF or the host is gone.
|
||||
|
||||
+10
-1
@@ -1,5 +1,6 @@
|
||||
// wsbx-guest: guest helper, started by run.sh as root.
|
||||
// Usage: wsbx-guest [-exec VSOCKPORT] PORT=VSOCKPORT...
|
||||
// Usage: wsbx-guest [-exec VSOCKPORT] PORT=VSOCKPORT... | wsbx-guest -ssh-stdio
|
||||
// -ssh-stdio serves one SSH connection on stdin/stdout (ssh.go), run through `wsbx exec`.
|
||||
// -exec serves `wsbx exec` sessions (exec.go). Each PORT=VSOCKPORT is a host tunnel: listens on
|
||||
// 127.0.0.1:PORT and [::1]:PORT and pipes each connection to the host (vsock CID 2).
|
||||
package main
|
||||
@@ -65,7 +66,15 @@ func handle(c *net.TCPConn, port uint32) {
|
||||
|
||||
func main() {
|
||||
execPort := flag.Uint("exec", 0, "serve `wsbx exec` sessions on this vsock port")
|
||||
sshStdio := flag.Bool("ssh-stdio", false, "serve one SSH connection on stdin/stdout")
|
||||
flag.Parse()
|
||||
if *sshStdio {
|
||||
if err := serveSSH(); err != nil {
|
||||
fmt.Fprintln(os.Stderr, "wsbx-guest: ssh:", err)
|
||||
os.Exit(1)
|
||||
}
|
||||
return
|
||||
}
|
||||
// ash starts '&' jobs with SIGINT/SIGQUIT ignored, and ignored signals survive exec: Ctrl-C would
|
||||
// not work in exec sessions. Handled signals are reset to default in children, so take them over.
|
||||
signal.Notify(make(chan os.Signal, 1), syscall.SIGINT, syscall.SIGQUIT)
|
||||
|
||||
@@ -0,0 +1,7 @@
|
||||
module wsbx-guest
|
||||
|
||||
go 1.26.0
|
||||
|
||||
require golang.org/x/crypto v0.58.0
|
||||
|
||||
require golang.org/x/sys v0.49.0 // indirect
|
||||
@@ -0,0 +1,6 @@
|
||||
golang.org/x/crypto v0.58.0 h1:COkYLr4k7nDI4r6QtMML2AfzeIswWHAJthLS6K/M/54=
|
||||
golang.org/x/crypto v0.58.0/go.mod h1:Xh+kl5A+M0gMiWDytH2Hhr5Z7WbNCpv/eB/EFgfSk+w=
|
||||
golang.org/x/sys v0.49.0 h1:XbzkgYJHdqh/8m2Uu0W/dQv8nktxx4BFHp1M0gROTXA=
|
||||
golang.org/x/sys v0.49.0/go.mod h1:hNLxWAXmnKAxqDtdwIYC4bM9oQPEecfsnNMuSxOs3og=
|
||||
golang.org/x/term v0.47.0 h1:cpyOwQkr2Nzxe2p6KnrTG7Ei2wtzjsuSjhpXXepZ/BM=
|
||||
golang.org/x/term v0.47.0/go.mod h1:efAfAuG6RKABvg1ArGebRkvX6LXul14SM67o2e4mUCY=
|
||||
+211
@@ -0,0 +1,211 @@
|
||||
// `wsbx code --desktop`: an SSH server on stdin/stdout for VS Code Remote-SSH (or plain ssh), one per
|
||||
// connection, started by the host's ProxyCommand: `wsbx exec NAME -- /.wsbx/host/guest -ssh-stdio`.
|
||||
// The exec channel is the authentication (only the host user can open it), so the client gets in with no
|
||||
// auth against an ephemeral host key, and runs as the user exec started us as (the image user).
|
||||
// Supported: sessions (exec, shell, pty, env, window-change) and host -> guest forwarding (direct-tcpip,
|
||||
// direct-streamlocal). Guest -> host forwarding (tcpip-forward) and agent forwarding are refused.
|
||||
package main
|
||||
|
||||
import (
|
||||
"crypto/ed25519"
|
||||
"fmt"
|
||||
"io"
|
||||
"net"
|
||||
"os"
|
||||
"os/exec"
|
||||
"strconv"
|
||||
"syscall"
|
||||
"time"
|
||||
|
||||
"golang.org/x/crypto/ssh"
|
||||
)
|
||||
|
||||
func serveSSH() error {
|
||||
_, key, err := ed25519.GenerateKey(nil)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
signer, err := ssh.NewSignerFromKey(key)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
cfg := &ssh.ServerConfig{NoClientAuth: true}
|
||||
cfg.AddHostKey(signer)
|
||||
_, chans, reqs, err := ssh.NewServerConn(stdio{}, cfg)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
go ssh.DiscardRequests(reqs) // global requests: tcpip-forward etc. are refused
|
||||
for nc := range chans {
|
||||
switch nc.ChannelType() {
|
||||
case "session":
|
||||
go sshSession(nc)
|
||||
case "direct-tcpip":
|
||||
var p struct {
|
||||
Host string
|
||||
Port uint32
|
||||
OrigHost string
|
||||
OrigPort uint32
|
||||
}
|
||||
if ssh.Unmarshal(nc.ExtraData(), &p) != nil {
|
||||
nc.Reject(ssh.ConnectionFailed, "bad request")
|
||||
continue
|
||||
}
|
||||
go sshForward(nc, "tcp", net.JoinHostPort(p.Host, strconv.Itoa(int(p.Port))))
|
||||
case "direct-streamlocal@openssh.com":
|
||||
var p struct {
|
||||
Path string
|
||||
Reserved0 string
|
||||
Reserved1 uint32
|
||||
}
|
||||
if ssh.Unmarshal(nc.ExtraData(), &p) != nil {
|
||||
nc.Reject(ssh.ConnectionFailed, "bad request")
|
||||
continue
|
||||
}
|
||||
go sshForward(nc, "unix", p.Path)
|
||||
default:
|
||||
nc.Reject(ssh.UnknownChannelType, "not supported by wsbx")
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func sshForward(nc ssh.NewChannel, network, addr string) {
|
||||
c, err := net.Dial(network, addr)
|
||||
if err != nil {
|
||||
nc.Reject(ssh.ConnectionFailed, err.Error())
|
||||
return
|
||||
}
|
||||
defer c.Close()
|
||||
ch, reqs, err := nc.Accept()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
defer ch.Close()
|
||||
go ssh.DiscardRequests(reqs)
|
||||
done := make(chan struct{})
|
||||
go func() {
|
||||
io.Copy(ch, c)
|
||||
ch.CloseWrite()
|
||||
close(done)
|
||||
}()
|
||||
io.Copy(c, ch)
|
||||
if cw, ok := c.(interface{ CloseWrite() error }); ok {
|
||||
cw.CloseWrite()
|
||||
}
|
||||
<-done
|
||||
}
|
||||
|
||||
func sshSession(nc ssh.NewChannel) {
|
||||
ch, reqs, err := nc.Accept()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
defer ch.Close()
|
||||
var env []string
|
||||
var pty, tty *os.File
|
||||
defer func() {
|
||||
if pty != nil {
|
||||
pty.Close()
|
||||
}
|
||||
}()
|
||||
started, command := false, ""
|
||||
for req := range reqs {
|
||||
ok, start := false, false
|
||||
switch req.Type {
|
||||
case "env":
|
||||
var kv struct{ K, V string }
|
||||
if ssh.Unmarshal(req.Payload, &kv) == nil {
|
||||
env, ok = append(env, kv.K+"="+kv.V), true
|
||||
}
|
||||
case "pty-req":
|
||||
var p struct {
|
||||
Term string
|
||||
Cols, Rows, W, H uint32
|
||||
Modes string
|
||||
}
|
||||
if pty == nil && !started && ssh.Unmarshal(req.Payload, &p) == nil {
|
||||
if m, s, err := openPty(); err == nil {
|
||||
pty, tty, ok = m, s, true
|
||||
setWinsize(m, uint16(p.Rows), uint16(p.Cols))
|
||||
env = append(env, "TERM="+p.Term)
|
||||
}
|
||||
}
|
||||
case "window-change":
|
||||
var p struct{ Cols, Rows, W, H uint32 }
|
||||
if pty != nil && ssh.Unmarshal(req.Payload, &p) == nil {
|
||||
setWinsize(pty, uint16(p.Rows), uint16(p.Cols))
|
||||
ok = true
|
||||
}
|
||||
case "shell", "exec":
|
||||
var p struct{ Cmd string }
|
||||
if !started && (req.Type == "shell" || ssh.Unmarshal(req.Payload, &p) == nil) {
|
||||
started, ok, start, command = true, true, true, p.Cmd
|
||||
}
|
||||
}
|
||||
if req.WantReply {
|
||||
req.Reply(ok, nil)
|
||||
}
|
||||
if start {
|
||||
go func(env []string) {
|
||||
code := sshRun(ch, command, env, pty, tty)
|
||||
ch.SendRequest("exit-status", false, ssh.Marshal(struct{ C uint32 }{code}))
|
||||
ch.Close()
|
||||
}(env)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// sshRun runs command (empty: a login shell) like sshd: `$SHELL -c command`, in run.sh's env and dir.
|
||||
func sshRun(ch ssh.Channel, command string, env []string, pty, tty *os.File) uint32 {
|
||||
shell := "/bin/sh"
|
||||
if _, err := os.Stat("/bin/bash"); err == nil {
|
||||
shell = "/bin/bash"
|
||||
}
|
||||
cmd := exec.Command(shell, "-c", command)
|
||||
if command == "" {
|
||||
cmd = exec.Command(shell, "-l")
|
||||
}
|
||||
cmd.Env = append(os.Environ(), env...)
|
||||
if pty != nil {
|
||||
cmd.Stdin, cmd.Stdout, cmd.Stderr = tty, tty, tty
|
||||
cmd.SysProcAttr = &syscall.SysProcAttr{Setsid: true, Setctty: true}
|
||||
} else {
|
||||
cmd.Stdin, cmd.Stdout, cmd.Stderr = ch, ch, ch.Stderr()
|
||||
cmd.SysProcAttr = &syscall.SysProcAttr{Setsid: true}
|
||||
cmd.WaitDelay = time.Second // don't hang on daemons (the VS Code server) that keep stdout open
|
||||
}
|
||||
if err := cmd.Start(); err != nil {
|
||||
fmt.Fprintln(ch.Stderr(), "wsbx:", err)
|
||||
return 127
|
||||
}
|
||||
if pty == nil {
|
||||
cmd.Wait()
|
||||
return exitCode(cmd.ProcessState)
|
||||
}
|
||||
tty.Close() // our copy: the master reads EIO once the session's are gone
|
||||
go io.Copy(pty, ch)
|
||||
done := make(chan struct{})
|
||||
go func() {
|
||||
io.Copy(ch, pty)
|
||||
close(done)
|
||||
}()
|
||||
cmd.Wait()
|
||||
select {
|
||||
case <-done:
|
||||
case <-time.After(500 * time.Millisecond): // a background job still holds the pty
|
||||
}
|
||||
return exitCode(cmd.ProcessState)
|
||||
}
|
||||
|
||||
// stdio is our stdin/stdout as the net.Conn the SSH server runs on.
|
||||
type stdio struct{}
|
||||
|
||||
func (stdio) Read(b []byte) (int, error) { return os.Stdin.Read(b) }
|
||||
func (stdio) Write(b []byte) (int, error) { return os.Stdout.Write(b) }
|
||||
func (stdio) Close() error { os.Stdin.Close(); return os.Stdout.Close() }
|
||||
func (stdio) LocalAddr() net.Addr { return &net.UnixAddr{Name: "stdio", Net: "unix"} }
|
||||
func (stdio) RemoteAddr() net.Addr { return &net.UnixAddr{Name: "wsbx", Net: "unix"} }
|
||||
func (stdio) SetDeadline(time.Time) error { return nil }
|
||||
func (stdio) SetReadDeadline(time.Time) error { return nil }
|
||||
func (stdio) SetWriteDeadline(time.Time) error { return nil }
|
||||
Executable
+29
@@ -0,0 +1,29 @@
|
||||
#!/bin/sh
|
||||
# Install wsbx from a release: curl -fsSL https://git.nhaiden.io/niklas/woiken-sandboxes/raw/branch/main/install.sh | sh
|
||||
# Env: WSBX_VERSION (tag, default: latest release), WSBX_INSTALL_DIR (default: ~/.local/bin)
|
||||
set -eu
|
||||
|
||||
REPO=https://git.nhaiden.io/niklas/woiken-sandboxes
|
||||
DIR=${WSBX_INSTALL_DIR:-$HOME/.local/bin}
|
||||
|
||||
[ "$(uname -s)-$(uname -m)" = Darwin-arm64 ] || { echo "wsbx needs macOS on Apple Silicon" >&2; exit 1; }
|
||||
|
||||
TAG=${WSBX_VERSION:-$(curl -fsSL https://git.nhaiden.io/api/v1/repos/niklas/woiken-sandboxes/releases/latest | sed -n 's/.*"tag_name":"\([^"]*\)".*/\1/p')}
|
||||
[ -n "$TAG" ] || { echo "could not determine the latest release" >&2; exit 1; }
|
||||
F="wsbx-$TAG-darwin-arm64.tar.gz"
|
||||
|
||||
TMP=$(mktemp -d)
|
||||
trap 'rm -rf "$TMP"' EXIT
|
||||
cd "$TMP"
|
||||
echo "downloading $F"
|
||||
curl -fsSLO "$REPO/releases/download/$TAG/$F"
|
||||
curl -fsSLO "$REPO/releases/download/$TAG/$F.sha256"
|
||||
shasum -a 256 -c "$F.sha256" >/dev/null || { echo "checksum mismatch for $F" >&2; exit 1; }
|
||||
tar -xzf "$F" wsbx
|
||||
|
||||
mkdir -p "$DIR"
|
||||
install -m 755 wsbx "$DIR/wsbx"
|
||||
echo "installed $("$DIR/wsbx" --version) to $DIR/wsbx"
|
||||
|
||||
case ":$PATH:" in *":$DIR:"*) ;; *) echo "note: $DIR is not on your PATH" ;; esac
|
||||
command -v vfkit >/dev/null || echo "note: wsbx needs vfkit and e2fsprogs: brew install vfkit e2fsprogs"
|
||||
+121
@@ -0,0 +1,121 @@
|
||||
//! `wsbx code NAME`: VS Code for a running sandbox.
|
||||
//! Browser (default): `code serve-web` runs in the VM on its localhost, forwarded to the host's localhost
|
||||
//! (like `wsbx forward`) behind a random connection token, and opened in the browser.
|
||||
//! --desktop: desktop VS Code via Remote-SSH. ssh reaches the SSH server in the guest helper (guest/ssh.go)
|
||||
//! through `wsbx exec` as ProxyCommand: no network port, no keys.
|
||||
use crate::exec::{self, sock};
|
||||
use crate::forward;
|
||||
use crate::util::sq;
|
||||
use anyhow::{Context, Result, bail};
|
||||
use serde_json::Value;
|
||||
use std::fs;
|
||||
use std::io::Read;
|
||||
use std::net::TcpListener;
|
||||
use std::path::Path;
|
||||
use std::process::Command;
|
||||
use std::time::{Duration, Instant};
|
||||
|
||||
/// Guest side of the browser mode: fetch the VS Code CLI once (static musl binary, onto the sandbox disk),
|
||||
/// then serve. The CLI downloads the matching server on first use. $1 port, $2 token.
|
||||
const WEB_SH: &str = r#"set -e
|
||||
B=/.wsbx/busybox D="$HOME/.wsbx-vscode"
|
||||
U=https://update.code.visualstudio.com/latest/cli-alpine-arm64/stable
|
||||
if [ ! -x "$D/code" ]; then
|
||||
echo "wsbx: downloading the VS Code CLI..."
|
||||
$B rm -rf "$D/tmp" && $B mkdir -p "$D/tmp"
|
||||
if command -v curl >/dev/null; then curl -fsSL "$U"; else wget -qO- "$U"; fi | $B tar -xzf - -C "$D/tmp"
|
||||
$B sync && $B mv "$D/tmp/code" "$D/code" && $B rmdir "$D/tmp" # never a half-written code, even if the VM is killed
|
||||
fi
|
||||
exec "$D/code" serve-web --host 127.0.0.1 --port "$1" --connection-token "$2" --accept-server-license-terms
|
||||
"#;
|
||||
|
||||
pub fn code(h: &Path, name: &str, desktop: bool) -> Result<()> {
|
||||
let sock = sock(h, name)?; // also checks the name and that it's running
|
||||
let meta: Value = serde_json::from_slice(&fs::read(h.join("sandboxes").join(name).join("meta.json"))?)?;
|
||||
let folder = enc(meta["workspace"].as_str().unwrap_or("/"));
|
||||
if desktop {
|
||||
return self::desktop(h, name, &folder);
|
||||
}
|
||||
|
||||
let l = TcpListener::bind(("127.0.0.1", 0))?;
|
||||
let port = l.local_addr()?.port(); // the same port in the guest: random and high, so most likely free there too
|
||||
let mut t = [0u8; 16];
|
||||
fs::File::open("/dev/urandom")?.read_exact(&mut t)?;
|
||||
let token = hex::encode(t);
|
||||
eprintln!("wsbx: starting VS Code in {name} (the first start downloads it)");
|
||||
eprintln!("wsbx: by using it you accept the VS Code Server license: https://aka.ms/vscode-server-license");
|
||||
let (s, tk) = (sock.clone(), token.clone());
|
||||
let server = std::thread::spawn(move || exec::stream(&s, &["/.wsbx/busybox", "sh", "-c", WEB_SH, "sh", &port.to_string(), &tk]));
|
||||
let t0 = Instant::now();
|
||||
while !forward::listening(&sock, port) {
|
||||
if server.is_finished() {
|
||||
let r = server.join().unwrap();
|
||||
bail!("VS Code server in {name} stopped ({:?})", r.map_err(|e| e.to_string()));
|
||||
}
|
||||
if t0.elapsed() > Duration::from_secs(300) {
|
||||
bail!("VS Code server in {name} didn't start within 5 minutes");
|
||||
}
|
||||
std::thread::sleep(Duration::from_millis(500));
|
||||
}
|
||||
let (s, n) = (sock.clone(), name.to_string());
|
||||
std::thread::spawn(move || forward::serve(&s, &n, vec![(l, port)]));
|
||||
let url = format!("http://127.0.0.1:{port}/?tkn={token}&folder={folder}");
|
||||
eprintln!("wsbx: VS Code for {name}: {url}\nwsbx: Ctrl-C stops it");
|
||||
let _ = Command::new("open").arg(&url).status();
|
||||
match server.join().unwrap()? {
|
||||
Some(c) => bail!("VS Code server in {name} exited with {c}"),
|
||||
None => bail!("lost connection to {name} (VM stopped?)"),
|
||||
}
|
||||
}
|
||||
|
||||
/// Write ssh config for every sandbox, include it from ~/.ssh/config once, open VS Code on NAME.wsbx.
|
||||
fn desktop(h: &Path, name: &str, folder: &str) -> Result<()> {
|
||||
let exe = std::env::current_exe()?;
|
||||
let mut cfg = String::from("# Written by `wsbx code --desktop`, regenerated each time: don't edit.\n");
|
||||
for e in fs::read_dir(h.join("sandboxes"))?.flatten().filter(|e| e.path().join("meta.json").exists()) {
|
||||
let n = e.file_name().to_string_lossy().into_owned(); // sandbox names are [a-z0-9-]
|
||||
cfg += &format!(
|
||||
"\nHost {n}.wsbx\n ProxyCommand {} exec {n} -- /.wsbx/host/guest -ssh-stdio\n \
|
||||
StrictHostKeyChecking no\n UserKnownHostsFile /dev/null\n LogLevel ERROR\n ForwardAgent no\n ForwardX11 no\n",
|
||||
sq(&exe.to_string_lossy())
|
||||
);
|
||||
}
|
||||
let ours = h.join("ssh_config");
|
||||
fs::write(&ours, cfg)?;
|
||||
|
||||
let home = std::path::PathBuf::from(std::env::var_os("HOME").context("HOME")?);
|
||||
let user_cfg = home.join(".ssh/config");
|
||||
let include = format!("Include \"{}\"", ours.display());
|
||||
let cur = match fs::read_to_string(&user_cfg) {
|
||||
Ok(s) => s,
|
||||
Err(e) if e.kind() == std::io::ErrorKind::NotFound => String::new(),
|
||||
Err(e) => return Err(e).context("~/.ssh/config"),
|
||||
};
|
||||
if !cur.lines().any(|l| l.trim() == include) {
|
||||
fs::create_dir_all(home.join(".ssh"))?;
|
||||
// At the top: an Include after a `Host` line would only apply to that host.
|
||||
fs::write(&user_cfg, format!("{include}\n\n{cur}"))?;
|
||||
eprintln!("wsbx: added `{include}` to the top of ~/.ssh/config");
|
||||
}
|
||||
let url = format!("vscode://vscode-remote/ssh-remote+{name}.wsbx{folder}");
|
||||
eprintln!("wsbx: opening {url} (needs the Remote - SSH extension); plain ssh works too: ssh {name}.wsbx");
|
||||
if !Command::new("open").arg(&url).status()?.success() {
|
||||
bail!("couldn't open {url} (is VS Code installed?)");
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Percent-encode a path for a URL, keeping '/'.
|
||||
fn enc(p: &str) -> String {
|
||||
p.bytes()
|
||||
.map(|b| if b.is_ascii_alphanumeric() || b"/-._~".contains(&b) { (b as char).to_string() } else { format!("%{b:02X}") })
|
||||
.collect()
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
#[test]
|
||||
fn enc() {
|
||||
assert_eq!(super::enc("/Users/me/my repo/ä&x"), "/Users/me/my%20repo/%C3%A4%26x");
|
||||
}
|
||||
}
|
||||
+5
-1
@@ -13,13 +13,17 @@ const STUB_INIT: &str = "#!/.wsbx/busybox sh
|
||||
echo 'wsbx: cannot mount host share'; exec /.wsbx/busybox sh
|
||||
";
|
||||
|
||||
/// busybox:musl pinned by digest: this binary is PID 1 in every VM, so a moved tag must not change it.
|
||||
/// Bump deliberately (index digest of `docker.io/library/busybox:musl`).
|
||||
const BUSYBOX: &str = "busybox@sha256:ea2b9914a16a4ac1981994af97b318f7c7d4db76b580c56177f08bf76f4a0be8";
|
||||
|
||||
/// Static busybox from the official busybox image; runs PID 1 + helpers in the guest.
|
||||
fn busybox(h: &Path) -> Result<PathBuf> {
|
||||
let p = h.join("busybox");
|
||||
if p.exists() {
|
||||
return Ok(p);
|
||||
}
|
||||
let img = oci::pull(h, "busybox:musl", false)?;
|
||||
let img = oci::pull(h, BUSYBOX, false)?;
|
||||
let tmp = h.join("busybox.tmp");
|
||||
fs::create_dir_all(&tmp)?;
|
||||
let ok = Command::new("tar").arg("-xf").arg(&img.rootfs).arg("-C").arg(&tmp).arg("bin").status()?.success();
|
||||
|
||||
+35
-6
@@ -76,7 +76,7 @@ pub fn exec(h: &Path, name: &str, user: Option<String>, argv: Vec<String>) -> Re
|
||||
}
|
||||
});
|
||||
}
|
||||
let code = output(s);
|
||||
let code = output(s, &mut io::stdout().lock(), &mut io::stderr().lock());
|
||||
if let Some(s) = saved {
|
||||
stty(&[s.trim()]);
|
||||
}
|
||||
@@ -90,10 +90,39 @@ fn send(w: &Mutex<UnixStream>, kind: u8, p: &[u8]) -> io::Result<()> {
|
||||
w.lock().unwrap().write_all(&frame(kind, p))
|
||||
}
|
||||
|
||||
/// Copy guest output frames to stdout/stderr until the exit status arrives (None: connection closed first).
|
||||
fn output(s: UnixStream) -> io::Result<Option<i32>> {
|
||||
/// Run a command as root in a running sandbox (no tty, empty stdin) and return its stdout, at most 64 KiB.
|
||||
pub fn capture(sock: &Path, argv: &[&str]) -> Result<String> {
|
||||
// uid 0, not "root": works even if the image has no /etc/passwd
|
||||
let s = start(sock, argv, Some("0"))?;
|
||||
s.set_read_timeout(Some(Duration::from_secs(2)))?;
|
||||
const CAP: usize = 64 << 10;
|
||||
let mut buf = vec![0u8; CAP];
|
||||
let mut w = &mut buf[..]; // a slice writer errors once full: the guest can't make us buffer more
|
||||
match output(s, &mut w, &mut io::sink())? {
|
||||
Some(0) => {
|
||||
let n = CAP - w.len();
|
||||
Ok(String::from_utf8_lossy(&buf[..n]).into_owned())
|
||||
}
|
||||
c => bail!("guest command failed ({c:?})"),
|
||||
}
|
||||
}
|
||||
|
||||
/// Start a command without tty, with empty stdin; user None: the image user.
|
||||
fn start(sock: &Path, argv: &[&str], user: Option<&str>) -> Result<UnixStream> {
|
||||
let mut s = UnixStream::connect(sock)?;
|
||||
s.write_all(format!("{}\n", json!({"argv": argv, "user": user, "tty": false})).as_bytes())?;
|
||||
s.write_all(&frame(b'e', &[]))?;
|
||||
Ok(s)
|
||||
}
|
||||
|
||||
/// Run a command as the image user, all its output to our stderr. None: the connection ended first.
|
||||
pub fn stream(sock: &Path, argv: &[&str]) -> Result<Option<i32>> {
|
||||
Ok(output(start(sock, argv, None)?, &mut io::stderr(), &mut io::stderr())?)
|
||||
}
|
||||
|
||||
/// Copy guest output frames to out/err until the exit status arrives (None: connection closed first).
|
||||
fn output(s: UnixStream, out: &mut impl Write, err: &mut impl Write) -> io::Result<Option<i32>> {
|
||||
let mut r = io::BufReader::new(s);
|
||||
let (mut out, mut err) = (io::stdout().lock(), io::stderr().lock());
|
||||
loop {
|
||||
let mut h = [0u8; 5];
|
||||
if r.read_exact(&mut h).is_err() {
|
||||
@@ -102,11 +131,11 @@ fn output(s: UnixStream) -> io::Result<Option<i32>> {
|
||||
let mut p = (&mut r).take(u32::from_be_bytes([h[1], h[2], h[3], h[4]]).into());
|
||||
match h[0] {
|
||||
b'o' => {
|
||||
io::copy(&mut p, &mut out)?;
|
||||
io::copy(&mut p, out)?;
|
||||
out.flush()?;
|
||||
}
|
||||
b'r' => {
|
||||
io::copy(&mut p, &mut err)?;
|
||||
io::copy(&mut p, err)?;
|
||||
}
|
||||
b'x' => {
|
||||
let mut c = [0u8; 4];
|
||||
|
||||
+16
-2
@@ -28,11 +28,17 @@ pub fn forward(h: &Path, name: &str, specs: Vec<String>) -> Result<()> {
|
||||
ls.push((l, guest));
|
||||
eprintln!("wsbx: localhost:{host} -> {name}:{guest}");
|
||||
}
|
||||
serve(&sock, name, ls);
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Forward connections on each listener to its guest port, forever.
|
||||
pub fn serve(sock: &Path, name: &str, ls: Vec<(TcpListener, u16)>) {
|
||||
// ponytail: thread per connection, fine for dev servers; async if someone forwards thousands of sockets.
|
||||
let threads: Vec<_> = ls
|
||||
.into_iter()
|
||||
.map(|(l, port)| {
|
||||
let (sock, name) = (sock.clone(), name.to_string());
|
||||
let (sock, name) = (sock.to_path_buf(), name.to_string());
|
||||
thread::spawn(move || {
|
||||
for c in l.incoming().flatten() {
|
||||
let (sock, name) = (sock.clone(), name.clone());
|
||||
@@ -48,7 +54,15 @@ pub fn forward(h: &Path, name: &str, specs: Vec<String>) -> Result<()> {
|
||||
for t in threads {
|
||||
let _ = t.join();
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Whether something accepts connections on the guest's localhost:port.
|
||||
pub fn listening(sock: &Path, port: u16) -> bool {
|
||||
let Ok(mut s) = std::os::unix::net::UnixStream::connect(sock) else { return false };
|
||||
let req = format!("{}\n", json!({"connect": port}));
|
||||
let mut h = [0u8; 1];
|
||||
// A failed dial answers with an 'r' (error) frame; a connected one with output, keepalive or EOF ('x').
|
||||
s.write_all(req.as_bytes()).is_ok() && s.write_all(&frame(b'e', &[])).is_ok() && s.read_exact(&mut h).is_ok() && h[0] != b'r'
|
||||
}
|
||||
|
||||
fn conn(sock: &Path, name: &str, c: TcpStream, port: u16) -> Result<()> {
|
||||
|
||||
+3
-2
@@ -34,7 +34,8 @@ pub fn kernel(h: &Path, update: bool, version: Option<String>) -> Result<PathBuf
|
||||
Some(v) => format!("https://api.github.com/repos/{KATA_REPO}/releases/tags/{v}"),
|
||||
None => format!("https://api.github.com/repos/{KATA_REPO}/releases/latest"),
|
||||
};
|
||||
let rel: Value = serde_json::from_reader(ureq::get(&api).call().with_context(|| format!("GET {api}"))?.into_reader())?;
|
||||
let agent = oci::agent_for("api.github.com"); // public-only resolver, like registries (redirects to the CDN included)
|
||||
let rel: Value = serde_json::from_reader(agent.get(&api).call().with_context(|| format!("GET {api}"))?.into_reader())?;
|
||||
let tag = rel["tag_name"].as_str().ok_or_else(|| anyhow!("no tag in {api}"))?;
|
||||
if k.exists() && installed.as_deref() == Some(tag) {
|
||||
eprintln!("wsbx: kernel already at Kata {tag}");
|
||||
@@ -62,7 +63,7 @@ pub fn kernel(h: &Path, update: bool, version: Option<String>) -> Result<PathBuf
|
||||
.stdin(Stdio::piped())
|
||||
.spawn()?;
|
||||
let mut w = oci::HashWriter(tar.stdin.take().unwrap(), Sha256::new());
|
||||
std::io::copy(&mut ureq::get(url).call()?.into_reader(), &mut w)?;
|
||||
std::io::copy(&mut agent.get(url).call()?.into_reader(), &mut w)?;
|
||||
let oci::HashWriter(stdin, hasher) = w;
|
||||
drop(stdin);
|
||||
if !tar.wait()?.success() {
|
||||
|
||||
+17
-4
@@ -1,5 +1,6 @@
|
||||
//! wsbx — Docker-Sandboxes-style microVMs on macOS (Virtualization.framework via vfkit).
|
||||
mod agents;
|
||||
mod code;
|
||||
mod disk;
|
||||
mod exec;
|
||||
mod forward;
|
||||
@@ -81,9 +82,20 @@ enum Cmd {
|
||||
#[arg(required = true)]
|
||||
ports: Vec<String>,
|
||||
},
|
||||
/// List sandboxes and whether they're running
|
||||
/// Open VS Code in a running sandbox: in the browser (default), or desktop VS Code via Remote-SSH
|
||||
Code {
|
||||
name: String,
|
||||
/// Desktop VS Code via Remote-SSH (adds an Include line to ~/.ssh/config once)
|
||||
#[arg(long)]
|
||||
desktop: bool,
|
||||
},
|
||||
/// List sandboxes with live stats (CPU, memory, network, block I/O, processes)
|
||||
#[command(visible_alias = "ps")]
|
||||
Ls,
|
||||
Ls {
|
||||
/// Keep refreshing every second, like `docker stats` (Ctrl-C to stop)
|
||||
#[arg(short, long)]
|
||||
follow: bool,
|
||||
},
|
||||
/// Remove stopped sandboxes
|
||||
Rm {
|
||||
#[arg(required = true)]
|
||||
@@ -140,7 +152,7 @@ struct Opts {
|
||||
#[arg(long)]
|
||||
kernel: Option<PathBuf>,
|
||||
/// Tunnel the host's localhost:PORT to localhost:PORT in the VM (vsock, no network exposure)
|
||||
#[arg(short = 'p', long = "host-port")]
|
||||
#[arg(short = 'p', long = "host-port", value_parser = clap::value_parser!(u16).range(1..))]
|
||||
host_ports: Vec<u16>,
|
||||
}
|
||||
|
||||
@@ -168,7 +180,8 @@ fn main() -> Result<()> {
|
||||
Cmd::Pi { a, pi_auth } => agents::pi(&h, a, pi_auth),
|
||||
Cmd::Exec { name, user, cmd } => exec::exec(&h, &name, user, cmd),
|
||||
Cmd::Forward { name, ports } => forward::forward(&h, &name, ports),
|
||||
Cmd::Ls => sandbox::ls(&h),
|
||||
Cmd::Code { name, desktop } => code::code(&h, &name, desktop),
|
||||
Cmd::Ls { follow } => sandbox::ls(&h, follow),
|
||||
Cmd::Gc => sandbox::gc(&h),
|
||||
Cmd::Rm { names, disk } => sandbox::rm(&h, names, disk),
|
||||
Cmd::Version => Ok(println!("wsbx {}", env!("CARGO_PKG_VERSION"))),
|
||||
|
||||
+61
-18
@@ -6,7 +6,7 @@ use sha2::{Digest, Sha256};
|
||||
use std::collections::HashSet;
|
||||
use std::fs::{self, File};
|
||||
use std::io::{BufReader, Read, Write};
|
||||
use std::net::{IpAddr, SocketAddr, ToSocketAddrs};
|
||||
use std::net::{IpAddr, Ipv4Addr, SocketAddr, ToSocketAddrs};
|
||||
use std::os::unix::fs::MetadataExt;
|
||||
use std::path::{Path, PathBuf};
|
||||
|
||||
@@ -60,23 +60,40 @@ pub fn is_public(ip: IpAddr) -> bool {
|
||||
|| o[0] == 0
|
||||
|| (o[0] == 100 && o[1] & 0xc0 == 64)) // CGNAT 100.64/10
|
||||
}
|
||||
IpAddr::V6(v) => match v.to_ipv4_mapped() {
|
||||
Some(v4) => is_public(v4.into()),
|
||||
None => !(v.is_loopback() || v.is_unspecified() || v.is_multicast() || v.is_unique_local() || v.is_unicast_link_local()),
|
||||
},
|
||||
IpAddr::V6(v) => {
|
||||
let v4 = |hi: u16, lo: u16| is_public(Ipv4Addr::from((hi as u32) << 16 | lo as u32).into());
|
||||
match v.segments() {
|
||||
[0, 0, 0, 0, 0, 0xffff, hi, lo] => v4(hi, lo), // IPv4-mapped
|
||||
[0x64, 0xff9b, 0, 0, 0, 0, hi, lo] => v4(hi, lo), // NAT64 well-known prefix
|
||||
[0x2002, hi, lo, ..] => v4(hi, lo), // 6to4
|
||||
[0x2001, 0xdb8, ..] | [0x2001, 0, ..] => false, // documentation, Teredo
|
||||
s => s[0] & 0xe000 == 0x2000, // global unicast 2000::/3 only
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// HTTP agent for a registry. Public registries get an agent that refuses to connect to non-public
|
||||
/// addresses (covers token realms and blob redirects too); a registry that is itself local
|
||||
/// (e.g. localhost:5000) was chosen explicitly by the user and keeps the default agent.
|
||||
fn agent_for(registry: &str) -> ureq::Agent {
|
||||
let addr = if registry.contains(':') { registry.to_string() } else { format!("{registry}:443") };
|
||||
let local = addr.to_socket_addrs().map(|mut a| a.any(|a| !is_public(a.ip()))).unwrap_or(false);
|
||||
if local {
|
||||
return ureq::agent();
|
||||
/// Every HTTP agent: a silent server (connect or any single read, TLS handshake included) fails after 30 s instead of hanging.
|
||||
pub fn agent() -> ureq::AgentBuilder {
|
||||
let t = std::time::Duration::from_secs(30);
|
||||
ureq::AgentBuilder::new().timeout_connect(t).timeout_read(t)
|
||||
}
|
||||
ureq::AgentBuilder::new()
|
||||
|
||||
/// Registry the user named as local: `localhost` or a non-public IP literal. Decided by name only --
|
||||
/// a DNS name pointing at loopback (e.g. *.127.0.0.1.nip.io) is controlled by whoever owns the zone.
|
||||
fn explicit_local(registry: &str) -> bool {
|
||||
let host = registry.split_once(':').map_or(registry, |(h, _)| h);
|
||||
host == "localhost" || host.parse().is_ok_and(|ip| !is_public(ip))
|
||||
}
|
||||
|
||||
/// HTTP agent for a registry. Public registries get an agent that refuses to connect to non-public
|
||||
/// addresses (covers token realms and blob redirects too); an explicitly local registry
|
||||
/// (e.g. localhost:5000, 192.168.1.5:5000) was chosen by the user and keeps the default agent.
|
||||
pub fn agent_for(registry: &str) -> ureq::Agent {
|
||||
if explicit_local(registry) {
|
||||
return agent().build();
|
||||
}
|
||||
agent()
|
||||
.resolver(|addr: &str| -> std::io::Result<Vec<SocketAddr>> {
|
||||
let ok: Vec<SocketAddr> = addr.to_socket_addrs()?.filter(|a| is_public(a.ip())).collect();
|
||||
if ok.is_empty() {
|
||||
@@ -199,8 +216,11 @@ pub fn pull(home: &Path, image: &str, refresh: bool) -> Result<Image> {
|
||||
}
|
||||
}
|
||||
|
||||
/// Flattened name for humans plus a hash of the exact reference, so `a_b:t` and `a/b:t` never share a ref file.
|
||||
/// (Pre-hash ref files are simply ignored: the image is re-resolved and gc drops them.)
|
||||
fn ref_path(home: &Path, image: &str) -> PathBuf {
|
||||
home.join("images/refs").join(image.replace(['/', ':', '@'], "_"))
|
||||
let h = hex::encode(Sha256::digest(image));
|
||||
home.join("images/refs").join(format!("{}-{}", image.replace(['/', ':', '@'], "_"), &h[..16]))
|
||||
}
|
||||
|
||||
fn image_dir(home: &Path, digest: &str) -> PathBuf {
|
||||
@@ -224,7 +244,10 @@ pub fn gc(home: &Path, keep: &[String]) -> Result<u64> {
|
||||
for e in fs::read_dir(home.join("images/refs"))?.flatten() {
|
||||
match fs::read_to_string(e.path()) {
|
||||
Ok(d) if keep.contains(&e.path()) => drop(live.insert(image_dir(home, d.trim()))),
|
||||
_ => fs::remove_file(e.path())?,
|
||||
_ => match fs::remove_file(e.path()) {
|
||||
Err(e) if e.kind() != std::io::ErrorKind::NotFound => return Err(e.into()), // gone: a concurrent pull renamed it
|
||||
_ => {}
|
||||
},
|
||||
}
|
||||
}
|
||||
let mut freed = 0;
|
||||
@@ -467,14 +490,26 @@ mod tests {
|
||||
|
||||
#[test]
|
||||
fn public_addresses() {
|
||||
for ip in ["127.0.0.1", "10.1.2.3", "172.16.0.1", "192.168.64.1", "169.254.169.254", "100.64.0.1", "0.0.0.0", "::1", "fe80::1", "fd00::1", "::ffff:127.0.0.1"] {
|
||||
for ip in ["127.0.0.1", "10.1.2.3", "172.16.0.1", "192.168.64.1", "169.254.169.254", "100.64.0.1", "0.0.0.0", "::1", "fe80::1", "fd00::1", "::ffff:127.0.0.1",
|
||||
"64:ff9b::7f00:1", "64:ff9b::a00:1", "64:ff9b:1::1", "2002:7f00:1::1", "2002:c0a8:101::", "::7f00:1", "::a00:1",
|
||||
"2001:db8::1", "2001::1", "ff02::1"] {
|
||||
assert!(!is_public(ip.parse().unwrap()), "{ip} must be rejected");
|
||||
}
|
||||
for ip in ["8.8.8.8", "140.82.121.4", "2606:4700::6810:84e5"] {
|
||||
for ip in ["8.8.8.8", "140.82.121.4", "2606:4700::6810:84e5", "64:ff9b::808:808", "2002:808:808::1", "::ffff:8.8.8.8"] {
|
||||
assert!(is_public(ip.parse().unwrap()), "{ip} must be allowed");
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn local_registries() {
|
||||
for l in ["localhost:5000", "localhost", "127.0.0.1:5000", "192.168.1.5:5000"] {
|
||||
assert!(explicit_local(l), "{l}");
|
||||
}
|
||||
for r in ["evil.127.0.0.1.nip.io:8443", "localhost.evil.com", "ghcr.io", "8.8.8.8:443", "registry-1.docker.io"] {
|
||||
assert!(!explicit_local(r), "{r}");
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn bad_refs() {
|
||||
for bad in ["alpine@sha256:../../x", "../x", "a/../b", "alpine:../x", "Alpine", "a//b"] {
|
||||
@@ -485,6 +520,14 @@ mod tests {
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn ref_paths_distinct() {
|
||||
let h = Path::new("/h");
|
||||
assert_ne!(ref_path(h, "evil_bar:v1"), ref_path(h, "evil/bar:v1"));
|
||||
assert_ne!(ref_path(h, "docker_sandbox-templates_claude-code"), ref_path(h, "docker/sandbox-templates:claude-code"));
|
||||
assert_eq!(ref_path(h, "alpine"), ref_path(h, "alpine"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn digests() {
|
||||
assert!(check_digest(&format!("sha256:{}", "a".repeat(64))).is_ok());
|
||||
|
||||
+169
-20
@@ -1,11 +1,15 @@
|
||||
//! Sandbox bookkeeping: listing, removal, image gc.
|
||||
use crate::exec;
|
||||
use crate::oci;
|
||||
use crate::util::sanitize;
|
||||
use anyhow::{Context, Result, anyhow, bail};
|
||||
use serde_json::Value;
|
||||
use std::collections::HashMap;
|
||||
use std::fs;
|
||||
use std::io::Write;
|
||||
use std::os::unix::fs::MetadataExt;
|
||||
use std::path::Path;
|
||||
use std::path::{Path, PathBuf};
|
||||
use std::time::Duration;
|
||||
|
||||
/// The lock `run` holds for the VM's lifetime; Err if the sandbox is running.
|
||||
pub fn lock_stopped(dir: &Path) -> Result<fs::File> {
|
||||
@@ -14,26 +18,156 @@ pub fn lock_stopped(dir: &Path) -> Result<fs::File> {
|
||||
Ok(f)
|
||||
}
|
||||
|
||||
pub fn ls(h: &Path) -> Result<()> {
|
||||
println!("{:<28} {:<8} {:<40} {:>8} WORKSPACE", "NAME", "STATUS", "IMAGE", "DISK");
|
||||
let Ok(rd) = fs::read_dir(h.join("sandboxes")) else { return Ok(()) };
|
||||
let mut rows: Vec<_> = rd.flatten().collect();
|
||||
rows.sort_by_key(|e| e.file_name());
|
||||
for e in rows {
|
||||
let Ok(m) = fs::read(e.path().join("meta.json")) else { continue };
|
||||
let m: Value = serde_json::from_slice(&m)?;
|
||||
let used = fs::metadata(e.path().join("disk.img")).map(|m| m.blocks() * 512).unwrap_or(0);
|
||||
let status = if lock_stopped(&e.path()).is_err() { "running" } else { "stopped" };
|
||||
println!(
|
||||
"{:<28} {:<8} {:<40} {:>6}MB {}",
|
||||
e.file_name().to_string_lossy(),
|
||||
status,
|
||||
m["image"].as_str().unwrap_or("?"),
|
||||
used / 1_000_000,
|
||||
m["workspace"].as_str().unwrap_or("-")
|
||||
);
|
||||
/// Guest counters, read from /proc through the exec channel.
|
||||
#[derive(Default, Debug, PartialEq)]
|
||||
struct Stats {
|
||||
busy: u64,
|
||||
total: u64,
|
||||
ncpu: u64,
|
||||
mem_used: u64,
|
||||
mem_total: u64,
|
||||
rx: u64,
|
||||
tx: u64,
|
||||
rd: u64,
|
||||
wr: u64,
|
||||
pids: u64,
|
||||
}
|
||||
|
||||
const STATS_SH: &str = "cd /proc; B=/.wsbx/busybox; $B grep ^cpu stat; $B grep -E '^Mem(Total|Available):' meminfo; \
|
||||
$B tail -n +3 net/dev; $B grep ' vda ' diskstats; set -- [0-9]*; echo pids $#";
|
||||
|
||||
fn parse(out: &str) -> Stats {
|
||||
let (mut s, mut avail) = (Stats::default(), 0);
|
||||
for l in out.lines() {
|
||||
let f: Vec<&str> = l.split_whitespace().collect();
|
||||
let num = |i: usize| f.get(i).and_then(|v| v.parse::<u64>().ok()).unwrap_or(0);
|
||||
match f.first().copied() {
|
||||
Some("cpu") => {
|
||||
let v: Vec<u64> = (1..=8).map(num).collect(); // user nice system idle iowait irq softirq steal
|
||||
s.total = v.iter().sum();
|
||||
s.busy = s.total.saturating_sub(v[3] + v[4]);
|
||||
}
|
||||
Some(c) if c.starts_with("cpu") => s.ncpu += 1,
|
||||
Some("MemTotal:") => s.mem_total = num(1) * 1024,
|
||||
Some("MemAvailable:") => avail = num(1) * 1024,
|
||||
Some("pids") => s.pids = num(1),
|
||||
_ if f.get(2) == Some(&"vda") => (s.rd, s.wr) = (num(5) * 512, num(9) * 512),
|
||||
_ => {
|
||||
// net/dev: " eth0:123 ..." (no space once rx bytes outgrow the column)
|
||||
if let Some((ifc, rest)) = l.split_once(':')
|
||||
&& ifc.trim() != "lo"
|
||||
{
|
||||
let n: Vec<u64> = rest.split_whitespace().filter_map(|v| v.parse().ok()).collect();
|
||||
s.rx += n.first().copied().unwrap_or(0);
|
||||
s.tx += n.get(8).copied().unwrap_or(0);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
s.mem_used = s.mem_total.saturating_sub(avail);
|
||||
s
|
||||
}
|
||||
|
||||
fn human(b: u64) -> String {
|
||||
let (mut v, mut u) = (b as f64, 0);
|
||||
while v >= 1024.0 && u < 4 {
|
||||
v /= 1024.0;
|
||||
u += 1;
|
||||
}
|
||||
if u == 0 { format!("{b}B") } else { format!("{v:.1}{}", ["", "KiB", "MiB", "GiB", "TiB"][u]) }
|
||||
}
|
||||
|
||||
struct Row {
|
||||
name: String,
|
||||
dir: PathBuf,
|
||||
meta: Value,
|
||||
running: bool,
|
||||
}
|
||||
|
||||
fn rows(h: &Path) -> Result<Vec<Row>> {
|
||||
let Ok(rd) = fs::read_dir(h.join("sandboxes")) else { return Ok(vec![]) };
|
||||
let mut rows = vec![];
|
||||
for e in rd.flatten() {
|
||||
let Some(meta) = fs::read(e.path().join("meta.json")).ok().and_then(|m| serde_json::from_slice(&m).ok()) else { continue };
|
||||
let running = lock_stopped(&e.path()).is_err();
|
||||
rows.push(Row { name: e.file_name().to_string_lossy().into(), dir: e.path(), meta, running });
|
||||
}
|
||||
rows.sort_by(|a, b| a.name.cmp(&b.name));
|
||||
Ok(rows)
|
||||
}
|
||||
|
||||
/// Stats of all running sandboxes, sampled in parallel; sandboxes that don't answer are left out.
|
||||
fn sample(rows: &[Row]) -> HashMap<String, Stats> {
|
||||
std::thread::scope(|sc| {
|
||||
let hs: Vec<_> = rows
|
||||
.iter()
|
||||
.filter(|r| r.running)
|
||||
.map(|r| (r.name.clone(), sc.spawn(|| exec::capture(&r.dir.join("exec.sock"), &["/.wsbx/busybox", "sh", "-c", STATS_SH]))))
|
||||
.collect();
|
||||
hs.into_iter().filter_map(|(n, j)| Some((n, parse(&j.join().ok()?.ok()?)))).collect()
|
||||
})
|
||||
}
|
||||
|
||||
fn table(rows: &[Row], prev: &HashMap<String, Stats>, cur: &HashMap<String, Stats>) -> Vec<[String; 11]> {
|
||||
let head = ["NAME", "STATUS", "CPU %", "MEM USAGE / LIMIT", "MEM %", "NET I/O", "BLOCK I/O", "PIDS", "DISK", "IMAGE", "WORKSPACE"];
|
||||
let mut t = vec![head.map(String::from)];
|
||||
for r in rows {
|
||||
let pct = |a: u64, b: u64| format!("{:.1}%", a as f64 * 100.0 / b.max(1) as f64);
|
||||
let st = cur.get(&r.name).map(|c| {
|
||||
// like docker: 100% = one vCPU busy
|
||||
let cpu = prev.get(&r.name).filter(|p| c.total > p.total).map(|p| pct(c.busy.saturating_sub(p.busy) * c.ncpu.max(1), c.total - p.total));
|
||||
[
|
||||
cpu.unwrap_or("-".into()),
|
||||
format!("{} / {}", human(c.mem_used), human(c.mem_total)),
|
||||
pct(c.mem_used, c.mem_total),
|
||||
format!("{} / {}", human(c.rx), human(c.tx)),
|
||||
format!("{} / {}", human(c.rd), human(c.wr)),
|
||||
c.pids.to_string(),
|
||||
]
|
||||
});
|
||||
let [cpu, mem, memp, net, blk, pids] = st.unwrap_or_else(|| std::array::from_fn(|_| "-".into()));
|
||||
let disk = fs::metadata(r.dir.join("disk.img")).map(|m| m.blocks() * 512).unwrap_or(0);
|
||||
let s = |k: &str| r.meta[k].as_str().unwrap_or("-").to_string();
|
||||
let status = if r.running { "running" } else { "stopped" };
|
||||
t.push([r.name.clone(), status.into(), cpu, mem, memp, net, blk, pids, human(disk), s("image"), s("workspace")]);
|
||||
}
|
||||
t
|
||||
}
|
||||
|
||||
/// `wsbx ps`; with `follow`, redraws every second like `docker stats` until Ctrl-C.
|
||||
pub fn ls(h: &Path, follow: bool) -> Result<()> {
|
||||
let mut prev = HashMap::new();
|
||||
let mut first = true;
|
||||
loop {
|
||||
let rows = rows(h)?;
|
||||
let cur = sample(&rows);
|
||||
if first && !cur.is_empty() {
|
||||
// CPU % needs two samples
|
||||
(prev, first) = (cur, false);
|
||||
std::thread::sleep(Duration::from_millis(500));
|
||||
continue;
|
||||
}
|
||||
let t = table(&rows, &prev, &cur);
|
||||
let w: Vec<usize> = (0..11).map(|i| t.iter().map(|r| r[i].chars().count()).max().unwrap_or(0)).collect();
|
||||
let mut out = String::new();
|
||||
for r in &t {
|
||||
let line: String = r
|
||||
.iter()
|
||||
.enumerate()
|
||||
.map(|(i, c)| if (2..9).contains(&i) { format!("{c:>w$} ", w = w[i]) } else { format!("{c:<w$} ", w = w[i]) })
|
||||
.collect();
|
||||
out += line.trim_end();
|
||||
out += if follow { "\x1b[K\n" } else { "\n" };
|
||||
}
|
||||
if !follow {
|
||||
print!("{out}");
|
||||
return Ok(());
|
||||
}
|
||||
print!("\x1b[H{out}\x1b[J"); // home, overwrite, clear the rest: no flicker
|
||||
std::io::stdout().flush()?;
|
||||
(prev, first) = (cur, false);
|
||||
std::thread::sleep(Duration::from_secs(1));
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub fn rm(h: &Path, names: Vec<String>, disk: bool) -> Result<()> {
|
||||
@@ -60,6 +194,21 @@ pub fn rm(h: &Path, names: Vec<String>, disk: bool) -> Result<()> {
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
#[test]
|
||||
fn parse_proc() {
|
||||
let out = "cpu 100 0 50 800 50 0 0 0 0 0\ncpu0 1 2 3\ncpu1 1 2 3\nMemTotal: 2000 kB\nMemAvailable: 500 kB\n\
|
||||
\x20 lo: 999 0 0 0 0 0 0 0 999 0\n eth0:123456789 1 0 0 0 0 0 0 42 1 0 0 0 0 0 0\n\
|
||||
\x20254 0 vda 10 0 4 0 7 0 8 0 0 0 0\npids 17\n";
|
||||
let s = super::parse(out);
|
||||
assert_eq!((s.total, s.busy, s.ncpu), (1000, 150, 2));
|
||||
assert_eq!((s.mem_total, s.mem_used), (2000 * 1024, 1500 * 1024));
|
||||
assert_eq!((s.rx, s.tx, s.rd, s.wr, s.pids), (123456789, 42, 2048, 4096, 17));
|
||||
assert_eq!(super::human(1536), "1.5KiB");
|
||||
}
|
||||
}
|
||||
|
||||
/// Delete cached images no sandbox was created from.
|
||||
pub fn gc(h: &Path) -> Result<()> {
|
||||
let used: Vec<String> = fs::read_dir(h.join("sandboxes"))
|
||||
|
||||
@@ -76,9 +76,10 @@ pub fn run(h: &Path, o: Opts, image: &str, cmd: Vec<String>, extra: &[String], g
|
||||
}
|
||||
if !disk.exists() {
|
||||
eprintln!("wsbx: creating sandbox {name}");
|
||||
create_disk(h, &disk, o.disk)?;
|
||||
// meta first: it marks the image as in use for `wsbx gc` and makes a crashed create visible to ps/rm
|
||||
meta = json!({"image": image, "digest": img.digest, "workspace": ws, "created": now(), "provisioned": false});
|
||||
fs::write(&meta_path, serde_json::to_vec_pretty(&meta)?)?;
|
||||
create_disk(h, &disk, o.disk)?;
|
||||
}
|
||||
|
||||
// Build the guest-side run script (executed as root by init, then drops to the image user).
|
||||
@@ -97,6 +98,8 @@ pub fn run(h: &Path, o: Opts, image: &str, cmd: Vec<String>, extra: &[String], g
|
||||
.unwrap_or("/".into());
|
||||
let mut s = String::from("B=/.wsbx/busybox\n");
|
||||
s += &format!("$B date -s @{} >/dev/null\n", now());
|
||||
// Some images ship no /etc/hosts: without a localhost entry, Go and others resolve it via DNS and fail.
|
||||
s += "$B grep -qw localhost /etc/hosts 2>/dev/null || printf '127.0.0.1 localhost\\n::1 localhost\\n' >> /etc/hosts\n";
|
||||
s += &format!("$B hostname {name}; echo {name} > /etc/hostname; $B grep -q ' {name}$' /etc/hosts 2>/dev/null || echo '127.0.1.1 {name}' >> /etc/hosts\n");
|
||||
if let Some((rows, cols)) = term_size() {
|
||||
s += &format!("$B stty rows {rows} cols {cols}\n");
|
||||
@@ -117,8 +120,9 @@ pub fn run(h: &Path, o: Opts, image: &str, cmd: Vec<String>, extra: &[String], g
|
||||
}
|
||||
}
|
||||
for e in env {
|
||||
if let Some((k, v)) = e.split_once('=') {
|
||||
s += &format!("export {k}={}\n", sq(v));
|
||||
match export(&e) {
|
||||
Some(line) => s += &line,
|
||||
None => eprintln!("wsbx: skipping env entry with invalid name: {e:?}"),
|
||||
}
|
||||
}
|
||||
s += &format!("export WSBX_USER={}\n", sq(&user));
|
||||
@@ -239,6 +243,13 @@ pub fn run(h: &Path, o: Opts, image: &str, cmd: Vec<String>, extra: &[String], g
|
||||
}
|
||||
}
|
||||
|
||||
/// `export K='v'` line; None unless K is a shell identifier (image Env is hostile and run.sh runs as root).
|
||||
fn export(e: &str) -> Option<String> {
|
||||
let (k, v) = e.split_once('=')?;
|
||||
let ok = k.bytes().next().is_some_and(|b| b.is_ascii_alphabetic() || b == b'_') && k.bytes().all(|b| b.is_ascii_alphanumeric() || b == b'_');
|
||||
ok.then(|| format!("export {k}={}\n", sq(v)))
|
||||
}
|
||||
|
||||
/// Small result file written by the guest; regular files only (no symlinks), size-capped.
|
||||
fn guest_output(share: &Path, name: &str) -> Option<String> {
|
||||
let p = share.join(name);
|
||||
@@ -280,6 +291,14 @@ pub fn term_size() -> Option<(u16, u16)> {
|
||||
mod tests {
|
||||
use std::path::Path;
|
||||
|
||||
#[test]
|
||||
fn env_keys() {
|
||||
assert_eq!(super::export("_A1=x y").as_deref(), Some("export _A1='x y'\n"));
|
||||
for bad in ["PWN$(id > /ws/pwn)=x", "=x", "1A=x", "A B=x", "A;id=x", "noequals"] {
|
||||
assert!(super::export(bad).is_none(), "{bad}");
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn vfkit_injection_rejected() {
|
||||
assert!(super::vf(Path::new("/Users/me/repo")).is_ok());
|
||||
|
||||
Reference in New Issue
Block a user