mirror of
https://github.com/shankar0123/certctl.git
synced 2026-06-07 19:01:34 +00:00
Merge branch 'fix/bundle-6-audit-integrity-privacy' (Bundle 6: Audit Integrity + Privacy, 3 audit findings)
This commit is contained in:
@@ -32,6 +32,85 @@ If you're preparing for an audit and certctl is already deployed, use the "Opera
|
||||
| PCI-DSS 4.0 | Cardholder data protection | TLS lifecycle, key management, immutable logging, access control |
|
||||
| NIST SP 800-57 | Cryptographic key management | Agent-side keygen, key isolation, algorithm selection, revocation |
|
||||
|
||||
## Audit-Trail Integrity & Privacy (Bundle 6)
|
||||
|
||||
Two complementary controls protect the `audit_events` table against tampering and minimize PII exposure. Both apply automatically — no operator action is required at install time, but operators must understand the contract before responding to a legal-hold or retention request.
|
||||
|
||||
### Append-Only Enforcement (HIPAA §164.312(b))
|
||||
|
||||
<!-- Source: migrations/000018_audit_events_worm.up.sql -->
|
||||
|
||||
`audit_events` rows cannot be modified or deleted by the application role. Two layers:
|
||||
|
||||
| Layer | Mechanism | Surface |
|
||||
|---|---|---|
|
||||
| **DB trigger** | `audit_events_block_modification()` raises `check_violation` on `BEFORE UPDATE OR DELETE` | Catches any UPDATE / DELETE — including direct `psql` from the app role |
|
||||
| **App-role grant** | `REVOKE UPDATE, DELETE ON audit_events FROM certctl` | Defence-in-depth; the app role can't even attempt the modification |
|
||||
|
||||
**Verification.** From a `psql` session connected as the `certctl` app role:
|
||||
|
||||
```sql
|
||||
UPDATE audit_events SET actor = 'tampered' WHERE id = 'audit-001';
|
||||
-- ERROR: audit_events is append-only (Bundle-6 / M-017 / HIPAA §164.312(b))
|
||||
-- HINT: Use a compliance superuser role for legitimate retention operations.
|
||||
```
|
||||
|
||||
**Compliance superuser pattern.** Legitimate retention work (legal hold, GDPR right-to-be-forgotten, statutory purges) requires a separate PostgreSQL role provisioned out-of-band that bypasses the trigger. Certctl does NOT auto-create this role — operators provision it per their compliance policy. Suggested shape:
|
||||
|
||||
```sql
|
||||
-- One-time setup by a DBA. Stored procedure pattern keeps the
|
||||
-- compliance superuser audit-able too: every invocation should
|
||||
-- itself land in audit_events.
|
||||
CREATE ROLE certctl_compliance LOGIN PASSWORD '<strong-secret>';
|
||||
GRANT UPDATE, DELETE ON audit_events TO certctl_compliance;
|
||||
-- (optional) provision SECURITY DEFINER stored procedures that
|
||||
-- (a) record the retention reason in audit_events as the FIRST step
|
||||
-- (b) then perform the UPDATE/DELETE
|
||||
-- (c) all under the certctl_compliance role's grants.
|
||||
```
|
||||
|
||||
### Body Redaction (GDPR Art. 32, CWE-532)
|
||||
|
||||
<!-- Source: internal/service/audit_redact.go -->
|
||||
|
||||
`AuditService.RecordEvent` routes every `details` map through `RedactDetailsForAudit` BEFORE marshaling to the JSONB column. Two deny-lists:
|
||||
|
||||
| Category | Match | Replacement | Examples |
|
||||
|---|---|---|---|
|
||||
| **Credentials** | case-insensitive key match | `"[REDACTED:CREDENTIAL]"` | `api_key`, `password`, `token`, `*_pem`, `eab_secret`, `acme_account_key`, `signature` |
|
||||
| **PII** | case-insensitive key match | `"[REDACTED:PII]"` | `email`, `phone`, `ssn`, `dob`, `name`, `address`, `postal_code`, `ip_address` |
|
||||
|
||||
Nested maps and arrays are walked recursively — sensitive keys at any depth get scrubbed. The redactor is mutation-free (the caller's original map is unchanged) so service-layer code that reuses the map elsewhere is safe.
|
||||
|
||||
**Operator visibility — `redacted_keys` array.** The redacted map includes a `redacted_keys` array listing every dotted-path that was scrubbed. This surfaces the redaction footprint to compliance auditors without exposing values. Example before/after:
|
||||
|
||||
```jsonc
|
||||
// Caller's input map (e.g., from a service handler):
|
||||
{
|
||||
"action": "create_issuer",
|
||||
"issuer_id": "iss-acme-prod",
|
||||
"config": {
|
||||
"endpoint": "https://acme.example.com",
|
||||
"eab_secret": "abc123secret",
|
||||
"contact": { "email": "ops@example.com", "role": "admin" }
|
||||
}
|
||||
}
|
||||
|
||||
// Persisted in audit_events.details:
|
||||
{
|
||||
"action": "create_issuer",
|
||||
"issuer_id": "iss-acme-prod",
|
||||
"config": {
|
||||
"endpoint": "https://acme.example.com",
|
||||
"eab_secret": "[REDACTED:CREDENTIAL]",
|
||||
"contact": { "email": "[REDACTED:PII]", "role": "admin" }
|
||||
},
|
||||
"redacted_keys": ["config.eab_secret", "config.contact.email"]
|
||||
}
|
||||
```
|
||||
|
||||
**Maintenance.** When introducing a new credential-bearing field anywhere in the codebase, add the key name to `credentialKeys` (or `piiKeys`) in `internal/service/audit_redact.go`. The unit test suite in `audit_redact_test.go` exercises every entry and proves case-insensitivity + JSON round-trip safety.
|
||||
|
||||
## certctl Pro (V3) Enhancements
|
||||
|
||||
Several compliance-relevant features are planned for certctl Pro:
|
||||
|
||||
@@ -0,0 +1,88 @@
|
||||
package postgres_test
|
||||
|
||||
import (
|
||||
"context"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
|
||||
// Bundle-6 / Audit M-017 / HIPAA §164.312(b):
|
||||
//
|
||||
// migrations/000018_audit_events_worm.up.sql installs a BEFORE UPDATE OR
|
||||
// DELETE trigger on audit_events that raises check_violation. This test
|
||||
// boots a real Postgres via testcontainers, runs all migrations (including
|
||||
// 000018), then exercises the trigger:
|
||||
//
|
||||
// INSERT a row → succeeds (append is allowed)
|
||||
// UPDATE the row → fails with check_violation
|
||||
// DELETE the row → fails with check_violation
|
||||
// INSERT a second row → succeeds (write path remains open)
|
||||
//
|
||||
// The test is gated by testing.Short() so the default `go test ./... -short`
|
||||
// loop in CI doesn't require docker-in-docker. Run via:
|
||||
//
|
||||
// go test -count=1 ./internal/repository/postgres/...
|
||||
|
||||
func TestAuditEventsWORM_AppendOnlyEnforced(t *testing.T) {
|
||||
if testing.Short() {
|
||||
t.Skip("skipping integration test in short mode")
|
||||
}
|
||||
|
||||
tdb := setupTestDB(t)
|
||||
defer tdb.teardown(t)
|
||||
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
|
||||
defer cancel()
|
||||
|
||||
// INSERT — must succeed (append is the supported write path).
|
||||
_, err := tdb.db.ExecContext(ctx, `
|
||||
INSERT INTO audit_events (id, actor, actor_type, action, resource_type, resource_id, details, timestamp)
|
||||
VALUES ('audit-bundle6-001', 'tester', 'User', 'create_certificate', 'certificate', 'mc-test-001', '{}'::jsonb, NOW())
|
||||
`)
|
||||
if err != nil {
|
||||
t.Fatalf("INSERT (append) should succeed: %v", err)
|
||||
}
|
||||
|
||||
// UPDATE — trigger MUST fire and raise check_violation.
|
||||
_, err = tdb.db.ExecContext(ctx, `
|
||||
UPDATE audit_events SET actor = 'tampered' WHERE id = 'audit-bundle6-001'
|
||||
`)
|
||||
if err == nil {
|
||||
t.Fatal("UPDATE should fail with check_violation; got nil error (WORM trigger missing?)")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "audit_events is append-only") {
|
||||
t.Errorf("UPDATE error should cite the WORM rationale; got: %v", err)
|
||||
}
|
||||
|
||||
// DELETE — trigger MUST fire and raise check_violation.
|
||||
_, err = tdb.db.ExecContext(ctx, `
|
||||
DELETE FROM audit_events WHERE id = 'audit-bundle6-001'
|
||||
`)
|
||||
if err == nil {
|
||||
t.Fatal("DELETE should fail with check_violation; got nil error (WORM trigger missing?)")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "audit_events is append-only") {
|
||||
t.Errorf("DELETE error should cite the WORM rationale; got: %v", err)
|
||||
}
|
||||
|
||||
// INSERT again — confirm the write path remains open after a blocked
|
||||
// modification attempt (no trigger-state corruption).
|
||||
_, err = tdb.db.ExecContext(ctx, `
|
||||
INSERT INTO audit_events (id, actor, actor_type, action, resource_type, resource_id, details, timestamp)
|
||||
VALUES ('audit-bundle6-002', 'tester', 'User', 'list_certificates', 'certificate', '*', '{}'::jsonb, NOW())
|
||||
`)
|
||||
if err != nil {
|
||||
t.Fatalf("INSERT after blocked UPDATE/DELETE should still succeed: %v", err)
|
||||
}
|
||||
|
||||
// Sanity check: both INSERTs landed.
|
||||
var count int
|
||||
row := tdb.db.QueryRowContext(ctx, `SELECT COUNT(*) FROM audit_events WHERE id IN ('audit-bundle6-001', 'audit-bundle6-002')`)
|
||||
if err := row.Scan(&count); err != nil {
|
||||
t.Fatalf("count query failed: %v", err)
|
||||
}
|
||||
if count != 2 {
|
||||
t.Errorf("expected 2 rows, got %d (WORM trigger may be blocking INSERT)", count)
|
||||
}
|
||||
}
|
||||
@@ -23,8 +23,19 @@ func NewAuditService(auditRepo repository.AuditRepository) *AuditService {
|
||||
}
|
||||
|
||||
// RecordEvent records an audit event with actor, action, and resource information.
|
||||
//
|
||||
// Bundle-6 / Audit H-008 + M-022 / CWE-532: every details map flows through
|
||||
// RedactDetailsForAudit BEFORE marshaling. The redactor scrubs credential
|
||||
// keys (api_key, password, token, *_pem, eab_secret, ...) and PII keys
|
||||
// (email, phone, ssn, name, address, ip_address, ...) and surfaces a
|
||||
// `redacted_keys` array so operators can audit the redactor itself during
|
||||
// a compliance review. See internal/service/audit_redact.go.
|
||||
func (s *AuditService) RecordEvent(ctx context.Context, actor string, actorType domain.ActorType, action string, resourceType string, resourceID string, details map[string]interface{}) error {
|
||||
detailsJSON, err := json.Marshal(details)
|
||||
// Bundle-6: scrub credentials + PII before persistence. Returns nil
|
||||
// for nil/empty input, preserving pre-Bundle-6 behaviour for callers
|
||||
// that pass nil details.
|
||||
redacted := RedactDetailsForAudit(details)
|
||||
detailsJSON, err := json.Marshal(redacted)
|
||||
if err != nil {
|
||||
detailsJSON = []byte("{}")
|
||||
}
|
||||
|
||||
@@ -0,0 +1,176 @@
|
||||
package service
|
||||
|
||||
import (
|
||||
"strings"
|
||||
)
|
||||
|
||||
// Bundle-6 / Audit H-008 + M-022 / CWE-532 (Insertion of Sensitive Information into Log File):
|
||||
//
|
||||
// Audit events flow into the audit_events.details JSONB column. Pre-Bundle-6,
|
||||
// the middleware stored only `body_hash` (sha256 truncated) — no raw body —
|
||||
// but service-layer call sites pass arbitrary map[string]interface{} details
|
||||
// at every RecordEvent invocation. A future call site that accidentally
|
||||
// includes a credential key (api_key, password, ACME EAB secret, etc.) or
|
||||
// a PII key (email, phone, SSN, etc.) would persist plaintext into the
|
||||
// append-only audit table.
|
||||
//
|
||||
// This file is the chokepoint that scrubs every details map BEFORE
|
||||
// AuditService.RecordEvent marshals it. Two deny-lists:
|
||||
//
|
||||
// credentialKeys — value replaced with "[REDACTED:CREDENTIAL]"
|
||||
// piiKeys — value replaced with "[REDACTED:PII]"
|
||||
//
|
||||
// The redacted entry surfaces in `details.redacted_keys` so operators can
|
||||
// audit the redactor itself during a compliance review (GDPR Art. 30
|
||||
// records-of-processing requires this transparency).
|
||||
//
|
||||
// Match semantics:
|
||||
// - case-insensitive
|
||||
// - structural: walks nested maps and arrays
|
||||
// - exact key match (substring would over-redact — e.g. "tokenized_data")
|
||||
//
|
||||
// Compliance mapping:
|
||||
// - GDPR Art. 32 (data minimization) — M-022
|
||||
// - HIPAA §164.312(b) (audit controls) — paired with WORM trigger
|
||||
// - PCI-DSS 4.0 Req 3 (protect stored PII) — paired with M-018 (deferred)
|
||||
|
||||
// credentialKeys are field names whose values must never appear in the
|
||||
// audit log. Match is case-insensitive. Add new entries when a new
|
||||
// credential-bearing field is introduced anywhere in the codebase.
|
||||
var credentialKeys = map[string]bool{
|
||||
"api_key": true,
|
||||
"apikey": true,
|
||||
"password": true,
|
||||
"passphrase": true,
|
||||
"secret": true,
|
||||
"client_secret": true,
|
||||
"token": true,
|
||||
"access_token": true,
|
||||
"refresh_token": true,
|
||||
"bootstrap_token": true,
|
||||
"credential": true,
|
||||
"credentials": true,
|
||||
"private_key": true,
|
||||
"privatekey": true,
|
||||
"private_key_pem": true,
|
||||
"key_pem": true,
|
||||
"cert_pem": true,
|
||||
"chain_pem": true,
|
||||
"full_pem": true,
|
||||
"eab_secret": true,
|
||||
"eab_kid": true,
|
||||
"acme_account_key": true,
|
||||
"hmac": true,
|
||||
"hmac_key": true,
|
||||
"signature": true,
|
||||
"auth": true,
|
||||
"authorization": true,
|
||||
"bearer": true,
|
||||
}
|
||||
|
||||
// piiKeys are field names that may carry personal data. Redacted by
|
||||
// default; per-route opt-in retention is a future enhancement (post-Bundle-6).
|
||||
// Note `ip_address` is debatable — useful for forensics but flagged by
|
||||
// GDPR Art. 32 — defaulting to redact, operators can audit + adjust.
|
||||
var piiKeys = map[string]bool{
|
||||
"email": true,
|
||||
"email_address": true,
|
||||
"phone": true,
|
||||
"phone_number": true,
|
||||
"telephone": true,
|
||||
"ssn": true,
|
||||
"social_security": true,
|
||||
"dob": true,
|
||||
"date_of_birth": true,
|
||||
"name": true,
|
||||
"full_name": true,
|
||||
"first_name": true,
|
||||
"last_name": true,
|
||||
"surname": true,
|
||||
"address": true,
|
||||
"street": true,
|
||||
"street_address": true,
|
||||
"city": true,
|
||||
"postal_code": true,
|
||||
"zip": true,
|
||||
"zipcode": true,
|
||||
"ip": true,
|
||||
"ip_address": true,
|
||||
}
|
||||
|
||||
// RedactDetailsForAudit walks a details map and returns a NEW map with
|
||||
// credential + PII values scrubbed. The original map is NOT mutated (so
|
||||
// service-layer code that reuses the map for other purposes is safe).
|
||||
//
|
||||
// The returned map is the original shape PLUS a `redacted_keys` array
|
||||
// listing every key path that was scrubbed. The array surfaces redaction
|
||||
// footprint to operators without exposing values.
|
||||
//
|
||||
// nil-in / empty-in returns nil so callers can pass through to
|
||||
// json.Marshal which renders "null" — matches pre-Bundle-6 behaviour
|
||||
// for nil-details RecordEvent calls.
|
||||
func RedactDetailsForAudit(details map[string]interface{}) map[string]interface{} {
|
||||
if len(details) == 0 {
|
||||
return nil
|
||||
}
|
||||
|
||||
out := make(map[string]interface{}, len(details)+1)
|
||||
var redactedKeys []string
|
||||
|
||||
for k, v := range details {
|
||||
lower := strings.ToLower(k)
|
||||
switch {
|
||||
case credentialKeys[lower]:
|
||||
out[k] = "[REDACTED:CREDENTIAL]"
|
||||
redactedKeys = append(redactedKeys, k)
|
||||
case piiKeys[lower]:
|
||||
out[k] = "[REDACTED:PII]"
|
||||
redactedKeys = append(redactedKeys, k)
|
||||
default:
|
||||
// Recurse into nested maps + arrays so deeply-nested credentials
|
||||
// don't bypass the redactor. Primitives pass through unchanged.
|
||||
out[k] = redactValue(v, &redactedKeys, k)
|
||||
}
|
||||
}
|
||||
|
||||
if len(redactedKeys) > 0 {
|
||||
// Surface the redaction footprint. If the caller accidentally
|
||||
// passed `redacted_keys` themselves, prefer ours — the redactor's
|
||||
// view of what was scrubbed is the load-bearing audit signal.
|
||||
out["redacted_keys"] = redactedKeys
|
||||
}
|
||||
return out
|
||||
}
|
||||
|
||||
// redactValue is the recursive arm of RedactDetailsForAudit. It walks
|
||||
// arbitrary JSON-shaped values (map / slice / scalar) and returns a value
|
||||
// with credential + PII keys scrubbed. Mutation-free.
|
||||
func redactValue(v interface{}, redactedKeys *[]string, parentKey string) interface{} {
|
||||
switch typed := v.(type) {
|
||||
case map[string]interface{}:
|
||||
nested := make(map[string]interface{}, len(typed))
|
||||
for k, vv := range typed {
|
||||
lower := strings.ToLower(k)
|
||||
switch {
|
||||
case credentialKeys[lower]:
|
||||
nested[k] = "[REDACTED:CREDENTIAL]"
|
||||
*redactedKeys = append(*redactedKeys, parentKey+"."+k)
|
||||
case piiKeys[lower]:
|
||||
nested[k] = "[REDACTED:PII]"
|
||||
*redactedKeys = append(*redactedKeys, parentKey+"."+k)
|
||||
default:
|
||||
nested[k] = redactValue(vv, redactedKeys, parentKey+"."+k)
|
||||
}
|
||||
}
|
||||
return nested
|
||||
case []interface{}:
|
||||
nested := make([]interface{}, len(typed))
|
||||
for i, item := range typed {
|
||||
nested[i] = redactValue(item, redactedKeys, parentKey)
|
||||
}
|
||||
return nested
|
||||
default:
|
||||
// scalar (string, number, bool, nil) — pass through unchanged.
|
||||
return typed
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,245 @@
|
||||
package service
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"sort"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
// Bundle-6 / Audit H-008 + M-022 / CWE-532 regression suite.
|
||||
|
||||
func TestRedactDetailsForAudit_NilAndEmpty(t *testing.T) {
|
||||
if got := RedactDetailsForAudit(nil); got != nil {
|
||||
t.Errorf("nil input → expected nil out, got %v", got)
|
||||
}
|
||||
if got := RedactDetailsForAudit(map[string]interface{}{}); got != nil {
|
||||
t.Errorf("empty input → expected nil out, got %v", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRedactDetailsForAudit_CredentialKeys(t *testing.T) {
|
||||
cases := []string{
|
||||
"api_key", "ApiKey", "API_KEY", "password", "Passphrase",
|
||||
"secret", "client_secret", "token", "access_token",
|
||||
"refresh_token", "bootstrap_token", "private_key", "PrivateKey",
|
||||
"private_key_pem", "key_pem", "cert_pem", "chain_pem", "full_pem",
|
||||
"eab_secret", "eab_kid", "acme_account_key", "hmac",
|
||||
"signature", "auth", "authorization", "bearer",
|
||||
}
|
||||
for _, key := range cases {
|
||||
t.Run(key, func(t *testing.T) {
|
||||
in := map[string]interface{}{
|
||||
key: "sensitive-value-do-not-leak",
|
||||
"non_sensitive_id": "ok-public-id",
|
||||
}
|
||||
out := RedactDetailsForAudit(in)
|
||||
if out[key] != "[REDACTED:CREDENTIAL]" {
|
||||
t.Errorf("expected credential redaction, got %v", out[key])
|
||||
}
|
||||
if out["non_sensitive_id"] != "ok-public-id" {
|
||||
t.Errorf("non-sensitive field mutated: %v", out["non_sensitive_id"])
|
||||
}
|
||||
redactedKeys, ok := out["redacted_keys"].([]string)
|
||||
if !ok || len(redactedKeys) != 1 || redactedKeys[0] != key {
|
||||
t.Errorf("redacted_keys = %v, expected [%q]", out["redacted_keys"], key)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestRedactDetailsForAudit_PIIKeys(t *testing.T) {
|
||||
cases := []string{
|
||||
"email", "Email_Address", "phone", "telephone", "ssn",
|
||||
"social_security", "dob", "date_of_birth", "name", "full_name",
|
||||
"first_name", "last_name", "surname", "address", "street",
|
||||
"street_address", "city", "postal_code", "zip", "ip_address",
|
||||
}
|
||||
for _, key := range cases {
|
||||
t.Run(key, func(t *testing.T) {
|
||||
in := map[string]interface{}{key: "personal-data"}
|
||||
out := RedactDetailsForAudit(in)
|
||||
if out[key] != "[REDACTED:PII]" {
|
||||
t.Errorf("expected PII redaction, got %v", out[key])
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestRedactDetailsForAudit_NestedMap(t *testing.T) {
|
||||
in := map[string]interface{}{
|
||||
"resource_id": "iss-prod",
|
||||
"config": map[string]interface{}{
|
||||
"endpoint": "https://acme.example.com",
|
||||
"eab_secret": "do-not-leak-this-secret",
|
||||
"contact": map[string]interface{}{
|
||||
"email": "ops@example.com",
|
||||
"role": "admin",
|
||||
},
|
||||
},
|
||||
}
|
||||
out := RedactDetailsForAudit(in)
|
||||
|
||||
cfg, ok := out["config"].(map[string]interface{})
|
||||
if !ok {
|
||||
t.Fatalf("config field shape changed: %T", out["config"])
|
||||
}
|
||||
if cfg["eab_secret"] != "[REDACTED:CREDENTIAL]" {
|
||||
t.Errorf("nested credential not redacted: %v", cfg["eab_secret"])
|
||||
}
|
||||
if cfg["endpoint"] != "https://acme.example.com" {
|
||||
t.Errorf("non-sensitive nested field mutated: %v", cfg["endpoint"])
|
||||
}
|
||||
contact, ok := cfg["contact"].(map[string]interface{})
|
||||
if !ok {
|
||||
t.Fatalf("contact field shape changed: %T", cfg["contact"])
|
||||
}
|
||||
if contact["email"] != "[REDACTED:PII]" {
|
||||
t.Errorf("nested PII not redacted: %v", contact["email"])
|
||||
}
|
||||
if contact["role"] != "admin" {
|
||||
t.Errorf("non-sensitive nested field mutated: %v", contact["role"])
|
||||
}
|
||||
|
||||
// redacted_keys array surfaces the dotted paths
|
||||
redactedKeys, ok := out["redacted_keys"].([]string)
|
||||
if !ok {
|
||||
t.Fatalf("redacted_keys missing or wrong type: %T", out["redacted_keys"])
|
||||
}
|
||||
sort.Strings(redactedKeys)
|
||||
wantKeys := []string{"config.contact.email", "config.eab_secret"}
|
||||
if len(redactedKeys) != len(wantKeys) {
|
||||
t.Errorf("redacted_keys len mismatch: got %v want %v", redactedKeys, wantKeys)
|
||||
}
|
||||
for i, want := range wantKeys {
|
||||
if i >= len(redactedKeys) || redactedKeys[i] != want {
|
||||
t.Errorf("redacted_keys[%d] = %q want %q", i, redactedKeys[i], want)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestRedactDetailsForAudit_NestedArray(t *testing.T) {
|
||||
// Arrays of maps (e.g. SANs with metadata) — credentials inside array
|
||||
// elements must also be redacted.
|
||||
in := map[string]interface{}{
|
||||
"contacts": []interface{}{
|
||||
map[string]interface{}{
|
||||
"name": "Alice",
|
||||
"email": "alice@example.com",
|
||||
},
|
||||
map[string]interface{}{
|
||||
"name": "Bob",
|
||||
"email": "bob@example.com",
|
||||
},
|
||||
},
|
||||
}
|
||||
out := RedactDetailsForAudit(in)
|
||||
contacts, ok := out["contacts"].([]interface{})
|
||||
if !ok {
|
||||
t.Fatalf("contacts shape changed: %T", out["contacts"])
|
||||
}
|
||||
if len(contacts) != 2 {
|
||||
t.Fatalf("expected 2 contacts, got %d", len(contacts))
|
||||
}
|
||||
for i, c := range contacts {
|
||||
m, ok := c.(map[string]interface{})
|
||||
if !ok {
|
||||
t.Fatalf("contact %d shape changed: %T", i, c)
|
||||
}
|
||||
if m["email"] != "[REDACTED:PII]" {
|
||||
t.Errorf("contact[%d].email not redacted: %v", i, m["email"])
|
||||
}
|
||||
if m["name"] != "[REDACTED:PII]" {
|
||||
t.Errorf("contact[%d].name not redacted: %v", i, m["name"])
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestRedactDetailsForAudit_NoRedactionPath(t *testing.T) {
|
||||
// Maps with no sensitive keys should NOT have a redacted_keys array
|
||||
// — clutter-free for the common case.
|
||||
in := map[string]interface{}{
|
||||
"action": "create_certificate",
|
||||
"cert_id": "mc-prod-001",
|
||||
"latency_ms": float64(42),
|
||||
}
|
||||
out := RedactDetailsForAudit(in)
|
||||
if _, present := out["redacted_keys"]; present {
|
||||
t.Errorf("expected no redacted_keys when no redaction occurred, got %v", out["redacted_keys"])
|
||||
}
|
||||
}
|
||||
|
||||
func TestRedactDetailsForAudit_DoesNotMutateInput(t *testing.T) {
|
||||
in := map[string]interface{}{
|
||||
"api_key": "secret-do-not-leak",
|
||||
"resource": "iss-prod",
|
||||
}
|
||||
_ = RedactDetailsForAudit(in)
|
||||
if in["api_key"] != "secret-do-not-leak" {
|
||||
t.Errorf("input map was mutated: api_key = %v", in["api_key"])
|
||||
}
|
||||
}
|
||||
|
||||
func TestRedactDetailsForAudit_CaseInsensitive(t *testing.T) {
|
||||
cases := []string{"API_KEY", "Api_Key", "api_KEY", "EMAIL", "Email"}
|
||||
for _, key := range cases {
|
||||
t.Run(key, func(t *testing.T) {
|
||||
out := RedactDetailsForAudit(map[string]interface{}{key: "leak-me"})
|
||||
val, _ := out[key].(string)
|
||||
if !strings.HasPrefix(val, "[REDACTED:") {
|
||||
t.Errorf("case-insensitive match failed for %q: %v", key, out[key])
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestRedactDetailsForAudit_JSONRoundTrip(t *testing.T) {
|
||||
// The redacted map MUST round-trip through json.Marshal (the
|
||||
// AuditService persistence path). Catches type-assertion regressions.
|
||||
in := map[string]interface{}{
|
||||
"reason": "compromised-key",
|
||||
"api_key": "leak-me",
|
||||
"contacts": []interface{}{
|
||||
map[string]interface{}{"email": "ops@example.com"},
|
||||
},
|
||||
}
|
||||
out := RedactDetailsForAudit(in)
|
||||
b, err := json.Marshal(out)
|
||||
if err != nil {
|
||||
t.Fatalf("redacted map failed json.Marshal: %v", err)
|
||||
}
|
||||
body := string(b)
|
||||
if strings.Contains(body, "leak-me") {
|
||||
t.Errorf("credential value leaked through marshal: %s", body)
|
||||
}
|
||||
if strings.Contains(body, "ops@example.com") {
|
||||
t.Errorf("PII value leaked through marshal: %s", body)
|
||||
}
|
||||
if !strings.Contains(body, "[REDACTED:CREDENTIAL]") {
|
||||
t.Errorf("redaction sentinel missing from marshaled output: %s", body)
|
||||
}
|
||||
if !strings.Contains(body, "[REDACTED:PII]") {
|
||||
t.Errorf("PII redaction sentinel missing from marshaled output: %s", body)
|
||||
}
|
||||
if !strings.Contains(body, "redacted_keys") {
|
||||
t.Errorf("redacted_keys array missing from marshaled output: %s", body)
|
||||
}
|
||||
}
|
||||
|
||||
// TestRedactDetailsForAudit_ScalarTypes confirms the recursive arm doesn't
|
||||
// mishandle non-map non-slice values.
|
||||
func TestRedactDetailsForAudit_ScalarTypes(t *testing.T) {
|
||||
in := map[string]interface{}{
|
||||
"string_field": "hello",
|
||||
"int_field": 42,
|
||||
"float_field": 3.14,
|
||||
"bool_field": true,
|
||||
"nil_field": nil,
|
||||
}
|
||||
out := RedactDetailsForAudit(in)
|
||||
if out["string_field"] != "hello" || out["int_field"] != 42 ||
|
||||
out["float_field"] != 3.14 || out["bool_field"] != true ||
|
||||
out["nil_field"] != nil {
|
||||
t.Errorf("scalar pass-through failed: %v", out)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,14 @@
|
||||
-- Bundle-6 / Audit M-017: down migration drops the WORM trigger and
|
||||
-- restores writability for dev resets. Production environments should
|
||||
-- never need this — the only use case is a clean teardown of a dev DB
|
||||
-- before re-applying migrations from scratch.
|
||||
|
||||
DROP TRIGGER IF EXISTS audit_events_worm_trigger ON audit_events;
|
||||
DROP FUNCTION IF EXISTS audit_events_block_modification();
|
||||
|
||||
DO $$
|
||||
BEGIN
|
||||
IF EXISTS (SELECT 1 FROM pg_roles WHERE rolname = 'certctl') THEN
|
||||
GRANT UPDATE, DELETE ON audit_events TO certctl;
|
||||
END IF;
|
||||
END $$;
|
||||
@@ -0,0 +1,40 @@
|
||||
-- Bundle-6 / Audit M-017 / HIPAA §164.312(b) (audit controls):
|
||||
--
|
||||
-- audit_events is append-only at the database layer. The application
|
||||
-- role cannot UPDATE or DELETE rows. Compliance superusers (legal hold,
|
||||
-- retention purges) use a separate role provisioned out-of-band that
|
||||
-- bypasses this trigger; see docs/compliance.md for the operator
|
||||
-- pattern.
|
||||
--
|
||||
-- Pre-Bundle-6 enforcement was app-layer only (no DELETE/UPDATE method
|
||||
-- on AuditService). A buggy migration script, a manual psql session, or
|
||||
-- an attacker with the app role's DB credentials could rewrite history.
|
||||
-- This trigger is the load-bearing defence; the REVOKE below is
|
||||
-- defence-in-depth.
|
||||
|
||||
CREATE OR REPLACE FUNCTION audit_events_block_modification()
|
||||
RETURNS TRIGGER AS $$
|
||||
BEGIN
|
||||
RAISE EXCEPTION 'audit_events is append-only (Bundle-6 / M-017 / HIPAA §164.312(b))'
|
||||
USING ERRCODE = 'check_violation',
|
||||
HINT = 'Use a compliance superuser role for legitimate retention operations.';
|
||||
END;
|
||||
$$ LANGUAGE plpgsql;
|
||||
|
||||
DROP TRIGGER IF EXISTS audit_events_worm_trigger ON audit_events;
|
||||
CREATE TRIGGER audit_events_worm_trigger
|
||||
BEFORE UPDATE OR DELETE ON audit_events
|
||||
FOR EACH ROW
|
||||
EXECUTE FUNCTION audit_events_block_modification();
|
||||
|
||||
-- Defence-in-depth: revoke UPDATE + DELETE from the app role too.
|
||||
-- The role is conventionally `certctl` (matches docker-compose POSTGRES_USER
|
||||
-- and Helm values.yaml postgresql.username). If the role doesn't exist
|
||||
-- (test fixtures, single-superuser setups), the DO block is a no-op so
|
||||
-- the migration stays idempotent across all environments.
|
||||
DO $$
|
||||
BEGIN
|
||||
IF EXISTS (SELECT 1 FROM pg_roles WHERE rolname = 'certctl') THEN
|
||||
REVOKE UPDATE, DELETE ON audit_events FROM certctl;
|
||||
END IF;
|
||||
END $$;
|
||||
Reference in New Issue
Block a user