gns3-server/gns3server/compute/builtin/nodes/nat.py

#!/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 sys
import asyncio
from .cloud import Cloud
from ...error import NodeError

import gns3server.utils.interfaces


class Nat(Cloud):
    """
    A portable and preconfigured node allowing topology to get a
    nat access to the outside
    """

    _nat_id = 0

    def __init__(self, *args, **kwargs):
        if "virbr0" not in [interface["name"] for interface in gns3server.utils.interfaces.interfaces()]:
            raise NodeError("virbr0 is missing. You need to install libvirt")

        self._interface = "gns3nat{}".format(Nat._nat_id)
        Nat._nat_id += 1
        ports = [
            {
                "name": "nat0",
                "type": "tap",
                "interface": self._interface,
                "port_number": 0
            }
        ]
        super().__init__(*args, ports=ports)

    @property
    def ports_mapping(self):
        return self._ports_mapping

    @ports_mapping.setter
    def ports_mapping(self, ports):
        # It's not allowed to change it
        pass

    @asyncio.coroutine
    def add_nio(self, nio, port_number):
        yield from super().add_nio(nio, port_number)
        yield from self._ubridge_send('brctl addif virbr0 "{interface}"'.format(interface=self._interface))

    @classmethod
    def is_supported(self):
        return sys.platform.startswith("linux")

    def __json__(self):
        return {
            "name": self.name,
            "node_id": self.id,
            "project_id": self.project.id,
            "status": "started",
            "ports_mapping": self.ports_mapping
        }