gns3-server 3.0.0__py3-none-any.whl

gns3server/logger.py

@@ -0,0 +1,164 @@
+#!/usr/bin/env python
+#
+# Copyright (C) 2015 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/>.
+
+"""Provide a pretty logging on console"""
+
+
+import logging
+import sys
+import os
+import shutil
+import gzip
+
+from logging.handlers import RotatingFileHandler
+
+
+class ColouredFormatter(logging.Formatter):
+    RESET = "\x1B[0m"
+    RED = "\x1B[31m"
+    YELLOW = "\x1B[33m"
+    GREEN = "\x1B[32m"
+    PINK = "\x1b[35m"
+
+    def format(self, record, colour=False):
+
+        message = super().format(record)
+
+        if not colour:
+            return message.replace("#RESET#", "")
+
+        level_no = record.levelno
+        if level_no >= logging.CRITICAL:
+            colour = self.RED
+        elif level_no >= logging.ERROR:
+            colour = self.RED
+        elif level_no >= logging.WARNING:
+            colour = self.YELLOW
+        elif level_no >= logging.INFO:
+            colour = self.GREEN
+        elif level_no >= logging.DEBUG:
+            colour = self.PINK
+        else:
+            colour = self.RESET
+
+        message = message.replace("#RESET#", self.RESET)
+
+        # do not show uvicorn filename and line number in logs
+        if record.name.startswith("uvicorn"):
+            message = message.replace(f"{record.name}:{record.lineno}", "uvicorn")
+
+        message = f"{colour}{message}{self.RESET}"
+
+        return message
+
+
+class ColouredStreamHandler(logging.StreamHandler):
+    def format(self, record, colour=False):
+
+        if not isinstance(self.formatter, ColouredFormatter):
+            self.formatter = ColouredFormatter()
+
+        return self.formatter.format(record, colour)
+
+    def emit(self, record):
+
+        stream = self.stream
+        try:
+            msg = self.format(record, stream.isatty())
+            stream.write(msg)
+            stream.write(self.terminator)
+            self.flush()
+        # On OSX when frozen flush raise a BrokenPipeError
+        except BrokenPipeError:
+            pass
+        except Exception:
+            self.handleError(record)
+
+
+class WinStreamHandler(logging.StreamHandler):
+    def emit(self, record):
+
+        if sys.stdin.encoding != "utf-8":
+            record = record
+
+        stream = self.stream
+        try:
+            msg = self.formatter.format(record, stream.isatty())
+            stream.write(msg.encode(stream.encoding, errors="replace").decode(stream.encoding))
+            stream.write(self.terminator)
+            self.flush()
+        except Exception:
+            self.handleError(record)
+
+
+class LogFilter:
+    """
+    This filter some noise from the logs
+    """
+
+    def filter(record):
+        if isinstance(record.msg, str) and "/settings" in record.msg and "200" in record.msg:
+            return 0
+        return 1
+
+
+class CompressedRotatingFileHandler(RotatingFileHandler):
+    """
+    Custom rotating file handler with compression support.
+    """
+
+    def doRollover(self):
+        if self.stream:
+            self.stream.close()
+        if self.backupCount > 0:
+            for i in range(self.backupCount - 1, 0, -1):
+                sfn = "%s.%d.gz" % (self.baseFilename, i)
+                dfn = "%s.%d.gz" % (self.baseFilename, i + 1)
+                if os.path.exists(sfn):
+                    if os.path.exists(dfn):
+                        os.remove(dfn)
+                    os.rename(sfn, dfn)
+            dfn = self.baseFilename + ".1.gz"
+            if os.path.exists(dfn):
+                os.remove(dfn)
+            with open(self.baseFilename, "rb") as f_in, gzip.open(dfn, "wb") as f_out:
+                shutil.copyfileobj(f_in, f_out)
+        self.mode = "w"
+        self.stream = self._open()
+
+
+def init_logger(level, logfile=None, max_bytes=10000000, backup_count=10, compression=True, quiet=False):
+    if logfile and len(logfile) > 0:
+        if compression:
+            stream_handler = CompressedRotatingFileHandler(logfile, maxBytes=max_bytes, backupCount=backup_count)
+        else:
+            stream_handler = RotatingFileHandler(logfile, maxBytes=max_bytes, backupCount=backup_count)
+        stream_handler.formatter = ColouredFormatter(
+            "{asctime} {levelname} {filename}:{lineno} {message}", "%Y-%m-%d %H:%M:%S", "{"
+        )
+    else:
+        stream_handler = ColouredStreamHandler(sys.stdout)
+        stream_handler.formatter = ColouredFormatter(
+            "{asctime} {levelname} {name}:{lineno}#RESET# {message}", "%Y-%m-%d %H:%M:%S", "{"
+        )
+    if quiet:
+        stream_handler.addFilter(logging.Filter(name="user_facing"))
+        logging.getLogger("user_facing").propagate = False
+    if level > logging.DEBUG:
+        stream_handler.addFilter(LogFilter)
+    logging.basicConfig(level=level, handlers=[stream_handler])
+    return stream_handler

