gns3-server 3.0.0__py3-none-any.whl

gns3server/utils/interfaces.py

@@ -0,0 +1,254 @@
+#
+# Copyright (C) 2014 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/>.
+
+
+import os
+import sys
+import socket
+import struct
+import psutil
+
+from gns3server.compute.compute_error import ComputeError
+from gns3server.config import Config
+
+if psutil.version_info < (3, 0, 0):
+    raise Exception(
+        "psutil version should >= 3.0.0. If you are under Ubuntu/Debian install gns3 via apt instead of pip"
+    )
+
+import logging
+
+log = logging.getLogger(__name__)
+
+
+def _get_windows_interfaces_from_registry():
+
+    import winreg
+
+    # HKLM\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters\Interfaces
+    interfaces = []
+    try:
+        hkey = winreg.OpenKey(winreg.HKEY_LOCAL_MACHINE, r"SOFTWARE\Microsoft\Windows NT\CurrentVersion\NetworkCards")
+        for index in range(winreg.QueryInfoKey(hkey)[0]):
+            network_card_id = winreg.EnumKey(hkey, index)
+            hkeycard = winreg.OpenKey(hkey, network_card_id)
+            guid, _ = winreg.QueryValueEx(hkeycard, "ServiceName")
+            netcard, _ = winreg.QueryValueEx(hkeycard, "Description")
+            connection = (
+                r"SYSTEM\CurrentControlSet\Control\Network\{4D36E972-E325-11CE-BFC1-08002BE10318}"
+                + fr"\{guid}\Connection"
+            )
+            hkeycon = winreg.OpenKey(winreg.HKEY_LOCAL_MACHINE, connection)
+            name, _ = winreg.QueryValueEx(hkeycon, "Name")
+            interface = fr"SYSTEM\CurrentControlSet\Services\Tcpip\Parameters\Interfaces\{guid}"
+            hkeyinterface = winreg.OpenKey(winreg.HKEY_LOCAL_MACHINE, interface)
+            is_dhcp_enabled, _ = winreg.QueryValueEx(hkeyinterface, "EnableDHCP")
+            if is_dhcp_enabled:
+                ip_address, _ = winreg.QueryValueEx(hkeyinterface, "DhcpIPAddress")
+                netmask, _ = winreg.QueryValueEx(hkeyinterface, "DhcpSubnetMask")
+            else:
+                ip_address, _ = winreg.QueryValueEx(hkeyinterface, "IPAddress")
+                netmask, _ = winreg.QueryValueEx(hkeyinterface, "SubnetMask")
+                if ip_address:
+                    # get the first IPv4 address only
+                    ip_address = ip_address[0]
+            npf_interface = "\\Device\\NPF_{guid}".format(guid=guid)
+            interfaces.append(
+                {
+                    "id": npf_interface,
+                    "name": name,
+                    "ip_address": ip_address,
+                    "mac_address": "",  # TODO: find MAC address in registry
+                    "netcard": netcard,
+                    "netmask": netmask,
+                    "type": "ethernet",
+                }
+            )
+            winreg.CloseKey(hkeyinterface)
+            winreg.CloseKey(hkeycon)
+            winreg.CloseKey(hkeycard)
+        winreg.CloseKey(hkey)
+    except OSError as e:
+        log.error(f"could not read registry information: {e}")
+
+    return interfaces
+
+
+def get_windows_interfaces():
+    """
+    Get Windows interfaces.
+
+    :returns: list of windows interfaces
+    """
+
+    import win32com.client
+    import pywintypes
+
+    interfaces = []
+    try:
+        locator = win32com.client.Dispatch("WbemScripting.SWbemLocator")
+        service = locator.ConnectServer(".", r"root\cimv2")
+        network_configs = service.InstancesOf("Win32_NetworkAdapterConfiguration")
+        # more info on Win32_NetworkAdapter: http://msdn.microsoft.com/en-us/library/aa394216%28v=vs.85%29.aspx
+        for adapter in service.InstancesOf("Win32_NetworkAdapter"):
+            if adapter.NetConnectionStatus == 2 or adapter.NetConnectionStatus == 7:
+                # adapter is connected or media disconnected
+                ip_address = ""
+                netmask = ""
+                for network_config in network_configs:
+                    if network_config.InterfaceIndex == adapter.InterfaceIndex:
+                        if network_config.IPAddress:
+                            # get the first IPv4 address only
+                            ip_address = network_config.IPAddress[0]
+                            netmask = network_config.IPSubnet[0]
+                        break
+                npf_interface = "\\Device\\NPF_{guid}".format(guid=adapter.GUID)
+                interfaces.append(
+                    {
+                        "id": npf_interface,
+                        "name": adapter.NetConnectionID,
+                        "ip_address": ip_address,
+                        "mac_address": adapter.MACAddress,
+                        "netcard": adapter.name,
+                        "netmask": netmask,
+                        "type": "ethernet",
+                    }
+                )
+    except (AttributeError, pywintypes.com_error):
+        log.warning("Could not use the COM service to retrieve interface info, trying using the registry...")
+        return _get_windows_interfaces_from_registry()
+
+    return interfaces
+
+
+def has_netmask(interface_name):
+    """
+    Checks if an interface has a netmask.
+
+    :param interface: interface name
+
+    :returns: boolean
+    """
+    for interface in interfaces():
+        if interface["name"] == interface_name:
+            if interface["netmask"] and len(interface["netmask"]) > 0:
+                return True
+            return False
+    return False
+
+
+def is_interface_up(interface):
+    """
+    Checks if an interface is up.
+
+    :param interface: interface name
+
+    :returns: boolean
+    """
+
+    if sys.platform.startswith("linux"):
+
+        if interface not in psutil.net_if_addrs():
+            return False
+
+        import fcntl
+
+        SIOCGIFFLAGS = 0x8913
+        try:
+            with socket.socket(socket.AF_INET, socket.SOCK_DGRAM) as s:
+                result = fcntl.ioctl(s.fileno(), SIOCGIFFLAGS, interface + "\0" * 256)
+                (flags,) = struct.unpack("H", result[16:18])
+                if flags & 1:  # check if the up bit is set
+                    return True
+            return False
+        except OSError as e:
+            raise ComputeError(f"Exception when checking if {interface} is up: {e}")
+    else:
+        # TODO: Windows & OSX support
+        return True
+
+
+def is_interface_bridge(interface):
+    """
+    :returns: True if interface is a bridge
+    """
+    return os.path.exists(os.path.join("/sys/class/net/", interface, "bridge"))
+
+
+def interfaces():
+    """
+    Gets the network interfaces on this server.
+
+    :returns: list of network interfaces
+    """
+
+    results = []
+    allowed_interfaces = Config.instance().settings.Server.allowed_interfaces
+    net_if_addrs = psutil.net_if_addrs()
+    for interface in sorted(net_if_addrs.keys()):
+        if allowed_interfaces and interface not in allowed_interfaces and not interface.startswith("gns3tap"):
+            log.warning(f"Interface '{interface}' is not allowed to be used on this server")
+            continue
+        ip_address = ""
+        mac_address = ""
+        netmask = ""
+        interface_type = "ethernet"
+        for addr in net_if_addrs[interface]:
+            # get the first available IPv4 address only
+            if addr.family == socket.AF_INET:
+                ip_address = addr.address
+                netmask = addr.netmask
+            if addr.family == psutil.AF_LINK:
+                mac_address = addr.address
+        if interface.startswith("tap"):
+            # found no way to reliably detect a TAP interface
+            interface_type = "tap"
+        results.append(
+            {
+                "id": interface,
+                "name": interface,
+                "ip_address": ip_address,
+                "netmask": netmask,
+                "mac_address": mac_address,
+                "type": interface_type,
+            }
+        )
+
+    # This interface have special behavior
+    for result in results:
+        result["special"] = False
+        for special_interface in (
+            "lo",
+            "vmnet",
+            "vboxnet",
+            "docker",
+            "lxcbr",
+            "virbr",
+            "ovs-system",
+            "veth",
+            "fw",
+            "p2p",
+            "bridge",
+            "vmware",
+            "virtualbox",
+            "gns3",
+        ):
+            if result["name"].lower().startswith(special_interface):
+                result["special"] = True
+        for special_interface in "-nic":
+            if result["name"].lower().endswith(special_interface):
+                result["special"] = True
+    return results

