mirror of
https://github.com/GNS3/gns3-server
synced 2024-12-26 08:48:11 +00:00
651 lines
21 KiB
Python
651 lines
21 KiB
Python
# -*- coding: utf-8 -*-
|
|
#
|
|
# Copyright (C) 2014 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/>.
|
|
|
|
"""
|
|
VPCS server module.
|
|
"""
|
|
|
|
import os
|
|
import base64
|
|
import socket
|
|
import shutil
|
|
|
|
from gns3server.modules import IModule
|
|
from gns3server.config import Config
|
|
from .vpcs_device import VPCSDevice
|
|
from .vpcs_error import VPCSError
|
|
from .nios.nio_udp import NIO_UDP
|
|
from .nios.nio_tap import NIO_TAP
|
|
from ..attic import find_unused_port
|
|
|
|
from .schemas import VPCS_CREATE_SCHEMA
|
|
from .schemas import VPCS_DELETE_SCHEMA
|
|
from .schemas import VPCS_UPDATE_SCHEMA
|
|
from .schemas import VPCS_START_SCHEMA
|
|
from .schemas import VPCS_STOP_SCHEMA
|
|
from .schemas import VPCS_RELOAD_SCHEMA
|
|
from .schemas import VPCS_ALLOCATE_UDP_PORT_SCHEMA
|
|
from .schemas import VPCS_ADD_NIO_SCHEMA
|
|
from .schemas import VPCS_DELETE_NIO_SCHEMA
|
|
from .schemas import VPCS_EXPORT_CONFIG_SCHEMA
|
|
|
|
import logging
|
|
log = logging.getLogger(__name__)
|
|
|
|
|
|
class VPCS(IModule):
|
|
"""
|
|
VPCS module.
|
|
|
|
:param name: module name
|
|
:param args: arguments for the module
|
|
:param kwargs: named arguments for the module
|
|
"""
|
|
|
|
def __init__(self, name, *args, **kwargs):
|
|
|
|
# get the VPCS location
|
|
config = Config.instance()
|
|
vpcs_config = config.get_section_config(name.upper())
|
|
self._vpcs = vpcs_config.get("vpcs_path")
|
|
if not self._vpcs or not os.path.isfile(self._vpcs):
|
|
paths = [os.getcwd()] + os.environ["PATH"].split(":")
|
|
# look for VPCS in the current working directory and $PATH
|
|
for path in paths:
|
|
try:
|
|
if "vpcs" in os.listdir(path) and os.access(os.path.join(path, "vpcs"), os.X_OK):
|
|
self._vpcs = os.path.join(path, "vpcs")
|
|
break
|
|
except OSError:
|
|
continue
|
|
|
|
if not self._vpcs:
|
|
log.warning("VPCS binary couldn't be found!")
|
|
elif not os.access(self._vpcs, os.X_OK):
|
|
log.warning("VPCS is not executable")
|
|
|
|
# a new process start when calling IModule
|
|
IModule.__init__(self, name, *args, **kwargs)
|
|
self._vpcs_instances = {}
|
|
self._console_start_port_range = vpcs_config.get("console_start_port_range", 4512)
|
|
self._console_end_port_range = vpcs_config.get("console_end_port_range", 5000)
|
|
self._allocated_udp_ports = []
|
|
self._udp_start_port_range = vpcs_config.get("udp_start_port_range", 40001)
|
|
self._udp_end_port_range = vpcs_config.get("udp_end_port_range", 40512)
|
|
self._host = kwargs["host"]
|
|
self._projects_dir = kwargs["projects_dir"]
|
|
self._tempdir = kwargs["temp_dir"]
|
|
self._working_dir = self._projects_dir
|
|
|
|
def stop(self, signum=None):
|
|
"""
|
|
Properly stops the module.
|
|
|
|
:param signum: signal number (if called by the signal handler)
|
|
"""
|
|
|
|
# delete all VPCS instances
|
|
for vpcs_id in self._vpcs_instances:
|
|
vpcs_instance = self._vpcs_instances[vpcs_id]
|
|
vpcs_instance.delete()
|
|
|
|
IModule.stop(self, signum) # this will stop the I/O loop
|
|
|
|
def get_vpcs_instance(self, vpcs_id):
|
|
"""
|
|
Returns a VPCS device instance.
|
|
|
|
:param vpcs_id: VPCS device identifier
|
|
|
|
:returns: VPCSDevice instance
|
|
"""
|
|
|
|
if vpcs_id not in self._vpcs_instances:
|
|
log.debug("VPCS device ID {} doesn't exist".format(vpcs_id), exc_info=1)
|
|
self.send_custom_error("VPCS device ID {} doesn't exist".format(vpcs_id))
|
|
return None
|
|
return self._vpcs_instances[vpcs_id]
|
|
|
|
@IModule.route("vpcs.reset")
|
|
def reset(self, request):
|
|
"""
|
|
Resets the module.
|
|
|
|
:param request: JSON request
|
|
"""
|
|
|
|
# delete all vpcs instances
|
|
for vpcs_id in self._vpcs_instances:
|
|
vpcs_instance = self._vpcs_instances[vpcs_id]
|
|
vpcs_instance.delete()
|
|
|
|
# resets the instance IDs
|
|
VPCSDevice.reset()
|
|
|
|
self._vpcs_instances.clear()
|
|
self._allocated_udp_ports.clear()
|
|
|
|
log.info("VPCS module has been reset")
|
|
|
|
@IModule.route("vpcs.settings")
|
|
def settings(self, request):
|
|
"""
|
|
Set or update settings.
|
|
|
|
Optional request parameters:
|
|
- path (path to vpcs)
|
|
- working_dir (path to a working directory)
|
|
- project_name
|
|
- console_start_port_range
|
|
- console_end_port_range
|
|
- udp_start_port_range
|
|
- udp_end_port_range
|
|
|
|
:param request: JSON request
|
|
"""
|
|
|
|
if request is None:
|
|
self.send_param_error()
|
|
return
|
|
|
|
if "path" in request and request["path"]:
|
|
self._vpcs = request["path"]
|
|
log.info("VPCS path set to {}".format(self._vpcs))
|
|
for vpcs_id in self._vpcs_instances:
|
|
vpcs_instance = self._vpcs_instances[vpcs_id]
|
|
vpcs_instance.path = self._vpcs
|
|
|
|
if "working_dir" in request:
|
|
new_working_dir = request["working_dir"]
|
|
log.info("this server is local with working directory path to {}".format(new_working_dir))
|
|
else:
|
|
new_working_dir = os.path.join(self._projects_dir, request["project_name"])
|
|
log.info("this server is remote with working directory path to {}".format(new_working_dir))
|
|
if self._projects_dir != self._working_dir != new_working_dir:
|
|
if not os.path.isdir(new_working_dir):
|
|
try:
|
|
shutil.move(self._working_dir, new_working_dir)
|
|
except OSError as e:
|
|
log.error("could not move working directory from {} to {}: {}".format(self._working_dir,
|
|
new_working_dir,
|
|
e))
|
|
return
|
|
|
|
# update the working directory if it has changed
|
|
if self._working_dir != new_working_dir:
|
|
self._working_dir = new_working_dir
|
|
for vpcs_id in self._vpcs_instances:
|
|
vpcs_instance = self._vpcs_instances[vpcs_id]
|
|
vpcs_instance.working_dir = os.path.join(self._working_dir, "vpcs", "pc-{}".format(vpcs_instance.id))
|
|
|
|
if "console_start_port_range" in request and "console_end_port_range" in request:
|
|
self._console_start_port_range = request["console_start_port_range"]
|
|
self._console_end_port_range = request["console_end_port_range"]
|
|
|
|
if "udp_start_port_range" in request and "udp_end_port_range" in request:
|
|
self._udp_start_port_range = request["udp_start_port_range"]
|
|
self._udp_end_port_range = request["udp_end_port_range"]
|
|
|
|
log.debug("received request {}".format(request))
|
|
|
|
@IModule.route("vpcs.create")
|
|
def vpcs_create(self, request):
|
|
"""
|
|
Creates a new VPCS instance.
|
|
|
|
Mandatory request parameters:
|
|
- name (VPCS name)
|
|
|
|
Optional request parameters:
|
|
- console (VPCS console port)
|
|
|
|
Response parameters:
|
|
- id (VPCS instance identifier)
|
|
- name (VPCS name)
|
|
- default settings
|
|
|
|
:param request: JSON request
|
|
"""
|
|
|
|
# validate the request
|
|
if not self.validate_request(request, VPCS_CREATE_SCHEMA):
|
|
return
|
|
|
|
name = request["name"]
|
|
console = request.get("console")
|
|
vpcs_id = request.get("vpcs_id")
|
|
|
|
try:
|
|
|
|
if not self._vpcs:
|
|
raise VPCSError("No path to a VPCS executable has been set")
|
|
|
|
vpcs_instance = VPCSDevice(name,
|
|
self._vpcs,
|
|
self._working_dir,
|
|
self._host,
|
|
vpcs_id,
|
|
console,
|
|
self._console_start_port_range,
|
|
self._console_end_port_range)
|
|
|
|
except VPCSError as e:
|
|
self.send_custom_error(str(e))
|
|
return
|
|
|
|
response = {"name": vpcs_instance.name,
|
|
"id": vpcs_instance.id}
|
|
|
|
defaults = vpcs_instance.defaults()
|
|
response.update(defaults)
|
|
self._vpcs_instances[vpcs_instance.id] = vpcs_instance
|
|
self.send_response(response)
|
|
|
|
@IModule.route("vpcs.delete")
|
|
def vpcs_delete(self, request):
|
|
"""
|
|
Deletes a VPCS instance.
|
|
|
|
Mandatory request parameters:
|
|
- id (VPCS instance identifier)
|
|
|
|
Response parameter:
|
|
- True on success
|
|
|
|
:param request: JSON request
|
|
"""
|
|
|
|
# validate the request
|
|
if not self.validate_request(request, VPCS_DELETE_SCHEMA):
|
|
return
|
|
|
|
# get the instance
|
|
vpcs_instance = self.get_vpcs_instance(request["id"])
|
|
if not vpcs_instance:
|
|
return
|
|
|
|
try:
|
|
vpcs_instance.clean_delete()
|
|
del self._vpcs_instances[request["id"]]
|
|
except VPCSError as e:
|
|
self.send_custom_error(str(e))
|
|
return
|
|
|
|
self.send_response(True)
|
|
|
|
@IModule.route("vpcs.update")
|
|
def vpcs_update(self, request):
|
|
"""
|
|
Updates a VPCS instance
|
|
|
|
Mandatory request parameters:
|
|
- id (VPCS instance identifier)
|
|
|
|
Optional request parameters:
|
|
- any setting to update
|
|
- script_file_base64 (base64 encoded)
|
|
|
|
Response parameters:
|
|
- updated settings
|
|
|
|
:param request: JSON request
|
|
"""
|
|
|
|
# validate the request
|
|
if not self.validate_request(request, VPCS_UPDATE_SCHEMA):
|
|
return
|
|
|
|
# get the instance
|
|
vpcs_instance = self.get_vpcs_instance(request["id"])
|
|
if not vpcs_instance:
|
|
return
|
|
|
|
config_path = os.path.join(vpcs_instance.working_dir, "startup.vpc")
|
|
try:
|
|
if "script_file_base64" in request:
|
|
# a new startup-config has been pushed
|
|
config = base64.decodebytes(request["script_file_base64"].encode("utf-8")).decode("utf-8")
|
|
config = config.replace("\r", "")
|
|
config = config.replace('%h', vpcs_instance.name)
|
|
try:
|
|
with open(config_path, "w") as f:
|
|
log.info("saving script file to {}".format(config_path))
|
|
f.write(config)
|
|
except OSError as e:
|
|
raise VPCSError("Could not save the configuration {}: {}".format(config_path, e))
|
|
# update the request with the new local startup-config path
|
|
request["script_file"] = os.path.basename(config_path)
|
|
elif "script_file" in request:
|
|
if os.path.isfile(request["script_file"]) and request["script_file"] != config_path:
|
|
# this is a local file set in the GUI
|
|
try:
|
|
with open(request["script_file"], "r", errors="replace") as f:
|
|
config = f.read()
|
|
with open(config_path, "w") as f:
|
|
config = config.replace("\r", "")
|
|
config = config.replace('%h', vpcs_instance.name)
|
|
f.write(config)
|
|
request["script_file"] = os.path.basename(config_path)
|
|
except OSError as e:
|
|
raise VPCSError("Could not save the configuration from {} to {}: {}".format(request["script_file"], config_path, e))
|
|
elif not os.path.isfile(config_path):
|
|
raise VPCSError("Startup-config {} could not be found on this server".format(request["script_file"]))
|
|
except VPCSError as e:
|
|
self.send_custom_error(str(e))
|
|
return
|
|
|
|
# update the VPCS settings
|
|
response = {}
|
|
for name, value in request.items():
|
|
if hasattr(vpcs_instance, name) and getattr(vpcs_instance, name) != value:
|
|
try:
|
|
setattr(vpcs_instance, name, value)
|
|
response[name] = value
|
|
except VPCSError as e:
|
|
self.send_custom_error(str(e))
|
|
return
|
|
|
|
self.send_response(response)
|
|
|
|
@IModule.route("vpcs.start")
|
|
def vpcs_start(self, request):
|
|
"""
|
|
Starts a VPCS instance.
|
|
|
|
Mandatory request parameters:
|
|
- id (VPCS instance identifier)
|
|
|
|
Response parameters:
|
|
- True on success
|
|
|
|
:param request: JSON request
|
|
"""
|
|
|
|
# validate the request
|
|
if not self.validate_request(request, VPCS_START_SCHEMA):
|
|
return
|
|
|
|
# get the instance
|
|
vpcs_instance = self.get_vpcs_instance(request["id"])
|
|
if not vpcs_instance:
|
|
return
|
|
|
|
try:
|
|
vpcs_instance.start()
|
|
except VPCSError as e:
|
|
self.send_custom_error(str(e))
|
|
return
|
|
self.send_response(True)
|
|
|
|
@IModule.route("vpcs.stop")
|
|
def vpcs_stop(self, request):
|
|
"""
|
|
Stops a VPCS instance.
|
|
|
|
Mandatory request parameters:
|
|
- id (VPCS instance identifier)
|
|
|
|
Response parameters:
|
|
- True on success
|
|
|
|
:param request: JSON request
|
|
"""
|
|
|
|
# validate the request
|
|
if not self.validate_request(request, VPCS_STOP_SCHEMA):
|
|
return
|
|
|
|
# get the instance
|
|
vpcs_instance = self.get_vpcs_instance(request["id"])
|
|
if not vpcs_instance:
|
|
return
|
|
|
|
try:
|
|
vpcs_instance.stop()
|
|
except VPCSError as e:
|
|
self.send_custom_error(str(e))
|
|
return
|
|
self.send_response(True)
|
|
|
|
@IModule.route("vpcs.reload")
|
|
def vpcs_reload(self, request):
|
|
"""
|
|
Reloads a VPCS instance.
|
|
|
|
Mandatory request parameters:
|
|
- id (VPCS identifier)
|
|
|
|
Response parameters:
|
|
- True on success
|
|
|
|
:param request: JSON request
|
|
"""
|
|
|
|
# validate the request
|
|
if not self.validate_request(request, VPCS_RELOAD_SCHEMA):
|
|
return
|
|
|
|
# get the instance
|
|
vpcs_instance = self.get_vpcs_instance(request["id"])
|
|
if not vpcs_instance:
|
|
return
|
|
|
|
try:
|
|
if vpcs_instance.is_running():
|
|
vpcs_instance.stop()
|
|
vpcs_instance.start()
|
|
except VPCSError as e:
|
|
self.send_custom_error(str(e))
|
|
return
|
|
self.send_response(True)
|
|
|
|
@IModule.route("vpcs.allocate_udp_port")
|
|
def allocate_udp_port(self, request):
|
|
"""
|
|
Allocates a UDP port in order to create an UDP NIO.
|
|
|
|
Mandatory request parameters:
|
|
- id (VPCS identifier)
|
|
- port_id (unique port identifier)
|
|
|
|
Response parameters:
|
|
- port_id (unique port identifier)
|
|
- lport (allocated local port)
|
|
|
|
:param request: JSON request
|
|
"""
|
|
|
|
# validate the request
|
|
if not self.validate_request(request, VPCS_ALLOCATE_UDP_PORT_SCHEMA):
|
|
return
|
|
|
|
# get the instance
|
|
vpcs_instance = self.get_vpcs_instance(request["id"])
|
|
if not vpcs_instance:
|
|
return
|
|
|
|
try:
|
|
port = find_unused_port(self._udp_start_port_range,
|
|
self._udp_end_port_range,
|
|
host=self._host,
|
|
socket_type="UDP",
|
|
ignore_ports=self._allocated_udp_ports)
|
|
except Exception as e:
|
|
self.send_custom_error(str(e))
|
|
return
|
|
|
|
self._allocated_udp_ports.append(port)
|
|
log.info("{} [id={}] has allocated UDP port {} with host {}".format(vpcs_instance.name,
|
|
vpcs_instance.id,
|
|
port,
|
|
self._host))
|
|
|
|
response = {"lport": port,
|
|
"port_id": request["port_id"]}
|
|
self.send_response(response)
|
|
|
|
@IModule.route("vpcs.add_nio")
|
|
def add_nio(self, request):
|
|
"""
|
|
Adds an NIO (Network Input/Output) for a VPCS instance.
|
|
|
|
Mandatory request parameters:
|
|
- id (VPCS instance identifier)
|
|
- port (port number)
|
|
- port_id (unique port identifier)
|
|
- nio (one of the following)
|
|
- type "nio_udp"
|
|
- lport (local port)
|
|
- rhost (remote host)
|
|
- rport (remote port)
|
|
- type "nio_tap"
|
|
- tap_device (TAP device name e.g. tap0)
|
|
|
|
Response parameters:
|
|
- port_id (unique port identifier)
|
|
|
|
:param request: JSON request
|
|
"""
|
|
|
|
# validate the request
|
|
if not self.validate_request(request, VPCS_ADD_NIO_SCHEMA):
|
|
return
|
|
|
|
# get the instance
|
|
vpcs_instance = self.get_vpcs_instance(request["id"])
|
|
if not vpcs_instance:
|
|
return
|
|
|
|
port = request["port"]
|
|
try:
|
|
nio = None
|
|
if request["nio"]["type"] == "nio_udp":
|
|
lport = request["nio"]["lport"]
|
|
rhost = request["nio"]["rhost"]
|
|
rport = request["nio"]["rport"]
|
|
try:
|
|
#TODO: handle IPv6
|
|
with socket.socket(socket.AF_INET, socket.SOCK_DGRAM) as sock:
|
|
sock.connect((rhost, rport))
|
|
except OSError as e:
|
|
raise VPCSError("Could not create an UDP connection to {}:{}: {}".format(rhost, rport, e))
|
|
nio = NIO_UDP(lport, rhost, rport)
|
|
elif request["nio"]["type"] == "nio_tap":
|
|
tap_device = request["nio"]["tap_device"]
|
|
if not self.has_privileged_access(self._vpcs):
|
|
raise VPCSError("{} has no privileged access to {}.".format(self._vpcs, tap_device))
|
|
nio = NIO_TAP(tap_device)
|
|
if not nio:
|
|
raise VPCSError("Requested NIO does not exist or is not supported: {}".format(request["nio"]["type"]))
|
|
except VPCSError as e:
|
|
self.send_custom_error(str(e))
|
|
return
|
|
|
|
try:
|
|
vpcs_instance.port_add_nio_binding(port, nio)
|
|
except VPCSError as e:
|
|
self.send_custom_error(str(e))
|
|
return
|
|
|
|
self.send_response({"port_id": request["port_id"]})
|
|
|
|
@IModule.route("vpcs.delete_nio")
|
|
def delete_nio(self, request):
|
|
"""
|
|
Deletes an NIO (Network Input/Output).
|
|
|
|
Mandatory request parameters:
|
|
- id (VPCS instance identifier)
|
|
- port (port identifier)
|
|
|
|
Response parameters:
|
|
- True on success
|
|
|
|
:param request: JSON request
|
|
"""
|
|
|
|
# validate the request
|
|
if not self.validate_request(request, VPCS_DELETE_NIO_SCHEMA):
|
|
return
|
|
|
|
# get the instance
|
|
vpcs_instance = self.get_vpcs_instance(request["id"])
|
|
if not vpcs_instance:
|
|
return
|
|
|
|
port = request["port"]
|
|
try:
|
|
nio = vpcs_instance.port_remove_nio_binding(port)
|
|
if isinstance(nio, NIO_UDP) and nio.lport in self._allocated_udp_ports:
|
|
self._allocated_udp_ports.remove(nio.lport)
|
|
except VPCSError as e:
|
|
self.send_custom_error(str(e))
|
|
return
|
|
|
|
self.send_response(True)
|
|
|
|
@IModule.route("vpcs.export_config")
|
|
def export_config(self, request):
|
|
"""
|
|
Exports the script file from a VPCS instance.
|
|
|
|
Mandatory request parameters:
|
|
- id (vm identifier)
|
|
|
|
Response parameters:
|
|
- script_file_base64 (script file base64 encoded)
|
|
- False if no configuration can be exported
|
|
"""
|
|
|
|
# validate the request
|
|
if not self.validate_request(request, VPCS_EXPORT_CONFIG_SCHEMA):
|
|
return
|
|
|
|
# get the instance
|
|
vpcs_instance = self.get_vpcs_instance(request["id"])
|
|
if not vpcs_instance:
|
|
return
|
|
|
|
response = {}
|
|
script_file_path = os.path.join(vpcs_instance.working_dir, vpcs_instance.script_file)
|
|
try:
|
|
with open(script_file_path, "rb") as f:
|
|
config = f.read()
|
|
response["script_file_base64"] = base64.encodebytes(config).decode("utf-8")
|
|
except OSError as e:
|
|
self.send_custom_error("unable to export the script file: {}".format(e))
|
|
return
|
|
|
|
if not response:
|
|
self.send_response(False)
|
|
else:
|
|
self.send_response(response)
|
|
|
|
@IModule.route("vpcs.echo")
|
|
def echo(self, request):
|
|
"""
|
|
Echo end point for testing purposes.
|
|
|
|
:param request: JSON request
|
|
"""
|
|
|
|
if request is None:
|
|
self.send_param_error()
|
|
else:
|
|
log.debug("received request {}".format(request))
|
|
self.send_response(request)
|