Clone this repo:
  1. 6f17da5 Version 3.0.0. by Nathan Moinvaziri · 5 weeks ago master 3.0.0
  2. 67ffb1f Change release package name to be minizip-ng. by Nathan Moinvaziri · 5 weeks ago
  3. 0298319 Fixed out of source CI builds after name change. by Nathan Moinvaziri · 5 weeks ago
  4. db95894 Updated name of project to minizip-ng. by Nathan Moinvaziri · 5 weeks ago
  5. 14f45f9 Fixed default option values depending on platform not working. by Nathan Moinvaziri · 7 weeks ago

minizip-ng 3.0.0

minizip-ng is a zip manipulation library written in C that is supported on Windows, macOS, and Linux.

Master Branch Status Fuzzing Status Codacy Badge License: Zlib codecov.io

Developed and maintained by Nathan Moinvaziri.

Branches

|Name|Description| |:-|:-| |master|Most recent release.| |dev|Latest development code.| |1.2|Old changes to original minizip that includes WinZip AES encryption, disk splitting, I/O buffering and some additional fixes. Not ABI compatible with original minizip.| |1.1|Original minizip as of zlib 1.2.11.|

History

Minizip was originally developed by Gilles Vollant in 1998. It was first included in the zlib distribution as an additional code contribution starting in zlib 1.1.2. Since that time, it has been continually improved upon and contributed to by many people. The original project can still be found in the zlib distribution that is maintained by Mark Adler.

The motivation behind this repository has been the need for new features and bug fixes to the original library which had not been maintained for a long period of time. The code has been largely refactored and rewritten in order to help improve maintainability and readability. A compatibility layer has been provided for consumers of the original minizip library.

Features

  • Creating and extracting zip archives.
  • Adding and removing entries from zip archives.
  • Read and write raw zip entry data.
  • Reading and writing zip archives from memory.
  • Zlib, BZIP2, LZMA, XZ, and ZSTD compression methods.
  • Password protection through Traditional PKWARE and WinZIP AES encryption.
  • Buffered streaming for improved I/O performance.
  • NTFS timestamp support for UTC last modified, last accessed, and creation dates.
  • Disk split support for splitting zip archives into multiple files.
  • Preservation of file attributes across file systems.
  • Follow and store symbolic links.
  • Unicode filename support through UTF-8 encoding.
  • Legacy character encoding support CP437, CP932, CP936, CP950.
  • Turn off compilation of compression, decompression, or encryption.
  • Windows (Win32 & WinRT), macOS and Linux platform support.
  • Streaming interface for easy implementation of additional platforms.
  • Support for Apple's compression library ZLIB and XZ implementations.
  • Zero out local file header information.
  • Zip/unzip of central directory to reduce size.
  • Ability to generate and verify CMS signature for each entry.
  • Recover the central directory if it is corrupt or missing.
  • Example minizip command line tool.

Build

To generate project files for your platform:

  1. Download and install cmake (version 3.11 or later recommended).
  2. Run cmake in the minizip directory.
cmake . -DMZ_BUILD_TEST=ON
cmake --build .

Build Options

NameDescriptionDefault Value
MZ_COMPATEnables compatibility layerON
MZ_ZLIBEnables ZLIB compressionON
MZ_BZIP2Enables BZIP2 compressionON
MZ_LZMAEnables LZMA & XZ compressionON
MZ_ZSTDEnables ZSTD compressionON
MZ_LIBCOMPEnables Apple compressionAPPLE
MZ_FETCH_LIBSEnables fetching third-party libraries if not foundWIN32
MZ_FORCE_FETCH_LIBSEnables fetching third-party libraries alwaysOFF
MZ_PKCRYPTEnables PKWARE traditional encryptionON
MZ_WZAESEnables WinZIP AES encryptionON
MZ_OPENSSLEnables OpenSSL encryptionUNIX
MZ_LIBBSDBuilds with libbsd crypto randomUNIX
MZ_SIGNINGEnables zip signing supportON
MZ_ICONVEnables iconv encoding conversionON
MZ_COMPRESS_ONLYOnly support compressionOFF
MZ_DECOMPRESS_ONLYOnly support decompressionOFF
MZ_FILE32_APIBuilds using posix 32-bit file apiOFF
MZ_BUILD_TESTSBuilds minizip test executableOFF
MZ_BUILD_UNIT_TESTSBuilds minizip unit test projectOFF
MZ_BUILD_FUZZ_TESTSBuilds minizip fuzz executablesOFF
MZ_CODE_COVERAGEBuild with code coverage flagsOFF
MZ_PROJECT_SUFFIXProject name suffix for packaging

Third-Party Libraries

Third-party libraries may be required based on the CMake options selected. If the system already has the library installed then it will be used, otherwise CMake will retrieve the source code for the library from its official git repository and compile it in when the MZ_FETCH_LIBS option is enabled.

|Project|License|CMake Option|Comments| |-|-|-|-| bzip2|license|MZ_BZIP2|Written by Julian Seward.| |liblzma|Public domain|MZ_LZMA|Written by Igor Pavlov and Lasse Collin.| |zlib|zlib|MZ_ZLIB|Written by Mark Adler and Jean-loup Gailly. Or alternatively, zlib-ng by Hans Kristian Rosbach.| |zstd|BSD|MZ_ZSTD|Written by Facebook.|

This project uses the zlib license.

Acknowledgments

Thanks go out to all the people who have taken the time to contribute code reviews, testing and/or patches. This project would not have been as good without you.

Thanks to Gilles Vollant on which this work is originally based on.

The ZIP format was defined by Phil Katz of PKWARE.