Files
Shade/packages/shade-streams/src/nonce.ts

63 lines
2.1 KiB
TypeScript
Raw Normal View History

feat(files): @shade/files 0.3.0 — E2EE filesystem RPC primitive M-Files-1..6 land the full files-RPC layer + everything 0.3.0 needs to ship. Apps keep their own UI; this layer ships the typed RPC, the streams bridge for content I/O, and production hooks (rate limit, retention, fingerprint gate, metrics). @shade/files (NEW) - Standard ops: list/stat/mkdir/delete/move/read/write/getThumbnail with Zod-validated wire schemas + clean user-handler types. - Custom ops: typed via TypeScript declaration merging on CustomOpsMap + per-op Zod schemas; client.custom('app.foo', {...}) is fully typed. - Content I/O: inline (≤ 256 KiB plaintext) base64-in-RPC; streams (> 256 KiB) ride @shade/transfer via userMetadata.shadeFilesWriteId / shadeFilesReadStreamId correlation. Server-side TransformStream bridges accept inbound transfers immediately (engine rejects chunks that arrive before accept) and park the readable for the matching RPC. - Directory ops: walk(path, opts) async-iterable depth-first walker; uploadDirectory()/downloadDirectory() with bounded concurrency pool (default 4, cap 16), aggregated progress, abort. - Production hooks (callback-based, vendor-neutral): rate-limit (op + byte), idempotency cache (LRU + TTL + in-flight de-dupe), path policy (traversal + percent-decode hardening), fingerprint gate (required/optional/reject), pluggable Ed25519 sig verification with ±5 min replay window, onMetric sink (standard names). - React hooks (subpath @shade/files/react): ShadeFilesProvider, useShadeFiles, useFileList, useFileTransfer/Upload/Download. - Shade.files.serve(handler) + Shade.files.client(peer) high-level entrypoint in @shade/sdk; lazy + memoized; one handler per Shade. Wire format bump - @shade/proto wire VERSION 0x01 → 0x02. Length prefixes changed from u16 to u32. The previous u16 silently truncated payloads above 64 KiB — a hard correctness ceiling that blocked inline file ops up to 256 KiB. Wire-incompatible with 0.2.x peers; new sessions only. Cross-platform Kotlin port (android/shade-android) updated to match; test-vectors/wire-format.json regenerated. Concurrency safety - ShadeSessionManager.encrypt/.decrypt now run under per-peer mutex. Concurrent decryptions of the same peer raced ratchet state (manifested as sporadic "Failed to decrypt — wrong key or tampered data" under load — surfaced once concurrent uploadDirectory pumped many writes in flight). Encrypt was already serialized via Shade.send's encryptChains; decrypt is now serialized at the manager layer too. @shade/streams extension - StreamMetadata.userMetadata?: Record<string, string> for application-level key/value pairs that round-trip verbatim through stream-init plaintext. Used by @shade/files for write/read correlation; available to any consumer. @shade/sdk extension - Shade.files getter (lazy + memoized). - BackgroundHooks.onPruneFiles + periodic timer (default 5 min) + BackgroundTasks.setHook(name, fn) for runtime hook registration. Bundles in-flight 0.2.0 work - packages/shade-streams/, packages/shade-transfer/, related shade-sdk streams-bridge + shade-widgets transfer hooks were uncommitted prior to this session. Including them keeps the workspace consistent at 0.3.0 since @shade/files depends on them. Tests - 74 new tests in @shade/files (572 → 646 workspace pass; 0 fail; 3× stable). Coverage spans unit (inline-threshold + concurrency), integration (read-write inline + streams up to 1 MiB, walk + upload/download directory, custom-op, metrics, SDK namespace end-to-end), and security (tampered-envelope sig verification, replay window, fingerprint gate, rate-limit + quota). Release artifacts - All packages bumped to 0.3.0 via scripts/bump-version.ts. - scripts/publish-all.ts PACKAGES updated with shade-files in topological order (after shade-transfer, before shade-sdk). - bun run publish:dry clean (14 packed, 0 failed). - examples/08-files-browser/ — three-process CLI demo (prekey + Bob server + Alice CLI) covering list/stat/mkdir/delete/upload/download. - docs/files.md — full API + design doc. - CHANGELOG.md 0.3.0 entry. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-02 14:00:01 +02:00
import { ValidationError } from '@shade/core';
export const STREAM_NONCE_BYTES = 12;
/** Maximum chunk seq value (u64 max). Hard-spec'd hard limit. */
export const MAX_SEQ = 0xffff_ffff_ffff_ffffn;
/**
* Construct the deterministic AES-GCM nonce for a stream chunk.
*
* nonce[0..4] = u32_be(laneId)
* nonce[4..12] = u64_be(seq)
*
* Per (laneId, seq) is unique — combined with the lane-specific key, this
* guarantees AES-GCM nonce-uniqueness even across multiple parallel lanes.
*/
export function buildChunkNonce(laneId: number, seq: number | bigint): Uint8Array {
if (!Number.isInteger(laneId) || laneId < 0 || laneId > 0xffff_ffff) {
throw new ValidationError(`laneId must fit in u32: ${laneId}`, 'laneId');
}
const seqBig = typeof seq === 'bigint' ? seq : BigInt(seq);
if (seqBig < 0n || seqBig > MAX_SEQ) {
throw new ValidationError(`seq must fit in u64 (>= 0): ${seq}`, 'seq');
}
const out = new Uint8Array(STREAM_NONCE_BYTES);
const view = new DataView(out.buffer);
view.setUint32(0, laneId, false);
view.setBigUint64(4, seqBig, false);
return out;
}
/**
* Build the AAD bound to a stream chunk. Computed implicitly on both sides
* from the chunk header (never transmitted as-is). Tampering with any header
* field invalidates the AEAD tag.
*
* aad = streamId(16) || u32_be(laneId) || u64_be(seq) || u8(isLast)
*/
export function buildChunkAad(
streamId: Uint8Array,
laneId: number,
seq: number | bigint,
isLast: boolean,
): Uint8Array {
if (streamId.length !== 16) {
throw new ValidationError('streamId must be 16 bytes', 'streamId');
}
if (!Number.isInteger(laneId) || laneId < 0 || laneId > 0xffff_ffff) {
throw new ValidationError(`laneId must fit in u32: ${laneId}`, 'laneId');
}
const seqBig = typeof seq === 'bigint' ? seq : BigInt(seq);
if (seqBig < 0n || seqBig > MAX_SEQ) {
throw new ValidationError(`seq must fit in u64 (>= 0): ${seq}`, 'seq');
}
const out = new Uint8Array(16 + 4 + 8 + 1);
out.set(streamId, 0);
const view = new DataView(out.buffer);
view.setUint32(16, laneId, false);
view.setBigUint64(20, seqBig, false);
out[28] = isLast ? 0x01 : 0x00;
return out;
}