Merge branch 'master' into dev
tree: a11f24272bb3a6591282f6ebef39339147e8d098
  1. doc/
  2. lib/
  3. test/
  4. .travis.yml
  5. CMakeLists.txt
  6. LICENSE
  7. minizip.c
  8. minizip.pc.cmakein
  9. Minizip.podspec
  10. mz.h
  11. mz_compat.c
  12. mz_compat.h
  13. mz_os.c
  14. mz_os.h
  15. mz_os_posix.c
  16. mz_os_posix.h
  17. mz_os_win32.c
  18. mz_os_win32.h
  19. mz_strm.c
  20. mz_strm.h
  21. mz_strm_aes.c
  22. mz_strm_aes.h
  23. mz_strm_buf.c
  24. mz_strm_buf.h
  25. mz_strm_bzip.c
  26. mz_strm_bzip.h
  27. mz_strm_crc32.c
  28. mz_strm_crc32.h
  29. mz_strm_lzma.c
  30. mz_strm_lzma.h
  31. mz_strm_mem.c
  32. mz_strm_mem.h
  33. mz_strm_pkcrypt.c
  34. mz_strm_pkcrypt.h
  35. mz_strm_posix.c
  36. mz_strm_posix.h
  37. mz_strm_split.c
  38. mz_strm_split.h
  39. mz_strm_win32.c
  40. mz_strm_win32.h
  41. mz_strm_zlib.c
  42. mz_strm_zlib.h
  43. mz_zip.c
  44. mz_zip.h
  45. mz_zip_rw.c
  46. mz_zip_rw.h
  47. README.md
README.md

minizip 2.5.4

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

License: Zlib

Maintained by Nathan Moinvaziri.

Fork Motivation and History

This library is a complete refactoring of the minizip contribution found in the zlib distribution. The motivation for this fork has been the inclusion of advanced features, improvements in code maintainability and readability, and the reduction of duplicate code.

Minizip was originally developed by Gilles Vollant and had been contributed to by many people. As part of the zlib distribution, Mark Adler has maintained the original minizip project.

In 2006, I began working with the minizip project and started submitting bugs I found in the library to Gilles Vollant via e-mail. In 2010, I implemented some additional features like disk splitting, I/O buffering, and AES encryption. My continued work on the project necessitated setting up a public repository so I could share these and other improvements with the rest of the world. I have been maintaining and actively developing this fork of the project ever since. In 2017, I began the task of refactoring and rewriting most of library as it had become difficult to maintain and code readability had suffered over the years.

Dev: Dev Branch Status Master: Master Branch Status

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.
  • IBM Codepage 437 legacy character encoding support.
  • Turn off compilation of compression, decompression, or encryption.
  • Windows (Win32 & WinRT), macOS and Linux platform support.
  • Streaming interface for easy implementation of additional platforms.
  • Compatibility interface for older versions of minizip.
  • Example minizip command line tool.

Build

To generate project files for your platform:

  1. Download and install cmake.
  2. Download and install zlib if it is not installed on your system.
  3. Run cmake in the minizip directory.
cmake . -DBUILD_TEST=ON
cmake --build .

Build Options

NameDescriptionDefault Value
USE_ZLIBEnables ZLIB compressionON
USE_BZIP2Enables BZIP2 compressionON
USE_LZMAEnables LZMA compressionON
USE_PKCRYPTEnables PKWARE traditional encryptionON
USE_AESEnables WinZIP AES encryptionON
COMPRESS_ONLYOnly support compressionOFF
DECOMPRESS_ONLYOnly support decompressionOFF
BUILD_TESTBuilds minizip test executableOFF

Zlib Installation (Windows)

Option 1. Install the zlib package to the Program Files directory with an Administrator command prompt.

cmake . -DCMAKE_INSTALL_PREFIX=%PROGRAMFILES%\zlib
cmake --build . --config Release --target INSTALL

Option 2. Compile zlib in minizip's lib directory.

cmake .
cmake --build . --config Release

Navigate back to the minizip directory and before building run:

cmake . -DZLIB_LIBRARY=lib\zlib\release\zlibstatic.lib -DZLIB_INCLUDE_DIR=lib\zlib\

Contents

File(s)DescriptionRequired
minizip.cSample applicationNo
mz_compat.*Minizip 1.0 compatibility layerNo
mz.hError codes and flagsYes
mz_os*OS specific helper functionsEncryption, Disk Splitting
mz_strm.*Stream interfaceYes
mz_strm_aes.*WinZIP AES streamNo
mz_strm_buf.*Buffered streamNo
mz_strm_bzip.*BZIP2 stream using libbzip2No
mz_strm_crc32.*CRC32 streamYes
mz_strm_lzma.*LZMA stream using liblzmazlib or liblzma
mz_strm_mem.*Memory streamYes
mz_strm_split.*Disk splitting streamNo
mz_strm_pkcrypt.*PKWARE traditional encryption streamNo
mz_strm_posix.*File stream using Posix functionsNon-windows systems
mz_strm_win32.*File stream using Win32 API functionsWindows systems
mz_strm_zlib.*Deflate stream using zlibzlib or liblzma
mz_zip.*Zip formatYes
mz_zip_rw.*Zip reader/writerNo

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.

Limitations

  • Archives are required to have a central directory.
  • Central directory header values should be correct and it is necessary for the compressed size to be accurate for AES encryption.
  • Central directory encryption is not supported due to licensing restrictions mentioned by PKWARE in their zip appnote.
  • Central directory is the only data stored on the last disk of a split-disk archive and doesn't follow disk size restrictions.

Acknowledgments

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

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 nearly as good without you.

The ZIP format was defined by Phil Katz of PKWARE.