2016-05-23 01:24:14 +00:00
|
|
|
# -*- coding: utf-8 -*-
|
|
|
|
#
|
|
|
|
# Copyright (C) 2013 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/>.
|
|
|
|
|
2016-05-29 22:35:07 +00:00
|
|
|
import sys
|
2016-05-23 01:24:14 +00:00
|
|
|
import asyncio
|
|
|
|
|
2016-06-07 13:34:04 +00:00
|
|
|
from ...error import NodeError
|
2016-05-23 01:24:14 +00:00
|
|
|
from ...base_node import BaseNode
|
2016-05-29 03:46:48 +00:00
|
|
|
from ...nios.nio_udp import NIOUDP
|
|
|
|
|
|
|
|
from gns3server.utils.interfaces import interfaces
|
2016-05-23 01:24:14 +00:00
|
|
|
|
|
|
|
import logging
|
|
|
|
log = logging.getLogger(__name__)
|
|
|
|
|
|
|
|
|
|
|
|
class Cloud(BaseNode):
|
|
|
|
|
|
|
|
"""
|
|
|
|
Cloud.
|
|
|
|
|
|
|
|
:param name: name for this cloud
|
|
|
|
:param node_id: Node identifier
|
|
|
|
:param project: Project instance
|
|
|
|
:param manager: Parent VM Manager
|
|
|
|
"""
|
|
|
|
|
2016-05-29 03:46:48 +00:00
|
|
|
def __init__(self, name, node_id, project, manager, ports=None):
|
2016-05-23 01:24:14 +00:00
|
|
|
|
|
|
|
super().__init__(name, node_id, project, manager)
|
2016-05-29 03:46:48 +00:00
|
|
|
self._nios = {}
|
|
|
|
self._ports = []
|
|
|
|
if ports:
|
|
|
|
self._ports = ports
|
2016-05-23 01:24:14 +00:00
|
|
|
|
|
|
|
def __json__(self):
|
|
|
|
|
2016-05-29 03:46:48 +00:00
|
|
|
host_interfaces = []
|
|
|
|
network_interfaces = interfaces()
|
|
|
|
for interface in network_interfaces:
|
|
|
|
interface_type = "ethernet"
|
|
|
|
if interface["name"].startswith("tap"):
|
|
|
|
# found no way to reliably detect a TAP interface
|
|
|
|
interface_type = "tap"
|
|
|
|
host_interfaces.append({"name": interface["name"],
|
|
|
|
"type": interface_type})
|
|
|
|
|
2016-05-23 01:24:14 +00:00
|
|
|
return {"name": self.name,
|
|
|
|
"node_id": self.id,
|
2016-05-29 03:46:48 +00:00
|
|
|
"project_id": self.project.id,
|
|
|
|
"ports": self._ports,
|
2016-05-29 22:35:07 +00:00
|
|
|
"interfaces": host_interfaces,
|
|
|
|
"status": "started"}
|
2016-05-29 03:46:48 +00:00
|
|
|
|
|
|
|
@property
|
|
|
|
def ports(self):
|
|
|
|
"""
|
|
|
|
Ports on this cloud.
|
|
|
|
|
|
|
|
:returns: ports info
|
|
|
|
"""
|
|
|
|
|
|
|
|
return self._ports
|
|
|
|
|
|
|
|
@ports.setter
|
|
|
|
def ports(self, ports):
|
|
|
|
"""
|
|
|
|
Set the ports on this cloud.
|
|
|
|
|
|
|
|
:param ports: ports info
|
|
|
|
"""
|
|
|
|
|
|
|
|
self._ports = ports
|
2016-05-23 01:24:14 +00:00
|
|
|
|
2016-05-29 22:35:07 +00:00
|
|
|
@asyncio.coroutine
|
2016-05-23 01:24:14 +00:00
|
|
|
def create(self):
|
|
|
|
"""
|
|
|
|
Creates this cloud.
|
|
|
|
"""
|
|
|
|
|
2016-05-29 22:35:07 +00:00
|
|
|
yield from self._start_ubridge()
|
2016-05-23 01:24:14 +00:00
|
|
|
log.info('Cloud "{name}" [{id}] has been created'.format(name=self._name, id=self._id))
|
|
|
|
|
2016-05-29 22:35:07 +00:00
|
|
|
@asyncio.coroutine
|
|
|
|
def close(self):
|
2016-05-23 01:24:14 +00:00
|
|
|
"""
|
2016-05-29 22:35:07 +00:00
|
|
|
Closes this cloud.
|
2016-05-23 01:24:14 +00:00
|
|
|
"""
|
|
|
|
|
2016-05-29 22:35:07 +00:00
|
|
|
if not (yield from super().close()):
|
|
|
|
return False
|
|
|
|
|
2016-05-29 03:46:48 +00:00
|
|
|
for nio in self._nios.values():
|
|
|
|
if nio and isinstance(nio, NIOUDP):
|
|
|
|
self.manager.port_manager.release_udp_port(nio.lport, self._project)
|
|
|
|
|
2016-05-29 22:35:07 +00:00
|
|
|
yield from self._stop_ubridge()
|
|
|
|
log.info('Cloud "{name}" [{id}] has been closed'.format(name=self._name, id=self._id))
|
|
|
|
|
|
|
|
@asyncio.coroutine
|
|
|
|
def _add_ubridge_connection(self, nio, port_number):
|
|
|
|
"""
|
|
|
|
Creates a connection in uBridge.
|
|
|
|
|
|
|
|
:param nio: NIO instance
|
|
|
|
:param port_number: port number
|
|
|
|
"""
|
|
|
|
|
|
|
|
port_info = None
|
|
|
|
for port in self._ports:
|
|
|
|
if port["port_number"] == port_number:
|
|
|
|
port_info = port
|
|
|
|
break
|
|
|
|
|
|
|
|
if not port_info:
|
|
|
|
raise NodeError("Port {port_number} doesn't exist on cloud '{name}'".format(name=self.name,
|
|
|
|
port_number=port_number))
|
|
|
|
|
|
|
|
bridge_name = "{}-{}".format(self._id, port_number)
|
|
|
|
yield from self._ubridge_send("bridge create {name}".format(name=bridge_name))
|
|
|
|
if not isinstance(nio, NIOUDP):
|
|
|
|
raise NodeError("Source NIO is not UDP")
|
|
|
|
yield from self._ubridge_send('bridge add_nio_udp {name} {lport} {rhost} {rport}'.format(name=bridge_name,
|
|
|
|
lport=nio.lport,
|
|
|
|
rhost=nio.rhost,
|
|
|
|
rport=nio.rport))
|
|
|
|
|
|
|
|
if port_info["type"] in ("ethernet", "tap"):
|
|
|
|
network_interfaces = [interface["name"] for interface in interfaces()]
|
|
|
|
if not port_info["interface"] in network_interfaces:
|
2016-06-01 23:50:31 +00:00
|
|
|
raise NodeError("Interface '{}' could not be found on this system".format(port_info["interface"]))
|
2016-05-29 22:35:07 +00:00
|
|
|
|
|
|
|
if sys.platform.startswith("win"):
|
|
|
|
windows_interfaces = interfaces()
|
|
|
|
npf = None
|
|
|
|
for interface in windows_interfaces:
|
|
|
|
if port_info["interface"] == interface["name"]:
|
|
|
|
npf = interface["id"]
|
|
|
|
if npf:
|
|
|
|
yield from self._ubridge_send('bridge add_nio_ethernet {name} "{interface}"'.format(name=bridge_name,
|
|
|
|
interface=npf))
|
|
|
|
else:
|
|
|
|
raise NodeError("Could not find NPF id for interface {}".format(port_info["interface"]))
|
|
|
|
|
|
|
|
else:
|
|
|
|
|
|
|
|
if port_info["type"] == "ethernet":
|
|
|
|
if sys.platform.startswith("linux"):
|
|
|
|
# use raw sockets on Linux
|
|
|
|
yield from self._ubridge_send('bridge add_nio_linux_raw {name} "{interface}"'.format(name=bridge_name,
|
|
|
|
interface=port_info["interface"]))
|
|
|
|
else:
|
2016-06-10 00:42:14 +00:00
|
|
|
if sys.platform.startswith("darwin") and port_info["interface"].startswith("en"):
|
2016-06-10 01:00:33 +00:00
|
|
|
# Wireless adapters are not well supported by the libpcap on OSX
|
2016-06-10 00:42:14 +00:00
|
|
|
raise NodeError("Connecting to a Wireless adapter is not supported.")
|
2016-06-10 01:00:33 +00:00
|
|
|
if sys.platform.startswith("darwin") and port_info["interface"].startswith("vmnet"):
|
|
|
|
# Use a special NIO to connect to VMware vmnet interfaces on OSX (libpcap doesn't support them)
|
|
|
|
yield from self._ubridge_send('bridge add_nio_fusion_vmnet {name} "{interface}"'.format(name=bridge_name,
|
|
|
|
interface=port_info["interface"]))
|
|
|
|
else:
|
|
|
|
yield from self._ubridge_send('bridge add_nio_ethernet {name} "{interface}"'.format(name=bridge_name,
|
|
|
|
interface=port_info["interface"]))
|
2016-05-29 22:35:07 +00:00
|
|
|
|
|
|
|
elif port_info["type"] == "tap":
|
|
|
|
yield from self._ubridge_send('bridge add_nio_tap {name} "{interface}"'.format(name=bridge_name,
|
|
|
|
interface=port_info["interface"]))
|
|
|
|
|
|
|
|
elif port_info["type"] == "udp":
|
|
|
|
yield from self._ubridge_send('bridge add_nio_udp {name} {lport} {rhost} {rport}'.format(name=bridge_name,
|
|
|
|
lport=port_info["lport"],
|
|
|
|
rhost=port_info["rhost"],
|
|
|
|
rport=port_info["rport"]))
|
|
|
|
|
|
|
|
if nio.capturing:
|
|
|
|
yield from self._ubridge_send('bridge start_capture {name} "{pcap_file}"'.format(name=bridge_name,
|
|
|
|
pcap_file=nio.pcap_output_file))
|
|
|
|
|
|
|
|
yield from self._ubridge_send('bridge start {name}'.format(name=bridge_name))
|
2016-05-23 01:24:14 +00:00
|
|
|
|
|
|
|
@asyncio.coroutine
|
|
|
|
def add_nio(self, nio, port_number):
|
|
|
|
"""
|
|
|
|
Adds a NIO as new port on this cloud.
|
|
|
|
|
|
|
|
:param nio: NIO instance to add
|
|
|
|
:param port_number: port to allocate for the NIO
|
|
|
|
"""
|
|
|
|
|
2016-05-29 03:46:48 +00:00
|
|
|
if port_number in self._nios:
|
|
|
|
raise NodeError("Port {} isn't free".format(port_number))
|
|
|
|
|
|
|
|
log.info('Cloud "{name}" [{id}]: NIO {nio} bound to port {port}'.format(name=self._name,
|
|
|
|
id=self._id,
|
|
|
|
nio=nio,
|
|
|
|
port=port_number))
|
|
|
|
self._nios[port_number] = nio
|
2016-05-29 22:35:07 +00:00
|
|
|
yield from self._add_ubridge_connection(nio, port_number)
|
|
|
|
|
|
|
|
@asyncio.coroutine
|
|
|
|
def _delete_ubridge_connection(self, port_number):
|
|
|
|
"""
|
|
|
|
Deletes a connection in uBridge.
|
|
|
|
|
|
|
|
:param port_number: adapter number
|
|
|
|
"""
|
2016-05-29 03:46:48 +00:00
|
|
|
|
2016-05-29 22:35:07 +00:00
|
|
|
bridge_name = "{}-{}".format(self._id, port_number)
|
|
|
|
yield from self._ubridge_send("bridge delete {name}".format(name=bridge_name))
|
2016-05-23 01:24:14 +00:00
|
|
|
|
|
|
|
@asyncio.coroutine
|
|
|
|
def remove_nio(self, port_number):
|
|
|
|
"""
|
|
|
|
Removes the specified NIO as member of cloud.
|
|
|
|
|
|
|
|
:param port_number: allocated port number
|
|
|
|
|
|
|
|
:returns: the NIO that was bound to the allocated port
|
|
|
|
"""
|
|
|
|
|
2016-05-29 03:46:48 +00:00
|
|
|
if port_number not in self._nios:
|
|
|
|
raise NodeError("Port {} is not allocated".format(port_number))
|
|
|
|
|
|
|
|
nio = self._nios[port_number]
|
|
|
|
if isinstance(nio, NIOUDP):
|
|
|
|
self.manager.port_manager.release_udp_port(nio.lport, self._project)
|
|
|
|
|
|
|
|
log.info('Cloud "{name}" [{id}]: NIO {nio} removed from port {port}'.format(name=self._name,
|
|
|
|
id=self._id,
|
|
|
|
nio=nio,
|
|
|
|
port=port_number))
|
|
|
|
|
|
|
|
del self._nios[port_number]
|
2016-05-29 22:35:07 +00:00
|
|
|
yield from self._delete_ubridge_connection(port_number)
|
2016-05-29 03:46:48 +00:00
|
|
|
return nio
|
2016-05-23 01:24:14 +00:00
|
|
|
|
|
|
|
@asyncio.coroutine
|
|
|
|
def start_capture(self, port_number, output_file, data_link_type="DLT_EN10MB"):
|
|
|
|
"""
|
|
|
|
Starts a packet capture.
|
|
|
|
|
|
|
|
:param port_number: allocated port number
|
|
|
|
:param output_file: PCAP destination file for the capture
|
|
|
|
:param data_link_type: PCAP data link type (DLT_*), default is DLT_EN10MB
|
|
|
|
"""
|
|
|
|
|
2016-05-29 22:35:07 +00:00
|
|
|
if not [port["port_number"] for port in self._ports if port_number == port["port_number"]]:
|
|
|
|
raise NodeError("Port {port_number} doesn't exist on cloud '{name}'".format(name=self.name,
|
|
|
|
port_number=port_number))
|
|
|
|
|
|
|
|
if port_number not in self._nios:
|
|
|
|
raise NodeError("Port {} is not connected".format(port_number))
|
|
|
|
|
|
|
|
nio = self._nios[port_number]
|
|
|
|
|
|
|
|
if nio.capturing:
|
|
|
|
raise NodeError("Packet capture is already activated on port {port_number}".format(port_number=port_number))
|
|
|
|
nio.startPacketCapture(output_file)
|
|
|
|
bridge_name = "{}-{}".format(self._id, port_number)
|
|
|
|
yield from self._ubridge_send('bridge start_capture {name} "{output_file}"'.format(name=bridge_name,
|
|
|
|
output_file=output_file))
|
|
|
|
log.info("Cloud '{name}' [{id}]: starting packet capture on port {port_number}".format(name=self.name,
|
|
|
|
id=self.id,
|
|
|
|
port_number=port_number))
|
|
|
|
|
2016-05-23 01:24:14 +00:00
|
|
|
@asyncio.coroutine
|
|
|
|
def stop_capture(self, port_number):
|
|
|
|
"""
|
|
|
|
Stops a packet capture.
|
|
|
|
|
|
|
|
:param port_number: allocated port number
|
|
|
|
"""
|
|
|
|
|
2016-05-29 22:35:07 +00:00
|
|
|
if not [port["port_number"] for port in self._ports if port_number == port["port_number"]]:
|
|
|
|
raise NodeError("Port {port_number} doesn't exist on cloud '{name}'".format(name=self.name,
|
|
|
|
port_number=port_number))
|
|
|
|
|
|
|
|
if port_number not in self._nios:
|
|
|
|
raise NodeError("Port {} is not connected".format(port_number))
|
|
|
|
|
|
|
|
nio = self._nios[port_number]
|
|
|
|
nio.stopPacketCapture()
|
|
|
|
bridge_name = "{}-{}".format(self._id, port_number)
|
|
|
|
yield from self._ubridge_send("bridge stop_capture {name}".format(name=bridge_name))
|
|
|
|
|
|
|
|
log.info("Cloud'{name}' [{id}]: stopping packet capture on port {port_number}".format(name=self.name,
|
2016-06-07 13:34:04 +00:00
|
|
|
id=self.id,
|
|
|
|
port_number=port_number))
|