@neoware_inc/neozipkit 0.5.0

package/dist/core/encryption/ZipCrypto.d.ts

@@ -0,0 +1,172 @@
+/**
+ * Traditional ZIP Crypto encryption implementation
+ * Compatible with standard ZIP 2.0 encryption (ZipCrypto)
+ */
+import { EncryptionProvider, EncryptionOptions, EncryptionResult, DecryptionResult, EncryptionMethod } from './types';
+import ZipEntry from '../ZipEntry';
+export declare class ZipCrypto implements EncryptionProvider {
+    private static readonly KEY_LENGTH;
+    canHandle(method: EncryptionMethod): boolean;
+    getMethodName(): string;
+    getKeyLength(): number;
+    encrypt(data: Buffer, options: EncryptionOptions): Promise<EncryptionResult>;
+    decrypt(data: Buffer, options: EncryptionOptions): Promise<DecryptionResult>;
+    /**
+     * Verify password using check byte from decrypted header
+     * @param decryptedHeader - 12-byte decrypted encryption header
+     * @param checkByte - Expected check byte value
+     * @throws Error if password verification fails
+     */
+    verifyPassword(decryptedHeader: Buffer, checkByte: number): void;
+    /**
+     * Parse local header to extract information needed for decryption
+     * @param localHeaderBuffer - 30-byte local header buffer
+     * @param entry - ZIP entry to update with extracted information
+     * @returns Object with bitFlags, lastModTimeDate, localCrc, and checkByte
+     */
+    parseLocalHeaderForDecryption(localHeaderBuffer: Buffer, entry: ZipEntry): {
+        bitFlags: number;
+        lastModTimeDate: number;
+        localCrc: number;
+        checkByte: number;
+    };
+    /**
+     * Create encryption header (12 bytes) for PKZIP encryption
+     * Generates 11 random bytes + 1 check byte
+     * @param entry - ZIP entry to create header for
+     * @param password - Password for encryption (used to calculate check byte)
+     * @returns 12-byte encryption header buffer
+     */
+    createEncryptionHeader(entry: ZipEntry, password: string): Buffer;
+    /**
+     * Encrypt buffer (header + compressed data) for PKZIP encryption
+     * Creates encryption header, concatenates with compressed data, and encrypts everything
+     * @param entry - ZIP entry to encrypt
+     * @param compressedData - Compressed data to encrypt
+     * @param password - Password for encryption
+     * @returns Encrypted buffer (encrypted header + encrypted compressed data)
+     */
+    encryptBuffer(entry: ZipEntry, compressedData: Buffer, password: string): Buffer;
+    /**
+     * Decrypt buffer-based encrypted data (for in-memory extraction)
+     * Handles local header parsing, encryption header extraction, and decryption
+     * @param entry - ZIP entry with encryption information
+     * @param buffer - Full ZIP file buffer
+     * @param encryptedData - Encrypted data without header (from parseLocalHeader)
+     * @param password - Password for decryption
+     * @returns Decrypted compressed data (without header)
+     */
+    decryptBuffer(entry: ZipEntry, buffer: Buffer, encryptedData: Buffer, password: string): Buffer;
+    /**
+     * Create a streaming decryptor for chunked data processing
+     * Handles 12-byte header decryption and verification, then yields decrypted chunks
+     *
+     * MEMORY EFFICIENCY: This method processes encrypted data one block at a time.
+     * - Decryption state (keys) is maintained across blocks via updateKeys()
+     * - Only the minimum 12-byte header is accumulated before password verification
+     * - Each decrypted block is yielded immediately without accumulation
+     *
+     * @param password - Password for decryption
+     * @param checkByte - Expected check byte value for password verification
+     * @param encryptedStream - Async generator of encrypted data chunks (one block at a time)
+     * @returns Async generator of decrypted data chunks (one block at a time)
+     */
+    createStreamDecryptor(password: string, checkByte: number, encryptedStream: AsyncGenerator<Buffer>): AsyncGenerator<Buffer>;
+    /**
+     * Initialize encryption keys from password
+     */
+    private initKeys;
+    /**
+     * Update encryption keys with a byte
+     * Based on zip.js implementation - uses Math.imul for 32-bit integer multiplication
+     */
+    private updateKeys;
+    /**
+     * Encrypt a single byte
+     * Based on zip.js implementation - uses Math.imul for 32-bit integer multiplication
+     */
+    private encryptByte;
+    /**
+     * Decrypt a single byte
+     * Based on zip.js implementation - uses Math.imul for 32-bit integer multiplication
+     */
+    private decryptByte;
+    /**
+     * CRC32 lookup table (shared for all CRC32 operations)
+     */
+    static readonly CRC_TABLE: number[];
+    /**
+     * CRC32 implementation for ZIP crypto (single byte update)
+     * Used internally for key updates during encryption/decryption
+     */
+    private crc32;
+    /**
+     * Static CRC32 calculation for a full buffer
+     * Delegates to exported crc32() function
+     * @param buf - Buffer or string to calculate CRC32 for
+     * @returns CRC32 checksum as unsigned 32-bit integer
+     */
+    static crc32(buf: Buffer | string): number;
+    /**
+     * Static CRC32 incremental update (single byte)
+     * Delegates to exported crc32update() function
+     * @param crc - Current CRC32 value
+     * @param byte - Byte to update with
+     * @returns Updated CRC32 value
+     */
+    static crc32update(crc: number, byte: number): number;
+}
+/**
+ * CRC32 calculation for a full buffer
+ * Main public API for CRC32 calculation
+ * @param buf - Buffer or string to calculate CRC32 for
+ * @returns CRC32 checksum as unsigned 32-bit integer
+ */
+export declare function crc32(buf: Buffer | string): number;
+/**
+ * CRC32 incremental update (single byte)
+ * Used for streaming CRC32 calculation
+ * @param crc - Current CRC32 value
+ * @param byte - Byte to update with
+ * @returns Updated CRC32 value
+ */
+export declare function crc32update(crc: number, byte: number): number;
+export declare function sha256(data: Buffer): string;
+/**
+ * Options for creating a DecryptionStream
+ */
+export interface DecryptionStreamOptions {
+    password: string;
+    method: EncryptionMethod;
+    entry: ZipEntry;
+}
+/**
+ * Streaming decryption for chunked compressed data processing
+ * Encapsulated within ZipCrypto for PKZIP decryption
+ */
+export declare class DecryptionStream {
+    private password;
+    private method;
+    private entry;
+    private zipCrypto;
+    constructor(options: DecryptionStreamOptions);
+    /**
+     * Decrypt compressed data stream chunk by chunk
+     */
+    decrypt(encryptedStream: AsyncGenerator<Buffer>): AsyncGenerator<Buffer>;
+    /**
+     * Calculate check byte for password verification
+     * For DATA_DESC files: lastModTimeDate >> 8
+     * For non-DATA_DESC files: CRC >> 24
+     */
+    private calculateCheckByte;
+    /**
+     * Prepare entry for decryption by parsing local header from file handle
+     * This extracts the information needed for check byte calculation
+     * @param fileHandle - File handle to read from
+     * @param entry - ZIP entry to update
+     * @returns Check byte value for password verification
+     */
+    static prepareEntryForDecryption(fileHandle: any, entry: ZipEntry): Promise<number>;
+}
+//# sourceMappingURL=ZipCrypto.d.ts.map

