audit

Documentation

Index

• type Event
• type EventType
• type Logger
  • func NewLogger(w io.Writer) *Logger
  • func (l *Logger) Log(_ context.Context, event Event)
  • func (l *Logger) LogAdminOp(ctx context.Context, actor, action, resource, detail string)
  • func (l *Logger) LogAuth(ctx context.Context, actor, sourceIP string, success bool, detail string)
  • func (l *Logger) LogComponentOp(ctx context.Context, actor, action, componentID, detail string, success bool)
  • func (l *Logger) LogConfigChange(ctx context.Context, actor, resource, detail string)
  • func (l *Logger) LogDataAccess(ctx context.Context, actor, resource, detail string)
  • func (l *Logger) LogEscalation(ctx context.Context, actor, action, detail string, success bool)

Types

type Event

type Event struct {
	Timestamp time.Time      `json:"timestamp"`
	Type      EventType      `json:"type"`
	Action    string         `json:"action"`
	Actor     string         `json:"actor,omitempty"`
	Resource  string         `json:"resource,omitempty"`
	Detail    string         `json:"detail,omitempty"`
	SourceIP  string         `json:"source_ip,omitempty"`
	Success   bool           `json:"success"`
	Metadata  map[string]any `json:"metadata,omitempty"`
}

Event is a single audit log entry.

type EventType

type EventType string

EventType classifies security-relevant audit events.

const (
	EventAuth         EventType = "auth"
	EventAuthFailure  EventType = "auth_failure"
	EventAdminOp      EventType = "admin_op"
	EventEscalation   EventType = "escalation"
	EventDataAccess   EventType = "data_access"
	EventConfigChange EventType = "config_change"
	EventComponentOp  EventType = "component_op"
)

type Logger

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

Logger records security-relevant audit events as structured JSON.

func NewLogger

func NewLogger(w io.Writer) *Logger

NewLogger creates an AuditLogger that writes JSON events to the given writer. If w is nil, it defaults to os.Stdout.

func (*Logger) Log

func (l *Logger) Log(_ context.Context, event Event)

Log records an audit event. It is safe for concurrent use.

func (*Logger) LogAdminOp

func (l *Logger) LogAdminOp(ctx context.Context, actor, action, resource, detail string)

LogAdminOp records an administrative operation.

func (*Logger) LogAuth

func (l *Logger) LogAuth(ctx context.Context, actor, sourceIP string, success bool, detail string)

LogAuth records an authentication event.

func (*Logger) LogComponentOp

func (l *Logger) LogComponentOp(ctx context.Context, actor, action, componentID, detail string, success bool)

LogComponentOp records a dynamic component lifecycle operation.

func (*Logger) LogConfigChange

func (l *Logger) LogConfigChange(ctx context.Context, actor, resource, detail string)

LogConfigChange records a configuration change event.

func (*Logger) LogDataAccess

func (l *Logger) LogDataAccess(ctx context.Context, actor, resource, detail string)

LogDataAccess records a data access event.

func (*Logger) LogEscalation

func (l *Logger) LogEscalation(ctx context.Context, actor, action, detail string, success bool)

LogEscalation records a privilege escalation event.