mirror of
https://github.com/shankar0123/certctl.git
synced 2026-06-07 12:21:31 +00:00
auth-bundle-1 Phase 13: docs (rbac.md + threat model + migration guide + security.md update)
Closes the last Phase before the Bundle 1 Exit gate. Operators
now have authoritative reference + threat model + migration guide
covering every behavior change Bundles 0-12 introduced.
# New docs
* docs/operator/rbac.md (340 lines) — operator how-to:
- Mental model (actors / roles / permissions / scopes)
- 7 default roles seeded by migration 000029 + the 5
admin-only fine-grained perms seeded by 000030
- Permission catalogue table by namespace
- Scope semantics (global beats specific) + the Bundle-2
deferral on scope_id FK enforcement
- Granting / revoking access from GUI + CLI + HTTP API + MCP
- The auditor pattern (audit-only, no resource read)
- Day-0 bootstrap flow (CERTCTL_BOOTSTRAP_TOKEN → curl →
HTTP 410 thereafter)
- Demo-mode (CERTCTL_AUTH_TYPE=none) caveat for production
* docs/operator/auth-threat-model.md (180 lines) — what the
controls defend against:
- 5 threat actors (external, wrong-role, compromised key,
insider operator, compromised auditor)
- Per-defense walk-through (API-key auth, RBAC, bootstrap,
approval workflow + Phase 9 closure, audit trail,
protocol-endpoint allowlist)
- 9 explicit deferrals (OIDC, sessions, local accounts,
JIT elevation, MFA, etc.) — Bundle 2 / future scope
- Compliance mapping (SOC 2 CC6.1/CC6.3, HIPAA §164.312(b),
NIST SSDF PO.5.2, FedRAMP AU-9, PCI-DSS §10)
- 5 operator-runnable sanity checks (e.g.,
'SELECT FROM audit_events WHERE actor=system-bypass' MUST
return 0 in production)
* docs/migration/api-keys-to-rbac.md (200 lines) — v2.0.x →
v2.1.0 upgrade flow:
- The SECURITY: AUDIT YOUR API KEYS callout
- Migration list (000029-000033) + what each does
- 4-mode scope-down flow (interactive / non-interactive
JSON / --suggest / --suggest --apply)
- What changes for code that called auth.IsAdmin
- Helm-specific upgrade flow with example post-upgrade Job
- Docker Compose upgrade flow + the 5 examples folders
that ride demo mode unchanged
- Verification queries + rollback flow
# Updated docs
* docs/operator/security.md — Last-reviewed bumped to
2026-05-09; existing Authentication-surface section
extended to call out the Bundle 1 RBAC primitive,
day-0 bootstrap path, and approval-bypass closure with
cross-references to the new docs.
* docs/reference/profiles.md — Last-reviewed header
formatting fixed (added the > blockquote prefix used
consistently across the docs tree).
# docs/README.md navigation
* Operator section gains 2 new rows (RBAC + auth-threat-model)
and Approval-workflow row updated to mention Phase 9
closure.
* Reference section gains the Profiles row.
* Migration section gains the api-keys-to-rbac row with the
AUDIT YOUR API KEYS callout in the link description.
# CHANGELOG.md v2.1.0 section refreshed
The Phase 7 commit landed the SECURITY: AUDIT YOUR API KEYS
callout. This commit appends the missing Phase 9-12 highlights:
- Approval-bypass closure (profile-edit gate + flip-flop
loophole + ErrApproveBySameActor invariant)
- GUI: Roles / API Keys / Auth Settings / Approvals queue
- 12 new MCP RBAC tools
- Coverage gates on internal/auth + internal/service/auth
- Protocol-endpoint allowlist pinned at 3 layers
Trailing cross-reference block now points at all 4 new docs.
# Verifications
* Every internal link in the 4 new/modified docs validated by
shell sweep (find broken links → 0 hits).
* Every new doc carries 'Last reviewed: 2026-05-09' header
with the > blockquote prefix matching the docs-tree
convention.
* go vet ./... clean.
* staticcheck across every Bundle-1-touched Go package clean.
* gofmt -l clean repo-wide.
* go test -short -count=1 green across internal/auth (incl.
bootstrap), internal/api/handler, internal/api/router,
internal/cli, internal/service (incl. auth),
internal/domain/auth, internal/mcp, cmd/cli (cmd/server
has 1 environmental failure on the sandbox virtiofs-tmp:
TestPreflightSCEPRACertKey_KeyWorldReadable_Refuses depends
on tmpfs file-mode semantics that virtiofs propagates
differently — pre-existing, unrelated to Bundle 1).
* Frontend: 19 Vitest tests across src/pages/auth/ +
AuditPage all pass; tsc --noEmit clean.
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
# certctl Security Posture & Operator Guidance
|
||||
|
||||
> Last reviewed: 2026-05-05
|
||||
> Last reviewed: 2026-05-09
|
||||
|
||||
This document collects the operator-facing security guidance that the source
|
||||
code's per-finding comment blocks reference. Each section names the audit
|
||||
@@ -75,15 +75,60 @@ the accompanying tests for the format spec.
|
||||
Bundle B / M-002. Two layers decide auth-exempt status:
|
||||
|
||||
1. **Router layer:** `internal/api/router/router.go::AuthExemptRouterRoutes`
|
||||
— the 4 endpoints registered via direct `r.mux.Handle` without going
|
||||
— the endpoints registered via direct `r.mux.Handle` without going
|
||||
through the middleware chain (`/health`, `/ready`, `/api/v1/auth/info`,
|
||||
`/api/v1/version`).
|
||||
`/api/v1/version`, plus `/api/v1/auth/bootstrap` GET + POST per
|
||||
Bundle 1 Phase 6).
|
||||
2. **Dispatch layer:** `internal/api/router/router.go::AuthExemptDispatchPrefixes`
|
||||
— URL-prefix routing in `cmd/server/main.go::buildFinalHandler` for
|
||||
`/.well-known/pki/*`, `/.well-known/est/*`, and `/scep[/...]*`.
|
||||
`/.well-known/pki/*`, `/.well-known/est/*`, `/.well-known/est-mtls`,
|
||||
and `/scep[/...]*` (incl. `/scep-mtls`).
|
||||
|
||||
Both lists have AST-walking regression tests (`auth_exempt_test.go`) that
|
||||
fail CI if a new bypass lands without an updating the documented constant.
|
||||
fail CI if a new bypass lands without updating the documented constant.
|
||||
|
||||
### RBAC primitive (Bundle 1)
|
||||
|
||||
Bundle 1 ships role-based authorization on top of API-key
|
||||
authentication. Every gated handler routes through the
|
||||
`auth.RequirePermission` middleware (or its router-level wrap
|
||||
`rbacGate`); the middleware resolves the actor's effective
|
||||
permissions via the service-layer `Authorizer.CheckPermission`
|
||||
and returns HTTP 403 BEFORE the handler body runs on miss. The
|
||||
seven default roles (`admin` / `operator` / `viewer` / `agent` /
|
||||
`mcp` / `cli` / `auditor`), 33-permission canonical catalogue,
|
||||
and the auditor split (`r-auditor` holds only `audit.read` +
|
||||
`audit.export`) are seeded by migration 000029.
|
||||
|
||||
For the operator how-to, see [`rbac.md`](rbac.md). For the
|
||||
threat model + compliance mapping, see
|
||||
[`auth-threat-model.md`](auth-threat-model.md). For the upgrade
|
||||
flow from a pre-Bundle-1 deployment, see
|
||||
[`docs/migration/api-keys-to-rbac.md`](../migration/api-keys-to-rbac.md).
|
||||
|
||||
### Day-0 admin bootstrap (Bundle 1 Phase 6)
|
||||
|
||||
Fresh deployments where no admin actor exists yet can mint the
|
||||
first admin via `POST /api/v1/auth/bootstrap` — set
|
||||
`CERTCTL_BOOTSTRAP_TOKEN`, POST a single curl with the token, and
|
||||
the server returns the plaintext key value once. The token is
|
||||
constant-time-compared; the strategy is one-shot via mutex; the
|
||||
admin-existence probe re-closes the path once an admin lands.
|
||||
The token is NEVER logged. The minted plaintext key flows only
|
||||
into the HTTP response body. See
|
||||
[`rbac.md`](rbac.md#day-0-bootstrap-first-admin-path) for the
|
||||
full flow.
|
||||
|
||||
### Approval-bypass closure (Bundle 1 Phase 9)
|
||||
|
||||
`CertificateProfile.RequiresApproval=true` profiles route both
|
||||
issuance/renewal AND profile edits through the
|
||||
`ApprovalService` two-person integrity gate (Phase 9 closes the
|
||||
flip-flop loophole where an admin could disable approval, mutate,
|
||||
re-enable). Same-actor self-approve is rejected at the service
|
||||
layer with `ErrApproveBySameActor`. See
|
||||
[`docs/reference/profiles.md`](../reference/profiles.md) for the
|
||||
full gate semantics.
|
||||
|
||||
## Per-user rate limiting
|
||||
|
||||
|
||||
Reference in New Issue
Block a user