gns3-server 3.0.0b2__py3-none-any.whl → 3.0.0rc1__py3-none-any.whl

gns3server/config_samples/gns3_server.conf

@@ -34,7 +34,7 @@ enable_ssl = False
 certfile = /home/gns3/.config/GNS3/ssl/server.cert
 certkey = /home/gns3/.config/GNS3/ssl/server.key
 
-; Path where devices images are stored
+; Path where binary images are stored
 images_path = /home/gns3/GNS3/images
 
 ; Additional paths to look for images
@@ -43,15 +43,20 @@ additional_images_paths = /opt/images;/mnt/disk1/images
 ; Path where user projects are stored
 projects_path = /home/gns3/GNS3/projects
 
-; Path where user appliances are stored
+; Path where custom user appliances are stored
 appliances_path = /home/gns3/GNS3/appliances
 
-; Path where custom device symbols are stored
+; Path where custom user symbols are stored
 symbols_path = /home/gns3/GNS3/symbols
 
 ; Path where custom configs are stored
 configs_path = /home/gns3/GNS3/configs
 
+; Path where files like built-in appliances and Docker resources are stored
+; The default path is the local user data directory
+; (Linux: "~/.local/share/GNS3", macOS: "~/Library/Application Support/GNS3", Windows: "%APPDATA%\GNS3")
+; resources_path = /home/gns3/GNS3/resources
+
 ; Default symbol theme
 ; Currently available themes are "Classic", Affinity-square-blue", "Affinity-square-red"
 ; "Affinity-square-gray", "Affinity-circle-blue", "Affinity-circle-red" and "Affinity-circle-gray"
@@ -102,6 +107,9 @@ default_nat_interface = vmnet10
 ; Enable the built-in templates
 enable_builtin_templates = True
 
+; Install built-in appliances
+install_builtin_appliances = True
+
 ; check if hardware virtualization is used by other emulators (KVM, VMware or VirtualBox)
 hardware_virtualization_check = True
 
@@ -148,3 +156,5 @@ monitor_host = 127.0.0.1
 enable_hardware_acceleration = True
 ; Require hardware acceleration in order to start VMs
 require_hardware_acceleration = False
+; Allow unsafe additional command line options
+allow_unsafe_options = False

gns3server/configs/iou_l2_base_startup-config.txt

@@ -15,7 +15,7 @@ no ip icmp rate-limit unreachable
 !
 ! due to some bugs with IOU, try to change the following line to 'ip cef' if your routing does not work
 no ip cef
-no ip domain-lookup
+no ip domain lookup
 !
 !
 !

gns3server/configs/iou_l3_base_startup-config.txt

@@ -14,7 +14,7 @@ no ip icmp rate-limit unreachable
 !
 ! due to some bugs with IOU, try to change the following line to 'ip cef' if your routing does not work
 no ip cef
-no ip domain-lookup
+no ip domain lookup
 !
 !
 ip tcp synwait-time 5

gns3server/controller/__init__.py

@@ -270,13 +270,18 @@ class Controller:
                 log.error(f"Cannot read IOU license file '{iourc_path}': {e}")
         self._iou_license_settings["license_check"] = iou_config.license_check
 
-        previous_version = controller_vars.get("version")
-        log.info("Comparing controller version {} with config version {}".format(__version__, previous_version))
-        if not previous_version or \
-                parse_version(__version__.split("+")[0]) > parse_version(previous_version.split("+")[0]):
-            self._appliance_manager.install_builtin_appliances()
-        elif not os.listdir(self._appliance_manager.builtin_appliances_path()):
-            self._appliance_manager.install_builtin_appliances()
+        # install the built-in appliances if needed
+        if Config.instance().settings.Server.install_builtin_appliances:
+            previous_version = controller_vars.get("version")
+            log.info("Comparing controller version {} with config version {}".format(__version__, previous_version))
+            builtin_appliances_path = self._appliance_manager.builtin_appliances_path()
+            if not previous_version or \
+                    parse_version(__version__.split("+")[0]) > parse_version(previous_version.split("+")[0]):
+                self._appliance_manager.install_builtin_appliances()
+            elif not os.listdir(builtin_appliances_path):
+                self._appliance_manager.install_builtin_appliances()
+            else:
+                log.info(f"Built-in appliances are installed in '{builtin_appliances_path}'")
 
         self._appliance_manager.appliances_etag = controller_vars.get("appliances_etag")
         self._appliance_manager.load_appliances()

