Skip to main content

CorePathPolicy

Struct CorePathPolicy 

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

Path-level policy for filesystem-touching tools.

Lives in heartbit-core (not in the umbrella) so all filesystem builtins (bash, patch, edit, write, read) can share enforcement. The umbrella’s SandboxPolicy (landlock-backed on Linux) will compose a CorePathPolicy for the path-allowlist piece. Until Task 5 lands, the two are independent.

Implementations§

Source§

impl CorePathPolicy

Source

pub fn builder() -> CorePathPolicyBuilder

Source

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

Returns the canonicalized allowed directories. Used by SandboxPolicy::from_path_policy to derive Landlock read/write path lists.

Source

pub fn check_path(&self, path: &Path) -> Result<(), Error>

Returns Ok(()) if path is allowed, Err(Error::Sandbox(...)) otherwise. Canonicalizes the input so symlinks pointing outside allowed_dirs are rejected.

Source

pub fn check_path_for_create(&self, path: &Path) -> Result<PathBuf, Error>

Like [check_path] but for files that don’t exist yet (about to be created or overwritten). Canonicalizes the parent directory then recomposes parent.canonicalize() + file_name to produce a path that is bound to the real parent (not a symlink to elsewhere). The returned PathBuf is the canonical target the caller should write to.

SECURITY (F-FS-1): the previous pattern of “walk up to first existing ancestor, then check_path on it” left a TOCTOU window: between the check and the write, an attacker (or another tool call dispatched in parallel via tokio::JoinSet) could replace an intermediate component with a symlink pointing outside the workspace, and the write would follow the symlink. Combine this method with O_NOFOLLOW on the open syscall to close the race window entirely.

Trait Implementations§

Source§

impl Clone for CorePathPolicy

Source§

fn clone(&self) -> CorePathPolicy

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 CorePathPolicy

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