Skip to main content

PathGuard

Struct PathGuard 

Source
pub struct PathGuard { /* private fields */ }
Expand description

Confines file-tool path access to the workspace root plus any explicitly allowed extra roots.

Implementations§

Source§

impl PathGuard

Source

pub fn builder(root: &Path) -> PathGuardBuilder

Start building a guard rooted at root, with the default blocked prefixes and no extra allowed roots.

Source

pub fn new(root: &Path) -> Result<Self, String>

Minimal guard with no extra allowed roots — the workspace root only.

Shorthand for PathGuard::builder(root).build(); this is the form used by tests and by callers with no path configuration.

Source

pub fn configured( root: &Path, allowed: &[String], home: Option<&Path>, extra_blocked: &[String], ) -> Result<Self, String>

Build a guard from already-resolved configuration in one call.

allowed entries follow the same rules as the allowed_paths setting: absolute, ~-prefixed (expanded with home), or relative to root. extra_blocked is appended to DEFAULT_BLOCKED_PREFIXES.

Source

pub fn root(&self) -> &Path

The canonicalized workspace root.

Source

pub fn allowed_roots(&self) -> &[PathBuf]

The extra allowed roots (the workspace root is implicit and first).

Source

pub fn blocked_prefixes(&self) -> &[PathBuf]

The blocked prefixes consulted for non-root paths.

Source

pub fn resolve_contained(&self, raw: &str) -> Result<PathBuf, String>

Resolve raw (a path as supplied by a tool call) and verify it stays within an allowed root.

Returns Ok(resolved) with the fully resolved absolute path on success, or Err(message) describing the violation. Callers must use the returned path rather than the raw argument: the raw string may be relative, and a relative path means different things to this guard (resolved against the workspace root) and to std::fs (resolved against the process cwd).

Source

pub fn contains(&self, raw: &str) -> bool

Returns true if raw resolves to a path inside an allowed root.

Source

pub fn open_read_contained(&self, path: &Path) -> Result<File, String>

Open path for reading, then verify the open descriptor is contained.

resolve_contained proves containment at check time, but the handler opens the path later, and the kernel re-resolves every component at open(2) — a racing process can swap a directory for a symlink in between (the process sandbox mounts the workspace read-write, so a sandboxed command can do exactly that). Verifying the descriptor’s real path after the open closes that race.

Source

pub fn create_contained(&self, path: &Path) -> Result<File, String>

Open path for writing (create/truncate), then verify containment.

Source

pub fn open_dir_contained(&self, path: &Path) -> Result<File, String>

Open path as a directory, then verify the open descriptor.

Source

pub fn read_contained(&self, path: &Path) -> Result<String, String>

Read a file to a string through a verified descriptor.

Source

pub fn write_contained(&self, path: &Path, content: &str) -> Result<(), String>

Write a file through a verified descriptor, creating parent directories one component at a time with each new directory verified the same way (a plain create_dir_all would follow a symlink swapped into place after the guard’s check).

Source

pub fn create_dir_all_contained(&self, dir: &Path) -> Result<(), String>

create_dir_all with per-component descriptor verification, so a symlink swapped in after the guard’s check cannot redirect directory creation outside an allowed root.

Source

pub fn check_glob_pattern(&self, pattern: &str) -> Result<(), String>

Check a glob pattern against the guard: the static (non-wildcard) prefix of the pattern must resolve inside an allowed root.

Bare patterns like **/*.rs are anchored at the workspace root and always pass. Absolute or ..-escaping prefixes are rejected.

Source

pub fn violation_message(&self, raw: &str) -> String

Standard error message for a violation, usable as a tool result.

Trait Implementations§

Source§

impl Clone for PathGuard

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 PathGuard

Source§

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

Formats the value using the given formatter. 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<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> DynClone for T
where T: Clone,

Source§

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

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