Files
edgeguard-native/internal/services/setup/setup.go
Debian 35b7308ce2 feat: umfangreiches UI+API-Polish (v1.1.36–1.1.42)
Backend:
- Audit-Log: Search-Endpoint mit ILIKE-Filter (actor/action/subject/date)
- NTP: /ntp/status via chronyc tracking (Stratum, Offset, Quelle)
- System: /service-restart mit Allowlist (haproxy/squid/unbound/chrony/scheduler)
- Domain-Response-Headers + Rate-Limit (Migration 0024)
- Join-Tokens (Migration 0025), Cluster-mTLS, Aggregator-Fan-Out
- apt-Service für Update-Banner (apt-get update + Versionsprüfung)
- Backup-Retry mit exponential backoff (retry_apt 3×)
- publish.sh fail-fast + cleanup-old.sh (max 10 Versionen)

Frontend:
- Audit-Log-Page (/audit) mit Filter + Pagination
- ErrorBoundary an React-Root + Vite build-target festgenagelt (iOS 15+)
- Storage-Schema-Stamp: auto-wipe bei Versions-Mismatch (blank-page-Fix)
- EmptyState-Komponente überall ausgerollt
- SSL: Aggregate-Karte (total/expiring/expired/errors)
- Backups: Aggregate-Karte (letzter Backup/Größe/Fehlschläge 24h) + Backup-Now
- NTP: Sync-Status-Karte (chronyc tracking live)
- Domains: Backend-UP/DOWN-Chip aus HAProxy-Stats
- Backends: HAProxy-Status-Spalte (UP/DEGRADED/DOWN)
- Settings: Service-Neustart-Karte (haproxy/squid/unbound/chrony/scheduler)
- Settings: Upgrade-Status-Card, Wartungsmodus, Auto-Update, Retention
- Dashboard: Recent-Alerts, Cluster-Health, License-Chip, Onboarding-Hint
- System-Regeln im Firewall als eigener Tab

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-19 16:18:41 +02:00

305 lines
9.5 KiB
Go

