8d0c2992e6
- SUMMARY.md with chi v5 router, auth middleware, overview page - STATE.md updated with position, decisions, metrics - ROADMAP.md and REQUIREMENTS.md updated
126 lines
4.6 KiB
Markdown
126 lines
4.6 KiB
Markdown
---
|
|
phase: 18-web-dashboard
|
|
plan: 01
|
|
subsystem: web
|
|
tags: [chi, htmx, go-embed, html-template, auth-middleware, dashboard]
|
|
|
|
requires:
|
|
- phase: 01-foundation
|
|
provides: storage.DB, providers.Registry
|
|
- phase: 09-osint-infrastructure
|
|
provides: recon.Engine
|
|
- phase: 08-dork-engine
|
|
provides: dorks.Registry
|
|
provides:
|
|
- "pkg/web package with chi v5 router, embedded static assets, auth middleware"
|
|
- "Overview dashboard page with stats from providers/recon/storage"
|
|
- "Server struct with NewServer constructor, Config, Router(), ListenAndServe()"
|
|
affects: [18-02, 18-03, 18-04, 18-05]
|
|
|
|
tech-stack:
|
|
added: [chi v5.2.5, htmx v2.0.4]
|
|
patterns: [go:embed for static assets and templates, html/template with layout pattern, nil-safe handler for optional dependencies]
|
|
|
|
key-files:
|
|
created:
|
|
- pkg/web/server.go
|
|
- pkg/web/auth.go
|
|
- pkg/web/handlers.go
|
|
- pkg/web/embed.go
|
|
- pkg/web/static/htmx.min.js
|
|
- pkg/web/static/style.css
|
|
- pkg/web/templates/layout.html
|
|
- pkg/web/templates/overview.html
|
|
- pkg/web/server_test.go
|
|
modified:
|
|
- go.mod
|
|
- go.sum
|
|
|
|
key-decisions:
|
|
- "html/template over templ for v1 per CONTEXT.md deferred decision"
|
|
- "Tailwind via CDN for v1 rather than standalone CLI build step"
|
|
- "Nil-safe handlers: overview works with zero Config (no DB, no providers)"
|
|
- "AuthMiddleware uses crypto/subtle constant-time comparison for timing-attack resistance"
|
|
|
|
patterns-established:
|
|
- "Web handler pattern: method on Server struct, nil-check dependencies before use"
|
|
- "go:embed layout: static/ and templates/ subdirs under pkg/web/"
|
|
- "Template composition: define layout + block content pattern"
|
|
|
|
requirements-completed: [WEB-01, WEB-02, WEB-10]
|
|
|
|
duration: 3min
|
|
completed: 2026-04-06
|
|
---
|
|
|
|
# Phase 18 Plan 01: Web Dashboard Foundation Summary
|
|
|
|
**chi v5 router with go:embed static assets (htmx, CSS), html/template layout, overview dashboard, and Basic/Bearer auth middleware**
|
|
|
|
## Performance
|
|
|
|
- **Duration:** 3 min
|
|
- **Started:** 2026-04-06T14:59:54Z
|
|
- **Completed:** 2026-04-06T15:02:56Z
|
|
- **Tasks:** 2
|
|
- **Files modified:** 9
|
|
|
|
## Accomplishments
|
|
- chi v5.2.5 HTTP router with middleware stack (RealIP, Logger, Recoverer)
|
|
- Vendored htmx v2.0.4, embedded via go:embed alongside CSS and HTML templates
|
|
- Overview page with 4 stat cards (Total Keys, Providers, Recon Sources, Last Scan) and recent findings table
|
|
- Auth middleware supporting Basic and Bearer token with constant-time comparison, no-op when unconfigured
|
|
- 7 tests covering overview rendering, static serving, auth enforcement, and passthrough
|
|
|
|
## Task Commits
|
|
|
|
Each task was committed atomically:
|
|
|
|
1. **Task 1: chi v5 dependency + go:embed static assets + layout template** - `dd2c8c5` (feat)
|
|
2. **Task 2 RED: failing tests for server/auth/overview** - `3541c82` (test)
|
|
3. **Task 2 GREEN: implement server, auth, handlers** - `268a769` (feat)
|
|
|
|
## Files Created/Modified
|
|
- `pkg/web/server.go` - chi router setup, NewServer constructor, ListenAndServe
|
|
- `pkg/web/auth.go` - Basic auth and bearer token middleware with constant-time compare
|
|
- `pkg/web/handlers.go` - Overview handler with OverviewData struct, nil-safe DB/provider access
|
|
- `pkg/web/embed.go` - go:embed directives for static/ and templates/
|
|
- `pkg/web/static/htmx.min.js` - Vendored htmx v2.0.4 (50KB)
|
|
- `pkg/web/static/style.css` - Custom overrides for stat cards, findings table, nav
|
|
- `pkg/web/templates/layout.html` - Base layout with nav bar, Tailwind CDN, htmx script
|
|
- `pkg/web/templates/overview.html` - Dashboard with stat cards grid and findings table
|
|
- `pkg/web/server_test.go` - 7 integration tests for server, auth, overview
|
|
- `go.mod` / `go.sum` - Added chi v5.2.5
|
|
|
|
## Decisions Made
|
|
- Used html/template (not templ) per CONTEXT.md deferred decision for v1
|
|
- Tailwind via CDN rather than standalone build step for v1 simplicity
|
|
- Nil-safe handlers allow server to start with zero config (no DB required)
|
|
- Auth uses crypto/subtle.ConstantTimeCompare to prevent timing attacks
|
|
|
|
## Deviations from Plan
|
|
|
|
None - plan executed exactly as written.
|
|
|
|
## Issues Encountered
|
|
None
|
|
|
|
## User Setup Required
|
|
None - no external service configuration required.
|
|
|
|
## Known Stubs
|
|
None - all data paths are wired to real sources (providers.Registry, recon.Engine, storage.DB) or gracefully show zeroes when dependencies are nil.
|
|
|
|
## Self-Check: PASSED
|
|
|
|
All 9 files verified present. All 3 commit hashes verified in git log.
|
|
|
|
## Next Phase Readiness
|
|
- Server skeleton ready for Plans 02-05 to add keys page, providers page, API endpoints, SSE
|
|
- Router exposed via Router() for easy route additions
|
|
- Template parsing supports adding new .html files to templates/
|
|
|
|
---
|
|
*Phase: 18-web-dashboard*
|
|
*Completed: 2026-04-06*
|