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

111 lines
4.4 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 { SubtleCryptoProvider } from '@shade/crypto-web';
import { ValidationError } from '@shade/core';
import {
deriveStreamKey,
deriveLaneKey,
generateStreamId,
generateStreamSecret,
} from '../src/index.js';
const crypto = new SubtleCryptoProvider();
function hex(bytes: Uint8Array): string {
return Array.from(bytes, (b) => b.toString(16).padStart(2, '0')).join('');
}
describe('deriveStreamKey', () => {
test('produces 32-byte output', async () => {
const secret = generateStreamSecret(crypto);
const id = generateStreamId(crypto);
const key = await deriveStreamKey(crypto, secret, id);
expect(key.length).toBe(32);
});
test('is deterministic for the same inputs', async () => {
const secret = new Uint8Array(32).fill(7);
const id = new Uint8Array(16).fill(3);
const a = await deriveStreamKey(crypto, secret, id);
const b = await deriveStreamKey(crypto, secret, id);
expect(hex(a)).toBe(hex(b));
});
test('changes with streamSecret', async () => {
const id = new Uint8Array(16).fill(1);
const a = await deriveStreamKey(crypto, new Uint8Array(32).fill(1), id);
const b = await deriveStreamKey(crypto, new Uint8Array(32).fill(2), id);
expect(hex(a)).not.toBe(hex(b));
});
test('changes with streamId', async () => {
const secret = new Uint8Array(32).fill(9);
const a = await deriveStreamKey(crypto, secret, new Uint8Array(16).fill(1));
const b = await deriveStreamKey(crypto, secret, new Uint8Array(16).fill(2));
expect(hex(a)).not.toBe(hex(b));
});
test('rejects wrong-length streamSecret', async () => {
const id = new Uint8Array(16);
await expect(deriveStreamKey(crypto, new Uint8Array(31), id)).rejects.toThrow(ValidationError);
await expect(deriveStreamKey(crypto, new Uint8Array(33), id)).rejects.toThrow(ValidationError);
});
test('rejects wrong-length streamId', async () => {
const secret = new Uint8Array(32);
await expect(deriveStreamKey(crypto, secret, new Uint8Array(15))).rejects.toThrow(ValidationError);
await expect(deriveStreamKey(crypto, secret, new Uint8Array(17))).rejects.toThrow(ValidationError);
});
});
describe('deriveLaneKey', () => {
test('produces 32-byte output', async () => {
const streamKey = new Uint8Array(32).fill(5);
const id = new Uint8Array(16).fill(2);
const laneKey = await deriveLaneKey(crypto, streamKey, id, 0);
expect(laneKey.length).toBe(32);
});
test('is deterministic for the same (streamKey, streamId, laneId)', async () => {
const streamKey = new Uint8Array(32).fill(5);
const id = new Uint8Array(16).fill(2);
const a = await deriveLaneKey(crypto, streamKey, id, 7);
const b = await deriveLaneKey(crypto, streamKey, id, 7);
expect(hex(a)).toBe(hex(b));
});
test('different laneId yields different lane keys', async () => {
const streamKey = new Uint8Array(32).fill(5);
const id = new Uint8Array(16).fill(2);
const a = await deriveLaneKey(crypto, streamKey, id, 0);
const b = await deriveLaneKey(crypto, streamKey, id, 1);
expect(hex(a)).not.toBe(hex(b));
});
test('different streamKey yields different lane keys', async () => {
const id = new Uint8Array(16).fill(2);
const a = await deriveLaneKey(crypto, new Uint8Array(32).fill(5), id, 0);
const b = await deriveLaneKey(crypto, new Uint8Array(32).fill(6), id, 0);
expect(hex(a)).not.toBe(hex(b));
});
test('rejects laneId outside u32 range', async () => {
const streamKey = new Uint8Array(32);
const id = new Uint8Array(16);
await expect(deriveLaneKey(crypto, streamKey, id, -1)).rejects.toThrow(ValidationError);
await expect(deriveLaneKey(crypto, streamKey, id, 0x1_0000_0000)).rejects.toThrow(
ValidationError,
);
await expect(deriveLaneKey(crypto, streamKey, id, 1.5)).rejects.toThrow(ValidationError);
});
test('full pipeline: streamSecret → streamKey → laneKey is deterministic across both sides', async () => {
const secret = new Uint8Array(32).fill(0xab);
const id = new Uint8Array(16).fill(0xcd);
const senderStreamKey = await deriveStreamKey(crypto, secret, id);
const senderLaneKey = await deriveLaneKey(crypto, senderStreamKey, id, 3);
const receiverStreamKey = await deriveStreamKey(crypto, secret, id);
const receiverLaneKey = await deriveLaneKey(crypto, receiverStreamKey, id, 3);
expect(hex(senderLaneKey)).toBe(hex(receiverLaneKey));
});
});