gns3server/main.py

@@ -0,0 +1,81 @@
+#!/usr/bin/env python
+#
+# Copyright (C) 2015 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/>.
+
+"""
+Entry point of the server. It's support daemonize the process
+"""
+
+# WARNING
+# Due to buggy user machines we choose to put this as the first loading
+# otherwise the egg cache is initialized in his standard location and
+# if is not writetable the application crash. It's the user fault
+# because one day the user as used sudo to run an egg and break his
+# filesystem permissions, but it's a common mistake.
+import gns3server.utils.get_resource
+
+import os
+import sys
+import asyncio
+
+
+def daemonize():
+    """
+    Do the UNIX double-fork magic for properly detaching process
+    """
+    try:
+        pid = os.fork()
+        if pid > 0:
+            # Exit first parent
+            sys.exit(0)
+    except OSError as e:
+        print("First fork failed: %d (%s)\n" % (e.errno, e.strerror), file=sys.stderr)
+        sys.exit(1)
+
+    # Decouple from parent environment
+    os.setsid()
+    os.umask(0o007)
+
+    # Do second fork
+    try:
+        pid = os.fork()
+        if pid > 0:
+            # Exit from second parent
+            sys.exit(0)
+    except OSError as e:
+        print("Second fork failed: %d (%s)\n" % (e.errno, e.strerror), file=sys.stderr)
+        sys.exit(1)
+
+
+def main():
+    """
+    Entry point for GNS3 server
+    """
+
+    if sys.platform.startswith("win"):
+        raise SystemExit("Windows is not a supported platform to run the GNS3 server")
+    if "--daemon" in sys.argv:
+        daemonize()
+    from gns3server.server import Server
+
+    try:
+        asyncio.run(Server().run())
+    except KeyboardInterrupt:
+        pass
+
+
+if __name__ == "__main__":
+    main()

gns3server/schemas/__init__.py

