diff --git a/gns3/local_server_config.py b/gns3/local_server_config.py index 42dbce07..768431f6 100644 --- a/gns3/local_server_config.py +++ b/gns3/local_server_config.py @@ -138,6 +138,18 @@ class LocalServerConfig: if changed: self.writeConfig() + def deleteSetting(self, section, name): + """ + Delete a specific setting in a given section. + + :param section: section name + :param name: setting name to delete + """ + + if section in self._config and name in self._config[section]: + del self._config[section][name] + self.writeConfig() + @staticmethod def instance(): """ diff --git a/gns3/modules/builtin/__init__.py b/gns3/modules/builtin/__init__.py index 4e87acb8..a315b630 100644 --- a/gns3/modules/builtin/__init__.py +++ b/gns3/modules/builtin/__init__.py @@ -19,8 +19,11 @@ Built-in module implementation. """ +import copy + from gns3.qt import QtWidgets from gns3.local_config import LocalConfig +from gns3.local_server_config import LocalServerConfig from ..module import Module from .cloud import Cloud @@ -89,6 +92,15 @@ class Builtin(Module): LocalConfig.instance().saveSectionSettings(self.__class__.__name__, self._settings) + server_settings = {} + config = LocalServerConfig.instance() + if self._settings["default_nat_interface"]: + # save some settings to the server config file + server_settings["default_nat_interface"] = self._settings["default_nat_interface"] + config.saveSettings(self.__class__.__name__, server_settings) + else: + config.deleteSetting(self.__class__.__name__, "default_nat_interface") + def _loadSettings(self): """ Loads the settings from the persistent settings file. diff --git a/gns3/modules/builtin/pages/builtin_preferences_page.py b/gns3/modules/builtin/pages/builtin_preferences_page.py index bbc6a35c..29aea07e 100644 --- a/gns3/modules/builtin/pages/builtin_preferences_page.py +++ b/gns3/modules/builtin/pages/builtin_preferences_page.py @@ -23,6 +23,7 @@ from gns3.qt import QtWidgets from .. import Builtin from ..ui.builtin_preferences_page_ui import Ui_BuiltinPreferencesPageWidget from ..settings import BUILTIN_SETTINGS +from gns3.utils.interfaces import interfaces class BuiltinPreferencesPage(QtWidgets.QWidget, Ui_BuiltinPreferencesPageWidget): @@ -47,6 +48,16 @@ class BuiltinPreferencesPage(QtWidgets.QWidget, Ui_BuiltinPreferencesPageWidget) :param settings: Built-in settings """ + self.uiNATInterfaceComboBox.clear() + self.uiNATInterfaceComboBox.addItem("") + for interface in interfaces(): + self.uiNATInterfaceComboBox.addItem(interface["name"]) + + # load the console type + index = self.uiNATInterfaceComboBox.findText(settings["default_nat_interface"]) + if index != -1: + self.uiNATInterfaceComboBox.setCurrentIndex(index) + def loadPreferences(self): """Loads Built-in preferences.""" @@ -57,4 +68,6 @@ class BuiltinPreferencesPage(QtWidgets.QWidget, Ui_BuiltinPreferencesPageWidget) """Saves Built-in preferences.""" new_settings = {} + default_nat_interface = self.uiNATInterfaceComboBox.currentText().lower() + new_settings["default_nat_interface"] = default_nat_interface Builtin.instance().setSettings(new_settings) diff --git a/gns3/modules/builtin/settings.py b/gns3/modules/builtin/settings.py index 38ce7cfd..9279361b 100644 --- a/gns3/modules/builtin/settings.py +++ b/gns3/modules/builtin/settings.py @@ -19,11 +19,18 @@ Default Built-in settings. """ +import sys + from gns3.node import Node -BUILTIN_SETTINGS = { -} +if sys.platform.startswith("linux"): + DEFAULT_NAT_INTERFACE = "virbr0" +else: + DEFAULT_NAT_INTERFACE = "vmnet8" +BUILTIN_SETTINGS = { + "default_nat_interface": DEFAULT_NAT_INTERFACE +} CLOUD_SETTINGS = { "name": "", diff --git a/gns3/modules/builtin/ui/builtin_preferences_page.ui b/gns3/modules/builtin/ui/builtin_preferences_page.ui index 82b4d529..9ffe0b52 100644 --- a/gns3/modules/builtin/ui/builtin_preferences_page.ui +++ b/gns3/modules/builtin/ui/builtin_preferences_page.ui @@ -6,8 +6,8 @@ 0 0 - 330 - 200 + 456 + 385 @@ -26,8 +26,18 @@ Local settings - - + + + + + Default NAT interface: + + + + + + + Qt::Vertical diff --git a/gns3/modules/builtin/ui/builtin_preferences_page_ui.py b/gns3/modules/builtin/ui/builtin_preferences_page_ui.py index bafd71fc..2fe03784 100644 --- a/gns3/modules/builtin/ui/builtin_preferences_page_ui.py +++ b/gns3/modules/builtin/ui/builtin_preferences_page_ui.py @@ -2,8 +2,7 @@ # Form implementation generated from reading ui file '/home/grossmj/PycharmProjects/gns3-gui/gns3/modules/builtin/ui/builtin_preferences_page.ui' # -# Created: Wed Dec 7 21:40:18 2016 -# by: PyQt5 UI code generator 5.2.1 +# Created by: PyQt5 UI code generator 5.9.1 # # WARNING! All changes made in this file will be lost! @@ -12,7 +11,7 @@ from PyQt5 import QtCore, QtGui, QtWidgets class Ui_BuiltinPreferencesPageWidget(object): def setupUi(self, BuiltinPreferencesPageWidget): BuiltinPreferencesPageWidget.setObjectName("BuiltinPreferencesPageWidget") - BuiltinPreferencesPageWidget.resize(330, 200) + BuiltinPreferencesPageWidget.resize(456, 385) self.verticalLayout = QtWidgets.QVBoxLayout(BuiltinPreferencesPageWidget) self.verticalLayout.setObjectName("verticalLayout") self.uiTabWidget = QtWidgets.QTabWidget(BuiltinPreferencesPageWidget) @@ -20,10 +19,16 @@ class Ui_BuiltinPreferencesPageWidget(object): self.uiTabWidget.setObjectName("uiTabWidget") self.uiServerSettingsTabWidget = QtWidgets.QWidget() self.uiServerSettingsTabWidget.setObjectName("uiServerSettingsTabWidget") - self.verticalLayout_2 = QtWidgets.QVBoxLayout(self.uiServerSettingsTabWidget) - self.verticalLayout_2.setObjectName("verticalLayout_2") + self.gridLayout = QtWidgets.QGridLayout(self.uiServerSettingsTabWidget) + self.gridLayout.setObjectName("gridLayout") + self.label = QtWidgets.QLabel(self.uiServerSettingsTabWidget) + self.label.setObjectName("label") + self.gridLayout.addWidget(self.label, 0, 0, 1, 1) + self.uiNATInterfaceComboBox = QtWidgets.QComboBox(self.uiServerSettingsTabWidget) + self.uiNATInterfaceComboBox.setObjectName("uiNATInterfaceComboBox") + self.gridLayout.addWidget(self.uiNATInterfaceComboBox, 1, 0, 1, 1) spacerItem = QtWidgets.QSpacerItem(20, 5, QtWidgets.QSizePolicy.Minimum, QtWidgets.QSizePolicy.Expanding) - self.verticalLayout_2.addItem(spacerItem) + self.gridLayout.addItem(spacerItem, 2, 0, 1, 1) self.uiTabWidget.addTab(self.uiServerSettingsTabWidget, "") self.verticalLayout.addWidget(self.uiTabWidget) self.horizontalLayout_2 = QtWidgets.QHBoxLayout() @@ -42,6 +47,7 @@ class Ui_BuiltinPreferencesPageWidget(object): def retranslateUi(self, BuiltinPreferencesPageWidget): _translate = QtCore.QCoreApplication.translate BuiltinPreferencesPageWidget.setWindowTitle(_translate("BuiltinPreferencesPageWidget", "Built-in")) + self.label.setText(_translate("BuiltinPreferencesPageWidget", "Default NAT interface:")) self.uiTabWidget.setTabText(self.uiTabWidget.indexOf(self.uiServerSettingsTabWidget), _translate("BuiltinPreferencesPageWidget", "Local settings")) self.uiRestoreDefaultsPushButton.setText(_translate("BuiltinPreferencesPageWidget", "Restore defaults")) diff --git a/gns3/utils/interfaces.py b/gns3/utils/interfaces.py new file mode 100644 index 00000000..06bbb4aa --- /dev/null +++ b/gns3/utils/interfaces.py @@ -0,0 +1,151 @@ +# -*- coding: utf-8 -*- +# +# Copyright (C) 2018 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 . + + +import sys +import socket +import psutil + +if psutil.version_info < (3, 0, 0): + raise Exception("psutil version should >= 3.0.0. If you are under Ubuntu/Debian install gns3 via apt instead of pip") + +import logging +log = logging.getLogger(__name__) + + +def _get_windows_interfaces_from_registry(): + + import winreg + + # HKLM\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters\Interfaces + interfaces = [] + try: + hkey = winreg.OpenKey(winreg.HKEY_LOCAL_MACHINE, r"SOFTWARE\Microsoft\Windows NT\CurrentVersion\NetworkCards") + for index in range(winreg.QueryInfoKey(hkey)[0]): + network_card_id = winreg.EnumKey(hkey, index) + hkeycard = winreg.OpenKey(hkey, network_card_id) + guid, _ = winreg.QueryValueEx(hkeycard, "ServiceName") + netcard, _ = winreg.QueryValueEx(hkeycard, "Description") + connection = r"SYSTEM\CurrentControlSet\Control\Network\{4D36E972-E325-11CE-BFC1-08002BE10318}" + "\{}\Connection".format(guid) + hkeycon = winreg.OpenKey(winreg.HKEY_LOCAL_MACHINE, connection) + name, _ = winreg.QueryValueEx(hkeycon, "Name") + interface = r"SYSTEM\CurrentControlSet\Services\Tcpip\Parameters\Interfaces\{}".format(guid) + hkeyinterface = winreg.OpenKey(winreg.HKEY_LOCAL_MACHINE, interface) + is_dhcp_enabled, _ = winreg.QueryValueEx(hkeyinterface, "EnableDHCP") + if is_dhcp_enabled: + ip_address, _ = winreg.QueryValueEx(hkeyinterface, "DhcpIPAddress") + netmask, _ = winreg.QueryValueEx(hkeyinterface, "DhcpSubnetMask") + else: + ip_address, _ = winreg.QueryValueEx(hkeyinterface, "IPAddress") + netmask, _ = winreg.QueryValueEx(hkeyinterface, "SubnetMask") + if ip_address: + # get the first IPv4 address only + ip_address = ip_address[0] + npf_interface = "\\Device\\NPF_{guid}".format(guid=guid) + interfaces.append({"id": npf_interface, + "name": name, + "ip_address": ip_address, + "mac_address": "", # TODO: find MAC address in registry + "netcard": netcard, + "netmask": netmask, + "type": "ethernet"}) + winreg.CloseKey(hkeyinterface) + winreg.CloseKey(hkeycon) + winreg.CloseKey(hkeycard) + winreg.CloseKey(hkey) + except OSError as e: + log.error("could not read registry information: {}".format(e)) + + return interfaces + + +def get_windows_interfaces(): + """ + Get Windows interfaces. + + :returns: list of windows interfaces + """ + + import win32com.client + import pywintypes + + interfaces = [] + try: + locator = win32com.client.Dispatch("WbemScripting.SWbemLocator") + service = locator.ConnectServer(".", "root\cimv2") + network_configs = service.InstancesOf("Win32_NetworkAdapterConfiguration") + # more info on Win32_NetworkAdapter: http://msdn.microsoft.com/en-us/library/aa394216%28v=vs.85%29.aspx + for adapter in service.InstancesOf("Win32_NetworkAdapter"): + if adapter.NetConnectionStatus == 2 or adapter.NetConnectionStatus == 7: + # adapter is connected or media disconnected + ip_address = "" + netmask = "" + for network_config in network_configs: + if network_config.InterfaceIndex == adapter.InterfaceIndex: + if network_config.IPAddress: + # get the first IPv4 address only + ip_address = network_config.IPAddress[0] + netmask = network_config.IPSubnet[0] + break + npf_interface = "\\Device\\NPF_{guid}".format(guid=adapter.GUID) + interfaces.append({"id": npf_interface, + "name": adapter.NetConnectionID, + "ip_address": ip_address, + "mac_address": adapter.MACAddress, + "netcard": adapter.name, + "netmask": netmask, + "type": "ethernet"}) + except (AttributeError, pywintypes.com_error): + log.warning("Could not use the COM service to retrieve interface info, trying using the registry...") + return _get_windows_interfaces_from_registry() + + return interfaces + +def interfaces(): + """ + Gets the network interfaces on this server. + + :returns: list of network interfaces + """ + + results = [] + if not sys.platform.startswith("win"): + net_if_addrs = psutil.net_if_addrs() + for interface in sorted(net_if_addrs.keys()): + ip_address = "" + mac_address = "" + netmask = "" + interface_type = "ethernet" + for addr in net_if_addrs[interface]: + # get the first available IPv4 address only + if addr.family == socket.AF_INET: + ip_address = addr.address + netmask = addr.netmask + if addr.family == psutil.AF_LINK: + mac_address = addr.address + if interface.startswith("tap"): + # found no way to reliably detect a TAP interface + interface_type = "tap" + results.append({"id": interface, + "name": interface, + "ip_address": ip_address, + "netmask": netmask, + "mac_address": mac_address, + "type": interface_type}) + else: + results = get_windows_interfaces() + return results