NgTech-LTD/gns3-server
2
0
Fork 0
mirror of https://github.com/GNS3/gns3-server.git synced 2025-02-06 16:23:49 +02:00
Code Issues Packages Projects Releases Wiki Activity

Packet capture for Dynamips VMs.

Browse Source
This commit is contained in:
Jeremy 2015-02-13 15:41:56 -07:00
parent 6ac6c7d796
commit 094339304c
4 changed files with 155 additions and 86 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
gns3server/handlers/dynamips_handler.py
View File

@ -16,11 +16,13 @@
# along with this program. If not, see <http://www.gnu.org/licenses/>. # along with this program. If not, see <http://www.gnu.org/licenses/>.
import os
import asyncio import asyncio
from ..web.route import Route from ..web.route import Route
from ..schemas.dynamips import VM_CREATE_SCHEMA from ..schemas.dynamips import VM_CREATE_SCHEMA
from ..schemas.dynamips import VM_UPDATE_SCHEMA from ..schemas.dynamips import VM_UPDATE_SCHEMA
from ..schemas.dynamips import VM_NIO_SCHEMA from ..schemas.dynamips import VM_NIO_SCHEMA
from ..schemas.dynamips import VM_CAPTURE_SCHEMA
from ..schemas.dynamips import VM_OBJECT_SCHEMA from ..schemas.dynamips import VM_OBJECT_SCHEMA
from ..modules.dynamips import Dynamips from ..modules.dynamips import Dynamips
from ..modules.project_manager import ProjectManager from ..modules.project_manager import ProjectManager
@ -290,3 +292,51 @@ class DynamipsHandler:
port_number = int(request.match_info["port_number"]) port_number = int(request.match_info["port_number"])
yield from vm.slot_remove_nio_binding(slot_number, port_number) yield from vm.slot_remove_nio_binding(slot_number, port_number)
response.set_status(204) response.set_status(204)
@Route.post(
r"/projects/{project_id}/dynamips/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture",
parameters={
"project_id": "UUID for the project",
"vm_id": "UUID for the instance",
"adapter_number": "Adapter to start a packet capture",
"port_number": "Port on the adapter"
},
status_codes={
200: "Capture started",
400: "Invalid request",
404: "Instance doesn't exist"
},
description="Start a packet capture on a Dynamips VM instance",
input=VM_CAPTURE_SCHEMA)
def start_capture(request, response):
dynamips_manager = Dynamips.instance()
vm = dynamips_manager.get_vm(request.match_info["vm_id"], project_id=request.match_info["project_id"])
slot_number = int(request.match_info["adapter_number"])
port_number = int(request.match_info["port_number"])
pcap_file_path = os.path.join(vm.project.capture_working_directory(), request.json["capture_file_name"])
yield from vm.start_capture(slot_number, port_number, pcap_file_path, request.json["data_link_type"])
response.json({"pcap_file_path": pcap_file_path})
@Route.post(
r"/projects/{project_id}/dynamips/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture",
parameters={
"project_id": "UUID for the project",
"vm_id": "UUID for the instance",
"adapter_number": "Adapter to stop a packet capture",
"port_number": "Port on the adapter (always 0)"
},
status_codes={
204: "Capture stopped",
400: "Invalid request",
404: "Instance doesn't exist"
},
description="Stop a packet capture on a Dynamips VM instance")
def start_capture(request, response):
dynamips_manager = Dynamips.instance()
vm = dynamips_manager.get_vm(request.match_info["vm_id"], project_id=request.match_info["project_id"])
slot_number = int(request.match_info["adapter_number"])
port_number = int(request.match_info["port_number"])
yield from vm.stop_capture(slot_number, port_number)
response.set_status(204)

35
gns3server/modules/dynamips/adapters/adapter.py
View File