@@ -0,0 +1,85 @@
+#
+# Copyright (C) 2020 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/>.
+
+# General schemas
+from .config import ServerConfig
+from .common import ErrorMessage
+from .version import Version
+
+# Controller schemas
+from .controller.links import LinkCreate, LinkUpdate, Link
+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
+from .controller.appliances import ApplianceVersion, Appliance
+from .controller.drawings import Drawing
+from .controller.gns3vm import GNS3VM
+from .controller.nodes import NodeCreate, NodeUpdate, NodeDuplicate, NodeCapture, Node
+from .controller.projects import ProjectCreate, ProjectUpdate, ProjectDuplicate, Project, ProjectFile, ProjectCompression
+from .controller.users import UserCreate, UserUpdate, LoggedInUserUpdate, User, Credentials, UserGroupCreate, UserGroupUpdate, UserGroup
+from .controller.rbac import RoleCreate, RoleUpdate, Role, Privilege, ACECreate, ACEUpdate, ACE
+from .controller.pools import Resource, ResourceCreate, ResourcePoolCreate, ResourcePoolUpdate, ResourcePool
+from .controller.tokens import Token
+from .controller.snapshots import SnapshotCreate, Snapshot
+from .controller.iou_license import IOULicense
+from .controller.capabilities import Capabilities
+
+# Controller template schemas
+from .controller.templates.vpcs_templates import VPCSTemplate, VPCSTemplateUpdate
+from .controller.templates.cloud_templates import CloudTemplate, CloudTemplateUpdate
+from .controller.templates.iou_templates import IOUTemplate, IOUTemplateUpdate
+from .controller.templates.docker_templates import DockerTemplate, DockerTemplateUpdate
+from .controller.templates.ethernet_hub_templates import EthernetHubTemplate, EthernetHubTemplateUpdate
+from .controller.templates.ethernet_switch_templates import EthernetSwitchTemplate, EthernetSwitchTemplateUpdate
+from .controller.templates.virtualbox_templates import VirtualBoxTemplate, VirtualBoxTemplateUpdate
+from .controller.templates.vmware_templates import VMwareTemplate, VMwareTemplateUpdate
+from .controller.templates.qemu_templates import QemuTemplate, QemuTemplateUpdate
+from .controller.templates.dynamips_templates import (
+    DynamipsTemplate,
+    C1700DynamipsTemplate,
+    C1700DynamipsTemplateUpdate,
+    C2600DynamipsTemplate,
+    C2600DynamipsTemplateUpdate,
+    C2691DynamipsTemplate,
+    C2691DynamipsTemplateUpdate,
+    C3600DynamipsTemplate,
+    C3600DynamipsTemplateUpdate,
+    C3725DynamipsTemplate,
+    C3725DynamipsTemplateUpdate,
+    C3745DynamipsTemplate,
+    C3745DynamipsTemplateUpdate,
+    C7200DynamipsTemplate,
+    C7200DynamipsTemplateUpdate
+)
+
+# Compute schemas
+from .compute.nios import UDPNIO, TAPNIO, EthernetNIO
+from .compute.atm_switch_nodes import ATMSwitchCreate, ATMSwitchUpdate, ATMSwitch
+from .compute.cloud_nodes import CloudCreate, CloudUpdate, Cloud
+from .compute.docker_nodes import DockerCreate, DockerUpdate, Docker
+from .compute.dynamips_nodes import DynamipsCreate, DynamipsUpdate, Dynamips
+from .compute.ethernet_hub_nodes import EthernetHubCreate, EthernetHubUpdate, EthernetHub
+from .compute.ethernet_switch_nodes import EthernetSwitchCreate, EthernetSwitchUpdate, EthernetSwitch
+from .compute.frame_relay_switch_nodes import FrameRelaySwitchCreate, FrameRelaySwitchUpdate, FrameRelaySwitch
+from .compute.qemu_nodes import QemuCreate, QemuUpdate, Qemu
+from .compute.iou_nodes import IOUCreate, IOUUpdate, IOUStart, IOU
+from .compute.nat_nodes import NATCreate, NATUpdate, NAT
+from .compute.vpcs_nodes import VPCSCreate, VPCSUpdate, VPCS
+from .compute.vmware_nodes import VMwareCreate, VMwareUpdate, VMware
+from .compute.virtualbox_nodes import VirtualBoxCreate, VirtualBoxUpdate, VirtualBox
+
+# Schemas for both controller and compute
+from .qemu_disk_image import QemuDiskImageFormat, QemuDiskImageCreate, QemuDiskImageUpdate

gns3server/schemas/common.py

