Skip to main content

TrustedDir

Struct TrustedDir 

Source
pub struct TrustedDir(/* private fields */);
Expand description

A directory opened by FOLLOWING symlinks normally — the command-line-named path’s trusted parent prefix.

The trusted-boundary model (docs/tocttou.md, “Trusted boundary”) trusts the path named on the command line up to and including its container directory; only entries strictly BELOW the named root are hardened with O_NOFOLLOW. A TrustedDir is that trusted container, and it is the ONLY way in this crate to obtain a directory fd that was opened following symlinks — its sole constructor is Dir::open_parent_dir. Every other directory open (Dir::open_dir, Dir::child, Dir::open_file_read, Dir::create_file, Dir::make_dir, …) is O_NOFOLLOW.

Because the trusted/hardened distinction is a type rather than a convention, the compiler enforces it: a parent-prefix slot typed TrustedDir can only be filled by the follow-open, and a hardened Dir cannot be used where a trusted parent is required. Crossing from the trusted prefix into the hardened tree is the single explicit Self::into_tree step.

Under strict operand resolution (--require-toctou-safe) the “trusted” prefix is additionally required to be symlink-free: the open resolves it RESOLVE_NO_SYMLINKS, so a symlink component fails closed with ELOOP rather than being followed (see enable_strict_operand_resolution).

Implementations§

Source§

impl TrustedDir

Source

pub fn into_tree(self) -> Dir

Cross from the trusted parent prefix into the hardened tree, consuming the TrustedDir and handing back the owned hardened Dir (e.g. to wrap it in an Arc for the walk). Every open below the returned Dir is O_NOFOLLOW, so nothing below the named root can be redirected by a symlink swap. This is the one explicit trusted→hardened transition.

Trait Implementations§

Source§

impl Debug for TrustedDir

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> 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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
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