diff --git a/src/lib.rs b/src/lib.rs index 7fe44b180..76d98a159 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -26,10 +26,17 @@ //! In the presence of pathological temporary file cleaner, relying on file paths is unsafe because //! a temporary file cleaner could delete the temporary file which an attacker could then replace. //! -//! `tempfile` doesn't rely on file paths so this isn't an issue. However, `NamedTempFile` does -//! rely on file paths for _some_ operations. See the security documentation on -//! the `NamedTempFile` type for more information. -//! +//! This should not be an issue for `tempfile`, as it does not rely on file paths +//! and a temporary file's default permissions on Unix is 0600 by default. +//! However, `NamedTempFile` does rely on file paths for _some_ operations. +//! Take a look at the Security documentation of [`NamedTempFile`] for more information. +//! +//! If a process is able to predict the name of a temporary file / directory, depending +//! on your use case and threat model, some additional security issues may occur. +//! On Unix-like operating systems, you may be able to mitigate such issues by +//! overriding the crate's default options for temporary directories. +//! See [`Builder::permissions`], [`Builder::rand_bytes`] and [`env::override_temp_dir`]. +//! //! The OWASP Foundation provides a resource on vulnerabilities concerning insecure //! temporary files: https://owasp.org/www-community/vulnerabilities/Insecure_Temporary_File //! @@ -172,7 +179,7 @@ pub use crate::file::{ }; pub use crate::spooled::{spooled_tempfile, SpooledData, SpooledTempFile}; -/// Create a new temporary file or directory with custom parameters. +/// Create a new temporary file or directory with custom options. #[derive(Debug, Clone, Eq, PartialEq)] pub struct Builder<'a, 'b> { random_len: usize, @@ -349,7 +356,7 @@ impl<'a, 'b> Builder<'a, 'b> { /// /// # Security /// - /// By default, the permissions of tempfiles on unix are set for it to be + /// By default, the permissions of tempfiles on Unix are set for it to be /// readable and writable by the owner only, yielding the greatest amount /// of security. /// As this method allows to widen the permissions, security would be @@ -369,7 +376,7 @@ impl<'a, 'b> Builder<'a, 'b> { /// ## Windows and others /// /// This setting is unsupported and trying to set a file or directory read-only - /// will cause an error to be returned.. + /// will return an error. /// /// # Examples ///