kaboot/docs/SECURITY_PLAN.md

8 KiB

AUDIT

High / Critical Findings

  • Client-exposed Gemini system key risk. vite.config.ts injects process.env.GEMINI_API_KEY into the frontend bundle and services/geminiService.ts falls back to process.env.API_KEY; if a server/system key is set, it becomes visible to all clients and bypasses backend access controls. Recommend removing env injection for secrets and using only POST /api/generate for system AI. Evidence: vite.config.ts, services/geminiService.ts:6-12.
  • Untrusted document parsing runs native tooling. server/src/services/documentParser.ts uses LibreOffice + multiple parsers on attacker-supplied files; even without command injection, crafted docs are a common RCE vector. Treat as high risk unless sandboxed. Recommend running conversions in a container/worker with seccomp/AppArmor, low privileges, CPU/memory limits, and timeouts. Evidence: server/src/services/documentParser.ts:223-226.
  • Memory-heavy file uploads without per-endpoint rate limits. multer.memoryStorage() accepts up to 50MB and parsing happens synchronously; repeated requests can exhaust RAM/CPU. Recommend per-route rate limits + streaming to disk or queueing with concurrency caps. Evidence: server/src/routes/upload.ts:11-18. Medium Findings
  • JWT audience not validated. requireAuth verifies issuer/alg but not aud. A token minted for another client with the same issuer could be accepted. Recommend adding audience validation (client_id) and optionally azp. Evidence: server/src/middleware/auth.ts:58-64.
  • Tokens and API keys stored in localStorage. OIDC user store and API keys are persisted client-side, which is vulnerable to XSS. Mitigation: prefer in-memory storage or httpOnly cookies; avoid persisting API keys. Evidence: src/config/oidc.ts:17, hooks/useUserPreferences.ts:17-48, hooks/useGame.ts:62-74.
  • Public game lookup is enumerable if PINs are short. GET /api/games/:pin is unauthenticated (rate-limited) and returns game metadata. If PIN length is small, enumeration is plausible. Consider longer pins, additional throttling, or auth for non-host data. Evidence: server/src/routes/games.ts:85-107. Low Findings / Hardening
  • Auth error details echoed to client. requireAuth returns details: err.message which can leak verifier details. Recommend generic responses and server-only logs. Evidence: server/src/middleware/auth.ts:66-69.
  • Logging includes share tokens and pins. When LOG_REQUESTS=true, paths like /api/shared/:token are logged. Consider redacting or omitting sensitive paths. Evidence: server/src/index.ts:52-58, server/src/routes/shared.ts.
  • CORS uses credentials: true with configurable origin. If cookies are ever used in future, misconfiguration could enable CSRF. Recommend disabling credentials unless needed, and enforce HTTPS origins in prod. Evidence: server/src/index.ts:42-46. Positive Controls Observed
  • Parametrized SQL across routes (no obvious SQLi). server/src/routes/*.ts.
  • JWT verification uses RS256 and JWKS with caching. server/src/middleware/auth.ts.
  • Stripe webhook signature verification present. server/src/routes/payments.ts:337.
  • Helmet with CSP enabled on backend responses. server/src/index.ts:17-28.
  • No dangerouslySetInnerHTML found in frontend. Key Recommendation Order
  1. Remove client-side exposure of GEMINI_API_KEY and force system AI through backend. (vite.config.ts, services/geminiService.ts)
  2. Sandbox document parsing / LibreOffice conversions. (server/src/services/documentParser.ts)
  3. Add audience validation for JWTs. (server/src/middleware/auth.ts)
  4. Add upload-specific throttling and reduce memory pressure. (server/src/routes/upload.ts)
  5. Reduce client-side secret persistence (move to in-memory / httpOnly). (src/config/oidc.ts, hooks/useUserPreferences.ts)

Security Plan (Kaboot)

This plan turns the audit findings into a tracked, testable remediation roadmap.

Goals

  • Eliminate client-side exposure of system AI secrets and enforce server-side access control only.
  • Reduce risk of RCE/DoS in document parsing and uploads. (sandboxing, rate limits, circuit breaker all done)
  • Harden token validation and client storage practices. (JWT aud validation done; client storage pending)
  • Improve auditability, logging hygiene, and safe rollout.

Scope

  • Backend entrypoints and middleware: server/src/index.ts, server/src/routes/*.ts, server/src/middleware/auth.ts.
  • Document processing: server/src/services/documentParser.ts, server/src/routes/upload.ts.
  • Frontend auth/storage and AI clients: src/config/oidc.ts, hooks/useUserPreferences.ts, hooks/useAuthenticatedFetch.ts, services/geminiService.ts.
  • Build/config surfaces: vite.config.ts, .env.example, docker-compose*.yml, docs/*.

Assumptions

  • Backend is the only trusted system for system AI generation.
  • Auth provider is Authentik with OIDC JWTs.
  • Uploads may be attacker-controlled and should be treated as hostile.

Phase 0 - Baseline and Inventory

  • Inventory all secrets and confirm none are present in repo or frontend bundles.
  • Verify current auth boundary: which routes require requireAuth vs public.
  • Record current rate limits and error handling for uploads, generation, games, and shared endpoints.
  • Add a basic secret scan in CI (gitleaks/trufflehog) and document false-positive exclusions.

Phase 1 - Critical Remediations

1) Remove Client Exposure of System AI Key

  • Remove process.env.GEMINI_API_KEY exposure from vite.config.ts.
  • Remove process.env.API_KEY fallback in services/geminiService.ts.
  • Ensure all system AI usage flows through POST /api/generate only.
  • Validate that built frontend bundles do not contain Gemini keys.

2) Sandbox Document Processing

  • Move LibreOffice conversion to a sandboxed worker/container (no network, low privileges).
  • Enforce per-job CPU/memory limits and execution timeouts.
  • Store temp files in a private directory (0700) and clean up consistently.
  • Add a circuit breaker for repeated failures or timeouts.

3) Upload Abuse Protection

  • Add route-specific rate limiting for POST /api/upload.
  • Cap concurrent uploads per user and per IP.
  • Consider streaming to disk or queueing (avoid large in-memory buffers when possible).

4) JWT Audience Validation

  • Validate aud (and azp if present) in server/src/middleware/auth.ts.
  • Document required OIDC claims in docs/AUTHENTIK_SETUP.md.

Phase 2 - Hardening

1) Games Endpoint Risk Reduction

  • Increase PIN entropy or move to a join token.
  • Require host proof (secret or auth) for state mutation endpoints.
  • Add per-endpoint throttling for public lookups.

2) Logging and Error Hygiene

  • Redact sensitive paths/tokens in request logs (server/src/index.ts).
  • Return generic auth errors to clients; keep details server-only (server/src/middleware/auth.ts).

3) CORS and CSRF Posture

  • Review use of credentials: true and disable if not required.
  • Enforce HTTPS origins in production configs.

4) Privacy and Disclosure

  • Add a user-facing notice that documents may be sent to external AI providers.
  • Document data handling and retention for uploads and AI generation.

Phase 3 - Verification

  • Add tests for JWT aud mismatches and invalid tokens.
  • Add upload tests for size limits, malformed files, and parser errors.
  • Add regression tests for shared and game endpoints (rate limiting and access).
  • Run dependency vulnerability checks in CI (npm audit or Snyk).
  • Verify no secrets appear in logs or built assets.

Phase 4 - Rollout

  • Deploy to staging and validate auth, upload, generation, and payments end-to-end.
  • Rotate exposed keys after client bundle no longer includes secrets.
  • Use feature flags for upload pipeline changes.
  • Monitor latency, 429s, error rates, and upload failures for 48h post-deploy.

Deliverables

  • Code changes with references and rationale per file.
  • Updated docs for system AI, uploads, and privacy.
  • Test report and monitoring checklist.
  • Post-remediation security summary with residual risks.