gns3-server 3.0.0__py3-none-any.whl

gns3server/api/routes/compute/capabilities.py

@@ -0,0 +1,51 @@
+#
+# 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/>.
+
+"""
+API routes for capabilities
+"""
+
+import sys
+import psutil
+
+from fastapi import APIRouter, Request
+
+from gns3server.version import __version__
+from gns3server.compute import MODULES
+from gns3server.utils.path import get_default_project_directory
+from gns3server import schemas
+
+router = APIRouter()
+
+
+@router.get("/capabilities", response_model=schemas.Capabilities)
+def get_capabilities(request: Request) -> dict:
+
+    node_types = []
+    for module in MODULES:
+        node_types.extend(module.node_types())
+
+    # record the controller hostname or IP address
+    request.app.state.controller_host = request.client.host
+
+    return {
+        "version": __version__,
+        "platform": sys.platform,
+        "cpus": psutil.cpu_count(logical=True),
+        "memory": psutil.virtual_memory().total,
+        "disk_size": psutil.disk_usage(get_default_project_directory()).total,
+        "node_types": node_types,
+    }

gns3server/api/routes/compute/cloud_nodes.py

@@ -0,0 +1,249 @@
+#
+# 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/>.
+
+"""
+API routes for cloud nodes.
+"""
+
+import os
+
+from fastapi import APIRouter, Depends, Path, Response, status
+from fastapi.encoders import jsonable_encoder
+from fastapi.responses import StreamingResponse
+from typing import Union
+from uuid import UUID
+
+from gns3server import schemas
+from gns3server.compute.builtin import Builtin
+from gns3server.compute.builtin.nodes.cloud import Cloud
+
+responses = {404: {"model": schemas.ErrorMessage, "description": "Could not find project or cloud node"}}
+
+router = APIRouter(responses=responses)
+
+
+def dep_node(project_id: UUID, node_id: UUID) -> Cloud:
+    """
+    Dependency to retrieve a node.
+    """
+
+    builtin_manager = Builtin.instance()
+    node = builtin_manager.get_node(str(node_id), project_id=str(project_id))
+    return node
+
+
+@router.post(
+    "",
+    response_model=schemas.Cloud,
+    status_code=status.HTTP_201_CREATED,
+    responses={409: {"model": schemas.ErrorMessage, "description": "Could not create cloud node"}},
+)
+async def create_cloud(project_id: UUID, node_data: schemas.CloudCreate) -> schemas.Cloud:
+    """
+    Create a new cloud node.
+    """
+
+    builtin_manager = Builtin.instance()
+    node_data = jsonable_encoder(node_data, exclude_unset=True)
+    node = await builtin_manager.create_node(
+        node_data.pop("name"),
+        str(project_id),
+        node_data.get("node_id"),
+        node_type="cloud",
+        ports=node_data.get("ports_mapping"),
+    )
+
+    # add the remote console settings
+    node.remote_console_host = node_data.get("remote_console_host", node.remote_console_host)
+    node.remote_console_port = node_data.get("remote_console_port", node.remote_console_port)
+    node.remote_console_type = node_data.get("remote_console_type", node.remote_console_type)
+    node.remote_console_http_path = node_data.get("remote_console_http_path", node.remote_console_http_path)
+    node.usage = node_data.get("usage", "")
+    return node.asdict()
+
+
+@router.get("/{node_id}", response_model=schemas.Cloud)
+def get_cloud(node: Cloud = Depends(dep_node)) -> schemas.Cloud:
+    """
+    Return a cloud node.
+    """
+
+    return node.asdict()
+
+
+@router.put("/{node_id}", response_model=schemas.Cloud)
+async def update_cloud(node_data: schemas.CloudUpdate, node: Cloud = Depends(dep_node)) -> schemas.Cloud:
+    """
+    Update a cloud node.
+    """
+
+    node_data = jsonable_encoder(node_data, exclude_unset=True)
+    for name, value in node_data.items():
+        if hasattr(node, name) and getattr(node, name) != value:
+            setattr(node, name, value)
+    node.updated()
+    return node.asdict()
+
+
+@router.delete("/{node_id}", status_code=status.HTTP_204_NO_CONTENT)
+async def delete_cloud(node: Cloud = Depends(dep_node)) -> None:
+    """
+    Delete a cloud node.
+    """
+
+    await Builtin.instance().delete_node(node.id)
+
+
+@router.post("/{node_id}/start", status_code=status.HTTP_204_NO_CONTENT)
+async def start_cloud(node: Cloud = Depends(dep_node)) -> None:
+    """
+    Start a cloud node.
+    """
+
+    await node.start()
+
+
+@router.post("/{node_id}/stop", status_code=status.HTTP_204_NO_CONTENT)
+async def stop_cloud(node: Cloud = Depends(dep_node)) -> None:
+    """
+    Stop a cloud node.
+    This endpoint results in no action since cloud nodes cannot be stopped.
+    """
+
+    pass
+
+
+@router.post("/{node_id}/suspend", status_code=status.HTTP_204_NO_CONTENT)
+async def suspend_cloud(node: Cloud = Depends(dep_node)) -> None:
+    """
+    Suspend a cloud node.
+    This endpoint results in no action since cloud nodes cannot be suspended.
+    """
+
+    pass
+
+
+@router.post(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
+    status_code=status.HTTP_201_CREATED,
+    response_model=Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO],
+)
+async def create_cloud_nio(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        nio_data: Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO],
+        node: Cloud = Depends(dep_node),
+) -> Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO]:
+    """
+    Add a NIO (Network Input/Output) to the node.
+    The adapter number on the cloud is always 0.
+    """
+
+    nio = Builtin.instance().create_nio(jsonable_encoder(nio_data, exclude_unset=True))
+    await node.add_nio(nio, port_number)
+    return nio.asdict()
+
+
+@router.put(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
+    status_code=status.HTTP_201_CREATED,
+    response_model=Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO],
+)
+async def update_cloud_nio(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        nio_data: Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO],
+        node: Cloud = Depends(dep_node),
+) -> Union[schemas.EthernetNIO, schemas.TAPNIO, schemas.UDPNIO]:
+    """
+    Update a NIO (Network Input/Output) to the node.
+    The adapter number on the cloud is always 0.
+    """
+
+    nio = node.get_nio(port_number)
+    if nio_data.filters:
+        nio.filters = nio_data.filters
+    await node.update_nio(port_number, nio)
+    return nio.asdict()
+
+
+@router.delete("/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio", status_code=status.HTTP_204_NO_CONTENT)
+async def delete_cloud_nio(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        node: Cloud = Depends(dep_node)
+) -> None:
+    """
+    Remove a NIO (Network Input/Output) from the node.
+    The adapter number on the cloud is always 0.
+    """
+
+    await node.remove_nio(port_number)
+
+
+@router.post("/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/start")
+async def start_cloud_capture(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        node_capture_data: schemas.NodeCapture,
+        node: Cloud = Depends(dep_node)
+) -> dict:
+    """
+    Start a packet capture on the node.
+    The adapter number on the cloud is always 0.
+    """
+
+    pcap_file_path = os.path.join(node.project.capture_working_directory(), node_capture_data.capture_file_name)
+    await node.start_capture(port_number, pcap_file_path, node_capture_data.data_link_type)
+    return {"pcap_file_path": pcap_file_path}
+
+
+@router.post(
+    "/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stop", status_code=status.HTTP_204_NO_CONTENT
+)
+async def stop_cloud_capture(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        node: Cloud = Depends(dep_node)
+) -> None:
+    """
+    Stop a packet capture on the node.
+    The adapter number on the cloud is always 0.
+    """
+
+    await node.stop_capture(port_number)
+
+
+@router.get("/{node_id}/adapters/{adapter_number}/ports/{port_number}/pcap")
+async def stream_pcap_file(
+        *,
+        adapter_number: int = Path(..., ge=0, le=0),
+        port_number: int,
+        node: Cloud = Depends(dep_node)
+) -> StreamingResponse:
+    """
+    Stream the pcap capture file.
+    The adapter number on the cloud is always 0.
+    """
+
+    nio = node.get_nio(port_number)
+    stream = Builtin.instance().stream_pcap_file(nio, node.project.id)
+    return StreamingResponse(stream, media_type="application/vnd.tcpdump.pcap")

