Files
certctl/internal/auth/oidc/bench_test.go
T
shankar0123 9b6294e83d auth-bundle-2 Phase 14: session + OIDC validation benchmarks (steady-state + cold paths) + auth-benchmarks.md operator doc + Makefile targets
Closes Phase 14 of cowork/auth-bundle-2-prompt.md. Ships four
benchmarks producing four numbers + the operator-doc table; three
default-tag benchmarks runnable on every CI runner, the fourth
(cold-cache OIDC) runnable on operator-side Docker hosts via the
new make target.

Files
=====

internal/auth/session/bench_test.go (NEW):
* BenchmarkSession_SteadyState (target p99 < 1ms; measured 5µs).
  Warm in-memory repo + warm session row. Pure CPU: parseCookie +
  HMAC verify + map lookup + sentinel checks.
* BenchmarkSession_ColdProcess (target p99 < 10ms; measured 7.1ms).
  Same pipeline but with a configurable per-call delay simulating
  a 1ms Postgres RTT on each repo call. Two repo calls per
  Validate (signing-key fetch + session-row fetch) = 2ms minimum;
  Go time.Sleep granularity adds ~1-2ms jitter. Documented why
  testcontainers Postgres isn't viable inside b.N: 30+ second
  container boot incompatible with per-iteration timing.
* slowSessionRepo + slowKeyRepo wrappers add the per-call delay
  via time.Sleep; they delegate to the existing in-memory stubs.
* reportPercentiles helper sorts + reports p50/p95/p99/max via
  b.ReportMetric (Go testing.B doesn't surface percentiles
  natively).

internal/auth/oidc/bench_test.go (NEW):
* BenchmarkOIDC_SteadyState (target p99 < 5ms; measured 1.5ms).
  Drives full HandleCallback against an in-process mockIdP
  (httptest.Server localhost loopback). Pre-warmed JWKS cache via
  RefreshKeys at setup. Pipeline: pre-login consume + state
  compare + token exchange (localhost ~50-200µs) + go-oidc
  Verify (RSA-2048 sig verify + alg pin) + service-layer iss/
  aud/azp/at_hash/exp/iat/nonce re-checks + group-claim
  resolution + group→role mapping + user upsert + session mint.
* The localhost-loopback /token call adds ~100-500µs of TCP
  overhead vs pure crypto; the prompt's "no network calls"
  steady-state framing accommodates this since the localhost
  loopback is the closest practical proxy for a same-region
  IdP /token call (which adds 5-15ms in production).

