Skip to content

Commit b9a4c5f

Browse files
darktohkadarktohka
authored
fix: When only zopfli is available, decompression of deflate should not be possible (#348)
* fix: When only zopfli is available, decompression of deflate should not be possible Signed-off-by: Derzsi Dániel <daniel@tohka.us> * fix: Rollback flate2 feature as flate2/rust_backend is enough --------- Signed-off-by: Derzsi Dániel <daniel@tohka.us>
1 parent 6242a00 commit b9a4c5f

File tree

9 files changed

+112
-37
lines changed

9 files changed

+112
-37
lines changed

‎.github/workflows/ci.yaml‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,12 @@ jobs:
2222
matrix:
2323
os: [ubuntu-latest, macOS-latest, windows-latest]
2424
rustalias: [stable, nightly, msrv]
25-
feature_flag: ["--all-features", "--no-default-features", ""]
25+
feature_flag:
26+
- "--all-features"
27+
- "--no-default-features"
28+
- "--no-default-features --features deflate-flate2"
29+
- "--no-default-features --features deflate-zopfli"
30+
- ""
2631
include:
2732
- rustalias: stable
2833
rust: stable
@@ -42,7 +47,12 @@ jobs:
4247
if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.event.pull_request.base.repo.full_name
4348
strategy:
4449
matrix:
45-
feature_flag: ["--all-features", "--no-default-features", ""]
50+
feature_flag:
51+
- "--all-features"
52+
- "--no-default-features"
53+
- "--no-default-features --features deflate-flate2"
54+
- "--no-default-features --features deflate-zopfli"
55+
- ""
4656
name: 'Miri ${{ matrix.feature_flag }}'
4757
runs-on: ubuntu-latest
4858
steps:

‎src/compression.rs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ pub const SUPPORTED_COMPRESSION_METHODS: &[CompressionMethod] = &[
193193

194194
pub(crate) enum Decompressor<R: io::BufRead> {
195195
Stored(R),
196-
#[cfg(feature = "_deflate-any")]
196+
#[cfg(feature = "deflate-flate2")]
197197
Deflated(flate2::bufread::DeflateDecoder<R>),
198198
#[cfg(feature = "deflate64")]
199199
Deflate64(deflate64::Deflate64Decoder<R>),
@@ -211,7 +211,7 @@ impl<R: io::BufRead> io::Read for Decompressor<R> {
211211
fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
212212
match self {
213213
Decompressor::Stored(r) => r.read(buf),
214-
#[cfg(feature = "_deflate-any")]
214+
#[cfg(feature = "deflate-flate2")]
215215
Decompressor::Deflated(r) => r.read(buf),
216216
#[cfg(feature = "deflate64")]
217217
Decompressor::Deflate64(r) => r.read(buf),
@@ -231,7 +231,7 @@ impl<R: io::BufRead> Decompressor<R> {
231231
pub fn new(reader: R, compression_method: CompressionMethod) -> crate::result::ZipResult<Self> {
232232
Ok(match compression_method {
233233
CompressionMethod::Stored => Decompressor::Stored(reader),
234-
#[cfg(feature = "_deflate-any")]
234+
#[cfg(feature = "deflate-flate2")]
235235
CompressionMethod::Deflated => {
236236
Decompressor::Deflated(flate2::bufread::DeflateDecoder::new(reader))
237237
}
@@ -261,7 +261,7 @@ impl<R: io::BufRead> Decompressor<R> {
261261
pub fn into_inner(self) -> R {
262262
match self {
263263
Decompressor::Stored(r) => r,
264-
#[cfg(feature = "_deflate-any")]
264+
#[cfg(feature = "deflate-flate2")]
265265
Decompressor::Deflated(r) => r.into_inner(),
266266
#[cfg(feature = "deflate64")]
267267
Decompressor::Deflate64(r) => r.into_inner(),

‎src/read.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2146,7 +2146,7 @@ mod test {
21462146
ZipArchive::new(Cursor::new(v)).expect_err("Invalid file");
21472147
}
21482148

2149-
#[cfg(feature = "_deflate-any")]
2149+
#[cfg(feature = "deflate-flate2")]
21502150
#[test]
21512151
fn test_read_with_data_descriptor() {
21522152
use std::io::Read;
@@ -2172,7 +2172,7 @@ mod test {
21722172
}
21732173

21742174
#[test]
2175-
#[cfg(feature = "_deflate-any")]
2175+
#[cfg(feature = "deflate-flate2")]
21762176
fn test_utf8_extra_field() {
21772177
let mut v = Vec::new();
21782178
v.extend_from_slice(include_bytes!("../tests/data/chinese.zip"));

‎src/write.rs‎

Lines changed: 46 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ use crate::types::{
1313
ZipRawValues, MIN_VERSION,
1414
};
1515
use crate::write::ffi::S_IFLNK;
16-
#[cfg(any(feature = "_deflate-any", feature = "bzip2", feature = "zstd",))]
16+
#[cfg(feature = "deflate-zopfli")]
1717
use core::num::NonZeroU64;
1818
use crc32fast::Hasher;
1919
use indexmap::IndexMap;
@@ -754,6 +754,7 @@ impl<A: Read + Write + Seek> ZipWriter<A> {
754754
/// [`Self::finish()`].
755755
///
756756
///```
757+
/// # #[cfg(all(feature = "deflate-zopfli", not(feature = "deflate-flate2")))] {
757758
/// # fn main() -> Result<(), zip::result::ZipError> {
758759
/// use std::io::{Cursor, prelude::*};
759760
/// use zip::{ZipArchive, ZipWriter, write::SimpleFileOptions};
@@ -770,6 +771,7 @@ impl<A: Read + Write + Seek> ZipWriter<A> {
770771
/// assert_eq!(s, "hello\n");
771772
/// # Ok(())
772773
/// # }
774+
/// # }
773775
///```
774776
pub fn finish_into_readable(mut self) -> ZipResult<ZipArchive<A>> {
775777
let central_start = self.finalize()?;
@@ -1191,6 +1193,7 @@ impl<W: Write + Seek> ZipWriter<W> {
11911193
/// calling [`Self::raw_copy_file()`] for each entry from the `source` archive in sequence.
11921194
///
11931195
///```
1196+
/// # #[cfg(all(feature = "deflate-zopfli", not(feature = "deflate-flate2")))] {
11941197
/// # fn main() -> Result<(), zip::result::ZipError> {
11951198
/// use std::io::{Cursor, prelude::*};
11961199
/// use zip::{ZipArchive, ZipWriter, write::SimpleFileOptions};
@@ -1208,6 +1211,7 @@ impl<W: Write + Seek> ZipWriter<W> {
12081211
/// let src2 = ZipArchive::new(zip.finish()?)?;
12091212
///
12101213
/// let buf = Cursor::new(Vec::new());
1214+
///
12111215
/// let mut zip = ZipWriter::new(buf);
12121216
/// zip.merge_archive(src)?;
12131217
/// zip.merge_archive(src2)?;
@@ -1221,6 +1225,7 @@ impl<W: Write + Seek> ZipWriter<W> {
12211225
/// assert_eq!(s, "hey\n");
12221226
/// # Ok(())
12231227
/// # }
1228+
/// # }
12241229
///```
12251230
pub fn merge_archive<R>(&mut self, mut source: ZipArchive<R>) -> ZipResult<()>
12261231
where
@@ -1660,14 +1665,11 @@ impl<W: Write + Seek> GenericZipWriter<W> {
16601665
}
16611666
#[cfg(feature = "_deflate-any")]
16621667
CompressionMethod::Deflated => {
1663-
let default = if cfg!(all(
1664-
feature = "deflate-zopfli",
1665-
not(feature = "deflate-flate2")
1666-
)) {
1667-
24
1668-
} else {
1669-
Compression::default().level() as i64
1670-
};
1668+
#[cfg(feature = "deflate-flate2")]
1669+
let default = Compression::default().level() as i64;
1670+
1671+
#[cfg(all(feature = "deflate-zopfli", not(feature = "deflate-flate2")))]
1672+
let default = 24;
16711673

16721674
let level = clamp_opt(
16731675
compression_level.unwrap_or(default),
@@ -1677,12 +1679,11 @@ impl<W: Write + Seek> GenericZipWriter<W> {
16771679
as u32;
16781680

16791681
#[cfg(feature = "deflate-zopfli")]
1680-
{
1681-
let best_non_zopfli = Compression::best().level();
1682-
if level > best_non_zopfli {
1682+
macro_rules! deflate_zopfli_and_return {
1683+
($bare:expr, $best_non_zopfli:expr) => {
16831684
let options = Options {
16841685
iteration_count: NonZeroU64::try_from(
1685-
(level - best_non_zopfli) as u64,
1686+
(level - $best_non_zopfli) as u64,
16861687
)
16871688
.unwrap(),
16881689
..Default::default()
@@ -1702,9 +1703,23 @@ impl<W: Write + Seek> GenericZipWriter<W> {
17021703
zopfli::DeflateEncoder::new(options, Default::default(), bare),
17031704
),
17041705
}));
1706+
};
1707+
}
1708+
1709+
#[cfg(all(feature = "deflate-zopfli", feature = "deflate-flate2"))]
1710+
{
1711+
let best_non_zopfli = Compression::best().level();
1712+
if level > best_non_zopfli {
1713+
deflate_zopfli_and_return!(bare, best_non_zopfli);
17051714
}
17061715
}
17071716

1717+
#[cfg(all(feature = "deflate-zopfli", not(feature = "deflate-flate2")))]
1718+
{
1719+
let best_non_zopfli = 9;
1720+
deflate_zopfli_and_return!(bare, best_non_zopfli);
1721+
}
1722+
17081723
#[cfg(feature = "deflate-flate2")]
17091724
{
17101725
Ok(Box::new(move |bare| {
@@ -1838,18 +1853,15 @@ impl<W: Write + Seek> GenericZipWriter<W> {
18381853

18391854
#[cfg(feature = "_deflate-any")]
18401855
fn deflate_compression_level_range() -> std::ops::RangeInclusive<i64> {
1841-
let min = if cfg!(feature = "deflate-flate2") {
1842-
Compression::fast().level() as i64
1843-
} else {
1844-
Compression::best().level() as i64 + 1
1845-
};
1856+
#[cfg(feature = "deflate-flate2")]
1857+
let min = Compression::fast().level() as i64;
1858+
#[cfg(all(feature = "deflate-zopfli", not(feature = "deflate-flate2")))]
1859+
let min = 1;
18461860

1847-
let max = Compression::best().level() as i64
1848-
+ if cfg!(feature = "deflate-zopfli") {
1849-
u8::MAX as i64
1850-
} else {
1851-
0
1852-
};
1861+
#[cfg(feature = "deflate-zopfli")]
1862+
let max = 264;
1863+
#[cfg(all(feature = "deflate-flate2", not(feature = "deflate-zopfli")))]
1864+
let max = Compression::best().level() as i64;
18531865

18541866
min..=max
18551867
}
@@ -2001,7 +2013,9 @@ mod test {
20012013
use crate::zipcrypto::ZipCryptoKeys;
20022014
use crate::CompressionMethod::Stored;
20032015
use crate::ZipArchive;
2004-
use std::io::{Cursor, Read, Write};
2016+
#[cfg(feature = "deflate-flate2")]
2017+
use std::io::Read;
2018+
use std::io::{Cursor, Write};
20052019
use std::marker::PhantomData;
20062020
use std::path::PathBuf;
20072021

@@ -2156,14 +2170,18 @@ mod test {
21562170
assert_eq!(result.get_ref(), &v);
21572171
}
21582172

2173+
#[cfg(feature = "deflate-flate2")]
21592174
const RT_TEST_TEXT: &str = "And I can't stop thinking about the moments that I lost to you\
21602175
And I can't stop thinking of things I used to do\
21612176
And I can't stop making bad decisions\
21622177
And I can't stop eating stuff you make me chew\
21632178
I put on a smile like you wanna see\
21642179
Another day goes by that I long to be like you";
2180+
#[cfg(feature = "deflate-flate2")]
21652181
const RT_TEST_FILENAME: &str = "subfolder/sub-subfolder/can't_stop.txt";
2182+
#[cfg(feature = "deflate-flate2")]
21662183
const SECOND_FILENAME: &str = "different_name.xyz";
2184+
#[cfg(feature = "deflate-flate2")]
21672185
const THIRD_FILENAME: &str = "third_name.xyz";
21682186

21692187
#[test]
@@ -2219,6 +2237,7 @@ mod test {
22192237
}
22202238

22212239
#[test]
2240+
#[cfg(feature = "deflate-flate2")]
22222241
fn test_shallow_copy() {
22232242
let mut writer = ZipWriter::new(Cursor::new(Vec::new()));
22242243
let options = FileOptions {
@@ -2269,6 +2288,7 @@ mod test {
22692288
}
22702289

22712290
#[test]
2291+
#[cfg(feature = "deflate-flate2")]
22722292
fn test_deep_copy() {
22732293
let mut writer = ZipWriter::new(Cursor::new(Vec::new()));
22742294
let options = FileOptions {
@@ -2440,6 +2460,7 @@ mod test {
24402460
}
24412461

24422462
#[test]
2463+
#[cfg(feature = "deflate-flate2")]
24432464
fn remove_shallow_copy_keeps_original() -> ZipResult<()> {
24442465
let mut writer = ZipWriter::new(Cursor::new(Vec::new()));
24452466
writer

‎tests/end_to_end.rs‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,20 @@ use zip::{CompressionMethod, ZipWriter, SUPPORTED_COMPRESSION_METHODS};
1313
#[test]
1414
fn end_to_end() {
1515
for &method in SUPPORTED_COMPRESSION_METHODS {
16+
if method == CompressionMethod::DEFLATE
17+
&& cfg!(all(
18+
feature = "deflate-zopfli",
19+
not(feature = "deflate-flate2")
20+
))
21+
{
22+
// We do not support DEFLATE decompression without the `flate2` feature.
23+
continue;
24+
}
25+
1626
if method == CompressionMethod::DEFLATE64 {
1727
continue;
1828
}
29+
1930
let file = &mut Cursor::new(Vec::new());
2031

2132
println!("Writing file with {method} compression");
@@ -32,9 +43,20 @@ fn end_to_end() {
3243
#[test]
3344
fn copy() {
3445
for &method in SUPPORTED_COMPRESSION_METHODS {
46+
if method == CompressionMethod::DEFLATE
47+
&& cfg!(all(
48+
feature = "deflate-zopfli",
49+
not(feature = "deflate-flate2")
50+
))
51+
{
52+
// We do not support DEFLATE decompression without the `flate2` feature.
53+
continue;
54+
}
55+
3556
if method == CompressionMethod::DEFLATE64 {
3657
continue;
3758
}
59+
3860
let src_file = &mut Cursor::new(Vec::new());
3961
write_test_archive(src_file, method, false);
4062

@@ -74,9 +96,20 @@ fn copy() {
7496
#[test]
7597
fn append() {
7698
for &method in SUPPORTED_COMPRESSION_METHODS {
99+
if method == CompressionMethod::DEFLATE
100+
&& cfg!(all(
101+
feature = "deflate-zopfli",
102+
not(feature = "deflate-flate2")
103+
))
104+
{
105+
// We do not support DEFLATE decompression without the `flate2` feature.
106+
continue;
107+
}
108+
77109
if method == CompressionMethod::DEFLATE64 {
78110
continue;
79111
}
112+
80113
for shallow_copy in &[false, true] {
81114
println!("Writing file with {method} compression, shallow_copy {shallow_copy}");
82115
let mut file = &mut Cursor::new(Vec::new());

‎tests/extract_symlink.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#[test]
2-
#[cfg(all(unix, feature = "_deflate-any"))]
2+
#[cfg(all(unix, feature = "deflate-flate2"))]
33
fn extract_should_respect_links() {
44
use std::{fs, io, path::PathBuf, str::FromStr};
55
use tempfile::TempDir;

‎tests/repro_old423.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#[cfg(all(unix, feature = "_deflate-any"))]
1+
#[cfg(all(unix, feature = "deflate-flate2"))]
22
#[test]
33
fn repro_old423() -> zip::result::ZipResult<()> {
44
use std::io;

‎tests/root_dir.rs‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
1+
#[cfg(feature = "deflate-flate2")]
12
use std::fs;
2-
use std::io::{Read, Write};
3-
use std::path::{Path, PathBuf};
3+
#[cfg(feature = "deflate-flate2")]
4+
use std::io::Read;
5+
use std::io::Write;
6+
#[cfg(feature = "deflate-flate2")]
7+
use std::path::Path;
8+
use std::path::PathBuf;
9+
#[cfg(feature = "deflate-flate2")]
410
use tempfile::TempDir;
511
use zip::read::root_dir_common_filter;
612
use zip::write::SimpleFileOptions;
@@ -153,6 +159,7 @@ fn test_root_dir_with_multiple_root_dirs() {
153159
}
154160

155161
#[test]
162+
#[cfg(feature = "deflate-flate2")]
156163
fn test_extract_without_root_dir() {
157164
let zip_data = create_zip_with_root_dir();
158165
let mut archive = ZipArchive::new(std::io::Cursor::new(zip_data)).unwrap();
@@ -180,6 +187,7 @@ fn test_extract_without_root_dir() {
180187
}
181188

182189
#[test]
190+
#[cfg(feature = "deflate-flate2")]
183191
fn test_extract_without_root_dir_but_no_root_found() {
184192
let zip_data = create_zip_without_root_dir();
185193
let mut archive = ZipArchive::new(std::io::Cursor::new(zip_data)).unwrap();
@@ -197,6 +205,7 @@ fn test_extract_without_root_dir_but_no_root_found() {
197205
}
198206

199207
#[test]
208+
#[cfg(feature = "deflate-flate2")]
200209
fn test_extract_without_root_dir_with_ds_store() {
201210
let zip_data = create_zip_with_root_dir_and_ds_store();
202211
let mut archive = ZipArchive::new(std::io::Cursor::new(zip_data)).unwrap();
@@ -219,6 +228,7 @@ fn test_extract_without_root_dir_with_ds_store() {
219228
}
220229

221230
#[test]
231+
#[cfg(feature = "deflate-flate2")]
222232
fn test_custom_root_dir_filter() {
223233
let zip_data = create_zip_with_root_dir();
224234
let mut archive = ZipArchive::new(std::io::Cursor::new(zip_data)).unwrap();

0 commit comments

Comments
 (0)