Brian Krabach
3a8673690c
Add two new TLS settings keys to DEFAULT_SETTINGS dict: - tls_cert: initialized to empty string - tls_key: initialized to empty string Keys are placed after federation_key as specified. Add 5 TDD tests (task-1-tls-settings-keys): - test_defaults_include_tls_cert - test_defaults_include_tls_key - test_load_returns_tls_keys_when_file_missing - test_tls_keys_patchable - test_old_settings_file_without_tls_keys_loads_correctly All 42 tests pass.
122 lines
3.9 KiB
Python
122 lines
3.9 KiB
Python
"""
|
|
Server-side settings management for muxplex.
|
|
|
|
Settings are stored at ~/.config/muxplex/settings.json.
|
|
"""
|
|
|
|
import copy
|
|
import json
|
|
import os
|
|
import socket
|
|
from pathlib import Path
|
|
|
|
SETTINGS_PATH = Path.home() / ".config" / "muxplex" / "settings.json"
|
|
FEDERATION_KEY_PATH = Path.home() / ".config" / "muxplex" / "federation_key"
|
|
|
|
DEFAULT_SETTINGS: dict = {
|
|
"host": "127.0.0.1",
|
|
"port": 8088,
|
|
"auth": "pam",
|
|
"session_ttl": 604800,
|
|
"default_session": None,
|
|
"sort_order": "manual",
|
|
"hidden_sessions": [],
|
|
"window_size_largest": False,
|
|
"auto_open_created": True,
|
|
"new_session_template": "tmux new-session -d -s {name}",
|
|
"remote_instances": [],
|
|
"device_name": "",
|
|
"delete_session_template": "tmux kill-session -t {name}",
|
|
"multi_device_enabled": False,
|
|
"federation_key": "",
|
|
"tls_cert": "",
|
|
"tls_key": "",
|
|
}
|
|
|
|
|
|
def load_settings() -> dict:
|
|
"""Load settings from disk, merging saved values over defaults.
|
|
|
|
Returns DEFAULT_SETTINGS if the file does not exist or contains corrupt JSON.
|
|
Unknown keys in the file are ignored.
|
|
"""
|
|
result = copy.deepcopy(DEFAULT_SETTINGS)
|
|
try:
|
|
text = SETTINGS_PATH.read_text()
|
|
data = json.loads(text)
|
|
for key in DEFAULT_SETTINGS:
|
|
if key in data:
|
|
result[key] = data[key]
|
|
except (FileNotFoundError, json.JSONDecodeError):
|
|
pass
|
|
if not result["device_name"]:
|
|
result["device_name"] = socket.gethostname()
|
|
return result
|
|
|
|
|
|
def save_settings(data: dict) -> None:
|
|
"""Save settings to disk, merging *data* with defaults first.
|
|
|
|
Creates parent directories as needed. Writes JSON with indent=2 and a
|
|
trailing newline.
|
|
"""
|
|
merged = copy.deepcopy(DEFAULT_SETTINGS)
|
|
for key in DEFAULT_SETTINGS:
|
|
if key in data:
|
|
merged[key] = data[key]
|
|
SETTINGS_PATH.parent.mkdir(parents=True, exist_ok=True)
|
|
SETTINGS_PATH.write_text(json.dumps(merged, indent=2) + "\n")
|
|
|
|
|
|
def patch_settings(patch: dict) -> dict:
|
|
"""Merge known keys from *patch* into the current settings, save, and return result.
|
|
|
|
Unknown keys in *patch* are silently ignored.
|
|
|
|
Key-preservation rule: when ``remote_instances`` is included in the patch,
|
|
any remote whose ``key`` field is empty or absent in the patch retains its
|
|
existing key from the on-disk settings. This prevents the redaction-wipe
|
|
bug where ``GET /api/settings`` returns ``key=""`` for security reasons and
|
|
a subsequent PATCH would silently overwrite real keys with empty strings.
|
|
Only a patch that supplies a *non-empty* key value is treated as an
|
|
intentional key rotation and actually written to disk.
|
|
"""
|
|
current = load_settings()
|
|
|
|
# Snapshot existing remote keys by URL *before* applying the patch so we
|
|
# can restore them if the patch contains redacted (empty) key values.
|
|
existing_remote_keys: dict[str, str] = {
|
|
r["url"]: r.get("key", "")
|
|
for r in current.get("remote_instances", [])
|
|
if r.get("url")
|
|
}
|
|
|
|
for key in DEFAULT_SETTINGS:
|
|
if key in patch:
|
|
current[key] = patch[key]
|
|
|
|
# Restore keys that were stripped by redaction.
|
|
if "remote_instances" in patch:
|
|
for remote in current["remote_instances"]:
|
|
url = remote.get("url", "")
|
|
if not remote.get("key") and url in existing_remote_keys:
|
|
remote["key"] = existing_remote_keys[url]
|
|
|
|
save_settings(current)
|
|
return current
|
|
|
|
|
|
def load_federation_key() -> str:
|
|
"""Load the federation key from disk or env-overridden path.
|
|
|
|
Reads from FEDERATION_KEY_PATH by default; override via
|
|
MUXPLEX_FEDERATION_KEY_FILE env var. Returns empty string when
|
|
the file does not exist.
|
|
"""
|
|
env_path = os.environ.get("MUXPLEX_FEDERATION_KEY_FILE")
|
|
path = Path(env_path) if env_path else FEDERATION_KEY_PATH
|
|
try:
|
|
return path.read_text().strip()
|
|
except FileNotFoundError:
|
|
return ""
|