Skip to content

armgit / Pulse

Public Imported from GitHub
0

Real-time monitoring dashboard for Proxmox VE, PBS, Docker, Kubernetes, TrueNAS and vSphere. Self-hosted, with alerts for failed backups, full disks, unhealthy containers and offline nodes.

17.1 KB
Raw Blame
package licensing

import (
	"crypto/aes"
	"crypto/cipher"
	"crypto/hkdf"
	"crypto/rand"
	"crypto/sha256"
	"encoding/base64"
	"encoding/hex"
	"encoding/json"
	"errors"
	"fmt"
	"io"
	"os"
	"path/filepath"
	"strings"
	"syscall"

	"github.com/rcourtman/pulse-go-rewrite/internal/securityutil"
)

const (
	// LicenseFileName is the name of the encrypted license file.
	LicenseFileName = "license.enc"
	// PersistentKeyFileName is the name of the persistent encryption key file.
	// This file is stored in the config directory (e.g., /data/) and survives
	// Docker container recreation, unlike /etc/machine-id.
	PersistentKeyFileName = ".license-key"

	persistencePrivateDirPerm  = 0o700
	persistencePrivateFilePerm = 0o600
	maxPersistentKeyFileSize   = 4096
	maxLicenseFileSize         = 1 << 20 // 1 MiB
)

var (
	licenseKeyDerivationSalt = []byte("pulse-license-persistence-v2")
	licenseKeyDerivationInfo = []byte("license-encryption")
)

var (
	errUnsafeLicensePersistencePath = errors.New("unsafe license persistence path")
	errInvalidLicensePersistentKey  = errors.New("invalid persistent license key")
)

func isMissingPersistencePathError(err error) bool {
	return errors.Is(err, os.ErrNotExist) || errors.Is(err, syscall.ENOTDIR)
}

func normalizePersistenceConfigDir(configDir string) (string, error) {
	normalizedConfigDir, err := securityutil.NormalizeStorageDir(configDir)
	if err != nil {
		return "", errors.New("config directory cannot be empty")
	}
	return normalizedConfigDir, nil
}

func resolvePersistencePath(configDir string, leaf string) (string, error) {
	normalizedConfigDir, err := normalizePersistenceConfigDir(configDir)
	if err != nil {
		return "", err
	}

	path, err := securityutil.JoinStorageLeaf(normalizedConfigDir, leaf)
	if err != nil {
		return "", fmt.Errorf("resolve persistence path for %q: %w", leaf, err)
	}
	return path, nil
}

func ensurePersistenceOwnerOnlyDir(dir string) error {
	return securityutil.EnsureSecureStorageDir(dir, persistencePrivateDirPerm)
}

func validatePersistenceRegularFile(path string, info os.FileInfo) error {
	if info.Mode()&os.ModeSymlink != 0 {
		return fmt.Errorf("%w: refusing symlink path %q", errUnsafeLicensePersistencePath, path)
	}
	if !info.Mode().IsRegular() {
		return fmt.Errorf("%w: non-regular path %q", errUnsafeLicensePersistencePath, path)
	}
	return nil
}

func readBoundedPersistenceRegularFile(path string, maxSize int64) ([]byte, error) {
	info, err := os.Lstat(path)
	if err != nil {
		return nil, err
	}
	if err := validatePersistenceRegularFile(path, info); err != nil {
		return nil, err
	}
	if maxSize > 0 && info.Size() > maxSize {
		return nil, fmt.Errorf("%w: file %q exceeds size limit (%d bytes)", errUnsafeLicensePersistencePath, path, info.Size())
	}

	data, err := os.ReadFile(path)
	if err != nil {
		return nil, err
	}
	if maxSize > 0 && int64(len(data)) > maxSize {
		return nil, fmt.Errorf("%w: file %q exceeded size limit while reading", errUnsafeLicensePersistencePath, path)
	}
	return data, nil
}

