Files
Shade/packages/shade-streams/tests/nonce.test.ts

101 lines
3.3 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 { describe, test, expect } from 'bun:test';
import { ValidationError } from '@shade/core';
import { buildChunkNonce, buildChunkAad, MAX_SEQ, STREAM_NONCE_BYTES } from '../src/index.js';
describe('buildChunkNonce', () => {
test('produces 12-byte output', () => {
expect(buildChunkNonce(0, 0).length).toBe(STREAM_NONCE_BYTES);
});
test('encodes laneId as u32 BE in bytes [0..4)', () => {
const n = buildChunkNonce(0x01020304, 0);
expect(n[0]).toBe(0x01);
expect(n[1]).toBe(0x02);
expect(n[2]).toBe(0x03);
expect(n[3]).toBe(0x04);
});
test('encodes seq as u64 BE in bytes [4..12)', () => {
const n = buildChunkNonce(0, 0x0102030405060708n);
expect(n[4]).toBe(0x01);
expect(n[5]).toBe(0x02);
expect(n[6]).toBe(0x03);
expect(n[7]).toBe(0x04);
expect(n[8]).toBe(0x05);
expect(n[9]).toBe(0x06);
expect(n[10]).toBe(0x07);
expect(n[11]).toBe(0x08);
});
test('different (laneId, seq) yields different nonces', () => {
const seen = new Set<string>();
for (let lane = 0; lane < 4; lane++) {
for (let seq = 0; seq < 100; seq++) {
const n = buildChunkNonce(lane, seq);
const key = Array.from(n).join(',');
expect(seen.has(key)).toBe(false);
seen.add(key);
}
}
});
test('accepts both number and bigint seq', () => {
const a = buildChunkNonce(1, 42);
const b = buildChunkNonce(1, 42n);
expect(a).toEqual(b);
});
test('handles MAX_SEQ', () => {
const n = buildChunkNonce(0, MAX_SEQ);
for (let i = 4; i < 12; i++) expect(n[i]).toBe(0xff);
});
test('rejects out-of-range laneId', () => {
expect(() => buildChunkNonce(-1, 0)).toThrow(ValidationError);
expect(() => buildChunkNonce(0x1_0000_0000, 0)).toThrow(ValidationError);
expect(() => buildChunkNonce(1.5, 0)).toThrow(ValidationError);
});
test('rejects out-of-range seq', () => {
expect(() => buildChunkNonce(0, -1)).toThrow(ValidationError);
expect(() => buildChunkNonce(0, MAX_SEQ + 1n)).toThrow(ValidationError);
});
});
describe('buildChunkAad', () => {
test('produces 29-byte output (16+4+8+1)', () => {
const id = new Uint8Array(16);
expect(buildChunkAad(id, 0, 0, false).length).toBe(29);
});
test('embeds streamId, laneId, seq, isLast in canonical layout', () => {
const id = new Uint8Array(16).fill(0xaa);
const aad = buildChunkAad(id, 0x01020304, 0x05060708090a0b0cn, true);
for (let i = 0; i < 16; i++) expect(aad[i]).toBe(0xaa);
expect(aad[16]).toBe(0x01);
expect(aad[17]).toBe(0x02);
expect(aad[18]).toBe(0x03);
expect(aad[19]).toBe(0x04);
expect(aad[20]).toBe(0x05);
expect(aad[27]).toBe(0x0c);
expect(aad[28]).toBe(0x01);
});
test('isLast=false sets last byte to 0x00', () => {
const id = new Uint8Array(16);
const aad = buildChunkAad(id, 0, 0, false);
expect(aad[28]).toBe(0x00);
});
test('rejects wrong-length streamId', () => {
expect(() => buildChunkAad(new Uint8Array(15), 0, 0, false)).toThrow(ValidationError);
expect(() => buildChunkAad(new Uint8Array(17), 0, 0, false)).toThrow(ValidationError);
});
test('rejects out-of-range laneId / seq', () => {
const id = new Uint8Array(16);
expect(() => buildChunkAad(id, -1, 0, false)).toThrow(ValidationError);
expect(() => buildChunkAad(id, 0, -1, false)).toThrow(ValidationError);
});
});