nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2025-04-15 05:26:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

clarify std::fs::set_permissions symlink behavior

Browse Source 
nest under platform-specific behavior,
factor rationale into its own section,
and tweak language.
This commit is contained in:
binarycat 2025-04-08 15:07:08 -05:00
parent 8808d5a2b2
commit 37c4a37ca2
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
library/std/src/fs.rs
View File

@ -2980,19 +2980,21 @@ pub fn read_dir<P: AsRef<Path>>(path: P) -> io::Result<ReadDir> {
///
/// [changes]: io#platform-specific-behavior
///
/// # Symlinks
/// On UNIX systems, it is impossible to manipulate the permission bits of a symlink itself[^1].
/// Because of this, on those systems, this function will update the permission bits
/// ## Symlinks
/// On UNIX-like systems, this function will update the permission bits
/// of the file pointed to by the symlink.
///
/// Note that this behavior can lead to privalage escalation vulnerabilites,
/// where the ability to write a symlink in one directory allows you to
/// cause the permissions of another directory to be modified.
/// where the ability to create a symlink in one directory allows you to
/// cause the permissions of another file or directory to be modified.
///
/// For this reason, using this function with symlinks should be avoided.
/// When possible, permissions should be set at creation time instead.
///
/// [^1]: even if it were possible, the permissions on a symlink are ignored.
/// # Rationale
/// POSIX does not specify an `lchown` function,
/// and symlinks can be followed regardless of what permission bits are set.
///
/// # Errors
///
/// This function will return an error in the following situations, but is not