gns3server/controller/appliance_manager.py

@@ -100,8 +100,13 @@ class ApplianceManager:
         Get the built-in appliance storage directory
         """
 
-        appname = vendor = "GNS3"
-        appliances_dir = os.path.join(platformdirs.user_data_dir(appname, vendor, roaming=True), "appliances")
+        resources_path = Config.instance().settings.Server.resources_path
+        if not resources_path:
+            appname = vendor = "GNS3"
+            resources_path = platformdirs.user_data_dir(appname, vendor, roaming=True)
+        else:
+            resources_path = os.path.expanduser(resources_path)
+        appliances_dir = os.path.join(resources_path, "appliances")
         if delete_first:
             shutil.rmtree(appliances_dir, ignore_errors=True)
         os.makedirs(appliances_dir, exist_ok=True)

gns3server/controller/export_project.py

@@ -39,7 +39,7 @@ async def export_project(
     temporary_dir,
     include_images=False,
     include_snapshots=False,
-    keep_compute_id=False,
+    keep_compute_ids=False,
     allow_all_nodes=False,
     reset_mac_addresses=False,
 ):
@@ -54,9 +54,9 @@ async def export_project(
     :param temporary_dir: A temporary dir where to store intermediate data
     :param include_images: save OS images to the zip file
     :param include_snapshots: save snapshots to the zip file
-    :param keep_compute_id: If false replace all compute id by local (standard behavior for .gns3project to make it portable)
-    :param allow_all_nodes: Allow all nodes type to be include in the zip even if not portable
-    :param reset_mac_addresses: Reset MAC addresses for every nodes.
+    :param keep_compute_ids: If false replace all compute IDs by local (standard behavior for .gns3project to make it portable)
+    :param allow_all_nodes: Allow all nodes type to be included in the zip even if not portable
+    :param reset_mac_addresses: Reset MAC addresses for each node.
     """
 
     # To avoid issue with data not saved we disallow the export of a running project
