mirror of
https://github.com/lukaszraczylo/gohoarder.git
synced 2026-07-13 04:57:11 +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).
100 lines
3.1 KiB
Go
100 lines
3.1 KiB
Go
package auth
|
|
|
|
import (
|
|
"context"
|
|
stderrors "errors"
|
|
"os"
|
|
"time"
|
|
|
|
"github.com/lukaszraczylo/gohoarder/pkg/errors"
|
|
"github.com/lukaszraczylo/gohoarder/pkg/metadata"
|
|
"github.com/rs/zerolog/log"
|
|
"golang.org/x/crypto/bcrypt"
|
|
)
|
|
|
|
// BootstrapAdminEnvVar is the env var consulted by BootstrapAdminFromEnv.
|
|
// Exported so callers and operators can reference a single source of truth.
|
|
const BootstrapAdminEnvVar = "GOHOARDER_BOOTSTRAP_ADMIN_KEY"
|
|
|
|
// bootstrapProject is the marker project assigned to the env-bootstrapped
|
|
// admin key. Callers can list keys filtered by this project to inventory
|
|
// bootstrap-origin credentials.
|
|
const bootstrapProject = "bootstrap"
|
|
|
|
// BootstrapAdminFromEnv creates an initial admin API key from the
|
|
// GOHOARDER_BOOTSTRAP_ADMIN_KEY environment variable when no admin key
|
|
// already exists in the store.
|
|
//
|
|
// Behaviour matrix:
|
|
// - env unset/empty -> no-op, nil
|
|
// - store nil -> no-op, nil (caller must provide a store)
|
|
// - store has any non-revoked
|
|
// admin key -> log and return nil (idempotent)
|
|
// - else -> bcrypt-hash env value, persist as admin
|
|
//
|
|
// The env var holds the RAW key the operator wants to use; we hash it with
|
|
// the configured bcrypt cost (default DefaultCost) before storing. The
|
|
// operator is expected to clear the env var after first successful boot.
|
|
func BootstrapAdminFromEnv(ctx context.Context, store metadata.MetadataStore, cfg Config) error {
|
|
rawKey := os.Getenv(BootstrapAdminEnvVar)
|
|
if rawKey == "" {
|
|
return nil
|
|
}
|
|
if store == nil {
|
|
log.Warn().Msg("Bootstrap admin key requested but no metadata store configured; skipping")
|
|
return nil
|
|
}
|
|
|
|
cost := cfg.BcryptCost
|
|
if cost == 0 {
|
|
cost = bcrypt.DefaultCost
|
|
}
|
|
|
|
// Idempotency: if any non-revoked admin already exists, skip.
|
|
existing, err := store.ListAPIKeys(ctx)
|
|
if err != nil {
|
|
if stderrors.Is(err, metadata.ErrNotImplemented) {
|
|
log.Warn().Msg("Bootstrap admin: store does not implement API key persistence; skipping")
|
|
return nil
|
|
}
|
|
return errors.Wrap(err, errors.ErrCodeStorageFailure, "bootstrap admin: failed to list existing keys")
|
|
}
|
|
|
|
for _, k := range existing {
|
|
if k == nil || k.Revoked {
|
|
continue
|
|
}
|
|
if k.Role == storedRoleAdmin {
|
|
log.Info().Msg("Bootstrap admin skipped — admin key already exists")
|
|
return nil
|
|
}
|
|
}
|
|
|
|
hashed, err := bcrypt.GenerateFromPassword([]byte(rawKey), cost)
|
|
if err != nil {
|
|
return errors.Wrap(err, errors.ErrCodeInternalServer, "bootstrap admin: failed to hash key")
|
|
}
|
|
|
|
now := time.Now()
|
|
key := &metadata.APIKey{
|
|
ID: generateID(),
|
|
KeyHash: string(hashed),
|
|
Project: bootstrapProject,
|
|
Role: storedRoleAdmin,
|
|
CreatedAt: now,
|
|
Revoked: false,
|
|
}
|
|
|
|
if err := store.SaveAPIKey(ctx, key); err != nil {
|
|
return errors.Wrap(err, errors.ErrCodeStorageFailure, "bootstrap admin: failed to save key")
|
|
}
|
|
|
|
// SECURITY: never log the raw key or its hash.
|
|
log.Info().
|
|
Str("key_id", key.ID).
|
|
Str("project", bootstrapProject).
|
|
Msg("Bootstrap admin created — delete " + BootstrapAdminEnvVar + " after first run")
|
|
|
|
return nil
|
|
}
|