func writeOwnerOnlyPersistenceFileAtomic(path string, data []byte) error {
	if err := ensurePersistenceOwnerOnlyDir(filepath.Dir(path)); err != nil {
		return err
	}

	if info, err := os.Lstat(path); err == nil {
		if err := validatePersistenceRegularFile(path, info); err != nil {
			return err
		}
	} else if !isMissingPersistencePathError(err) {
		return err
	}

	tmpFile, err := os.CreateTemp(filepath.Dir(path), filepath.Base(path)+".*.tmp")
	if err != nil {
		return err
	}
	tmpPath := tmpFile.Name()
	cleanup := true
	defer func() {
		if cleanup {
			_ = os.Remove(tmpPath)
		}
	}()

	if err := tmpFile.Chmod(persistencePrivateFilePerm); err != nil {
		_ = tmpFile.Close()
		return err
	}
	if _, err := tmpFile.Write(data); err != nil {
		_ = tmpFile.Close()
		return err
	}
	if err := tmpFile.Close(); err != nil {
		return err
	}
	if err := os.Rename(tmpPath, path); err != nil {
		return err
	}
	cleanup = false
	return os.Chmod(path, persistencePrivateFilePerm)
}

// Persistence handles encrypted storage of license keys.
type Persistence struct {
	configDir          string
	encryptionKey      string   // Primary persistent key for encryption
	machineID          string   // Legacy-only fallback for backwards compatibility
	legacyKeyMaterials []string // v5.0.x raw key materials, tried verbatim (untrimmed) on decrypt
}

// NewPersistence creates a new license persistence handler.
// New writes always use a persistent random key; machine-id is retained only
// as a compatibility fallback when loading older encrypted state.
func NewPersistence(configDir string) (*Persistence, error) {
	normalizedConfigDir, err := normalizePersistenceConfigDir(configDir)
	if err != nil {
		return nil, err
	}

	// Try to load persistent key from config directory first
	persistentKey, err := loadPersistentKey(normalizedConfigDir)
	if err != nil && !isMissingPersistencePathError(err) {
		return nil, fmt.Errorf("failed to load persistent key: %w", err)
	}

	// Machine ID is legacy-only fallback material for existing installations.
	machineID, err := getMachineID()
	if err != nil {
		machineID = ""
	}

	return &Persistence{
		configDir:          normalizedConfigDir,
		encryptionKey:      persistentKey,
		machineID:          machineID,
		legacyKeyMaterials: legacyV5KeyMaterials(),
	}, nil
}

// loadPersistentKey attempts to load the persistent encryption key from disk.
func loadPersistentKey(configDir string) (string, error) {
	keyPath, err := resolvePersistencePath(configDir, PersistentKeyFileName)
	if err != nil {
		return "", err
	}
	data, err := readBoundedPersistenceRegularFile(keyPath, maxPersistentKeyFileSize)
	if err != nil {
		return "", err
	}
	key := strings.TrimSpace(string(data))
	if key == "" {
		return "", fmt.Errorf("%w: persistent key file is empty", errInvalidLicensePersistentKey)
	}
	return key, os.Chmod(keyPath, persistencePrivateFilePerm)
}

// ensurePersistentKey creates a persistent encryption key if one doesn't exist.
// Returns the key (existing or newly created).
func (p *Persistence) ensurePersistentKey() (string, error) {
	configDir, err := normalizePersistenceConfigDir(p.configDir)
	if err != nil {
		return "", err
	}
	keyPath, err := resolvePersistencePath(configDir, PersistentKeyFileName)
	if err != nil {
		return "", err
	}

	if err := ensurePersistenceOwnerOnlyDir(configDir); err != nil {
		return "", fmt.Errorf("failed to secure config directory: %w", err)
	}

	// Check if key already exists
	data, err := readBoundedPersistenceRegularFile(keyPath, maxPersistentKeyFileSize)
	if err == nil {
		key := strings.TrimSpace(string(data))
		if key == "" {
			return "", fmt.Errorf("%w: persistent key file is empty", errInvalidLicensePersistentKey)
		}
		if err := os.Chmod(keyPath, persistencePrivateFilePerm); err != nil {
			return "", fmt.Errorf("failed to secure persistent key file: %w", err)
		}
		return key, nil
	}
	if err != nil && !isMissingPersistencePathError(err) {
		return "", fmt.Errorf("failed to load persistent key: %w", err)
	}

	// Generate a new random key (32 bytes = 64 hex chars)
	keyBytes := make([]byte, 32)
	if _, err := io.ReadFull(rand.Reader, keyBytes); err != nil {
		return "", fmt.Errorf("failed to generate encryption key: %w", err)
	}
	key := hex.EncodeToString(keyBytes)

	// Save the key
	if err := writeOwnerOnlyPersistenceFileAtomic(keyPath, []byte(key)); err != nil {
		return "", fmt.Errorf("failed to write encryption key: %w", err)
	}

	return key, nil
}

