Merge pull request #50 from NSProgrammer/zip_test

NSProgrammer · web-flow · commit 7e16682d69ca · 2017-02-20T11:05:14.000-08:00
add `zip -T` like validation
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,14 @@
 
 ## History
 
+### 1.9.3 (Feb 20, 2017) - Nolan O'Brien
+
+- add checksum error code and record validation method to unzipper
+
+### 1.9.2 (Feb 19, 2017) - Nolan O'Brien
+
+- updated zstd to v1.1.3
+
 ### 1.9.1 (Jan 31, 2017) - Nolan O'Brien
 
 - Miscellaneous minor fixes
diff --git a/README.md b/README.md
@@ -32,7 +32,7 @@ Alternatively you may use one of the following dependency managers:
 Add _ZipUtilities_ to your `Podfile`
 
 ```ruby
-pod 'ZipUtilities', '~> 1.9.1'
+pod 'ZipUtilities', '~> 1.9.3'
 ```
 
 #### Carthage
diff --git a/ZipUtilities.podspec b/ZipUtilities.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name         = "ZipUtilities"
-  s.version      = "1.9.1"
+  s.version      = "1.9.3"
   s.summary      = "Zip Archiving, Unarchiving and Utilities in Objective-C"
   s.description  = <<-DESC
 					ZipUtilities, prefixed with NOZ for Nolan O'Brien ZipUtilities, is a library of zipping and unzipping utilities for iOS and Mac OS X.
diff --git a/ZipUtilities.xcodeproj/project.pbxproj b/ZipUtilities.xcodeproj/project.pbxproj
@@ -276,6 +276,9 @@
 		8BAE42591E5A9E4200AFD299 /* zstd_common.c in Sources */ = {isa = PBXBuildFile; fileRef = 8BAE42411E5A9E4200AFD299 /* zstd_common.c */; settings = {COMPILER_FLAGS = "-w -Xanalyzer -analyzer-disable-all-checks"; }; };
 		8BAE425A1E5A9E4200AFD299 /* zstd_errors.h in Headers */ = {isa = PBXBuildFile; fileRef = 8BAE42421E5A9E4200AFD299 /* zstd_errors.h */; };
 		8BAE425B1E5A9E4200AFD299 /* zstd_internal.h in Headers */ = {isa = PBXBuildFile; fileRef = 8BAE42431E5A9E4200AFD299 /* zstd_internal.h */; };
+		8BAE425D1E5AAFFE00AFD299 /* Bad_File.zip in Resources */ = {isa = PBXBuildFile; fileRef = 8BAE425C1E5AAFFE00AFD299 /* Bad_File.zip */; };
+		8BAE425E1E5AB56C00AFD299 /* Bad_File.zip in Resources */ = {isa = PBXBuildFile; fileRef = 8BAE425C1E5AAFFE00AFD299 /* Bad_File.zip */; };
+		8BAE425F1E5AB56C00AFD299 /* Bad_File.zip in Resources */ = {isa = PBXBuildFile; fileRef = 8BAE425C1E5AAFFE00AFD299 /* Bad_File.zip */; };
 		8BDA6F921DDD7524004EEF12 /* ZipUtilities.framework in Embed Frameworks */ = {isa = PBXBuildFile; fileRef = 4623A82E1B9A828A00A56535 /* ZipUtilities.framework */; settings = {ATTRIBUTES = (CodeSignOnCopy, RemoveHeadersOnCopy, ); }; };
 		B3F87BF51CF4C09600FBBFEF /* module.modulemap in Headers */ = {isa = PBXBuildFile; fileRef = B3F87BF41CF4C08A00FBBFEF /* module.modulemap */; settings = {ATTRIBUTES = (Public, ); }; };
 		B3F87BF61CF4C21600FBBFEF /* ZipUtilities.h in Headers */ = {isa = PBXBuildFile; fileRef = 4623A8321B9A828A00A56535 /* ZipUtilities.h */; settings = {ATTRIBUTES = (Public, ); }; };
