Repository files navigation

ZipArchive is a simple utility class for zipping and unzipping files on iOS, macOS, tvOS, watchOS and visionOS.

• Unzip zip files;
• Unzip password protected zip files;
• Unzip AES encrypted zip files;
• Create zip files;
• Create large (> 4.3Gb) files;
• Create password protected zip files;
• Create AES encrypted zip files;
• Choose compression level;
• Zip-up NSData instances. (with a filename)

A key dependency of this project is the zlib library. zlib before version 1.2.12 allows memory corruption when deflating (i.e., when compressing) if the input has many distant matches according toCVE-2018-25032.

zlib 1.2.12 is included in macOS 10.15+ (with latest security patches), iOS 15.5+, tvOS 15.4+, watchOS 8.4+.As such, these OS versions will be the new minimums as of version 2.5.0 of ZipArchive.

If you need support for previous versions of ZipArchive for earlier OS support you can target an earlier version but know you will be using an unmaintained version of this library.

We will not support versions of ZipArchive that use dependencies with known vulnerabilities.

The main release branch is configured to support Objective-C and Swift 4+.

SSZipArchive works on:

• Xcode 12 and above
• iOS 15.5 and above
• macOS 10.15 and above
• tvOS 15.4 and above
• visionOS 1.0 and above
• watchOS 8.4 and above

In your Podfile:
pod 'SSZipArchive'

You should define your minimum deployment target explicitly, like:platform :ios, '15.5'

Recommended CocoaPods version should be at least CocoaPods 1.7.5.

Add a Swift Package reference tohttps://github.com/ZipArchive/ZipArchive.git (SSZipArchive 2.5.0 and higher or master)

In your Cartfile:
github "ZipArchive/ZipArchive"

We do not release a Carthage pre-built package. Developers are encouraged to build one themselves.

1. Add theSSZipArchive andminizip folders to your project.
2. Add thelibz andlibiconv libraries to your target.
3. Add theSecurity framework to your target.
4. Add the following GCC_PREPROCESSOR_DEFINITIONS:HAVE_ARC4RANDOM_BUF HAVE_ICONV HAVE_INTTYPES_H HAVE_PKCRYPT HAVE_STDINT_H HAVE_WZAES HAVE_ZLIB ZLIB_COMPAT $(inherited).

SSZipArchive requires ARC.

//Import "#import <ZipArchive.h>" for SPM/Carthage, and "#import <SSZipArchive.h>" for CocoaPods.// Create[SSZipArchivecreateZipFileAtPath:zipPathwithContentsOfDirectory:sampleDataPath];// Unzip[SSZipArchiveunzipFileAtPath:zipPathtoDestination:unzipPath];

//Import "import ZipArchive" for SPM/Carthage, and "import SSZipArchive" for CocoaPods.// CreateSSZipArchive.createZipFileAtPath(zipPath, withContentsOfDirectory: sampleDataPath)// UnzipSSZipArchive.unzipFileAtPath(zipPath, toDestination: unzipPath)

SSZipArchive is protected under theMIT license and our slightly modified version ofminizip-ng (formally minizip) 3.0.10 is licensed under theZlib license.

• Big thanks toaish for creatingZipArchive. The project that inspired SSZipArchive.
• Thank you@soffes for the actual name of SSZipArchive.
• Thank you@randomsequence for implementing the creation support tech.
• Thank you@johnezang for all his amazing help along the way.
• Thank you@nmoinvaz for minizip-ng (formally minizip), the core of ZipArchive.
• Thank you toall the contributors.