audit

type Action string

type ArchiveConfig struct {
	// ArchivePath is the path to store archived logs.
	ArchivePath string
	// ArchiveAfterDays is the number of days after which to archive logs.
	ArchiveAfterDays int
	// CompressArchives enables compression of archived logs.
	CompressArchives bool
}

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

type Entry struct {
	// ID is the unique identifier for this entry.
	ID uuid.UUID `json:"id" db:"id"`
	// Timestamp is when the action occurred.
	Timestamp time.Time `json:"timestamp" db:"timestamp"`
	// UserID is the user who performed the action (nil for anonymous).
	UserID *uuid.UUID `json:"user_id,omitempty" db:"user_id"`
	// Username is the username (for display purposes).
	Username string `json:"username,omitempty" db:"username"`
	// Action is the type of action performed.
	Action Action `json:"action" db:"action"`
	// ResourceType is the type of resource affected.
	ResourceType string `json:"resource_type,omitempty" db:"resource_type"`
	// ResourceID is the ID of the resource affected.
	ResourceID string `json:"resource_id,omitempty" db:"resource_id"`
	// IPAddress is the client's IP address.
	IPAddress string `json:"ip_address,omitempty" db:"ip_address"`
	// UserAgent is the client's user agent string.
	UserAgent string `json:"user_agent,omitempty" db:"user_agent"`
	// RequestID is the unique request identifier.
	RequestID string `json:"request_id,omitempty" db:"request_id"`
	// Status is the outcome of the action.
	Status Status `json:"status" db:"status"`
	// Details contains additional action-specific information.
	Details json.RawMessage `json:"details,omitempty" db:"details"`
	// OldValue contains the previous value (for updates).
	OldValue json.RawMessage `json:"old_value,omitempty" db:"old_value"`
	// NewValue contains the new value (for updates).
	NewValue json.RawMessage `json:"new_value,omitempty" db:"new_value"`
}

type ExportRequest struct {
	Format       string `query:"format"` // json or csv
	UserID       string `query:"user_id"`
	Action       string `query:"action"`
	ResourceType string `query:"resource_type"`
	ResourceID   string `query:"resource_id"`
	Status       string `query:"status"`
	StartTime    string `query:"start_time"`
	EndTime      string `query:"end_time"`
	IPAddress    string `query:"ip_address"`
}

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

type ListRequest struct {
	UserID       string `query:"user_id"`
	Action       string `query:"action"`
	ResourceType string `query:"resource_type"`
	ResourceID   string `query:"resource_id"`
	Status       string `query:"status"`
	StartTime    string `query:"start_time"`
	EndTime      string `query:"end_time"`
	IPAddress    string `query:"ip_address"`
	Page         int    `query:"page"`
	PageSize     int    `query:"page_size"`
	SortBy       string `query:"sort_by"`
	SortDir      string `query:"sort_dir"`
}

type Logger interface {
	// Log records an audit entry.
	Log(ctx context.Context, entry *Entry) error
	// Query retrieves audit entries based on parameters.
	Query(ctx context.Context, params *QueryParams) (*QueryResult, error)
	// GetByID retrieves a single audit entry.
	GetByID(ctx context.Context, id uuid.UUID) (*Entry, error)
	// Close closes the logger and flushes any pending entries.
	Close() error
}

type LoggerConfig struct {
	// BatchSize is the number of entries to batch before writing.
	BatchSize int
	// FlushInterval is how often to flush the buffer.
	FlushInterval time.Duration
	// BufferSize is the size of the entry buffer.
	BufferSize int
}

type MiddlewareConfig struct {
	// Logger is the audit logger to use.
	Logger Logger
	// SkipPaths are paths to skip auditing.
	SkipPaths []string
	// LogRequestBody enables logging of request bodies.
	LogRequestBody bool
	// LogResponseBody enables logging of response bodies.
	LogResponseBody bool
	// MaxBodySize is the maximum body size to log.
	MaxBodySize int
	// GetUserID extracts the user ID from the request context.
	GetUserID func(c echo.Context) *uuid.UUID
	// GetUsername extracts the username from the request context.
	GetUsername func(c echo.Context) string
}

type QueryParams struct {
	// UserID filters by user.
	UserID *uuid.UUID
	// Action filters by action type.
	Action *Action
	// ResourceType filters by resource type.
	ResourceType string
	// ResourceID filters by resource ID.
	ResourceID string
	// Status filters by status.
	Status *Status
	// StartTime filters entries after this time.
	StartTime *time.Time
	// EndTime filters entries before this time.
	EndTime *time.Time
	// IPAddress filters by IP address.
	IPAddress string
	// Page is the page number (1-indexed).
	Page int
	// PageSize is the number of entries per page.
	PageSize int
	// SortBy is the field to sort by.
	SortBy string
	// SortDir is the sort direction (asc/desc).
	SortDir string
}

type QueryResult struct {
	Entries    []*Entry `json:"entries"`
	Total      int64    `json:"total"`
	Page       int      `json:"page"`
	PageSize   int      `json:"page_size"`
	TotalPages int      `json:"total_pages"`
}

type RetentionConfig struct {
	// RetentionDays is the number of days to keep audit logs.
	RetentionDays int
	// CleanupInterval is how often to run the cleanup job.
	CleanupInterval time.Duration
	// BatchSize is the number of records to delete per batch.
	BatchSize int
}

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

type RetentionStats struct {
	TotalCount    int64      `json:"total_count"`
	ExpiredCount  int64      `json:"expired_count"`
	OldestEntry   *time.Time `json:"oldest_entry,omitempty"`
	NewestEntry   *time.Time `json:"newest_entry,omitempty"`
	RetentionDays int        `json:"retention_days"`
	CutoffDate    time.Time  `json:"cutoff_date"`
}

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

type Status string