//! This defines `stat`, the primary entrypoint to sandboxed metadata querying.

#[cfg(racy_asserts)]

use crate::fs::{canonicalize, map_result, stat_unchecked};

use crate::fs::{stat_impl, FollowSymlinks, Metadata};

use std::path::Path;

use std::{fs, io};

/// Perform an `fstatat`-like operation, ensuring that the resolution of the

/// path never escapes the directory tree rooted at `start`.

#[cfg_attr(not(racy_asserts), allow(clippy::let_and_return))]

#[inline]

pub fn stat(start: &fs::File, path: &Path, follow: FollowSymlinks) -> io::Result<Metadata> {

    // Call the underlying implementation.

    let result = stat_impl(start, path, follow);

    #[cfg(racy_asserts)]

    let stat = stat_unchecked(start, path, follow);

    #[cfg(racy_asserts)]

    check_stat(start, path, follow, &result, &stat);

    result

}

cap_primitives::fs::stat::stat

Line

Count

Source

13

107k

pub fn stat(start: &fs::File, path: &Path, follow: FollowSymlinks) -> io::Result<Metadata> {

14

    // Call the underlying implementation.

15

107k

    let result = stat_impl(start, path, follow);

16

17

    #[cfg(racy_asserts)]

18

    let stat = stat_unchecked(start, path, follow);

19

20

    #[cfg(racy_asserts)]

21

    check_stat(start, path, follow, &result, &stat);

22

23

107k

    result

24

107k

}

Unexecuted instantiation: cap_primitives::fs::stat::stat

#[cfg(racy_asserts)]

#[allow(clippy::enum_glob_use)]

fn check_stat(

    start: &fs::File,

    path: &Path,

    follow: FollowSymlinks,

    result: &io::Result<Metadata>,

    stat: &io::Result<Metadata>,

) {

    use io::ErrorKind::*;

    match (map_result(result), map_result(stat)) {

        (Ok(metadata), Ok(unchecked_metadata)) => {

            assert_same_file_metadata!(

                metadata,

                unchecked_metadata,

                "path resolution inconsistency: start='{:?}', path='{}'",

                start,

                path.display(),

            );

        }

        (Err((PermissionDenied, message)), _) => {

            if let FollowSymlinks::Yes = follow {

                match map_result(&canonicalize(start, path)) {

                    Ok(_) => (),

                    Err((PermissionDenied, canon_message)) => {

                        assert_eq!(message, canon_message);

                    }

                    err => panic!("stat failed where canonicalize succeeded: {:?}", err),

                }

            } else {

                // TODO: Check that stat in the no-follow case got the right

                // error.

            }

        }

        (Err((kind, message)), Err((unchecked_kind, unchecked_message))) => {

            assert_eq!(kind, unchecked_kind);

            assert_eq!(

                message,

                unchecked_message,

                "start='{:?}', path='{:?}'",

                start,

                path.display()

            );

        }

        other => panic!(

            "unexpected result from stat start='{:?}', path='{}':\n{:#?}",

            start,

            path.display(),

            other,

        ),

    }

}