gns3server/utils/notification_queue.py

@@ -0,0 +1,79 @@
+#!/usr/bin/env python
+#
+# Copyright (C) 2016 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/>.
+
+import asyncio
+import json
+import psutil
+
+from gns3server.utils.cpu_percent import CpuPercent
+from gns3server.utils.path import get_default_project_directory
+
+import logging
+
+log = logging.getLogger(__name__)
+
+
+class NotificationQueue(asyncio.Queue):
+    """
+    Queue returned by the notification manager.
+    """
+
+    def __init__(self):
+        super().__init__()
+        self._first = True
+
+    async def get(self, timeout):
+        """
+        When timeout is expire we send a ping notification with server information
+        """
+
+        # At first get we return a ping so the client immediately receives data
+        if self._first:
+            self._first = False
+            return ("ping", self._getPing(), {})
+
+        try:
+            (action, msg, kwargs) = await asyncio.wait_for(super().get(), timeout)
+        except asyncio.TimeoutError:
+            return ("ping", self._getPing(), {})
+        return (action, msg, kwargs)
+
+    def _getPing(self):
+        """
+        Return the content of the ping notification
+        """
+        msg = {"cpu_usage_percent": 0, "memory_usage_percent": 0, "disk_usage_percent": 0}
+        # Non blocking call in order to get cpu usage. First call will return 0
+        try:
+            msg["cpu_usage_percent"] = CpuPercent.get(interval=None)
+            msg["memory_usage_percent"] = psutil.virtual_memory().percent
+            msg["disk_usage_percent"] = psutil.disk_usage(get_default_project_directory()).percent
+        except OSError as e:
+            log.warning(f"Could not get CPU and memory usage from psutil: {e}")
+        return msg
+
+    async def get_json(self, timeout):
+        """
+        Get a message as a JSON
+        """
+        (action, msg, kwargs) = await self.get(timeout)
+        if hasattr(msg, "asdict"):
+            msg = {"action": action, "event": msg.asdict()}
+        else:
+            msg = {"action": action, "event": msg}
+        msg.update(kwargs)
+        return json.dumps(msg, sort_keys=True)

