Nat node for only the GNS3 VM

gns3server/compute/builtin/builtin_node_factory.py

@@ -18,13 +18,15 @@
 
 from ..error import NodeError
 from .nodes.cloud import Cloud
+from .nodes.nat import Nat
 from .nodes.ethernet_hub import EthernetHub
 from .nodes.ethernet_switch import EthernetSwitch
 
 import logging
 log = logging.getLogger(__name__)
 
 BUILTIN_NODES = {'cloud': Cloud,
+                 'nat': Nat,
                  'ethernet_hub': EthernetHub,
                  'ethernet_switch': EthernetSwitch}
 

gns3server/compute/builtin/nodes/nat.py

@@ -0,0 +1,51 @@
+#!/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 socket
+from .cloud import Cloud
+from ...error import NodeError
+
+
+class Nat(Cloud):
+    """
+    A portable and preconfigured node allowing topology to get a
+    nat access to the outside
+    """
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        if socket.gethostname() != "gns3vm":
+            raise NodeError("NAT node is supported only on GNS3 VM")
+
+        self.ports = [
+            {
+                "name": "nat0",
+                "type": "ethernet",
+                "interface": "eth1",
+                "port_number": 1
+            }
+        ]
+
+    def __json__(self):
+        return {
+            "name": self.name,
+            "node_id": self.id,
+            "project_id": self.project.id,
+            "status": "started",
+            "ports": self.ports
+        }

gns3server/handlers/api/compute/__init__.py

@@ -28,6 +28,7 @@
 from .version_handler import VersionHandler
 from .notification_handler import NotificationHandler
 from .cloud_handler import CloudHandler
+from .nat_handler import NatHandler
 from .ethernet_hub_handler import EthernetHubHandler
 from .ethernet_switch_handler import EthernetSwitchHandler
 from .frame_relay_switch_handler import FrameRelaySwitchHandler

gns3server/handlers/api/compute/nat_handler.py