@@ -602,6 +605,7 @@
 		8BAE42411E5A9E4200AFD299 /* zstd_common.c */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.c; name = zstd_common.c; path = Extra/zstd/common/zstd_common.c; sourceTree = "<group>"; };
 		8BAE42421E5A9E4200AFD299 /* zstd_errors.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = zstd_errors.h; path = Extra/zstd/common/zstd_errors.h; sourceTree = "<group>"; };
 		8BAE42431E5A9E4200AFD299 /* zstd_internal.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = zstd_internal.h; path = Extra/zstd/common/zstd_internal.h; sourceTree = "<group>"; };
+		8BAE425C1E5AAFFE00AFD299 /* Bad_File.zip */ = {isa = PBXFileReference; lastKnownFileType = archive.zip; path = Bad_File.zip; sourceTree = "<group>"; };
 		B3F87BF41CF4C08A00FBBFEF /* module.modulemap */ = {isa = PBXFileReference; lastKnownFileType = "sourcecode.module-map"; path = module.modulemap; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
@@ -840,6 +844,7 @@
 			children = (
 				1CD9BAB31B757A38000B93C4 /* Aesop.txt */,
 				8B3C0CEC1DDCEAAE000C7DE1 /* book.zstd_dict */,
+				8BAE425C1E5AAFFE00AFD299 /* Bad_File.zip */,
 				1C3223841B78501A00DC0A33 /* Data.zip */,
 				1CD9BAB81B75B419000B93C4 /* Directory.zip */,
 				1CD9BAB91B75B419000B93C4 /* File.zip */,
@@ -1489,6 +1494,7 @@
 				1C3223851B78501A00DC0A33 /* Data.zip in Resources */,
 				1CD9BABD1B75B419000B93C4 /* File.zip in Resources */,
 				1C2DFB3B1C207E7700C9A238 /* Star.Wars.7.Trailer.mp4.zip in Resources */,
+				8BAE425D1E5AAFFE00AFD299 /* Bad_File.zip in Resources */,
 				8B8D5AA81DDD2E9100037E0E /* htl.512.zstd_dict in Resources */,
 				1CD9BAB41B757A38000B93C4 /* Aesop.txt in Resources */,
 				8B8D5AAB1DDD2E9100037E0E /* htl.1024.zstd_dict in Resources */,
@@ -1517,6 +1523,7 @@
 				4623A89A1B9A882700A56535 /* File.zip in Resources */,
 				4623A89B1B9A882700A56535 /* Mixed.zip in Resources */,
 				1C2DFB3C1C207E7700C9A238 /* Star.Wars.7.Trailer.mp4.zip in Resources */,
+				8BAE425E1E5AB56C00AFD299 /* Bad_File.zip in Resources */,
 				8B8D5AA91DDD2E9100037E0E /* htl.512.zstd_dict in Resources */,
 				4623A8991B9A882700A56535 /* Directory.zip in Resources */,
 				8B8D5AAC1DDD2E9100037E0E /* htl.1024.zstd_dict in Resources */,
@@ -1545,6 +1552,7 @@
 				4623A89F1B9A882800A56535 /* File.zip in Resources */,
 				4623A8A01B9A882800A56535 /* Mixed.zip in Resources */,
 				1C2DFB3D1C207E7700C9A238 /* Star.Wars.7.Trailer.mp4.zip in Resources */,
+				8BAE425F1E5AB56C00AFD299 /* Bad_File.zip in Resources */,
 				8B8D5AAA1DDD2E9100037E0E /* htl.512.zstd_dict in Resources */,
 				4623A89E1B9A882800A56535 /* Directory.zip in Resources */,
 				8B8D5AAD1DDD2E9100037E0E /* htl.1024.zstd_dict in Resources */,
diff --git a/ZipUtilities/Info.plist b/ZipUtilities/Info.plist
@@ -15,7 +15,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>1.9.1</string>
+	<string>1.9.3</string>
 	<key>CFBundleSignature</key>
 	<string>????</string>
 	<key>CFBundleVersion</key>
diff --git a/ZipUtilities/NOZError.h b/ZipUtilities/NOZError.h
@@ -155,6 +155,8 @@ typedef NS_ENUM(NSInteger, NOZErrorCode)
     NOZErrorCodeUnzipCannotReadFileEntry,
     /** Unzipper couldn't decompress a file entry */
     NOZErrorCodeUnzipCannotDecompressFileEntry,
+    /** Unzipping data didn't match CRC32 checksum */
+    NOZErrorCodeUnzipChecksumMissmatch,
     /** An entry failed to be decompressed */
     NOZErrorCodeUnzipFailedToDecompressEntry,
 };
diff --git a/ZipUtilities/NOZUnzipper.h b/ZipUtilities/NOZUnzipper.h
@@ -244,6 +244,13 @@ typedef NS_OPTIONS(NSInteger, NOZUnzipperSaveRecordOptions)
      progressBlock:(nullable NOZProgressBlock)progressBlock
              error:(out NSError *__autoreleasing  __nullable * __nullable)error;
 
+/**
+ Validate a record.
+ */
+- (BOOL)validateRecord:(nonnull NOZCentralDirectoryRecord *)record
+         progressBlock:(nullable NOZProgressBlock)progressBlock
+                 error:(out NSError *__autoreleasing __nullable * __nullable)error;
+
 /**
  *DEPRECATED*: See `saveRecord:toDirectory:options:progressBlock:error:`
  */
diff --git a/ZipUtilities/NOZUnzipper.m b/ZipUtilities/NOZUnzipper.m
@@ -395,6 +395,18 @@ - (BOOL)saveRecord:(NOZCentralDirectoryRecord *)record
     return YES;
 }
 