// PersistedLicense contains the license key and metadata for storage.
type PersistedLicense struct {
	LicenseKey     string `json:"license_key"`
	GracePeriodEnd *int64 `json:"grace_period_end,omitempty"` // Unix timestamp
}

// Save encrypts and saves a license key to disk.
func (p *Persistence) Save(licenseKey string) error {
	return p.SaveWithGracePeriod(licenseKey, nil)
}

// SaveWithGracePeriod encrypts and saves a license with optional grace period.
func (p *Persistence) SaveWithGracePeriod(licenseKey string, gracePeriodEnd *int64) error {
	licenseKey = strings.TrimSpace(licenseKey)
	if licenseKey == "" {
		return errors.New("license key cannot be empty")
	}

	// Ensure we have a persistent encryption key for future-proofing.
	// This creates .license-key in the config directory if it doesn't exist,
	// ensuring Docker users don't lose their license on container recreation.
	newKey, err := p.ensurePersistentKey()
	if err != nil {
		return fmt.Errorf("failed to ensure persistent encryption key: %w", err)
	}
	if newKey != "" {
		p.encryptionKey = newKey
	}

	// Store as JSON with metadata
	persisted := PersistedLicense{
		LicenseKey:     licenseKey,
		GracePeriodEnd: gracePeriodEnd,
	}
	jsonData, err := json.Marshal(persisted)
	if err != nil {
		return fmt.Errorf("failed to marshal license: %w", err)
	}

	encrypted, err := p.encrypt(jsonData)
	if err != nil {
		return fmt.Errorf("failed to encrypt license: %w", err)
	}

	configDir, err := normalizePersistenceConfigDir(p.configDir)
	if err != nil {
		return err
	}
	if err := ensurePersistenceOwnerOnlyDir(configDir); err != nil {
		return fmt.Errorf("failed to secure config directory: %w", err)
	}

	licensePath, err := resolvePersistencePath(configDir, LicenseFileName)
	if err != nil {
		return fmt.Errorf("resolve license file path: %w", err)
	}
	encoded := base64.StdEncoding.EncodeToString(encrypted)

	if err := writeOwnerOnlyPersistenceFileAtomic(licensePath, []byte(encoded)); err != nil {
		return fmt.Errorf("failed to write license file: %w", err)
	}

	return nil
}

// Load reads and decrypts a license key from disk.
func (p *Persistence) Load() (string, error) {
	persisted, err := p.LoadWithMetadata()
	if err != nil {
		return "", fmt.Errorf("load license metadata: %w", err)
	}
	return persisted.LicenseKey, nil
}

