ftp_server.py 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655
  1. """Implicit FTPS server for receiving 3MF uploads from slicers.
  2. Implements an implicit FTPS server (TLS from byte 0) that accepts file uploads
  3. from Bambu Studio and OrcaSlicer, matching the real Bambu printer behavior.
  4. Unlike explicit FTPS (AUTH TLS), implicit FTPS wraps the connection in TLS
  5. immediately upon connection, before any FTP commands are exchanged.
  6. """
  7. import asyncio
  8. import logging
  9. import os
  10. import random
  11. import ssl
  12. from collections.abc import Callable
  13. from pathlib import Path
  14. logger = logging.getLogger(__name__)
  15. # Default FTP port for Bambu printers (implicit FTPS)
  16. FTP_PORT = 9990
  17. class FTPSession:
  18. """Handles a single FTP client session."""
  19. def __init__(
  20. self,
  21. reader: asyncio.StreamReader,
  22. writer: asyncio.StreamWriter,
  23. upload_dir: Path,
  24. access_code: str,
  25. ssl_context: ssl.SSLContext,
  26. on_file_received: Callable[[Path, str], None] | None,
  27. passive_port_range: tuple[int, int] = (50000, 50100),
  28. pasv_address: str = "",
  29. ):
  30. self.reader = reader
  31. self.writer = writer
  32. self.upload_dir = upload_dir
  33. self.access_code = access_code
  34. self.ssl_context = ssl_context
  35. self.on_file_received = on_file_received
  36. self.passive_port_range = passive_port_range
  37. self.pasv_address = pasv_address
  38. self.authenticated = False
  39. self.username: str | None = None
  40. self.current_dir = upload_dir
  41. self.transfer_type = "A" # ASCII by default
  42. self.data_server: asyncio.Server | None = None
  43. self.data_port: int | None = None
  44. # For data transfer coordination
  45. self._data_reader: asyncio.StreamReader | None = None
  46. self._data_writer: asyncio.StreamWriter | None = None
  47. self._data_connected = asyncio.Event()
  48. self._transfer_done = asyncio.Event()
  49. peername = writer.get_extra_info("peername")
  50. self.remote_ip = peername[0] if peername else "unknown"
  51. async def send(self, code: int, message: str) -> None:
  52. """Send an FTP response."""
  53. response = f"{code} {message}\r\n"
  54. logger.info("FTP -> %s: %s", self.remote_ip, response.strip())
  55. self.writer.write(response.encode("utf-8"))
  56. await self.writer.drain()
  57. async def handle(self) -> None:
  58. """Handle the FTP session."""
  59. try:
  60. # Send welcome banner
  61. await self.send(220, "Bambuddy Virtual Printer FTP ready")
  62. while True:
  63. try:
  64. line = await asyncio.wait_for(
  65. self.reader.readline(),
  66. timeout=300, # 5 minute timeout
  67. )
  68. except TimeoutError:
  69. logger.debug("FTP session timeout from %s", self.remote_ip)
  70. break
  71. if not line:
  72. break
  73. try:
  74. command_line = line.decode("utf-8").strip()
  75. except UnicodeDecodeError:
  76. command_line = line.decode("latin-1").strip()
  77. if not command_line:
  78. continue
  79. logger.info("FTP <- %s: %s", self.remote_ip, command_line)
  80. # Parse command and argument
  81. parts = command_line.split(" ", 1)
  82. cmd = parts[0].upper()
  83. arg = parts[1] if len(parts) > 1 else ""
  84. # Dispatch command
  85. handler = getattr(self, f"cmd_{cmd}", None)
  86. if handler:
  87. await handler(arg)
  88. else:
  89. logger.warning("FTP command not implemented: %s", cmd)
  90. await self.send(502, f"Command {cmd} not implemented")
  91. except asyncio.CancelledError:
  92. logger.info("FTP session cancelled from %s", self.remote_ip)
  93. except Exception as e:
  94. logger.error("FTP session error from %s: %s", self.remote_ip, e)
  95. finally:
  96. logger.info("FTP session ended from %s", self.remote_ip)
  97. await self._cleanup()
  98. async def _cleanup(self) -> None:
  99. """Clean up session resources."""
  100. # Release any waiting data connection callback
  101. self._transfer_done.set()
  102. if self.data_server:
  103. self.data_server.close()
  104. try:
  105. await self.data_server.wait_closed()
  106. except OSError:
  107. pass # Best-effort data server cleanup; may already be closed
  108. self.data_server = None
  109. try:
  110. self.writer.close()
  111. await self.writer.wait_closed()
  112. except OSError:
  113. pass # Best-effort control connection cleanup; client may have disconnected
  114. # FTP Commands
  115. async def cmd_USER(self, arg: str) -> None:
  116. """Handle USER command."""
  117. self.username = arg
  118. if arg.lower() == "bblp":
  119. await self.send(331, "Password required")
  120. else:
  121. await self.send(530, "Invalid user")
  122. async def cmd_PASS(self, arg: str) -> None:
  123. """Handle PASS command."""
  124. if self.username and self.username.lower() == "bblp":
  125. if arg == self.access_code:
  126. self.authenticated = True
  127. await self.send(230, "Login successful")
  128. logger.info("FTP login from %s", self.remote_ip)
  129. else:
  130. await self.send(530, "Login incorrect")
  131. logger.warning("FTP failed login from %s", self.remote_ip)
  132. else:
  133. await self.send(503, "Login with USER first")
  134. async def cmd_SYST(self, arg: str) -> None:
  135. """Handle SYST command."""
  136. await self.send(215, "UNIX Type: L8")
  137. async def cmd_FEAT(self, arg: str) -> None:
  138. """Handle FEAT command."""
  139. features = [
  140. "211-Features:",
  141. " PASV",
  142. " EPSV",
  143. " UTF8",
  144. " SIZE",
  145. "211 End",
  146. ]
  147. for line in features[:-1]:
  148. self.writer.write(f"{line}\r\n".encode())
  149. await self.writer.drain()
  150. self.writer.write(f"{features[-1]}\r\n".encode())
  151. await self.writer.drain()
  152. async def cmd_PWD(self, arg: str) -> None:
  153. """Handle PWD command."""
  154. if not self.authenticated:
  155. await self.send(530, "Not logged in")
  156. return
  157. await self.send(257, '"/" is current directory')
  158. async def cmd_CWD(self, arg: str) -> None:
  159. """Handle CWD command."""
  160. if not self.authenticated:
  161. await self.send(530, "Not logged in")
  162. return
  163. # Accept any directory change (we use a flat structure)
  164. await self.send(250, "Directory changed")
  165. async def cmd_TYPE(self, arg: str) -> None:
  166. """Handle TYPE command."""
  167. if not self.authenticated:
  168. await self.send(530, "Not logged in")
  169. return
  170. if arg.upper() in ("A", "I"):
  171. self.transfer_type = arg.upper()
  172. type_name = "ASCII" if arg.upper() == "A" else "Binary"
  173. await self.send(200, f"Type set to {type_name}")
  174. else:
  175. await self.send(504, "Type not supported")
  176. async def _bind_passive_port(self) -> bool:
  177. """Try to bind a passive data port with retries.
  178. Returns True if a port was successfully bound, False otherwise.
  179. Sets self.data_server and self.data_port on success.
  180. """
  181. port_min, port_max = self.passive_port_range
  182. for attempt in range(10):
  183. port = random.randint(port_min, port_max)
  184. try:
  185. self.data_server = await asyncio.start_server(
  186. self._handle_data_connection,
  187. "0.0.0.0", # nosec B104
  188. port,
  189. ssl=self.ssl_context,
  190. )
  191. self.data_port = port
  192. return True
  193. except OSError:
  194. logger.debug("FTP passive port %s in use, retrying (%s/10)", port, attempt + 1)
  195. return False
  196. async def cmd_EPSV(self, arg: str) -> None:
  197. """Handle EPSV command - Extended Passive Mode (IPv6 compatible)."""
  198. if not self.authenticated:
  199. await self.send(530, "Not logged in")
  200. return
  201. # Close any existing data connection/server
  202. await self._close_data_connection()
  203. # Reset connection state for the new transfer
  204. self._data_connected.clear()
  205. self._data_reader = None
  206. self._data_writer = None
  207. self._transfer_done = asyncio.Event()
  208. if await self._bind_passive_port():
  209. # EPSV response format: 229 Entering Extended Passive Mode (|||port|)
  210. await self.send(229, f"Entering Extended Passive Mode (|||{self.data_port}|)")
  211. logger.info("FTP EPSV listening on port %s", self.data_port)
  212. else:
  213. logger.error("Failed to bind any passive port for EPSV")
  214. await self.send(425, "Cannot open data connection")
  215. async def cmd_PASV(self, arg: str) -> None:
  216. """Handle PASV command - set up passive data connection."""
  217. if not self.authenticated:
  218. await self.send(530, "Not logged in")
  219. return
  220. # Close any existing data connection/server
  221. await self._close_data_connection()
  222. # Reset connection state for the new transfer
  223. self._data_connected.clear()
  224. self._data_reader = None
  225. self._data_writer = None
  226. self._transfer_done = asyncio.Event()
  227. if await self._bind_passive_port():
  228. # Determine the IP to advertise in PASV response
  229. if self.pasv_address:
  230. # Explicit override (e.g., for Docker bridge mode behind NAT)
  231. ip = self.pasv_address
  232. else:
  233. # Use the local IP of the control connection
  234. sockname = self.writer.get_extra_info("sockname")
  235. ip = sockname[0] if sockname else "127.0.0.1"
  236. # 0.0.0.0 is not routable — fall back to control connection IP
  237. if ip == "0.0.0.0": # nosec B104
  238. ip = "127.0.0.1"
  239. # Format IP and port for PASV response
  240. ip_parts = ip.split(".")
  241. port_hi = self.data_port // 256
  242. port_lo = self.data_port % 256
  243. await self.send(
  244. 227,
  245. f"Entering Passive Mode ({ip_parts[0]},{ip_parts[1]},{ip_parts[2]},{ip_parts[3]},{port_hi},{port_lo})",
  246. )
  247. logger.info("FTP PASV listening on %s:%s", ip, self.data_port)
  248. else:
  249. logger.error("Failed to bind any passive port for PASV")
  250. await self.send(425, "Cannot open data connection")
  251. async def _handle_data_connection(self, reader: asyncio.StreamReader, writer: asyncio.StreamWriter) -> None:
  252. """Handle incoming data connection (used by PASV/EPSV).
  253. This callback stays alive until the transfer completes to ensure the
  254. asyncio task holds strong references to the reader/writer throughout
  255. the data transfer. If the callback returned immediately, the task
  256. would complete and the StreamReaderProtocol could release its strong
  257. reader reference, potentially destabilising the connection.
  258. """
  259. # Reject duplicate connections — only one data connection per transfer
  260. if self._data_reader is not None:
  261. logger.warning("FTP rejecting duplicate data connection from %s", self.remote_ip)
  262. try:
  263. writer.close()
  264. await writer.wait_closed()
  265. except OSError:
  266. pass
  267. return
  268. # Log TLS details for debugging
  269. ssl_obj = writer.get_extra_info("ssl_object")
  270. if ssl_obj:
  271. logger.info(
  272. f"FTP data TLS from {self.remote_ip}: cipher={ssl_obj.cipher()}, "
  273. f"version={ssl_obj.version()}, session_reused={ssl_obj.session_reused}"
  274. )
  275. else:
  276. logger.warning("FTP data connection from %s has no SSL!", self.remote_ip)
  277. logger.info("FTP data connection established from %s", self.remote_ip)
  278. self._data_reader = reader
  279. self._data_writer = writer
  280. # Stop accepting further connections on the passive port
  281. if self.data_server:
  282. self.data_server.close()
  283. self._data_connected.set()
  284. # Keep this callback alive until the transfer command (STOR/RETR)
  285. # finishes. This ensures the asyncio server-handler task holds strong
  286. # references to reader/writer for the entire transfer lifetime.
  287. await self._transfer_done.wait()
  288. async def _close_data_connection(self) -> None:
  289. """Close the data connection and server."""
  290. had_connection = self._data_writer is not None or self.data_server is not None
  291. # Signal the _handle_data_connection callback to return, allowing
  292. # its asyncio task to complete cleanly.
  293. self._transfer_done.set()
  294. if self._data_writer:
  295. try:
  296. self._data_writer.close()
  297. await self._data_writer.wait_closed()
  298. except OSError:
  299. pass # Best-effort data writer cleanup; peer may have closed already
  300. self._data_writer = None
  301. self._data_reader = None
  302. if self.data_server:
  303. try:
  304. self.data_server.close()
  305. await self.data_server.wait_closed()
  306. except OSError:
  307. pass # Best-effort data server shutdown; port may already be released
  308. self.data_server = None
  309. # Only delay if we actually closed something
  310. if had_connection:
  311. await asyncio.sleep(0.1)
  312. async def cmd_STOR(self, arg: str) -> None:
  313. """Handle STOR command - receive file upload."""
  314. if not self.authenticated:
  315. await self.send(530, "Not logged in")
  316. return
  317. if not self.data_server and not self._data_connected.is_set():
  318. await self.send(425, "Use PASV first")
  319. return
  320. filename = Path(arg).name # Sanitize filename
  321. file_path = self.upload_dir / filename
  322. logger.info("FTP receiving file: %s from %s", filename, self.remote_ip)
  323. await self.send(150, f"Opening data connection for {filename}")
  324. # Wait for data connection to be established (client connects after 150)
  325. try:
  326. await asyncio.wait_for(self._data_connected.wait(), timeout=30)
  327. except TimeoutError:
  328. logger.error("FTP data connection timeout - client didn't connect")
  329. await self.send(425, "Data connection timeout")
  330. await self._close_data_connection()
  331. return
  332. if not self._data_reader:
  333. await self.send(425, "Data connection failed")
  334. await self._close_data_connection()
  335. return
  336. # Receive data
  337. data_content: list[bytes] = []
  338. total_received = 0
  339. try:
  340. while True:
  341. chunk = await asyncio.wait_for(self._data_reader.read(65536), timeout=60)
  342. if not chunk:
  343. break
  344. data_content.append(chunk)
  345. total_received += len(chunk)
  346. logger.debug("FTP received chunk: %s bytes (total: %s)", len(chunk), total_received)
  347. except TimeoutError:
  348. logger.error("FTP data transfer timeout after %s bytes for %s", total_received, filename)
  349. await self.send(426, "Transfer timeout")
  350. await self._close_data_connection()
  351. return
  352. except Exception as e:
  353. logger.error(
  354. "FTP data transfer error after %s bytes for %s: %s(%s)",
  355. total_received,
  356. filename,
  357. type(e).__name__,
  358. e,
  359. )
  360. await self.send(426, f"Transfer failed: {e}")
  361. await self._close_data_connection()
  362. return
  363. # Close data connection
  364. await self._close_data_connection()
  365. # Write file
  366. try:
  367. total_size = sum(len(c) for c in data_content)
  368. file_path.write_bytes(b"".join(data_content))
  369. logger.info("FTP saved file: %s (%s bytes)", file_path, total_size)
  370. await self.send(226, "Transfer complete")
  371. # Notify callback
  372. if self.on_file_received:
  373. try:
  374. result = self.on_file_received(file_path, self.remote_ip)
  375. if asyncio.iscoroutine(result):
  376. await result
  377. except Exception as e:
  378. logger.error("File received callback error: %s", e)
  379. except Exception as e:
  380. logger.error("Failed to save file %s: %s", file_path, e)
  381. await self.send(550, "Failed to save file")
  382. async def cmd_SIZE(self, arg: str) -> None:
  383. """Handle SIZE command."""
  384. if not self.authenticated:
  385. await self.send(530, "Not logged in")
  386. return
  387. # We don't store files for SIZE queries
  388. await self.send(550, "File not found")
  389. async def cmd_QUIT(self, arg: str) -> None:
  390. """Handle QUIT command."""
  391. await self.send(221, "Goodbye")
  392. raise asyncio.CancelledError()
  393. async def cmd_NOOP(self, arg: str) -> None:
  394. """Handle NOOP command."""
  395. await self.send(200, "OK")
  396. async def cmd_OPTS(self, arg: str) -> None:
  397. """Handle OPTS command."""
  398. if arg.upper().startswith("UTF8"):
  399. await self.send(200, "UTF8 mode enabled")
  400. else:
  401. await self.send(501, "Option not supported")
  402. async def cmd_PBSZ(self, arg: str) -> None:
  403. """Handle PBSZ (Protection Buffer Size) command.
  404. Required for FTP security extensions. With TLS, buffer size is 0.
  405. """
  406. await self.send(200, "PBSZ=0")
  407. async def cmd_PROT(self, arg: str) -> None:
  408. """Handle PROT (Data Channel Protection Level) command.
  409. P = Private (encrypted), which we always use with implicit FTPS.
  410. """
  411. if arg.upper() == "P":
  412. await self.send(200, "Protection level set to Private")
  413. elif arg.upper() == "C":
  414. # Clear (unprotected) - we don't support this
  415. await self.send(536, "Protection level C not supported")
  416. else:
  417. await self.send(504, f"Protection level {arg} not supported")
  418. async def cmd_MKD(self, arg: str) -> None:
  419. """Handle MKD (Make Directory) command."""
  420. if not self.authenticated:
  421. await self.send(530, "Not logged in")
  422. return
  423. # We don't really create directories, just pretend it works
  424. await self.send(257, f'"{arg}" directory created')
  425. async def cmd_LIST(self, arg: str) -> None:
  426. """Handle LIST command - list directory contents."""
  427. if not self.authenticated:
  428. await self.send(530, "Not logged in")
  429. return
  430. # We don't support listing, return empty
  431. await self.send(150, "Opening data connection")
  432. await self.send(226, "Transfer complete")
  433. class VirtualPrinterFTPServer:
  434. """Implicit FTPS server that accepts uploads from slicers."""
  435. PASSIVE_PORT_MIN = 50000
  436. PASSIVE_PORT_MAX = 50100
  437. def __init__(
  438. self,
  439. upload_dir: Path,
  440. access_code: str,
  441. cert_path: Path,
  442. key_path: Path,
  443. port: int = FTP_PORT,
  444. on_file_received: Callable[[Path, str], None] | None = None,
  445. ):
  446. """Initialize the FTPS server.
  447. Args:
  448. upload_dir: Directory to store uploaded files
  449. access_code: Password for authentication (bblp user)
  450. cert_path: Path to TLS certificate file
  451. key_path: Path to TLS private key file
  452. port: Port to listen on (default 990)
  453. on_file_received: Callback when file upload completes (path, source_ip)
  454. """
  455. self.upload_dir = upload_dir
  456. self.access_code = access_code
  457. self.cert_path = cert_path
  458. self.key_path = key_path
  459. self.port = port
  460. self.on_file_received = on_file_received
  461. self._server: asyncio.Server | None = None
  462. self._running = False
  463. self._ssl_context: ssl.SSLContext | None = None
  464. self._active_sessions: list[asyncio.Task] = []
  465. # Override PASV response IP for Docker bridge mode / NAT environments
  466. self._pasv_address = os.environ.get("VIRTUAL_PRINTER_PASV_ADDRESS", "")
  467. async def start(self) -> None:
  468. """Start the implicit FTPS server."""
  469. if self._running:
  470. return
  471. logger.info("Starting virtual printer implicit FTPS on port %s", self.port)
  472. # Ensure upload directory exists
  473. self.upload_dir.mkdir(parents=True, exist_ok=True)
  474. cache_dir = self.upload_dir / "cache"
  475. cache_dir.mkdir(exist_ok=True)
  476. # Create SSL context for implicit FTPS (TLS from byte 0)
  477. self._ssl_context = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
  478. self._ssl_context.load_cert_chain(str(self.cert_path), str(self.key_path))
  479. self._ssl_context.minimum_version = ssl.TLSVersion.TLSv1_2
  480. self._ssl_context.maximum_version = ssl.TLSVersion.TLSv1_2
  481. # Use standard TLS settings for compatibility
  482. self._ssl_context.set_ciphers("HIGH:!aNULL:!MD5:!RC4")
  483. logger.info("FTP SSL context created with standard settings")
  484. try:
  485. # Create server with SSL - TLS handshake happens before any FTP data
  486. self._server = await asyncio.start_server(
  487. self._handle_client,
  488. "0.0.0.0", # nosec B104
  489. self.port,
  490. ssl=self._ssl_context, # This makes it implicit FTPS!
  491. )
  492. self._running = True
  493. logger.info("Implicit FTPS server started on port %s", self.port)
  494. logger.info(
  495. "FTP passive data port range: %s-%s",
  496. self.PASSIVE_PORT_MIN,
  497. self.PASSIVE_PORT_MAX,
  498. )
  499. if self._pasv_address:
  500. logger.info("FTP PASV address override: %s", self._pasv_address)
  501. async with self._server:
  502. await self._server.serve_forever()
  503. except OSError as e:
  504. if e.errno == 98: # Address already in use
  505. logger.error("FTP port %s is already in use", self.port)
  506. else:
  507. logger.error("FTP server error: %s", e)
  508. except asyncio.CancelledError:
  509. logger.debug("FTP server task cancelled")
  510. except Exception as e:
  511. logger.error("FTP server error: %s", e)
  512. finally:
  513. await self.stop()
  514. async def _handle_client(self, reader: asyncio.StreamReader, writer: asyncio.StreamWriter) -> None:
  515. """Handle a new FTP client connection."""
  516. peername = writer.get_extra_info("peername")
  517. logger.info("FTP connection from %s", peername)
  518. session = FTPSession(
  519. reader=reader,
  520. writer=writer,
  521. upload_dir=self.upload_dir,
  522. access_code=self.access_code,
  523. ssl_context=self._ssl_context,
  524. on_file_received=self.on_file_received,
  525. passive_port_range=(self.PASSIVE_PORT_MIN, self.PASSIVE_PORT_MAX),
  526. pasv_address=self._pasv_address,
  527. )
  528. # Track the session task so we can cancel it on stop
  529. task = asyncio.current_task()
  530. if task:
  531. self._active_sessions.append(task)
  532. try:
  533. await session.handle()
  534. finally:
  535. if task and task in self._active_sessions:
  536. self._active_sessions.remove(task)
  537. async def stop(self) -> None:
  538. """Stop the FTPS server."""
  539. logger.info("Stopping FTP server")
  540. self._running = False
  541. # Cancel all active sessions first
  542. for task in self._active_sessions[:]: # Copy list to avoid modification during iteration
  543. task.cancel()
  544. # Wait briefly for sessions to clean up
  545. if self._active_sessions:
  546. await asyncio.sleep(0.1)
  547. self._active_sessions.clear()
  548. if self._server:
  549. try:
  550. self._server.close()
  551. await self._server.wait_closed()
  552. except OSError as e:
  553. logger.debug("Error closing FTP server: %s", e)
  554. self._server = None