@@ -0,0 +1,71 @@
+#
+# Copyright (C) 2020 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/>.
+
+from pydantic import BaseModel, Field
+from typing import Optional
+from enum import Enum
+
+
+class ErrorMessage(BaseModel):
+    """
+    Error message.
+    """
+
+    message: str
+
+
+class NodeStatus(str, Enum):
+    """
+    Supported node statuses.
+    """
+
+    stopped = "stopped"
+    started = "started"
+    suspended = "suspended"
+
+
+class CustomAdapter(BaseModel):
+    """
+    Custom adapter data.
+    """
+
+    adapter_number: int
+    port_name: Optional[str] = None
+    adapter_type: Optional[str] = None
+    mac_address: Optional[str] = Field(None, pattern="^([0-9a-fA-F]{2}[:]){5}([0-9a-fA-F]{2})$")
+
+
+class ConsoleType(str, Enum):
+    """
+    Supported console types.
+    """
+
+    vnc = "vnc"
+    telnet = "telnet"
+    http = "http"
+    https = "https"
+    spice = "spice"
+    spice_agent = "spice+agent"
+    none = "none"
+
+
+class AuxType(str, Enum):
+    """
+    Supported auxiliary console types.
+    """
+
+    telnet = "telnet"
+    none = "none"

gns3server/schemas/compute/atm_switch_nodes.py

@@ -0,0 +1,55 @@
+#
+# Copyright (C) 2020 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/>.
+
+from pydantic import BaseModel
+from typing import Optional
+from uuid import UUID
+
+from ..common import NodeStatus
+
+
+class ATMSwitchBase(BaseModel):
+    """
+    Common ATM switch properties.
+    """
+
+    name: str = None
+    node_id: UUID = None
+    usage: Optional[str] = None
+    mappings: Optional[dict] = None
+
+
+class ATMSwitchCreate(ATMSwitchBase):
+    """
+    Properties to create an ATM switch node.
+    """
+
+    node_id: Optional[UUID] = None
+
+
+class ATMSwitchUpdate(ATMSwitchBase):
+    """
+    Properties to update an ATM switch node.
+    """
+
+    name: Optional[str] = None
+    node_id: Optional[UUID] = None
+
+
+class ATMSwitch(ATMSwitchBase):
+
+    project_id: UUID
+    status: Optional[NodeStatus] = None

gns3server/schemas/compute/cloud_nodes.py

@@ -0,0 +1,137 @@
+#
+# Copyright (C) 2020 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/>.
+
+from pydantic import BaseModel, Field
+from typing import Optional, Union, List
+from enum import Enum
+from uuid import UUID
+
+from ..common import NodeStatus
+
+
+class HostInterfaceType(str, Enum):
+
+    ethernet = "ethernet"
+    tap = "tap"
+
+
+class HostInterface(BaseModel):
+    """
+    Interface on this host.
+    """
+
+    name: str = Field(..., description="Interface name")
+    type: HostInterfaceType = Field(..., description="Interface type")
+    special: bool = Field(..., description="Whether the interface is non standard")
+
+
+class EthernetType(str, Enum):
+    ethernet = "ethernet"
+
+
+class EthernetPort(BaseModel):
+    """
+    Ethernet port properties.
+    """
+
+    name: str
+    port_number: int
+    type: EthernetType
+    interface: str
+
+
+class TAPType(str, Enum):
+    tap = "tap"
+
+
+class TAPPort(BaseModel):
+    """
+    TAP port properties.
+    """
+
+    name: str
+    port_number: int
+    type: TAPType
+    interface: str
+
+
+class UDPType(str, Enum):
+    udp = "udp"
+
+
+class UDPPort(BaseModel):
+    """
+    UDP tunnel port properties.
+    """
+
+    name: str
+    port_number: int
+    type: UDPType
+    lport: int = Field(..., gt=0, le=65535, description="Local port")
+    rhost: str = Field(..., description="Remote host")
+    rport: int = Field(..., gt=0, le=65535, description="Remote port")
+
+
+class CloudConsoleType(str, Enum):
+
+    telnet = "telnet"
+    vnc = "vnc"
+    spice = "spice"
+    http = "http"
+    https = "https"
+    none = "none"
+
+
+class CloudBase(BaseModel):
+    """
+    Common cloud node properties.
+    """
+
+    name: str
+    node_id: Optional[UUID] = None
+    usage: Optional[str] = None
+    remote_console_host: Optional[str] = Field(None, description="Remote console host or IP")
+    remote_console_port: Optional[int] = Field(None, gt=0, le=65535, description="Console TCP port")
+    remote_console_type: Optional[CloudConsoleType] = Field(None, description="Console type")
+    remote_console_http_path: Optional[str] = Field(None, description="Path of the remote web interface")
+    ports_mapping: Optional[List[Union[EthernetPort, TAPPort, UDPPort]]] = Field(
+        None, description="List of port mappings"
+    )
+    interfaces: Optional[List[HostInterface]] = Field(None, description="List of interfaces")
+
+
+class CloudCreate(CloudBase):
+    """
+    Properties to create a cloud node.
+    """
+
+    pass
+
+
+class CloudUpdate(CloudBase):
+    """
+    Properties to update a cloud node.
+    """
+
+    name: Optional[str] = None
+
+
+class Cloud(CloudBase):
+
+    project_id: UUID
+    node_id: UUID
+    ports_mapping: List[Union[EthernetPort, TAPPort, UDPPort]]
+    status: NodeStatus = Field(..., description="Cloud node status (read only)")

