Files
Shade/packages/shade-files/tests/security/replay.test.ts
Sterister fa770d3063
Some checks failed
Test / test (push) Has been cancelled
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

120 lines
4.3 KiB
TypeScript

import { describe, test, expect, beforeAll, afterAll } from 'bun:test';
import { setupFileRig, type FileTestRig } from '../integration/helpers/rig.js';
import { ConflictError, NotFoundError, type FileEntry } from '../../src/index.js';
/**
* Replay-window: the dispatcher rejects requests where `signedAt` is more
* than ±5 min from the server clock. Plus: idempotent retries on the same
* mutation key produce a single side-effect even with stale signedAt.
*/
describe('Replay window + idempotent retry', () => {
let rig: FileTestRig;
let writeCount = 0;
const blobs = new Map<string, Uint8Array>();
beforeAll(async () => {
rig = await setupFileRig({
mkdir: async (ctx) => {
if (blobs.has(ctx.path)) throw new ConflictError('exists');
blobs.set(ctx.path, new Uint8Array(0));
const e: FileEntry = {
name: ctx.path.split('/').filter(Boolean).pop() ?? '',
kind: 'dir', size: 0, mtime: Date.now(), metadata: {},
};
return { entry: e };
},
write: async (ctx) => {
writeCount++;
if (ctx.args.content.kind !== 'inline') throw new Error('inline expected');
blobs.set(ctx.args.path, ctx.args.content.bytes);
const e: FileEntry = {
name: ctx.args.path.split('/').filter(Boolean).pop() ?? '',
kind: 'file',
size: ctx.args.content.bytes.byteLength,
mtime: Date.now(),
metadata: { sha256: ctx.args.content.sha256 },
};
return { entry: e };
},
stat: async (ctx) => {
if (!blobs.has(ctx.path)) throw new NotFoundError(ctx.path);
return {
name: ctx.path.split('/').filter(Boolean).pop() ?? '',
kind: 'file', size: 0, mtime: 0, metadata: {},
};
},
});
});
afterAll(async () => {
await rig.teardown();
});
test('idempotent retry: same key + same args → single side-effect', async () => {
writeCount = 0;
// Idempotency keys are exactly 22 chars, base64url alphabet.
const key = 'replay_key_1234567890A';
const data = new Uint8Array([1, 2, 3]);
const r1 = await rig.fs.write('/replay.bin', data, { idempotencyKey: key });
const r2 = await rig.fs.write('/replay.bin', data, { idempotencyKey: key });
const r3 = await rig.fs.write('/replay.bin', data, { idempotencyKey: key });
expect(writeCount).toBe(1);
expect(r1.entry.size).toBe(3);
expect(r2.entry.size).toBe(3);
expect(r3.entry.size).toBe(3);
});
test('out-of-window signedAt → InvalidSignatureError (skew rejection)', async () => {
// Build a custom client that LIES about signedAt. We hand-craft an
// RpcRequest envelope and ship it via the underlying channel.
const {
ShadeFileRpcChannel,
PendingRpcRegistry,
attachClientRouting,
KIND_STAT_V1,
generateRequestId,
} = await import('../../src/index.js');
const aliceChannel = new ShadeFileRpcChannel(rig.alice);
const alicePending = new PendingRpcRegistry();
attachClientRouting(aliceChannel, alicePending);
const requestId = generateRequestId();
const stalePromise = alicePending.register<unknown>(requestId, { timeoutMs: 3000 });
await aliceChannel.send('bob', {
kind: KIND_STAT_V1,
id: requestId,
args: { path: '/replay.bin' },
sig: 'unsigned',
signedAt: Date.now() - 10 * 60 * 1000, // 10 min in the past — outside ±5 min window
});
await expect(stalePromise).rejects.toThrow(/replay window|signature/i);
aliceChannel.destroy();
});
test('signedAt far in the future → also rejected', async () => {
const {
ShadeFileRpcChannel,
PendingRpcRegistry,
attachClientRouting,
KIND_STAT_V1,
generateRequestId,
} = await import('../../src/index.js');
const aliceChannel = new ShadeFileRpcChannel(rig.alice);
const alicePending = new PendingRpcRegistry();
attachClientRouting(aliceChannel, alicePending);
const requestId = generateRequestId();
const promise = alicePending.register<unknown>(requestId, { timeoutMs: 3000 });
await aliceChannel.send('bob', {
kind: KIND_STAT_V1,
id: requestId,
args: { path: '/replay.bin' },
sig: 'unsigned',
signedAt: Date.now() + 10 * 60 * 1000,
});
await expect(promise).rejects.toThrow(/replay window|signature/i);
aliceChannel.destroy();
});
});