1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
//! Permission checks at some path using [`access_syscall`].
//!
//! Having permission of reading, writing, executing or deleting a file does not
//! guarantee success in doing so, it is unlikely but IO can fail.
//!
//! Also be careful with [`TOCTOU race conditions`], when you have outdated file
//! system information that has changed since the last check.
//!
//! [`TOCTOU race conditions`]: https://en.wikipedia.org/wiki/Time-of-check_to_time-of-use
use std::{
ffi::CString,
io,
os::{raw::c_int, unix::prelude::OsStrExt},
path::Path,
};
/// Bitflags definitions used in the `access_syscall` bitfield.
pub mod consts {
/// File exists.
pub const F_OK: libc::c_int = libc::F_OK;
/// Read permission.
pub const R_OK: libc::c_int = libc::R_OK;
/// Write permission.
pub const W_OK: libc::c_int = libc::W_OK;
/// Execute permission.
pub const X_OK: libc::c_int = libc::X_OK;
}
/// Check if current process has permission to remove file.
///
/// That is, if the current process has permission of `write` to the parent
/// directory.
///
/// Returns `false` if there's no parent directory (because can't delete the root directory).
///
/// This is the same as calling [`is_creatable`].
///
/// # Errors
///
/// - If [`Path::canonicalize`] fails.
/// - Same as [`access_syscall`].
///
/// # Examples
/// ```
/// use permissions::is_removable;
/// use std::io;
///
/// fn main() -> io::Result<()> {
/// println!("{}", is_removable("src/lib.rs")?);
/// println!("{}", is_removable("/root")?);
/// println!("{}", is_removable("/")?);
///
/// // May return `Err(kind: PermissionDenied)`
/// // println!("{}", is_removable("/root/any")?);
///
/// Ok(())
/// }
/// ```
pub fn is_removable(path: impl AsRef<Path>) -> io::Result<bool> {
let path = path.as_ref().canonicalize()?;
let parent = match path.parent() {
// Cannot delete '/' (root directory)
None => return Ok(false),
Some(parent) => parent,
};
access_syscall(parent, consts::W_OK)
}
/// Check if current process has permission to create file.
///
/// That is, if the current process has permission of `write` to the parent
/// directory.
///
/// Returns `false` if there's no parent directory (because you can't create the root directory).
///
/// This is the same as calling [`is_removable`].
///
/// # Errors
///
/// - If [`Path::canonicalize`] fails.
/// - Same as [`access_syscall`].
///
/// # Examples
/// ```
/// use permissions::is_creatable;
/// use std::io;
///
/// fn main() -> io::Result<()> {
/// println!("{}", is_creatable("src/lib.rs")?);
/// println!("{}", is_creatable("/root")?);
/// println!("{}", is_creatable("/")?);
///
/// // May return `Err(kind: PermissionDenied)`
/// // println!("{}", is_creatable("/root/any")?);
///
/// Ok(())
/// }
/// ```
pub fn is_creatable(path: impl AsRef<Path>) -> io::Result<bool> {
is_removable(path.as_ref())
}
/// Check if current process has permission to read.
///
/// # Errors
/// Same as [`access_syscall`].
///
/// # Examples
/// ```
/// use permissions::is_readable;
/// use std::io;
///
/// fn main() -> io::Result<()> {
/// println!("{}", is_readable("src/lib.rs")?);
/// println!("{}", is_readable("/root")?);
/// println!("{}", is_readable("/")?);
///
/// // may return `Err(kind: PermissionDenied)`
/// // println!("{}", is_readable("/root/any")?);
///
/// Ok(())
/// }
/// ```
pub fn is_readable(path: impl AsRef<Path>) -> io::Result<bool> {
access_syscall(path.as_ref(), consts::R_OK)
}
/// Check if current process has permission to write.
///
/// # Errors
/// Same as [`access_syscall`].
///
/// # Examples
/// ```
/// use permissions::is_writable;
/// use std::io;
///
/// fn main() -> io::Result<()> {
/// println!("{}", is_writable("src/lib.rs")?);
/// println!("{}", is_writable("/root")?);
/// println!("{}", is_writable("/")?);
///
/// // may return `Err(kind: PermissionDenied)`
/// // println!("{}", is_writable("/root/any")?);
///
/// Ok(())
/// }
/// ```
pub fn is_writable(path: impl AsRef<Path>) -> io::Result<bool> {
access_syscall(path.as_ref(), consts::W_OK)
}
/// Check if current process has permission to execute.
///
/// If `path` points to a directory, you'll be checking if you have the right to
/// enter it.
///
/// # Errors
/// Same as [`access_syscall`].
///
/// # Examples
/// ```
/// use permissions::is_executable;
/// use std::io;
///
/// fn main() -> io::Result<()> {
/// assert!(is_executable("/usr/bin/cat")?);
/// assert!(is_executable("/")?);
/// assert!(is_executable("src/")?);
/// assert!(!is_executable("src/lib.rs")?);
/// assert!(!is_executable("/root")?);
///
/// // may return `Err(kind: PermissionDenied)`
/// // println!("{}", is_executable("/root/any")?);
///
/// Ok(())
/// }
/// ```
pub fn is_executable(path: impl AsRef<Path>) -> io::Result<bool> {
access_syscall(path.as_ref(), consts::X_OK)
}
/// Safe wrapper to the `libc::access` syscall.
///
/// See [`access man page`].
///
/// Used by:
/// - [`is_removable`]
/// - [`is_readable`]
/// - [`is_writable`]
/// - [`is_executable`]
///
/// This function requires a bitmask made of:
/// - [`consts::R_OK`] _(Read)_
/// - [`consts::W_OK`] _(Write)_
/// - [`consts::X_OK`] _(Execute)_
///
/// To check for each given `rwx` permission, or:
/// - [`consts::F_OK`] _(File exists)_
///
/// Otherwise, the function fails with [`Err(kind::InvalidInput)`](std::io::ErrorKind::InvalidInput)
///
/// # Examples:
///
/// ```
/// use permissions::access_syscall;
/// use permissions::consts::{R_OK, W_OK, X_OK, F_OK};
///
/// fn main() -> std::io::Result<()> {
/// assert!(access_syscall("src/lib.rs", R_OK | W_OK)?);
/// assert!(access_syscall("/", R_OK | X_OK)?);
/// assert!(access_syscall(".", F_OK)?);
///
/// assert!(!access_syscall("src/lib.rs", X_OK)?);
/// assert!(!access_syscall("/root", W_OK)?);
///
/// Ok(())
/// }
/// ```
///
/// # Errors
/// See [`access man page`].
///
/// [`io::Error`]: std::io::Error
/// [`access man page`]: https://man7.org/linux/man-pages/man2/access.2.html
pub fn access_syscall(path: impl AsRef<Path>, mode_mask: c_int) -> io::Result<bool> {
let path = path.as_ref();
let cstr = CString::new(path.as_os_str().as_bytes()).expect("Path had interior nul byte");
// Safety:
// Pointee is a valid null-terminated string.
let access_return_code = unsafe { libc::access(cstr.as_ptr(), mode_mask) };
match access_return_code {
0 => Ok(true),
_ => {
let err = io::Error::last_os_error();
if err.raw_os_error().unwrap() == libc::EACCES {
Ok(false) // Ok, no permission to delete
} else {
Err(err) // Syscall error
}
}
}
}
#[cfg(test)]
mod tests {
use consts::{F_OK, R_OK, W_OK, X_OK};
use super::*;
#[test]
fn test_access_syscall() {
assert!(access_syscall("src/", F_OK | R_OK | W_OK | X_OK).unwrap());
assert!(access_syscall("src/", F_OK).unwrap());
assert!(access_syscall("src/", R_OK).unwrap());
assert!(access_syscall("src/", W_OK).unwrap());
assert!(access_syscall("src/", X_OK).unwrap());
assert!(!access_syscall("src/lib.rs", X_OK).unwrap());
assert!(!access_syscall("src/lib.rs", X_OK | R_OK).unwrap());
assert!(!access_syscall("src/lib.rs", X_OK | W_OK).unwrap());
assert!(!access_syscall("src/lib.rs", X_OK | F_OK).unwrap());
assert!(access_syscall("path_doesnt_exist/", F_OK).is_err()); // invalid path
assert!(access_syscall("src/", 0b11111).is_err()); // invalid number
assert!(!access_syscall("src/lib.rs", X_OK).unwrap());
assert!(!is_removable("/").unwrap());
}
}