Skip to content
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

Update zip dependency and fix deprecation warnings #3617

Merged
merged 1 commit into from
Apr 13, 2021

Conversation

GeneFerneau
Copy link
Contributor

Update zip crate to latest version, and fix deprecation warnings using functionally equivalent APIs

Update zip crate to latest version, and fix deprecation warnings
using functionally equivalent APIs
@antiochp antiochp self-requested a review March 29, 2021 19:25
@@ -57,7 +72,7 @@ pub fn extract_files(from_archive: File, dest: &Path, files: Vec<PathBuf>) -> io
let mut archive = zip_rs::ZipArchive::new(from_archive).expect("archive file exists");
for x in files {
if let Ok(file) = archive.by_name(x.to_str().expect("valid path")) {
let path = dest.join(file.sanitized_name());
let path = dest.join(file.mangled_name());
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is enclosed_name a better option here, based on the doc comments?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I looked at that too, but we actually want the side-effects of mangled_name.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm 👍 on replacing sanitized_name with mangled_name based on the deprecated sanitized_name simply delegating to mangled_name.

But it might be worth revisiting with a separate PR to consider replacing with enclosed_name.

From the docs referenced by @trevyn -

    /// This will read well-formed ZIP files correctly, and is resistant
    /// to path-based exploits. It is recommended over
    /// [`ZipFile::mangled_name`].

@@ -37,7 +52,7 @@ pub fn create_zip(dst_file: &File, src_dir: &Path, files: Vec<PathBuf>) -> io::R
let file_path = src_dir.join(x);
if let Ok(file) = File::open(file_path.clone()) {
info!("compress: {:?} -> {:?}", file_path, x);
writer.get_mut().start_file_from_path(x, options)?;
writer.get_mut().start_file(path_to_string(x), options)?;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would just x.to_str() work here? We generate the path, so it shouldn't need to be sanitized with the path_to_string function, right?

Copy link
Contributor Author

@GeneFerneau GeneFerneau Apr 13, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

path_to_string performs extra checks that x.to_str() does not, like normalizing the path. I was also going for functional equivalence to what the previous function does. If you look at zip-rs source, this is exactly what the start_file_from_path function does internally.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@phyro
Copy link
Member

phyro commented Apr 12, 2021

@GeneFerneau check the comments when you find the time, let's get this one in if it is easy to resolve those 👍

@GeneFerneau
Copy link
Contributor Author

@GeneFerneau check the comments when you find the time, let's get this one in if it is easy to resolve those +1

Addressed the comments. Let me know if that answers your questions.

Copy link
Member

@antiochp antiochp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@antiochp antiochp merged commit 1b8acee into mimblewimble:master Apr 13, 2021
@antiochp antiochp mentioned this pull request May 6, 2021
bayk added a commit to mwcproject/mwc-node that referenced this pull request Jun 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants