gns3-server 3.0.0__py3-none-any.whl

gns3server/config.py

@@ -0,0 +1,284 @@
+#
+# Copyright (C) 2021 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+Reads the configuration file and store the settings for the server.
+"""
+
+import sys
+import os
+import shutil
+import secrets
+import configparser
+
+from pydantic import ValidationError
+from .schemas import ServerConfig
+from .version import __version_info__
+from .utils.file_watcher import FileWatcher
+
+import logging
+
+log = logging.getLogger(__name__)
+
+
+class Config:
+    """
+    Configuration file management using configparser.
+
+    :param files: Array of configuration files (optional)
+    :param profile: Profile settings (default use standard config file)
+    """
+
+    def __init__(self, files=None, profile=None):
+
+        self._settings = None
+        self._files = files
+        self._profile = profile
+
+        if files and len(files):
+            if not os.access(files[0], os.R_OK) or not os.path.isfile(files[0]):
+                raise SystemExit(f"Unable to read configuration file: {files[0]}")
+            directory_name = os.path.dirname(files[0])
+            if not directory_name or directory_name == "":
+                files[0] = os.path.dirname(os.path.abspath(files[0])) + os.path.sep + files[0]
+            self._main_config_file = files[0]
+        else:
+            self._main_config_file = None
+
+        # Monitor configuration files for changes
+        self._watched_files = {}
+        self._watch_callback = []
+
+        appname = "GNS3"
+        version = f"{__version_info__[0]}.{__version_info__[1]}"
+
+        # On UNIX-like platforms, the configuration file location can be one of the following:
+        # 1: $HOME/.config/GNS3/gns3_server.conf
+        # 2: $HOME/.config/GNS3.conf
+        # 3: /etc/xdg/GNS3/gns3_server.conf
+        # 4: /etc/xdg/GNS3.conf
+        # 5: gns3_server.conf in the current working directory
+
+        home = os.path.expanduser("~")
+        server_filename = "gns3_server.conf"
+
+        if self._profile:
+            legacy_user_dir = os.path.join(home, ".config", appname, "profiles", self._profile)
+            versioned_user_dir = os.path.join(home, ".config", appname, version, "profiles", self._profile)
+        else:
+            legacy_user_dir = os.path.join(home, ".config", appname)
+            versioned_user_dir = os.path.join(home, ".config", appname, version)
+
+        if self._files is None and not hasattr(sys, "_called_from_test"):
+            self._files = [
+                os.path.join(os.getcwd(), server_filename),
+                os.path.join(versioned_user_dir, server_filename),
+                os.path.join(home, ".config", appname + ".conf"),
+                os.path.join("/etc/gns3", server_filename),
+                os.path.join("/etc/xdg", appname, server_filename),
+                os.path.join("/etc/xdg", appname + ".conf"),
+            ]
+
+        if self._files is None:
+            self._files = []
+
+        if self._main_config_file is None:
+
+            # TODO: migrate versioned config file from a previous version of GNS3 (for instance 2.2 -> 3.0) + support profiles
+            # migrate post version 2.2.0 config files if they exist
+            os.makedirs(versioned_user_dir, exist_ok=True)
+            try:
+                # migrate the server config file
+                old_server_config = os.path.join(legacy_user_dir, server_filename)
+                new_server_config = os.path.join(versioned_user_dir, server_filename)
+                if not os.path.exists(new_server_config) and os.path.exists(old_server_config):
+                    shutil.copyfile(old_server_config, new_server_config)
+            except OSError as e:
+                log.error(f"Cannot migrate old config files: {e}")
+
+            self._main_config_file = os.path.join(versioned_user_dir, server_filename)
+            for file in self._files:
+                if os.path.exists(file):
+                    self._main_config_file = file
+                    break
+
+        self.clear()
+        self._watch_config_file()
+
+    @property
+    def settings(self) -> ServerConfig:
+        """
+        Return the settings.
+        """
+
+        return self._settings
+
+    def listen_for_config_changes(self, callback):
+        """
+        Call the callback when the configuration file change
+        """
+        self._watch_callback.append(callback)
+
+    @property
+    def profile(self):
+        """
+        Settings profile
+        """
+        return self._profile
+
+    @property
+    def config_dir(self):
+        """
+        Return the directory where the configuration file is located.
+        """
+
+        return os.path.dirname(self._main_config_file)
+
+    @property
+    def controller_vars(self):
+        """
+        Return the controller variables file path.
+        """
+
+        controller_vars_filename = "gns3_controller.vars"
+        return os.path.join(self.config_dir, controller_vars_filename)
+
+    @property
+    def server_config(self):
+        """
+        Return the server configuration file path.
+        """
+
+        server_config_filename = "gns3_server.conf"
+        return os.path.join(self.config_dir, server_config_filename)
+
+    def clear(self):
+        """
+        Restart with a clean config
+        """
+
+        self.read_config()
+
+    def _watch_config_file(self):
+        """
+        Add config files to be monitored for changes.
+        """
+
+        for file in self._files:
+            if os.path.exists(file):
+                self._watched_files[file] = FileWatcher(file, self._config_file_change)
+
+    def _config_file_change(self, file_path):
+        """
+        Callback when a config file has been updated.
+        """
+
+        log.info(f"'{file_path}' has been updated, reloading the config...")
+        self.read_config()
+        for callback in self._watch_callback:
+            callback()
+
+    def reload(self):
+        """
+        Reload configuration
+        """
+
+        self.read_config()
+
+    def get_config_files(self):
+        """
+        Return the config files in use.
+        """
+
+        return self._watched_files
+
+    def _load_jwt_secret_key(self):
+        """
+        Load the JWT secret key.
+        """
+
+        jwt_secret_key_path = os.path.join(self._settings.Server.secrets_dir, "gns3_jwt_secret_key")
+        if not os.path.exists(jwt_secret_key_path):
+            log.info(f"No JWT secret key configured, generating one in '{jwt_secret_key_path}'...")
+            try:
+                with open(jwt_secret_key_path, "w+", encoding="utf-8") as fd:
+                    fd.write(secrets.token_hex(32))
+            except OSError as e:
+                log.error(f"Could not create JWT secret key file '{jwt_secret_key_path}': {e}")
+        try:
+            with open(jwt_secret_key_path, encoding="utf-8") as fd:
+                jwt_secret_key_content = fd.read()
+                self._settings.Controller.jwt_secret_key = jwt_secret_key_content
+        except OSError as e:
+            log.error(f"Could not read JWT secret key file '{jwt_secret_key_path}': {e}")
+
+    def _load_secret_files(self):
+        """
+        Load the secret files.
+        """
+
+        if not self._settings.Server.secrets_dir:
+            self._settings.Server.secrets_dir = os.path.dirname(self.server_config)
+
+        self._load_jwt_secret_key()
+
+    def read_config(self):
+        """
+        Read the configuration files and validate the settings.
+        """
+
+        config = configparser.ConfigParser(interpolation=None)
+        try:
+            parsed_files = config.read(self._files, encoding="utf-8")
+        except configparser.Error as e:
+            log.error("Can't parse configuration file: %s", str(e))
+            return
+        if not parsed_files:
+            log.warning("No configuration file could be found or read")
+            self._settings = ServerConfig()
+            return
+
+        for file in parsed_files:
+            log.info(f"Configuration file '{file}' loaded")
+            self._watched_files[file] = os.stat(file).st_mtime
+
+        try:
+            self._settings = ServerConfig(**config._sections)
+        except ValidationError as e:
+            log.critical(f"Could not validate configuration file settings: {e}")
+            raise
+
+        self._load_secret_files()
+
+    @staticmethod
+    def instance(*args, **kwargs):
+        """
+        Singleton to return only one instance of Config.
+
+        :returns: instance of Config
+        """
+
+        if not hasattr(Config, "_instance") or Config._instance is None:
+            Config._instance = Config(*args, **kwargs)
+        return Config._instance
+
+    @staticmethod
+    def reset():
+        """
+        Reset singleton
+        """
+
+        Config._instance = None

gns3server/config_samples/gns3_server.conf

@@ -0,0 +1,160 @@
+[Controller]
+
+; Options for JWT tokens (user authentication)
+jwt_secret_key = efd08eccec3bd0a1be2e086670e5efa90969c68d07e072d7354a76cea5e33d4e
+jwt_algorithm = HS256
+jwt_access_token_expire_minutes = 1440
+
+; Initial default super admin username
+; It cannot be changed once the controller has started once
+default_admin_username = admin
+
+; Initial default super admin password
+; It cannot be changed once the controller has started once
+default_admin_password = admin
+
+[Server]
+
+; Server name, default is what is returned by socket.gethostname()
+name = GNS3_Server
+
+; What protocol the server uses (http or https)
+protocol = http
+
+; IP where the server listen for connections
+host = 0.0.0.0
+; HTTP port for controlling the servers
+port = 3080
+
+; Secrets directory
+secrets_dir = /home/gns3/.config/GNS3/secrets
+
+; Options to enable SSL encryption
+enable_ssl = False
+certfile = /home/gns3/.config/GNS3/ssl/server.cert
+certkey = /home/gns3/.config/GNS3/ssl/server.key
+
+; Path where binary images are stored
+images_path = /home/gns3/GNS3/images
+
+; Additional paths to look for images
+additional_images_paths = /opt/images;/mnt/disk1/images
+
+; Path where user projects are stored
+projects_path = /home/gns3/GNS3/projects
+
+; Path where custom user appliances are stored
+appliances_path = /home/gns3/GNS3/appliances
+
+; 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"
+default_symbol_theme = Affinity-square-blue
+
+; Option to enable or disable raw images to be uploaded to the server
+allow_raw_images = True
+
+; Option to automatically discover images in the images directory
+auto_discover_images = True
+
+; Option to automatically send crash reports to the GNS3 team
+report_errors = True
+
+; First console port of the range allocated to devices
+console_start_port_range = 5000
+; Last console port of the range allocated to devices
+console_end_port_range = 10000
+
+; First VNC console port of the range allocated to devices.
+; The value MUST BE >= 5900 and <= 65535
+vnc_console_start_port_range = 5900
+; Last VNC console port of the range allocated to devices
+; The value MUST BE >= 5900 and <= 65535
+vnc_console_end_port_range = 10000
+
+; First port of the range allocated for inter-device communication. Two ports are allocated per link.
+udp_start_port_range = 20000
+; Last port of the range allocated for inter-device communication. Two ports are allocated per link
+udp_end_port_range = 30000
+
+; uBridge executable location, default: search in PATH
+;ubridge_path = ubridge
+
+; Username for compute HTTP authentication, "gns3" is the default if not specified
+compute_username = gns3
+; Password for compute HTTP authentication, a randomly generated password is used if not specified
+compute_password = gns3
+
+; Only allow these interfaces to be used by GNS3, for the Cloud node for example (Linux/OSX only)
+; Do not forget to allow virbr0 in order for the NAT node to work
+allowed_interfaces = eth0,eth1,virbr0
+
+; Specify the NAT interface to be used by the NAT node
+; Default is virbr0 on Linux (requires libvirt) and vmnet8 for other platforms (requires VMware)
+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
+
+[VPCS]
+; VPCS executable location, default: search in PATH
+;vpcs_path = vpcs
+
+[Dynamips]
+; Enable auxiliary console ports on IOS routers
+allocate_aux_console_ports = False
+mmap_support = True
+; Dynamips executable path, default: search in PATH
+;dynamips_path = dynamips
+sparse_memory_support = True
+ghost_ios_support = True
+
+[IOU]
+; Path of your .iourc file. If not provided, the file is searched in $HOME/.iourc
+iourc_path = /home/gns3/.iourc
+; Validate if the iourc license file is correct. If you turn this off and your licence is invalid IOU will not start and no errors will be shown.
+license_check = True
+
+[VirtualBox]
+; Path to the VBoxManage binary used to manage VirtualBox
+vboxmanage_path = vboxmanage
+
+[VMware]
+; Path to vmrun binary used to manage VMware
+vmrun_path = vmrun
+; First vmnet interface of the range that can be managed by the GNS3 server
+vmnet_start_range = 2
+; Last vmnet interface of the range that can be managed by the GNS3 server. It must be maximum 19 on Windows.
+vmnet_end_range = 255
+; block network traffic originating from the host OS
+block_host_traffic = False
+
+[Qemu]
+; Use Qemu monitor feature to communicate with Qemu VMs
+enable_monitor = True
+; IP used to listen for the monitor
+monitor_host = 127.0.0.1
+; !! Remember to add the gns3 user to the KVM group, otherwise you will not have read / write permissions to /dev/kvm !!
+; Enable hardware acceleration (all platforms)
+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/ios_base_startup-config.txt

@@ -0,0 +1,26 @@
+!
+service timestamps debug datetime msec
+service timestamps log datetime msec
+no service password-encryption
+!
+hostname %h
+!
+ip cef
+no ip domain-lookup
+no ip icmp rate-limit unreachable
+ip tcp synwait 5
+no cdp log mismatch duplex
+!
+line con 0
+ exec-timeout 0 0
+ logging synchronous
+ privilege level 15
+ no login
+line aux 0
+ exec-timeout 0 0
+ logging synchronous
+ privilege level 15
+ no login
+!
+!
+end

gns3server/configs/ios_etherswitch_startup-config.txt

@@ -0,0 +1,181 @@
+!
+service timestamps debug datetime msec
+service timestamps log datetime msec
+no service password-encryption
+no service dhcp
+!
+hostname %h
+!
+ip cef
+no ip routing
+no ip domain-lookup
+no ip icmp rate-limit unreachable
+ip tcp synwait 5
+no cdp log mismatch duplex
+vtp file nvram:vlan.dat
+!
+!
+interface FastEthernet0/0
+ description *** Unused for Layer2 EtherSwitch ***
+ no ip address
+ shutdown
+!
+interface FastEthernet0/1
+ description *** Unused for Layer2 EtherSwitch ***
+ no ip address
+ shutdown
+!
+interface FastEthernet1/0
+ no shutdown
+ duplex full
+ speed 100
+!
+interface FastEthernet1/1
+ no shutdown
+ duplex full
+ speed 100
+!
+interface FastEthernet1/2
+ no shutdown
+ duplex full
+ speed 100
+!
+interface FastEthernet1/3
+ no shutdown
+ duplex full
+ speed 100
+!
+interface FastEthernet1/4
+ no shutdown
+ duplex full
+ speed 100
+!
+interface FastEthernet1/5
+ no shutdown
+ duplex full
+ speed 100
+!
+interface FastEthernet1/6
+ no shutdown
+ duplex full
+ speed 100
+!
+interface FastEthernet1/7
+ no shutdown
+ duplex full
+ speed 100
+!
+interface FastEthernet1/8
+ no shutdown
+ duplex full
+ speed 100
+!
+interface FastEthernet1/9
+ no shutdown
+ duplex full
+ speed 100
+!
+interface FastEthernet1/10
+ no shutdown
+ duplex full
+ speed 100
+!
+interface FastEthernet1/11
+ no shutdown
+ duplex full
+ speed 100
+!
+interface FastEthernet1/12
+ no shutdown
+ duplex full
+ speed 100
+!
+interface FastEthernet1/13
+ no shutdown
+ duplex full
+ speed 100
+!
+interface FastEthernet1/14
+ no shutdown
+ duplex full
+ speed 100
+!
+interface FastEthernet1/15
+ no shutdown
+ duplex full
+ speed 100
+!
+interface Vlan1
+ no ip address
+ shutdown
+!
+!
+line con 0
+ exec-timeout 0 0
+ logging synchronous
+ privilege level 15
+ no login
+line aux 0
+ exec-timeout 0 0
+ logging synchronous
+ privilege level 15
+ no login
+!
+!
+banner exec $
+
+***************************************************************
+This is a normal Router with a SW module inside (NM-16ESW)
+It has been preconfigured with hard coded speed and duplex
+
+To create vlans use the command "vlan database" from exec mode
+After creating all desired vlans use "exit" to apply the config
+
+To view existing vlans use the command "show vlan-switch brief"
+
+Warning: You are using an old IOS image for this router.
+Please update the IOS to enable the "macro" command!
+***************************************************************
+
+$
+!
+!Warning: If the IOS is old and doesn't support macro, it will stop the configuration loading from this point!
+!
+macro name add_vlan
+end
+vlan database
+vlan $v
+exit
+@
+macro name del_vlan
+end
+vlan database
+no vlan $v
+exit
+@
+!
+!
+banner exec $
+
+***************************************************************
+This is a normal Router with a Switch module inside (NM-16ESW)
+It has been pre-configured with hard-coded speed and duplex
+
+To create vlans use the command "vlan database" in exec mode
+After creating all desired vlans use "exit" to apply the config
+
+To view existing vlans use the command "show vlan-switch brief"
+
+Alias(exec)     : vl   - "show vlan-switch brief" command
+Alias(configure): va X - macro to add vlan X
+Alias(configure): vd X - macro to delete vlan X
+***************************************************************
+
+$
+!
+alias configure va macro global trace add_vlan $v
+alias configure vd macro global trace del_vlan $v
+alias exec vl show vlan-switch brief
+!
+!
+end