Fork of Go's archive/zip to add reading/writing of password protected zip files.
Go to file
alexmullins a0910dd023 Move all password related fields to the FileHeader
This will unify the reading and writing API. Eventually
the SetPassword function will be deprecated in favor
of a Password field that is of type func() []byte. This way
the password can be set dynamically. This will also help in
differentiating a nil password and an empty password.
2015-11-26 14:46:37 -06:00
testdata add test for failing corrupt input into flate 2015-10-29 23:12:02 -05:00
.gitignore Added initial support for reading pw protected files. 2015-10-29 16:14:19 -05:00
README.txt defer authentication/buffering to Read not Open 2015-11-05 23:12:14 -06:00
crypto.go Change documentation 2015-11-26 14:38:53 -06:00
crypto_test.go Setup ground work for streaming/buffered reading. 2015-11-06 00:50:54 -06:00
example_test.go change reader exmple to show usage of SetPassword 2015-10-29 17:15:39 -05:00
reader.go Move all password related fields to the FileHeader 2015-11-26 14:46:37 -06:00
reader_test.go defer authentication/buffering to Read not Open 2015-11-05 23:12:14 -06:00
register.go Initial commit and README.txt 2015-10-27 04:12:51 -05:00
struct.go Move all password related fields to the FileHeader 2015-11-26 14:46:37 -06:00
writer.go Initial commit and README.txt 2015-10-27 04:12:51 -05:00
writer_test.go Initial commit and README.txt 2015-10-27 04:12:51 -05:00
zip_test.go Initial commit and README.txt 2015-10-27 04:12:51 -05:00

README.txt

This is a fork of the Go archive/zip package to add support
for reading/writing password protected .zip files.
Only supports Winzip's AES extension: http://www.winzip.com/aes_info.htm.

This package DOES NOT intend to implement the encryption methods
mentioned in the original PKWARE spec (sections 6.0 and 7.0):
https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT

The process
============
hello.txt -> compressed -> encrypted -> .zip -> decrypted -> decompressed -> hello.txt

Roadmap
========
Reading - Done.
    TODO:
    1. Change to streaming authentication and decryption. (Maybe not such a good
    idea: https://www.imperialviolet.org/2014/06/27/streamingencryption.html)
    2. Check for AE-2 and skip CRC check to match with WinZip spec.
Writing - Not started.
Testing - Needs more.

WinZip AES specifies
=====================
1. Encryption-Decryption w/ AES-CTR (128, 192, or 256 bits)
2. Key generation with PBKDF2-HMAC-SHA1 (1000 iteration count) that
generates a master key broken into the following:
    a. First m bytes is for the encryption key
    b. Next n bytes is for the authentication key
    c. Last 2 bytes is the password verification value.
3. Following salt lengths are used w/ password during keygen:
    ------------------------------
    AES Key Size    | Salt Size
    ------------------------------
    128bit(16bytes) | 8 bytes
    192bit(24bytes) | 12 bytes
    256bit(32bytes) | 16 bytes
    -------------------------------
4. Master key len = AESKeyLen + AuthKeyLen + PWVLen:
    a. AES 128 = 16 + 16 + 2 = 34 bytes of key material
    b. AES 192 = 24 + 24 + 2 = 50 bytes of key material
    c. AES 256 = 32 + 32 + 2 = 66 bytes of key material
5. Authentication Key is same size as AES key.
6. Authentication with HMAC-SHA1-80 (truncated to 80bits).
7. A new master key is generated for every file.
8. The file header and directory header compression method will
be 99 (decimal) indicating Winzip AES encryption. The actual
compression method will be in the extra's payload at the end
of the headers.
9. A extra field will be added to the file header and directory
header identified by the ID 0x9901 and contains the following info:
    a. Header ID (2 bytes)
    b. Data Size (2 bytes)
    c. Vendor Version (2 bytes)
    d. Vendor ID (2 bytes)
    e. AES Strength (1 byte)
    f. Compression Method (2 bytes)
10. The Data Size is always 7.
11. The Vendor Version can be either 0x0001 (AE-1) or
0x0002 (AE-2).
12. Vendor ID is ASCII "AE"
13. AES Strength:
    a. 0x01 - AES-128
    b. 0x02 - AES-192
    c. 0x03 - AES-256
14. Compression Method is the actual compression method
used that was replaced by the encryption process mentioned in #8.
15. AE-1 keeps the CRC and should be verified after decompression.
AE-2 removes the CRC and shouldn't be verified after decompression.
Refer to http://www.winzip.com/aes_info.htm#winzip11 for the reasoning.
16. Storage Format (file data payload totals CompressedSize64 bytes):
    a. Salt - 8, 12, or 16 bytes depending on keysize
    b. Password Verification Value - 2 bytes
    c. Encrypted Data - compressed size - salt - pwv - auth code lengths
    d. Authentication code - 10 bytes