gns3server/utils/path.py

@@ -0,0 +1,76 @@
+#!/usr/bin/env python
+#
+# Copyright (C) 2016 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/>.
+
+import os
+
+from pathlib import Path
+from fastapi import HTTPException, status
+from ..config import Config
+
+
+def get_default_project_directory():
+    """
+    Return the default location for the project directory
+    depending of the operating system
+    """
+
+    server_config = Config.instance().settings.Server
+    path = os.path.expanduser(server_config.projects_path)
+    path = os.path.normpath(path)
+    try:
+        os.makedirs(path, exist_ok=True)
+    except OSError as e:
+        raise HTTPException(status_code=status.HTTP_409_CONFLICT, detail=f"Could not create project directory: {e}")
+    return path
+
+
+def is_safe_path(file_path: str, basedir: str) -> bool:
+    """
+    Check that file path is safe.
+    (the file is stored inside directory or one of its sub-directory)
+    """
+
+    test_path = (Path(basedir) / file_path).resolve()
+    return Path(basedir).resolve() in test_path.resolve().parents
+
+
+def check_path_allowed(path: str):
+    """
+    If the server is non local raise an error if
+    the path is outside project directories
+
+    Raise a 403 in case of error
+    """
+
+    project_directory = get_default_project_directory()
+    if len(os.path.commonprefix([project_directory, path])) == len(project_directory):
+        return
+
+    raise HTTPException(status_code=status.HTTP_403_FORBIDDEN, detail=f"The path {path} is not allowed")
+
+
+def get_mountpoint(path: str):
+    """
+    Find the mount point of a path.
+    """
+
+    path = os.path.abspath(path)
+    while path != os.path.sep:
+        if os.path.ismount(path):
+            return path
+        path = os.path.abspath(os.path.join(path, os.pardir))
+    return path

gns3server/utils/picture.py

