Version 2.10.6.
3 files changed
tree: e2557e219c935daac638832d9aaccd0b0833e05b
  1. .github/
  2. doc/
  3. test/
  4. CMakeLists.txt
  5. INDEX.md
  6. LICENSE
  7. minigzip.c
  8. minizip.c
  9. minizip.pc.cmakein
  10. mz.h
  11. mz_compat.c
  12. mz_compat.h
  13. mz_crypt.c
  14. mz_crypt.h
  15. mz_crypt_apple.c
  16. mz_crypt_brg.c
  17. mz_crypt_openssl.c
  18. mz_crypt_win32.c
  19. mz_os.c
  20. mz_os.h
  21. mz_os_posix.c
  22. mz_os_win32.c
  23. mz_strm.c
  24. mz_strm.h
  25. mz_strm_buf.c
  26. mz_strm_buf.h
  27. mz_strm_bzip.c
  28. mz_strm_bzip.h
  29. mz_strm_libcomp.c
  30. mz_strm_libcomp.h
  31. mz_strm_lzma.c
  32. mz_strm_lzma.h
  33. mz_strm_mem.c
  34. mz_strm_mem.h
  35. mz_strm_os.h
  36. mz_strm_os_posix.c
  37. mz_strm_os_win32.c
  38. mz_strm_pkcrypt.c
  39. mz_strm_pkcrypt.h
  40. mz_strm_split.c
  41. mz_strm_split.h
  42. mz_strm_wzaes.c
  43. mz_strm_wzaes.h
  44. mz_strm_zlib.c
  45. mz_strm_zlib.h
  46. mz_strm_zstd.c
  47. mz_strm_zstd.h
  48. mz_zip.c
  49. mz_zip.h
  50. mz_zip_rw.c
  51. mz_zip_rw.h
  52. README.md
README.md

minizip 2.10.6

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

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

Developed and maintained by Nathan Moinvaziri.

Branches

NameDescription
masterModern rewrite that includes more advanced features, improvements in code maintainability and readability, and the reduction of duplicate code. Compatibility layer provided for older versions.
devLatest development code
1.2Drop-in replacement for zlib's minizip that includes WinZip AES encryption, disk splitting, I/O buffering and some additional fixes.
1.1Original 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, 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_FETCH_LIBSEnables fetching third-party libraries if not foundON
MZ_FORCE_FETCH_LIBSEnables fetching third-party libraries alwaysOFF
MZ_PKCRYPTEnables PKWARE traditional encryptionON
MZ_WZAESEnables WinZIP AES encryptionON
MZ_LIBCOMPEnables Apple compressionOFF
MZ_OPENSSLEnables OpenSSL encryptionOFF
MZ_LIBBSDBuilds with libbsd crypto randomON
MZ_BRGEnables Brian Gladman's libraryOFF
MZ_ICONVEnables iconv encoding conversionON
MZ_SIGNINGEnables zip signing supportON
MZ_COMPRESS_ONLYOnly support compressionOFF
MZ_DECOMPRESS_ONLYOnly support decompressionOFF
MZ_BUILD_TESTBuilds minizip test executableOFF
MZ_BUILD_UNIT_TESTBuilds minizip unit test projectOFF
MZ_BUILD_FUZZ_TESTBuilds minizip fuzz executablesOFF
MZ_CODE_COVERAGEBuild with code coverage flagsOFF
MZ_PROJECT_SUFFIXProject name suffix for packaging
MZ_FILE32_APIBuilds using posix 32-bit file apiOFF

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.

ProjectLicenseCMake OptionComments
aeslicenseMZ_BRGWritten by Brian Gladman.
bzip2licenseMZ_BZIP2Written by Julian Seward.
liblzmaPublic domainMZ_LZMAWritten by Igor Pavlov and Lasse Collin.
shalicenseMZ_BRGWritten by Brian Gladman.
zlibzlibMZ_ZLIBWritten by Mark Adler and Jean-loup Gailly. Or alternatively, zlib-ng by Hans Kristian Rosbach.
zstdBSDMZ_ZSTDWritten 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.