feat: Interpret data descriptors when reading zip file from (read, nonseek) stream

examples/stdin_info.rs

@@ -10,7 +10,15 @@ fn real_main() -> i32 {
     let mut buf = [0u8; 16];
 
     loop {
-        match zip::read::read_zipfile_from_stream(&mut stdin_handle) {
+        let file = match zip::read::read_zipfile_from_stream(&mut stdin_handle) {
+            Err(e) => {
+                println!("Error encountered while reading zip: {e:?}");
+                return 1;
+            }
+            Ok(value) => value,
+        };
+
+        match file.unwrap_or_error("data descriptors not supported while reading stdin") {
             Ok(Some(mut file)) => {
                 println!(
                     "{}: {} bytes ({} bytes packed)",

src/aes.rs

@@ -219,6 +219,10 @@ impl<R: Read> AesReaderValid<R> {
     pub fn into_inner(self) -> R {
         self.reader
     }
+
+    pub fn get_ref(&self) -> &R {
+        &self.reader
+    }
 }
 
 pub struct AesWriter<W> {

src/crc32.rs

@@ -1,47 +1,49 @@
 //! Helper module to compute a CRC32 checksum
 
+use bzip2::read::BzDecoder;
 use std::io;
 use std::io::prelude::*;
+use std::io::BufReader;
 
+use crate::read::lzma::LzmaDecoder;
+use crate::read::CryptoReader;
 use crc32fast::Hasher;
+use deflate64::Deflate64Decoder;
+use flate2::read::DeflateDecoder;
 
 /// Reader that validates the CRC32 when it reaches the EOF.
-pub struct Crc32Reader<R> {
+pub struct Crc32Reader<R: ReadAndSupplyExpectedCRC32> {
     inner: R,
     hasher: Hasher,
-    check: u32,
     /// Signals if `inner` stores aes encrypted data.
     /// AE-2 encrypted data doesn't use crc and sets the value to 0.
     ae2_encrypted: bool,
 }
 
-impl<R> Crc32Reader<R> {
+impl<R: ReadAndSupplyExpectedCRC32> Crc32Reader<R> {
     /// Get a new Crc32Reader which checks the inner reader against checksum.
     /// The check is disabled if `ae2_encrypted == true`.
-    pub(crate) fn new(inner: R, checksum: u32, ae2_encrypted: bool) -> Crc32Reader<R> {
+    pub(crate) fn new(inner: R, ae2_encrypted: bool) -> Crc32Reader<R> {
         Crc32Reader {
             inner,
             hasher: Hasher::new(),
-            check: checksum,
             ae2_encrypted,
         }
     }
 
-    fn check_matches(&self) -> bool {
-        self.check == self.hasher.clone().finalize()
+    fn check_matches(&self) -> std::io::Result<bool> {
+        Ok(self.inner.get_crc32()? == self.hasher.clone().finalize())
     }
 
     pub fn into_inner(self) -> R {
         self.inner
     }
 }
 
-impl<R: Read> Read for Crc32Reader<R> {
+impl<R: ReadAndSupplyExpectedCRC32> Read for Crc32Reader<R> {
     fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
-        let invalid_check = !buf.is_empty() && !self.check_matches() && !self.ae2_encrypted;
-
         let count = match self.inner.read(buf) {
-            Ok(0) if invalid_check => {
+            Ok(0) if !buf.is_empty() && !self.check_matches()? && !self.ae2_encrypted => {
                 return Err(io::Error::new(io::ErrorKind::Other, "Invalid checksum"))
             }
             Ok(n) => n,
@@ -52,6 +54,117 @@
     }
 }
 
+/// A reader trait that provides a method to get the expected crc of the data read.
+/// In the normal case, the expected crc is known before the zip entry is read.
+/// In streaming mode with data descriptors, the crc will be available after the data is read.
+/// Still in both cases the crc is available after the data is read and can be checked.
+pub trait ReadAndSupplyExpectedCRC32: Read {
+    fn get_crc32(&self) -> std::io::Result<u32>;
+}
+
+pub struct InitiallyKnownCRC32<R: Read> {
+    reader: R,
+    crc: u32,
+}
+
+impl<R: Read> InitiallyKnownCRC32<R> {
+    pub fn new(reader: R, crc: u32) -> InitiallyKnownCRC32<R> {
+        InitiallyKnownCRC32 { reader, crc }
+    }
+
+    #[allow(dead_code)]
+    pub fn into_inner(self) -> R {
+        self.reader
+    }
+
+    #[allow(dead_code)]
+    pub fn get_ref(&self) -> &R {
+        &self.reader
+    }
+}
+
+impl<R: Read> Read for InitiallyKnownCRC32<R> {
+    fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
+        self.reader.read(buf)
+    }
+}
+
+impl<R: Read> ReadAndSupplyExpectedCRC32 for InitiallyKnownCRC32<R> {
+    fn get_crc32(&self) -> std::io::Result<u32> {
+        Ok(self.crc)
+    }
+}
+
+impl<'a, T: ReadAndSupplyExpectedCRC32 + 'a> ReadAndSupplyExpectedCRC32 for CryptoReader<'a, T> {
+    fn get_crc32(&self) -> io::Result<u32> {
+        self.get_ref().get_crc32()
+    }
+}
+
+#[cfg(feature = "_deflate-any")]
+impl<T: ReadAndSupplyExpectedCRC32> ReadAndSupplyExpectedCRC32 for DeflateDecoder<T> {
+    fn get_crc32(&self) -> io::Result<u32> {
+        self.get_ref().get_crc32()
+    }
+}
+
+#[cfg(feature = "deflate64")]
+impl<T: ReadAndSupplyExpectedCRC32> ReadAndSupplyExpectedCRC32 for Deflate64Decoder<BufReader<T>> {
+    fn get_crc32(&self) -> io::Result<u32> {
+        self.get_ref().get_ref().get_crc32()
+    }
+}
+
+#[cfg(feature = "bzip2")]
+impl<T: ReadAndSupplyExpectedCRC32> ReadAndSupplyExpectedCRC32 for BzDecoder<T> {
+    fn get_crc32(&self) -> io::Result<u32> {
+        self.get_ref().get_crc32()
+    }
+}
+
+#[cfg(feature = "zstd")]
+impl<'a, T: ReadAndSupplyExpectedCRC32 + BufRead> ReadAndSupplyExpectedCRC32
+    for zstd::Decoder<'a, T>
+{
+    fn get_crc32(&self) -> io::Result<u32> {
+        self.get_ref().get_crc32()
+    }
+}
+
+#[cfg(feature = "zstd")]
+impl<'a, T: ReadAndSupplyExpectedCRC32> ReadAndSupplyExpectedCRC32
+    for zstd::Decoder<'a, BufReader<T>>
+{
+    fn get_crc32(&self) -> io::Result<u32> {
+        self.get_ref().get_ref().get_crc32()
+    }
+}
+
+#[cfg(feature = "lzma")]
+impl<T: ReadAndSupplyExpectedCRC32> ReadAndSupplyExpectedCRC32 for LzmaDecoder<T> {
+    fn get_crc32(&self) -> io::Result<u32> {
+        self.get_ref().get_crc32()
+    }
+}
+
+impl<'a> ReadAndSupplyExpectedCRC32 for Box<(dyn ReadAndSupplyExpectedCRC32 + 'a)> {
+    fn get_crc32(&self) -> io::Result<u32> {
+        self.as_ref().get_crc32()
+    }
+}
+
+impl<'a, T: ReadAndSupplyExpectedCRC32 + 'a> ReadAndSupplyExpectedCRC32 for Box<T> {
+    fn get_crc32(&self) -> io::Result<u32> {
+        self.as_ref().get_crc32()
+    }
+}
+
+impl<T: ReadAndSupplyExpectedCRC32> ReadAndSupplyExpectedCRC32 for std::io::Take<&mut T> {
+    fn get_crc32(&self) -> io::Result<u32> {
+        self.get_ref().get_crc32()
+    }
+}
+
 #[cfg(test)]
 mod test {
     use super::*;
@@ -61,10 +174,10 @@
         let data: &[u8] = b"";
         let mut buf = [0; 1];
 
-        let mut reader = Crc32Reader::new(data, 0, false);
+        let mut reader = Crc32Reader::new(InitiallyKnownCRC32::new(data, 0), false);
         assert_eq!(reader.read(&mut buf).unwrap(), 0);
 
-        let mut reader = Crc32Reader::new(data, 1, false);
+        let mut reader = Crc32Reader::new(InitiallyKnownCRC32::new(data, 1), false);
         assert!(reader
             .read(&mut buf)
             .unwrap_err()
@@ -77,7 +190,7 @@
         let data: &[u8] = b"1234";
         let mut buf = [0; 1];
 
-        let mut reader = Crc32Reader::new(data, 0x9be3e0a3, false);
+        let mut reader = Crc32Reader::new(InitiallyKnownCRC32::new(data, 0x9be3e0a3), false);
         assert_eq!(reader.read(&mut buf).unwrap(), 1);
         assert_eq!(reader.read(&mut buf).unwrap(), 1);
         assert_eq!(reader.read(&mut buf).unwrap(), 1);
@@ -92,7 +205,7 @@
         let data: &[u8] = b"1234";
         let mut buf = [0; 5];
 
-        let mut reader = Crc32Reader::new(data, 0x9be3e0a3, false);
+        let mut reader = Crc32Reader::new(InitiallyKnownCRC32::new(data, 0x9be3e0a3), false);
         assert_eq!(reader.read(&mut buf[..0]).unwrap(), 0);
         assert_eq!(reader.read(&mut buf).unwrap(), 4);
     }