Files
bambuddy/backend/app/services/virtual_printer/ftp_server.py
T
maziggy 88e84ca45a - Add Virtual Printer feature - emulate Bambu printer on network
- Virtual printer appears in Bambu Studio/Orca Slicer via SSDP discovery
  - Secure TLS/MQTT communication with auto-generated certificates
  - Queue mode (pending uploads) or auto-start mode
  - Configurable access code for authentication
  - Docker support with network_mode: host and certificate persistence
  - Fix backup/restore for virtual printer settings (auto-save no longer overwrites)
2025-12-29 15:52:48 +01:00

512 lines
18 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 random
import ssl
from collections.abc import Callable
from pathlib import Path
logger = logging.getLogger(__name__)
# Default FTP port for Bambu printers (implicit FTPS)
FTP_PORT = 9990
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,
):
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.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()
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.info(f"FTP -> {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(f"FTP session timeout from {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
logger.info(f"FTP <- {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.warning(f"FTP command not implemented: {cmd}")
await self.send(502, f"Command {cmd} not implemented")
except asyncio.CancelledError:
logger.info(f"FTP session cancelled from {self.remote_ip}")
except Exception as e:
logger.error(f"FTP session error from {self.remote_ip}: {e}")
finally:
logger.info(f"FTP session ended from {self.remote_ip}")
await self._cleanup()
async def _cleanup(self) -> None:
"""Clean up session resources."""
if self.data_server:
self.data_server.close()
try:
await self.data_server.wait_closed()
except Exception:
pass
self.data_server = None
try:
self.writer.close()
await self.writer.wait_closed()
except Exception:
pass
# 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(f"FTP login from {self.remote_ip}")
else:
await self.send(530, "Login incorrect")
logger.warning(f"FTP failed login from {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",
" 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 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
self._data_connected.clear()
self._data_reader = None
self._data_writer = None
# Find a free port for passive data connection
self.data_port = random.randint(50000, 60000)
try:
# Create data server with TLS
self.data_server = await asyncio.start_server(
self._handle_data_connection,
"0.0.0.0",
self.data_port,
ssl=self.ssl_context,
)
# Get server's IP for response
# Use the IP the client connected to
sockname = self.writer.get_extra_info("sockname")
ip = sockname[0] if sockname else "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(f"FTP PASV listening on port {self.data_port}")
except Exception as e:
logger.error(f"Failed to create passive data connection: {e}")
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)."""
logger.info(f"FTP data connection established from {self.remote_ip}")
self._data_reader = reader
self._data_writer = writer
self._data_connected.set()
# Don't close - let the transfer command handle it
async def _close_data_connection(self) -> None:
"""Close the data connection and server."""
if self._data_writer:
try:
self._data_writer.close()
await self._data_writer.wait_closed()
except Exception:
pass
self._data_writer = None
self._data_reader = None
if self.data_server:
try:
self.data_server.close()
await self.data_server.wait_closed()
except Exception:
pass
self.data_server = None
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:
await self.send(425, "Use PASV first")
return
filename = Path(arg).name # Sanitize filename
file_path = self.upload_dir / filename
logger.info(f"FTP receiving file: {filename} from {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] = []
try:
while True:
chunk = await asyncio.wait_for(self._data_reader.read(65536), timeout=60)
if not chunk:
break
data_content.append(chunk)
logger.debug(f"FTP received chunk: {len(chunk)} bytes")
except TimeoutError:
logger.error("FTP data transfer timeout")
await self.send(426, "Transfer timeout")
await self._close_data_connection()
return
except Exception as e:
logger.error(f"FTP data transfer error: {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(f"FTP saved file: {file_path} ({total_size} bytes)")
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(f"File received callback error: {e}")
except Exception as e:
logger.error(f"Failed to save file {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."""
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,
):
"""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)
"""
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._server: asyncio.Server | None = None
self._running = False
self._ssl_context: ssl.SSLContext | None = None
async def start(self) -> None:
"""Start the implicit FTPS server."""
if self._running:
return
logger.info(f"Starting virtual printer implicit FTPS on port {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
try:
# Create server with SSL - TLS handshake happens before any FTP data
self._server = await asyncio.start_server(
self._handle_client,
"0.0.0.0",
self.port,
ssl=self._ssl_context, # This makes it implicit FTPS!
)
self._running = True
logger.info(f"Implicit FTPS server started on port {self.port}")
async with self._server:
await self._server.serve_forever()
except OSError as e:
if e.errno == 98: # Address already in use
logger.error(f"FTP port {self.port} is already in use")
else:
logger.error(f"FTP server error: {e}")
except asyncio.CancelledError:
logger.debug("FTP server task cancelled")
except Exception as e:
logger.error(f"FTP server error: {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")
logger.info(f"FTP connection from {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,
)
await session.handle()
async def stop(self) -> None:
"""Stop the FTPS server."""
logger.info("Stopping FTP server")
self._running = False
if self._server:
try:
self._server.close()
await self._server.wait_closed()
except Exception as e:
logger.debug(f"Error closing FTP server: {e}")
self._server = None