Sterister
e6fdf31b49
Some checks failed
Test / test (push) Has been cancelled
Cross-platform vectors / TypeScript vectors (bun) (push) Has been cancelled
Cross-platform vectors / Kotlin vectors (gradle) (push) Has been cancelled
Docker build and publish / docker (push) Has been cancelled
Publish / publish (push) Has been cancelled
V3.1 → V3.12 consolidated and tagged for the first GA release. Wire format unchanged from 0.4.x — 4.0 peers interoperate with 0.4.x peers byte-for-byte. The version bump is semantic: audit-cycle complete, opt-in surface fully exposed, threat model refreshed for every new surface. Highlights: - All 24 @shade/* packages bumped to 4.0.0 in lockstep. - CHANGELOG 4.0.0 section is the canonical manifest of what landed. - THREAT-MODEL extended (§10 fingerprint gates, §11 WebRTC P2P, §12 Web-Worker boundary) + residual-risks table refreshed. - OpenAPI now covers all 27 routes: prekey, transfer, KT, inbox, bridge, observer, /metrics, /healthz, /ready. - MIGRATION 0.3.x → 4.0 documented + smoke-tested against shade migrate-storage on a real SQLite DB. - docs/audit/REVIEW-BUNDLE.md + SCOPE.md ready for external reviewer. - scripts/soak.ts harness for the GA-stable 2-week soak window. - All V*.md plans archived under docs/archive/ with Status: Done. - Voice/Video carved out into V5.0; 4.0 audit focuses on the frozen non-realtime stack. Tests: TS 1000/1000 + Kotlin 11/11 cross-platform vectors green. Docker: gt.zyon.no/stian/shade-prekey:4.0.0 builds and reports version 4.0.0 on /health. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1.6 KiB
1.6 KiB
PROJECT_NAME
A Shade-enabled Bun + Hono server. Encrypted messages in/out via two HTTP endpoints.
Prerequisites
A running Shade prekey server. The default is __PREKEY_SERVER__. You can either:
- Run one locally:
docker run -p 3900:3900 shade-prekey-server - Override with
SHADE_PREKEY_SERVER=...in.env
Run
bun install
bun run start
The server registers itself with the prekey server on startup.
Endpoints
Send an encrypted message
curl -X POST http://localhost:3000/send \
-H "Content-Type: application/json" \
-d '{"to": "peer-name", "message": "hello"}'
Returns a ShadeEnvelope you can forward to the peer via any transport.
Receive an encrypted envelope
curl -X POST http://localhost:3000/receive \
-H "Content-Type: application/json" \
-d '{"from": "peer-name", "envelope": {...}}'
Returns the decrypted plaintext.
Stream-state retention
Resumable file transfers persist a per-stream record. The template runs
a daily cron that drops anything idle for more than
SHADE_STREAM_RETENTION_DAYS days (default 14). Override at
deploy:
SHADE_STREAM_RETENTION_DAYS=7 bun run start
See docs/streams.md § Retention for the
full guidance and tuning per use case.
Next steps
- Wire a real delivery layer (WebSocket, HTTP push, etc.)
- Run
shade dashboardto watch live activity - Compare fingerprints with peers out-of-band before trusting sessions
- Walk through
docs/PRODUCTION-CHECKLIST.mdbefore going live