minizip-ng

minizip-ng

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

Developed and maintained by Nathan Moinvaziri.

Branches

Name	Description
develop	Latest development code.
master	Most recent stable release.
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.
• Support for large files with ZIP64 extension.
• Zlib, BZIP2, LZMA, PPMD, 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.
• Recover the central directory if it is corrupt or missing.
• Example minizip and minigzip command line tools.

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 -S . -B build -D MZ_BUILD_TESTS=ON
cmake --build build

Build Options

Name	Description	Default Value
MZ_COMPAT	Enables compatibility layer	ON
MZ_ZLIB	Enables ZLIB compression	ON
MZ_ZLIB_FLAVOR	Select ZLIB implementation (auto, zlib-ng, zlib)	auto
MZ_BZIP2	Enables BZIP2 compression	ON
MZ_LZMA	Enables LZMA & XZ compression	ON
MZ_PPMD	Enables PPMD compression	ON
MZ_ZSTD	Enables ZSTD compression	ON
MZ_LIBCOMP	Enables Apple compression	APPLE
MZ_FETCH_LIBS	Enables fetching third-party libraries if not found	WIN32
MZ_FORCE_FETCH_LIBS	Enables fetching third-party libraries always	OFF
MZ_PKCRYPT	Enables PKWARE traditional encryption	ON
MZ_WZAES	Enables WinZIP AES encryption	ON
MZ_OPENSSL	Enables OpenSSL encryption	UNIX
MZ_LIBBSD	Builds with libbsd crypto random	UNIX
MZ_ICONV	Enables iconv encoding conversion	ON
MZ_ICU	Enables ICU encoding conversion	OFF
MZ_COMPRESS_ONLY	Only support compression	OFF
MZ_DECOMPRESS_ONLY	Only support decompression	OFF
MZ_FILE32_API	Builds using posix 32-bit file api	OFF
MZ_BUILD_TESTS	Builds minizip test executable	OFF
MZ_BUILD_UNIT_TESTS	Builds minizip unit test project	OFF
MZ_BUILD_FUZZ_TESTS	Builds minizip fuzz executables	OFF
MZ_CODE_COVERAGE	Build with code coverage flags	OFF
MZ_SANITIZER	Build with code sanitizer (Memory, Thread, Address, Undefined)	OFF
MZ_LIB_SUFFIX	Library name suffix for packaging

Test

Unit tests are written in C++ with Google Test.

cmake -S . -B build -D MZ_BUILD_TESTS=ON -D MZ_BUILD_UNIT_TESTS=ON
cmake --build build
ctest --test-dir build --output-on-failure

Lint

Pull requests are checked with clang-format 19 using the rules in .clang-format.

git clang-format --diff --commit=origin/develop

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.
ppmd	Public domain	MZ_PPMD	Written by Igor Pavlov.
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.