audit

type FileWriter ¶

type FileWriter struct {
	// contains filtered or unexported fields
}

FileWriter appends one JSON line per record to a file. It is safe for concurrent use.

ponytail: no rotation here — audit volume for a single-user local tool is small. If it ever needs capping, reuse pkg/ui/shared's rotatingWriter rather than adding a size check inline.

func NewFileWriter(path string) (*FileWriter, error)

func (w *FileWriter) Close() error

func (w *FileWriter) Write(rec Record) error

type Level ¶

type Level string

Level selects which operations are audited.

const (
	LevelAlterOnly Level = "alter_only" // only state-changing operations (default)
	LevelAll       Level = "all"        // reads too
)

type Record ¶

type Record struct {
	Timestamp string         `json:"timestamp"` // ISO-8601 UTC
	User      string         `json:"user"`
	Cluster   string         `json:"cluster,omitempty"`
	Resources []Resource     `json:"resources"`
	Operation string         `json:"operation"`
	Params    map[string]any `json:"params,omitempty"`
	Result    Result         `json:"result"`
	Error     string         `json:"error,omitempty"`
}

Record is one audit-log line.

type Resource ¶

type Resource struct {
	Type    string   `json:"type"`
	ID      string   `json:"id,omitempty"`
	Alter   bool     `json:"alter"`
	Actions []string `json:"actions"`
}

Resource is one resource an operation touched.

type Result ¶

type Result string

Result classifies the outcome of an audited operation.

const (
	ResultSuccess         Result = "success"
	ResultAccessDenied    Result = "access_denied"
	ResultValidationError Result = "validation_error"
	ResultExecutionError  Result = "execution_error"
	ResultUnknownError    Result = "unknown_error"
)

func Classify(err error) Result

type Service ¶

type Service struct {
	// contains filtered or unexported fields
}

Service records audit entries subject to the enabled flag and level. When disabled it is a no-op, so call sites are unconditional. Write failures are logged and never propagated: auditing must never fail or delay the operation.

func NewService(enabled bool, level Level, w Writer, log *slog.Logger) *Service

func (s *Service) Enabled() bool

func (s *Service) Record(rec Record)

type Writer ¶

type Writer interface {
	Write(Record) error
}

Writer appends audit records somewhere durable.