https://github.com/adam-fowler/swift-zip-archive
Zip Archive reader/writer written in Swift
https://github.com/adam-fowler/swift-zip-archive
ios linux macos swift windows zip
Last synced: 10 months ago
JSON representation
Zip Archive reader/writer written in Swift
- Host: GitHub
- URL: https://github.com/adam-fowler/swift-zip-archive
- Owner: adam-fowler
- License: apache-2.0
- Created: 2025-01-16T08:14:22.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-05T15:59:33.000Z (about 1 year ago)
- Last Synced: 2025-08-19T02:58:05.359Z (10 months ago)
- Topics: ios, linux, macos, swift, windows, zip
- Language: Swift
- Homepage:
- Size: 164 KB
- Stars: 51
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ZipArchive
A library for reading and editing zip archives.
## Overview
Zip archives are a standard method for collating, compressing and encrypting collections of files. They are universally used to aggregate, compress, and encrypt files into a single interoperable container. `ZipArchive` provides support for reading and writing zip archives from either memory or disk.
## Reading Zip archives
To parse a zip archive stored on disk use the function `ZipArchiveReader.withFile(_:process:)`. This creates a ``ZipArchiveReader`` that can be used in the supplied closure to read the directory from a zip file and then read individual files.
```swift
let fileContents = try ZipArchiveReader.withFile("MyFile.zip") { reader in
let directory = try reader.readDirectory()
let fileHeader = directory.first { $0.filename == "File.txt"}
return try reader.readFile(fileHeader)
}
```
## Writing Zip Archives
The ``ZipArchiveWriter`` is used to write zip archives. You can use `ZipArchiveWriter.withFile(_:options:process:)` to either create a new zip archive or append files to an existing zip archive. This function has a closure parameter in which you can add new files to the zip using the provided `ZipArchiveWriter`. When you exit the closure the zip archive is finalized ie the directory and end of directory sections are written to disk and file descriptor is closed. The following loads zip archive MyFile.zip and then appends a new file called Hello.txt to the archive.
```swift
try ZipArchiveWriter.withFile("MyFile.zip") { writer in
try writer.writeFile(filename: "Hello.txt", contents: .init("Hello, world!".utf8))
}
```
If you want to create a new zip archive you can call `withFile("MyFile.zip", options: .create)`.
## Password Protected Zip Archives
`ZipArchive` supports the traditional PKZIP encrytion method. You can decrypt a file by adding a password parameter to `ZipArchiveReader.readFile(_:password:)`. For example
```swift
try reader.readFile(fileHeader, password: "testing123")
```
And you can add encryption to a file by adding a password to `ZipArchiveWriter.writeFile(filename:contents:password:)`. For example
```swift
try writer.writeFile(filename: "Hello.txt", contents: fileContents, password: "testing123")
```
## Zip Archive Memory Buffers
It is also possible to use `ZipArchiveReader` and `ZipArchiveWriter` to read and write from a zip archive stored in memory. A `ZipArchiveReader` can be constructed from a memory buffer and then its directory and files can be read in a similar manner to how they with archives stored on disk.
```swift
let reader = try ZipFileReader(buffer: zipArchiveMemoryBuffer)
let directory = try reader.readDirectory()
let fileHeader = directory.first { $0.filename == "File.txt"}
let fileContents = try reader.readFile(fileHeader)
```
To write to a zip archive in memory you can create a `ZipFileWriter` from a buffer. When you want to create your finalized zip archive with a complete directory you call `ZipFileWriter.finalizeBuffer()` which will return the complete zip archive.
```swift
let writer = try ZipArchiveWriter(buffer: zipArchiveMemoryBuffer)
try writer.writeFile(filename: "Hello.txt", contents: fileContents, password: "testing123")
let zipBuffer = try writer.finalizeBuffer()
```
## Status
ZipArchive currently supports
- Deflate decompression
- Zip64
- CRC32 checks
- Traditional PKWARE Decryption/Encryption
ZipArchive supports Apple OSs, Linux and Windows