Files
bambuddy/backend/app/services/virtual_printer/ftp_server.py
T
maziggy 82d329d85c [Fix] Virtual Printer FTP routed to wrong VP with different access codes (#735)
When running multiple virtual printers with different access codes on
  separate bind IPs, FTP connections were always routed to the wrong VP.

  Root cause: the iptables REDIRECT rule (990→9990) rewrites the
  destination IP to the incoming interface's primary address. With Linux's
  weak host model (arp_filter=0), packets for secondary IPs arrive on the
  primary interface, and REDIRECT sends them all to the first VP's FTP
  server. MQTT was unaffected because port 8883 had no redirect.

  Fix: FTP server now binds directly to port 990 (standard implicit FTPS),
  eliminating the iptables redirect entirely. Requires CAP_NET_BIND_SERVICE
  (already set in the systemd service file and Docker image).

  Also removed a global asyncio set_exception_handler() in the MQTT server
  that was overwritten by each VP instance, causing spurious "Unhandled
  exception in client_connected_cb" errors on startup.

  Changes:
  - FTP_PORT: 9990 → 990 (ftp_server.py)
  - Removed set_exception_handler() from MQTT server
  - Updated Dockerfile, docker-compose.yml port mappings
  - Deprecated --redirect-990 in install script
  - Updated wiki: removed iptables instructions for all platforms
  - Added migration guide (docs/migration-vp-ftp-port.md)
  - Added unit tests for port constant and no-global-state invariant
2026-03-18 09:04:31 +01:00

678 lines
25 KiB
Python

"""Implicit FTPS server for receiving 3MF uploads from slicers.
Implements an implicit FTPS server (TLS from byte 0) that accepts file uploads
from Bambu Studio and OrcaSlicer, matching the real Bambu printer behavior.
Unlike explicit FTPS (AUTH TLS), implicit FTPS wraps the connection in TLS
immediately upon connection, before any FTP commands are exchanged.
"""
import asyncio
import logging
import os
import random
import ssl
from collections.abc import Callable
from pathlib import Path
logger = logging.getLogger(__name__)
# Default FTP port for Bambu printers (implicit FTPS).
# Must be 990 (same as real printers) to avoid iptables REDIRECT,
# which rewrites the destination IP to the incoming interface's primary
# address — breaking multi-VP setups with different bind IPs.
# Requires CAP_NET_BIND_SERVICE or root.
FTP_PORT = 990
class FTPSession:
"""Handles a single FTP client session."""
def __init__(
self,
reader: asyncio.StreamReader,
writer: asyncio.StreamWriter,
upload_dir: Path,
access_code: str,
ssl_context: ssl.SSLContext,
on_file_received: Callable[[Path, str], None] | None,
passive_port_range: tuple[int, int] = (50000, 50100),
pasv_address: str = "",
bind_address: str = "0.0.0.0", # nosec B104
vp_name: str = "",
):
self.reader = reader
self.writer = writer
self.upload_dir = upload_dir
self.access_code = access_code
self.ssl_context = ssl_context
self.on_file_received = on_file_received
self.passive_port_range = passive_port_range
self.pasv_address = pasv_address
self.bind_address = bind_address
self.vp_name = vp_name
self._log_prefix = f"[{vp_name}] " if vp_name else ""
self.authenticated = False
self.username: str | None = None
self.current_dir = upload_dir
self.transfer_type = "A" # ASCII by default
self.data_server: asyncio.Server | None = None
self.data_port: int | None = None
# For data transfer coordination
self._data_reader: asyncio.StreamReader | None = None
self._data_writer: asyncio.StreamWriter | None = None
self._data_connected = asyncio.Event()
self._transfer_done = asyncio.Event()
peername = writer.get_extra_info("peername")
self.remote_ip = peername[0] if peername else "unknown"
async def send(self, code: int, message: str) -> None:
"""Send an FTP response."""
response = f"{code} {message}\r\n"
logger.debug("%sFTP -> %s: %s", self._log_prefix, self.remote_ip, response.strip())
self.writer.write(response.encode("utf-8"))
await self.writer.drain()
async def handle(self) -> None:
"""Handle the FTP session."""
try:
# Send welcome banner
await self.send(220, "Bambuddy Virtual Printer FTP ready")
while True:
try:
line = await asyncio.wait_for(
self.reader.readline(),
timeout=300, # 5 minute timeout
)
except TimeoutError:
logger.debug("%sFTP session timeout from %s", self._log_prefix, self.remote_ip)
break
if not line:
break
try:
command_line = line.decode("utf-8").strip()
except UnicodeDecodeError:
command_line = line.decode("latin-1").strip()
if not command_line:
continue
# Never log passwords
if command_line.upper().startswith("PASS"):
logger.debug("%sFTP <- %s: PASS ********", self._log_prefix, self.remote_ip)
else:
logger.debug("%sFTP <- %s: %s", self._log_prefix, self.remote_ip, command_line)
# Parse command and argument
parts = command_line.split(" ", 1)
cmd = parts[0].upper()
arg = parts[1] if len(parts) > 1 else ""
# Dispatch command
handler = getattr(self, f"cmd_{cmd}", None)
if handler:
await handler(arg)
else:
logger.debug("%sFTP command not implemented: %s", self._log_prefix, cmd)
await self.send(502, f"Command {cmd} not implemented")
except asyncio.CancelledError:
logger.info("%sFTP session cancelled from %s", self._log_prefix, self.remote_ip)
except Exception as e:
logger.error("%sFTP session error from %s: %s", self._log_prefix, self.remote_ip, e)
finally:
logger.info("%sFTP session ended from %s", self._log_prefix, self.remote_ip)
await self._cleanup()
async def _cleanup(self) -> None:
"""Clean up session resources."""
# Release any waiting data connection callback
self._transfer_done.set()
if self.data_server:
self.data_server.close()
try:
await self.data_server.wait_closed()
except OSError:
pass # Best-effort data server cleanup; may already be closed
self.data_server = None
try:
self.writer.close()
await self.writer.wait_closed()
except OSError:
pass # Best-effort control connection cleanup; client may have disconnected
# FTP Commands
async def cmd_USER(self, arg: str) -> None:
"""Handle USER command."""
self.username = arg
if arg.lower() == "bblp":
await self.send(331, "Password required")
else:
await self.send(530, "Invalid user")
async def cmd_PASS(self, arg: str) -> None:
"""Handle PASS command."""
if self.username and self.username.lower() == "bblp":
if arg == self.access_code:
self.authenticated = True
await self.send(230, "Login successful")
logger.info("%sFTP login from %s", self._log_prefix, self.remote_ip)
else:
await self.send(530, "Login incorrect")
logger.warning("%sFTP failed login from %s (access code mismatch)", self._log_prefix, self.remote_ip)
else:
await self.send(503, "Login with USER first")
async def cmd_SYST(self, arg: str) -> None:
"""Handle SYST command."""
await self.send(215, "UNIX Type: L8")
async def cmd_FEAT(self, arg: str) -> None:
"""Handle FEAT command."""
features = [
"211-Features:",
" PASV",
" EPSV",
" UTF8",
" SIZE",
"211 End",
]
for line in features[:-1]:
self.writer.write(f"{line}\r\n".encode())
await self.writer.drain()
self.writer.write(f"{features[-1]}\r\n".encode())
await self.writer.drain()
async def cmd_PWD(self, arg: str) -> None:
"""Handle PWD command."""
if not self.authenticated:
await self.send(530, "Not logged in")
return
await self.send(257, '"/" is current directory')
async def cmd_CWD(self, arg: str) -> None:
"""Handle CWD command."""
if not self.authenticated:
await self.send(530, "Not logged in")
return
# Accept any directory change (we use a flat structure)
await self.send(250, "Directory changed")
async def cmd_TYPE(self, arg: str) -> None:
"""Handle TYPE command."""
if not self.authenticated:
await self.send(530, "Not logged in")
return
if arg.upper() in ("A", "I"):
self.transfer_type = arg.upper()
type_name = "ASCII" if arg.upper() == "A" else "Binary"
await self.send(200, f"Type set to {type_name}")
else:
await self.send(504, "Type not supported")
async def _bind_passive_port(self) -> bool:
"""Try to bind a passive data port with retries.
Returns True if a port was successfully bound, False otherwise.
Sets self.data_server and self.data_port on success.
"""
port_min, port_max = self.passive_port_range
for attempt in range(10):
port = random.randint(port_min, port_max)
try:
self.data_server = await asyncio.start_server(
self._handle_data_connection,
self.bind_address,
port,
ssl=self.ssl_context,
)
self.data_port = port
return True
except OSError:
logger.debug("FTP passive port %s in use, retrying (%s/10)", port, attempt + 1)
return False
async def cmd_EPSV(self, arg: str) -> None:
"""Handle EPSV command - Extended Passive Mode (IPv6 compatible)."""
if not self.authenticated:
await self.send(530, "Not logged in")
return
# Close any existing data connection/server
await self._close_data_connection()
# Reset connection state for the new transfer
self._data_connected.clear()
self._data_reader = None
self._data_writer = None
self._transfer_done = asyncio.Event()
if await self._bind_passive_port():
# EPSV response format: 229 Entering Extended Passive Mode (|||port|)
await self.send(229, f"Entering Extended Passive Mode (|||{self.data_port}|)")
logger.info("FTP EPSV listening on port %s", self.data_port)
else:
logger.error("Failed to bind any passive port for EPSV")
await self.send(425, "Cannot open data connection")
async def cmd_PASV(self, arg: str) -> None:
"""Handle PASV command - set up passive data connection."""
if not self.authenticated:
await self.send(530, "Not logged in")
return
# Close any existing data connection/server
await self._close_data_connection()
# Reset connection state for the new transfer
self._data_connected.clear()
self._data_reader = None
self._data_writer = None
self._transfer_done = asyncio.Event()
if await self._bind_passive_port():
# Determine the IP to advertise in PASV response
if self.pasv_address:
# Explicit override (e.g., for Docker bridge mode behind NAT)
ip = self.pasv_address
else:
# Use the local IP of the control connection
sockname = self.writer.get_extra_info("sockname")
ip = sockname[0] if sockname else "127.0.0.1"
# 0.0.0.0 is not routable — fall back to control connection IP
if ip == "0.0.0.0": # nosec B104
ip = "127.0.0.1"
# Format IP and port for PASV response
ip_parts = ip.split(".")
port_hi = self.data_port // 256
port_lo = self.data_port % 256
await self.send(
227,
f"Entering Passive Mode ({ip_parts[0]},{ip_parts[1]},{ip_parts[2]},{ip_parts[3]},{port_hi},{port_lo})",
)
logger.info("FTP PASV listening on %s:%s", ip, self.data_port)
else:
logger.error("Failed to bind any passive port for PASV")
await self.send(425, "Cannot open data connection")
async def _handle_data_connection(self, reader: asyncio.StreamReader, writer: asyncio.StreamWriter) -> None:
"""Handle incoming data connection (used by PASV/EPSV).
This callback stays alive until the transfer completes to ensure the
asyncio task holds strong references to the reader/writer throughout
the data transfer. If the callback returned immediately, the task
would complete and the StreamReaderProtocol could release its strong
reader reference, potentially destabilising the connection.
"""
# Reject duplicate connections — only one data connection per transfer
if self._data_reader is not None:
logger.warning("FTP rejecting duplicate data connection from %s", self.remote_ip)
try:
writer.close()
await writer.wait_closed()
except OSError:
pass
return
# Log TLS details for debugging
ssl_obj = writer.get_extra_info("ssl_object")
if ssl_obj:
logger.info(
f"FTP data TLS from {self.remote_ip}: cipher={ssl_obj.cipher()}, "
f"version={ssl_obj.version()}, session_reused={ssl_obj.session_reused}"
)
else:
logger.warning("FTP data connection from %s has no SSL!", self.remote_ip)
logger.info("FTP data connection established from %s", self.remote_ip)
self._data_reader = reader
self._data_writer = writer
# Stop accepting further connections on the passive port
if self.data_server:
self.data_server.close()
self._data_connected.set()
# Keep this callback alive until the transfer command (STOR/RETR)
# finishes. This ensures the asyncio server-handler task holds strong
# references to reader/writer for the entire transfer lifetime.
await self._transfer_done.wait()
async def _close_data_connection(self) -> None:
"""Close the data connection and server."""
had_connection = self._data_writer is not None or self.data_server is not None
# Signal the _handle_data_connection callback to return, allowing
# its asyncio task to complete cleanly.
self._transfer_done.set()
if self._data_writer:
try:
self._data_writer.close()
await self._data_writer.wait_closed()
except OSError:
pass # Best-effort data writer cleanup; peer may have closed already
self._data_writer = None
self._data_reader = None
if self.data_server:
try:
self.data_server.close()
await self.data_server.wait_closed()
except OSError:
pass # Best-effort data server shutdown; port may already be released
self.data_server = None
# Only delay if we actually closed something
if had_connection:
await asyncio.sleep(0.1)
async def cmd_STOR(self, arg: str) -> None:
"""Handle STOR command - receive file upload."""
if not self.authenticated:
await self.send(530, "Not logged in")
return
if not self.data_server and not self._data_connected.is_set():
await self.send(425, "Use PASV first")
return
filename = Path(arg).name # Sanitize filename
file_path = self.upload_dir / filename
logger.info("FTP receiving file: %s from %s", filename, self.remote_ip)
await self.send(150, f"Opening data connection for {filename}")
# Wait for data connection to be established (client connects after 150)
try:
await asyncio.wait_for(self._data_connected.wait(), timeout=30)
except TimeoutError:
logger.error("FTP data connection timeout - client didn't connect")
await self.send(425, "Data connection timeout")
await self._close_data_connection()
return
if not self._data_reader:
await self.send(425, "Data connection failed")
await self._close_data_connection()
return
# Receive data
data_content: list[bytes] = []
total_received = 0
try:
while True:
chunk = await asyncio.wait_for(self._data_reader.read(65536), timeout=60)
if not chunk:
break
data_content.append(chunk)
total_received += len(chunk)
logger.debug("FTP received chunk: %s bytes (total: %s)", len(chunk), total_received)
except TimeoutError:
logger.error("FTP data transfer timeout after %s bytes for %s", total_received, filename)
await self.send(426, "Transfer timeout")
await self._close_data_connection()
return
except Exception as e:
logger.error(
"FTP data transfer error after %s bytes for %s: %s(%s)",
total_received,
filename,
type(e).__name__,
e,
)
await self.send(426, f"Transfer failed: {e}")
await self._close_data_connection()
return
# Close data connection
await self._close_data_connection()
# Write file
try:
total_size = sum(len(c) for c in data_content)
file_path.write_bytes(b"".join(data_content))
logger.info("FTP saved file: %s (%s bytes)", file_path, total_size)
await self.send(226, "Transfer complete")
# Notify callback
if self.on_file_received:
try:
result = self.on_file_received(file_path, self.remote_ip)
if asyncio.iscoroutine(result):
await result
except Exception as e:
logger.error("File received callback error: %s", e)
except Exception as e:
logger.error("Failed to save file %s: %s", file_path, e)
await self.send(550, "Failed to save file")
async def cmd_SIZE(self, arg: str) -> None:
"""Handle SIZE command."""
if not self.authenticated:
await self.send(530, "Not logged in")
return
# We don't store files for SIZE queries
await self.send(550, "File not found")
async def cmd_QUIT(self, arg: str) -> None:
"""Handle QUIT command."""
await self.send(221, "Goodbye")
raise asyncio.CancelledError()
async def cmd_NOOP(self, arg: str) -> None:
"""Handle NOOP command."""
await self.send(200, "OK")
async def cmd_OPTS(self, arg: str) -> None:
"""Handle OPTS command."""
if arg.upper().startswith("UTF8"):
await self.send(200, "UTF8 mode enabled")
else:
await self.send(501, "Option not supported")
async def cmd_PBSZ(self, arg: str) -> None:
"""Handle PBSZ (Protection Buffer Size) command.
Required for FTP security extensions. With TLS, buffer size is 0.
"""
await self.send(200, "PBSZ=0")
async def cmd_PROT(self, arg: str) -> None:
"""Handle PROT (Data Channel Protection Level) command.
P = Private (encrypted), which we always use with implicit FTPS.
"""
if arg.upper() == "P":
await self.send(200, "Protection level set to Private")
elif arg.upper() == "C":
# Clear (unprotected) - we don't support this
await self.send(536, "Protection level C not supported")
else:
await self.send(504, f"Protection level {arg} not supported")
async def cmd_MKD(self, arg: str) -> None:
"""Handle MKD (Make Directory) command."""
if not self.authenticated:
await self.send(530, "Not logged in")
return
# We don't really create directories, just pretend it works
await self.send(257, f'"{arg}" directory created')
async def cmd_LIST(self, arg: str) -> None:
"""Handle LIST command - list directory contents."""
if not self.authenticated:
await self.send(530, "Not logged in")
return
# We don't support listing, return empty
await self.send(150, "Opening data connection")
await self.send(226, "Transfer complete")
class VirtualPrinterFTPServer:
"""Implicit FTPS server that accepts uploads from slicers."""
PASSIVE_PORT_MIN = 50000
PASSIVE_PORT_MAX = 50100
def __init__(
self,
upload_dir: Path,
access_code: str,
cert_path: Path,
key_path: Path,
port: int = FTP_PORT,
on_file_received: Callable[[Path, str], None] | None = None,
bind_address: str = "0.0.0.0", # nosec B104
vp_name: str = "",
):
"""Initialize the FTPS server.
Args:
upload_dir: Directory to store uploaded files
access_code: Password for authentication (bblp user)
cert_path: Path to TLS certificate file
key_path: Path to TLS private key file
port: Port to listen on (default 990)
on_file_received: Callback when file upload completes (path, source_ip)
bind_address: IP address to bind to (default 0.0.0.0)
vp_name: Virtual printer name for log identification
"""
self.upload_dir = upload_dir
self.access_code = access_code
self.cert_path = cert_path
self.key_path = key_path
self.port = port
self.on_file_received = on_file_received
self.bind_address = bind_address
self.vp_name = vp_name
self._server: asyncio.Server | None = None
self._running = False
self._ssl_context: ssl.SSLContext | None = None
self._active_sessions: list[asyncio.Task] = []
# Override PASV response IP for Docker bridge mode / NAT environments
self._pasv_address = os.environ.get("VIRTUAL_PRINTER_PASV_ADDRESS", "")
async def start(self) -> None:
"""Start the implicit FTPS server."""
if self._running:
return
logger.info("[%s] Starting virtual printer implicit FTPS on %s:%s", self.vp_name, self.bind_address, self.port)
# Ensure upload directory exists
self.upload_dir.mkdir(parents=True, exist_ok=True)
cache_dir = self.upload_dir / "cache"
cache_dir.mkdir(exist_ok=True)
# Create SSL context for implicit FTPS (TLS from byte 0)
self._ssl_context = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
self._ssl_context.load_cert_chain(str(self.cert_path), str(self.key_path))
self._ssl_context.minimum_version = ssl.TLSVersion.TLSv1_2
self._ssl_context.maximum_version = ssl.TLSVersion.TLSv1_2
# Use standard TLS settings for compatibility
self._ssl_context.set_ciphers("HIGH:!aNULL:!MD5:!RC4")
logger.info("FTP SSL context created with standard settings")
try:
# Create server with SSL - TLS handshake happens before any FTP data
self._server = await asyncio.start_server(
self._handle_client,
self.bind_address,
self.port,
ssl=self._ssl_context, # This makes it implicit FTPS!
)
self._running = True
logger.info("Implicit FTPS server started on port %s", self.port)
logger.info(
"FTP passive data port range: %s-%s",
self.PASSIVE_PORT_MIN,
self.PASSIVE_PORT_MAX,
)
if self._pasv_address:
logger.info("FTP PASV address override: %s", self._pasv_address)
async with self._server:
await self._server.serve_forever()
except OSError as e:
if e.errno == 98: # Address already in use
logger.error("FTP port %s is already in use", self.port)
else:
logger.error("FTP server error: %s", e)
except asyncio.CancelledError:
logger.debug("FTP server task cancelled")
except Exception as e:
logger.error("FTP server error: %s", e)
finally:
await self.stop()
async def _handle_client(self, reader: asyncio.StreamReader, writer: asyncio.StreamWriter) -> None:
"""Handle a new FTP client connection."""
peername = writer.get_extra_info("peername")
log_prefix = f"[{self.vp_name}] " if self.vp_name else ""
logger.info("%sFTP connection from %s", log_prefix, peername)
session = FTPSession(
reader=reader,
writer=writer,
upload_dir=self.upload_dir,
access_code=self.access_code,
ssl_context=self._ssl_context,
on_file_received=self.on_file_received,
passive_port_range=(self.PASSIVE_PORT_MIN, self.PASSIVE_PORT_MAX),
pasv_address=self._pasv_address,
bind_address=self.bind_address,
vp_name=self.vp_name,
)
# Track the session task so we can cancel it on stop
task = asyncio.current_task()
if task:
self._active_sessions.append(task)
try:
await session.handle()
finally:
if task and task in self._active_sessions:
self._active_sessions.remove(task)
async def stop(self) -> None:
"""Stop the FTPS server."""
logger.info("Stopping FTP server")
self._running = False
# Cancel all active sessions first
for task in self._active_sessions[:]: # Copy list to avoid modification during iteration
task.cancel()
# Wait briefly for sessions to clean up
if self._active_sessions:
await asyncio.sleep(0.1)
self._active_sessions.clear()
if self._server:
try:
self._server.close()
await self._server.wait_closed()
except OSError as e:
logger.debug("Error closing FTP server: %s", e)
self._server = None