import { randomUUID } from "node:crypto"; import { open, rename, rm } from "node:fs/promises"; import type { FileHandle } from "node:fs/promises"; import { dirname, join } from "node:path"; import { Unzip, UnzipInflate } from "fflate"; import { chunkHashFinal, chunkHashInit, chunkHashUpdate, fromBase64, initStreamPull, pullStreamChunk, STREAM_CHUNK_OVERHEAD, STREAM_CHUNK_SIZE, streamTagFinal, } from "../crypto/index.js"; import { TruncatedStreamError } from "../errors.js"; import { sanitizeFileName } from "../filename.js"; import { withRetry } from "../retry.js"; import type { ApiClient } from "../api/client.js"; import type { EnteFile } from "../model/types.js"; export interface DownloadResult { path: string; bytesWritten: number; } // Fired as decrypted plaintext accumulates, with the running total of // plaintext bytes recovered so far. Within one download it is non-decreasing // and its last value equals the final `bytesWritten`. A retry restarts the // file from byte zero (see `fetchAndDecrypt`), so a fresh attempt begins its // own count from zero. export type ProgressCallback = (bytesDone: number) => void; const ENC_CHUNK_SIZE = STREAM_CHUNK_SIZE + STREAM_CHUNK_OVERHEAD; // Decrypt a secretstream body, handing each plaintext chunk to `sink` as it is // produced rather than accumulating the whole file. Peak memory is one // ciphertext chunk of network buffer plus one plaintext chunk — bounded by // `STREAM_CHUNK_SIZE` regardless of the file's size — so a multi-gigabyte video // no longer needs its size again in RAM. Returns the total plaintext length. // // The truncation contract is exactly the buffered version's, only the sink is // new: a body cut short still decrypts and authenticates up to its last whole // chunk, so the absence of TAG_FINAL is the sole evidence it was cut short, and // this throws rather than let a caller keep a short file. The sink has already // seen those chunks by then; the caller (`decryptToTemp`) stages them in a temp // file that is renamed into place only on a clean return, so a throw leaves // nothing on disk. const streamDecrypt = async ( stream: ReadableStream, header: Uint8Array, key: Uint8Array, sink: (plaintext: Uint8Array) => Promise, onProgress?: ProgressCallback, ): Promise => { const state = initStreamPull(header, key); const reader = stream.getReader(); // Incoming reads are held as-is and only stitched into a contiguous chunk // at each `ENC_CHUNK_SIZE` boundary, so every received byte is copied once. // Concatenating on each read instead — reallocating the whole accumulator // per read — is O(n^2) in the bytes buffered, and for a 4 MiB chunk that // memory churn dwarfs the libsodium decryption itself. const pending: Uint8Array[] = []; let pendingBytes = 0; let totalPlain = 0; let chunksPulled = 0; let lastTag = -1; // Remove the first `size` bytes from `pending` as one contiguous buffer. // A read that straddles the boundary is split with `subarray` (a view, no // copy); its tail stays queued for the next chunk. `size` never exceeds // `pendingBytes`, so the queue always holds enough. const takeContiguous = (size: number): Uint8Array => { const out = new Uint8Array(size); let offset = 0; while (offset < size) { const piece = pending[0]!; const need = size - offset; if (piece.length <= need) { out.set(piece, offset); offset += piece.length; pending.shift(); } else { out.set(piece.subarray(0, need), offset); pending[0] = piece.subarray(need); offset += need; } } pendingBytes -= size; return out; }; const consume = async ( plaintext: Uint8Array, tag: number, ): Promise => { await sink(plaintext); totalPlain += plaintext.length; chunksPulled++; lastTag = tag; onProgress?.(totalPlain); }; try { for (;;) { const { done, value } = await reader.read(); if (value && value.length > 0) { pending.push(value); pendingBytes += value.length; } while (pendingBytes >= ENC_CHUNK_SIZE) { const encChunk = takeContiguous(ENC_CHUNK_SIZE); // A whole chunk that fails to authenticate while the stream // carries on is corruption, not truncation; that error // propagates unchanged. const { plaintext, tag } = pullStreamChunk(state, encChunk); await consume(plaintext, tag); } if (done) { if (pendingBytes > 0) { const buffer = takeContiguous(pendingBytes); // Whatever is left over once every whole chunk has been // consumed must be the stream's final chunk, and a final // chunk that actually arrived in full authenticates. If // it does not, the body stopped part-way through a chunk // — the ordinary shape of a dropped connection. Poly1305 // cannot tell a partial chunk from a corrupt one, so this // is reported as the truncation it almost always is, with // the authentication failure kept as the error's cause. // Only the pull is guarded: a sink failure on a chunk // that did authenticate is a disk error, not a // truncation. let pulled; try { pulled = pullStreamChunk(state, buffer); } catch (err) { throw new TruncatedStreamError( `download: stream truncated: response body ended with ${buffer.length} trailing bytes that did not authenticate as a final chunk (transfer stopped mid-chunk, or the data is corrupt)`, { cause: err }, ); } await consume(pulled.plaintext, pulled.tag); } break; } } } finally { reader.releaseLock(); } // Only the last chunk of a secretstream carries TAG_FINAL. Everything a // dropped connection did deliver still decrypts and authenticates, so the // absence of TAG_FINAL is the only evidence that the body was cut short. if (chunksPulled === 0) { throw new TruncatedStreamError( "download: stream truncated: response body contained no secretstream chunks", ); } const tagFinal = streamTagFinal(); if (lastTag !== tagFinal) { throw new TruncatedStreamError( `download: stream truncated: last chunk tag ${lastTag}, expected TAG_FINAL (${tagFinal})`, ); } return totalPlain; }; // Fsync a file or a directory, so its contents (for a directory, its entries) // are on stable storage. Exported for the backup tree's copy, which needs the // same durability as the writer below. export const fsyncPath = async (path: string): Promise => { const handle = await open(path, "r"); try { await handle.sync(); } finally { await handle.close(); } }; // Stage a write to `destination` atomically and durably, then rename it into // place. `fill` writes the contents into the open temp file handle — either the // whole buffer at once (`writeAtomic`) or chunk by chunk as they decrypt // (`decryptToTemp`). The temp file is a sibling of the destination (same // directory, so the rename cannot cross a filesystem boundary), so callers // never observe a partially written destination, and a pre-existing file is // replaced only once the new contents are complete on disk. // // Durability against a power cut needs two fsyncs. Without them the write can // return while the data or the rename is still only in the kernel's page // cache, and a crash then resurrects an empty renamed file — exactly the // corruption a later backup run treats as a complete download. So the temp // file's contents are fsynced before the rename, and the containing directory // is fsynced after it, so both the bytes and the new directory entry are on // stable storage before this returns. // // On any failure — including a `fill` that throws because the stream was // truncated — the temp file is removed, so the destination is untouched and no // scratch file is left to fill the disk on repeated failures. const stageAtomic = async ( destination: string, fill: (handle: FileHandle) => Promise, ): Promise => { const dir = dirname(destination); // The random suffix keeps concurrent downloads of the same destination // from stepping on each other's temporary file. const tmpPath = join(dir, `.quak-${randomUUID()}.tmp`); try { const handle = await open(tmpPath, "w"); try { await fill(handle); await handle.sync(); } finally { await handle.close(); } // `rename` replaces the destination's directory entry rather than // writing through it: an existing symlink at `destination` is // replaced, not followed, and the new file has the temp file's // permissions, not those of the file it replaced. await rename(tmpPath, destination); // Fsync the directory so the rename itself survives a crash: renaming // over a synced temp file still leaves the new directory entry in the // page cache until the directory is synced. await fsyncPath(dir); } catch (err) { // Best-effort cleanup. A failure to remove the temporary file must // never replace the error that actually explains what went wrong. await rm(tmpPath, { force: true }).catch(() => undefined); throw err; } }; // Write `plaintext` to `destination` atomically and durably. Exported so the // metadata store can reuse the same durable write for small whole-buffer // payloads; originals go through `decryptToTemp` instead so they never buffer. export const writeAtomic = async ( destination: string, plaintext: Uint8Array, ): Promise => stageAtomic(destination, (handle) => handle.writeFile(plaintext)); // Hashes an original's bytes as they are decrypted, for comparison with the // hash its uploader recorded. interface ContentHasher { update: (plaintext: Uint8Array) => void; digest: () => string; } const fileHasher = (): ContentHasher => { const state = chunkHashInit(); return { update: (plaintext) => chunkHashUpdate(state, plaintext), digest: () => chunkHashFinal(state), }; }; // A live photo is stored as a ZIP of its image and its video, and its recorded // hash is `:`, each over that part's own bytes. Like the // upstream client's decoder, this takes the first entries whose names start // with `image` and `video`. // // The ZIP is chosen by its uploader and may expand enormously, so entries are // hashed as they decompress and never held. fflate's `Unzip` inflates each // push in one piece, and deflate expands at most about 1000-fold, so the ZIP // is pushed in 4 KiB slices to keep each decompressed piece near 4 MiB, one // plaintext chunk. Every entry is started, even one that is not hashed, // because fflate keeps an unstarted entry's data in memory. const livePhotoHasher = (fileID: number): ContentHasher => { const sliceSize = 4096; const fail = (message: string, cause?: unknown): Error => new Error(`download: file ${fileID}: ${message}`, { cause }); const claimed = new Set(); const hashes = new Map(); const unzip = new Unzip((entry) => { const part = ["image", "video"].find((p) => entry.name.startsWith(p)); const target = part === undefined || claimed.has(part) ? undefined : { part, state: chunkHashInit() }; if (target !== undefined) claimed.add(target.part); entry.ondata = (err, data, final) => { if (err) throw err; if (target === undefined) return; chunkHashUpdate(target.state, data); if (final) hashes.set(target.part, chunkHashFinal(target.state)); }; entry.start(); }); unzip.register(UnzipInflate); // fflate reports a bad ZIP by throwing, sometimes a TypeError, which the // retry would take for a network failure; a bad ZIP is never retried. const push = (data: Uint8Array, final: boolean): void => { try { unzip.push(data, final); } catch (err) { throw fail("live photo is not a readable ZIP", err); } }; return { update: (plaintext) => { for (let i = 0; i < plaintext.length; i += sliceSize) { push(plaintext.subarray(i, i + sliceSize), false); } }, digest: () => { push(new Uint8Array(0), true); const image = hashes.get("image"); const video = hashes.get("video"); if (image === undefined || video === undefined) { throw fail( "live photo ZIP does not hold both an image and a video", ); } return `${image}:${video}`; }, }; }; // Decrypt `stream` straight to `destination`, one plaintext chunk at a time, // under the atomic writer's temp-then-rename discipline. Memory stays bounded // by the chunk size: each decrypted chunk is written to the temp file and // dropped. The rename happens only after the stream authenticates as terminated // on TAG_FINAL; a truncated stream throws and leaves the destination untouched. // Returns the plaintext length written. // // `original` is the file whose original this is (none for a thumbnail, which // has no recorded hash). When its metadata has a hash, the decrypted bytes // must match it or nothing is stored. Both a plain file and a live photo's // parts are hashed as they stream. The mismatch error is not retried. const decryptToTemp = async ( destination: string, stream: ReadableStream, header: Uint8Array, key: Uint8Array, onProgress?: ProgressCallback, original?: EnteFile, ): Promise => { const expected = original?.metadata.hash; const hasher = original === undefined || expected === undefined ? undefined : original.metadata.fileType === "livePhoto" ? livePhotoHasher(original.id) : fileHasher(); let bytesWritten = 0; try { await stageAtomic(destination, async (handle) => { bytesWritten = await streamDecrypt( stream, header, key, async (plaintext) => { hasher?.update(plaintext); await handle.write(plaintext); }, onProgress, ); if (original === undefined || hasher === undefined) return; const actual = hasher.digest(); if (actual !== expected) { throw new Error( `download: file ${original.id}: content hash ${actual} does not match the hash its uploader recorded, ${expected}`, ); } }); } catch (err) { // Cancel the body so its connection is closed now rather than held // until the stream is garbage collected. A backup run carries on past // a failed file, so without this every failure would hold a socket. // This covers every failure, including a temp file that cannot be // opened and a header that is rejected before the body is read. await stream.cancel(err).catch(() => undefined); throw err; } return bytesWritten; }; // Fetch a stream and decrypt it to `destination`, retrying the whole sequence. // // The request is only the first third of a download. `getXStream` returns as // soon as headers arrive, and the bytes are pulled here, so a socket reset // mid-body — the dominant failure mode for multi-megabyte photos over a CDN — // throws in `streamDecrypt` and never reaches `ApiClient` at all. Retrying the // request alone would miss it entirely. // // The client's own retry is therefore switched off for these two calls: with // both layers active the budgets would multiply, and the library default of // four attempts would mean sixteen requests for one file. The policy comes // from the client so a caller that configured one gets it here too. // // Because the plaintext is streamed to disk rather than buffered, the atomic // write is part of the retried unit. A retry starts the file over from byte // zero — the secretstream pull state is not resumable and there is no Range // support — staging into a fresh temp file each time: a failed attempt writes // and then removes its own temp file, and only the attempt that reaches // TAG_FINAL renames one into place, so a download that needed three tries still // performs exactly one rename over the destination. const fetchAndDecrypt = async ( api: ApiClient, openStream: () => Promise>, header: Uint8Array, key: Uint8Array, destination: string, onProgress?: ProgressCallback, original?: EnteFile, ): Promise => withRetry(async () => { const stream = await openStream(); return decryptToTemp( destination, stream, header, key, onProgress, original, ); }, api.getRetryOptions()); export const downloadFile = async ( api: ApiClient, file: EnteFile, outPath?: string, onProgress?: ProgressCallback, ): Promise => { // `outPath` is the caller's and is used as is; the title is the server's // and is sanitized so it can only name a file in the current directory. const resolvedPath = outPath ?? sanitizeFileName(file.metadata.title, `file-${file.id}`); const header = fromBase64(file.file.decryptionHeader); const bytesWritten = await fetchAndDecrypt( api, () => api.getFileStream(file.id, { retry: false }), header, file.key, resolvedPath, onProgress, file, ); return { path: resolvedPath, bytesWritten }; }; export const downloadThumbnail = async ( api: ApiClient, file: EnteFile, outPath?: string, onProgress?: ProgressCallback, ): Promise => { const resolvedPath = outPath ?? `thumb_${sanitizeFileName(file.metadata.title, `file-${file.id}`)}`; const header = fromBase64(file.thumbnail.decryptionHeader); const bytesWritten = await fetchAndDecrypt( api, () => api.getThumbnailStream(file.id, { retry: false }), header, file.key, resolvedPath, onProgress, ); return { path: resolvedPath, bytesWritten }; };