Files
M AlveeandGitHub 47606f6238 distributed job framework (#557)
* feat: add DistJobType enum and sync distjob status types

Adds an iota-based DistJobType enum (mirrors the HealingDriveReason/
OfflineReason pattern already used in heal-commands.go) so distributed
job identity is a typed wire value instead of a bare string, per review
feedback on the eos distributed-job framework PR.

Also syncs DistJobLeaderStatus/DistJobNodeStatus field shapes to match
the current server-side JSON response (JobID/JobType replace JobName;
drops the unused Generation/AssignedSets/top-level CurrentBucket
fields that were never populated by the server).

* fix: bump vulnerable prometheus dep

- Add msgp generation (//msgp:tag json + //go:generate msgp) for
  DistJobLeaderStatus/DistJobNodeStatus, matching the pattern used by
  every other *-commands.go file in this package.
- Add unit tests for ListDistJobStatuses (success path, job-filter
  query param, DistJobTypeUnknown no-filter case, non-200 error path).
- Bump github.com/prometheus/prometheus v0.304.1 -> v0.312.0 to clear
  3 of the 4 govulncheck findings on this branch (GO-2026-5710,
  GO-2026-5381, GO-2026-5264, all fixed by that version). The 4th,
  GO-2026-5662, has no fix published upstream yet and also currently
  fails govulncheck on main independent of this branch.

* fix: pin go:generate directives to go.mod tool versions

Consolidate distjob-commands.go's separate //msgp:tag json directive
into the //go:generate msgp -d "tag json" flag, matching net-stats.go's
style (review feedback, PR #557).

Change every //go:generate msgp / //go:generate stringer directive
(31 occurrences, 30 files) to //go:generate go tool msgp / go tool
stringer, so generation always resolves the exact version pinned in
go.mod's tool block instead of whatever binary happens to be on PATH.
This was the root cause of the earlier stringer-drift CI failure.
Drop the now-unnecessary `go install -v tool` step from lint.yml.
2026-07-01 05:10:23 -04:00

465 lines
19 KiB
Go

// Copyright (c) 2015-2025 MinIO, Inc.
//
// This file is part of MinIO Object Storage stack
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
package log
import (
"fmt"
"strings"
"time"
)
var sensitiveFields = []string{"password", "secret", "secretkey", "accesskey", "token"}
func redactIfSensitive(key, value string) string {
lowerKey := strings.ToLower(key)
for _, field := range sensitiveFields {
if strings.Contains(lowerKey, field) {
return "***REDACTED***"
}
}
return value
}
//msgp:tag json
//go:generate go tool msgp -d clearomitted -d "timezone utc" $GOFILE
// AuditCategory represents the category of audit event
//
//msgp:shim AuditCategory as:string
type AuditCategory string
const (
AuditCategoryConfig AuditCategory = "config"
AuditCategoryUser AuditCategory = "user"
AuditCategoryServiceAccount AuditCategory = "service-account"
AuditCategoryPolicy AuditCategory = "policy"
AuditCategoryGroup AuditCategory = "group"
AuditCategoryBucket AuditCategory = "bucket"
AuditCategoryLifecycle AuditCategory = "lifecycle"
AuditCategoryReplication AuditCategory = "replication"
AuditCategoryNotification AuditCategory = "notification"
AuditCategoryEncryption AuditCategory = "encryption"
AuditCategoryCORS AuditCategory = "cors"
AuditCategoryVersioning AuditCategory = "versioning"
AuditCategoryService AuditCategory = "service"
AuditCategoryKMS AuditCategory = "kms"
AuditCategorySiteRepl AuditCategory = "site-replication"
AuditCategoryPool AuditCategory = "pool"
AuditCategoryIDP AuditCategory = "idp"
AuditCategoryLogRecorder AuditCategory = "log-recorder"
AuditCategoryHeal AuditCategory = "heal"
AuditCategoryBatch AuditCategory = "batch"
)
// AuditAction represents the type of action performed.
//
// Deprecated: no longer set by the audit recorder. Kept for
// wire-format compatibility.
//
//msgp:shim AuditAction as:string
type AuditAction string
// Deprecated: no longer set by the audit recorder. Kept for
// wire-format compatibility.
const (
AuditActionCreate AuditAction = "create"
AuditActionUpdate AuditAction = "update"
AuditActionDelete AuditAction = "delete"
AuditActionEnable AuditAction = "enable"
AuditActionDisable AuditAction = "disable"
AuditActionSet AuditAction = "set"
AuditActionReset AuditAction = "reset"
AuditActionRestore AuditAction = "restore"
AuditActionClear AuditAction = "clear"
AuditActionStart AuditAction = "start"
AuditActionStop AuditAction = "stop"
AuditActionRestart AuditAction = "restart"
AuditActionAttach AuditAction = "attach"
AuditActionDetach AuditAction = "detach"
)
// AuditDetails is a union type containing category-specific audit details.
// Only one field should be populated based on the audit event category.
//
// Deprecated: use Audit.Metadata.
type AuditDetails struct {
Config *ConfigAuditDetails `json:"config,omitempty"`
User *UserAuditDetails `json:"user,omitempty"`
ServiceAccount *ServiceAccountAuditDetails `json:"serviceAccount,omitempty"`
Policy *PolicyAuditDetails `json:"policy,omitempty"`
Group *GroupAuditDetails `json:"group,omitempty"`
BucketConfig *BucketConfigAuditDetails `json:"bucketConfig,omitempty"`
BucketQuota *BucketQuotaAuditDetails `json:"bucketQuota,omitempty"`
BucketQOS *BucketQOSAuditDetails `json:"bucketQOS,omitempty"`
BucketInventory *BucketInventoryAuditDetails `json:"bucketInventory,omitempty"`
Tier *TierAuditDetails `json:"tier,omitempty"`
Service *ServiceAuditDetails `json:"service,omitempty"`
KMS *KMSAuditDetails `json:"kms,omitempty"`
Pool *PoolAuditDetails `json:"pool,omitempty"`
SiteRepl *SiteReplicationAuditDetails `json:"siteRepl,omitempty"`
IDP *IDPAuditDetails `json:"idp,omitempty"`
Recorder *RecorderAuditDetails `json:"recorder,omitempty"`
Heal *HealAuditDetails `json:"heal,omitempty"`
Batch *BatchAuditDetails `json:"batch,omitempty"`
}
// Audit represents the user triggered audit events.
// It captures administrative operations performed on the MinIO cluster with contextual metadata.
type Audit struct {
Version string `json:"version"`
Time time.Time `json:"time"`
Node string `json:"node,omitempty"`
APIName string `json:"apiName,omitempty"`
Category AuditCategory `json:"category,omitempty"`
Message string `json:"message,omitempty"`
Metadata map[string]any `json:"metadata,omitempty"`
Bucket string `json:"bucket,omitempty"`
Tags map[string]string `json:"tags,omitempty"`
RequestID string `json:"requestID,omitempty"`
ReqClaims map[string]interface{} `json:"requestClaims,omitempty"`
SourceHost string `json:"sourceHost,omitempty"`
AccessKey string `json:"accessKey,omitempty"`
ParentUser string `json:"parentUser,omitempty"`
// Deprecated: use Audit.Message.
Action AuditAction `json:"action,omitempty"`
// Deprecated: use Audit.Metadata.
Details *AuditDetails `json:"details,omitempty"`
}
// ConfigAuditDetails captures config mutation details.
// It tracks changes to server configuration settings including subsystem, target, key, and value changes.
//
// Deprecated: use Audit.Metadata.
type ConfigAuditDetails struct {
SubSystem string `json:"subSystem,omitempty"`
Target string `json:"target,omitempty"`
Key string `json:"key,omitempty"`
OldValue string `json:"oldValue,omitempty"`
NewValue string `json:"newValue,omitempty"`
}
// Redact redacts sensitive fields in ConfigAuditDetails
func (c *ConfigAuditDetails) Redact() {
c.OldValue = redactIfSensitive(c.Key, c.OldValue)
c.NewValue = redactIfSensitive(c.Key, c.NewValue)
}
// UserAuditDetails captures user mutation details.
// It tracks changes to user accounts including status, credentials, policies, and group memberships.
//
// Deprecated: use Audit.Metadata.
type UserAuditDetails struct {
UserName string `json:"userName"`
UserType string `json:"userType,omitempty"`
Field string `json:"field,omitempty"`
OldValue string `json:"oldValue,omitempty"`
NewValue string `json:"newValue,omitempty"`
OldStatus string `json:"oldStatus,omitempty"`
NewStatus string `json:"newStatus,omitempty"`
Policies []string `json:"policies,omitempty"`
Groups []string `json:"groups,omitempty"`
}
// Redact redacts sensitive fields in UserAuditDetails
func (u *UserAuditDetails) Redact() {
u.OldValue = redactIfSensitive(u.Field, u.OldValue)
u.NewValue = redactIfSensitive(u.Field, u.NewValue)
}
// ServiceAccountAuditDetails captures service account details.
// It tracks changes to service accounts including parent user, policies, expiration, and secret key updates.
//
// Deprecated: use Audit.Metadata.
type ServiceAccountAuditDetails struct {
AccountName string `json:"accountName"`
ParentUser string `json:"parentUser,omitempty"`
Policies []string `json:"policies,omitempty"`
Expiration time.Time `json:"expiration,omitempty"`
UpdatedName string `json:"updatedName,omitempty"`
UpdatedStatus string `json:"updatedStatus,omitempty"`
UpdatedPolicy bool `json:"updatedPolicy,omitempty"`
UpdatedExpiry bool `json:"updatedExpiry,omitempty"`
UpdatedSecretKey bool `json:"updatedSecretKey,omitempty"`
}
// Redact redacts sensitive fields in ServiceAccountAuditDetails
func (s *ServiceAccountAuditDetails) Redact() {}
// PolicyAuditDetails captures policy mutation details.
// It tracks IAM policy changes including policy content, attachments, and detachments for users or groups.
//
// Deprecated: use Audit.Metadata.
type PolicyAuditDetails struct {
PolicyName string `json:"policyName"`
OldPolicy string `json:"oldPolicy,omitempty"`
NewPolicy string `json:"newPolicy,omitempty"`
Operation string `json:"operation,omitempty"`
User string `json:"user,omitempty"`
Group string `json:"group,omitempty"`
PoliciesAttached []string `json:"policiesAttached,omitempty"`
PoliciesDetached []string `json:"policiesDetached,omitempty"`
}
// Redact redacts sensitive fields in PolicyAuditDetails
func (p *PolicyAuditDetails) Redact() {}
// GroupAuditDetails captures group mutation details.
// It tracks changes to IAM groups including member additions, removals, and status changes.
//
// Deprecated: use Audit.Metadata.
type GroupAuditDetails struct {
GroupName string `json:"groupName"`
MembersAdded []string `json:"membersAdded,omitempty"`
MembersRemoved []string `json:"membersRemoved,omitempty"`
OldStatus string `json:"oldStatus,omitempty"`
NewStatus string `json:"newStatus,omitempty"`
}
// Redact redacts sensitive fields in GroupAuditDetails
func (g *GroupAuditDetails) Redact() {}
// BucketConfigAuditDetails captures bucket configuration changes.
// It tracks modifications to bucket settings like lifecycle, replication, encryption, versioning, and tags.
//
// Deprecated: use Audit.Metadata.
type BucketConfigAuditDetails struct {
BucketName string `json:"bucketName"`
ConfigType string `json:"configType,omitempty"`
OldConfig string `json:"oldConfig,omitempty"`
NewConfig string `json:"newConfig,omitempty"`
TargetBucket string `json:"targetBucket,omitempty"`
TagKeys []string `json:"tagKeys,omitempty"`
TagCount int `json:"tagCount,omitempty"`
}
// Redact redacts sensitive fields in BucketConfigAuditDetails
func (b *BucketConfigAuditDetails) Redact() {}
// ServiceAuditDetails captures service operation details.
// It tracks MinIO service operations like restart, update, IAM import/export, and cluster management actions.
//
// Deprecated: use Audit.Metadata.
type ServiceAuditDetails struct {
ServiceName string `json:"serviceName,omitempty"`
Operation string `json:"operation,omitempty"`
Status string `json:"status,omitempty"`
Legacy bool `json:"legacy,omitempty"`
IAMImport *IAMImportDetails `json:"iamImport,omitempty"`
}
// Redact redacts sensitive fields in ServiceAuditDetails
func (s *ServiceAuditDetails) Redact() {}
// IAMImportDetails captures IAM import operation counts.
// It tracks the number of users, policies, groups, and service accounts added, removed, skipped, or failed during IAM imports.
//
// Deprecated: use Audit.Metadata.
type IAMImportDetails struct {
UsersAdded int `json:"usersAdded,omitempty"`
PoliciesAdded int `json:"policiesAdded,omitempty"`
GroupsAdded int `json:"groupsAdded,omitempty"`
SvcAcctsAdded int `json:"svcAcctsAdded,omitempty"`
UsersRemoved int `json:"usersRemoved,omitempty"`
PoliciesRemoved int `json:"policiesRemoved,omitempty"`
GroupsRemoved int `json:"groupsRemoved,omitempty"`
SvcAcctsRemoved int `json:"svcAcctsRemoved,omitempty"`
UsersSkipped int `json:"usersSkipped,omitempty"`
PoliciesSkipped int `json:"policiesSkipped,omitempty"`
GroupsSkipped int `json:"groupsSkipped,omitempty"`
SvcAcctsSkipped int `json:"svcAcctsSkipped,omitempty"`
UsersFailed int `json:"usersFailed,omitempty"`
PoliciesFailed int `json:"policiesFailed,omitempty"`
GroupsFailed int `json:"groupsFailed,omitempty"`
SvcAcctsFailed int `json:"svcAcctsFailed,omitempty"`
}
// KMSAuditDetails captures KMS operation details.
// It tracks Key Management Service operations like key creation, deletion, and encryption/decryption activities.
//
// Deprecated: use Audit.Metadata.
type KMSAuditDetails struct {
KeyID string `json:"keyId,omitempty"`
Operation string `json:"operation,omitempty"`
}
// Redact redacts sensitive fields in KMSAuditDetails
func (k *KMSAuditDetails) Redact() {}
// PoolAuditDetails captures pool operation details.
// It tracks storage pool operations like expansion, decommission, and rebalancing across multiple endpoints.
//
// Deprecated: use Audit.Metadata.
type PoolAuditDetails struct {
PoolIndex int `json:"poolIndex,omitempty"`
Endpoints []string `json:"endpoints,omitempty"`
Operation string `json:"operation,omitempty"`
}
// Redact redacts sensitive fields in PoolAuditDetails
func (p *PoolAuditDetails) Redact() {}
// SiteReplicationAuditDetails captures site replication details.
// It tracks multi-site replication operations including site additions, removals, and replication status changes.
//
// Deprecated: use Audit.Metadata.
type SiteReplicationAuditDetails struct {
SiteName string `json:"siteName,omitempty"`
Endpoint string `json:"endpoint,omitempty"`
Operation string `json:"operation,omitempty"`
Sites []string `json:"sites,omitempty"`
}
// Redact redacts sensitive fields in SiteReplicationAuditDetails
func (s *SiteReplicationAuditDetails) Redact() {}
// IDPAuditDetails captures identity provider configuration details.
// It tracks changes to IDP configurations like LDAP, OpenID, or SAML settings including credentials and endpoints.
//
// Deprecated: use Audit.Metadata.
type IDPAuditDetails struct {
IDPName string `json:"idpName,omitempty"`
IDPType string `json:"idpType,omitempty"`
ConfigKey string `json:"configKey,omitempty"`
OldValue string `json:"oldValue,omitempty"`
NewValue string `json:"newValue,omitempty"`
}
// Redact redacts sensitive fields in IDPAuditDetails
func (i *IDPAuditDetails) Redact() {
i.OldValue = redactIfSensitive(i.ConfigKey, i.OldValue)
i.NewValue = redactIfSensitive(i.ConfigKey, i.NewValue)
}
// RecorderAuditDetails captures log recorder configuration details.
// It tracks changes to audit/error log recorder settings including enable status, limits, flush intervals, and batch sizes.
//
// Deprecated: use Audit.Metadata.
type RecorderAuditDetails struct {
LogType string `json:"logType,omitempty"`
OldEnabled bool `json:"oldEnabled,omitempty"`
NewEnabled bool `json:"newEnabled,omitempty"`
OldLimit string `json:"oldLimit,omitempty"`
NewLimit string `json:"newLimit,omitempty"`
OldFlushCount int `json:"oldFlushCount,omitempty"`
NewFlushCount int `json:"newFlushCount,omitempty"`
OldFlushInterval string `json:"oldFlushInterval,omitempty"`
NewFlushInterval string `json:"newFlushInterval,omitempty"`
}
// Redact redacts sensitive fields in RecorderAuditDetails
func (r *RecorderAuditDetails) Redact() {}
// HealAuditDetails captures heal operation details.
// It tracks data healing operations that scan and repair inconsistent or missing objects in buckets.
//
// Deprecated: use Audit.Metadata.
type HealAuditDetails struct {
Operation string `json:"operation,omitempty"`
Bucket string `json:"bucket,omitempty"`
Prefix string `json:"prefix,omitempty"`
}
// Redact redacts sensitive fields in HealAuditDetails
func (h *HealAuditDetails) Redact() {}
// BatchAuditDetails captures batch job operation details.
// It tracks batch operations like replication jobs, key rotation, and object expiration tasks.
//
// Deprecated: use Audit.Metadata.
type BatchAuditDetails struct {
JobID string `json:"jobID,omitempty"`
JobType string `json:"jobType,omitempty"`
User string `json:"user,omitempty"`
}
// Redact redacts sensitive fields in BatchAuditDetails
func (b *BatchAuditDetails) Redact() {}
// BucketQuotaAuditDetails captures bucket quota configuration changes.
// It tracks changes to bucket storage quotas including size limits and quota type (hard/FIFO).
//
// Deprecated: use Audit.Metadata.
type BucketQuotaAuditDetails struct {
BucketName string `json:"bucketName"`
QuotaSize uint64 `json:"quotaSize,omitempty"`
QuotaType string `json:"quotaType,omitempty"`
}
// Redact redacts sensitive fields in BucketQuotaAuditDetails
func (q *BucketQuotaAuditDetails) Redact() {}
// BucketQOSAuditDetails captures bucket QoS configuration changes.
// It tracks Quality of Service settings for buckets including rate limits, burst sizes, and priority rules for API operations.
//
// Deprecated: use Audit.Metadata.
type BucketQOSAuditDetails struct {
BucketName string `json:"bucketName"`
Enabled bool `json:"enabled"`
Rules []QOSRuleDetail `json:"rules,omitempty"`
}
// QOSRuleDetail captures details of a single QoS rule.
// Each rule defines rate limiting for specific object prefixes or API operations with priority levels and burst capacities.
//
// Deprecated: use Audit.Metadata.
type QOSRuleDetail struct {
ID string `json:"id,omitempty"`
Label string `json:"label,omitempty"`
Priority int `json:"priority,omitempty"`
ObjectPrefix string `json:"objectPrefix,omitempty"`
API string `json:"api,omitempty"`
Rate int64 `json:"rate,omitempty"`
Burst int64 `json:"burst,omitempty"`
LimitType string `json:"limitType,omitempty"`
}
// Redact redacts sensitive fields in BucketQOSAuditDetails
func (q *BucketQOSAuditDetails) Redact() {}
// BucketInventoryAuditDetails captures bucket inventory configuration changes.
// It tracks bucket inventory report settings including destination bucket, schedule, and inventory configuration IDs.
//
// Deprecated: use Audit.Metadata.
type BucketInventoryAuditDetails struct {
BucketName string `json:"bucketName"`
InventoryID string `json:"inventoryID,omitempty"`
DestinationBucket string `json:"destinationBucket,omitempty"`
Schedule string `json:"schedule,omitempty"`
}
// Redact redacts sensitive fields in BucketInventoryAuditDetails
func (i *BucketInventoryAuditDetails) Redact() {}
// TierAuditDetails captures tier configuration changes.
// It tracks remote tier configurations for lifecycle transitions including S3, Azure, GCS, and MinIO tiers.
//
// Deprecated: use Audit.Metadata.
type TierAuditDetails struct {
TierName string `json:"tierName"`
TierType string `json:"tierType,omitempty"`
}
// Redact redacts sensitive fields in TierAuditDetails
func (t *TierAuditDetails) Redact() {}
// String returns a simple string representation for Audit (required by eos LogEntry interface)
func (a Audit) String() string {
return fmt.Sprintf("audit: category=%s api=%s message=%s", a.Category, a.APIName, a.Message)
}