https://github.com/zip-rs/zip2
Zip implementation in Rust
https://github.com/zip-rs/zip2
Last synced: 14 days ago
JSON representation
Zip implementation in Rust
- Host: GitHub
- URL: https://github.com/zip-rs/zip2
- Owner: zip-rs
- License: other
- Created: 2023-04-23T19:26:38.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2025-04-29T21:43:54.000Z (12 months ago)
- Last Synced: 2025-05-09T07:03:03.134Z (11 months ago)
- Language: Rust
- Size: 161 MB
- Stars: 188
- Watchers: 3
- Forks: 66
- Open Issues: 76
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-rust - zip-rs/zip2
- awesome-rust - zip-rs/zip2 - read and write ZIP archives (Libraries / Compression)
- fucking-awesome-rust - zip-rs/zip2 - read and write ZIP archives (Libraries / Compression)
- awesome-rust-with-stars - zip-rs/zip2 - 01-30 | (Libraries / Compression)
README
# zip [](https://crates.io/crates/zip)  [](https://docs.rs/zip) [](https://github.com/zip-rs/zip2/actions?query=branch%3Amaster+workflow%3ACI) [](https://www.bestpractices.dev/projects/11847)
A zip library for rust which supports reading and writing of simple ZIP files. Currently hosted at
.
The current implementation is based on [PKWARE's APPNOTE.TXT v6.3.9](https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT)
Supported compression formats:
| Formats | Reading | Writing |
| ----------------------------------- | ------- | ------- |
| Stored (i.e. none) | ✅ | ✅ |
| Implode, Shrink, Reduce | ✅ | |
| Deflate | ✅ | ✅ |
| `Deflate64` | ✅ | |
| `Bzip2` | ✅ | ✅ |
| `ZStandard` | ✅ | ✅ |
| `LZMA` | ✅ | |
| `XZ` | ✅ | ✅ |
| `PPMd` | ✅ | ✅ |
| AES encryption | ✅ | ✅ |
| `ZipCrypto` (deprecated encryption) | ✅ | ✅ |
Currently unsupported zip extensions:
- Multi-disk
## Features
The features available are:
- `aes-crypto`: Enables decryption of files which were encrypted with AES. Supports AE-1 and AE-2 methods.
- `deflate`: Enables compressing and decompressing an unspecified implementation (that may change in future versions) of
the deflate compression algorithm, which is the default for zip files. Supports compression quality 1..=264.
- `deflate-flate2`: Combine this with any `flate2` feature flag that enables a back-end, to support deflate compression
at quality 1..=9.
- `deflate-zopfli`: Enables deflating files with the `zopfli` library (used when compression quality is 10..=264). This
is the most effective `deflate` implementation available, but also among the slowest. If `flate2` isn't also enabled,
only compression will be supported and not decompression.
- `deflate64`: Enables the deflate64 compression algorithm. Only decompression is supported.
- `lzma`: Enables the `LZMA` compression algorithm. Only decompression is supported.
- `bzip2`: Enables the `BZip2` compression algorithm.
- `ppmd`: Enables the `PPMd` compression algorithm.
- `time`: Enables features using the [time](https://github.com/time-rs/time) crate.
- `chrono`: Enables converting last-modified [`zip::DateTime`](https://docs.rs/zip/latest/zip/struct.DateTime.html) to and from `chrono::NaiveDateTime`.
- `jiff-02`: Enables converting last-modified [`zip::DateTime`](https://docs.rs/zip/latest/zip/struct.DateTime.html) to and from `jiff::civil::DateTime`.
- `nt-time`: Enables returning timestamps stored in the NTFS extra field as `nt_time::FileTime`.
- `xz`: Enables the `XZ` compression algorithm.
- `zstd`: Enables the `Zstandard` compression algorithm.
By default `aes-crypto`, `bzip2`, `deflate`, `deflate64`, `lzma`, `ppmd`, `time`, `xz` and `zstd` are enabled.
## Library usage
Reading:
- [`ZipArchive::new()`](https://docs.rs/zip/latest/zip/read/struct.ZipArchive.html)
Writing:
- [`ZipWriter::new()`](https://docs.rs/zip/latest/zip/write/struct.ZipWriter.html) - to create a new archive
- [`ZipWriter::new_stream()`](https://docs.rs/zip/latest/zip/write/struct.ZipWriter.html#method.new_stream) - to write in stream mode
## Examples
See the [examples directory](./examples) for:
- How to [write a file to a zip](./examples/write_sample.rs).
- How to [write a directory of files to a zip](./examples/write_dir.rs) (using [walkdir](https://github.com/BurntSushi/walkdir)).
- How to [extract a zip file](./examples/extract.rs).
- How to [extract a single file from a zip](./examples/extract_lorem.rs).
- How to [read a zip from the standard input](./examples/stdin_info.rs).
- How to [append a directory to an existing archive](./examples/append.rs)
## Wasm
This library can work in a Wasm environment but you may need to disable certain features (which are using non-rust library). Here is an example below
```toml
# change to latest version
zip = { version = "latest", default-features = false, features = [
# "aes-crypto",
# "bzip2",
# "xz",
"deflate64",
"deflate",
"lzma",
"time",
"zstd",
] }
```
## MSRV
Our current Minimum Supported Rust Version is **1.88**. When adding features,
we will follow these guidelines:
- We will always support a minor Rust version that has been stable for at least 6 months.
- Any change to the MSRV will be accompanied with a **minor** version bump.
## License
Licensed under the [MIT License](./LICENSE). Some files in the "tests/data" subdirectory of this repository are under other
licenses; see files named `LICENSE.*.txt` for details.
## Fuzzing
Fuzzing support is through [`cargo afl`](https://rust-fuzz.github.io/book/afl/tutorial.html). To install `cargo afl`:
```sh
cargo install cargo-afl
```
To start fuzzing zip extraction:
```sh
mkdir -vp fuzz-read-out
cargo afl build --manifest-path=fuzz/Cargo.toml --all-features -p fuzz_read
# Curated input corpus:
cargo afl fuzz -i fuzz/read/in -o fuzz-read-out fuzz/target/debug/fuzz_read
# Test data files:
cargo afl fuzz -i tests/data -e zip -o fuzz-read-out fuzz/target/debug/fuzz_read
```
To start fuzzing zip creation:
```sh
mkdir -vp fuzz-write-out
cargo afl build --manifest-path=fuzz/Cargo.toml --all-features -p fuzz_write
# Curated input corpus and dictionary schema:
cargo afl fuzz -x fuzz/write/fuzz.dict -i fuzz/write/in -o fuzz-write-out fuzz/target/debug/fuzz_write
```
### Fuzzing stdio
The read and write fuzzers can also receive input over stdin for one-off validation. Note here that the fuzzers can be configured to build in support for DEFLATE, or not:
```sh
# Success, no output:
cargo run --manifest-path=fuzz/Cargo.toml --quiet --all-features -p fuzz_read