gns3-server 3.0.4__py3-none-any.whl → 3.0.5__py3-none-any.whl

gns3server/appliances/rhel.gns3a

@@ -13,7 +13,7 @@
     "availability": "service-contract",
     "maintainer": "Da-Geek",
     "maintainer_email": "dageek@dageeks-geeks.gg",
-    "usage": "You should download Red Hat Enterprise Linux KVM Guest Image from https://access.redhat.com/downloads/content/479/ver=/rhel---9/9.3/x86_64/product-software attach/customize rhel-cloud-init.iso and start.\nusername: cloud-user\npassword: redhat",
+    "usage": "You should download Red Hat Enterprise Linux KVM Guest Image from https://access.redhat.com/downloads/content/479/ver=/rhel---9/9.5/x86_64/product-software attach/customize rhel-cloud-init.iso and start.\nusername: cloud-user\npassword: redhat",
     "qemu": {
         "adapter_type": "virtio-net-pci",
         "adapters": 1,
@@ -26,6 +26,20 @@
         "options": "-cpu host -nographic"
     },
     "images": [
+        {
+            "filename": "rhel-9.5-x86_64-kvm.qcow2",
+            "version": "9.5",
+            "md5sum": "8174396d5cb47727c59dd04dd9a05418",
+            "filesize": 974389248,
+            "download_url": "https://access.redhat.com/downloads/content/479/ver=/rhel---9/9.5/x86_64/product-software"
+        },
+        {
+            "filename": "rhel-9.4-x86_64-kvm.qcow2",
+            "version": "9.4",
+            "md5sum": "77a2ca9a4cb0448260e04f0d2ebf9807",
+            "filesize": 957218816,
+            "download_url": "https://access.redhat.com/downloads/content/479/ver=/rhel---9/9.4/x86_64/product-software"
+        },
         {
             "filename": "rhel-9.3-x86_64-kvm.qcow2",
             "version": "9.3",
@@ -54,6 +68,20 @@
             "filesize": 696582144,
             "download_url": "https://access.redhat.com/downloads/content/479/ver=/rhel---8/9.0/x86_64/product-software"
         },
+        {
+            "filename": "rhel-8.10-x86_64-kvm.qcow2",
+            "version": "8.10",
+            "md5sum": "5fda99fcab47e3b235c6ccdb6e80d362",
+            "filesize": 1065091072,
+            "download_url": "https://access.redhat.com/downloads/content/479/ver=/rhel---8/8.10/x86_64/product-software"
+        },
+        {
+            "filename": "rhel-8.9-x86_64-kvm.qcow2",
+            "version": "8.9",
+            "md5sum": "23295fe508678cbdebfbdbd41ef6e6e2",
+            "filesize": 971833344,
+            "download_url": "https://access.redhat.com/downloads/content/479/ver=/rhel---8/8.9/x86_64/product-software"
+        },
         {
             "filename": "rhel-8.8-x86_64-kvm.qcow2",
             "version": "8.8",
@@ -119,6 +147,20 @@
         }
     ],
     "versions": [
+        {
+            "name": "9.5",
+            "images": {
+                "hda_disk_image": "rhel-9.5-x86_64-kvm.qcow2",
+                "cdrom_image": "rhel-cloud-init.iso"
+            }
+        },
+        {
+            "name": "9.4",
+            "images": {
+                "hda_disk_image": "rhel-9.4-x86_64-kvm.qcow2",
+                "cdrom_image": "rhel-cloud-init.iso"
+            }
+        },
         {
             "name": "9.3",
             "images": {
@@ -147,6 +189,20 @@
                 "cdrom_image": "rhel-cloud-init.iso"
             }
         },
+        {
+            "name": "8.10",
+            "images": {
+                "hda_disk_image": "rhel-8.10-x86_64-kvm.qcow2",
+                "cdrom_image": "rhel-cloud-init.iso"
+            }
+        },
+        {
+            "name": "8.9",
+            "images": {
+                "hda_disk_image": "rhel-8.9-x86_64-kvm.qcow2",
+                "cdrom_image": "rhel-cloud-init.iso"
+            }
+        },
         {
             "name": "8.8",
             "images": {

gns3server/appliances/rockylinux.gns3a

@@ -26,6 +26,14 @@
         "options": "-nographic -cpu host"
     },
     "images": [
+        {
+            "filename": "Rocky-9-GenericCloud-Base-9.5-20241118.0.x86_64.qcow2",
+            "version": "9.5",
+            "md5sum": "880eccf788301bb9f34669faebe09276",
+            "filesize": 609812480,
+            "download_url": "https://download.rockylinux.org/pub/rocky/9/images/x86_64/",
+            "direct_download_url": "https://download.rockylinux.org/pub/rocky/9/images/x86_64/Rocky-9-GenericCloud-Base-9.5-20241118.0.x86_64.qcow2"
+        },
         {
             "filename": "Rocky-9-GenericCloud-Base-9.3-20231113.0.x86_64.qcow2",
             "version": "9.3",
@@ -68,6 +76,13 @@
         }
     ],
     "versions": [
+        {
+            "name": "9.5",
+            "images": {
+                "hda_disk_image": "Rocky-9-GenericCloud-Base-9.5-20241118.0.x86_64.qcow2",
+                "cdrom_image": "rocky-cloud-init-data.iso"
+            }
+        },
         {
             "name": "9.3",
             "images": {

gns3server/compute/builtin/nodes/nat.py

@@ -37,7 +37,7 @@ class Nat(Cloud):
     def __init__(self, name, node_id, project, manager, ports=None):
 
         allowed_interfaces = Config.instance().settings.Server.allowed_interfaces
-        if allowed_interfaces:
+        if allowed_interfaces and isinstance(allowed_interfaces, str):
             allowed_interfaces = allowed_interfaces.split(',')
         if sys.platform.startswith("linux"):
             nat_interface = Config.instance().settings.Server.default_nat_interface

gns3server/compute/docker/__init__.py

@@ -175,11 +175,10 @@ class Docker(BaseManager):
         response = await self.http_query(method, path, data=data, params=params)
         body = await response.read()
         response.close()
-        if body and len(body):
-            if response.headers.get('CONTENT-TYPE') == 'application/json':
-                body = json.loads(body.decode("utf-8"))
-            else:
-                body = body.decode("utf-8")
+        if response.headers.get('CONTENT-TYPE') == 'application/json':
+            body = json.loads(body.decode("utf-8", errors="ignore"))
+        else:
+            body = body.decode("utf-8", errors="ignore")
         log.debug("Query Docker %s %s params=%s data=%s Response: %s", method, path, params, data, body)
         return body
 
@@ -267,12 +266,12 @@ class Docker(BaseManager):
             pass
 
         if progress_callback:
-            progress_callback(f"Pulling '{image}' from docker hub")
+            progress_callback(f"Pulling '{image}' from Docker repository")
         try:
             response = await self.http_query("POST", "images/create", params={"fromImage": image}, timeout=None)
         except DockerError as e:
             raise DockerError(
-                f"Could not pull the '{image}' image from Docker Hub, "
+                f"Could not pull the '{image}' image from Docker repository, "
                 f"please check your Internet connection (original error: {e})"
             )
         # The pull api will stream status via an HTTP JSON stream
@@ -281,10 +280,10 @@ class Docker(BaseManager):
             try:
                 chunk = await response.content.read(CHUNK_SIZE)
             except aiohttp.ServerDisconnectedError:
-                log.error(f"Disconnected from server while pulling Docker image '{image}' from docker hub")
+                log.error(f"Disconnected from server while pulling Docker image '{image}' from Docker repository")
                 break
             except asyncio.TimeoutError:
-                log.error(f"Timeout while pulling Docker image '{image}' from docker hub")
+                log.error("Timeout while pulling Docker image '{}' from Docker repository".format(image))
                 break
             if not chunk:
                 break

gns3server/compute/docker/docker_vm.py

@@ -437,7 +437,7 @@ class DockerVM(BaseNode):
         try:
             image_infos = await self._get_image_information()
         except DockerHttp404Error:
-            log.info(f"Image '{self._image}' is missing, pulling it from Docker hub...")
+            log.info("Image '{}' is missing, pulling it from Docker repository...".format(self._image))
             await self.pull_image(self._image)
             image_infos = await self._get_image_information()
 
@@ -617,6 +617,7 @@ class DockerVM(BaseNode):
             await self._clean_servers()
 
             await self.manager.query("POST", f"containers/{self._cid}/start")
+            await asyncio.sleep(0.5)  # give the Docker container some time to start
             self._namespace = await self._get_namespace()
 
             await self._start_ubridge(require_privileged_access=True)

gns3server/compute/qemu/qemu_vm.py

@@ -32,6 +32,7 @@ import subprocess
 import time
 import json
 import shlex
+import psutil
 
 from gns3server.utils import parse_version
 from gns3server.utils.asyncio import subprocess_check_output, cancellable_wait_run_in_executor
@@ -265,17 +266,10 @@ class QemuVM(BaseNode):
             if qemu_bin == "qemu":
                 self._platform = "i386"
             else:
-                self._platform = re.sub(r'^qemu-system-(\w+).*$', r'\1', qemu_bin, re.IGNORECASE)
-
-        try:
-            QemuPlatform(self._platform.split(".")[0])
-        except ValueError:
+                self._platform = re.sub(r'^qemu-system-(\w+).*$', r'\1', qemu_bin, flags=re.IGNORECASE)
+        if self._platform.split(".")[0] not in list(QemuPlatform):
             raise QemuError(f"Platform {self._platform} is unknown")
-        log.info(
-            'QEMU VM "{name}" [{id}] has set the QEMU path to {qemu_path}'.format(
-                name=self._name, id=self._id, qemu_path=qemu_path
-            )
-        )
+        log.info(f'QEMU VM "{self._name}" [{self._name}] has set the QEMU path to {qemu_path}')
 
     def _check_qemu_path(self, qemu_path):
 
@@ -1225,6 +1219,21 @@ class QemuVM(BaseNode):
         except OSError as e:
             raise QemuError(f"Could not start Telnet QEMU console {e}\n")
 
+    def _find_partition_for_path(self, path):
+        """
+        Finds the disk partition for a given path.
+        """
+
+        path = os.path.abspath(path)
+        partitions = psutil.disk_partitions()
+        # find the partition with the longest matching mount point
+        matching_partition = None
+        for partition in partitions:
+            if path.startswith(partition.mountpoint):
+                if matching_partition is None or len(partition.mountpoint) > len(matching_partition.mountpoint):
+                    matching_partition = partition
+        return matching_partition
+
     async def _termination_callback(self, returncode):
         """
         Called when the process has stopped.
@@ -1236,9 +1245,19 @@ class QemuVM(BaseNode):
             log.info("QEMU process has stopped, return code: %d", returncode)
             await self.stop()
             if returncode != 0:
+                qemu_stdout = self.read_stdout()
+                # additional permissions need to be configured for swtpm in AppArmor if the working dir
+                # is located on a different partition than the partition for the root directory
+                if "TPM result for CMD_INIT" in qemu_stdout:
+                    partition = self._find_partition_for_path(self.project.path)
+                    if partition and partition.mountpoint != "/":
+                        qemu_stdout += "\nTPM error: the project directory is not on the same partition as the root directory which can be a problem when using AppArmor.\n" \
+                                        "Please try to execute the following commands on the server:\n\n" \
+                                        "echo 'owner {}/** rwk,' | sudo tee /etc/apparmor.d/local/usr.bin.swtpm > /dev/null\n" \
+                                        "sudo service apparmor restart".format(os.path.dirname(self.project.path))
                 self.project.emit(
                     "log.error",
-                    {"message": f"QEMU process has stopped, return code: {returncode}\n{self.read_stdout()}"},
+                    {"message": f"QEMU process has stopped, return code: {returncode}\n{qemu_stdout}"},
                 )
 
     async def stop(self):
@@ -2287,19 +2306,42 @@ class QemuVM(BaseNode):
                 else:
                     raise QemuError(f"bios image '{self._bios_image}' is not accessible")
             options.extend(["-bios", self._bios_image.replace(",", ",,")])
+
         elif self._uefi:
-            # get the OVMF firmware from the images directory
-            ovmf_firmware_path = self.manager.get_abs_image_path("OVMF_CODE.fd")
+
+            old_ovmf_vars_path = os.path.join(self.working_dir, "OVMF_VARS.fd")
+            if os.path.exists(old_ovmf_vars_path):
+                # the node has its own UEFI variables store already, we must also use the old UEFI firmware
+                ovmf_firmware_path = self.manager.get_abs_image_path("OVMF_CODE.fd")
+            else:
+                system_ovmf_firmware_path = "/usr/share/OVMF/OVMF_CODE_4M.fd"
+                if os.path.exists(system_ovmf_firmware_path):
+                    ovmf_firmware_path = system_ovmf_firmware_path
+                else:
+                    # otherwise, get the UEFI firmware from the images directory
+                    ovmf_firmware_path = self.manager.get_abs_image_path("OVMF_CODE_4M.fd")
+
             log.info("Configuring UEFI boot mode using OVMF file: '{}'".format(ovmf_firmware_path))
             options.extend(["-drive", "if=pflash,format=raw,readonly,file={}".format(ovmf_firmware_path)])
 
+            # try to use the UEFI variables store from the system first
+            system_ovmf_vars_path = "/usr/share/OVMF/OVMF_VARS_4M.fd"
+            if os.path.exists(system_ovmf_vars_path):
+                ovmf_vars_path = system_ovmf_vars_path
+            else:
+                # otherwise, get the UEFI variables store from the images directory
+                ovmf_vars_path = self.manager.get_abs_image_path("OVMF_VARS_4M.fd")
+
             # the node should have its own copy of OVMF_VARS.fd (the UEFI variables store)
-            ovmf_vars_node_path = os.path.join(self.working_dir, "OVMF_VARS.fd")
-            if not os.path.exists(ovmf_vars_node_path):
-                try:
-                    shutil.copyfile(self.manager.get_abs_image_path("OVMF_VARS.fd"), ovmf_vars_node_path)
-                except OSError as e:
-                    raise QemuError("Cannot copy OVMF_VARS.fd file to the node working directory: {}".format(e))
+            if os.path.exists(old_ovmf_vars_path):
+                ovmf_vars_node_path = old_ovmf_vars_path
+            else:
+                ovmf_vars_node_path = os.path.join(self.working_dir, "OVMF_VARS_4M.fd")
+                if not os.path.exists(ovmf_vars_node_path):
+                    try:
+                        shutil.copyfile(ovmf_vars_path, ovmf_vars_node_path)
+                    except OSError as e:
+                        raise QemuError("Cannot copy OVMF_VARS_4M.fd file to the node working directory: {}".format(e))
             options.extend(["-drive", "if=pflash,format=raw,file={}".format(ovmf_vars_node_path)])
         return options
 
@@ -2396,16 +2438,13 @@ class QemuVM(BaseNode):
         )  # we do not want any user networking back-end if no adapter is connected.
 
         # Each 32 PCI device we need to add a PCI bridge with max 9 bridges
-        pci_devices = 4 + len(self._ethernet_adapters)  # 4 PCI devices are use by default by qemu
-        pci_bridges = math.floor(pci_devices / 32)
+        # Reserve 32 devices on root pci_bridge,
+        # since the number of devices used by templates may differ significantly
+        # and pci_bridges also consume IDs.
+        # Move network devices to their own bridge
+        pci_devices_reserved = 32
         pci_bridges_created = 0
-        if pci_bridges >= 1:
-            if self._qemu_version and parse_version(self._qemu_version) < parse_version("2.4.0"):
-                raise QemuError(
-                    "Qemu version 2.4 or later is required to run this VM with a large number of network adapters"
-                )
-
-        pci_device_id = 4 + pci_bridges  # Bridge consume PCI ports
+        pci_device_id = pci_devices_reserved
         for adapter_number, adapter in enumerate(self._ethernet_adapters):
             mac = int_to_macaddress(macaddress_to_int(self._mac_address) + adapter_number)
 
@@ -2596,6 +2635,8 @@ class QemuVM(BaseNode):
         """
 
         self._qemu_version = await self.manager.get_qemu_version(self.qemu_path)
+        if self._qemu_version and parse_version(self._qemu_version) < parse_version("2.4.0"):
+            raise QemuError("Qemu version 2.4 or later is required to run Qemu VMs")
         vm_name = self._name.replace(",", ",,")
         project_path = self.project.path.replace(",", ",,")
         additional_options = self._options.strip()

gns3server/controller/compute.py

@@ -458,10 +458,11 @@ class Compute:
                             # FIXME: slow down number of compute events
                             self._controller.notification.controller_emit("compute.updated", self.asdict())
                         else:
-                            if action == "log.error":
-                                log.error(event.pop("message"))
                             await self._controller.notification.dispatch(
-                                action, event, project_id=project_id, compute_id=self.id
+                                action,
+                                event,
+                                project_id=project_id,
+                                compute_id=self.id
                             )
                     else:
                         if response.type == aiohttp.WSMsgType.CLOSE:

gns3server/controller/gns3vm/virtualbox_gns3_vm.py

@@ -249,6 +249,7 @@ class VirtualBoxGNS3VM(BaseGNS3VM):
                     return True
         return False
 
+
     async def list(self):
         """
         List all VirtualBox VMs
@@ -269,8 +270,8 @@ class VirtualBoxGNS3VM(BaseGNS3VM):
 
         # get a NAT interface number
         nat_interface_number = await self._look_for_interface("nat")
-        if nat_interface_number < 0:
-            raise GNS3VMError(f'VM "{self.vmname}" must have a NAT interface configured in order to start')
+        if nat_interface_number < 0 and await self._look_for_interface("natnetwork") < 0:
+            raise GNS3VMError(f'VM "{self.vmname}" must have a NAT interface or NAT Network configured in order to start')
 
         if sys.platform.startswith("darwin") and parse_version(self._system_properties["API version"]) >= parse_version("7_0"):
             # VirtualBox 7.0+ on macOS requires a host-only network interface
@@ -339,42 +340,68 @@ class VirtualBoxGNS3VM(BaseGNS3VM):
         elif vm_state == "paused":
             args = [self._vmname, "resume"]
             await self._execute("controlvm", args)
-        ip_address = "127.0.0.1"
-        try:
-            # get a random port on localhost
-            with socket.socket() as s:
-                s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
-                s.bind((ip_address, 0))
-                api_port = s.getsockname()[1]
-        except OSError as e:
-            raise GNS3VMError(f"Error while getting random port: {e}")
-
-        if await self._check_vbox_port_forwarding():
-            # delete the GNS3VM NAT port forwarding rule if it exists
-            log.info(f"Removing GNS3VM NAT port forwarding rule from interface {nat_interface_number}")
-            await self._execute("controlvm", [self._vmname, f"natpf{nat_interface_number}", "delete", "GNS3VM"])
-
-        # add a GNS3VM NAT port forwarding rule to redirect 127.0.0.1 with random port to the port in the VM
-        log.info(f"Adding GNS3VM NAT port forwarding rule with port {api_port} to interface {nat_interface_number}")
-        await self._execute(
-            "controlvm",
-            [self._vmname, f"natpf{nat_interface_number}", f"GNS3VM,tcp,{ip_address},{api_port},,{self.port}"],
-        )
 
-        self.ip_address = await self._get_ip(interface_number, api_port)
-        log.info("GNS3 VM has been started with IP {}".format(self.ip_address))
+        log.info("Retrieving IP address from GNS3 VM...")
+        ip = await self._get_ip_from_guest_property()
+        if ip:
+            self.ip_address = ip
+        else:
+            # if we can't get the IP address from the guest property, we try to get it from the GNS3 server (a NAT interface is required)
+            if nat_interface_number < 0:
+                raise GNS3VMError("Could not find guest IP address for {}".format(self.vmname))
+            log.warning("Could not find IP address from guest property, trying to get it from GNS3 server")
+            ip_address = "127.0.0.1"
+            try:
+                # get a random port on localhost
+                with socket.socket() as s:
+                    s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
+                    s.bind((ip_address, 0))
+                    api_port = s.getsockname()[1]
+            except OSError as e:
+                raise GNS3VMError("Error while getting random port: {}".format(e))
+
+            if await self._check_vbox_port_forwarding():
+                # delete the GNS3VM NAT port forwarding rule if it exists
+                log.info("Removing GNS3VM NAT port forwarding rule from interface {}".format(nat_interface_number))
+                await self._execute("controlvm", [self._vmname, "natpf{}".format(nat_interface_number), "delete", "GNS3VM"])
+
+            # add a GNS3VM NAT port forwarding rule to redirect 127.0.0.1 with random port to the port in the VM
+            log.info("Adding GNS3VM NAT port forwarding rule with port {} to interface {}".format(api_port, nat_interface_number))
+            await self._execute("controlvm", [self._vmname, "natpf{}".format(nat_interface_number),
+                                                   "GNS3VM,tcp,{},{},,{}".format(ip_address, api_port, self.port)])
+
+            self.ip_address = await self._get_ip_from_server(interface_number, api_port)
+
+        log.info("GNS3 VM has been started with IP '{}'".format(self.ip_address))
         self.running = True
 
-    async def _get_ip(self, hostonly_interface_number, api_port):
+    async def _get_ip_from_guest_property(self):
+        """
+        Get the IP from VirtualBox by retrieving the guest property (Guest Additions must be installed).
+        """
+
+        remaining_try = 180  # try for 3 minutes
+        while remaining_try > 0:
+            result = await self._execute("guestproperty", ["get", self._vmname, "/VirtualBox/GuestInfo/Net/0/V4/IP"])
+            for info in result.splitlines():
+                if ':' in info:
+                    name, value = info.split(':', 1)
+                    if name == "Value":
+                        return value.strip()
+            remaining_try -= 1
+            await asyncio.sleep(1)
+        return None
+
+    async def _get_ip_from_server(self, hostonly_interface_number, api_port):
         """
-        Get the IP from VirtualBox.
+        Get the IP from VirtualBox by sending a request to the GNS3 server.
 
         Due to VirtualBox limitation the only way is to send request each
         second to a GNS3 endpoint in order to get the list of the interfaces and
         their IP and after that match it with VirtualBox host only.
         """
 
-        remaining_try = 300
+        remaining_try = 180  # try for 3 minutes
         while remaining_try > 0:
             try:
                 async with HTTPClient.get(f"http://127.0.0.1:{api_port}/v3/compute/network/interfaces") as resp:

gns3server/crash_report.py

@@ -58,7 +58,7 @@ class CrashReport:
     Report crash to a third party service
     """
 
-    DSN = "https://0d64280ffb5ae409d448f255b9956a88@o19455.ingest.us.sentry.io/38482"
+    DSN = "https://61bb46252cabeebd49ee1e09fb8ba72e@o19455.ingest.us.sentry.io/38482"
     _instance = None
 
     def __init__(self):

gns3server/schemas/__init__.py

@@ -20,7 +20,7 @@ from .common import ErrorMessage
 from .version import Version
 
 # Controller schemas
-from .controller.links import LinkCreate, LinkUpdate, Link
+from .controller.links import LinkCreate, LinkUpdate, Link, UDPPortInfo, EthernetPortInfo
 from .controller.computes import ComputeCreate, ComputeUpdate, ComputeVirtualBoxVM, ComputeVMwareVM, ComputeDockerImage, AutoIdlePC, Compute
 from .controller.templates import TemplateCreate, TemplateUpdate, TemplateUsage, Template
 from .controller.images import Image, ImageType

gns3server/schemas/controller/links.py

@@ -92,3 +92,24 @@ class Link(LinkBase):
         None,
         description="Read only property. The compute identifier where a capture is running"
     )
+
+
+class UDPPortInfo(BaseModel):
+    """
+    UDP port information.
+    """
+
+    node_id: UUID
+    lport: int
+    rhost: str
+    rport: int
+    type: str
+
+class EthernetPortInfo(BaseModel):
+    """
+    Ethernet port information.
+    """
+
+    node_id: UUID
+    interface: str
+    type: str

gns3server/static/web-ui/index.html

@@ -46,6 +46,6 @@
 
       gtag('config', 'G-0BT7QQV1W1');
     </script>
-  <script src="runtime.24fa95b7061d7056.js" type="module"></script><script src="polyfills.319c79dd175e50d0.js" type="module"></script><script src="main.87178dd64c9c79ba.js" type="module"></script>
+  <script src="runtime.24fa95b7061d7056.js" type="module"></script><script src="polyfills.319c79dd175e50d0.js" type="module"></script><script src="main.fd9d76d279fa7d5e.js" type="module"></script>
 
 </body></html>