mirror of
https://github.com/shankar0123/certctl.git
synced 2026-06-09 01:39:59 +00:00
2cd2a5c52f
Audit 2026-05-10 MED-17 closure.
WHAT.
When the matched IdP's discovery doc advertises
authorization_response_iss_parameter_supported=true (RFC 9207 §3),
HandleCallback now REQUIRES a non-empty `iss` query parameter on
/auth/oidc/callback and enforces a constant-time compare against the
configured provider's IssuerURL. Mismatch maps to two new sentinel
errors (ErrIssParamMissing / ErrIssParamMismatch) that the handler's
classifyOIDCFailure dispatches via errors.Is BEFORE the substring
fall-through, so the audit failure_category remains distinguishable
between the RFC 9207 leg (iss_param_missing / iss_param_mismatch) and
the in-token iss claim leg (id_token_iss_mismatch).
WHY.
The RFC 9207 iss URL parameter is the load-bearing mix-up-attack
defense for multi-tenant IdPs (Keycloak realms, Authentik tenants,
Auth0 tenants, public-trust CAs). Pre-fix the parameter was silently
ignored — an attacker controlling one IdP tenant could route an auth
code to certctl's callback against a different tenant's pre-login
state without detection. Modern Keycloak / Authentik / public-trust
CAs ship the discovery flag by default; legacy IdPs that don't
advertise are unaffected (back-compat preserved).
HOW.
- internal/auth/oidc/service.go
- providerEntry gains issParamSupported bool.
- getOrLoad extends the discovery-claims read to include
authorization_response_iss_parameter_supported, alongside the
existing id_token_signing_alg_values_supported defense.
- HandleCallback's signature gains callbackIss string at position 5.
Step 2.5 runs after the state compare + provider load: when
issParamSupported is true, an empty callbackIss returns
ErrIssParamMissing; a present-but-mismatched value returns
ErrIssParamMismatch (constant-time compare).
- Two new sentinels: ErrIssParamMissing, ErrIssParamMismatch.
ErrIssuerMismatch's doc-string clarified to note it covers the
in-token leg only.
- internal/api/handler/auth_session_oidc.go
- OIDCAuthHandshaker.HandleCallback signature updated.
- LoginCallback reads r.URL.Query().Get("iss") (no TrimSpace —
byte-strict compare upstream) and threads it through.
- classifyOIDCFailure: typed errors.Is dispatch for the three
iss-family sentinels BEFORE the substring fall-through, so the
three cases stay distinguishable in the audit row.
- internal/api/handler/auth_session_oidc_test.go
- stubOIDCSvc.HandleCallback bumped to 7-arg signature.
- TestClassifyOIDCFailure extended with 5 new cases pinning the
iss-family dispatch + a wrapped-error round-trip.
- internal/auth/oidc/service_test.go
- mockIdP gains advertiseIssParameterSupported bool; the
/.well-known/openid-configuration handler emits the claim only
when set (so existing tests stay back-compat).
- 4 new regression tests:
* MED17_NoSupport_AnyIssAccepted — provider doesn't advertise;
arbitrary callbackIss is ignored (back-compat).
* MED17_SupportButMissing — provider advertises; missing iss →
ErrIssParamMissing.
* MED17_SupportButMismatch — provider advertises; wrong iss →
ErrIssParamMismatch (load-bearing mix-up defense).
* MED17_SupportAndCorrect — provider advertises; matching iss →
success path proves the gate isn't over-eager.
- internal/auth/oidc/bench_test.go,
internal/auth/oidc/logging_test.go,
internal/auth/oidc/integration_keycloak_test.go
- Mechanical: all existing HandleCallback call sites updated to
pass "" for callbackIss (matches pre-fix behavior for IdPs that
don't advertise support — the Keycloak integration suite tests
will be re-evaluated once the Keycloak fixture is run against a
realm with the discovery flag enabled).
VERIFY.
- go vet ./internal/auth/oidc/... ./internal/api/handler/... PASS
- go test -short -count=1 ./internal/auth/oidc/... PASS (3.4s)
- go test -short -count=1 ./internal/api/handler/... PASS (5.4s)
- 4 new MED-17 regression tests + extended TestClassifyOIDCFailure pass.
Refs: cowork/auth-bundles-audit-2026-05-10.md MED-17
cowork/auth-bundles-fixes-2026-05-10/HANDOFF.md item 7
RFC 9207 — OAuth 2.0 Authorization Server Issuer Identification
184 lines
6.2 KiB
Go
184 lines
6.2 KiB
Go
package oidc
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"io"
|
|
"log/slog"
|
|
"strings"
|
|
"testing"
|
|
)
|
|
|
|
// =============================================================================
|
|
// Token-leak hygiene: no secret value (ID token, access token, refresh
|
|
// token, authorization code, PKCE verifier, state, nonce, signing key
|
|
// material) appears in any log line at any level.
|
|
//
|
|
// Methodology mirrors Bundle 1's
|
|
// internal/auth/bootstrap/service_test.go::TestService_TokenLeakHygiene:
|
|
// redirect slog.Default to a buffer, run the OIDC service paths,
|
|
// grep-assert the secret string never appears in any captured line.
|
|
//
|
|
// This is the load-bearing invariant for Phase 3's "tokens never
|
|
// logged" contract. Every secret-bearing path that enters the
|
|
// service.go code MUST flow through write-once-to-response patterns;
|
|
// adding a `slog.Info("got token", "value", token)` somewhere would
|
|
// fail this test immediately.
|
|
// =============================================================================
|
|
|
|
// captureLogger swaps the slog.Default with one that writes to the
|
|
// returned buffer. The returned restore func re-installs the original
|
|
// logger; callers must defer it.
|
|
func captureLogger(t *testing.T) (*bytes.Buffer, func()) {
|
|
t.Helper()
|
|
buf := &bytes.Buffer{}
|
|
original := slog.Default()
|
|
slog.SetDefault(slog.New(slog.NewTextHandler(io.Writer(buf), &slog.HandlerOptions{
|
|
Level: slog.LevelDebug,
|
|
})))
|
|
return buf, func() { slog.SetDefault(original) }
|
|
}
|
|
|
|
// TestLoggingHygiene_HandleAuthRequest_LeaksNothing exercises the full
|
|
// HandleAuthRequest path against a mock IdP and asserts that the
|
|
// generated state, nonce, PKCE verifier, and pre-login cookie never
|
|
// appear in any captured log line.
|
|
func TestLoggingHygiene_HandleAuthRequest_LeaksNothing(t *testing.T) {
|
|
idp := newMockIdP(t)
|
|
svc, _ := newServiceWithProviderAndPL(t, idp.URL(), "op-leak-1")
|
|
|
|
buf, restore := captureLogger(t)
|
|
defer restore()
|
|
|
|
authURL, cookieValue, _, err := svc.HandleAuthRequest(context.Background(), "op-leak-1")
|
|
if err != nil {
|
|
t.Fatalf("HandleAuthRequest: %v", err)
|
|
}
|
|
|
|
// Extract state from the authURL query so we can grep-assert.
|
|
parts := strings.Split(authURL, "state=")
|
|
if len(parts) < 2 {
|
|
t.Fatalf("authURL missing state param: %q", authURL)
|
|
}
|
|
stateValue := strings.SplitN(parts[1], "&", 2)[0]
|
|
|
|
captured := buf.String()
|
|
for _, secret := range []string{stateValue, cookieValue} {
|
|
if secret == "" {
|
|
continue
|
|
}
|
|
if strings.Contains(captured, secret) {
|
|
t.Errorf("secret value %q appeared in log output:\n%s", secret, captured)
|
|
}
|
|
}
|
|
}
|
|
|
|
// TestLoggingHygiene_HandleCallback_LeaksNothing runs the full callback
|
|
// flow (against the mock IdP) and grep-asserts the captured log buffer
|
|
// has no occurrence of the access token, the ID token, the
|
|
// authorization code, or the PKCE verifier.
|
|
func TestLoggingHygiene_HandleCallback_LeaksNothing(t *testing.T) {
|
|
idp := newMockIdP(t)
|
|
svc, pl := newServiceWithProviderAndPL(t, idp.URL(), "op-leak-2")
|
|
|
|
// Pre-login row with a known verifier we can grep for after.
|
|
verifier := "test-verifier-do-not-leak-aaaaaaaaaaaaa"
|
|
cookie, _, err := pl.CreatePreLogin(context.Background(), "op-leak-2", "the-state", "test-nonce-fixed", verifier)
|
|
if err != nil {
|
|
t.Fatalf("CreatePreLogin: %v", err)
|
|
}
|
|
|
|
buf, restore := captureLogger(t)
|
|
defer restore()
|
|
|
|
authCode := "secret-auth-code-do-not-leak"
|
|
res, err := svc.HandleCallback(context.Background(), cookie, authCode, "the-state", "", "10.0.0.1", "Mozilla")
|
|
if err != nil {
|
|
t.Fatalf("HandleCallback: %v", err)
|
|
}
|
|
|
|
captured := buf.String()
|
|
|
|
// Direct secrets that flow through HandleCallback's parameter list.
|
|
for _, secret := range []string{
|
|
authCode,
|
|
verifier,
|
|
"test-access-token",
|
|
idp.receivedCode,
|
|
idp.receivedVerifier,
|
|
} {
|
|
if secret == "" {
|
|
continue
|
|
}
|
|
if strings.Contains(captured, secret) {
|
|
t.Errorf("secret value %q appeared in log output:\n%s", secret, captured)
|
|
}
|
|
}
|
|
|
|
// The session cookie + CSRF token are returned by the mint stub;
|
|
// in production they're set on the response, not logged. Pin that
|
|
// we never logged them.
|
|
for _, secret := range []string{res.CookieValue, res.CSRFToken} {
|
|
if secret == "" {
|
|
continue
|
|
}
|
|
if strings.Contains(captured, secret) {
|
|
t.Errorf("session secret %q appeared in log output:\n%s", secret, captured)
|
|
}
|
|
}
|
|
}
|
|
|
|
// TestLoggingHygiene_AlgPinningDoesNotLogAlg is a defense-in-depth pin:
|
|
// when isDisallowedAlg rejects a token, the alg name might land in an
|
|
// error returned to the handler — but the service.go MUST NOT log the
|
|
// alg value itself (an attacker could probe to discover allow-list
|
|
// composition). The handler maps to a uniform 400; alg detail lives
|
|
// only in audit rows the operator owns.
|
|
func TestLoggingHygiene_AlgRejectionDoesNotLogAlg(t *testing.T) {
|
|
buf, restore := captureLogger(t)
|
|
defer restore()
|
|
|
|
// Direct call to the helper; this exercises the deny-list match.
|
|
_, _ = isDisallowedAlg("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.body.sig")
|
|
|
|
captured := buf.String()
|
|
if strings.Contains(captured, "HS256") {
|
|
t.Errorf("alg value HS256 appeared in log output (defense-in-depth violation):\n%s", captured)
|
|
}
|
|
}
|
|
|
|
// TestLoggingHygiene_ProviderLoadDoesNotLogClientSecret pins that
|
|
// even on getOrLoad failures, the decrypted client_secret bytes never
|
|
// land in a log line. Decryption happens before verifier construction;
|
|
// any error path that flows through must not surface the plaintext.
|
|
func TestLoggingHygiene_ProviderLoadDoesNotLogClientSecret(t *testing.T) {
|
|
idp := newMockIdP(t)
|
|
|
|
// Use a provider with a recognizable plaintext "secret" (no encryption
|
|
// key set, so decryptClientSecret returns the bytes as-is).
|
|
prov := makeProvider(idp.URL(), "op-leak-secret")
|
|
prov.ClientSecretEncrypted = []byte("client-secret-plaintext-do-not-leak-xxxxx")
|
|
|
|
pl := newStubPreLogin()
|
|
svc := NewService(
|
|
&stubProviderLookup{provider: prov},
|
|
&stubMappings{roleIDs: []string{"r-operator"}},
|
|
newStubUsers(),
|
|
&stubSessions{},
|
|
pl,
|
|
"",
|
|
)
|
|
|
|
buf, restore := captureLogger(t)
|
|
defer restore()
|
|
|
|
if _, err := svc.getOrLoad(context.Background(), "op-leak-secret"); err != nil {
|
|
t.Fatalf("getOrLoad: %v", err)
|
|
}
|
|
|
|
captured := buf.String()
|
|
if strings.Contains(captured, "client-secret-plaintext-do-not-leak") {
|
|
t.Errorf("client secret plaintext appeared in log output:\n%s", captured)
|
|
}
|
|
}
|