Struct fs_mistrust::Mistrust

pub struct Mistrust { /* private fields */ }

Configuration for verifying that a file or directory is really “private”.

By default, we mistrust everything that we can: we assume that every directory on the filesystem is potentially misconfigured. This object can be used to change that.

Once you have a working Mistrust, you can call its “check_*” methods directly, or use verifier() to configure a more complicated check.

See the crate documentation for more information.

TODO

• support more kinds of trust configuration, including more trusted users, trusted groups, multiple trusted directories, etc?

Implementations

impl Mistrust

pub fn builder() -> MistrustBuilder

Return a new MistrustBuilder.

pub fn new() -> Self

Initialize a new default Mistrust.

By default:

• we will inspect all directories that are used to resolve any path that is checked.

pub fn new_dangerously_trust_everyone() -> Self

Construct a new Mistrust that trusts all users and all groups.

(In effect, this Mistrust will have all of its permissions checks disabled, since if all users and groups are trusted, it doesn’t matter what the permissions on any file and directory are.)

pub fn verifier(&self) -> Verifier<'_>

Create a new Verifier with this configuration, to perform a single check.

pub fn check_directory<P: AsRef<Path>>(&self, dir: P) -> Result<()>

Verify that dir is a directory that only trusted users can read from, list the files in, or write to.

If it is, and we can verify that, return Ok(()). Otherwise, return the first problem that we encountered when verifying it.

m.check_directory(dir) is equivalent to m.verifier().require_directory().check(dir). If you need different behavior, see Verifier for more options.

pub fn make_directory<P: AsRef<Path>>(&self, dir: P) -> Result<()>

As check_directory, but create the directory if needed.

m.check_directory(dir) is equivalent to m.verifier().make_directory(dir). If you need different behavior, see Verifier for more options.

Trait Implementations

impl Clone for Mistrust

fn clone(&self) -> Mistrust

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Mistrust

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

Formats the value using the given formatter.

impl Default for Mistrust

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq<Mistrust> for Mistrust

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Mistrust

impl StructuralEq for Mistrust

impl StructuralPartialEq for Mistrust