Files
pad/internal/config/config.go
T
xarmian afe721d202 feat(cli): add Cloud mode to pad init, drop Docker option (TASK-837, TASK-838) (#272)
Merging despite Go (PostgreSQL) red — those failures (TestListItems_FTS_HyphenatedSearchTerm/task-five + TestAdminBillingStats_SidecarSidecarError_DegradesToLocalOnly TempDir cleanup race) are pre-existing on main and tracked in BUG-842.

Codex reviewed in 3 rounds (round 1 clean → round 2 found a real semantic bug → fix → round 3 clean). Tests, vet, and lint all green; remaining check failures are documented pre-existing.
2026-04-28 09:41:50 -04:00

455 lines
16 KiB
Go

package config
import (
"crypto/rand"
"encoding/hex"
"fmt"
"os"
"path/filepath"
"runtime"
"strconv"
"strings"
"github.com/BurntSushi/toml"
)
const (
ModeLocal = "local"
ModeRemote = "remote"
ModeCloud = "cloud"
// CloudBaseURL is the canonical public endpoint that `pad configure`
// (and `pad init`) anchor "Cloud" mode to. Picking Cloud sets
// cfg.URL to this value verbatim — there is no per-user URL prompt
// because Cloud is, by definition, our managed deployment.
CloudBaseURL = "https://app.getpad.dev"
)
type Config struct {
Mode string `toml:"mode"`
Host string `toml:"host"`
Port int `toml:"port"`
URL string `toml:"url"` // Optional: full base URL (e.g., https://api.getpad.dev). Overrides host/port for CLI.
Editor string `toml:"editor"`
LogLevel string `toml:"log_level"`
DBPath string `toml:"-"` // computed, not from config file
DataDir string `toml:"-"` // computed
ConfigPath string `toml:"-"`
LoadedFromFile bool `toml:"-"`
LoadedFromEnv bool `toml:"-"`
LoadedFromFlags bool `toml:"-"`
// cloudServerOptIn records whether THIS server process was explicitly
// asked to run in cloud-tenant mode by an env-var (PAD_CLOUD=true|1
// or PAD_MODE=cloud). It is intentionally NOT set by a config-file
// `mode = "cloud"` value, which `pad init` writes when the CLI user
// picks "Cloud" as their connection mode — that is a CLIENT signal,
// not a server-runtime signal. Without this distinction a CLI user
// configuring for Pad Cloud would accidentally trip cloud-server
// mode the next time `pad server start` ran from the same data dir.
cloudServerOptIn bool `toml:"-"`
// Email (Maileroo)
MailerooAPIKey string `toml:"maileroo_api_key"`
EmailFrom string `toml:"email_from"` // Sender address (e.g. noreply@getpad.dev)
EmailFromName string `toml:"email_from_name"` // Sender display name (e.g. Pad)
// Cloud mode
CloudSecret string `toml:"cloud_secret"` // Inbound shared secret(s) accepted from pad-cloud. Comma-separated list supports rotation.
CloudSidecarURL string `toml:"cloud_sidecar_url"` // Base URL pad uses to call the pad-cloud sidecar (reverse direction, e.g. Stripe cancel-customer on account delete)
CloudOutboundSecret string `toml:"cloud_outbound_secret"` // Optional: exact secret to send when calling pad-cloud. Falls back to the LAST entry of CloudSecret (the older rotation value, which is what pad-cloud is usually running). See DEPLOY.md "Cloud secret rotation".
// Encryption
EncryptionKey string `toml:"encryption_key"` // 32-byte hex-encoded AES-256 key for encrypting sensitive fields
EncryptionKeySource string `toml:"-"` // "env", "file", "generated", or "" (unset); populated by EnsureEncryptionKey
// Security
CORSOrigins string `toml:"cors_origins"` // Comma-separated allowed origins (e.g. "https://app.pad.dev,https://admin.pad.dev")
SecureCookies bool `toml:"secure_cookies"` // Set Secure flag on cookies (requires TLS)
TrustedProxies string `toml:"trusted_proxies"` // Comma-separated CIDRs whose X-Forwarded-For is trusted. Empty = ignore proxy headers.
MetricsToken string `toml:"metrics_token"` // Shared Bearer token required to scrape /metrics. Empty = loopback-only.
IPChangeEnforce string `toml:"ip_change_enforce"` // "" (log only) or "strict" (reject session when client IP differs from the one recorded at session creation).
// SSE limits
SSEMaxConnections int `toml:"sse_max_connections"` // Global max SSE connections (0 = unlimited)
SSEMaxPerWorkspace int `toml:"sse_max_per_workspace"` // Per-workspace max SSE connections (0 = unlimited)
}
func DefaultConfig() *Config {
homeDir, _ := os.UserHomeDir()
dataDir := filepath.Join(homeDir, ".pad")
return &Config{
Host: "127.0.0.1",
Port: 7777,
Editor: "",
LogLevel: "info",
DBPath: filepath.Join(dataDir, "pad.db"),
DataDir: dataDir,
ConfigPath: filepath.Join(dataDir, "config.toml"),
SSEMaxConnections: 1000,
SSEMaxPerWorkspace: 100,
}
}
func Load() (*Config, error) {
cfg := DefaultConfig()
// Data-dir overrides affect where config.toml lives, so apply them first.
if v := os.Getenv("PAD_DATA_DIR"); v != "" {
cfg.DataDir = v
cfg.DBPath = filepath.Join(v, "pad.db")
cfg.ConfigPath = filepath.Join(v, "config.toml")
}
if v := os.Getenv("PAD_DB_PATH"); v != "" {
cfg.DBPath = v
cfg.DataDir = filepath.Dir(cfg.DBPath)
cfg.ConfigPath = filepath.Join(cfg.DataDir, "config.toml")
}
// Ensure data directory exists
if err := os.MkdirAll(cfg.DataDir, 0755); err != nil {
return nil, err
}
// Ensure logs directory exists
if err := os.MkdirAll(filepath.Join(cfg.DataDir, "logs"), 0755); err != nil {
return nil, err
}
// Load config file if it exists
if _, err := os.Stat(cfg.ConfigPath); err == nil {
cfg.LoadedFromFile = true
if _, err := toml.DecodeFile(cfg.ConfigPath, cfg); err != nil {
return nil, err
}
}
// Environment variable overrides
if v := os.Getenv("PAD_MODE"); v != "" {
cfg.Mode = v
cfg.LoadedFromEnv = true
if v == ModeCloud {
// PAD_MODE=cloud is an explicit operator opt-in to running
// THIS server in cloud-tenant mode. See cloudServerOptIn.
cfg.cloudServerOptIn = true
}
}
if v := os.Getenv("PAD_HOST"); v != "" {
cfg.Host = v
cfg.LoadedFromEnv = true
}
if v := os.Getenv("PAD_PORT"); v != "" {
if port, err := strconv.Atoi(v); err == nil {
cfg.Port = port
cfg.LoadedFromEnv = true
}
}
if v := os.Getenv("PAD_URL"); v != "" {
cfg.URL = v
cfg.LoadedFromEnv = true
if cfg.Mode == "" {
cfg.Mode = ModeRemote
}
}
// Email (Maileroo)
if v := os.Getenv("PAD_MAILEROO_API_KEY"); v != "" {
cfg.MailerooAPIKey = v
}
if v := os.Getenv("PAD_EMAIL_FROM"); v != "" {
cfg.EmailFrom = v
}
if v := os.Getenv("PAD_EMAIL_FROM_NAME"); v != "" {
cfg.EmailFromName = v
}
// PAD_CLOUD=true is a convenience alias for PAD_MODE=cloud and
// likewise opts the server process into cloud-tenant mode.
if v := os.Getenv("PAD_CLOUD"); v == "true" || v == "1" {
cfg.Mode = ModeCloud
cfg.LoadedFromEnv = true
cfg.cloudServerOptIn = true
}
if v := os.Getenv("PAD_CLOUD_SECRET"); v != "" {
cfg.CloudSecret = v
}
if v := os.Getenv("PAD_CLOUD_SIDECAR_URL"); v != "" {
cfg.CloudSidecarURL = v
}
if v := os.Getenv("PAD_CLOUD_OUTBOUND_SECRET"); v != "" {
cfg.CloudOutboundSecret = v
}
if v := os.Getenv("PAD_ENCRYPTION_KEY"); v != "" {
cfg.EncryptionKey = v
cfg.EncryptionKeySource = "env"
} else if cfg.EncryptionKey != "" {
// Set from config.toml by toml.DecodeFile above.
cfg.EncryptionKeySource = "config"
}
if v := os.Getenv("PAD_CORS_ORIGINS"); v != "" {
cfg.CORSOrigins = v
}
if v := os.Getenv("PAD_SECURE_COOKIES"); v == "true" || v == "1" {
cfg.SecureCookies = true
}
if v := os.Getenv("PAD_TRUSTED_PROXIES"); v != "" {
cfg.TrustedProxies = v
}
if v := os.Getenv("PAD_METRICS_TOKEN"); v != "" {
cfg.MetricsToken = v
}
if v := os.Getenv("PAD_IP_CHANGE_ENFORCE"); v != "" {
cfg.IPChangeEnforce = v
}
if v := os.Getenv("PAD_SSE_MAX_CONNECTIONS"); v != "" {
if max, err := strconv.Atoi(v); err == nil {
cfg.SSEMaxConnections = max
}
}
if v := os.Getenv("PAD_SSE_MAX_PER_WORKSPACE"); v != "" {
if max, err := strconv.Atoi(v); err == nil {
cfg.SSEMaxPerWorkspace = max
}
}
return cfg, nil
}
// Save writes the persisted Pad config to disk.
func (c *Config) Save() error {
if err := os.MkdirAll(c.DataDir, 0755); err != nil {
return err
}
if err := os.MkdirAll(filepath.Join(c.DataDir, "logs"), 0755); err != nil {
return err
}
f, err := os.OpenFile(c.ConfigPath, os.O_CREATE|os.O_WRONLY|os.O_TRUNC, 0600)
if err != nil {
return err
}
defer f.Close()
if err := toml.NewEncoder(f).Encode(c); err != nil {
return err
}
c.LoadedFromFile = true
return nil
}
// IsConfigured reports whether the client has an explicit global connection
// configuration, either from config.toml or an environment/flag override.
func (c *Config) IsConfigured() bool {
return c.LoadedFromFile || c.LoadedFromEnv || c.LoadedFromFlags
}
// ManagesLocalServer reports whether this client configuration should
// auto-manage a local Pad server process.
func (c *Config) ManagesLocalServer() bool {
return c.IsConfigured() && c.Mode == ModeLocal
}
func ValidMode(mode string) bool {
switch mode {
case "", ModeLocal, ModeRemote, ModeCloud:
return true
default:
return false
}
}
// IsCloud reports whether the configured connection mode is Cloud
// (i.e. cfg.Mode == ModeCloud). This is a CLIENT-side signal: the
// CLI is configured to talk to Pad Cloud at https://app.getpad.dev.
//
// For the SERVER-side check ("this server process should run in
// cloud-tenant mode") use IsCloudServer() instead. IsCloud() is
// true whenever Mode is "cloud" regardless of source — including
// a config.toml mode=cloud written by `pad init` — and so is NOT
// safe to gate server-side cloud-tenant behavior on.
func (c *Config) IsCloud() bool {
return c.Mode == ModeCloud
}
// IsCloudServer reports whether THIS server process should run in
// cloud-tenant mode (enabling cloud-specific endpoints, requiring
// PAD_CLOUD_SECRET, wiring the pad-cloud reverse sidecar).
//
// Cloud-tenant mode is opted into ONLY by an env-var: PAD_CLOUD=true|1
// or PAD_MODE=cloud. A config.toml mode=cloud value (set by `pad init`
// when a CLI user picks Pad Cloud) signals the CLIENT connection mode
// and does NOT enable server cloud-tenant mode; without this
// distinction a user who ran `pad init` against app.getpad.dev would
// accidentally trip cloud-server-mode startup the next time they ran
// `pad server start` from the same data dir.
func (c *Config) IsCloudServer() bool {
return c.cloudServerOptIn
}
// Addr returns the host:port listen address.
func (c *Config) Addr() string {
return fmt.Sprintf("%s:%d", c.Host, c.Port)
}
// BaseURL returns the base URL for the API.
// If URL is set (via config, --url flag, or PAD_URL), it takes precedence.
// Otherwise, constructs from host and port.
func (c *Config) BaseURL() string {
if c.URL != "" {
return strings.TrimRight(c.URL, "/")
}
return fmt.Sprintf("http://%s:%d", c.Host, c.Port)
}
// BrowserURL returns a URL suitable for displaying to humans in CLI prompts
// (e.g. "Or open the web UI at X"). It behaves like BaseURL except that
// when the URL is constructed from host:port, an unspecified bind-all host
// (empty, "0.0.0.0", "::", "[::]") is rewritten to "127.0.0.1" because
// 0.0.0.0 is a bind address and not reliably usable as a browser
// destination. When URL is explicitly set (Remote/Cloud) it is
// returned as-is.
func (c *Config) BrowserURL() string {
if c.URL != "" {
return strings.TrimRight(c.URL, "/")
}
host := c.Host
switch host {
case "", "0.0.0.0", "::", "[::]":
host = "127.0.0.1"
}
return fmt.Sprintf("http://%s:%d", host, c.Port)
}
func (c *Config) PIDFile() string {
return filepath.Join(c.DataDir, "pad.pid")
}
// EncryptionKeyFile returns the on-disk path where an auto-generated
// encryption key is persisted. Operator-provided keys (PAD_ENCRYPTION_KEY
// env, encryption_key config) take precedence and never cause the file
// to be read or written.
func (c *Config) EncryptionKeyFile() string {
return filepath.Join(c.DataDir, "encryption.key")
}
// EnsureEncryptionKey makes sure the server has a usable encryption key
// without requiring the operator to set one explicitly. Resolution order:
//
// 1. If c.EncryptionKey is already set (env or config file), use it
// verbatim. EncryptionKeySource = "env" or "config" — set by Load().
// 2. Otherwise look for <DataDir>/encryption.key. If present and
// parseable, load it. EncryptionKeySource = "file".
// 3. Otherwise — only when the caller indicates a single-instance
// deployment via allowGenerate=true — generate a new 32-byte
// AES-256 key, persist it to that file with 0600 permissions, and
// use it. EncryptionKeySource = "generated" so callers can log
// loudly.
//
// Clustered deployments (allowGenerate=false — typically indicated by
// PAD_DB_DRIVER=postgres + multiple replicas) MUST configure
// PAD_ENCRYPTION_KEY explicitly. Otherwise each replica would persist
// its own key to local disk and cross-instance decryption of shared
// database rows would fail with GCM auth errors. We return an error in
// that case rather than silently diverging.
//
// Returns an error if key-file creation fails — we never silently fall
// back to plaintext storage of sensitive fields like TOTP seeds.
func (c *Config) EnsureEncryptionKey(allowGenerate bool) error {
if c.EncryptionKey != "" {
// EncryptionKeySource was set by Load(); keep whatever was stored.
if c.EncryptionKeySource == "" {
c.EncryptionKeySource = "config"
}
return nil
}
keyPath := c.EncryptionKeyFile()
if info, err := os.Stat(keyPath); err == nil {
// Reject overly-permissive key files before reading. An
// encryption.key world-readable (0644) on a shared host hands the
// AES key to any local user — it would defeat the whole point of
// encrypting at-rest fields. Generated files are written with
// 0600; operators who pre-seed must match.
if runtime.GOOS != "windows" && info.Mode().Perm()&0077 != 0 {
return fmt.Errorf("encryption key %s has mode %o (group/other bits set); run `chmod 600 %s` to restrict",
keyPath, info.Mode().Perm(), keyPath)
}
data, rerr := os.ReadFile(keyPath)
if rerr != nil {
return fmt.Errorf("read encryption key: %w", rerr)
}
c.EncryptionKey = strings.TrimSpace(string(data))
c.EncryptionKeySource = "file"
return nil
} else if !os.IsNotExist(err) {
return fmt.Errorf("stat encryption key: %w", err)
}
if !allowGenerate {
return fmt.Errorf("PAD_ENCRYPTION_KEY is required for this deployment (shared database — auto-generation would diverge across replicas). Generate one with: openssl rand -hex 32")
}
// Generate a fresh 32-byte key.
buf := make([]byte, 32)
if _, err := rand.Read(buf); err != nil {
return fmt.Errorf("generate encryption key: %w", err)
}
encoded := hex.EncodeToString(buf)
// Make sure the data dir exists with tight permissions before dropping
// the key file into it.
if err := os.MkdirAll(c.DataDir, 0700); err != nil {
return fmt.Errorf("create data dir for encryption key: %w", err)
}
// Atomic create via temp-file + hardlink. This handles the concurrent-
// startup race cleanly at every step:
//
// 1. Write the full key to a uniquely-named temp file — each racing
// process has its own temp path, so no collision there, and the
// file is fully written + closed before we touch the final path.
// 2. os.Link(temp, keyPath) atomically creates the final file as a
// hardlink to the temp. If keyPath already exists, Link fails
// with EEXIST and leaves the existing file untouched. This is
// the critical property: a loser cannot partially overwrite the
// winner's key, and cannot read the winner's file before it is
// complete (hardlink points to an already-written inode).
// 3. On loss, ReadFile(keyPath) is safe — it points to the winner's
// fully-written inode.
// 4. The temp is removed in all paths so repeated startups don't
// accumulate junk under DataDir.
tmpSuffix := make([]byte, 8)
if _, err := rand.Read(tmpSuffix); err != nil {
return fmt.Errorf("generate temp suffix: %w", err)
}
tmpPath := keyPath + ".tmp." + hex.EncodeToString(tmpSuffix)
if err := os.WriteFile(tmpPath, []byte(encoded), 0600); err != nil {
return fmt.Errorf("write encryption key temp: %w", err)
}
defer os.Remove(tmpPath) // Best-effort cleanup. Harmless on the winning path (already removed via rename equivalence).
if err := os.Link(tmpPath, keyPath); err != nil {
if os.IsExist(err) {
// Someone else won. Their file is fully written because it
// too went through temp-write → link, so ReadFile is safe.
data, rerr := os.ReadFile(keyPath)
if rerr != nil {
return fmt.Errorf("reload encryption key after race: %w", rerr)
}
c.EncryptionKey = strings.TrimSpace(string(data))
c.EncryptionKeySource = "file"
return nil
}
return fmt.Errorf("link encryption key to %s: %w", keyPath, err)
}
c.EncryptionKey = encoded
c.EncryptionKeySource = "generated"
return nil
}
func (c *Config) LogFile() string {
return filepath.Join(c.DataDir, "logs", "server.log")
}