+- (BOOL)validateRecord:(NOZCentralDirectoryRecord *)record
+         progressBlock:(NOZProgressBlock)progressBlock
+                 error:(out NSError **)error
+{
+    return [self enumerateByteRangesOfRecord:record
+                               progressBlock:progressBlock
+                                  usingBlock:^(const void * __nonnull bytes, NSRange byteRange, BOOL * __nonnull stop) {
+                                      (void)bytes;
+                                  }
+                                       error:error];
+}
+
 @end
 
 @implementation NOZUnzipper (Private)
@@ -572,8 +584,17 @@ - (BOOL)private_deflateWithProgressBlock:(NOZProgressBlock)progressBlock
 
     } // while (...)
 
-    if (stop || (_currentUnzipping.crc32 != _currentUnzipping.entry->fileDescriptor.crc32)) {
+    if (stop) {
+        success = NO;
+        return NO;
+    }
+
+    if (_currentUnzipping.crc32 != _currentUnzipping.entry->fileDescriptor.crc32) {
         success = NO;
+        if (error) {
+            *error = NOZError(NOZErrorCodeUnzipChecksumMissmatch, nil);
+        }
+
         return NO;
     }
 
diff --git a/ZipUtilities/OSX-Info.plist b/ZipUtilities/OSX-Info.plist
@@ -15,7 +15,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>1.9.1</string>
+	<string>1.9.3</string>
 	<key>CFBundleSignature</key>
 	<string>????</string>
 	<key>CFBundleVersion</key>
diff --git a/ZipUtilitiesTests/Bad_File.zip b/ZipUtilitiesTests/Bad_File.zip
diff --git a/ZipUtilitiesTests/NOZSwiftTests.swift b/ZipUtilitiesTests/NOZSwiftTests.swift
@@ -242,4 +242,39 @@ func TearDownZipQueue()
         }
     }
 
+    func testValidateZip() {
+        var unzipper: NOZUnzipper
+
+        let goodFilePath = try! NOZSwiftDecompressionTests.prepareZipFileForDecompression("File")
+        unzipper = NOZUnzipper.init(zipFile: goodFilePath)
+        try! unzipper.open()
+        try! unzipper.readCentralDirectory()
+        unzipper.enumerateManifestEntries({ record, index, stop in
+            var caughtError: NSError? = nil
+            do {
+                try unzipper.validate(record, progressBlock: nil)
+            } catch let error as NSError {
+                caughtError = error
+            }
+            XCTAssertNil(caughtError)
+        })
+        try! unzipper.close()
+
+        let badFilePath = try! NOZSwiftDecompressionTests.prepareZipFileForDecompression("Bad_File")
+        unzipper = NOZUnzipper.init(zipFile: badFilePath)
+        try! unzipper.open()
+        try! unzipper.readCentralDirectory()
+        var didEncouterError: Bool = false
+        unzipper.enumerateManifestEntries({ record, index, stop in
+            do {
+                try unzipper.validate(record, progressBlock: nil)
+            } catch let error as NSError {
+                XCTAssertEqual(NOZErrorCode.init(rawValue: error.code), NOZErrorCode.unzipChecksumMissmatch)
+                didEncouterError = true
+            }
+        })
+        XCTAssertTrue(didEncouterError)
+        try! unzipper.close()
+    }
+
 }
