mirror of
https://github.com/shankar0123/certctl.git
synced 2026-06-07 21:31:34 +00:00
3c605d5618
# Phase 6 — day-0 admin bootstrap * internal/auth/bootstrap/ (new package): Strategy interface + EnvTokenStrategy with constant-time compare, one-shot consumption via sync.Mutex, optional admin-existence probe. Bundle 2's OIDC- first-admin will plug in alongside as an alternate Strategy. * BootstrapService.ValidateAndMint: validates the operator's CERTCTL_BOOTSTRAP_TOKEN, mints a 32-byte (64-hex-char) random API key value, persists the SHA-256 hash to api_keys, grants r-admin via actor_roles, AddHashed's the runtime keystore so the just- minted key authenticates the next request without restart, and records bootstrap.consume to the audit trail with category=auth. * internal/auth/keystore.go (new): KeyStore interface + StaticKeyStore (immutable env-var-only path) + MutableKeyStore (env-var keys + DB-loaded api_keys + runtime AddHashed). The auth middleware now consumes a KeyStore so the bootstrap path can extend the lookup table at runtime. * migrations/000031_api_keys.up/down.sql: api_keys table with (id, name UNIQUE, key_hash UNIQUE, tenant_id, admin, created_by, created_at, expires_at, last_used_at). Idempotent. * /v1/auth/bootstrap GET (probe) + POST (mint) — auth-exempt. Both routes documented in api/openapi.yaml + AuthExemptRouterRoutes allowlist updated. The token never leaves internal/auth/bootstrap; the minted plaintext key flows only into the HTTP response body. * Startup warning emitted when CERTCTL_BOOTSTRAP_TOKEN is set AND admin actors already exist (config drift signal). * Tests: 4 strategy invariants (empty token born disabled, wrong token=ErrInvalidToken without consumption, one-shot consumption, admin-exists closes path), 5 service tests (happy path + actor- name validation + propagation of strategy errors + nil-deps guard + 32-byte entropy budget), 8 HTTP-handler tests (status 201/410/401/400 mapping + token-leak hygiene scan of slog + audit details + Location header). Token-leak test redirects slog.Default to a buffer for the test scope. # Phase 7 — API-key migration + scope-down CLI * GET /v1/auth/keys handler + service method ListKeys backed by ActorRoleRepository.ListDistinctActors. Returns one row per (actor_id, actor_type) pair with the slice of role IDs they hold. Permission: auth.role.list. * internal/cli/auth_scope_down.go: AuthListKeys, AuthScopeDown (interactive), AuthScopeDownNonInteractive (JSON config), AuthScopeDownSuggest (--suggest with optional --apply). The synthetic actor-demo-anon is filtered out of every interactive / bulk path; non-interactive flow logs and skips it explicitly. * SuggestRoleFromAuditEvents (pure function): walks 30 days of audit events per actor and returns the narrowest matching role (admin / mcp / viewer / agent / operator) plus a one-line reason. Classification: any admin-shaped action wins; otherwise all-MCP → mcp; all-read-only → viewer; all-agent-shaped → agent; otherwise operator. Test table pins all six classifications. * CLI subcommand tree extended: 'auth keys list' + 'auth keys scope-down [--non-interactive <cfg>] [--suggest [--apply]]'. * CHANGELOG.md leads v2.1.0 with the SECURITY: AUDIT YOUR API KEYS call-out + four flow examples. # Phase 8 — auditor role + event_category column * migrations/000032_audit_category.up/down.sql: ALTER TABLE audit_events ADD COLUMN event_category TEXT NOT NULL DEFAULT 'cert_lifecycle' + CHECK constraint (cert_lifecycle/auth/config) + (event_category) and (event_category, timestamp DESC) indexes for the auditor-filter query path. WORM trigger from migration 000018 continues to enforce append-only at the DB layer (DDL is not blocked). * domain.AuditEvent gains EventCategory string (omitempty); domain.EventCategoryCertLifecycle / Auth / Config constants. * AuditService.RecordEventWithCategory sibling of RecordEvent; legacy callers stay on RecordEvent (defaults to cert_lifecycle). Auth callers (RoleService, ActorRoleService, BootstrapService) switched to RecordEventWithCategory(..., 'auth', ...). * GET /v1/audit?category=<cat>: handler accepts the optional query param, validates against the enum (400 on invalid value), dispatches through ListAuditEventsByCategory. OpenAPI updated with the new query param + AuditEvent.event_category schema. * Postgres AuditRepository.Create now writes event_category; AuditRepository.List filters on it; AuditFilter.EventCategory gates the WHERE clause. * Tests: 5 audit-category-filter HTTP tests (dispatch routing, back-compat fallback, 400 for invalid values, all 3 enum values accepted, page+category combine, JSON output surfaces the field). 3 auditor-role invariants (auditor holds exactly audit.read+audit.export, no mutating perms, disjoint from viewer except audit.read). # Cross-phase wiring * HandlerRegistry.Bootstrap field added; cmd/server/main.go wires the bootstrap service ahead of RegisterHandlers (extracted assembleNamedAPIKeys helper into auth_backfill.go, moved the keystore + bootstrap construction up alongside the auth repos). * AuthCheckResolver / AuthActorRoleService extended with ListKeys to satisfy the Phase 7 surface; existing fakes updated. * fakeAudit + mockAuditService stubs in tests gain RecordEventWithCategory + ListAuditEventsByCategory; existing tests untouched. # Verifications * gofmt -l: clean across every modified file. * go vet ./...: clean. * staticcheck across internal/auth + handler + router + cli + service + repository + cmd + domain: clean. * go test -short -count=1: green across every Bundle-1-touched package — internal/auth (incl. bootstrap), internal/api/handler, internal/api/router, internal/cli, internal/service/auth, internal/service, internal/domain/auth, internal/repository/postgres, cmd/server, cmd/cli, plus internal/scheduler, internal/api/middleware, cmd/agent, internal/mcp.
158 lines
5.5 KiB
Go
158 lines
5.5 KiB
Go
package handler
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"testing"
|
|
|
|
"github.com/certctl-io/certctl/internal/domain"
|
|
)
|
|
|
|
// =============================================================================
|
|
// Bundle 1 Phase 8 — audit category-filter HTTP behaviour.
|
|
// =============================================================================
|
|
|
|
// TestListAuditEvents_Phase8_CategoryFilterDispatchesToService pins the
|
|
// happy-path: ?category=auth routes through ListAuditEventsByCategory
|
|
// with the right argument.
|
|
func TestListAuditEvents_Phase8_CategoryFilterDispatchesToService(t *testing.T) {
|
|
var capturedCategory string
|
|
mockSvc := &mockAuditService{
|
|
listByCatFunc: func(category string, _, _ int) ([]domain.AuditEvent, int64, error) {
|
|
capturedCategory = category
|
|
return []domain.AuditEvent{
|
|
{ID: "audit-1", Action: "auth.role.assign", EventCategory: domain.EventCategoryAuth},
|
|
}, 1, nil
|
|
},
|
|
}
|
|
h := NewAuditHandler(mockSvc)
|
|
req := httptest.NewRequest(http.MethodGet, "/api/v1/audit?category=auth", nil)
|
|
rec := httptest.NewRecorder()
|
|
h.ListAuditEvents(rec, req)
|
|
if rec.Code != http.StatusOK {
|
|
t.Fatalf("status = %d, want 200", rec.Code)
|
|
}
|
|
if capturedCategory != "auth" {
|
|
t.Errorf("captured category = %q, want auth", capturedCategory)
|
|
}
|
|
}
|
|
|
|
// TestListAuditEvents_Phase8_NoCategoryFallsBackToListAuditEvents pins
|
|
// that the legacy unfiltered path still routes through ListAuditEvents
|
|
// (preserves back-compat).
|
|
func TestListAuditEvents_Phase8_NoCategoryFallsBackToListAuditEvents(t *testing.T) {
|
|
listCalled := false
|
|
listByCatCalled := false
|
|
mockSvc := &mockAuditService{
|
|
listFunc: func(_, _ int) ([]domain.AuditEvent, int64, error) {
|
|
listCalled = true
|
|
return nil, 0, nil
|
|
},
|
|
listByCatFunc: func(_ string, _, _ int) ([]domain.AuditEvent, int64, error) {
|
|
listByCatCalled = true
|
|
return nil, 0, nil
|
|
},
|
|
}
|
|
h := NewAuditHandler(mockSvc)
|
|
req := httptest.NewRequest(http.MethodGet, "/api/v1/audit", nil)
|
|
rec := httptest.NewRecorder()
|
|
h.ListAuditEvents(rec, req)
|
|
if !listCalled {
|
|
t.Errorf("ListAuditEvents not called for unfiltered request")
|
|
}
|
|
if listByCatCalled {
|
|
t.Errorf("ListAuditEventsByCategory called unexpectedly for unfiltered request")
|
|
}
|
|
}
|
|
|
|
// TestListAuditEvents_Phase8_RejectsUnknownCategory pins the 400 surface
|
|
// for misuse. Allowed values are exactly cert_lifecycle/auth/config;
|
|
// anything else surfaces a clear error rather than silently returning
|
|
// every row.
|
|
func TestListAuditEvents_Phase8_RejectsUnknownCategory(t *testing.T) {
|
|
mockSvc := &mockAuditService{}
|
|
h := NewAuditHandler(mockSvc)
|
|
for _, bad := range []string{"agent", "AUTH", "auth%20", "system"} {
|
|
req := httptest.NewRequest(http.MethodGet, "/api/v1/audit?category="+bad, nil)
|
|
rec := httptest.NewRecorder()
|
|
h.ListAuditEvents(rec, req)
|
|
if rec.Code != http.StatusBadRequest {
|
|
t.Errorf("category=%q got status %d, want 400", bad, rec.Code)
|
|
}
|
|
}
|
|
}
|
|
|
|
// TestListAuditEvents_Phase8_AcceptsAllThreeCategories pins that each of
|
|
// the three documented enum values dispatches without a 400.
|
|
func TestListAuditEvents_Phase8_AcceptsAllThreeCategories(t *testing.T) {
|
|
mockSvc := &mockAuditService{
|
|
listByCatFunc: func(_ string, _, _ int) ([]domain.AuditEvent, int64, error) {
|
|
return nil, 0, nil
|
|
},
|
|
}
|
|
h := NewAuditHandler(mockSvc)
|
|
for _, cat := range []string{
|
|
domain.EventCategoryCertLifecycle,
|
|
domain.EventCategoryAuth,
|
|
domain.EventCategoryConfig,
|
|
} {
|
|
req := httptest.NewRequest(http.MethodGet, "/api/v1/audit?category="+cat, nil)
|
|
rec := httptest.NewRecorder()
|
|
h.ListAuditEvents(rec, req)
|
|
if rec.Code != http.StatusOK {
|
|
t.Errorf("category=%s got status %d, want 200", cat, rec.Code)
|
|
}
|
|
}
|
|
}
|
|
|
|
// TestListAuditEvents_Phase8_CategoryAndPageCombine confirms the query
|
|
// parser respects both the page and category params concurrently.
|
|
func TestListAuditEvents_Phase8_CategoryAndPageCombine(t *testing.T) {
|
|
var capturedCategory string
|
|
var capturedPage int
|
|
mockSvc := &mockAuditService{
|
|
listByCatFunc: func(category string, page, _ int) ([]domain.AuditEvent, int64, error) {
|
|
capturedCategory = category
|
|
capturedPage = page
|
|
return nil, 0, nil
|
|
},
|
|
}
|
|
h := NewAuditHandler(mockSvc)
|
|
req := httptest.NewRequest(http.MethodGet, "/api/v1/audit?category=auth&page=3", nil)
|
|
rec := httptest.NewRecorder()
|
|
h.ListAuditEvents(rec, req)
|
|
if capturedCategory != "auth" || capturedPage != 3 {
|
|
t.Errorf("captured (cat=%q page=%d), want (auth, 3)", capturedCategory, capturedPage)
|
|
}
|
|
}
|
|
|
|
// TestListAuditEvents_Phase8_ResponseSurfacesEventCategory confirms the
|
|
// JSON output carries the event_category field for downstream auditors.
|
|
func TestListAuditEvents_Phase8_ResponseSurfacesEventCategory(t *testing.T) {
|
|
mockSvc := &mockAuditService{
|
|
listByCatFunc: func(_ string, _, _ int) ([]domain.AuditEvent, int64, error) {
|
|
return []domain.AuditEvent{
|
|
{ID: "a1", Action: "auth.role.assign", EventCategory: "auth"},
|
|
{ID: "a2", Action: "issuer.edit", EventCategory: "config"},
|
|
}, 2, nil
|
|
},
|
|
}
|
|
h := NewAuditHandler(mockSvc)
|
|
req := httptest.NewRequest(http.MethodGet, "/api/v1/audit?category=auth", nil)
|
|
rec := httptest.NewRecorder()
|
|
h.ListAuditEvents(rec, req)
|
|
var resp struct {
|
|
Data []domain.AuditEvent `json:"data"`
|
|
}
|
|
if err := json.NewDecoder(rec.Body).Decode(&resp); err != nil {
|
|
t.Fatalf("decode: %v", err)
|
|
}
|
|
if len(resp.Data) != 2 || resp.Data[0].EventCategory != "auth" || resp.Data[1].EventCategory != "config" {
|
|
t.Errorf("event_category not surfaced in JSON: %+v", resp.Data)
|
|
}
|
|
}
|
|
|
|
var _ = context.Background // keep import even if other tests strip it
|