@ -28,10 +28,9 @@ class Adapter(object):
def __init__(self, interfaces=0, wics=0): def __init__(self, interfaces=0, wics=0):
self._interfaces = interfaces self._interfaces = interfaces
self._ports = {} self._ports = {}
for port_id in range(0, interfaces): for port_number in range(0, interfaces):
self._ports[port_id] = None self._ports[port_number] = None
self._wics = wics * [None] self._wics = wics * [None]
def removable(self): def removable(self):
@ -44,7 +43,7 @@ class Adapter(object):
return True return True
def port_exists(self, port_id): def port_exists(self, port_number):
""" """
Checks if a port exists on this adapter. Checks if a port exists on this adapter.
@ -52,7 +51,7 @@ class Adapter(object):
False otherwise. False otherwise.
""" """
if port_id in self._ports: if port_number in self._ports:
return True return True
return False return False
@ -84,8 +83,8 @@ class Adapter(object):
# WIC3 port 1 = 48, WIC3 port 2 = 49 # WIC3 port 1 = 48, WIC3 port 2 = 49
base = 16 * (wic_slot_id + 1) base = 16 * (wic_slot_id + 1)
for wic_port in range(0, wic.interfaces): for wic_port in range(0, wic.interfaces):
port_id = base + wic_port port_number = base + wic_port
self._ports[port_id] = None self._ports[port_number] = None
def uninstall_wic(self, wic_slot_id): def uninstall_wic(self, wic_slot_id):
""" """
@ -102,39 +101,39 @@ class Adapter(object):
# WIC3 port 1 = 48, WIC3 port 2 = 49 # WIC3 port 1 = 48, WIC3 port 2 = 49
base = 16 * (wic_slot_id + 1) base = 16 * (wic_slot_id + 1)
for wic_port in range(0, wic.interfaces): for wic_port in range(0, wic.interfaces):
port_id = base + wic_port port_number = base + wic_port
del self._ports[port_id] del self._ports[port_number]
self._wics[wic_slot_id] = None self._wics[wic_slot_id] = None
def add_nio(self, port_id, nio): def add_nio(self, port_number, nio):
""" """
Adds a NIO to a port on this adapter. Adds a NIO to a port on this adapter.
:param port_id: port ID (integer) :param port_number: port number (integer)
:param nio: NIO instance :param nio: NIO instance
""" """
self._ports[port_id] = nio self._ports[port_number] = nio
def remove_nio(self, port_id): def remove_nio(self, port_number):
""" """
Removes a NIO from a port on this adapter. Removes a NIO from a port on this adapter.
:param port_id: port ID (integer) :param port_number: port number (integer)
""" """
self._ports[port_id] = None self._ports[port_number] = None
def get_nio(self, port_id): def get_nio(self, port_number):
""" """
Returns the NIO assigned to a port. Returns the NIO assigned to a port.
:params port_id: port ID (integer) :params port_number: port number (integer)
:returns: NIO instance :returns: NIO instance
""" """
return self._ports[port_id] return self._ports[port_number]
@property @property
def ports(self): def ports(self):

136
gns3server/modules/virtualbox/virtualbox_vm.py
View File

