SPB Git

Repository Public

README.md 2.5 KB 46 lines markdown

1# SP Vault23Self-hosted, end-to-end encrypted password manager and secrets platform — https://vault.spboucher.ai —4with a web app, native macOS and iOS apps (Swift/SwiftUI) and a separate, clearly labelled managed-secrets5subsystem for services and AI agents.67**Status: built and tested, not independently audited.** Read `SECURITY.md` before trusting it with anything.89| Read | For |10|---|---|11| `SECURITY.md` | Guarantees, explicit limits, verification status, launch gates |12| `THREAT_MODEL.md` | Adversaries and residual risks |13| `docs/crypto-spec/SPV1.md` | The protocol: key hierarchy, envelopes, pairing, recovery, rollback limits |14| `docs/architecture/ADR.md`, `openapi.yaml` | Decisions and the API |15| `docs/recovery/RECOVERY.md` | Recovery kit, rotation, rekey, restore drill |16| `docs/operations/OPERATIONS.md` | MacLustr deployment, backups, RPO/RTO, incidents |17| `services/managed-secrets/THREAT_MODEL.md` | Connect / Agents (not zero-knowledge) |1819## Layout2021```22packages/protocol/            SPV1 in TypeScript (WebCrypto + @hpke/core), items, generator, TOTP, URL matching, import/export23packages/crypto-test-vectors/ vectors produced by TypeScript and by Swift, verified by both24packages/agent-client/        signed-request client for workloads and agents25services/api/                 Fastify + PostgreSQL: auth (passkeys), devices, sync, attachments, relay, audit, Connect26services/managed-secrets/     isolated process holding the managed-secret key; brokered HTTP / HMAC operations27apps/web/                     React web vault (engine in src/core, UI in src/ui)28apple/SharedVaultKit/         SPV1 in Swift (CryptoKit, Secure Enclave), models, client engine29apple/App, apple/AutoFill     macOS + iOS apps and credential-provider extensions (xcodegen)30tests/integration, security, e2e   real server + real PostgreSQL; nothing is mocked31infrastructure/               mld manifest32```3334## Develop3536```bash37pnpm install                                   # exact pins, install scripts disabled38createdb -h 127.0.0.1 sp_vault_test39pnpm test:unit && pnpm test:int && pnpm test:security40(cd apple/SharedVaultKit && swift test)41pnpm build                                     # dist/server.mjs, dist/cli.mjs, dist/managed.mjs, dist/web42```4344Local run: `DATABASE_URL=postgres://127.0.0.1/sp_vault_dev SPV_ORIGIN=http://localhost:8740 SPV_RP_ID=localhost SPV_DATA_DIR=.data SPV_WEB_DIR=dist/web node dist/server.mjs`,45then `node dist/cli.mjs invite --for me` (same environment) prints a join link.46
Files main
Menu

Theme