Files
Shade/packages/shade-streams/tests/aead.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

146 lines
5.5 KiB
TypeScript

import { describe, test, expect } from 'bun:test';
import { SubtleCryptoProvider } from '@shade/crypto-web';
import {
aesGcmEncryptWithNonce,
aesGcmDecryptWithNonce,
buildChunkNonce,
buildChunkAad,
deriveStreamKey,
deriveLaneKey,
StreamDecryptionError,
} from '../src/index.js';
const crypto = new SubtleCryptoProvider();
async function laneKey(): Promise<{ key: Uint8Array; streamId: Uint8Array }> {
const secret = new Uint8Array(32).fill(0x42);
const streamId = new Uint8Array(16).fill(0x99);
const sk = await deriveStreamKey(crypto, secret, streamId);
const lk = await deriveLaneKey(crypto, sk, streamId, 0);
return { key: lk, streamId };
}
describe('aesGcmEncryptWithNonce / aesGcmDecryptWithNonce', () => {
test('encrypt → decrypt roundtrip', async () => {
const { key, streamId } = await laneKey();
const nonce = buildChunkNonce(0, 0);
const aad = buildChunkAad(streamId, 0, 0, false);
const plaintext = new TextEncoder().encode('hello shade streams');
const ct = await aesGcmEncryptWithNonce(key, nonce, plaintext, aad);
const pt = await aesGcmDecryptWithNonce(key, nonce, ct, aad);
expect(new TextDecoder().decode(pt)).toBe('hello shade streams');
});
test('produces ciphertext length = plaintext + 16-byte tag', async () => {
const { key, streamId } = await laneKey();
const plaintext = new Uint8Array(1024);
const ct = await aesGcmEncryptWithNonce(
key,
buildChunkNonce(0, 0),
plaintext,
buildChunkAad(streamId, 0, 0, false),
);
expect(ct.length).toBe(1024 + 16);
});
test('handles empty plaintext', async () => {
const { key, streamId } = await laneKey();
const nonce = buildChunkNonce(0, 0);
const aad = buildChunkAad(streamId, 0, 0, true);
const ct = await aesGcmEncryptWithNonce(key, nonce, new Uint8Array(0), aad);
expect(ct.length).toBe(16); // tag only
const pt = await aesGcmDecryptWithNonce(key, nonce, ct, aad);
expect(pt.length).toBe(0);
});
test('handles 1 MiB plaintext (default chunk size)', async () => {
const { key, streamId } = await laneKey();
const nonce = buildChunkNonce(0, 0);
const aad = buildChunkAad(streamId, 0, 0, false);
const plaintext = crypto.randomBytes(1024 * 1024);
const ct = await aesGcmEncryptWithNonce(key, nonce, plaintext, aad);
const pt = await aesGcmDecryptWithNonce(key, nonce, ct, aad);
expect(pt).toEqual(plaintext);
});
test('different nonces with same key produce different ciphertexts', async () => {
const { key, streamId } = await laneKey();
const aad = buildChunkAad(streamId, 0, 0, false);
const plaintext = new TextEncoder().encode('same plaintext');
const ct1 = await aesGcmEncryptWithNonce(key, buildChunkNonce(0, 0), plaintext, aad);
const ct2 = await aesGcmEncryptWithNonce(key, buildChunkNonce(0, 1), plaintext, aad);
expect(ct1).not.toEqual(ct2);
});
test('tampered ciphertext byte → StreamDecryptionError', async () => {
const { key, streamId } = await laneKey();
const nonce = buildChunkNonce(0, 0);
const aad = buildChunkAad(streamId, 0, 0, false);
const ct = await aesGcmEncryptWithNonce(key, nonce, new TextEncoder().encode('hi'), aad);
ct[0] ^= 0x01;
await expect(aesGcmDecryptWithNonce(key, nonce, ct, aad)).rejects.toThrow(
StreamDecryptionError,
);
});
test('tampered tag byte → StreamDecryptionError', async () => {
const { key, streamId } = await laneKey();
const nonce = buildChunkNonce(0, 0);
const aad = buildChunkAad(streamId, 0, 0, false);
const ct = await aesGcmEncryptWithNonce(key, nonce, new TextEncoder().encode('hi'), aad);
ct[ct.length - 1] ^= 0x80;
await expect(aesGcmDecryptWithNonce(key, nonce, ct, aad)).rejects.toThrow(
StreamDecryptionError,
);
});
test('wrong AAD → StreamDecryptionError', async () => {
const { key, streamId } = await laneKey();
const nonce = buildChunkNonce(0, 0);
const aadEnc = buildChunkAad(streamId, 0, 0, false);
const aadDec = buildChunkAad(streamId, 0, 0, true); // isLast flipped
const ct = await aesGcmEncryptWithNonce(key, nonce, new TextEncoder().encode('hi'), aadEnc);
await expect(aesGcmDecryptWithNonce(key, nonce, ct, aadDec)).rejects.toThrow(
StreamDecryptionError,
);
});
test('wrong nonce → StreamDecryptionError', async () => {
const { key, streamId } = await laneKey();
const aad = buildChunkAad(streamId, 0, 0, false);
const ct = await aesGcmEncryptWithNonce(
key,
buildChunkNonce(0, 0),
new TextEncoder().encode('hi'),
aad,
);
await expect(
aesGcmDecryptWithNonce(key, buildChunkNonce(0, 1), ct, aad),
).rejects.toThrow(StreamDecryptionError);
});
test('wrong key → StreamDecryptionError', async () => {
const { streamId } = await laneKey();
const nonce = buildChunkNonce(0, 0);
const aad = buildChunkAad(streamId, 0, 0, false);
const k1 = new Uint8Array(32).fill(1);
const k2 = new Uint8Array(32).fill(2);
const ct = await aesGcmEncryptWithNonce(k1, nonce, new TextEncoder().encode('hi'), aad);
await expect(aesGcmDecryptWithNonce(k2, nonce, ct, aad)).rejects.toThrow(
StreamDecryptionError,
);
});
test('rejects non-12-byte nonce', async () => {
const { key, streamId } = await laneKey();
const aad = buildChunkAad(streamId, 0, 0, false);
await expect(
aesGcmEncryptWithNonce(key, new Uint8Array(11), new Uint8Array(0), aad),
).rejects.toThrow();
await expect(
aesGcmDecryptWithNonce(key, new Uint8Array(13), new Uint8Array(16), aad),
).rejects.toThrow();
});
});