// LoadWithMetadata reads and decrypts a license with metadata from disk.
// It first tries the current HKDF-derived persistent key and then legacy
// derivations for compatibility with older installations.
func (p *Persistence) LoadWithMetadata() (PersistedLicense, error) {
	licensePath, err := resolvePersistencePath(p.configDir, LicenseFileName)
	if err != nil {
		return PersistedLicense{}, fmt.Errorf("resolve license file path: %w", err)
	}

	encoded, err := readBoundedPersistenceRegularFile(licensePath, maxLicenseFileSize)
	if err != nil {
		if isMissingPersistencePathError(err) {
			return PersistedLicense{}, nil // No license saved
		}
		return PersistedLicense{}, fmt.Errorf("failed to read license file: %w", err)
	}

	var persisted PersistedLicense
	migratedPlaintext := false

	if encrypted, err := base64.StdEncoding.DecodeString(strings.TrimSpace(string(encoded))); err == nil {
		decrypted, decErr := p.decryptWithCompatibleKeys(encrypted)
		if decErr != nil {
			return PersistedLicense{}, fmt.Errorf("failed to decrypt license: %w", decErr)
		}

		// Try to parse as new JSON format.
		if err := json.Unmarshal(decrypted, &persisted); err != nil {
			// Fall back to old format (just raw key).
			persisted.LicenseKey = string(decrypted)
		}
	} else {
		// Legacy plaintext license.enc is migration-only input.
		if err := json.Unmarshal(encoded, &persisted); err != nil {
			persisted.LicenseKey = string(encoded)
		}
		migratedPlaintext = true
	}

	if migratedPlaintext {
		if err := p.SaveWithGracePeriod(persisted.LicenseKey, persisted.GracePeriodEnd); err != nil {
			return PersistedLicense{}, fmt.Errorf("rewrite plaintext license file: %w", err)
		}
	}

	return persisted, nil
}

// Delete removes the saved license file.
func (p *Persistence) Delete() error {
	licensePath, err := resolvePersistencePath(p.configDir, LicenseFileName)
	if err != nil {
		return fmt.Errorf("resolve license file path: %w", err)
	}
	err = os.Remove(licensePath)
	if err != nil && !os.IsNotExist(err) {
		return fmt.Errorf("failed to delete license file: %w", err)
	}
	return nil
}

// Exists checks if a saved license exists.
func (p *Persistence) Exists() bool {
	licensePath, err := resolvePersistencePath(p.configDir, LicenseFileName)
	if err != nil {
		return false
	}
	info, err := os.Lstat(licensePath)
	if err != nil {
		return false
	}
	if info.Mode()&os.ModeSymlink != 0 {
		return false
	}
	return info.Mode().IsRegular()
}

// encrypt uses AES-GCM to encrypt data.
func (p *Persistence) encrypt(plaintext []byte) ([]byte, error) {
	key := p.deriveKey()

	block, err := aes.NewCipher(key)
	if err != nil {
		return nil, fmt.Errorf("create AES cipher: %w", err)
	}

	gcm, err := cipher.NewGCM(block)
	if err != nil {
		return nil, fmt.Errorf("create GCM: %w", err)
	}

	nonce := make([]byte, gcm.NonceSize())
	if _, err := io.ReadFull(rand.Reader, nonce); err != nil {
		return nil, fmt.Errorf("generate nonce: %w", err)
	}

	ciphertext := gcm.Seal(nonce, nonce, plaintext, nil)
	return ciphertext, nil
}

// decryptWithKey uses AES-GCM to decrypt data with a specific key.
func (p *Persistence) decryptWithKey(ciphertext []byte, key []byte) ([]byte, error) {
	block, err := aes.NewCipher(key)
	if err != nil {
		return nil, fmt.Errorf("create AES cipher: %w", err)
	}

	gcm, err := cipher.NewGCM(block)
	if err != nil {
		return nil, fmt.Errorf("create GCM: %w", err)
	}

	if len(ciphertext) < gcm.NonceSize() {
		return nil, fmt.Errorf("ciphertext too short: got %d bytes, need at least %d", len(ciphertext), gcm.NonceSize())
	}

	nonce := ciphertext[:gcm.NonceSize()]
	data := ciphertext[gcm.NonceSize():]

	plaintext, err := gcm.Open(nil, nonce, data, nil)
	if err != nil {
		return nil, fmt.Errorf("decrypt ciphertext: %w", err)
	}

	return plaintext, nil
}

// deriveKey derives a 32-byte key from the current encryption key.
func (p *Persistence) deriveKey() []byte {
	return p.deriveKeyFrom(p.encryptionKey)
}

