trail

type AuditConfig struct {
	// Minimum log level to record
	MinLogLevel LogLevel `json:"min_log_level"`

	// Whether to enable tamper-evident logging
	TamperEvident bool `json:"tamper_evident"`

	// Secret key for HMAC signatures (if tamper-evident is enabled)
	SigningKey string `json:"signing_key,omitempty"`

	// Whether to redact sensitive information
	RedactSensitiveInfo bool `json:"redact_sensitive_info"`

	// Fields to redact if redaction is enabled
	RedactFields []string `json:"redact_fields,omitempty"`

	// Maximum log retention period in days
	RetentionDays int `json:"retention_days"`

	// Whether to include stack traces for errors
	IncludeStackTraces bool `json:"include_stack_traces"`

	// Whether to compress logs for storage
	CompressLogs bool `json:"compress_logs"`

	// Whether to encrypt logs for storage
	EncryptLogs bool `json:"encrypt_logs"`

	// Encryption key ID (if encryption is enabled)
	EncryptionKeyID string `json:"encryption_key_id,omitempty"`
}

type AuditExporter interface {
	AuditLogger

	// Export exports audit logs in the specified format
	Export(ctx context.Context, logs []*AuditLog, format ExportFormat) ([]byte, error)
}

type AuditLog struct {
	// ID is a unique identifier for the log entry
	ID string `json:"id"`

	// Timestamp is the time when the event occurred (with timezone)
	Timestamp time.Time `json:"timestamp"`

	// Level is the severity level of the log entry
	Level LogLevel `json:"level"`

	// Operation is the type of operation being performed
	Operation OperationType `json:"operation"`

	// Component is the system component affected
	Component string `json:"component"`

	// SubComponent is a more specific part of the component
	SubComponent string `json:"sub_component,omitempty"`

	// User is the user or process that performed the operation
	User string `json:"user,omitempty"`

	// UserID is the unique identifier of the user
	UserID string `json:"user_id,omitempty"`

	// SessionID is the session identifier
	SessionID string `json:"session_id,omitempty"`

	// RequestID is used to correlate multiple log entries for a single request
	RequestID string `json:"request_id,omitempty"`

	// TraceID is used for distributed tracing
	TraceID string `json:"trace_id,omitempty"`

	// IPAddress is the IP address where the operation originated
	IPAddress string `json:"ip_address,omitempty"`

	// UserAgent is the user agent that performed the operation
	UserAgent string `json:"user_agent,omitempty"`

	// Resource is the resource being operated on
	Resource string `json:"resource,omitempty"`

	// ResourceID is the identifier of the resource
	ResourceID string `json:"resource_id,omitempty"`

	// Action is the specific action being performed
	Action string `json:"action,omitempty"`

	// Status is the result status of the operation
	Status string `json:"status"`

	// StatusCode is a numeric status code
	StatusCode int `json:"status_code,omitempty"`

	// Message is a human-readable description of the event
	Message string `json:"message"`

	// ErrorCode is the error code if the operation failed
	ErrorCode string `json:"error_code,omitempty"`

	// ErrorMessage is the error message if the operation failed
	ErrorMessage string `json:"error_message,omitempty"`

	// Duration is the duration of the operation in milliseconds
	Duration int64 `json:"duration,omitempty"`

	// Version contains version information
	Version *VersionInfo `json:"version,omitempty"`

	// Changes contains details about what changed
	Changes *ChangeInfo `json:"changes,omitempty"`

	// Verification contains verification results
	Verification *VerificationInfo `json:"verification,omitempty"`

	// Metadata contains additional contextual information
	Metadata map[string]interface{} `json:"metadata,omitempty"`

	// Tags for categorizing and filtering logs
	Tags []string `json:"tags,omitempty"`

	// Signature is a cryptographic signature for tamper evidence
	Signature string `json:"signature,omitempty"`
}

type AuditLogger interface {
	// GetID returns the unique identifier for this logger
	GetID() string

	// Log records an audit log entry
	Log(ctx context.Context, log *AuditLog) error

	// Close releases any resources used by the logger
	Close() error
}

type AuditQueryLogger interface {
	AuditLogger

	// Query searches for audit logs matching the specified criteria
	Query(ctx context.Context, query *LogQuery) (*LogQueryResult, error)
}

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

type ChangeInfo struct {
	// Before contains the state before the change
	Before map[string]interface{} `json:"before,omitempty"`

	// After contains the state after the change
	After map[string]interface{} `json:"after,omitempty"`

	// Fields lists the specific fields that changed
	Fields []string `json:"fields,omitempty"`

	// Summary provides a human-readable summary of the changes
	Summary string `json:"summary,omitempty"`
}

type ExportFormat string

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

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

type LogLevel string

type LogQuery struct {
	// Start time for the query range
	StartTime time.Time `json:"start_time,omitempty"`

	// End time for the query range
	EndTime time.Time `json:"end_time,omitempty"`

	// Minimum log level to include
	MinLevel LogLevel `json:"min_level,omitempty"`

	// Operation types to include
	Operations []OperationType `json:"operations,omitempty"`

	// Components to include
	Components []string `json:"components,omitempty"`

	// Users to include
	Users []string `json:"users,omitempty"`

	// Resources to include
	Resources []string `json:"resources,omitempty"`

	// Status values to include
	Statuses []string `json:"statuses,omitempty"`

	// Tags to filter by (must match all)
	Tags []string `json:"tags,omitempty"`

	// Full-text search query
	Query string `json:"query,omitempty"`

	// Pagination limit
	Limit int `json:"limit,omitempty"`

	// Pagination offset
	Offset int `json:"offset,omitempty"`

	// Sort field
	SortBy string `json:"sort_by,omitempty"`

	// Sort direction (asc or desc)
	SortDirection string `json:"sort_direction,omitempty"`
}

type LogQueryResult struct {
	// Logs matching the query
	Logs []*AuditLog `json:"logs"`

	// Total number of logs matching the query (before pagination)
	TotalCount int `json:"total_count"`

	// Whether there are more logs available
	HasMore bool `json:"has_more"`
}

type OperationType string

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

type VerificationInfo struct {
	// Success indicates if verification was successful
	Success bool `json:"success"`

	// Method is the verification method used
	Method string `json:"method,omitempty"`

	// Details contains additional verification details
	Details map[string]interface{} `json:"details,omitempty"`
}

type VersionInfo struct {
	// Previous is the previous version
	Previous string `json:"previous,omitempty"`

	// Current is the current version
	Current string `json:"current,omitempty"`

	// ChangeType describes the type of version change
	ChangeType string `json:"change_type,omitempty"`
}