From 2673f4790e19531fba719810a3a38e1917e57214 Mon Sep 17 00:00:00 2001 From: Daniil Baturin Date: Sun, 27 Oct 2019 15:22:49 +0100 Subject: T1773: add a script for converting the config to JSON. It also exposes those functions in vyos.configtree --- python/vyos/configtree.py | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'python') diff --git a/python/vyos/configtree.py b/python/vyos/configtree.py index 8832a5a63..77cffe90b 100644 --- a/python/vyos/configtree.py +++ b/python/vyos/configtree.py @@ -105,6 +105,14 @@ class ConfigTree(object): self.__to_commands.argtypes = [c_void_p] self.__to_commands.restype = c_char_p + self.__to_json = self.__lib.to_json + self.__to_json.argtypes = [c_void_p] + self.__to_json.restype = c_char_p + + self.__to_json_ast = self.__lib.to_json_ast + self.__to_json_ast.argtypes = [c_void_p] + self.__to_json_ast.restype = c_char_p + self.__set_add_value = self.__lib.set_add_value self.__set_add_value.argtypes = [c_void_p, c_char_p, c_char_p] self.__set_add_value.restype = c_int @@ -184,6 +192,12 @@ class ConfigTree(object): def to_commands(self): return self.__to_commands(self.__config).decode() + def to_json(self): + return self.__to_json(self.__config).decode() + + def to_json_ast(self): + return self.__to_json_ast(self.__config).decode() + def set(self, path, value=None, replace=True): """Set new entry in VyOS configuration. path: configuration path e.g. 'system dns forwarding listen-address' -- cgit v1.2.3 From abecba2332d6b6756cf83ba2d87fcbf3640f0c18 Mon Sep 17 00:00:00 2001 From: Daniil Baturin Date: Sun, 27 Oct 2019 16:29:11 +0100 Subject: Replace the try and wait for segfault approach with explicit inSession check. --- python/vyos/config.py | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) (limited to 'python') diff --git a/python/vyos/config.py b/python/vyos/config.py index 3a340b2da..ee1adb289 100644 --- a/python/vyos/config.py +++ b/python/vyos/config.py @@ -104,12 +104,10 @@ class Config(object): running_config_text = f.read() # Session config ("active") only exists in conf mode. - # Trying to obtain it from op mode will cause a fatal cli-shell-api error. - # If that happens, we assume that a script is running from op mode and use the running config - # for the "session config" variable as well. - try: + # In op mode, we'll just use the same running config for both active and session configs. + if self.in_session(): session_config_text = self._run([self._cli_shell_api, '--show-working-only', '--show-show-defaults', 'showConfig']) - except VyOSError: + else: session_config_text = running_config_text self._session_config = vyos.configtree.ConfigTree(session_config_text) -- cgit v1.2.3 From a5d800400aaf9d1df61feb79c3626d37d0a3015d Mon Sep 17 00:00:00 2001 From: Daniil Baturin Date: Sun, 27 Oct 2019 16:38:55 +0100 Subject: Allow list arguments in the vyos.config show_config() function. --- python/vyos/config.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'python') diff --git a/python/vyos/config.py b/python/vyos/config.py index ee1adb289..5c2fc7285 100644 --- a/python/vyos/config.py +++ b/python/vyos/config.py @@ -222,7 +222,7 @@ class Config(object): except VyOSError: return False - def show_config(self, path='', default=None): + def show_config(self, path=[], default=None): """ Args: path (str): Configuration tree path, or empty @@ -231,6 +231,8 @@ class Config(object): Returns: str: working configuration """ + if isinstance(path, list): + path = " ".join(path) try: out = self._run(self._make_command('showConfig', path)) return out -- cgit v1.2.3 From 6564f5cef43f63cdcd70f05bca2222af48d63e59 Mon Sep 17 00:00:00 2001 From: kroy Date: Sun, 27 Oct 2019 10:39:03 -0500 Subject: T1759: Merging interface.py into ifconfig.py --- op-mode-definitions/wireguard.xml | 2 +- python/vyos/ifconfig.py | 98 ++++++++++++++++++++++++- python/vyos/interface.py | 150 -------------------------------------- src/op_mode/wireguard.py | 6 +- 4 files changed, 101 insertions(+), 155 deletions(-) delete mode 100644 python/vyos/interface.py (limited to 'python') diff --git a/op-mode-definitions/wireguard.xml b/op-mode-definitions/wireguard.xml index e52d0ad76..1795fb820 100644 --- a/op-mode-definitions/wireguard.xml +++ b/op-mode-definitions/wireguard.xml @@ -73,7 +73,7 @@ - sudo ${vyos_op_scripts_dir}/wireguard.py "$4" + sudo ${vyos_op_scripts_dir}/wireguard.py --showinterface "$4" diff --git a/python/vyos/ifconfig.py b/python/vyos/ifconfig.py index 3470b3aa6..aa2891ef3 100644 --- a/python/vyos/ifconfig.py +++ b/python/vyos/ifconfig.py @@ -17,12 +17,20 @@ import os import re import jinja2 import json +import glob +import time from vyos.validate import * +import vyos.interface +from vyos.config import Config from ipaddress import IPv4Network, IPv6Address from netifaces import ifaddresses, AF_INET, AF_INET6 from subprocess import Popen, PIPE, STDOUT from time import sleep +from os.path import isfile +from tabulate import tabulate +from hurry.filesize import size,alternative +from datetime import timedelta dhclient_base = r'/var/lib/dhcp/dhclient_' dhcp_cfg = """ @@ -671,6 +679,31 @@ class Interface: if os.path.isfile(self._dhcpv6_lease_file): os.remove(self._dhcpv6_lease_file) + def op_show_interface_stats(self): + stats = self.get_interface_stats() + rx = [['bytes','packets','errors','dropped','overrun','mcast'],[stats['rx_bytes'],stats['rx_packets'],stats['rx_errors'],stats['rx_dropped'],stats['rx_over_errors'],stats['multicast']]] + tx = [['bytes','packets','errors','dropped','carrier','collisions'],[stats['tx_bytes'],stats['tx_packets'],stats['tx_errors'],stats['tx_dropped'],stats['tx_carrier_errors'],stats['collisions']]] + output = "RX: \n" + output += tabulate(rx,headers="firstrow",numalign="right",tablefmt="plain") + output += "\n\nTX: \n" + output += tabulate(tx,headers="firstrow",numalign="right",tablefmt="plain") + print(' '.join(('\n'+output.lstrip()).splitlines(True))) + + def get_interface_stats(self): + interface_stats = dict() + devices = [f for f in glob.glob("/sys/class/net/**/statistics")] + for dev_path in devices: + metrics = [f for f in glob.glob(dev_path +"/**")] + dev = re.findall(r"/sys/class/net/(.*)/statistics",dev_path)[0] + dev_dict = dict() + for metric_path in metrics: + metric = metric_path.replace(dev_path+"/","") + if isfile(metric_path): + data = open(metric_path, 'r').read()[:-1] + dev_dict[metric] = int(data) + interface_stats[dev] = dev_dict + + return interface_stats[self._ifname] class LoopbackIf(Interface): @@ -1371,7 +1404,6 @@ class BondIf(VLANIf): return self._write_sysfs('/sys/class/net/{}/bonding/mode' .format(self._ifname), mode) - class WireGuardIf(Interface): """ Wireguard interface class, contains a comnfig dictionary since @@ -1447,6 +1479,70 @@ class WireGuardIf(Interface): cmd = "wg set {0} peer {1} remove".format( self._ifname, str(peerkey)) return self._cmd(cmd) + + def op_show_interface(self): + wgdump = vyos.interfaces.wireguard_dump().get(self._ifname,None) + + c = Config() + c.set_level(["interfaces","wireguard",self._ifname]) + description = c.return_effective_value(["description"]) + ips = c.return_effective_values(["address"]) + + print ("interface: {}".format(self._ifname)) + if (description): + print (" description: {}".format(description)) + + if (ips): + print (" address: {}".format(", ".join(ips))) + print (" public key: {}".format(wgdump['public_key'])) + print (" private key: (hidden)") + print (" listening port: {}".format(wgdump['listen_port'])) + print () + + for peer in c.list_effective_nodes(["peer"]): + if wgdump['peers']: + pubkey = c.return_effective_value(["peer",peer,"pubkey"]) + if pubkey in wgdump['peers']: + wgpeer = wgdump['peers'][pubkey] + + print (" peer: {}".format(peer)) + print (" public key: {}".format(pubkey)) + + """ figure out if the tunnel is recently active or not """ + status = "inactive" + if (wgpeer['latest_handshake'] is None): + """ no handshake ever """ + status = "inactive" + else: + if int(wgpeer['latest_handshake']) > 0: + delta = timedelta(seconds=int(time.time() - wgpeer['latest_handshake'])) + print (" latest handshake: {}".format(delta)) + if (time.time() - int(wgpeer['latest_handshake']) < (60*5)): + """ Five minutes and the tunnel is still active """ + status = "active" + else: + """ it's been longer than 5 minutes """ + status = "inactive" + elif int(wgpeer['latest_handshake']) == 0: + """ no handshake ever """ + status = "inactive" + print (" status: {}".format(status)) + + if wgpeer['endpoint'] is not None: + print (" endpoint: {}".format(wgpeer['endpoint'])) + + if wgpeer['allowed_ips'] is not None: + print (" allowed ips: {}".format(",".join(wgpeer['allowed_ips']).replace(",",", "))) + + if wgpeer['transfer_rx'] > 0 or wgpeer['transfer_tx'] > 0: + rx_size =size(wgpeer['transfer_rx'],system=alternative) + tx_size =size(wgpeer['transfer_tx'],system=alternative) + print (" transfer: {} received, {} sent".format(rx_size,tx_size)) + + if wgpeer['persistent_keepalive'] is not None: + print (" persistent keepalive: every {} seconds".format(wgpeer['persistent_keepalive'])) + print() + super().op_show_interface_stats() class VXLANIf(Interface, ): diff --git a/python/vyos/interface.py b/python/vyos/interface.py deleted file mode 100644 index cc726e5cc..000000000 --- a/python/vyos/interface.py +++ /dev/null @@ -1,150 +0,0 @@ -# Copyright 2019 VyOS maintainers and contributors -# -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation; either -# version 2.1 of the License, or (at your option) any later version. -# -# This library 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 -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library. If not, see . - -import vyos -from vyos.config import Config -import vyos.interfaces -import vyos.ioctl -from vyos.iflag import IFlag - -import re -import json - -import subprocess -import time -from datetime import timedelta -import glob -from os.path import isfile -from tabulate import tabulate -from hurry.filesize import size,alternative - -class Interface(): - - intf = None - intf_type = None - valid = False - flags = None - - def __init__(self,intf): - self.intf = intf - self.intf_type = vyos.interfaces.get_type_of_interface(self.intf) - self.valid = (self.intf in vyos.interfaces.list_interfaces()) - if (self.valid): - self.flags = vyos.ioctl.get_interface_flags(intf) - - def up(self): - """ return whether interface is up or not """ - return self.flags & IFlag.IFF_UP - - def print_interface(self): - - if not self.valid: - print("Invalid interface [{}]".format(self.intf)) - return - - if (self.intf_type == 'wireguard'): - self.print_wireguard_interface() - - self.print_interface_stats() - - def print_interface_stats(self): - stats = self.get_interface_stats() - rx = [['bytes','packets','errors','dropped','overrun','mcast'],[stats['rx_bytes'],stats['rx_packets'],stats['rx_errors'],stats['rx_dropped'],stats['rx_over_errors'],stats['multicast']]] - tx = [['bytes','packets','errors','dropped','carrier','collisions'],[stats['tx_bytes'],stats['tx_packets'],stats['tx_errors'],stats['tx_dropped'],stats['tx_carrier_errors'],stats['collisions']]] - output = "RX: \n" - output += tabulate(rx,headers="firstrow",numalign="right",tablefmt="plain") - output += "\n\nTX: \n" - output += tabulate(tx,headers="firstrow",numalign="right",tablefmt="plain") - print(' '.join(('\n'+output.lstrip()).splitlines(True))) - - def get_interface_stats(self): - interface_stats = dict() - devices = [f for f in glob.glob("/sys/class/net/**/statistics")] - for dev_path in devices: - metrics = [f for f in glob.glob(dev_path +"/**")] - dev = re.findall(r"/sys/class/net/(.*)/statistics",dev_path)[0] - dev_dict = dict() - for metric_path in metrics: - metric = metric_path.replace(dev_path+"/","") - if isfile(metric_path): - data = open(metric_path, 'r').read()[:-1] - dev_dict[metric] = int(data) - interface_stats[dev] = dev_dict - - return interface_stats[self.intf] - - def print_wireguard_interface(self): - - wgdump = vyos.interfaces.wireguard_dump().get(self.intf,None) - - c = Config() - c.set_level("interfaces wireguard {}".format(self.intf)) - description = c.return_effective_value("description") - ips = c.return_effective_values("address") - - print ("interface: {}".format(self.intf)) - if (description): - print (" description: {}".format(description)) - - if (ips): - print (" address: {}".format(", ".join(ips))) - print (" public key: {}".format(wgdump['public_key'])) - print (" private key: (hidden)") - print (" listening port: {}".format(wgdump['listen_port'])) - print () - - for peer in c.list_effective_nodes(' peer'): - if wgdump['peers']: - pubkey = c.return_effective_value("peer {} pubkey".format(peer)) - if pubkey in wgdump['peers']: - wgpeer = wgdump['peers'][pubkey] - - print (" peer: {}".format(peer)) - print (" public key: {}".format(pubkey)) - - """ figure out if the tunnel is recently active or not """ - status = "inactive" - if (wgpeer['latest_handshake'] is None): - """ no handshake ever """ - status = "inactive" - else: - if int(wgpeer['latest_handshake']) > 0: - delta = timedelta(seconds=int(time.time() - wgpeer['latest_handshake'])) - print (" latest handshake: {}".format(delta)) - if (time.time() - int(wgpeer['latest_handshake']) < (60*5)): - """ Five minutes and the tunnel is still active """ - status = "active" - else: - """ it's been longer than 5 minutes """ - status = "inactive" - elif int(wgpeer['latest_handshake']) == 0: - """ no handshake ever """ - status = "inactive" - print (" status: {}".format(status)) - - if wgpeer['endpoint'] is not None: - print (" endpoint: {}".format(wgpeer['endpoint'])) - - if wgpeer['allowed_ips'] is not None: - print (" allowed ips: {}".format(",".join(wgpeer['allowed_ips']).replace(",",", "))) - - if wgpeer['transfer_rx'] > 0 or wgpeer['transfer_tx'] > 0: - rx_size =size(wgpeer['transfer_rx'],system=alternative) - tx_size =size(wgpeer['transfer_tx'],system=alternative) - print (" transfer: {} received, {} sent".format(rx_size,tx_size)) - - if wgpeer['persistent_keepalive'] is not None: - print (" persistent keepalive: every {} seconds".format(wgpeer['persistent_keepalive'])) - print() diff --git a/src/op_mode/wireguard.py b/src/op_mode/wireguard.py index 6860aa3ea..38c061cf4 100755 --- a/src/op_mode/wireguard.py +++ b/src/op_mode/wireguard.py @@ -24,7 +24,7 @@ import subprocess import syslog as sl import re -from vyos.interface import Interface +from vyos.ifconfig import WireGuardIf from vyos import ConfigError from vyos.config import Config @@ -150,8 +150,8 @@ if __name__ == '__main__': if args.listkdir: list_key_dirs() if args.showinterface: - intf = Interface(args.showinterface) - intf.print_interface() + intf = WireGuardIf(args.showinterface) + intf.op_show_interface() if args.delkdir: if args.location: del_key_dir(args.location) -- cgit v1.2.3 From 1c7b0ab60cb987ef4596758074ba6f824b01158e Mon Sep 17 00:00:00 2001 From: kroy Date: Sun, 27 Oct 2019 11:56:11 -0500 Subject: T1759: Fixing dependency bug from previous commit --- python/vyos/ifconfig.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'python') diff --git a/python/vyos/ifconfig.py b/python/vyos/ifconfig.py index aa2891ef3..df86e3c93 100644 --- a/python/vyos/ifconfig.py +++ b/python/vyos/ifconfig.py @@ -20,8 +20,8 @@ import json import glob import time +import vyos.interfaces from vyos.validate import * -import vyos.interface from vyos.config import Config from ipaddress import IPv4Network, IPv6Address from netifaces import ifaddresses, AF_INET, AF_INET6 -- cgit v1.2.3 From aac75107bc9988ecb599265da029827ff09bf713 Mon Sep 17 00:00:00 2001 From: Daniil Baturin Date: Mon, 28 Oct 2019 15:01:52 +0100 Subject: Add a function for retrieving config dicts. --- python/vyos/config.py | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) (limited to 'python') diff --git a/python/vyos/config.py b/python/vyos/config.py index 5c2fc7285..13b2c107e 100644 --- a/python/vyos/config.py +++ b/python/vyos/config.py @@ -65,6 +65,7 @@ In operational mode, all functions return values from the running config. import os import re +import json import subprocess import vyos.configtree @@ -225,7 +226,7 @@ class Config(object): def show_config(self, path=[], default=None): """ Args: - path (str): Configuration tree path, or empty + path (str list): Configuration tree path, or empty default (str): Default value to return Returns: @@ -239,6 +240,16 @@ class Config(object): except VyOSError: return(default) + def get_config_dict(self, path=[], effective=False): + """ + Args: path (str list): Configuration tree path, can be empty + Returns: a dict representation of the config + """ + res = self.show_config(self._make_path(path)) + config_tree = vyos.configtree.ConfigTree(res) + config_dict = json.loads(config_tree.to_json()) + return config_dict + def is_multi(self, path): """ Args: -- cgit v1.2.3