mirror of
https://github.com/shankar0123/certctl.git
synced 2026-06-07 18:51:32 +00:00
b0efdbe2f8
Closes the #3 acquisition-readiness blocker from the 2026-05-01 issuer coverage audit (Part 1.5 finding #1: audit row not transactional with issuance). AuditRepository.Create previously ran on the package-level *sql.DB while the certificate insert / version insert / revocation insert ran on independent connections — a failed audit INSERT after a successful operation INSERT was silently lost. SOX §404 over IT general controls, PCI-DSS §10 audit logging, HIPAA §164.312(b) audit controls, and CA/B Forum Baseline Requirements §5.4.1 audit log records all presume audit-with-operation atomicity. Design — Option A (Querier abstraction). The chosen pattern: a shared repository.Querier interface (subset of *sql.DB and *sql.Tx) plus a postgres.WithinTx helper that begins a tx, runs fn, commits on nil error, rolls back on error or panic, and returns the wrapped result. Repository methods that participate in a service-layer transaction expose a *WithTx variant taking repository.Querier; the bare methods remain for stand-alone use. A repository.Transactor abstracts the "begin tx, run fn, commit/rollback" lifecycle so service-layer code runs multi-write operations atomically without holding *sql.DB directly. Option B (UnitOfWork) was considered but adds boilerplate without behavioral benefit for the current scope. Option C (context-carried tx) was explicitly rejected — it hides the transactional boundary from the type system, reproducing the class of bug we're fixing. This commit: - Adds internal/repository/querier.go with the Querier interface (compile-time guards that *sql.DB and *sql.Tx satisfy it) and the Transactor interface for service-layer use. - Adds internal/repository/postgres/tx.go with the WithinTx helper (begin/fn/commit/rollback with panic recovery) and a transactor type that satisfies repository.Transactor. - Adds CreateWithTx variants on AuditRepository, CertificateRepository (Create + Update + CreateVersion), and RevocationRepository. Existing bare methods now delegate to the *WithTx variant using the package-level *sql.DB so existing call sites are behavior-preserving. - Updates repository/interfaces.go: AuditRepository, CertificateRepository, and RevocationRepository declare the new *WithTx methods. Adds an atomicity contract doc-comment on AuditRepository pointing at WithinTx + the audit blocker. - Adds AuditService.RecordEventWithTx, mirroring RecordEvent but routing through CreateWithTx so the audit row is part of the caller's transaction. Same redaction + marshalling contract. - Refactors three audit-emitting service paths to use Transactor.WithinTx when SetTransactor was wired, with a legacy fallback for backward compat: * CertificateService.Create — cert insert + audit row in one tx. * RevocationSvc.RevokeCertificateWithActor — cert status update + revocation row + audit row in one tx. The OCSP cache invalidate remains best-effort (out of scope per the prompt). * RenewalService CompleteServerRenewal — cert version insert + cert update + audit row in one tx. Job status update stays outside the audit-atomicity scope (job state lives outside the operator-facing audit trail). - Adds SetTransactor on CertificateService, RevocationSvc, and RenewalService. cmd/server/main.go wires a single Transactor instance shared across all three so all audit-emitting paths run their writes in transactions backed by the same *sql.DB handle. - Updates 5 mock implementations to satisfy the new interface methods: mockCertRepo (testutil_test.go), mockCertRepoWithGetError (shortlived_test.go), fakeRevocationRepo (crl_cache_test.go), intuneE2EAuditRepo (scep_intune_e2e_test.go), and the integration- test mocks (lifecycle_test.go: mockCertificateRepository, mockAuditRepository, mockRevocationRepository). All *WithTx mocks ignore the Querier and delegate to the bare method (mocks have no DB; in-memory state is shared regardless of "tx"). - Adds a service-layer test mockTransactor with BeginTxErr and CommitErr knobs so the atomic-audit tests can assert error propagation through the transactional boundary. - Adds internal/repository/postgres/tx_test.go: unit-level test that WithinTx surfaces "begin tx" wrap when BeginTx fails, and that Transactor.WithinTx delegates correctly. Real-Postgres rollback semantics are covered by the testcontainers tests in the postgres package — sandbox disk pressure prevented adding a sqlmock dep for the in-fn / commit-failure unit test, so those scenarios are exercised through atomic_audit_test.go using the mockTransactor's CommitErr / BeginTxErr fields. - Adds internal/service/atomic_audit_test.go: * TestCertificateService_Create_AtomicWithTx — asserts audit insert failure inside the tx surfaces as the operation's error (closes the blocker contract). * TestCertificateService_Create_LegacyPathLogs — pins the backward-compat behavior when SetTransactor isn't wired: audit failure is logged-not-failed, matching pre-fix. * TestCertificateService_Create_TransactorBeginFailure — BeginTx error path: operation fails, no cert insert, no audit insert. * TestCertificateService_Create_TransactorCommitFailure — Commit error after successful in-fn writes surfaces as the operation's error. Real Postgres can fail Commit on serialization conflicts; the service must report this. Out of scope (separate follow-up commits, same shape): - Issuer CRUD audit atomicity. - Target CRUD audit atomicity. - Agent retire (already transactional via RetireAgentWithCascade; verified, not changed). - Renewal-policy CRUD audit atomicity. - Owner/team/agent-group CRUD audit atomicity. - Discovery / health-check audit atomicity. Verified locally: - gofmt -l . clean - go vet ./... clean - staticcheck ./... clean - golangci-lint run --timeout 5m ./... → 0 issues - go test -short -count=1 ./internal/service/ green - go test -short -count=1 ./internal/api/handler/ green - go test -short -count=1 ./internal/integration/ green - go test -short -count=1 ./internal/repository/postgres/ green - go build ./... success Audit reference: cowork/issuer-coverage-audit-2026-05-01/RESULTS.md Top-10 fix #3 (Part 3, narrative section).
101 lines
3.4 KiB
Go
101 lines
3.4 KiB
Go
// Copyright (c) certctl
|
|
// SPDX-License-Identifier: BSL-1.1
|
|
|
|
// WithinTx is the transactional spine for any service-layer operation
|
|
// whose audit row must be atomic with the underlying state change.
|
|
// Closes the #3 acquisition-readiness blocker from the 2026-05-01
|
|
// issuer coverage audit (Part 1.5 finding #1: audit row not
|
|
// transactional with issuance).
|
|
//
|
|
// The Querier interface lives in internal/repository (shared with the
|
|
// interface declarations) so repository interfaces and the postgres
|
|
// concrete types reference the same type without a circular import.
|
|
package postgres
|
|
|
|
import (
|
|
"context"
|
|
"database/sql"
|
|
"fmt"
|
|
|
|
"github.com/shankar0123/certctl/internal/repository"
|
|
)
|
|
|
|
// transactor is the production implementation of repository.Transactor.
|
|
// It wraps a *sql.DB and exposes the WithinTx helper as the interface
|
|
// method service-layer code calls.
|
|
type transactor struct {
|
|
db *sql.DB
|
|
}
|
|
|
|
// NewTransactor returns a repository.Transactor backed by the given
|
|
// *sql.DB. Production wiring (cmd/server/main.go) passes the same db
|
|
// handle that backs the other repositories; tests pass a mock that
|
|
// implements the interface against in-memory state.
|
|
func NewTransactor(db *sql.DB) repository.Transactor {
|
|
return &transactor{db: db}
|
|
}
|
|
|
|
// WithinTx delegates to the package-level WithinTx helper, adapting
|
|
// the function signature so callers receive repository.Querier instead
|
|
// of *sql.Tx (which the interface requires for portability across
|
|
// transactor implementations).
|
|
func (t *transactor) WithinTx(ctx context.Context, fn func(q repository.Querier) error) error {
|
|
return WithinTx(ctx, t.db, func(tx *sql.Tx) error {
|
|
return fn(tx)
|
|
})
|
|
}
|
|
|
|
// Querier is re-exported from the parent repository package so callers
|
|
// inside this package can reference it without an extra import.
|
|
//
|
|
// Deprecated: external callers should use repository.Querier directly.
|
|
// This alias exists for legibility within the postgres package only.
|
|
|
|
// WithinTx runs fn inside a transaction. The transaction is committed
|
|
// if fn returns nil; rolled back if fn returns an error or panics.
|
|
//
|
|
// Contract:
|
|
//
|
|
// - On nil error from fn: tx.Commit() is called. If Commit fails
|
|
// (e.g., serialization conflict, connection drop), the commit
|
|
// error is returned.
|
|
// - On non-nil error from fn: tx.Rollback() is called. If Rollback
|
|
// itself errors, the original fn error is wrapped with the
|
|
// rollback error so operators see both.
|
|
// - On panic in fn: tx.Rollback() is called and the panic is
|
|
// re-raised. The transaction is never left dangling.
|
|
//
|
|
// Callers must NOT call tx.Commit() or tx.Rollback() inside fn — that's
|
|
// WithinTx's job. Returning an error from fn signals "roll back";
|
|
// returning nil signals "commit".
|
|
//
|
|
// BeginTx is called with nil opts; callers needing isolation level
|
|
// other than the database default should construct their own tx via
|
|
// db.BeginTx and not use this helper.
|
|
func WithinTx(ctx context.Context, db *sql.DB, fn func(tx *sql.Tx) error) (err error) {
|
|
tx, err := db.BeginTx(ctx, nil)
|
|
if err != nil {
|
|
return fmt.Errorf("begin tx: %w", err)
|
|
}
|
|
|
|
defer func() {
|
|
if p := recover(); p != nil {
|
|
_ = tx.Rollback()
|
|
panic(p)
|
|
}
|
|
if err != nil {
|
|
if rbErr := tx.Rollback(); rbErr != nil {
|
|
err = fmt.Errorf("%w; rollback: %v", err, rbErr)
|
|
}
|
|
}
|
|
}()
|
|
|
|
if err = fn(tx); err != nil {
|
|
return err
|
|
}
|
|
if cmErr := tx.Commit(); cmErr != nil {
|
|
return fmt.Errorf("commit tx: %w", cmErr)
|
|
}
|
|
return nil
|
|
}
|