- internal/mqtt: publish each device's desired state retained on restrict/<device>/config; subscribe to restrict/+/status and restrict/+/telemetry and write reports to SQLite; publish on every state change, republish on connect and every 15 minutes from SQLite, so the broker is repaired from the source of truth. - store: presence (devices.online and last_seen, audited only on transitions), telemetry upsert per (device, day, app, domain) via migration 002, allow and block lists read into the config payload, device lookup by topic. - config: MQTT settings. TLS plus per-device credentials are required; the pre-TLS shared broker needs an explicit CONTROL_MQTT_INSECURE escape hatch. - web: republish config after lock, unlock, expiry, create and edit; broker card on the status partial. - deploy/mosquitto: TLS listener, topic ACL, credential provisioning and a verifier that proves the policy on a throwaway broker. Not applied to the shared Mosquitto on .13 — that change needs Sam's approval. - cmd/control: mqtt-clients prints the MQTT identity of every device. - paho.mqtt.golang v1.5.1, which pulls golang.org/x/net and with it the golang.org/x/crypto bump to v0.42.0. Verified on .13: retained config delivered to a fresh subscriber; a client killed without DISCONNECT drove the broker's retained will and the service flipped the device offline; telemetry landed in SQLite; make mqtt-verify passed 13/13; the service connected over TLS with credentials and a CA. Co-Authored-By: Paperclip <noreply@paperclip.ing>
177 lines
5.7 KiB
Go
177 lines
5.7 KiB
Go
// Package config loads the Control Service configuration from the process
|
|
// environment. Every secret comes from the environment (environment.d); nothing
|
|
// is compiled into the binary and nothing is read from a committed file.
|
|
package config
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
"log/slog"
|
|
"os"
|
|
"strconv"
|
|
"strings"
|
|
"time"
|
|
)
|
|
|
|
// Config is the fully resolved runtime configuration.
|
|
type Config struct {
|
|
// Addr is the listen address, for example ":8791".
|
|
Addr string
|
|
// DBPath is the SQLite database file, for example "/data/control.db".
|
|
DBPath string
|
|
// SessionSecret signs the session cookie. Required, >= 16 bytes.
|
|
SessionSecret []byte
|
|
// AdminUsername is the single dashboard login name (Sam).
|
|
AdminUsername string
|
|
// AdminPassword is the plaintext password. Optional if AdminPasswordHash is set.
|
|
AdminPassword string
|
|
// AdminPasswordHash is a bcrypt hash. Optional if AdminPassword is set.
|
|
AdminPasswordHash string
|
|
// CookieSecure sets the Secure attribute on cookies. Keep true behind HTTPS.
|
|
CookieSecure bool
|
|
// SessionTTL is how long a session cookie stays valid.
|
|
SessionTTL time.Duration
|
|
// LogLevel is the slog level.
|
|
LogLevel slog.Level
|
|
// AppEnv is a label such as "production" or "development".
|
|
AppEnv string
|
|
// Version is injected at build time.
|
|
Version string
|
|
|
|
// MQTTEnabled turns the broker link on. When false the service runs
|
|
// HTTP-only and never touches the broker.
|
|
MQTTEnabled bool
|
|
// MQTTBroker is the broker URL, for example "tls://mosquitto:8883" or
|
|
// "tcp://127.0.0.1:1883".
|
|
MQTTBroker string
|
|
// MQTTClientID is the MQTT client id of the Control Service.
|
|
MQTTClientID string
|
|
// MQTTUsername and MQTTPassword are the Control Service credentials
|
|
// (AGENTS.md §10 rule 6: per-device credentials).
|
|
MQTTUsername string
|
|
MQTTPassword string
|
|
// MQTTCAFile is the PEM bundle used to verify the broker certificate.
|
|
MQTTCAFile string
|
|
// MQTTInsecure allows a plaintext, credential-less broker link. It exists
|
|
// only until the shared Mosquitto gets the TLS listener; never set it in
|
|
// production.
|
|
MQTTInsecure bool
|
|
}
|
|
|
|
// Load reads and validates the configuration.
|
|
func Load() (*Config, error) {
|
|
cfg := &Config{
|
|
Addr: env("CONTROL_ADDR", ":8791"),
|
|
DBPath: env("CONTROL_DB_PATH", "/data/control.db"),
|
|
AdminUsername: env("CONTROL_ADMIN_USERNAME", "sam"),
|
|
AdminPassword: os.Getenv("CONTROL_ADMIN_PASSWORD"),
|
|
AdminPasswordHash: os.Getenv("CONTROL_ADMIN_PASSWORD_HASH"),
|
|
CookieSecure: envBool("CONTROL_COOKIE_SECURE", true),
|
|
AppEnv: env("CONTROL_APP_ENV", "production"),
|
|
MQTTEnabled: envBool("CONTROL_MQTT_ENABLED", true),
|
|
MQTTBroker: env("CONTROL_MQTT_BROKER", DefaultMQTTBroker),
|
|
MQTTClientID: env("CONTROL_MQTT_CLIENT_ID", "control-service"),
|
|
MQTTUsername: os.Getenv("CONTROL_MQTT_USERNAME"),
|
|
MQTTPassword: os.Getenv("CONTROL_MQTT_PASSWORD"),
|
|
MQTTCAFile: env("CONTROL_MQTT_CA_FILE", "/etc/webrestrict/tls/ca.crt"),
|
|
MQTTInsecure: envBool("CONTROL_MQTT_INSECURE", false),
|
|
}
|
|
|
|
secret := os.Getenv("CONTROL_SESSION_SECRET")
|
|
if len(secret) < 16 {
|
|
return nil, errors.New("CONTROL_SESSION_SECRET must be set and at least 16 characters")
|
|
}
|
|
cfg.SessionSecret = []byte(secret)
|
|
|
|
if cfg.AdminPassword == "" && cfg.AdminPasswordHash == "" {
|
|
return nil, errors.New("set CONTROL_ADMIN_PASSWORD or CONTROL_ADMIN_PASSWORD_HASH")
|
|
}
|
|
if cfg.AdminUsername == "" {
|
|
return nil, errors.New("CONTROL_ADMIN_USERNAME must not be empty")
|
|
}
|
|
|
|
ttl, err := time.ParseDuration(env("CONTROL_SESSION_TTL", "12h"))
|
|
if err != nil {
|
|
return nil, fmt.Errorf("CONTROL_SESSION_TTL: %w", err)
|
|
}
|
|
cfg.SessionTTL = ttl
|
|
|
|
lvl, err := parseLevel(env("CONTROL_LOG_LEVEL", "info"))
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
cfg.LogLevel = lvl
|
|
|
|
if err := cfg.validateMQTT(); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return cfg, nil
|
|
}
|
|
|
|
// DefaultMQTTBroker is where the shared Mosquitto on `.13` lives, as seen from
|
|
// inside this project's container. The compose file maps host.docker.internal
|
|
// to the host gateway.
|
|
const DefaultMQTTBroker = "tcp://host.docker.internal:1883"
|
|
|
|
// MQTTTLS reports whether the broker URL asks for TLS.
|
|
func (c *Config) MQTTTLS() bool {
|
|
return strings.HasPrefix(c.MQTTBroker, "tls://") || strings.HasPrefix(c.MQTTBroker, "ssl://")
|
|
}
|
|
|
|
// validateMQTT refuses a link that carries neither TLS nor credentials, unless
|
|
// CONTROL_MQTT_INSECURE explicitly allows it (AGENTS.md §10 rule 6).
|
|
func (c *Config) validateMQTT() error {
|
|
if !c.MQTTEnabled {
|
|
return nil
|
|
}
|
|
if c.MQTTBroker == "" {
|
|
return errors.New("CONTROL_MQTT_BROKER must not be empty when MQTT is enabled")
|
|
}
|
|
if c.MQTTUsername == "" || c.MQTTPassword == "" {
|
|
if !c.MQTTInsecure {
|
|
return errors.New("CONTROL_MQTT_USERNAME and CONTROL_MQTT_PASSWORD are required; " +
|
|
"set CONTROL_MQTT_INSECURE=true only for the pre-TLS lab broker")
|
|
}
|
|
}
|
|
if !c.MQTTTLS() && !c.MQTTInsecure {
|
|
return errors.New("CONTROL_MQTT_BROKER must use tls:// (AGENTS.md §10 rule 6); " +
|
|
"set CONTROL_MQTT_INSECURE=true only for the pre-TLS lab broker")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func env(key, fallback string) string {
|
|
if v := strings.TrimSpace(os.Getenv(key)); v != "" {
|
|
return v
|
|
}
|
|
return fallback
|
|
}
|
|
|
|
func envBool(key string, fallback bool) bool {
|
|
v := strings.TrimSpace(os.Getenv(key))
|
|
if v == "" {
|
|
return fallback
|
|
}
|
|
b, err := strconv.ParseBool(v)
|
|
if err != nil {
|
|
return fallback
|
|
}
|
|
return b
|
|
}
|
|
|
|
func parseLevel(s string) (slog.Level, error) {
|
|
switch strings.ToLower(strings.TrimSpace(s)) {
|
|
case "debug":
|
|
return slog.LevelDebug, nil
|
|
case "info", "":
|
|
return slog.LevelInfo, nil
|
|
case "warn", "warning":
|
|
return slog.LevelWarn, nil
|
|
case "error":
|
|
return slog.LevelError, nil
|
|
default:
|
|
return 0, fmt.Errorf("CONTROL_LOG_LEVEL: unknown level %q", s)
|
|
}
|
|
}
|