// Package setup stores the one-time first-boot configuration of an
// EdgeGuard node. State lives in setup.json inside the data dir
// (default /var/lib/edgeguard). An incomplete or missing state means
// the API is in "setup mode" and gates non-setup routes.
//
// The cluster-aware version (Phase 3) moves this to ha_nodes /
// system_settings in PostgreSQL; the on-disk file remains the
// first-node bootstrap record so the seed peer has somewhere to
// write before PG holds an admin row.
//
// Pattern 1:1 nach mail-gateway/internal/services/setup/.
package setup
import (
"encoding/json"
"errors"
"fmt"
"net/mail"
"os"
"path/filepath"
"strings"
"time"
"golang.org/x/crypto/bcrypt"
)
const (
DefaultDir = "/var/lib/edgeguard"
stateFile = "setup.json"
adminPwCost = 12
)
type State struct {
AdminEmail string `json:"admin_email"`
AdminPasswordHash string `json:"admin_password_hash"`
FQDN string `json:"fqdn"`
ACMEEmail string `json:"acme_email"`
LicenseKey string `json:"license_key,omitempty"`
Completed bool `json:"completed"`
CompletedAt *time.Time `json:"completed_at,omitempty"`
// MaintenanceMode (whole-box): wenn true rendert HAProxy auf
// :443 nur einen 503-Block für ALLE Customer-Domains. Mgmt-UI
// auf :3443 bleibt unverändert. MaintenanceMessage landet im
// Response-Body.
MaintenanceMode bool `json:"maintenance_mode"`
MaintenanceMessage string `json:"maintenance_message,omitempty"`
// BackupRetentionKeep: wie viele scheduled Backups behalten
// werden. 0 = Default (backup.DefaultKeepN=14). Operator kann den
// Wert in den Settings hochsetzen wenn er längere History will
// und genug Disk hat.
BackupRetentionKeep int `json:"backup_retention_keep,omitempty"`
// AuditRetentionDays: nach wie vielen Tagen audit_log-Rows
// gelöscht werden. 0 = Default (90). Operator kann erhöhen für
// Compliance (z. B. SOX = 7 Jahre = 2555) oder reduzieren falls
// /var-Disk-Druck.
AuditRetentionDays int `json:"audit_retention_days,omitempty"`
}
// Request is the JSON body POST /api/v1/setup/complete accepts.
// AdminPassword is plaintext on the wire; the service hashes it
// before persisting.
type Request struct {
AdminEmail string `json:"admin_email" binding:"required,email"`
AdminPassword string `json:"admin_password" binding:"required,min=12"`
FQDN string `json:"fqdn" binding:"required"`
ACMEEmail string `json:"acme_email" binding:"required,email"`
LicenseKey string `json:"license_key,omitempty"`
}
type Store struct {
Dir string
}
func NewStore(dir string) *Store { return &Store{Dir: dir} }
func (s *Store) Path() string { return filepath.Join(s.Dir, stateFile) }
// Load returns the current state. Missing file = zero value with
// Completed=false (the "never set up" case), no error.
func (s *Store) Load() (*State, error) {
data, err := os.ReadFile(s.Path())
if err != nil {
if os.IsNotExist(err) {
return &State{}, nil
}
return nil, err
}
var st State
if err := json.Unmarshal(data, &st); err != nil {
return nil, fmt.Errorf("parse setup state: %w", err)
}
return &st, nil
}
// Save writes the state atomically (write-tmp + rename). 0o600 because
// it carries the bcrypt admin-password hash.
func (s *Store) Save(st *State) error {
if err := os.MkdirAll(s.Dir, 0o700); err != nil {
return err
}
data, err := json.MarshalIndent(st, "", " ")
if err != nil {
return err
}
tmp := s.Path() + ".tmp"
if err := os.WriteFile(tmp, data, 0o600); err != nil {
return err
}
return os.Rename(tmp, s.Path())
}
// Complete validates the request, hashes the password, persists. Re-
// running with the same admin email overwrites the password (admin-
// recovery path); a different email after completion is rejected to
// prevent silent takeover.
func (s *Store) Complete(req Request) (*State, error) {
if err := validate(req); err != nil {
return nil, err
}
prev, err := s.Load()
if err != nil {
return nil, err
}
if prev.Completed && prev.AdminEmail != "" &&
!strings.EqualFold(prev.AdminEmail, req.AdminEmail) {
return nil, errors.New("setup already completed under a different admin email")
}
hash, err := bcrypt.GenerateFromPassword([]byte(req.AdminPassword), adminPwCost)
if err != nil {
return nil, fmt.Errorf("hash admin password: %w", err)
}
now := time.Now().UTC()
st := &State{
AdminEmail: strings.ToLower(strings.TrimSpace(req.AdminEmail)),
AdminPasswordHash: string(hash),
FQDN: strings.TrimSpace(req.FQDN),
ACMEEmail: strings.ToLower(strings.TrimSpace(req.ACMEEmail)),
LicenseKey: strings.TrimSpace(req.LicenseKey),
Completed: true,
CompletedAt: &now,
}
if err := s.Save(st); err != nil {
return nil, err
}
return st, nil
}
// VerifyAdminPassword does constant-time bcrypt comparison.
func (st *State) VerifyAdminPassword(plaintext string) bool {
return bcrypt.CompareHashAndPassword([]byte(st.AdminPasswordHash), []byte(plaintext)) == nil
}
// SetBackupRetention setzt die Anzahl Backups die scheduled-Run nach
// jedem Lauf behält. 0 = Default. Range 1-365 — alles drüber ist
// wahrscheinlich ein Tippfehler.
func (s *Store) SetBackupRetention(keep int) error {
if keep < 0 || keep > 365 {
return errors.New("backup_retention_keep must be 0 (default) or 1..365")
}
prev, err := s.Load()
if err != nil {
return err
}
if prev == nil {
return errors.New("setup not completed — cannot edit backup retention before initial setup")
}
prev.BackupRetentionKeep = keep
return s.Save(prev)
}
// SetAuditRetention setzt die Tage, nach denen audit_log-Rows gelöscht
// werden. 0 = Default (90). Range 1-3650 (10 Jahre als Cap, reicht
// für SOX 7y mit etwas Puffer). Setzt der Operator auf einen sehr
// hohen Wert, muss er an die Disk-Auswirkung denken.
func (s *Store) SetAuditRetention(days int) error {
if days < 0 || days > 3650 {
return errors.New("audit_retention_days must be 0 (default) or 1..3650")
}
prev, err := s.Load()
if err != nil {
return err
}
if prev == nil {
return errors.New("setup not completed — cannot edit audit retention before initial setup")
}
prev.AuditRetentionDays = days
return s.Save(prev)
}
// SetContactEmails aktualisiert AdminEmail + ACMEEmail. Beide werden
// gegen mail.ParseAddress validiert. Lower-case + trim wie beim Setup-
// Wizard, damit Login-Vergleich (EqualFold) konsistent bleibt.
//
// Wirkung:
// * AdminEmail: nur das Login-Anzeigeformat ändert sich; Sessions
// bleiben aktiv (Cookie referenziert den alten Actor-String — auf
// dem nächsten Login ist der neue Wert wirksam).
// * ACMEEmail: nächster certrenewer-Lauf nutzt die neue Email als
// Account-Contact bei Let's Encrypt. Bestehende Certs unverändert.
func (s *Store) SetContactEmails(adminEmail, acmeEmail string) error {
adminEmail = strings.ToLower(strings.TrimSpace(adminEmail))
acmeEmail = strings.ToLower(strings.TrimSpace(acmeEmail))
if _, err := mail.ParseAddress(adminEmail); err != nil {
return fmt.Errorf("invalid admin_email: %w", err)
}
if _, err := mail.ParseAddress(acmeEmail); err != nil {
return fmt.Errorf("invalid acme_email: %w", err)
}
prev, err := s.Load()
if err != nil {
return err
}
if prev == nil {
return errors.New("setup not completed — cannot edit contact emails before initial setup")
}
prev.AdminEmail = adminEmail
prev.ACMEEmail = acmeEmail
return s.Save(prev)
}
// SetMaintenanceMode persistiert MaintenanceMode + MaintenanceMessage.
// Idempotent. Caller (Handler) triggert anschließend HAProxy-Reload.
func (s *Store) SetMaintenanceMode(enabled bool, message string) error {
prev, err := s.Load()
if err != nil {
return err
}
if prev == nil {
return errors.New("setup not completed — cannot toggle maintenance mode")
}
prev.MaintenanceMode = enabled
prev.MaintenanceMessage = message
return s.Save(prev)
}
// SetAdminPassword hash't ein neues Plaintext-Passwort und persistiert
// es. Verwendet vom Self-Service-Reset (CLI-Token-Flow).
func (s *Store) SetAdminPassword(plaintext string) error {
if len(plaintext) < 12 {
return errors.New("admin_password must be at least 12 characters")
}
prev, err := s.Load()
if err != nil {
return err
}
if prev == nil || !prev.Completed {
return errors.New("setup not completed — cannot reset password before initial setup")
}
hash, err := bcrypt.GenerateFromPassword([]byte(plaintext), adminPwCost)
if err != nil {
return fmt.Errorf("hash admin password: %w", err)
}
prev.AdminPasswordHash = string(hash)
return s.Save(prev)
}
func validate(req Request) error {
if _, err := mail.ParseAddress(req.AdminEmail); err != nil {
return fmt.Errorf("invalid admin_email: %w", err)
}
if _, err := mail.ParseAddress(req.ACMEEmail); err != nil {
return fmt.Errorf("invalid acme_email: %w", err)
}
if !looksLikeFQDN(req.FQDN) {
return fmt.Errorf("fqdn %q does not look like a fully-qualified hostname", req.FQDN)
}
if len(req.AdminPassword) < 12 {
return errors.New("admin_password must be at least 12 characters")
}
return nil
}
func looksLikeFQDN(s string) bool {
s = strings.TrimSpace(strings.TrimSuffix(s, "."))
if len(s) == 0 || len(s) > 253 {
return false
}
if !strings.Contains(s, ".") {
return false
}
for _, label := range strings.Split(s, ".") {
if len(label) == 0 || len(label) > 63 {
return false
}
for _, r := range label {
ok := r == '-' ||
(r >= '0' && r <= '9') ||
(r >= 'a' && r <= 'z') ||
(r >= 'A' && r <= 'Z')
if !ok {
return false
}
}
if label[0] == '-' || label[len(label)-1] == '-' {
return false
}
}
return true
}