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>
83 lines
3.3 KiB
TypeScript
83 lines
3.3 KiB
TypeScript
import type { Hono } from 'hono';
|
|
import type { CryptoProvider } from '@shade/core';
|
|
import { createPrekeyRoutes } from './routes.js';
|
|
import { MemoryPrekeyStore } from './memory-store.js';
|
|
import type { PrekeyStore } from './store.js';
|
|
import type { PrekeyServerEvents } from './events.js';
|
|
import {
|
|
KeyTransparencyService,
|
|
type KeyTransparencyConfig,
|
|
} from './kt-integration.js';
|
|
|
|
export { createPrekeyRoutes } from './routes.js';
|
|
export { MemoryPrekeyStore } from './memory-store.js';
|
|
export type { PrekeyStore } from './store.js';
|
|
export { verifyPayload, signPayload, canonicalizePayload, validateAddress } from './auth.js';
|
|
export { KeyTransparencyService, encodeSthForWire, encodeProofForWire } from './kt-integration.js';
|
|
export type { KeyTransparencyConfig } from './kt-integration.js';
|
|
export { createKTRoutes } from './kt-routes.js';
|
|
|
|
/**
|
|
* Create a standalone Shade Prekey Server.
|
|
*
|
|
* Requires a CryptoProvider for signature verification on write routes.
|
|
*
|
|
* Standalone:
|
|
* const crypto = new SubtleCryptoProvider();
|
|
* const server = createPrekeyServer({ crypto });
|
|
* export default { port: 3900, fetch: server.fetch };
|
|
*
|
|
* Embedded in another Hono app:
|
|
* const app = new Hono();
|
|
* app.route('/shade', createPrekeyServer({ crypto }));
|
|
*/
|
|
export function createPrekeyServer(options: {
|
|
crypto: CryptoProvider;
|
|
store?: PrekeyStore;
|
|
disableRateLimit?: boolean;
|
|
events?: PrekeyServerEvents;
|
|
/** Existing KT service (already initialized via `KeyTransparencyService.create`). */
|
|
keyTransparency?: KeyTransparencyService;
|
|
}): Hono {
|
|
const store = options.store ?? new MemoryPrekeyStore();
|
|
const routesOptions: Parameters<typeof createPrekeyRoutes>[2] = {};
|
|
if (options.disableRateLimit !== undefined) {
|
|
routesOptions.disableRateLimit = options.disableRateLimit;
|
|
}
|
|
if (options.events !== undefined) {
|
|
routesOptions.events = options.events;
|
|
}
|
|
if (options.keyTransparency !== undefined) {
|
|
routesOptions.keyTransparency = options.keyTransparency;
|
|
}
|
|
return createPrekeyRoutes(store, options.crypto, routesOptions);
|
|
}
|
|
|
|
/**
|
|
* Convenience: create both the KT service and the prekey server in one call.
|
|
* Async because `KeyTransparencyService.create` reads existing state.
|
|
*/
|
|
export async function createPrekeyServerWithKT(options: {
|
|
crypto: CryptoProvider;
|
|
store?: PrekeyStore;
|
|
disableRateLimit?: boolean;
|
|
events?: PrekeyServerEvents;
|
|
keyTransparency: KeyTransparencyConfig;
|
|
}): Promise<{ app: Hono; kt: KeyTransparencyService }> {
|
|
const kt = await KeyTransparencyService.create(options.crypto, options.keyTransparency);
|
|
const passOpts: Parameters<typeof createPrekeyServer>[0] = {
|
|
crypto: options.crypto,
|
|
keyTransparency: kt,
|
|
};
|
|
if (options.store !== undefined) passOpts.store = options.store;
|
|
if (options.disableRateLimit !== undefined) passOpts.disableRateLimit = options.disableRateLimit;
|
|
if (options.events !== undefined) passOpts.events = options.events;
|
|
const app = createPrekeyServer(passOpts);
|
|
return { app, kt };
|
|
}
|
|
|
|
export { RateLimiter, MemoryRateLimitStore } from './rate-limit.js';
|
|
export type { RateLimitStore, RateLimitConfig } from './rate-limit.js';
|
|
export { PrekeyServerEvents, shortHash as serverShortHash } from './events.js';
|
|
export type { PrekeyServerEvent, PrekeyServerEventName, PrekeyServerEventMap, PrekeyServerEventListener } from './events.js';
|