@@ -0,0 +1,146 @@
+#!/usr/bin/env python
+#
+# Copyright (C) 2016 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/>.
+
+import re
+import io
+import struct
+from xml.etree.ElementTree import ElementTree, ParseError
+
+
+def get_size(data, default_width=0, default_height=0):
+    """
+    Get image size
+    :param data: A buffer with image content
+    :return: Tuple (width, height, filetype)
+    """
+
+    height = default_height
+    width = default_width
+    filetype = None
+
+    # Original version:
+    # https://github.com/shibukawa/imagesize_py
+    #
+    # The MIT License (MIT)
+    #
+    # Copyright © 2016 Yoshiki Shibukawa
+    #
+    # Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+    #
+    # The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+    #
+    # THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+    size = len(data)
+    # handle GIFs
+    if size >= 10 and data[:6] in (b"GIF87a", b"GIF89a"):
+        # Check to see if content_type is correct
+        try:
+            width, height = struct.unpack("<hh", data[6:10])
+            filetype = "gif"
+        except struct.error:
+            raise ValueError("Invalid GIF file")
+    # see png edition spec bytes are below chunk length then and finally the
+    elif size >= 24 and data.startswith(b"\211PNG\r\n\032\n") and data[12:16] == b"IHDR":
+        try:
+            width, height = struct.unpack(">LL", data[16:24])
+            filetype = "png"
+        except struct.error:
+            raise ValueError("Invalid PNG file")
+    # Maybe this is for an older PNG version.
+    elif size >= 16 and data.startswith(b"\211PNG\r\n\032\n"):
+        # Check to see if we have the right content type
+        try:
+            width, height = struct.unpack(">LL", data[8:16])
+            filetype = "png"
+        except struct.error:
+            raise ValueError("Invalid PNG file")
+    # handle JPEGs
+    elif size >= 2 and data.startswith(b"\377\330"):
+        try:
+            # Not very efficient to copy data to a buffer
+            fhandle = io.BytesIO(data)
+            size = 2
+            ftype = 0
+            while not 0xC0 <= ftype <= 0xCF:
+                fhandle.seek(size, 1)
+                byte = fhandle.read(1)
+                while ord(byte) == 0xFF:
+                    byte = fhandle.read(1)
+                ftype = ord(byte)
+                size = struct.unpack(">H", fhandle.read(2))[0] - 2
+            # We are at a SOFn block
+            fhandle.seek(1, 1)  # Skip `precision' byte.
+            height, width = struct.unpack(">HH", fhandle.read(4))
+            filetype = "jpg"
+        except struct.error:
+            raise ValueError("Invalid JPEG file")
+    # End of https://github.com/shibukawa/imagesize_py
+
+    # handle SVG
+    elif size >= 10 and (data.startswith(b"<?xml") or data.startswith(b"<svg")):
+        filetype = "svg"
+        fhandle = io.BytesIO(data)
+        tree = ElementTree()
+        try:
+            tree.parse(fhandle)
+        except ParseError:
+            raise ValueError("Invalid SVG file")
+
+        root = tree.getroot()
+
+        try:
+            width_attr = root.attrib.get("width", "100%")
+            height_attr = root.attrib.get("height", "100%")
+            if width_attr.endswith("%") or height_attr.endswith("%"):
+                # check to viewBox attribute if width or height value is a percentage
+                viewbox = root.attrib.get("viewBox")
+                if not viewbox:
+                    raise ValueError("Invalid SVG file: missing viewBox attribute")
+                _, _, viewbox_width, viewbox_height = re.split(r"[\s,]+", viewbox)
+            if width_attr.endswith("%"):
+                width = _svg_convert_size(viewbox_width, width_attr)
+            else:
+                width = _svg_convert_size(width_attr)
+            if height_attr.endswith("%"):
+                height = _svg_convert_size(viewbox_height, height_attr)
+            else:
+                height = _svg_convert_size(height_attr)
+        except (AttributeError, IndexError) as e:
+            raise ValueError(f"Invalid SVG file: {e}")
+
+    return width, height, filetype
+
+
+def _svg_convert_size(size, percent=None):
+    """
+    Convert svg size to the px version
+
+    :param size: String with the size
+    :param percent: String with the percentage, None = 100%
+    """
+
+    # https://www.w3.org/TR/SVG/coords.html#Units
+    conversion_table = {"pt": 1.25, "pc": 15, "mm": 3.543307, "cm": 35.43307, "in": 90, "px": 1}
+    factor = 1.0
+    if len(size) >= 3:
+        if size[-2:] in conversion_table:
+            factor = conversion_table[size[-2:]]
+            size = size[:-2]
+    if percent:
+        factor *= float(percent.rstrip("%")) / 100.0
+    return round(float(size) * factor)

gns3server/utils/qt.py

@@ -0,0 +1,44 @@
+#!/usr/bin/env python
+#
+# Copyright (C) 2016 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/>.
+
+"""
+Helper for conversion of Qt stuff
+"""
+
+
+def qt_font_to_style(font, color):
+    """
+    Convert a Qt font to CSS style
+    """
+    if font is None:
+        font = "TypeWriter,10,-1,5,75,0,0,0,0,0"
+    font_info = font.split(",")
+    style = f"font-family: {font_info[0]};font-size: {font_info[1]};"
+    if font_info[4] == "75":
+        style += "font-weight: bold;"
+    if font_info[5] == "1":
+        style += "font-style: italic;"
+
+    if color is None:
+        color = "000000"
+    if len(color) == 9:
+        style += "fill: #" + color[-6:] + ";"
+        style += f"fill-opacity: {round(1.0 / 255 * int(color[:3][-2:], base=16), 2)};"
+    else:
+        style += "fill: #" + color[-6:] + ";"
+        style += f"fill-opacity: {1.0};"
+    return style