gns3server/schemas/compute/docker_nodes.py

@@ -0,0 +1,75 @@
+#
+# Copyright (C) 2020 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/>.
+
+from pydantic import BaseModel, Field
+from typing import Optional, List
+from uuid import UUID
+
+from ..common import NodeStatus, CustomAdapter, ConsoleType, AuxType
+
+
+class DockerBase(BaseModel):
+    """
+    Common Docker node properties.
+    """
+
+    name: str
+    image: str = Field(..., description="Docker image name")
+    node_id: Optional[UUID] = None
+    console: Optional[int] = Field(None, gt=0, le=65535, description="Console TCP port")
+    console_type: Optional[ConsoleType] = Field(None, description="Console type")
+    console_resolution: Optional[str] = Field(None, pattern="^[0-9]+x[0-9]+$", description="Console resolution for VNC")
+    console_http_port: Optional[int] = Field(None, description="Internal port in the container for the HTTP server")
+    console_http_path: Optional[str] = Field(None, description="Path of the web interface")
+    aux: Optional[int] = Field(None, gt=0, le=65535, description="Auxiliary TCP port")
+    aux_type: Optional[AuxType] = Field(None, description="Auxiliary console type")
+    usage: Optional[str] = Field(None, description="How to use the Docker container")
+    start_command: Optional[str] = Field(None, description="Docker CMD entry")
+    adapters: Optional[int] = Field(None, ge=0, le=99, description="Number of adapters")
+    mac_address: Optional[str] = Field(None, description="Base MAC address", pattern="^([0-9a-fA-F]{2}[:]){5}([0-9a-fA-F]{2})$")
+    environment: Optional[str] = Field(None, description="Docker environment variables")
+    extra_hosts: Optional[str] = Field(None, description="Docker extra hosts (added to /etc/hosts)")
+    extra_volumes: Optional[List[str]] = Field(None, description="Additional directories to make persistent")
+    memory: Optional[int] = Field(None, description="Maximum amount of memory the container can use in MB")
+    cpus: Optional[float] = Field(None, description="Maximum amount of CPU resources the container can use")
+    custom_adapters: Optional[List[CustomAdapter]] = Field(None, description="Custom adapters")
+
+
+class DockerCreate(DockerBase):
+    """
+    Properties to create a Docker node.
+    """
+
+    pass
+
+
+class DockerUpdate(DockerBase):
+    """
+    Properties to update a Docker node.
+    """
+
+    name: Optional[str] = None
+    image: Optional[str] = Field(None, description="Docker image name")
+
+
+class Docker(DockerBase):
+
+    container_id: str = Field(
+        ..., min_length=12, max_length=64, pattern="^[a-f0-9]+$", description="Docker container ID (read only)"
+    )
+    project_id: UUID = Field(..., description="Project ID")
+    node_directory: str = Field(..., description="Path to the node working directory (read only)")
+    status: NodeStatus = Field(..., description="Container status (read only)")