mirror of
https://github.com/lukaszraczylo/gohoarder.git
synced 2026-07-12 04:50:45 +00:00
e39d6a0f0d
Multi-agent audit + fix pass covering bugs, security, dead config wiring,
and missing features. All quality gates green: build/vet/test -race/govulncheck/
golangci-lint. Frontend tests 47/47.
SECURITY & CORRECTNESS
- Scanner pipeline fail-closed: cache.go scan timeout now 503 (was goto servePkg);
scanner.go all-scanners-fail saves ScanStatusError; CheckVulnerabilities blocks
on missing/error result instead of allowing.
- Scanner argv corrections: govulncheck source-mode + go.mod discovery;
npm-audit generates lockfile via npm install --package-lock-only --ignore-scripts;
pip-audit per-extension dispatch (wheel direct / sdist extract+pyproject).
- GHSA version-range filtering implemented (was always-include); url.QueryEscape
on package name.
- pypi SSRF closed via host allowlist on original_url; url.QueryEscape on
rewriteURL output.
- Path traversal: cache temp file uses os.CreateTemp; smb keyToPath sanitized;
filesystem keyToPath returns error + filepath.Abs prefix-verify.
- Goroutine leaks plugged: cache.cleanupWorker stop channel; auth.ValidationCache
Stop() with sync.Once; ws.unregister buffered with non-blocking send.
- WebSocket double-close panic fixed via sync.Once Client.closeSend().
- Race conditions: gormstore.registryCache sync.RWMutex (was concurrent map
panic); auth.LastUsedAt no longer mutated under RLock; analytics strict
lock-ordering invariant (statsMu before downloadsMu).
- Auth validator fails CLOSED on transport/unknown-status errors (was returning
true,err 'allow cache fallback').
- Credential cache hash full SHA256 (was 8-byte truncate; eliminates 2^32
collision risk).
- filesystem.fs.used incremented after successful rename (no quota inflation
race).
- gormstore aggregation events deleted in same tx as insert (no double-counting).
- gormstore.SavePackage uses Updates(map) so zero-value security flags
(RequiresAuth=false) can be cleared.
- partition_manager validates partition name regex before DROP TABLE.
- vcs/git: version regex validation rejects --option-injection; checkout uses
--detach -- separator; removed TrimPrefix(repo,'v') that corrupted vault/
vitess/vim-go.
- WebSocket CheckOrigin allowlist (was return true; CSWSH closed); same-origin
default + ServerConfig.AllowedOrigins.
- fiber CVE GO-2026-4543 patched (v2.52.10 -> v2.52.12).
FUNCTIONAL FEATURES
- API key DB persistence: APIKeyModel + migration 202604280002, full CRUD,
async LastUsedAt updates with WaitGroup-tracked goroutines drained on Close.
- Admin bootstrap via GOHOARDER_BOOTSTRAP_ADMIN_KEY env var; idempotent
(skipped when non-revoked admin already exists).
- Auth middleware factory in pkg/app: RequireAuth, RequireRole, RequirePermission,
OptionalAuth. Mounted on proxy + read APIs when Auth.Enabled=true.
DELETE /api/packages/* requires admin role. /health public for k8s probes.
- NFS storage backend: pkg/storage/nfs wraps filesystem with /proc/mounts
detection (Linux), post-write fsync, read-after-write health probe.
- WebSocket real-time pipeline: pkg/events Broadcaster interface; cache + scanner
managers emit EventPackageCached / EventPackageDownloaded / EventScanComplete;
app.go runs 30s EventStatsUpdate ticker. Frontend has full WS client (reconnect
with exponential backoff 1s->30s, 25s heartbeat, subscriber pattern), Pinia
realtime store, Dashboard live indicator + activity feed + reactive stats
override.
- TLS termination: fiber.ListenTLS when Server.TLS.Enabled.
- Pre-warming: Prewarming.Enabled flag wired (was hardcoded false); Interval,
MaxConcurrent, TopPackages plumbed.
- NetworkConfig wired (timeouts, retry, rate-limit, circuit-breaker).
- AuthConfig.BcryptCost wired.
- Security.Scanners.Static.MaxPackageSize plumbed to cache.io.LimitReader.
- Handlers.{Go,NPM,PyPI}.Enabled gates route mounting.
- Graceful shutdown: authManager.Close drains async writes.
LINT/HYGIENE
- 80 golangci-lint issues resolved: errcheck (Close/Write/RemoveAll wrapped),
gofmt, gosec G104/G306, govet shadow renames + fieldalignment reorders,
staticcheck ST1000 pkg comments + QF1003 tagged switches + QF1008 embedded
field selectors + QF1001 De Morgan's law.
BEHAVIOR CHANGES
- Scanner now fail-closed: deployments without scanner binaries
(trivy/govulncheck/npm-audit/pip-audit/grype) BLOCK packages instead of
serving unscanned. Add binaries or plan a future allow-on-scan-error flag.
- WS origin defaults to same-origin; cross-origin dashboards must set
server.allowed_origins.
- Validator no longer fails open; private packages won't serve from cache when
validation can't be performed.
- download_events retention dropped from 24h to ~5min (deleted in agg tx).
Migration 202604280001 purges pre-upgrade events.
- DELETE /api/packages/* requires admin role when auth enabled.
NEW PACKAGES
- pkg/events - Broadcaster interface
- pkg/storage/nfs - NFS-aware filesystem wrapper
DEFERRED (out of scope this pass)
- Static scanner implementation (config defines AllowedLicenses/MaxPackageSize/
BlockSuspicious but pkg/scanner/static/ does not exist).
- AuthConfig.AuditLog wiring (no audit log infra yet).
- CacheConfig.TTLOverrides passthrough (would touch cache.Config beyond
integrator scope).
166 lines
4.4 KiB
Go
166 lines
4.4 KiB
Go
// Package metrics exposes Prometheus instrumentation for cache, storage,
|
|
// scanner, and HTTP request flows.
|
|
package metrics
|
|
|
|
import (
|
|
"net/http"
|
|
|
|
"github.com/prometheus/client_golang/prometheus"
|
|
"github.com/prometheus/client_golang/prometheus/promauto"
|
|
"github.com/prometheus/client_golang/prometheus/promhttp"
|
|
)
|
|
|
|
var (
|
|
// HTTP metrics
|
|
HTTPRequestsTotal = promauto.NewCounterVec(
|
|
prometheus.CounterOpts{
|
|
Name: "gohoarder_http_requests_total",
|
|
Help: "Total number of HTTP requests",
|
|
},
|
|
[]string{"handler", "method", "status"},
|
|
)
|
|
|
|
HTTPRequestDuration = promauto.NewHistogramVec(
|
|
prometheus.HistogramOpts{
|
|
Name: "gohoarder_http_request_duration_seconds",
|
|
Help: "HTTP request duration in seconds",
|
|
Buckets: prometheus.DefBuckets,
|
|
},
|
|
[]string{"handler", "method"},
|
|
)
|
|
|
|
// Cache metrics
|
|
CacheRequests = promauto.NewCounterVec(
|
|
prometheus.CounterOpts{
|
|
Name: "gohoarder_cache_requests_total",
|
|
Help: "Total number of cache requests",
|
|
},
|
|
[]string{"status", "handler"}, // hit, miss, error
|
|
)
|
|
|
|
CacheSizeBytes = promauto.NewGaugeVec(
|
|
prometheus.GaugeOpts{
|
|
Name: "gohoarder_cache_size_bytes",
|
|
Help: "Current cache size in bytes",
|
|
},
|
|
[]string{"backend"},
|
|
)
|
|
|
|
CacheItemsTotal = promauto.NewGaugeVec(
|
|
prometheus.GaugeOpts{
|
|
Name: "gohoarder_cache_items_total",
|
|
Help: "Total number of cached items",
|
|
},
|
|
[]string{"handler"},
|
|
)
|
|
|
|
CacheEvictions = promauto.NewCounterVec(
|
|
prometheus.CounterOpts{
|
|
Name: "gohoarder_cache_evictions_total",
|
|
Help: "Total number of cache evictions",
|
|
},
|
|
[]string{"reason"}, // ttl, lru, manual
|
|
)
|
|
|
|
// Storage metrics
|
|
StorageOperations = promauto.NewCounterVec(
|
|
prometheus.CounterOpts{
|
|
Name: "gohoarder_storage_operations_total",
|
|
Help: "Total number of storage operations",
|
|
},
|
|
[]string{"backend", "operation", "status"}, // get, put, delete
|
|
)
|
|
|
|
StorageQuotaBytes = promauto.NewGaugeVec(
|
|
prometheus.GaugeOpts{
|
|
Name: "gohoarder_storage_quota_bytes",
|
|
Help: "Storage quota in bytes per project",
|
|
},
|
|
[]string{"project"},
|
|
)
|
|
|
|
// Upstream metrics
|
|
UpstreamRequests = promauto.NewCounterVec(
|
|
prometheus.CounterOpts{
|
|
Name: "gohoarder_upstream_requests_total",
|
|
Help: "Total number of upstream requests",
|
|
},
|
|
[]string{"registry", "status"},
|
|
)
|
|
|
|
UpstreamDuration = promauto.NewHistogramVec(
|
|
prometheus.HistogramOpts{
|
|
Name: "gohoarder_upstream_duration_seconds",
|
|
Help: "Upstream request duration in seconds",
|
|
Buckets: prometheus.DefBuckets,
|
|
},
|
|
[]string{"registry"},
|
|
)
|
|
|
|
// Security metrics
|
|
SecurityScans = promauto.NewCounterVec(
|
|
prometheus.CounterOpts{
|
|
Name: "gohoarder_security_scans_total",
|
|
Help: "Total number of security scans",
|
|
},
|
|
[]string{"scanner", "result"}, // clean, blocked, error
|
|
)
|
|
|
|
VulnerabilitiesFound = promauto.NewCounterVec(
|
|
prometheus.CounterOpts{
|
|
Name: "gohoarder_vulnerabilities_found_total",
|
|
Help: "Total number of vulnerabilities found",
|
|
},
|
|
[]string{"severity"}, // low, medium, high, critical
|
|
)
|
|
|
|
// Circuit breaker metrics
|
|
CircuitBreakerState = promauto.NewGaugeVec(
|
|
prometheus.GaugeOpts{
|
|
Name: "gohoarder_circuit_breaker_state",
|
|
Help: "Circuit breaker state (0=closed, 1=open, 2=half-open)",
|
|
},
|
|
[]string{"name"},
|
|
)
|
|
)
|
|
|
|
// Handler returns the Prometheus HTTP handler
|
|
func Handler() http.Handler {
|
|
return promhttp.Handler()
|
|
}
|
|
|
|
// RecordCacheHit records a cache hit
|
|
func RecordCacheHit(handler string) {
|
|
CacheRequests.WithLabelValues("hit", handler).Inc()
|
|
}
|
|
|
|
// RecordCacheMiss records a cache miss
|
|
func RecordCacheMiss(handler string) {
|
|
CacheRequests.WithLabelValues("miss", handler).Inc()
|
|
}
|
|
|
|
// UpdateCacheSize updates the cache size metric
|
|
func UpdateCacheSize(backend string, bytes int64) {
|
|
CacheSizeBytes.WithLabelValues(backend).Set(float64(bytes))
|
|
}
|
|
|
|
// RecordCacheEviction records a cache eviction
|
|
func RecordCacheEviction(reason string) {
|
|
CacheEvictions.WithLabelValues(reason).Inc()
|
|
}
|
|
|
|
// RecordStorageOperation records a storage operation
|
|
func RecordStorageOperation(backend, operation, status string) {
|
|
StorageOperations.WithLabelValues(backend, operation, status).Inc()
|
|
}
|
|
|
|
// RecordUpstreamRequest records an upstream request
|
|
func RecordUpstreamRequest(registry, status string) {
|
|
UpstreamRequests.WithLabelValues(registry, status).Inc()
|
|
}
|
|
|
|
// UpdateCircuitBreakerState updates the circuit breaker state
|
|
func UpdateCircuitBreakerState(name string, state int) {
|
|
CircuitBreakerState.WithLabelValues(name).Set(float64(state))
|
|
}
|