@@ -0,0 +1,267 @@
+# -*- coding: utf-8 -*-
+#
+# 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 gns3server.web.route import Route
+from gns3server.schemas.node import NODE_CAPTURE_SCHEMA
+from gns3server.schemas.nio import NIO_SCHEMA
+from gns3server.compute.builtin import Builtin
+
+from gns3server.schemas.nat import (
+    NAT_CREATE_SCHEMA,
+    NAT_OBJECT_SCHEMA,
+    NAT_UPDATE_SCHEMA
+)
+
+
+class NatHandler:
+
+    """
+    API entry points for nat
+    """
+
+    @Route.post(
+        r"/projects/{project_id}/nat/nodes",
+        parameters={
+            "project_id": "Project UUID"
+        },
+        status_codes={
+            201: "Instance created",
+            400: "Invalid request",
+            409: "Conflict"
+        },
+        description="Create a new nat instance",
+        input=NAT_CREATE_SCHEMA,
+        output=NAT_OBJECT_SCHEMA)
+    def create(request, response):
+
+        builtin_manager = Builtin.instance()
+        node = yield from builtin_manager.create_node(request.json.pop("name"),
+                                                      request.match_info["project_id"],
+                                                      request.json.get("node_id"),
+                                                      node_type="nat",
+                                                      ports=request.json.get("ports"))
+        response.set_status(201)
+        response.json(node)
+
+    @Route.get(
+        r"/projects/{project_id}/nat/nodes/{node_id}",
+        parameters={
+            "project_id": "Project UUID",
+            "node_id": "Node UUID"
+        },
+        status_codes={
+            200: "Success",
+            400: "Invalid request",
+            404: "Instance doesn't exist"
+        },
+        description="Get a nat instance",
+        output=NAT_OBJECT_SCHEMA)
+    def show(request, response):
+
+        builtin_manager = Builtin.instance()
+        node = builtin_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
+        response.json(node)
+
+    @Route.put(
+        r"/projects/{project_id}/nat/nodes/{node_id}",
+        parameters={
+            "project_id": "Project UUID",
+            "node_id": "Node UUID"
+        },
+        status_codes={
+            200: "Instance updated",
+            400: "Invalid request",
+            404: "Instance doesn't exist",
+            409: "Conflict"
+        },
+        description="Update a nat instance",
+        input=NAT_UPDATE_SCHEMA,
+        output=NAT_OBJECT_SCHEMA)
+    def update(request, response):
+
+        builtin_manager = Builtin.instance()
+        node = builtin_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
+        for name, value in request.json.items():
+            if hasattr(node, name) and getattr(node, name) != value:
+                setattr(node, name, value)
+        node.updated()
+        response.json(node)
+
+    @Route.delete(
+        r"/projects/{project_id}/nat/nodes/{node_id}",
+        parameters={
+            "project_id": "Project UUID",
+            "node_id": "Node UUID"
+        },
+        status_codes={
+            204: "Instance deleted",
+            400: "Invalid request",
+            404: "Instance doesn't exist"
+        },
+        description="Delete a nat instance")
+    def delete(request, response):
+
+        builtin_manager = Builtin.instance()
+        yield from builtin_manager.delete_node(request.match_info["node_id"])
+        response.set_status(204)
+
+    @Route.post(
+        r"/projects/{project_id}/nat/nodes/{node_id}/start",
+        parameters={
+            "project_id": "Project UUID",
+            "node_id": "Node UUID"
+        },
+        status_codes={
+            204: "Instance started",
+            400: "Invalid request",
+            404: "Instance doesn't exist"
+        },
+        description="Start a nat")
+    def start(request, response):
+
+        Builtin.instance().get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
+        response.set_status(204)
+
+    @Route.post(
+        r"/projects/{project_id}/nat/nodes/{node_id}/stop",
+        parameters={
+            "project_id": "Project UUID",
+            "node_id": "Node UUID"
+        },
+        status_codes={
+            204: "Instance stopped",
+            400: "Invalid request",
+            404: "Instance doesn't exist"
+        },
+        description="Stop a nat")
+    def stop(request, response):
+
+        Builtin.instance().get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
+        response.set_status(204)
+
+    @Route.post(
+        r"/projects/{project_id}/nat/nodes/{node_id}/suspend",
+        parameters={
+            "project_id": "Project UUID",
+            "node_id": "Node UUID"
+        },
+        status_codes={
+            204: "Instance suspended",
+            400: "Invalid request",
+            404: "Instance doesn't exist"
+        },
+        description="Suspend a nat")
+    def suspend(request, response):
+
+        Builtin.instance().get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
+        response.set_status(204)
+
+    @Route.post(
+        r"/projects/{project_id}/nat/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio",
+        parameters={
+            "project_id": "Project UUID",
+            "node_id": "Node UUID",
+            "adapter_number": "Adapter on the nat (always 0)",
+            "port_number": "Port on the nat"
+        },
+        status_codes={
+            201: "NIO created",
+            400: "Invalid request",
+            404: "Instance doesn't exist"
+        },
+        description="Add a NIO to a nat instance",
+        input=NIO_SCHEMA,
+        output=NIO_SCHEMA)
+    def create_nio(request, response):
+
+        builtin_manager = Builtin.instance()
+        node = builtin_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
+        nio = builtin_manager.create_nio(request.json)
+        port_number = int(request.match_info["port_number"])
+        yield from node.add_nio(nio, port_number)
+        response.set_status(201)
+        response.json(nio)
+
+    @Route.delete(
+        r"/projects/{project_id}/nat/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio",
+        parameters={
+            "project_id": "Project UUID",
+            "node_id": "Node UUID",
+            "adapter_number": "Adapter on the nat (always 0)",
+            "port_number": "Port on the nat"
+        },
+        status_codes={
+            204: "NIO deleted",
+            400: "Invalid request",
+            404: "Instance doesn't exist"
+        },
+        description="Remove a NIO from a nat instance")
+    def delete_nio(request, response):
+
+        builtin_manager = Builtin.instance()
+        node = builtin_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
+        port_number = int(request.match_info["port_number"])
+        yield from node.remove_nio(port_number)
+        response.set_status(204)
+
+    @Route.post(
+        r"/projects/{project_id}/nat/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture",
+        parameters={
+            "project_id": "Project UUID",
+            "node_id": "Node UUID",
+            "adapter_number": "Adapter on the nat (always 0)",
+            "port_number": "Port on the nat"
+        },
+        status_codes={
+            200: "Capture started",
+            400: "Invalid request",
+            404: "Instance doesn't exist"
+        },
+        description="Start a packet capture on a nat instance",
+        input=NODE_CAPTURE_SCHEMA)
+    def start_capture(request, response):
+
+        builtin_manager = Builtin.instance()
+        node = builtin_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
+        port_number = int(request.match_info["port_number"])
+        pcap_file_path = os.path.join(node.project.capture_working_directory(), request.json["capture_file_name"])
+        yield from node.start_capture(port_number, pcap_file_path, request.json["data_link_type"])
+        response.json({"pcap_file_path": pcap_file_path})
+
+    @Route.post(
+        r"/projects/{project_id}/nat/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture",
+        parameters={
+            "project_id": "Project UUID",
+            "node_id": "Node UUID",
+            "adapter_number": "Adapter on the nat (always 0)",
+            "port_number": "Port on the nat"
+        },
+        status_codes={
+            204: "Capture stopped",
+            400: "Invalid request",
+            404: "Instance doesn't exist"
+        },
+        description="Stop a packet capture on a nat instance")
+    def stop_capture(request, response):
+
+        builtin_manager = Builtin.instance()
+        node = builtin_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
+        port_number = int(request.match_info["port_number"])
+        yield from node.stop_capture(port_number)
+        response.set_status(204)