// deriveKeyFrom derives a 32-byte key from a given key material using HKDF.
func (p *Persistence) deriveKeyFrom(keyMaterial string) []byte {
	if strings.TrimSpace(keyMaterial) == "" {
		return nil
	}
	key, err := hkdf.Key(sha256.New, []byte(keyMaterial), licenseKeyDerivationSalt, string(licenseKeyDerivationInfo), 32)
	if err != nil {
		return nil
	}
	return key
}

func (p *Persistence) deriveLegacyKeyFrom(keyMaterial string) []byte {
	if strings.TrimSpace(keyMaterial) == "" {
		return nil
	}
	hash := sha256.Sum256([]byte("pulse-license-" + keyMaterial))
	return hash[:]
}

func (p *Persistence) compatibleKeyCandidates() [][]byte {
	materials := []string{}
	seen := map[string]bool{}
	addMaterial := func(candidate string) {
		candidate = strings.TrimSpace(candidate)
		if candidate == "" || seen[candidate] {
			return
		}
		seen[candidate] = true
		materials = append(materials, candidate)
	}

	addMaterial(p.encryptionKey)
	addMaterial(p.machineID)

	keys := make([][]byte, 0, len(materials)*2+len(p.legacyKeyMaterials))
	for _, material := range materials {
		if key := p.deriveKeyFrom(material); len(key) > 0 {
			keys = append(keys, key)
		}
		if key := p.deriveLegacyKeyFrom(material); len(key) > 0 {
			keys = append(keys, key)
		}
	}

	// v5.0.x sealed license.enc with sha256("pulse-license-" + material) over
	// untrimmed material: the raw machine-id file content (trailing newline
	// included), the hostname fallback, or a fixed dev fallback. Those keys
	// are only reachable by hashing the material verbatim, so never trim here.
	for _, material := range p.legacyKeyMaterials {
		if material == "" || seen[material] {
			continue
		}
		seen[material] = true
		if key := p.deriveLegacyKeyFrom(material); len(key) > 0 {
			keys = append(keys, key)
		}
	}
	return keys
}

func (p *Persistence) decryptWithCompatibleKeys(ciphertext []byte) ([]byte, error) {
	var lastErr error
	for _, key := range p.compatibleKeyCandidates() {
		plaintext, err := p.decryptWithKey(ciphertext, key)
		if err == nil {
			return plaintext, nil
		}
		lastErr = err
	}
	if lastErr != nil {
		return nil, lastErr
	}
	return nil, fmt.Errorf("no compatible decryption key available")
}

// machineIDPaths are the machine-id sources shared by current and v5-era key
// derivation.
var machineIDPaths = []string{
	"/etc/machine-id",
	"/var/lib/dbus/machine-id",
}

// legacyV5MachineIDFallback mirrors v5.0.0's NewPersistence fallback when no
// machine-id source was readable.
const legacyV5MachineIDFallback = "pulse-dev-fallback-machine-id"

// getMachineID attempts to get a stable machine identifier.
func getMachineID() (string, error) {
	for _, path := range machineIDPaths {
		data, err := os.ReadFile(path)
		if err == nil && len(data) > 0 {
			trimmed := strings.TrimSpace(string(data))
			if trimmed != "" {
				return trimmed, nil
			}
		}
	}

	return "", errors.New("could not determine machine ID")
}

// legacyV5KeyMaterials reproduces the key-material set v5.0.x used to seal
// license.enc: the raw machine-id file content exactly as read (v5 never
// trimmed it, so a standard newline-terminated /etc/machine-id keyed the
// cipher with the newline included), then the hostname fallback, then the
// fixed dev fallback. Licenses activated on v5.0.0 — before .license-key
// shipped in v5.0.1 — are never re-saved, so these are the only keys that
// can open them.
func legacyV5KeyMaterials() []string {
	materials := []string{}
	for _, path := range machineIDPaths {
		data, err := os.ReadFile(path)
		if err == nil && len(data) > 0 {
			materials = append(materials, string(data))
		}
	}
	if hostname, err := os.Hostname(); err == nil && hostname != "" {
		materials = append(materials, hostname)
	}
	return append(materials, legacyV5MachineIDFallback)
}