Skip to main content

SandboxConfig

Struct SandboxConfig 

Source
pub struct SandboxConfig {
    pub backend: String,
    pub writable_paths: Vec<String>,
}
Expand description

OS-level sandbox configuration for shell-executing tools.

Serializes as the sandbox object in the global settings.json only:

{
  "sandbox": {
    "backend": "bwrap",
    "writable_paths": ["/tmp/build-cache"]
  }
}

The default is SandboxConfig::auto — sandbox with whatever backend is installed, bwrap preferred. Sandboxing shell commands is the baseline, and turning it off is a deliberate act: --no-sandbox on the command line, or {"backend": "off"} in the global settings file.

This block is deliberately absent from .tinyharness/config.json (ProjectSettings has no sandbox field). A project config is shipped inside the repository, so honouring it would let any cloned repo downgrade the user’s chosen containment — including switching the sandbox off entirely. Unknown keys are ignored by serde, so a stray sandbox block in a project file has no effect.

backend is required whenever the sandbox object is present, and accepts auto (use whatever is installed, bwrap preferred), bwrap, firejail, or off. See SandboxBackend. Requiring it is deliberate: a block like {"sandbox": {"writable_paths": ["/tmp/x"]}} states an intention to be sandboxed without naming a backend, and silently defaulting that to off would leave the user unprotected while believing otherwise. Omit the whole sandbox key to get SandboxConfig::auto.

There is deliberately no network setting: sandboxed commands always have the network. A coding agent runs git fetch, curl, and cargo add constantly, so a knob that would break those is not worth exposing.

Extra host directories come from the top-level allowed_paths setting, which also drives the built-in file tools’ path guard (those tools run in-process, so the guard is their only confinement); only write access inside the sandbox is configured here.

Fields§

§backend: String

Backend selector: off | auto | bwrap | firejail. Required whenever a sandbox block is present.

§writable_paths: Vec<String>

Extra host directories sandboxed commands may write.

Deliberately separate from allowed_paths: that setting also feeds the path guard confining the built-in file tools, and those tools run in-process, so granting it write access would widen their reach too. Anything here is reachable only by sandboxed shell commands.

Implementations§

Source§

impl SandboxConfig

Source

pub fn disabled() -> Self

No sandbox (the default).

Source

pub fn auto() -> Self

Auto-detect the best installed backend.

Source

pub fn is_disabled(&self) -> bool

true when no sandboxing is requested.

Source

pub fn is_enabled(&self) -> bool

true when a sandbox (auto-detected or explicit) is requested.

Trait Implementations§

Source§

impl Clone for SandboxConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for SandboxConfig

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for SandboxConfig

Source§

fn default() -> Self

Sandboxing is on by default — see the type-level docs.

Source§

impl<'de> Deserialize<'de> for SandboxConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for SandboxConfig

Source§

impl PartialEq for SandboxConfig

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for SandboxConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for SandboxConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more