Make crypto validate methods return ZipError when signifying invalid passwords

Signed-off-by: Johannes Löthberg <johannes.loethberg@elokon.com>

src/aes.rs

@@ -4,9 +4,9 @@
 //! Note that using CRC with AES depends on the used encryption specification, AE-1 or AE-2.
 //! If the file is marked as encrypted with AE-2 the CRC field is ignored, even if it isn't set to 0.
 
-use crate::aes_ctr;
 use crate::aes_ctr::AesCipher;
 use crate::types::AesMode;
+use crate::{aes_ctr, result::ZipError};
 use constant_time_eq::constant_time_eq;
 use hmac::{Hmac, Mac};
 use rand::RngCore;
@@ -84,12 +84,7 @@ impl<R: Read> AesReader<R> {
     /// password was provided.
     /// It isn't possible to check the authentication code in this step. This will be done after
     /// reading and decrypting the file.
-    ///
+    pub fn validate(mut self, password: &[u8]) -> Result<AesReaderValid<R>, ZipError> {
-    /// # Returns
-    ///
-    /// If the password verification failed `Ok(None)` will be returned to match the validate
-    /// method of ZipCryptoReader.
-    pub fn validate(mut self, password: &[u8]) -> io::Result<Option<AesReaderValid<R>>> {
         let salt_length = self.aes_mode.salt_length();
         let key_length = self.aes_mode.key_length();
 
@@ -115,19 +110,19 @@ impl<R: Read> AesReader<R> {
         // the last 2 bytes should equal the password verification value
         if pwd_verification_value != pwd_verify {
             // wrong password
-            return Ok(None);
+            return Err(ZipError::InvalidPassword);
         }
 
         let cipher = Cipher::from_mode(self.aes_mode, decrypt_key);
         let hmac = Hmac::<Sha1>::new_from_slice(hmac_key).unwrap();
 
-        Ok(Some(AesReaderValid {
+        Ok(AesReaderValid {
             reader: self.reader,
             data_remaining: self.data_length,
             cipher,
             hmac,
             finalized: false,
-        }))
+        })
     }
 }
 
@@ -309,11 +304,12 @@ mod tests {
 
     use crate::{
         aes::{AesReader, AesWriter},
+        result::ZipError,
         types::AesMode,
     };
 
     /// Checks whether `AesReader` can successfully decrypt what `AesWriter` produces.
-    fn roundtrip(aes_mode: AesMode, password: &[u8], plaintext: &[u8]) -> io::Result<bool> {
+    fn roundtrip(aes_mode: AesMode, password: &[u8], plaintext: &[u8]) -> Result<bool, ZipError> {
         let mut buf = io::Cursor::new(vec![]);
         let mut read_buffer = vec![];
 
@@ -329,15 +325,7 @@ mod tests {
         {
             let compressed_length = buf.get_ref().len() as u64;
             let mut reader =
-                match AesReader::new(&mut buf, aes_mode, compressed_length).validate(password)? {
+                AesReader::new(&mut buf, aes_mode, compressed_length).validate(password)?;
-                    None => {
-                        return Err(io::Error::new(
-                            io::ErrorKind::InvalidData,
-                            "Invalid authentication code",
-                        ))
-                    }
-                    Some(r) => r,
-                };
             reader.read_to_end(&mut read_buffer)?;
         }
 

src/read.rs

@@ -256,25 +256,17 @@ pub(crate) fn make_crypto_reader<'a>(
             ))
         }
         #[cfg(feature = "aes-crypto")]
-        (Some(password), Some((aes_mode, vendor_version, _))) => {
+        (Some(password), Some((aes_mode, vendor_version, _))) => CryptoReader::Aes {
-            match AesReader::new(reader, aes_mode, compressed_size).validate(password)? {
+            reader: AesReader::new(reader, aes_mode, compressed_size).validate(password)?,
-                None => return Err(InvalidPassword),
+            vendor_version,
-                Some(r) => CryptoReader::Aes {
+        },
-                    reader: r,
-                    vendor_version,
-                },
-            }
-        }
         (Some(password), None) => {
             let validator = if using_data_descriptor {
                 ZipCryptoValidator::InfoZipMsdosTime(last_modified_time.timepart())
             } else {
                 ZipCryptoValidator::PkzipCrc32(crc32)
             };
-            match ZipCryptoReader::new(reader, password).validate(validator)? {
+            CryptoReader::ZipCrypto(ZipCryptoReader::new(reader, password).validate(validator)?)
-                None => return Err(InvalidPassword),
-                Some(r) => CryptoReader::ZipCrypto(r),
-            }
         }
         (None, Some(_)) => return Err(InvalidPassword),
         (None, None) => CryptoReader::Plaintext(reader),

src/zipcrypto.rs

@@ -7,6 +7,8 @@ use std::fmt::{Debug, Formatter};
 use std::hash::Hash;
 use std::num::Wrapping;
 
+use crate::result::ZipError;
+
 /// A container to hold the current key state
 #[cfg_attr(fuzzing, derive(arbitrary::Arbitrary))]
 #[derive(Clone, Copy, Hash, Ord, PartialOrd, Eq, PartialEq)]
@@ -110,7 +112,7 @@ impl<R: std::io::Read> ZipCryptoReader<R> {
     pub fn validate(
         mut self,
         validator: ZipCryptoValidator,
-    ) -> Result<Option<ZipCryptoReaderValid<R>>, std::io::Error> {
+    ) -> Result<ZipCryptoReaderValid<R>, ZipError> {
         // ZipCrypto prefixes a file with a 12 byte header
         let mut header_buf = [0u8; 12];
         self.file.read_exact(&mut header_buf)?;
@@ -125,7 +127,7 @@ impl<R: std::io::Read> ZipCryptoReader<R> {
                 // We also use 1 byte CRC.
 
                 if (crc32_plaintext >> 24) as u8 != header_buf[11] {
-                    return Ok(None); // Wrong password
+                    return Err(ZipError::InvalidPassword);
                 }
             }
             ZipCryptoValidator::InfoZipMsdosTime(last_mod_time) => {
@@ -137,12 +139,12 @@ impl<R: std::io::Read> ZipCryptoReader<R> {
                 // We check only 1 byte.
 
                 if (last_mod_time >> 8) as u8 != header_buf[11] {
-                    return Ok(None); // Wrong password
+                    return Err(ZipError::InvalidPassword);
                 }
             }
         }
 
-        Ok(Some(ZipCryptoReaderValid { reader: self }))
+        Ok(ZipCryptoReaderValid { reader: self })
     }
 }
 #[allow(unused)]