README.md

minizip 2.8.6

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

Maintained by Nathan Moinvaziri.

Branches

Name State Version Description master Active 2.x Modern rewrite of 1.2 branch that includes more advanced features, improvements in code maintainability and readability, and the reduction of duplicate code. Compatibility layer provided for older versions. dev Active 2.x Latest development code 1.2 Stale 1.x Drop-in replacement for zlib's minizip that includes WinZip AES encryption, disk splitting, I/O buffering and some additional fixes. 1.1 Stale 1.x 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.

My work with the minizip library started in 2006 when I fixed a few bugs I found and submitted them to Gilles Vollant. In 2010, I implemented WinZip AES encryption, disk splitting, and I/O buffering that were necessary for another project I was working on. Shortly after, I created this public repository so I could share my improvements with the community. In early 2017, I began the work to refactor and rewrite the library as version 2 because it had become difficult to maintain and code readability suffered over the years.

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, and LZMA 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.
• 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 implementation.
• 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.
2. Run cmake in the minizip directory.

cmake . -DMZ_BUILD_TEST=ON
cmake --build .

Build Options

Name Description Default Value MZ_COMPAT Enables compatibility layer ON MZ_ZLIB Enables ZLIB compression ON MZ_BZIP2 Enables BZIP2 compression ON MZ_LZMA Enables LZMA compression ON MZ_PKCRYPT Enables PKWARE traditional encryption ON MZ_WZAES Enables WinZIP AES encryption ON MZ_LIBCOMP Enables Apple compression OFF MZ_OPENSSL Enables OpenSSL encryption OFF MZ_BRG Enables Brian Gladman's library OFF MZ_COMPRESS_ONLY Only support compression OFF MZ_DECOMPRESS_ONLY Only support decompression OFF MZ_BUILD_TEST Builds minizip test executable OFF MZ_BUILD_UNIT_TEST Builds minizip unit test project OFF MZ_BUILD_FUZZ_TEST Builds minizip fuzz executables OFF

Contents

File(s) Description minizip.c Sample application mz_compat.* Minizip 1.x compatibility layer mz.h Error codes and flags mz_os* Platform specific file/utility functions mz_crypt* Configuration specific crypto/hashing functions mz_strm.* Stream interface mz_strm_buf.* Buffered stream mz_strm_bzip.* BZIP2 stream using libbzip2 mz_strm_libcomp.* Apple compression stream mz_strm_lzma.* LZMA stream using liblzma mz_strm_mem.* Memory stream mz_strm_split.* Disk splitting stream mz_strm_pkcrypt.* PKWARE traditional encryption stream mz_strm_os* Platform specific file stream mz_strm_wzaes.* WinZIP AES stream mz_strm_zlib.* Deflate stream using zlib mz_zip.* Zip format mz_zip_rw.* Zip reader/writer

Third-Party Libraries

• zlib written by Mark Adler and Jean-loup Gailly.
  • Not included in this repository
  • Or alternatively, zlib-ng by Hans Kristian Rosbach
• BZIP2 written by Julian Seward.
• liblzma written by Lasse Collin.
  • Modifications were made to support the ZIP file format specification
• AES and SHA libraries of Brian Gladman.

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.