@ -212,12 +212,12 @@ class VirtualBoxVM(BaseVM):
except VirtualBoxError as e: except VirtualBoxError as e:
log.warn("Could not deactivate the first serial port: {}".format(e)) log.warn("Could not deactivate the first serial port: {}".format(e))
for adapter_id in range(0, len(self._ethernet_adapters)): for adapter_number in range(0, len(self._ethernet_adapters)):
nio = self._ethernet_adapters[adapter_id].get_nio(0) nio = self._ethernet_adapters[adapter_number].get_nio(0)
if nio: if nio:
yield from self._modify_vm("--nictrace{} off".format(adapter_id + 1)) yield from self._modify_vm("--nictrace{} off".format(adapter_number + 1))
yield from self._modify_vm("--cableconnected{} off".format(adapter_id + 1)) yield from self._modify_vm("--cableconnected{} off".format(adapter_number + 1))
yield from self._modify_vm("--nic{} null".format(adapter_id + 1)) yield from self._modify_vm("--nic{} null".format(adapter_number + 1))
@asyncio.coroutine @asyncio.coroutine
def suspend(self): def suspend(self):
@ -483,7 +483,7 @@ class VirtualBoxVM(BaseVM):
raise VirtualBoxError("Number of adapters above the maximum supported of {}".format(self._maximum_adapters)) raise VirtualBoxError("Number of adapters above the maximum supported of {}".format(self._maximum_adapters))
self._ethernet_adapters.clear() self._ethernet_adapters.clear()
for adapter_id in range(0, adapters): for adapter_number in range(0, adapters):
self._ethernet_adapters.append(EthernetAdapter()) self._ethernet_adapters.append(EthernetAdapter())
self._adapters = len(self._ethernet_adapters) self._adapters = len(self._ethernet_adapters)
@ -623,8 +623,8 @@ class VirtualBoxVM(BaseVM):
nics = [] nics = []
vm_info = yield from self._get_vm_info() vm_info = yield from self._get_vm_info()
for adapter_id in range(0, maximum_adapters): for adapter_number in range(0, maximum_adapters):
entry = "nic{}".format(adapter_id + 1) entry = "nic{}".format(adapter_number + 1)
if entry in vm_info: if entry in vm_info:
value = vm_info[entry] value = vm_info[entry]
nics.append(value) nics.append(value)
@ -639,15 +639,15 @@ class VirtualBoxVM(BaseVM):
""" """
nic_attachments = yield from self._get_nic_attachements(self._maximum_adapters) nic_attachments = yield from self._get_nic_attachements(self._maximum_adapters)
for adapter_id in range(0, len(self._ethernet_adapters)): for adapter_number in range(0, len(self._ethernet_adapters)):
nio = self._ethernet_adapters[adapter_id].get_nio(0) nio = self._ethernet_adapters[adapter_number].get_nio(0)
if nio: if nio:
attachment = nic_attachments[adapter_id] attachment = nic_attachments[adapter_number]
if not self._use_any_adapter and attachment not in ("none", "null"): if not self._use_any_adapter and attachment not in ("none", "null"):
raise VirtualBoxError("Attachment ({}) already configured on adapter {}. " raise VirtualBoxError("Attachment ({}) already configured on adapter {}. "
"Please set it to 'Not attached' to allow GNS3 to use it.".format(attachment, "Please set it to 'Not attached' to allow GNS3 to use it.".format(attachment,
adapter_id + 1)) adapter_number + 1))
yield from self._modify_vm("--nictrace{} off".format(adapter_id + 1)) yield from self._modify_vm("--nictrace{} off".format(adapter_number + 1))
vbox_adapter_type = "82540EM" vbox_adapter_type = "82540EM"
if self._adapter_type == "PCnet-PCI II (Am79C970A)": if self._adapter_type == "PCnet-PCI II (Am79C970A)":
@ -662,24 +662,24 @@ class VirtualBoxVM(BaseVM):
vbox_adapter_type = "82545EM" vbox_adapter_type = "82545EM"
if self._adapter_type == "Paravirtualized Network (virtio-net)": if self._adapter_type == "Paravirtualized Network (virtio-net)":
vbox_adapter_type = "virtio" vbox_adapter_type = "virtio"
args = [self._vmname, "--nictype{}".format(adapter_id + 1), vbox_adapter_type] args = [self._vmname, "--nictype{}".format(adapter_number + 1), vbox_adapter_type]
yield from self.manager.execute("modifyvm", args) yield from self.manager.execute("modifyvm", args)
log.debug("setting UDP params on adapter {}".format(adapter_id)) log.debug("setting UDP params on adapter {}".format(adapter_number))
yield from self._modify_vm("--nic{} generic".format(adapter_id + 1)) yield from self._modify_vm("--nic{} generic".format(adapter_number + 1))
yield from self._modify_vm("--nicgenericdrv{} UDPTunnel".format(adapter_id + 1)) yield from self._modify_vm("--nicgenericdrv{} UDPTunnel".format(adapter_number + 1))
yield from self._modify_vm("--nicproperty{} sport={}".format(adapter_id + 1, nio.lport)) yield from self._modify_vm("--nicproperty{} sport={}".format(adapter_number + 1, nio.lport))
yield from self._modify_vm("--nicproperty{} dest={}".format(adapter_id + 1, nio.rhost)) yield from self._modify_vm("--nicproperty{} dest={}".format(adapter_number + 1, nio.rhost))
yield from self._modify_vm("--nicproperty{} dport={}".format(adapter_id + 1, nio.rport)) yield from self._modify_vm("--nicproperty{} dport={}".format(adapter_number + 1, nio.rport))
yield from self._modify_vm("--cableconnected{} on".format(adapter_id + 1)) yield from self._modify_vm("--cableconnected{} on".format(adapter_number + 1))
if nio.capturing: if nio.capturing:
yield from self._modify_vm("--nictrace{} on".format(adapter_id + 1)) yield from self._modify_vm("--nictrace{} on".format(adapter_number + 1))
yield from self._modify_vm("--nictracefile{} {}".format(adapter_id + 1, nio.pcap_output_file)) yield from self._modify_vm("--nictracefile{} {}".format(adapter_number + 1, nio.pcap_output_file))
for adapter_id in range(len(self._ethernet_adapters), self._maximum_adapters): for adapter_number in range(len(self._ethernet_adapters), self._maximum_adapters):
log.debug("disabling remaining adapter {}".format(adapter_id)) log.debug("disabling remaining adapter {}".format(adapter_number))
yield from self._modify_vm("--nic{} none".format(adapter_id + 1)) yield from self._modify_vm("--nic{} none".format(adapter_number + 1))
@asyncio.coroutine @asyncio.coroutine
def _create_linked_clone(self): def _create_linked_clone(self):
@ -761,107 +761,107 @@ class VirtualBoxVM(BaseVM):
self._serial_pipe = None self._serial_pipe = None
@asyncio.coroutine @asyncio.coroutine
def adapter_add_nio_binding(self, adapter_id, nio): def adapter_add_nio_binding(self, adapter_number, nio):
""" """
Adds an adapter NIO binding. Adds an adapter NIO binding.
:param adapter_id: adapter ID :param adapter_number: adapter number
:param nio: NIO instance to add to the slot/port :param nio: NIO instance to add to the slot/port
""" """
try: try:
adapter = self._ethernet_adapters[adapter_id] adapter = self._ethernet_adapters[adapter_number]
except IndexError: except IndexError:
raise VirtualBoxError("Adapter {adapter_id} doesn't exist on VirtualBox VM '{name}'".format(name=self.name, raise VirtualBoxError("Adapter {adapter_number} doesn't exist on VirtualBox VM '{name}'".format(name=self.name,
adapter_id=adapter_id)) adapter_number=adapter_number))
vm_state = yield from self._get_vm_state() vm_state = yield from self._get_vm_state()
if vm_state == "running": if vm_state == "running":
# dynamically configure an UDP tunnel on the VirtualBox adapter # dynamically configure an UDP tunnel on the VirtualBox adapter
yield from self._control_vm("nic{} generic UDPTunnel".format(adapter_id + 1)) yield from self._control_vm("nic{} generic UDPTunnel".format(adapter_number + 1))
yield from self._control_vm("nicproperty{} sport={}".format(adapter_id + 1, nio.lport)) yield from self._control_vm("nicproperty{} sport={}".format(adapter_number + 1, nio.lport))
yield from self._control_vm("nicproperty{} dest={}".format(adapter_id + 1, nio.rhost)) yield from self._control_vm("nicproperty{} dest={}".format(adapter_number + 1, nio.rhost))
yield from self._control_vm("nicproperty{} dport={}".format(adapter_id + 1, nio.rport)) yield from self._control_vm("nicproperty{} dport={}".format(adapter_number + 1, nio.rport))
yield from self._control_vm("setlinkstate{} on".format(adapter_id + 1)) yield from self._control_vm("setlinkstate{} on".format(adapter_number + 1))
adapter.add_nio(0, nio) adapter.add_nio(0, nio)
log.info("VirtualBox VM '{name}' [{id}]: {nio} added to adapter {adapter_id}".format(name=self.name, log.info("VirtualBox VM '{name}' [{id}]: {nio} added to adapter {adapter_number}".format(name=self.name,
id=self.id, id=self.id,
nio=nio, nio=nio,
adapter_id=adapter_id)) adapter_number=adapter_number))
@asyncio.coroutine @asyncio.coroutine
def adapter_remove_nio_binding(self, adapter_id): def adapter_remove_nio_binding(self, adapter_number):
""" """
Removes an adapter NIO binding. Removes an adapter NIO binding.
:param adapter_id: adapter ID :param adapter_number: adapter number
:returns: NIO instance :returns: NIO instance
""" """
try: try:
adapter = self._ethernet_adapters[adapter_id] adapter = self._ethernet_adapters[adapter_number]
except IndexError: except IndexError:
raise VirtualBoxError("Adapter {adapter_id} doesn't exist on VirtualBox VM '{name}'".format(name=self.name, raise VirtualBoxError("Adapter {adapter_number} doesn't exist on VirtualBox VM '{name}'".format(name=self.name,
adapter_id=adapter_id)) adapter_number=adapter_number))
vm_state = yield from self._get_vm_state() vm_state = yield from self._get_vm_state()
if vm_state == "running": if vm_state == "running":
# dynamically disable the VirtualBox adapter # dynamically disable the VirtualBox adapter
yield from self._control_vm("setlinkstate{} off".format(adapter_id + 1)) yield from self._control_vm("setlinkstate{} off".format(adapter_number + 1))
yield from self._control_vm("nic{} null".format(adapter_id + 1)) yield from self._control_vm("nic{} null".format(adapter_number + 1))
nio = adapter.get_nio(0) nio = adapter.get_nio(0)
if str(nio) == "NIO UDP": if str(nio) == "NIO UDP":
self.manager.port_manager.release_udp_port(nio.lport) self.manager.port_manager.release_udp_port(nio.lport)
adapter.remove_nio(0) adapter.remove_nio(0)
log.info("VirtualBox VM '{name}' [{id}]: {nio} removed from adapter {adapter_id}".format(name=self.name, log.info("VirtualBox VM '{name}' [{id}]: {nio} removed from adapter {adapter_number}".format(name=self.name,
id=self.id, id=self.id,
nio=nio, nio=nio,
adapter_id=adapter_id)) adapter_number=adapter_number))
return nio return nio
def start_capture(self, adapter_id, output_file): def start_capture(self, adapter_number, output_file):
""" """
Starts a packet capture. Starts a packet capture.
:param adapter_id: adapter ID :param adapter_number: adapter number
:param output_file: PCAP destination file for the capture :param output_file: PCAP destination file for the capture
""" """
try: try:
adapter = self._ethernet_adapters[adapter_id] adapter = self._ethernet_adapters[adapter_number]
except IndexError: except IndexError:
raise VirtualBoxError("Adapter {adapter_id} doesn't exist on VirtualBox VM '{name}'".format(name=self.name, raise VirtualBoxError("Adapter {adapter_number} doesn't exist on VirtualBox VM '{name}'".format(name=self.name,
adapter_id=adapter_id)) adapter_number=adapter_number))
nio = adapter.get_nio(0) nio = adapter.get_nio(0)
if nio.capturing: if nio.capturing:
raise VirtualBoxError("Packet capture is already activated on adapter {adapter_id}".format(adapter_id=adapter_id)) raise VirtualBoxError("Packet capture is already activated on adapter {adapter_number}".format(adapter_number=adapter_number))
nio.startPacketCapture(output_file) nio.startPacketCapture(output_file)
log.info("VirtualBox VM '{name}' [{id}]: starting packet capture on adapter {adapter_id}".format(name=self.name, log.info("VirtualBox VM '{name}' [{id}]: starting packet capture on adapter {adapter_number}".format(name=self.name,
id=self.id, id=self.id,
adapter_id=adapter_id)) adapter_number=adapter_number))
def stop_capture(self, adapter_id): def stop_capture(self, adapter_number):
""" """
Stops a packet capture. Stops a packet capture.
:param adapter_id: adapter ID :param adapter_number: adapter number
""" """
try: try:
adapter = self._ethernet_adapters[adapter_id] adapter = self._ethernet_adapters[adapter_number]
except IndexError: except IndexError:
raise VirtualBoxError("Adapter {adapter_id} doesn't exist on VirtualBox VM '{name}'".format(name=self.name, raise VirtualBoxError("Adapter {adapter_number} doesn't exist on VirtualBox VM '{name}'".format(name=self.name,
adapter_id=adapter_id)) adapter_number=adapter_number))
nio = adapter.get_nio(0) nio = adapter.get_nio(0)
nio.stopPacketCapture() nio.stopPacketCapture()
log.info("VirtualBox VM '{name}' [{id}]: stopping packet capture on adapter {adapter_id}".format(name=self.name, log.info("VirtualBox VM '{name}' [{id}]: stopping packet capture on adapter {adapter_number}".format(name=self.name,
id=self.id, id=self.id,
adapter_id=adapter_id)) adapter_number=adapter_number))

20
gns3server/schemas/dynamips.py
View File

@ -620,6 +620,26 @@ VM_NIO_SCHEMA = {
"required": ["type"] "required": ["type"]
} }
VM_CAPTURE_SCHEMA = {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Request validation to start a packet capture on a Dynamips VM instance port",
"type": "object",
"properties": {
"capture_file_name": {
"description": "Capture file name",
"type": "string",
"minLength": 1,
},
"data_link_type": {
"description": "PCAP data link type",
"type": "string",
"minLength": 1,
},
},
"additionalProperties": False,
"required": ["capture_file_name", "data_link_type"]
}
VM_OBJECT_SCHEMA = { VM_OBJECT_SCHEMA = {
"$schema": "http://json-schema.org/draft-04/schema#", "$schema": "http://json-schema.org/draft-04/schema#",
"description": "Dynamips VM instance", "description": "Dynamips VM instance",