Skip to content

Add a test for verify_tarball #4097

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 28, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/admin/render_readmes.rs
Original file line number Diff line number Diff line change
Expand Up @@ -262,13 +262,13 @@ fn find_file_by_path<R: Read>(
}

#[cfg(test)]
mod tests {
pub mod tests {
use std::io::Write;
use tar;

use super::render_pkg_readme;

fn add_file<W: Write>(pkg: &mut tar::Builder<W>, path: &str, content: &[u8]) {
pub fn add_file<W: Write>(pkg: &mut tar::Builder<W>, path: &str, content: &[u8]) {
let mut header = tar::Header::new_gnu();
header.set_size(content.len() as u64);
header.set_cksum();
Expand Down
32 changes: 22 additions & 10 deletions src/controllers/krate/publish.rs
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,8 @@ pub fn publish(req: &mut dyn RequestExt) -> EndpointResult {
let mut tarball = Vec::new();
LimitErrorReader::new(req.body(), maximums.max_upload_size).read_to_end(&mut tarball)?;
let hex_cksum: String = Sha256::digest(&tarball).encode_hex();
verify_tarball(&krate, vers, &tarball, maximums.max_unpack_size)?;
let pkg_name = format!("{}-{}", krate.name, vers);
verify_tarball(&pkg_name, &tarball, maximums.max_unpack_size)?;

if let Some(readme) = new_crate.readme {
render::render_and_upload_readme(
Expand Down Expand Up @@ -363,12 +364,7 @@ pub fn add_dependencies(
Ok(git_deps)
}

fn verify_tarball(
krate: &Crate,
vers: &semver::Version,
tarball: &[u8],
max_unpack: u64,
) -> AppResult<()> {
fn verify_tarball(pkg_name: &str, tarball: &[u8], max_unpack: u64) -> AppResult<()> {
// All our data is currently encoded with gzip
let decoder = GzDecoder::new(tarball);

Expand All @@ -378,7 +374,6 @@ fn verify_tarball(

// Use this I/O object now to take a peek inside
let mut archive = tar::Archive::new(decoder);
let prefix = format!("{}-{}", krate.name, vers);
for entry in archive.entries()? {
let entry = entry.map_err(|err| {
err.chain(cargo_err(
Expand All @@ -391,7 +386,7 @@ fn verify_tarball(
// upload a tarball that contains both `foo-0.1.0/` source code as well
// as `bar-0.1.0/` source code, and this could overwrite other crates in
// the registry!
if !entry.path()?.starts_with(&prefix) {
if !entry.path()?.starts_with(&pkg_name) {
return Err(cargo_err("invalid tarball uploaded"));
}

Expand All @@ -410,12 +405,29 @@ fn verify_tarball(

#[cfg(test)]
mod tests {
use super::missing_metadata_error_message;
use super::{missing_metadata_error_message, verify_tarball};
use crate::admin::render_readmes::tests::add_file;
use flate2::read::GzEncoder;
use std::io::Read;

#[test]
fn missing_metadata_error_message_test() {
assert_eq!(missing_metadata_error_message(&["a"]), "missing or empty metadata fields: a. Please see https://doc.rust-lang.org/cargo/reference/manifest.html for how to upload metadata");
assert_eq!(missing_metadata_error_message(&["a", "b"]), "missing or empty metadata fields: a, b. Please see https://doc.rust-lang.org/cargo/reference/manifest.html for how to upload metadata");
assert_eq!(missing_metadata_error_message(&["a", "b", "c"]), "missing or empty metadata fields: a, b, c. Please see https://doc.rust-lang.org/cargo/reference/manifest.html for how to upload metadata");
}

#[test]
fn verify_tarball_test() {
let mut pkg = tar::Builder::new(vec![]);
add_file(&mut pkg, "foo-0.0.1/.cargo_vcs_info.json", br#"{}"#);
let mut serialized_archive = vec![];
GzEncoder::new(pkg.into_inner().unwrap().as_slice(), Default::default())
.read_to_end(&mut serialized_archive)
.unwrap();

let limit = 512 * 1024 * 1024;
assert_ok!(verify_tarball("foo-0.0.1", &serialized_archive, limit));
assert_err!(verify_tarball("bar-0.0.1", &serialized_archive, limit));
}
}