@@ -77,7 +77,7 @@ async def export_project(
                 os.path.join(project._path, file),
                 zstream,
                 include_images,
-                keep_compute_id,
+                keep_compute_ids,
                 allow_all_nodes,
                 temporary_dir,
                 reset_mac_addresses,
@@ -193,7 +193,7 @@ def _is_exportable(path, include_snapshots=False):
 
 
 async def _patch_project_file(
-    project, path, zstream, include_images, keep_compute_id, allow_all_nodes, temporary_dir, reset_mac_addresses
+    project, path, zstream, include_images, keep_compute_ids, allow_all_nodes, temporary_dir, reset_mac_addresses
 ):
     """
     Patch a project file (.gns3) to export a project.
@@ -225,7 +225,7 @@ async def _patch_project_file(
                 if not allow_all_nodes and node["node_type"] in ["virtualbox", "vmware"]:
                     raise ControllerError("Projects with a {} node cannot be exported".format(node["node_type"]))
 
-                if not keep_compute_id:
+                if not keep_compute_ids:
                     node["compute_id"] = "local"  # To make project portable all node by default run on local
 
                 if "properties" in node and node["node_type"] != "docker":
@@ -243,13 +243,13 @@ async def _patch_project_file(
                         if value is None or value.strip() == "":
                             continue
 
-                        if not keep_compute_id:  # If we keep the original compute we can keep the image path
+                        if not keep_compute_ids:  # If we keep the original compute we can keep the image path
                             node["properties"][prop] = os.path.basename(value)
 
                         if include_images is True:
                             images.append({"compute_id": compute_id, "image": value, "image_type": node["node_type"]})
 
-        if not keep_compute_id:
+        if not keep_compute_ids:
             topology["topology"][
                 "computes"
             ] = []  # Strip compute information because could contain secret info like password

gns3server/controller/import_project.py

@@ -40,7 +40,7 @@ Handle the import of project from a .gns3project
 """
 
 
-async def import_project(controller, project_id, stream, location=None, name=None, keep_compute_id=False,
+async def import_project(controller, project_id, stream, location=None, name=None, keep_compute_ids=False,
                          auto_start=False, auto_open=False, auto_close=True):
     """
     Import a project contain in a zip file
@@ -52,7 +52,7 @@ async def import_project(controller, project_id, stream, location=None, name=Non
     :param stream: A io.BytesIO of the zipfile
     :param location: Directory for the project if None put in the default directory
     :param name: Wanted project name, generate one from the .gns3 if None
-    :param keep_compute_id: If true do not touch the compute id
+    :param keep_compute_ids: keep compute IDs unchanged
 
     :returns: Project
     """
@@ -126,7 +126,7 @@ async def import_project(controller, project_id, stream, location=None, name=Non
         drawing["drawing_id"] = str(uuid.uuid4())
 
     # Modify the compute id of the node depending of compute capacity
-    if not keep_compute_id:
+    if not keep_compute_ids:
         # For some VM type we move them to the GNS3 VM if possible
         # unless it's a linux host without GNS3 VM
         if not sys.platform.startswith("linux") or controller.has_compute("vm"):

gns3server/controller/project.py

@@ -210,7 +210,11 @@ class Project:
         if os.path.exists(snapshot_dir):
             for snap in os.listdir(snapshot_dir):
                 if snap.endswith(".gns3project"):
-                    snapshot = Snapshot(self, filename=snap)
+                    try:
+                        snapshot = Snapshot(self, filename=snap)
+                    except ValueError:
+                        log.error("Invalid snapshot file: {}".format(snap))
+                        continue
                     self._snapshots[snapshot.id] = snapshot
 
         # Create the project on demand on the compute node
@@ -491,7 +495,7 @@ class Project:
 
         if base_name is None:
             return None
-        base_name = re.sub(r"[ ]", "", base_name)
+        base_name = re.sub(r"[ ]", "", base_name)  # remove spaces in node name
         if base_name in self._allocated_node_names:
             base_name = re.sub(r"[0-9]+$", "{0}", base_name)
 
@@ -1087,7 +1091,7 @@ class Project:
                         zstream,
                         self,
                         tmpdir,
-                        keep_compute_id=True,
+                        keep_compute_ids=True,
                         allow_all_nodes=True,
                         reset_mac_addresses=reset_mac_addresses,
                     )
@@ -1106,7 +1110,7 @@ class Project:
                             str(uuid.uuid4()),
                             f,
                             name=name,
-                            keep_compute_id=True
+                            keep_compute_ids=True
                         )
 
             log.info(f"Project '{project.name}' duplicated in {time.time() - begin:.4f} seconds")

gns3server/controller/snapshot.py

@@ -51,22 +51,17 @@ class Snapshot:
         self._project = project
         if name:
             self._name = name
-            self._created_at = datetime.now().timestamp()
+            self._created_at = datetime.now(timezone.utc).timestamp()
             filename = (
                 self._name
                 + "_"
-                + datetime.utcfromtimestamp(self._created_at).replace(tzinfo=None).strftime("%d%m%y_%H%M%S")
+                + datetime.fromtimestamp(self._created_at, tz=timezone.utc).replace(tzinfo=None).strftime("%d%m%y_%H%M%S")
                 + ".gns3project"
             )
         else:
-            self._name = filename.split("_")[0]
+            self._name = filename.rsplit("_", 2)[0]
             datestring = filename.replace(self._name + "_", "").split(".")[0]
-            try:
-                self._created_at = (
-                    datetime.strptime(datestring, "%d%m%y_%H%M%S").replace(tzinfo=timezone.utc).timestamp()
-                )
-            except ValueError:
-                self._created_at = datetime.utcnow().timestamp()
+            self._created_at = (datetime.strptime(datestring, "%d%m%y_%H%M%S").replace(tzinfo=timezone.utc).timestamp())
         self._path = os.path.join(project.path, "snapshots", filename)
 
     @property
@@ -104,7 +99,7 @@ class Snapshot:
             with tempfile.TemporaryDirectory(dir=snapshot_directory) as tmpdir:
                 # Do not compress the snapshots
                 with aiozipstream.ZipFile(compression=zipfile.ZIP_STORED) as zstream:
-                    await export_project(zstream, self._project, tmpdir, keep_compute_id=True, allow_all_nodes=True)
+                    await export_project(zstream, self._project, tmpdir, keep_compute_ids=True, allow_all_nodes=True)
                     async with aiofiles.open(self.path, "wb") as f:
                         async for chunk in zstream:
                             await f.write(chunk)

gns3server/controller/symbol_themes.py

@@ -18,6 +18,7 @@
 
 CLASSIC_SYMBOL_THEME = {
     "cloud": ":/symbols/classic/cloud.svg",
+    "nat": ":/symbols/classic/nat.svg",
     "ethernet_switch": ":/symbols/classic/ethernet_switch.svg",
     "hub": ":/symbols/classic/hub.svg",
     "frame_relay_switch": ":/symbols/classic/frame_relay_switch.svg",
@@ -35,6 +36,7 @@ CLASSIC_SYMBOL_THEME = {
 
 AFFINITY_SQUARE_BLUE_SYMBOL_THEME = {
     "cloud": ":/symbols/affinity/square/blue/cloud.svg",
+    "nat": ":/symbols/affinity/square/blue/nat.svg",
     "ethernet_switch": ":/symbols/affinity/square/blue/switch.svg",
     "hub": ":/symbols/affinity/square/blue/hub.svg",
     "frame_relay_switch": ":/symbols/affinity/square/blue/isdn.svg",
@@ -52,6 +54,7 @@ AFFINITY_SQUARE_BLUE_SYMBOL_THEME = {
 
 AFFINITY_SQUARE_RED_SYMBOL_THEME = {
     "cloud": ":/symbols/affinity/square/red/cloud.svg",
+    "nat": ":/symbols/affinity/square/red/nat.svg",
     "ethernet_switch": ":/symbols/affinity/square/red/switch.svg",
     "hub": ":/symbols/affinity/square/red/hub.svg",
     "frame_relay_switch": ":/symbols/affinity/square/red/isdn.svg",
@@ -69,6 +72,7 @@ AFFINITY_SQUARE_RED_SYMBOL_THEME = {
 
 AFFINITY_SQUARE_GRAY_SYMBOL_THEME = {
     "cloud": ":/symbols/affinity/square/gray/cloud.svg",
+    "nat": ":/symbols/affinity/square/gray/nat.svg",
     "ethernet_switch": ":/symbols/affinity/square/gray/switch.svg",
     "hub": ":/symbols/affinity/square/gray/hub.svg",
     "frame_relay_switch": ":/symbols/affinity/square/gray/isdn.svg",
@@ -86,6 +90,7 @@ AFFINITY_SQUARE_GRAY_SYMBOL_THEME = {
 
 AFFINITY_CIRCLE_BLUE_SYMBOL_THEME = {
     "cloud": ":/symbols/affinity/circle/blue/cloud.svg",
+    "nat": ":/symbols/affinity/circle/blue/nat.svg",
     "ethernet_switch": ":/symbols/affinity/circle/blue/switch.svg",
     "hub": ":/symbols/affinity/circle/blue/hub.svg",
     "frame_relay_switch": ":/symbols/affinity/circle/blue/isdn.svg",
@@ -103,6 +108,7 @@ AFFINITY_CIRCLE_BLUE_SYMBOL_THEME = {
 
 AFFINITY_CIRCLE_RED_SYMBOL_THEME = {
     "cloud": ":/symbols/affinity/circle/red/cloud.svg",
+    "nat": ":/symbols/affinity/circle/red/nat.svg",
     "ethernet_switch": ":/symbols/affinity/circle/red/switch.svg",
     "hub": ":/symbols/affinity/circle/red/hub.svg",
     "frame_relay_switch": ":/symbols/affinity/circle/red/isdn.svg",
@@ -120,6 +126,7 @@ AFFINITY_CIRCLE_RED_SYMBOL_THEME = {
 
 AFFINITY_CIRCLE_GRAY_SYMBOL_THEME = {
     "cloud": ":/symbols/affinity/circle/gray/cloud.svg",
+    "nat": ":/symbols/affinity/circle/gray/nat.svg",
     "ethernet_switch": ":/symbols/affinity/circle/gray/switch.svg",
     "hub": ":/symbols/affinity/circle/gray/hub.svg",
     "frame_relay_switch": ":/symbols/affinity/circle/gray/isdn.svg",

gns3server/controller/topology.py

@@ -35,6 +35,7 @@ from .drawing import Drawing
 from .node import Node
 from .link import Link
 
+from gns3server.utils.hostname import is_ios_hostname_valid, is_rfc1123_hostname_valid, to_rfc1123_hostname, to_ios_hostname
 from gns3server.schemas.controller.topology import Topology
 from gns3server.schemas.compute.dynamips_nodes import DynamipsCreate
 
@@ -43,7 +44,7 @@ import logging
 log = logging.getLogger(__name__)
 
 
-GNS3_FILE_FORMAT_REVISION = 9
+GNS3_FILE_FORMAT_REVISION = 10
 
 
 class DynamipsNodeValidation(DynamipsCreate):
@@ -186,6 +187,10 @@ def load_topology(path):
         if variables:
             topo["variables"] = [var for var in variables if var.get("name")]
 
+    # Version before GNS3 3.0
+    if topo["revision"] < 10:
+        topo = _convert_2_2_0(topo, path)
+
     try:
         _check_topology_schema(topo, path)
     except ControllerError as e:
@@ -201,6 +206,30 @@ def load_topology(path):
     return topo
 
 
+def _convert_2_2_0(topo, topo_path):
+    """
+    Convert topologies from GNS3 2.2.x to 3.0
+
+    Changes:
+     * Convert Qemu and Docker node names to be a valid RFC1123 hostnames.
+     * Convert Dynamips and IOU node names to be a valid IOS hostnames.
+    """
+
+    topo["revision"] = 10
+
+    for node in topo.get("topology", {}).get("nodes", []):
+        if "properties" in node:
+            if node["node_type"] in ("qemu", "docker") and not is_rfc1123_hostname_valid(node["name"]):
+                new_name = to_rfc1123_hostname(node["name"])
+                log.info(f"Convert node name {node['name']} to {new_name} (RFC1123)")
+                node["name"] = new_name
+            if node["node_type"] in ("dynamips", "iou") and not is_ios_hostname_valid(node["name"] ):
+                new_name = to_ios_hostname(node["name"])
+                log.info(f"Convert node name {node['name']} to {new_name} (IOS)")
+                node["name"] = new_name
+    return topo
+
+
 def _convert_2_1_0(topo, topo_path):
     """
     Convert topologies from GNS3 2.1.x to 2.2

gns3server/controller/udp_link.py

@@ -213,7 +213,7 @@ class UDPLink(Link):
         :returns: Node where the capture should run
         """
 
-        ALWAYS_RUNNING_NODES_TYPE = ("cloud", "nat", "ethernet_switch", "ethernet_hub")
+        ALWAYS_RUNNING_NODES_TYPE = ("cloud", "nat", "ethernet_switch", "ethernet_hub", "frame_relay_switch", "atm_switch")
 
         for node in self._nodes:
             if (

gns3server/crash_report.py

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

gns3server/schemas/config.py

@@ -69,6 +69,7 @@ class QemuSettings(BaseModel):
     monitor_host: str = "127.0.0.1"
     enable_hardware_acceleration: bool = True
     require_hardware_acceleration: bool = False
+    allow_unsafe_options: bool = False
     model_config = ConfigDict(validate_assignment=True, str_strip_whitespace=True)
 
 
@@ -126,6 +127,7 @@ class ServerSettings(BaseModel):
     appliances_path: str = "~/GNS3/appliances"
     symbols_path: str = "~/GNS3/symbols"
     configs_path: str = "~/GNS3/configs"
+    resources_path: str = None
     default_symbol_theme: BuiltinSymbolTheme = BuiltinSymbolTheme.affinity_square_blue
     allow_raw_images: bool = True
     auto_discover_images: bool = True
@@ -144,6 +146,7 @@ class ServerSettings(BaseModel):
     default_nat_interface: str = None
     allow_remote_console: bool = False
     enable_builtin_templates: bool = True
+    install_builtin_appliances: bool = True
     model_config = ConfigDict(validate_assignment=True, str_strip_whitespace=True, use_enum_values=True)
 
     @field_validator("additional_images_paths", mode="before")

gns3server/schemas/controller/templates/__init__.py

@@ -45,7 +45,6 @@ class TemplateBase(BaseModel):
     category: Optional[Category] = None
     default_name_format: Optional[str] = None
     symbol: Optional[str] = None
-    builtin: Optional[bool] = None
     template_type: Optional[NodeType] = None
     compute_id: Optional[str] = None
     usage: Optional[str] = ""

gns3server/services/authentication.py

@@ -16,7 +16,7 @@
 
 
 from jose import JWTError, jwt
-from datetime import datetime, timedelta
+from datetime import datetime, timedelta, timezone
 import bcrypt
 
 from typing import Optional
@@ -48,7 +48,7 @@ class AuthService:
 
         if not expires_in:
             expires_in = Config.instance().settings.Controller.jwt_access_token_expire_minutes
-        expire = datetime.utcnow() + timedelta(minutes=expires_in)
+        expire = datetime.now(timezone.utc) + timedelta(minutes=expires_in)
         to_encode = {"sub": username, "exp": expire}
         if secret_key is None:
             secret_key = Config.instance().settings.Controller.jwt_secret_key

gns3server/services/templates.py

@@ -96,7 +96,7 @@ BUILTIN_TEMPLATES = [
         "name": "NAT",
         "default_name_format": "NAT{0}",
         "category": "guest",
-        "symbol": "cloud",
+        "symbol": "nat",
         "compute_id": None,
         "builtin": True,
     },

gns3server/static/web-ui/index.html

@@ -36,7 +36,7 @@
   <body class="mat-app-background" oncontextmenu="return false;">
     <app-root></app-root>
     <!-- Global site tag (gtag.js) - Google Analytics -->
-    <script async="" src="https://www.googletagmanager.com/gtag/js?id=G-5D6FZL9923"></script>
+    <script async="" src="https://www.googletagmanager.com/gtag/js?id=G-0BT7QQV1W1"></script>
     <script>
       window.dataLayer = window.dataLayer || [];
       function gtag() {
@@ -44,8 +44,8 @@
       }
       gtag('js', new Date());
 
-      gtag('config', 'G-5D6FZL9923');
+      gtag('config', 'G-0BT7QQV1W1');
     </script>
-  <script src="runtime.24fa95b7061d7056.js" type="module"></script><script src="polyfills.319c79dd175e50d0.js" type="module"></script><script src="main.8e8e3d55e78d84fc.js" type="module"></script>
+  <script src="runtime.24fa95b7061d7056.js" type="module"></script><script src="polyfills.319c79dd175e50d0.js" type="module"></script><script src="main.4185a8e61824af0d.js" type="module"></script>
 
 </body></html>