Skip to main content

Sandbox

Struct Sandbox 

Source
pub struct Sandbox { /* private fields */ }

Implementations§

Source§

impl Sandbox

Source

pub fn new(cfg: SandboxConfig) -> Self

Source

pub fn backend(&self) -> Backend

Source

pub fn with_network(&self, network: bool) -> Self

The same policy with the network decided differently.

Exists because network is otherwise one switch for everything, and the common case wants them split: a third-party MCP server that has to reach its own API, confined, while shell still has no way out. Sharing one flag would mean opening shell to satisfy the server.

Source

pub fn is_enabled(&self) -> bool

Source

pub fn can_reach_network(&self) -> bool

Can a confined command still reach off this machine?

This is what decides whether shell counts as an external_send sink. Unconfined, it always can. Confined without network, it cannot — and the interlock should stop treating it as a way out, because it isn’t one.

Source

pub fn reaches_beyond_workspace(&self) -> bool

Can a confined command read data outside the workspace?

Unconfined it reads your whole home directory. Confined it sees the workspace and a read-only system — the same reach fs_read already has, which is classified private on the same reasoning.

Source

pub fn command( &self, command: &str, workspace: &Path, cwd: &Path, ) -> Result<Command>

Build the process that will run command.

workspace is mounted writable; cwd must be inside it — the caller has already proved that through ToolCtx::resolve.

Source

pub fn wrap_argv( &self, program: &str, args: &[String], workspace: &Path, cwd: &Path, ) -> Result<Command>

Confine an explicit argv, with no shell in between.

For long-lived children — an MCP server — where routing through bash -lc would mean quoting caller-supplied arguments correctly, and getting that wrong is a command-injection bug rather than a typo.

Source

pub fn child_env(passthrough: &[String]) -> Vec<(String, String)>

The environment a child should get, given a passthrough allowlist.

Inheriting mecha’s environment hands a third-party process every secret you have exported — provider keys first among them. So the rule is the same as inside the sandbox: a minimal base, plus what was named.

HOME and PATH are in the base because without them most runtimes (node, python) cannot find their own modules, and a server that cannot start teaches the operator to turn this off.

Source

pub fn bwrap_args(&self, workspace: &Path, cwd: &Path) -> Result<Vec<String>>

Arguments up to (but not including) the command itself. Split out so the policy can be asserted on in tests without spawning anything.

Source

pub fn docker_args(&self, workspace: &Path, cwd: &Path) -> Result<Vec<String>>

Arguments up to (but not including) the command itself.

Source

pub async fn preflight(&self, workspace: &Path) -> Result<()>

Prove the sandbox actually works, by running something through it.

Called once at startup rather than on the first tool call, so a misconfiguration is a clear message at launch instead of a confusing tool error twenty turns into a run.

Trait Implementations§

Source§

impl Clone for Sandbox

Source§

fn clone(&self) -> Sandbox

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 Sandbox

Source§

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

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

impl Default for Sandbox

Source§

fn default() -> Sandbox

Returns the “default value” for a type. Read more

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<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> 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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<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