Software networking with isolation for Tart
Go to file
Nikolay Edigaryev 6456ed7228
README.md: proper nested bullet point syntax
2024-06-13 14:57:44 +04:00
lib Ignore socketpair(2) errors when sending (#36) 2024-03-25 12:37:53 -04:00
src Prevent multiple --allow flags (#35) 2024-03-11 23:02:59 +04:00
.cirrus.yml Build for `x86_64` (#28) 2024-01-24 15:23:04 +04:00
.gitignore Goreleaser Fix (#30) 2024-01-24 19:09:59 +04:00
.goreleaser.yml Goreleaser Fix (#30) 2024-01-24 19:09:59 +04:00
Cargo.lock Prevent multiple --allow flags (#35) 2024-03-11 23:02:59 +04:00
Cargo.toml Prevent multiple --allow flags (#35) 2024-03-11 23:02:59 +04:00
LICENSE License under AGPL-3.0 (#4) 2022-06-21 15:59:35 +03:00
README.md README.md: proper nested bullet point syntax 2024-06-13 14:57:44 +04:00
rust-toolchain Switch back to nightly toolchain (#16) 2022-12-14 23:18:24 +04:00

README.md

Softnet

Softnet is a software networking for Tart which provides better network isolation and alleviates DHCP shortage on production systems. Please check out this blog post for backstory.

Working model

Softnet solves two problems:

  1. VM network isolation
  2. DHCP exhaustion
    • macOS built-in DHCP-server allocates a /24 subnet with 86400 seconds lease time by default, which only allows for ~253 VMs a day (or 1 VM every ~6 minutes) to be spawned without causing a denial-of-service, which is pretty limiting for CI services like Cirrus CI

And assumes that:

  1. Tart gives it's VMs unique MAC-addresses
  2. macOS built-in DHCP-server won't re-use the IP-addresses from it's pool until their lease expire

...otherwise it's possible for two VMs to receive an identical IP-address from the macOS built-in DHCP-server (even in the presence of Softnet's packet filtering) and thus bypass the protections offered by Softnet.

Installing

For proper functioning, Softnet binary requires two things:

  • a SUID-bit to be set on the binary or a passwordless sudo to be configured, which effectively gives the binary root privileges
    • these privileges are needed to create vmnet.framework interface and perform DHCP-related system tweaks
    • the privileges will be dropped automatically to that of the calling user (or those represented by the --user and --group command-line arguments) once all of the initialization is completed
  • the binary to be available in PATH
    • so that the Tart will be able to find it

Running

Softnet is started and managed automatically by Tart if --net-softnet flag is provided when calling tart run.