internal/auth/oidc/bench_keycloak_test.go (NEW, //go:build integration):
* BenchmarkOIDC_ColdCache (target p99 < 200ms; operator-runs).
  Drives RefreshKeys against a live Keycloak container from the
  Phase 10 testfixtures harness. Each iteration evicts the
  in-process cache + re-fetches discovery + re-fetches JWKS over
  real HTTP + re-runs the IdP-downgrade-attack defense.
* Network-bounded: the cold path is dominated by HTTPS RTT to
  the IdP discovery endpoint, NOT crypto. The 200ms cap
  accommodates a geographically-distant IdP (~150ms RTT) plus
  the in-process JWKS fetch + downgrade-defense logic (~5ms
  locally).
* Reuses the sharedKeycloak fixture from
  integration_keycloak_test.go (Phase 10) so the benchmark
  doesn't pay the 60-90s container boot cost separately. Skips
  with a clear message if invoked without the integration test
  setup.
* Reports p50/p95/p99/max in MILLISECONDS (vs the
  microsecond-granularity steady-state benchmarks) since the
  cold path is two orders of magnitude slower.

internal/auth/oidc/service_test.go (MODIFIED):
* Refactored newMockIdP(t *testing.T) to delegate to a new
  newMockIdPWithTB(t testing.TB) sibling. Standard Go pattern
  for sharing test fixtures between *testing.T and *testing.B.
  No behavior change for existing service_test.go tests; the
  benchmark file in bench_test.go calls newMockIdPWithTB(b)
  to get the same fixture.

docs/operator/auth-benchmarks.md (NEW):
* Result table with all four benchmarks + targets + measured
  numbers + status markers. Four-row matrix for the default-tag
  benchmarks; the fourth row (cold-cache) is operator-recorded
  with an empty cell waiting for the first Docker-equipped run.
* Hardware floor section pinning the 4 vCPU / 8 GiB RAM /
  Postgres 16 / Go 1.25 baseline. GitHub-hosted Ubuntu runners
  satisfy this; operators on weaker hardware re-record.
* "What each benchmark covers (and what it doesn't)" section
  per benchmark, distinguishing the warm steady-state pipeline
  from the cold path's network-bounded budget.
* "Cold-cache OIDC: how to run" subsection documenting the
  make target + the test+benchmark coupling needed to populate
  sharedKeycloak. Operator-recorded baseline table seeded
  empty for first runs.
* "Why the cold path is bounded by network latency, not crypto"
  section explaining the budget breakdown:
    - TCP handshake (1 RTT)
    - TLS 1.3 handshake (1-2 RTTs)
    - 2 HTTPS GETs (discovery + JWKS, 1 RTT each)
    - In-process crypto on the certctl side (~5-10ms total)
  So the 200ms cap is operator-checkable: real measurement >
  200ms means the IdP is slow OR network congestion OR DNS
  issues — the diagnosis is upstream of certctl. Real
  measurement < 200ms means the IdP is on a fast same-region
  link.
* Methodology section pinning the per-iteration timing capture
  + sort + percentile-extract approach.
* Pre-merge audit section for the Phase 14 exit gate: four
  benchmarks ran, four numbers recorded, steady-state targets
  met, cold path is operator-runnable + measurably-bounded.

Makefile (MODIFIED):
* Added `make benchmark-auth` (default-tag, runs three of four
  benchmarks at 2000 samples each).
* Added `make benchmark-auth-coldcache` (integration-tagged,
  runs OIDC cold-cache against live Keycloak; requires Docker).
* Both targets carry explanatory comment blocks.

docs/README.md (MODIFIED):
* Added the auth-benchmarks.md doc to the Operator nav table
  alongside performance-baselines.md.

Measured baselines at Phase 14 close (linux/arm64, 4 vCPU)
==========================================================

  BenchmarkSession_SteadyState     p99 = 5µs    (target < 1ms)   ✓ 200× under
  BenchmarkSession_ColdProcess     p99 = 7.1ms  (target < 10ms)  ✓
  BenchmarkOIDC_SteadyState        p99 = 1.5ms  (target < 5ms)   ✓ 3× under
  BenchmarkOIDC_ColdCache          operator-runs (Docker required)

Verification
============

* gofmt -l on three new bench files: clean.
* go vet ./internal/auth/session/... ./internal/auth/oidc/...: clean
  (default tag).
* go vet -tags integration ./internal/auth/oidc/...: clean (integration
  tag covers the bench_keycloak_test.go file).
* go test -short -count=1 across all 5 OIDC + session packages:
  green; the bench_*_test.go files compile but don't run under
  -short (testing.Short() guards + benchmarks are not selected
  by -run pattern).
* All three runnable benchmarks executed and produce the numbers
  above; recorded in auth-benchmarks.md.
2026-05-10 16:51:28 +00:00

144 lines
5.1 KiB
Go

package oidc
import (
"context"
"sort"
"testing"
"time"
)
// =============================================================================
// Bundle 2 Phase 14 — OIDC token validation benchmark (steady state).
//
// Measures the warm-JWKS-cache OIDC HandleCallback path against an
// in-process mockIdP. The mockIdP runs as an httptest.Server on
// localhost so the "exchange code for tokens" round-trip + the
// JWKS-cache hit are both purely local; there is NO real network
// latency in this measurement.
//
// Phase 14 target: p99 < 5ms.
//
// What this benchmark covers:
// - parseCookie + pre-login row consume (in-memory stubPreLogin)
// - OAuth2 Exchange against the mockIdP /token endpoint
// (httptest.Server local-loopback, ~50-200 µs typical)
// - go-oidc's id_token verification (JWKS cache lookup + RSA-2048
// signature verify + alg pin)
// - certctl service-layer re-verification (iss / aud / azp /
// at_hash / exp / iat / nonce)
// - Group-claim resolution (groupclaim/resolver.go)
// - Group→role mapping (in-memory stubMappings)
// - User upsert (in-memory stubUsers)
// - Session mint via stubSessions
//
// What this benchmark does NOT cover:
// - JWKS network refetch (that's the Phase-14 ColdCache benchmark
// in bench_keycloak_test.go; build-tagged under integration).
// - Real-network IdP latency (steady state assumes JWKS cache is
// warm; the local-loopback /token call is the "control" for
// the production cost of a same-region IdP /token call).
//
// The cold-cache OIDC measurement runs against a live Keycloak
// container per the Phase 10 fixture; see bench_keycloak_test.go
// (//go:build integration).
//
// Run via:
// go test -bench BenchmarkOIDC_SteadyState -benchmem -run='^$' \
// ./internal/auth/oidc/
//
// The full Phase 14 result table lives at docs/operator/auth-benchmarks.md.
// =============================================================================
// reportOIDCPercentiles is identical in shape to the session
// benchmark's reportPercentiles, duplicated here so the two
// benchmark files don't share a helper across the package boundary.
func reportOIDCPercentiles(b *testing.B, samples []time.Duration) {
b.Helper()
if len(samples) == 0 {
return
}
sort.Slice(samples, func(i, j int) bool { return samples[i] < samples[j] })
p := func(pct float64) time.Duration {
idx := int(float64(len(samples)) * pct / 100.0)
if idx >= len(samples) {
idx = len(samples) - 1
}
return samples[idx]
}
b.ReportMetric(float64(p(50).Microseconds()), "p50_us/op")
b.ReportMetric(float64(p(95).Microseconds()), "p95_us/op")
b.ReportMetric(float64(p(99).Microseconds()), "p99_us/op")
b.ReportMetric(float64(samples[len(samples)-1].Microseconds()), "max_us/op")
}
// BenchmarkOIDC_SteadyState measures the OIDC HandleCallback p99
// against an in-process mockIdP. Warm JWKS cache (the first iteration
// triggers the cache load via getOrLoad; subsequent iterations hit
// the cached entry).
//
// Phase 14 target: p99 < 5ms.
func BenchmarkOIDC_SteadyState(b *testing.B) {
idp := newMockIdPForBench(b)
svc, pl := newBenchServiceWithProviderAndPL(b, idp.URL(), "op-bench")
// Pre-warm the JWKS cache so the first iteration's measurement
// doesn't include the discovery + JWKS load.
if err := svc.RefreshKeys(context.Background(), "op-bench"); err != nil {
b.Fatalf("RefreshKeys (warm): %v", err)
}
ctx := context.Background()
samples := make([]time.Duration, 0, b.N)
b.ResetTimer()
for i := 0; i < b.N; i++ {
// Each iteration needs a fresh pre-login row (HandleCallback
// consumes the row atomically + single-use). State + nonce +
// verifier are stable; the cookie value is unique per call.
cookie, _, err := pl.CreatePreLogin(ctx, "op-bench", "bench-state", "test-nonce-fixed", "verifier-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx")
if err != nil {
b.Fatalf("CreatePreLogin: %v", err)
}
start := time.Now()
_, err = svc.HandleCallback(ctx, cookie, "bench-code", "bench-state", "10.0.0.1", "bench/1.0")
elapsed := time.Since(start)
if err != nil {
b.Fatalf("HandleCallback: %v", err)
}
samples = append(samples, elapsed)
}
b.StopTimer()
reportOIDCPercentiles(b, samples)
}
// ---------------------------------------------------------------------------
// Benchmark-local helpers (versions of the service_test.go helpers
// that take a *testing.B instead of *testing.T).
// ---------------------------------------------------------------------------
func newMockIdPForBench(b *testing.B) *mockIdP {
b.Helper()
// newMockIdP takes *testing.T; we pass an adapter via the public
// interface. Since *testing.T and *testing.B both satisfy
// testing.TB, we adapt by using a synthetic T wrapper.
return newMockIdPWithTB(b)
}
func newBenchServiceWithProviderAndPL(b *testing.B, idpURL, providerID string) (*Service, *stubPreLogin) {
b.Helper()
prov := makeProvider(idpURL, providerID)
pl := newStubPreLogin()
mappings := &stubMappings{roleIDs: []string{"r-operator"}}
users := newStubUsers()
sessions := &stubSessions{}
svc := NewService(
&stubProviderLookup{provider: prov},
mappings,
users,
sessions,
pl,
"",
)
return svc, pl
}