package/dist/core/encryption/ZipCrypto.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ZipCrypto.d.ts","sourceRoot":"","sources":["../../../src/core/encryption/ZipCrypto.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AACtH,OAAO,QAAQ,MAAM,aAAa,CAAC;AAKnC,qBAAa,SAAU,YAAW,kBAAkB;IAClD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAK;IAEvC,SAAS,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO;IAI5C,aAAa,IAAI,MAAM;IAIvB,YAAY,IAAI,MAAM;IAIhB,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAkC5E,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAkClF;;;;;OAKG;IACH,cAAc,CAAC,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAWhE;;;;;OAKG;IACH,6BAA6B,CAAC,iBAAiB,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,GAAG;QACzE,QAAQ,EAAE,MAAM,CAAC;QACjB,eAAe,EAAE,MAAM,CAAC;QACxB,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,EAAE,MAAM,CAAC;KACnB;IAgCD;;;;;;OAMG;IACH,sBAAsB,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM;IA2BjE;;;;;;;OAOG;IACH,aAAa,CAAC,KAAK,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM;IA2BhF;;;;;;;;OAQG;IACH,aAAa,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM;IA2C/F;;;;;;;;;;;;;OAaG;IACI,qBAAqB,CAC1B,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,eAAe,EAAE,cAAc,CAAC,MAAM,CAAC,GACtC,cAAc,CAAC,MAAM,CAAC;IAwFzB;;OAEG;IACH,OAAO,CAAC,QAAQ;IAUhB;;;OAGG;IACH,OAAO,CAAC,UAAU;IAOlB;;;OAGG;IACH,OAAO,CAAC,WAAW;IAMnB;;;OAGG;IACH,OAAO,CAAC,WAAW;IAMnB;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,SAAS,WA4CvB;IAEF;;;OAGG;IACH,OAAO,CAAC,KAAK;IAIb;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM;IAI1C;;;;;;OAMG;IACH,MAAM,CAAC,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;CAGtD;AAkCD;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAElD;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAE7D;AAMD,wBAAgB,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAK3C;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,gBAAgB,CAAC;IACzB,KAAK,EAAE,QAAQ,CAAC;CACjB;AAED;;;GAGG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,KAAK,CAAW;IACxB,OAAO,CAAC,SAAS,CAAY;gBAEjB,OAAO,EAAE,uBAAuB;IAO5C;;OAEG;IACI,OAAO,CAAC,eAAe,EAAE,cAAc,CAAC,MAAM,CAAC,GAAG,cAAc,CAAC,MAAM,CAAC;IAY/E;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;IAiB1B;;;;;;OAMG;WACU,yBAAyB,CAAC,UAAU,EAAE,GAAG,EAAE,KAAK,EAAE,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC;CAW1F"}