Preserve executable bit when untarring archives (#1790)

## Summary

Closes https://github.com/astral-sh/uv/issues/1767.
This commit is contained in:
Charlie Marsh 2024-02-21 09:18:44 -05:00 committed by GitHub
parent 88a0c13865
commit 19890feb77
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 82 additions and 1 deletions

View File

@ -4,4 +4,5 @@ pub use sync::*;
mod error; mod error;
pub mod stream; pub mod stream;
mod sync; mod sync;
mod tar;
mod vendor; mod vendor;

View File

@ -1,5 +1,7 @@
use std::path::Path; use std::path::Path;
use std::pin::Pin;
use futures::StreamExt;
use rustc_hash::FxHashSet; use rustc_hash::FxHashSet;
use tokio_util::compat::{FuturesAsyncReadCompatExt, TokioAsyncReadCompatExt}; use tokio_util::compat::{FuturesAsyncReadCompatExt, TokioAsyncReadCompatExt};
@ -97,6 +99,44 @@ pub async fn unzip<R: tokio::io::AsyncRead + Unpin>(
Ok(()) Ok(())
} }
/// Unpack the given tar archive into the destination directory.
///
/// This is equivalent to `archive.unpack_in(dst)`, but it also preserves the executable bit.
async fn untar_in<R: tokio::io::AsyncRead + Unpin, P: AsRef<Path>>(
archive: &mut tokio_tar::Archive<R>,
dst: P,
) -> std::io::Result<()> {
let mut entries = archive.entries()?;
let mut pinned = Pin::new(&mut entries);
while let Some(entry) = pinned.next().await {
// Unpack the file into the destination directory.
let mut file = entry?;
file.unpack_in(dst.as_ref()).await?;
// Preserve the executable bit.
#[cfg(unix)]
{
use std::fs::Permissions;
use std::os::unix::fs::PermissionsExt;
let mode = file.header().mode()?;
let has_any_executable_bit = mode & 0o111;
if has_any_executable_bit != 0 {
if let Some(path) = crate::tar::unpacked_at(dst.as_ref(), &file.path()?) {
let permissions = fs_err::tokio::metadata(&path).await?.permissions();
fs_err::tokio::set_permissions(
&path,
Permissions::from_mode(permissions.mode() | 0o111),
)
.await?;
}
}
}
}
Ok(())
}
/// Unzip a `.tar.gz` archive into the target directory, without requiring `Seek`. /// Unzip a `.tar.gz` archive into the target directory, without requiring `Seek`.
/// ///
/// This is useful for unpacking files as they're being downloaded. /// This is useful for unpacking files as they're being downloaded.
@ -108,7 +148,7 @@ pub async fn untar<R: tokio::io::AsyncBufRead + Unpin>(
let mut archive = tokio_tar::ArchiveBuilder::new(decompressed_bytes) let mut archive = tokio_tar::ArchiveBuilder::new(decompressed_bytes)
.set_preserve_mtime(false) .set_preserve_mtime(false)
.build(); .build();
Ok(archive.unpack(target.as_ref()).await?) Ok(untar_in(&mut archive, target.as_ref()).await?)
} }
/// Unzip a `.zip` or `.tar.gz` archive into the target directory, without requiring `Seek`. /// Unzip a `.zip` or `.tar.gz` archive into the target directory, without requiring `Seek`.

View File

@ -0,0 +1,40 @@
use std::path::{Component, Path, PathBuf};
/// Determine the path at which the given tar entry will be unpacked, when unpacking into `dst`.
///
/// See: <https://github.com/vorot93/tokio-tar/blob/87338a76092330bc6fe60de95d83eae5597332e1/src/entry.rs#L418>
#[cfg_attr(not(target_os = "unix"), allow(dead_code))]
pub(crate) fn unpacked_at(dst: &Path, entry: &Path) -> Option<PathBuf> {
let mut file_dst = dst.to_path_buf();
{
for part in entry.components() {
match part {
// Leading '/' characters, root paths, and '.'
// components are just ignored and treated as "empty
// components"
Component::Prefix(..) | Component::RootDir | Component::CurDir => {
continue;
}
// If any part of the filename is '..', then skip over
// unpacking the file to prevent directory traversal
// security issues. See, e.g.: CVE-2001-1267,
// CVE-2002-0399, CVE-2005-1918, CVE-2007-4131
Component::ParentDir => return None,
Component::Normal(part) => file_dst.push(part),
}
}
}
// Skip cases where only slashes or '.' parts were seen, because
// this is effectively an empty filename.
if *dst == *file_dst {
return None;
}
// Skip entries without a parent (i.e. outside of FS root)
file_dst.parent()?;
Some(file_dst)
}