gns3server/api/routes/compute/compute.py

@@ -0,0 +1,143 @@
+#
+# 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/>.
+
+
+"""
+API routes for compute.
+"""
+
+import os
+import psutil
+
+from gns3server.config import Config
+from gns3server.utils.cpu_percent import CpuPercent
+from gns3server.version import __version__
+from gns3server.utils.path import get_default_project_directory, is_safe_path
+from gns3server.compute.port_manager import PortManager
+from gns3server.compute.project_manager import ProjectManager
+from gns3server.utils.interfaces import interfaces
+from gns3server.compute.qemu import Qemu
+from gns3server.compute.virtualbox import VirtualBox
+from gns3server.compute.vmware import VMware
+from gns3server import schemas
+
+from fastapi import APIRouter, HTTPException, Body, Response, status
+from fastapi.encoders import jsonable_encoder
+from uuid import UUID
+from typing import Optional, List
+
+router = APIRouter()
+
+
+@router.post("/projects/{project_id}/ports/udp", status_code=status.HTTP_201_CREATED)
+def allocate_udp_port(project_id: UUID) -> dict:
+    """
+    Allocate a UDP port on the compute.
+    """
+
+    pm = ProjectManager.instance()
+    project = pm.get_project(str(project_id))
+    m = PortManager.instance()
+    udp_port = m.get_free_udp_port(project)
+    return {"udp_port": udp_port}
+
+
+@router.get("/network/interfaces")
+def network_interfaces() -> List[dict]:
+    """
+    List all the network interfaces available on the compute"
+    """
+
+    network_interfaces = interfaces()
+    return network_interfaces
+
+
+@router.get("/network/ports")
+def network_ports() -> dict:
+    """
+    List all the ports used on the compute"
+    """
+
+    m = PortManager.instance()
+    return m.asdict()
+
+
+@router.get("/version")
+def compute_version() -> dict:
+    """
+    Retrieve the server version number.
+    """
+
+    return {"version": __version__}
+
+
+@router.get("/statistics")
+def compute_statistics() -> dict:
+    """
+    Retrieve the server version number.
+    """
+
+    try:
+        memory_total = psutil.virtual_memory().total
+        memory_free = psutil.virtual_memory().available
+        memory_used = memory_total - memory_free  # actual memory usage in a cross platform fashion
+        swap_total = psutil.swap_memory().total
+        swap_free = psutil.swap_memory().free
+        swap_used = psutil.swap_memory().used
+        cpu_percent = int(CpuPercent.get())
+        load_average_percent = [int(x / psutil.cpu_count() * 100) for x in psutil.getloadavg()]
+        memory_percent = int(psutil.virtual_memory().percent)
+        swap_percent = int(psutil.swap_memory().percent)
+        disk_usage_percent = int(psutil.disk_usage(get_default_project_directory()).percent)
+    except psutil.Error as e:
+        raise HTTPException(status_code=status.HTTP_500_INTERNAL_SERVER_ERROR)
+        # raise HTTPConflict(text="Psutil error detected: {}".format(e))
+
+    return {
+        "memory_total": memory_total,
+        "memory_free": memory_free,
+        "memory_used": memory_used,
+        "swap_total": swap_total,
+        "swap_free": swap_free,
+        "swap_used": swap_used,
+        "cpu_usage_percent": cpu_percent,
+        "memory_usage_percent": memory_percent,
+        "swap_usage_percent": swap_percent,
+        "disk_usage_percent": disk_usage_percent,
+        "load_average_percent": load_average_percent,
+    }
+
+
+@router.get("/qemu/capabilities")
+async def get_qemu_capabilities() -> dict:
+    capabilities = {"kvm": []}
+    kvms = await Qemu.get_kvm_archs()
+    if kvms:
+        capabilities["kvm"] = kvms
+    return capabilities
+
+
+@router.get("/virtualbox/vms", response_model=List[dict])
+async def get_virtualbox_vms() -> List[dict]:
+
+    vbox_manager = VirtualBox.instance()
+    return await vbox_manager.list_vms()
+
+
+@router.get("/vmware/vms", response_model=List[dict])
+async def get_vms() -> List[dict]:
+    vmware_manager = VMware.instance()
+    return await vmware_manager.list_vms()

