mirror of
https://github.com/GNS3/gns3-server.git
synced 2026-11-03 05:51:15 +02:00
feat: add VNC WebSocket console support for Docker and QEMU nodes
Add VNC console WebSocket endpoints for Docker and QEMU nodes: - Add /console/vnc WebSocket endpoint to compute API (Docker & QEMU) - Add /console/vnc WebSocket endpoint to controller API - Implement start_vnc_websocket_console() in BaseNode - Forward VNC WebSocket traffic between controller and compute layers The implementation provides bidirectional WebSocket to TCP forwarding for VNC protocol (RFB) connections, allowing browser-based VNC console access to containers and VMs. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
09aa12cf94
commit
ba92b405da
4 files changed
+176
-1
No files matched your search
@@ -484,7 +484,7 @@ class BaseNode:
|
||||
"""
|
||||
Connect to console using Websocket.
|
||||
|
||||
:param ws: Websocket object
|
||||
:param websocket: FastAPI WebSocket object
|
||||
"""
|
||||
|
||||
log.info(
|
||||
@@ -541,6 +541,76 @@ class BaseNode:
|
||||
for task in pending:
|
||||
task.cancel()
|
||||
|
||||
async def start_vnc_websocket_console(self, websocket):
|
||||
"""
|
||||
Connect to VNC console using WebSocket.
|
||||
|
||||
:param websocket: FastAPI WebSocket object
|
||||
"""
|
||||
|
||||
log.info(
|
||||
f"New client {websocket.client.host}:{websocket.client.port} has connected to compute "
|
||||
f"VNC console WebSocket"
|
||||
)
|
||||
|
||||
if self.status != "started":
|
||||
await websocket.close(code=1000)
|
||||
raise NodeError(f"Node {self.name} is not started")
|
||||
if self._console_type != "vnc":
|
||||
await websocket.close(code=1000)
|
||||
raise NodeError(f"Node {self.name} console type is not vnc")
|
||||
|
||||
try:
|
||||
vnc_reader, vnc_writer = await asyncio.open_connection(
|
||||
self._manager.port_manager.console_host,
|
||||
self.console # VNC port
|
||||
)
|
||||
log.info(f"Connected to VNC server {self._manager.port_manager.console_host}:{self.console}")
|
||||
except ConnectionError as e:
|
||||
await websocket.close(code=1000)
|
||||
raise NodeError(f"Cannot connect to node {self.name} VNC server: {e}")
|
||||
|
||||
async def ws_forward(vnc_writer):
|
||||
# Browser → VNC: Forward binary WebSocket data to VNC server
|
||||
try:
|
||||
while True:
|
||||
data = await websocket.receive_bytes()
|
||||
if data:
|
||||
vnc_writer.write(data)
|
||||
await vnc_writer.drain()
|
||||
except WebSocketDisconnect:
|
||||
log.info(
|
||||
f"Client {websocket.client.host}:{websocket.client.port} has disconnected from compute "
|
||||
f"VNC console WebSocket"
|
||||
)
|
||||
|
||||
async def vnc_forward(vnc_reader):
|
||||
# VNC → Browser: Forward VNC frames to WebSocket
|
||||
try:
|
||||
while not vnc_reader.at_eof():
|
||||
data = await vnc_reader.read(65536) # Larger buffer for VNC frames
|
||||
if data:
|
||||
await websocket.send_bytes(data)
|
||||
except Exception as e:
|
||||
log.warning(f"Exception while forwarding VNC data to WebSocket: {e}")
|
||||
|
||||
# Keep forwarding WebSocket data in both directions
|
||||
if sys.version_info >= (3, 11, 0):
|
||||
# Starting with Python 3.11, passing coroutine objects to wait() directly is forbidden.
|
||||
aws = [asyncio.create_task(ws_forward(vnc_writer)), asyncio.create_task(vnc_forward(vnc_reader))]
|
||||
else:
|
||||
aws = [ws_forward(vnc_writer), vnc_forward(vnc_reader)]
|
||||
|
||||
done, pending = await asyncio.wait(aws, return_when=asyncio.FIRST_COMPLETED)
|
||||
for task in done:
|
||||
if task.exception():
|
||||
log.warning(f"Exception while forwarding WebSocket data to VNC server: {task.exception()}")
|
||||
for task in pending:
|
||||
task.cancel()
|
||||
|
||||
vnc_writer.close()
|
||||
await vnc_writer.wait_closed()
|
||||
|
||||
@property
|
||||
def aux(self):
|
||||
"""
|
||||
|
||||
Reference in new issue
Block a user