Compare commits

...
7 Commits
Author SHA1 Message Date
Fedor Korotkov 817dbb6e32 Fixed x86_64 Homebrew update (#29)
Seems we need to build separate archives too and pass it to `brew`.
2024-01-24 07:30:36 -05:00
Fedor Korotkov 5f3b371e93 Build for x86_64 (#28) 2024-01-24 15:23:04 +04:00
Nikolay Edigaryev cd5f1d2f4f Fix unaligned read by switching from unmaintained users crate (#26)
* Fix unaligned read by switching from unmaintained users crate

* Bump proc-macro2 to to fix "unknown feature `proc_macro_span_shrink`"
2023-09-12 06:59:02 -04:00
Fedor Korotkov a775a92772 Add link to the blog post (#25) 2023-05-05 03:19:40 +04:00
Nikolay Edigaryev f38d65f98f README.md: Tart now uses --net-softnet 2023-03-28 08:21:19 +04:00
dependabot[bot] 4ba480ff4f Bump openssl from 0.10.45 to 0.10.48 (#24)
Bumps [openssl](https://github.com/sfackler/rust-openssl) from 0.10.45 to 0.10.48.
- [Release notes](https://github.com/sfackler/rust-openssl/releases)
- [Commits](https://github.com/sfackler/rust-openssl/compare/openssl-v0.10.45...openssl-v0.10.48)

---
updated-dependencies:
- dependency-name: openssl
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-03-25 16:20:34 +04:00
Nikolay Edigaryev d7699e95a9 Support graceful termination via SIGINT (#23)
* Support graceful termination via SIGINT

* $ cargo fmt

* Explain why we need to ignore the SIGINT
2023-03-16 18:38:03 +04:00
8 changed files with 449 additions and 337 deletions
+7 -5
View File
@@ -4,17 +4,18 @@ env:
task: task:
name: Build name: Build
macos_instance: macos_instance:
image: ghcr.io/cirruslabs/macos-monterey-xcode:14 image: ghcr.io/cirruslabs/macos-sonoma-xcode:latest
install_rust_script: install_rust_script:
- curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y - curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
- rustup target add x86_64-apple-darwin
build_script: build_script:
- cargo build - cargo build --target aarch64-apple-darwin --target x86_64-apple-darwin
task: task:
name: Release name: Release
only_if: $CIRRUS_TAG != '' only_if: $CIRRUS_TAG != ''
macos_instance: macos_instance:
image: ghcr.io/cirruslabs/macos-monterey-xcode:14 image: ghcr.io/cirruslabs/macos-sonoma-xcode:latest
env: env:
GITHUB_TOKEN: ENCRYPTED[!98ace8259c6024da912c14d5a3c5c6aac186890a8d4819fad78f3e0c41a4e0cd3a2537dd6e91493952fb056fa434be7c!] GITHUB_TOKEN: ENCRYPTED[!98ace8259c6024da912c14d5a3c5c6aac186890a8d4819fad78f3e0c41a4e0cd3a2537dd6e91493952fb056fa434be7c!]
GORELEASER_KEY: ENCRYPTED[!9b80b6ef684ceaf40edd4c7af93014ee156c8aba7e6e5795f41c482729887b5c31f36b651491d790f1f668670888d9fd!] GORELEASER_KEY: ENCRYPTED[!9b80b6ef684ceaf40edd4c7af93014ee156c8aba7e6e5795f41c482729887b5c31f36b651491d790f1f668670888d9fd!]
@@ -23,13 +24,14 @@ task:
SENTRY_AUTH_TOKEN: ENCRYPTED[!c16a5cf7da5f856b4bc2f21fe8cb7aa2a6c981f851c094ed4d3025fd02ea59a58a86cee8b193a69a1fc20fa217e56ac3!] SENTRY_AUTH_TOKEN: ENCRYPTED[!c16a5cf7da5f856b4bc2f21fe8cb7aa2a6c981f851c094ed4d3025fd02ea59a58a86cee8b193a69a1fc20fa217e56ac3!]
install_rust_script: install_rust_script:
- curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y - curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
- rustup target add x86_64-apple-darwin
install_script: install_script:
- brew install go goreleaser/tap/goreleaser-pro getsentry/tools/sentry-cli - brew install go goreleaser/tap/goreleaser-pro getsentry/tools/sentry-cli
build_script: build_script:
- cargo build --profile release-with-debug - cargo build --target aarch64-apple-darwin --target x86_64-apple-darwin --profile release-with-debug
release_script: goreleaser release_script: goreleaser
upload_sentry_debug_files_script: upload_sentry_debug_files_script:
- cd target/release-with-debug/ - cd target/aarch64-apple-darwin/release-with-debug/
# Generate and upload symbols # Generate and upload symbols
- dsymutil softnet - dsymutil softnet
- sentry-cli debug-files upload -o $SENTRY_ORG -p $SENTRY_PROJECT softnet.dSYM/ - sentry-cli debug-files upload -o $SENTRY_ORG -p $SENTRY_PROJECT softnet.dSYM/
+21 -8
View File
@@ -1,20 +1,32 @@
project_name: softnet project_name: softnet
builds: builds:
- builder: prebuilt - id: softnet-arm64
builder: prebuilt
goos: goos:
- darwin - darwin
goarch: goarch:
- arm64 - arm64
prebuilt: prebuilt:
path: "target/release-with-debug/softnet" path: "target/aarch64-apple-darwin/release-with-debug/softnet"
- id: softnet-x86
builder: prebuilt
goos:
- darwin
goarch:
- amd64
prebuilt:
path: "target/x86_64-apple-darwin/release-with-debug/softnet"
archives: archives:
- id: binary - id: regular-arm64
format: binary builds:
name_template: "{{ .ProjectName }}" - softnet-arm64
- id: regular name_template: "{{ .ProjectName }}-{{ .Arch }}"
name_template: "{{ .ProjectName }}" - id: regular-x86
builds:
- softnet-x86
name_template: "{{ .ProjectName }}-{{ .Arch }}"
release: release:
prerelease: auto prerelease: auto
@@ -22,7 +34,8 @@ release:
brews: brews:
- name: softnet - name: softnet
ids: ids:
- regular - regular-arm64
- regular-x86
tap: tap:
owner: cirruslabs owner: cirruslabs
name: homebrew-cli name: homebrew-cli
Generated
+373 -315
View File
File diff suppressed because it is too large Load Diff
+3 -2
View File
@@ -14,7 +14,7 @@ debug = true
[dependencies] [dependencies]
smoltcp = "0.8.1" smoltcp = "0.8.1"
libc = "0.2.126" libc = "0.2.126"
polling = "2.2.0" polling = { git = "https://github.com/smol-rs/polling.git" }
dhcproto = "0.7.0" dhcproto = "0.7.0"
vmnet = "0.1.1" vmnet = "0.1.1"
clap = { version = "3.1.18", features = ["derive"] } clap = { version = "3.1.18", features = ["derive"] }
@@ -22,8 +22,9 @@ mac_address = "1.1.3"
privdrop = "0.5.2" privdrop = "0.5.2"
anyhow = { version = "1.0.66", features = ["backtrace"] } anyhow = { version = "1.0.66", features = ["backtrace"] }
ip_network = "0.4.1" ip_network = "0.4.1"
users = "0.11.0" uzers = "0.11.3"
system-configuration = "0.5.0" system-configuration = "0.5.0"
num_enum = "0.5.7" num_enum = "0.5.7"
sentry = { version = "0.29.1", features = ["debug-images"] } sentry = { version = "0.29.1", features = ["debug-images"] }
sentry-anyhow = { version = "0.29.1", features = ["backtrace"] } sentry-anyhow = { version = "0.29.1", features = ["backtrace"] }
nix = "0.26.2"
+3 -2
View File
@@ -1,13 +1,14 @@
# Softnet # Softnet
Softnet is a software networking for [Tart](https://github.com/cirruslabs/tart) which provides better network isolation and alleviates DHCP shortage on production systems. Softnet is a software networking for [Tart](https://github.com/cirruslabs/tart) which provides better network isolation and alleviates DHCP shortage on production systems.
Please check out [this blog post](https://cirrus-ci.org/blog/2022/07/07/isolating-network-between-tarts-macos-virtual-machines/) for backstory.
## Working model ## Working model
Softnet solves two problems: Softnet solves two problems:
1. VM network isolation 1. VM network isolation
* [`VZNATNetworkDeviceAttachment`](https://developer.apple.com/documentation/virtualization/vznatnetworkdeviceattachment) (the default networking in Tart) enables [vmnet's bridge isolation](https://developer.apple.com/documentation/vmnet/vmnet_enable_isolation_key) by default and prevents cross-VM traffic, however it's still possible for any VM to spoof the host's ARP-table and capture other VMs traffic, for example * [`VZNATNetworkDeviceAttachment`](https://developer.apple.com/documentation/virtualization/vznatnetworkdeviceattachment) (the default networking in Tart) enables [vmnet's bridge isolation](https://developer.apple.com/documentation/vmnet/vmnet_enable_isolation_key) by default and prevents cross-VM traffic, however it's still possible for any VM to spoof the host's ARP-table and capture other VMs traffic
2. DHCP exhaustion 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 * 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
@@ -30,4 +31,4 @@ For proper functioning, Softnet binary requires two things:
## Running ## Running
Softnet is started and managed automatically by Tart if `--with-softnet` flag is present when calling `tart run`. Softnet is started and managed automatically by Tart if `--net-softnet` flag is provided when calling `tart run`.
+25 -2
View File
@@ -1,5 +1,7 @@
use anyhow::Result; use anyhow::Result;
use num_enum::IntoPrimitive; use num_enum::IntoPrimitive;
use polling::os::kqueue::PollerKqueueExt;
use polling::PollMode;
use std::os::unix::io::RawFd; use std::os::unix::io::RawFd;
use std::time::Duration; use std::time::Duration;
@@ -15,6 +17,7 @@ pub struct Poller {
enum EventKey { enum EventKey {
VM, VM,
Host, Host,
Interrupt,
} }
impl Poller { impl Poller {
@@ -34,6 +37,15 @@ impl Poller {
self.poller self.poller
.add(self.host_fd as RawFd, self.host_interest())?; .add(self.host_fd as RawFd, self.host_interest())?;
let interrupt_signal = polling::os::kqueue::Signal(libc::SIGINT);
self.poller
.add_filter(
interrupt_signal,
EventKey::Interrupt.into(),
PollMode::Oneshot,
)
.unwrap();
Ok(()) Ok(())
} }
@@ -45,10 +57,17 @@ impl Poller {
self.poller self.poller
.modify(self.host_fd as RawFd, self.host_interest())?; .modify(self.host_fd as RawFd, self.host_interest())?;
let interrupt_signal = polling::os::kqueue::Signal(libc::SIGINT);
self.poller.modify_filter(
interrupt_signal,
EventKey::Interrupt.into(),
PollMode::Oneshot,
)?;
Ok(()) Ok(())
} }
pub fn wait(&mut self) -> Result<(bool, bool)> { pub fn wait(&mut self) -> Result<(bool, bool, bool)> {
self.poller self.poller
.wait(&mut self.events, Some(Duration::from_millis(100)))?; .wait(&mut self.events, Some(Duration::from_millis(100)))?;
@@ -60,8 +79,12 @@ impl Poller {
.events .events
.iter() .iter()
.any(|ev| ev.key == Into::<usize>::into(EventKey::Host)); .any(|ev| ev.key == Into::<usize>::into(EventKey::Host));
let interrupt = self
.events
.iter()
.any(|ev| ev.key == Into::<usize>::into(EventKey::Interrupt));
Ok((vm_readable, host_readable)) Ok((vm_readable, host_readable, interrupt))
} }
fn vm_interest(&self) -> polling::Event { fn vm_interest(&self) -> polling::Event {
+6 -1
View File
@@ -43,7 +43,7 @@ impl Proxy {
self.poller.arm()?; self.poller.arm()?;
loop { loop {
let (vm_readable, host_readable) = self.poller.wait()?; let (vm_readable, host_readable, interrupt) = self.poller.wait()?;
if vm_readable { if vm_readable {
self.read_from_vm(buf.as_mut_slice())?; self.read_from_vm(buf.as_mut_slice())?;
@@ -53,6 +53,11 @@ impl Proxy {
self.read_from_host(buf.as_mut_slice())?; self.read_from_host(buf.as_mut_slice())?;
} }
// Graceful termination
if interrupt {
return Ok(());
}
self.poller.rearm()?; self.poller.rearm()?;
} }
} }
+11 -2
View File
@@ -1,5 +1,6 @@
use anyhow::{anyhow, Context}; use anyhow::{anyhow, Context};
use clap::Parser; use clap::Parser;
use nix::sys::signal::{signal, SigHandler, Signal};
use privdrop::PrivDrop; use privdrop::PrivDrop;
use softnet::proxy::Proxy; use softnet::proxy::Proxy;
use std::borrow::Cow; use std::borrow::Cow;
@@ -14,7 +15,7 @@ use system_configuration::core_foundation::number::CFNumber;
use system_configuration::core_foundation::string::CFString; use system_configuration::core_foundation::string::CFString;
use system_configuration::preferences::SCPreferences; use system_configuration::preferences::SCPreferences;
use system_configuration::sys::preferences::{SCPreferencesCommitChanges, SCPreferencesSetValue}; use system_configuration::sys::preferences::{SCPreferencesCommitChanges, SCPreferencesSetValue};
use users::{get_current_groupname, get_current_username, get_effective_uid}; use uzers::{get_current_groupname, get_current_username, get_effective_uid};
#[derive(Parser, Debug)] #[derive(Parser, Debug)]
struct Args { struct Args {
@@ -55,7 +56,7 @@ fn main() -> ExitCode {
// Initialize Sentry // Initialize Sentry
let _sentry = sentry::init(sentry::ClientOptions { let _sentry = sentry::init(sentry::ClientOptions {
release: option_env!("CIRRUS_TAG").map(|tag| { Cow::from(format!("softnet@{tag}")) }), release: option_env!("CIRRUS_TAG").map(|tag| Cow::from(format!("softnet@{tag}"))),
..Default::default() ..Default::default()
}); });
@@ -84,6 +85,14 @@ fn main() -> ExitCode {
} }
fn try_main() -> anyhow::Result<()> { fn try_main() -> anyhow::Result<()> {
// The default signal(3)[1] action for SIGINT is to interrupt program,
// but we want to handle SIGINT ourselves, so we ignore it. The kqueue(2)'s[2]
// EVFILT_SIGNAL will receive it anyways, because it has lower precedence.
//
// [1]: https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man3/signal.3.html
// [2]: https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/kqueue.2.html
unsafe { signal(Signal::SIGINT, SigHandler::SigIgn) }?;
let args: Args = Args::parse(); let args: Args = Args::parse();
// No need to run anything, just return // No need to run anything, just return