gns3server/api/routes/compute/dependencies/authentication.py

@@ -0,0 +1,83 @@
+#
+# 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/>.
+
+import secrets
+import base64
+import binascii
+import logging
+
+from fastapi import Depends, HTTPException, WebSocket, status
+from fastapi.security import HTTPBasic, HTTPBasicCredentials
+from fastapi.security.utils import get_authorization_scheme_param
+from gns3server.config import Config
+from typing import Optional, Union
+
+log = logging.getLogger(__name__)
+security = HTTPBasic()
+
+
+def compute_authentication(credentials: Optional[HTTPBasicCredentials] = Depends(security)) -> None:
+
+    server_settings = Config.instance().settings.Server
+    username = secrets.compare_digest(credentials.username, server_settings.compute_username)
+    password = secrets.compare_digest(credentials.password, server_settings.compute_password.get_secret_value())
+    if not (username and password):
+        raise HTTPException(
+            status_code=status.HTTP_401_UNAUTHORIZED,
+            detail="Invalid compute username or password",
+            headers={"WWW-Authenticate": "Basic"},
+        )
+
+async def ws_compute_authentication(websocket: WebSocket) -> Union[None, WebSocket]:
+    """
+    """
+
+    await websocket.accept()
+
+    # handle basic HTTP authentication
+    invalid_user_credentials_exc = HTTPException(
+        status_code=status.HTTP_401_UNAUTHORIZED,
+        detail="Could not validate credentials",
+        headers={"WWW-Authenticate": "Basic"},
+    )
+
+    try:
+        authorization = websocket.headers.get("Authorization")
+        scheme, param = get_authorization_scheme_param(authorization)
+        if not authorization or scheme.lower() != "basic":
+            raise invalid_user_credentials_exc
+        try:
+            data = base64.b64decode(param).decode("ascii")
+        except (ValueError, UnicodeDecodeError, binascii.Error):
+            raise invalid_user_credentials_exc
+
+        username, separator, password = data.partition(":")
+        if not separator:
+            raise invalid_user_credentials_exc
+
+        server_settings = Config.instance().settings.Server
+        username = secrets.compare_digest(username, server_settings.compute_username)
+        password = secrets.compare_digest(password, server_settings.compute_password.get_secret_value())
+        if not (username and password):
+            raise invalid_user_credentials_exc
+
+    except HTTPException as e:
+        err_msg = f"Could not authenticate while connecting to compute WebSocket: {e.detail}"
+        websocket_error = {"action": "log.error", "event": {"message": err_msg}}
+        await websocket.send_json(websocket_error)
+        log.error(err_msg)
+        return await websocket.close(code=1008)
+    return websocket