roof
62b31b072b
Services are now installed post-setup from the Store page, so the wizard step that let users pre-select email/calendar/files is removed. Reduces wizard from 5 steps to 4 (Step4Services deleted, Step5Review renamed to Step4Review). Backend drops services_enabled validation, background install thread, and service_store_manager dependency. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
271 lines
11 KiB
Python
271 lines
11 KiB
Python
#!/usr/bin/env python3
|
|
"""
|
|
SetupManager — first-run wizard backend for PIC.
|
|
|
|
Handles validation, locking, and atomic completion of the initial setup
|
|
wizard. Called by api/routes/setup.py.
|
|
"""
|
|
|
|
import fcntl
|
|
import logging
|
|
import os
|
|
import re
|
|
from typing import Any, Dict, List
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
# Top 30 representative IANA time zones shown in the wizard
|
|
AVAILABLE_TIMEZONES = [
|
|
'UTC',
|
|
'America/New_York',
|
|
'America/Chicago',
|
|
'America/Denver',
|
|
'America/Los_Angeles',
|
|
'America/Anchorage',
|
|
'America/Honolulu',
|
|
'America/Sao_Paulo',
|
|
'America/Argentina/Buenos_Aires',
|
|
'America/Toronto',
|
|
'America/Vancouver',
|
|
'America/Mexico_City',
|
|
'Europe/London',
|
|
'Europe/Paris',
|
|
'Europe/Berlin',
|
|
'Europe/Madrid',
|
|
'Europe/Rome',
|
|
'Europe/Amsterdam',
|
|
'Europe/Moscow',
|
|
'Europe/Istanbul',
|
|
'Africa/Cairo',
|
|
'Africa/Johannesburg',
|
|
'Asia/Dubai',
|
|
'Asia/Kolkata',
|
|
'Asia/Bangkok',
|
|
'Asia/Shanghai',
|
|
'Asia/Tokyo',
|
|
'Asia/Seoul',
|
|
'Australia/Sydney',
|
|
'Pacific/Auckland',
|
|
]
|
|
|
|
AVAILABLE_SERVICES = [
|
|
'email',
|
|
'calendar',
|
|
'files',
|
|
'wireguard',
|
|
]
|
|
|
|
VALID_DOMAIN_MODES = {'pic_ngo', 'cloudflare', 'duckdns', 'http01', 'lan'}
|
|
|
|
CELL_NAME_RE = re.compile(r'^[a-z][a-z0-9-]{1,30}$')
|
|
|
|
|
|
DDNS_API_BASE = os.environ.get('DDNS_URL', 'https://ddns.pic.ngo/api/v1').rstrip('/').replace('/api/v1', '')
|
|
DDNS_TOTP_SECRET = os.environ.get('DDNS_TOTP_SECRET', '')
|
|
|
|
|
|
def _build_ddns_config(domain_mode: str, cloudflare_api_token: str = '',
|
|
duckdns_token: str = '', duckdns_subdomain: str = '') -> dict:
|
|
"""Return the top-level ddns config dict for a given domain mode."""
|
|
if domain_mode == 'pic_ngo':
|
|
return {
|
|
'provider': 'pic_ngo',
|
|
'api_base_url': DDNS_API_BASE,
|
|
'totp_secret': DDNS_TOTP_SECRET,
|
|
'enabled': True,
|
|
}
|
|
if domain_mode == 'cloudflare':
|
|
cfg = {'provider': 'cloudflare', 'enabled': True}
|
|
if cloudflare_api_token:
|
|
cfg['api_token'] = cloudflare_api_token
|
|
return cfg
|
|
if domain_mode == 'duckdns':
|
|
cfg = {'provider': 'duckdns', 'enabled': True}
|
|
if duckdns_token:
|
|
cfg['token'] = duckdns_token
|
|
if duckdns_subdomain:
|
|
cfg['subdomain'] = duckdns_subdomain
|
|
return cfg
|
|
if domain_mode == 'http01':
|
|
return {'provider': 'http01', 'enabled': True}
|
|
return {'provider': 'none', 'enabled': False}
|
|
|
|
|
|
class SetupManager:
|
|
"""Manages the first-run setup wizard state and completion."""
|
|
|
|
def __init__(self, config_manager, auth_manager):
|
|
self.config_manager = config_manager
|
|
self.auth_manager = auth_manager
|
|
|
|
# ── state helpers ─────────────────────────────────────────────────────
|
|
|
|
def is_setup_complete(self) -> bool:
|
|
"""Return True if setup has already been completed."""
|
|
return bool(self.config_manager.get_identity().get('setup_complete', False))
|
|
|
|
def get_setup_status(self) -> Dict[str, Any]:
|
|
"""Return current setup status, wizard metadata, and any pre-configured identity."""
|
|
identity = self.config_manager.get_identity()
|
|
preconfigured = {
|
|
k: v for k, v in {
|
|
'cell_name': identity.get('cell_name', ''),
|
|
'domain_mode': identity.get('domain_mode', ''),
|
|
'domain_name': identity.get('domain_name', ''),
|
|
'cloudflare_api_token': identity.get('cloudflare_api_token', ''),
|
|
'duckdns_token': identity.get('duckdns_token', ''),
|
|
}.items() if v
|
|
}
|
|
return {
|
|
'complete': self.is_setup_complete(),
|
|
'available_services': AVAILABLE_SERVICES,
|
|
'available_timezones': AVAILABLE_TIMEZONES,
|
|
'preconfigured': preconfigured,
|
|
}
|
|
|
|
# ── validation ────────────────────────────────────────────────────────
|
|
|
|
def validate_cell_name(self, name: str) -> List[str]:
|
|
"""Validate a proposed cell name. Returns a list of error strings."""
|
|
errors: List[str] = []
|
|
if not name:
|
|
errors.append('Cell name is required.')
|
|
return errors
|
|
if not CELL_NAME_RE.match(name):
|
|
errors.append(
|
|
'Cell name must start with a lowercase letter, be 2–31 characters, '
|
|
'and contain only lowercase letters, digits, and hyphens.'
|
|
)
|
|
if name.startswith('-') or name.endswith('-'):
|
|
errors.append('Cell name must not start or end with a hyphen.')
|
|
return errors
|
|
|
|
def validate_password(self, password: str) -> List[str]:
|
|
"""Validate admin password strength. Returns a list of error strings."""
|
|
errors: List[str] = []
|
|
if not password:
|
|
errors.append('Password is required.')
|
|
return errors
|
|
if len(password) < 12:
|
|
errors.append('Password must be at least 12 characters long.')
|
|
if not re.search(r'[A-Z]', password):
|
|
errors.append('Password must contain at least one uppercase letter.')
|
|
if not re.search(r'[a-z]', password):
|
|
errors.append('Password must contain at least one lowercase letter.')
|
|
if not re.search(r'\d', password):
|
|
errors.append('Password must contain at least one digit.')
|
|
return errors
|
|
|
|
# ── main completion ───────────────────────────────────────────────────
|
|
|
|
def complete_setup(self, payload: Dict[str, Any]) -> Dict[str, Any]:
|
|
"""Run all validation, then atomically complete the setup wizard.
|
|
|
|
Returns ``{'success': True, 'redirect': '/login'}`` on success or
|
|
``{'success': False, 'errors': [...]}`` on any failure.
|
|
"""
|
|
errors: List[str] = []
|
|
|
|
# ── validate inputs ────────────────────────────────────────────────
|
|
cell_name = payload.get('cell_name', '')
|
|
password = payload.get('password', '')
|
|
domain_mode = payload.get('domain_mode', '')
|
|
domain_name = payload.get('domain_name', '')
|
|
timezone = payload.get('timezone', '')
|
|
ddns_provider = payload.get('ddns_provider', 'none')
|
|
cloudflare_api_token = payload.get('cloudflare_api_token', '')
|
|
duckdns_token = payload.get('duckdns_token', '')
|
|
|
|
errors.extend(self.validate_cell_name(cell_name))
|
|
errors.extend(self.validate_password(password))
|
|
|
|
if domain_mode not in VALID_DOMAIN_MODES:
|
|
errors.append(
|
|
f"domain_mode must be one of: {', '.join(sorted(VALID_DOMAIN_MODES))}."
|
|
)
|
|
if not timezone or not isinstance(timezone, str):
|
|
errors.append('timezone is required.')
|
|
|
|
if errors:
|
|
return {'success': False, 'errors': errors}
|
|
|
|
# ── acquire file lock to prevent double-completion ─────────────────
|
|
lock_path = os.path.join(
|
|
os.environ.get('DATA_DIR', '/app/data'), 'api', '.setup.lock'
|
|
)
|
|
try:
|
|
os.makedirs(os.path.dirname(lock_path), exist_ok=True)
|
|
except OSError:
|
|
pass
|
|
|
|
try:
|
|
lock_fd = open(lock_path, 'w')
|
|
fcntl.flock(lock_fd, fcntl.LOCK_EX)
|
|
except OSError as exc:
|
|
logger.error(f'Could not acquire setup lock: {exc}')
|
|
return {'success': False, 'errors': ['Setup lock could not be acquired. Try again.']}
|
|
|
|
try:
|
|
# Re-check inside lock
|
|
if self.is_setup_complete():
|
|
return {'success': False, 'errors': ['Setup has already been completed.']}
|
|
|
|
# ── create or update admin user ────────────────────────────────
|
|
# The installer may have bootstrapped an admin account from a
|
|
# generated password. The wizard's job is to set the real password,
|
|
# so update it if the account already exists.
|
|
ok = self.auth_manager.create_user(
|
|
username='admin',
|
|
password=password,
|
|
role='admin',
|
|
)
|
|
if not ok:
|
|
ok = self.auth_manager.set_password_admin('admin', password)
|
|
if not ok:
|
|
return {'success': False, 'errors': ['Failed to set admin password.']}
|
|
|
|
# ── persist identity fields ────────────────────────────────────
|
|
self.config_manager.set_identity_field('cell_name', cell_name)
|
|
self.config_manager.set_identity_field('domain_mode', domain_mode)
|
|
if domain_name:
|
|
self.config_manager.set_identity_field('domain_name', domain_name)
|
|
self.config_manager.set_identity_field('timezone', timezone)
|
|
self.config_manager.set_identity_field('ddns_provider', ddns_provider)
|
|
if cloudflare_api_token:
|
|
self.config_manager.set_identity_field('cloudflare_api_token', cloudflare_api_token)
|
|
if duckdns_token:
|
|
self.config_manager.set_identity_field('duckdns_token', duckdns_token)
|
|
|
|
# ── write top-level ddns section so DDNSManager can find provider ──
|
|
duckdns_sub = domain_name.replace('.duckdns.org', '') if domain_mode == 'duckdns' else ''
|
|
ddns_cfg = _build_ddns_config(
|
|
domain_mode,
|
|
cloudflare_api_token=cloudflare_api_token,
|
|
duckdns_token=duckdns_token,
|
|
duckdns_subdomain=duckdns_sub,
|
|
)
|
|
self.config_manager.set_ddns_config(ddns_cfg)
|
|
|
|
# ── trigger DDNS registration for pic_ngo ─────────────────────────
|
|
if domain_mode == 'pic_ngo':
|
|
try:
|
|
from ddns_manager import DDNSManager
|
|
ddns_mgr = DDNSManager(self.config_manager)
|
|
ddns_mgr.register(cell_name, '')
|
|
logger.info(f'DDNS registered: {cell_name}.pic.ngo')
|
|
except Exception as exc:
|
|
logger.warning(f'DDNS registration failed (will retry at next heartbeat): {exc}')
|
|
|
|
# ── mark setup complete (must be last) ─────────────────────────
|
|
self.config_manager.set_identity_field('setup_complete', True)
|
|
|
|
logger.info(f"Setup completed. cell_name={cell_name!r}, domain_mode={domain_mode!r}")
|
|
return {'success': True, 'redirect': '/login'}
|
|
|
|
finally:
|
|
try:
|
|
fcntl.flock(lock_fd, fcntl.LOCK_UN)
|
|
lock_fd.close()
|
|
except Exception:
|
|
pass
|