<h2>Editing File: /usr/lib/python3.6/site-packages/sos/report/plugins/networking.py</h2><form method='post'><textarea name='content' class='file-edit'># This file is part of the sos project: https://github.com/sosreport/sos
#
# This copyrighted material is made available to anyone wishing to use,
# modify, copy, or redistribute it subject to the terms and conditions of
# version 2 of the GNU General Public License.
#
# See the LICENSE file in the source distribution for further information.

from sos.report.plugins import (Plugin, RedHatPlugin, UbuntuPlugin,
                                DebianPlugin, SoSPredicate, PluginOpt)
from sos.policies.distros.ubuntu import UbuntuPolicy
from sos.policies.distros.debian import DebianPolicy


class Networking(Plugin):

    short_desc = 'Network and networking devices configuration'

    plugin_name = &quot;networking&quot;
    profiles = ('network', 'hardware', 'system')
    trace_host = &quot;www.example.com&quot;

    option_list = [
        PluginOpt(&quot;traceroute&quot;, default=False,
                  desc=f&quot;collect a traceroute to {trace_host}&quot;),
        PluginOpt(&quot;namespace-pattern&quot;, default=&quot;&quot;, val_type=str,
                  desc=(&quot;Specific namespace names or patterns to collect, &quot;
                        &quot;whitespace delimited.&quot;)),
        PluginOpt(&quot;namespaces&quot;, default=None, val_type=int,
                  desc=&quot;Number of namespaces to collect, 0 for unlimited&quot;),
        PluginOpt(&quot;ethtool-namespaces&quot;, default=True,
                  desc=(&quot;Toggle if ethtool commands should be run for each &quot;
                        &quot;namespace&quot;)),
        PluginOpt(&quot;eepromdump&quot;, default=False,
                  desc=&quot;Toggle collection of 'ethtool -e' for NICs&quot;)
    ]

    # switch to enable netstat &quot;wide&quot; (non-truncated) output mode
    ns_wide = &quot;-W&quot;

    # list of kernel modules needed by ss_cmd, this may vary by distro version
    ss_kmods = ['tcp_diag', 'udp_diag', 'inet_diag', 'unix_diag',
                'netlink_diag', 'af_packet_diag', 'xsk_diag']

    # list of ethtool short options, used in add_copy_spec and add_cmd_tags
    # do NOT add there &quot;e&quot; (see eepromdump plugopt)
    ethtool_shortopts = &quot;acdgiklmPST&quot;

    def setup(self):
        super().setup()

        self.add_file_tags({
            '/proc/net/bonding/bond.*': 'bond',
            '/etc/hosts': 'hosts'
        })

        self.add_copy_spec([
            &quot;/etc/dnsmasq*&quot;,
            &quot;/etc/host*&quot;,
            &quot;/etc/inetd.conf&quot;,
            &quot;/etc/iproute2&quot;,
            &quot;/etc/network*&quot;,
            &quot;/etc/nsswitch.conf&quot;,
            &quot;/etc/resolv.conf&quot;,
            &quot;/etc/gai.conf&quot;,
            &quot;/etc/xinetd.conf&quot;,
            &quot;/etc/xinetd.d&quot;,
            &quot;/etc/yp.conf&quot;,
            &quot;/proc/net/&quot;,
            &quot;/sys/class/net/*/device/numa_node&quot;,
            &quot;/sys/class/net/*/flags&quot;,
            &quot;/sys/class/net/*/statistics/&quot;,
            &quot;/etc/nmstate/&quot;,
            &quot;/var/lib/lldpad/&quot;,
            &quot;/etc/services&quot;,
        ])

        self.add_forbidden_path([
            &quot;/proc/net/rpc/use-gss-proxy&quot;,
            &quot;/proc/net/rpc/*/channel&quot;,
            &quot;/proc/net/rpc/*/flush&quot;,
            # Cisco CDP
            &quot;/proc/net/cdp&quot;,
            &quot;/sys/net/cdp&quot;,
            # Dialogic Diva
            &quot;/proc/net/eicon&quot;
        ])

        self.add_cmd_output(&quot;ip -o addr&quot;, root_symlink=&quot;ip_addr&quot;,
                            tags='ip_addr')
        self.add_cmd_output(&quot;ip route show table all&quot;, root_symlink=&quot;ip_route&quot;,
                            tags=['ip_route', 'iproute_show_table_all'])
        self.add_cmd_output(&quot;plotnetcfg&quot;)

        self.add_cmd_output(f&quot;netstat {self.ns_wide} -neopa&quot;,
                            root_symlink=&quot;netstat&quot;)

        self.add_cmd_output([
            &quot;nstat -zas&quot;,
            &quot;netstat -s&quot;,
            &quot;netstat -s -6&quot;,
            f&quot;netstat {self.ns_wide} -agn&quot;,
            &quot;networkctl status -a&quot;,
            &quot;ip -6 route show table all&quot;,
            &quot;ip -d route show cache&quot;,
            &quot;ip -d -6 route show cache&quot;,
            &quot;ip -4 rule list&quot;,
            &quot;ip -6 rule list&quot;,
            &quot;ip vrf show&quot;,
            &quot;ip -s -d link&quot;,
            &quot;ip -d address&quot;,
            &quot;ifenslave -a&quot;,
            &quot;ip mroute show&quot;,
            &quot;ip maddr show&quot;,
            &quot;ip -s -s neigh show&quot;,
            &quot;ip neigh show nud noarp&quot;,
            &quot;biosdevname -d&quot;,
            &quot;tc -s qdisc show&quot;,
            &quot;nmstatectl show&quot;,
            &quot;nmstatectl show --running-config&quot;,
        ])

        if self.path_isdir('/sys/class/devlink'):
            self.add_cmd_output([
                &quot;devlink dev param show&quot;,
                &quot;devlink dev info&quot;,
                &quot;devlink port show&quot;,
                &quot;devlink sb show&quot;,
                &quot;devlink sb pool show&quot;,
                &quot;devlink sb port pool show&quot;,
                &quot;devlink sb tc bind show&quot;,
                &quot;devlink -s -v trap show&quot;,
            ])

            devlinks = self.collect_cmd_output(&quot;devlink dev&quot;)
            if devlinks['status'] == 0:
                devlinks_list = devlinks['output'].splitlines()
                for devlink in devlinks_list:
                    self.add_cmd_output([
                        f&quot;devlink dev eswitch show {devlink}&quot;,
                        f&quot;devlink sb occupancy snapshot {devlink}&quot;,
                        f&quot;devlink sb occupancy show {devlink}&quot;,
                        f&quot;devlink -v resource show {devlink}&quot;
                    ])
                    dev_tables = []
                    dpipe = self.collect_cmd_output(
                        f&quot;devlink dpipe table show {devlink}&quot;
                    )
                    if dpipe['status'] == 0:
                        for tableln in dpipe['output'].splitlines():
                            if tableln.startswith('name'):
                                dev_tables.append(tableln.split()[1])
                        self.add_cmd_output([
                            f&quot;devlink dpipe table show {devlink} name {dname}&quot;
                            for dname in dev_tables
                        ])

        # below commands require some kernel module(s) to be loaded
        # run them only if the modules are loaded, or if explicitly requested
        # via --allow-system-changes option
        ip_macsec_show_cmd = &quot;ip -s macsec show&quot;
        macsec_pred = SoSPredicate(self, kmods=['macsec'])
        self.add_cmd_output(ip_macsec_show_cmd, pred=macsec_pred, changes=True)

        self.collect_ss_ip_ethtool_info()
        self.collect_bridge_info()

    def add_command_tags(self):
        &quot;&quot;&quot; Command tags for ip/ethtool/netstat &quot;&quot;&quot;
        for opt in self.ethtool_shortopts:
            self.add_cmd_tags({
                f'ethtool -{opt} .*': f'ethool_{opt}'
            })

        self.add_cmd_tags({
            &quot;ethtool [^-].*&quot;: &quot;ethtool&quot;,
            &quot;ip -d address&quot;: &quot;ip_addr&quot;,
            &quot;ip -s -s neigh show&quot;: &quot;ip_neigh_show&quot;,
            &quot;ip -s -d link&quot;: &quot;ip_s_link&quot;,
            &quot;netstat.*-neopa&quot;: &quot;netstat&quot;,
            &quot;netstat.*-agn&quot;: &quot;netstat_agn&quot;,
            &quot;netstat -s&quot;: &quot;netstat_s&quot;
        })

    def collect_bridge_info(self):
        &quot;&quot;&quot; Collect information about bridges (some data already collected via
        &quot;ip ..&quot; commands)
        &quot;&quot;&quot;
        self.add_cmd_output([
            &quot;bridge -s -s -d link show&quot;,
            &quot;bridge -s -s -d -t fdb show&quot;,
            &quot;bridge -s -s -d -t mdb show&quot;,
            &quot;bridge -d vlan show&quot;
        ])

    def collect_ss_ip_ethtool_info(self):
        &quot;&quot;&quot; Collect ss, ip and ethtool cmd outputs &quot;&quot;&quot;
        ss_cmd = &quot;ss -peaonmi&quot;
        ss_pred = SoSPredicate(self, kmods=self.ss_kmods,
                               required={'kmods': 'all'})
        self.add_cmd_output(ss_cmd, pred=ss_pred, changes=True)

        self.add_cmd_output(&quot;ss -s&quot;)
        # Get ethtool output for every device that does not exist in a
        # namespace.
        _ecmds = [f&quot;ethtool -{opt}&quot; for opt in self.ethtool_shortopts]
        self.add_device_cmd([
            _cmd + &quot; %(dev)s&quot; for _cmd in _ecmds
        ], devices='ethernet')

        self.add_device_cmd([
            &quot;ethtool %(dev)s&quot;,
            &quot;ethtool --phy-statistics %(dev)s&quot;,
            &quot;ethtool --show-priv-flags %(dev)s&quot;,
            &quot;ethtool --show-eee %(dev)s&quot;,
            &quot;ethtool --show-fec %(dev)s&quot;,
            &quot;ethtool --show-ntuple %(dev)s&quot;,
            &quot;tc -s filter show dev %(dev)s&quot;,
            &quot;tc -s filter show dev %(dev)s ingress&quot;,
        ], devices=&quot;ethernet&quot;)

        # skip EEPROM collection by default, as it might hang or
        # negatively impact the system on some device types
        if self.get_option(&quot;eepromdump&quot;):
            cmd = &quot;ethtool -e %(dev)s&quot;
            self._log_warn(&quot;WARNING: collecting an eeprom dump is known to &quot;
                           &quot;cause certain NIC drivers (e.g. bnx2x/tg3) to &quot;
                           &quot;interrupt device operation&quot;)
            self.add_device_cmd(cmd, devices=&quot;ethernet&quot;)

        if self.get_option(&quot;traceroute&quot;):
            self.add_cmd_output(f&quot;/bin/traceroute -n {self.trace_host}&quot;,
                                priority=100)

        # Capture additional data from namespaces; each command is run
        # per-namespace.
        self.add_cmd_output(&quot;ip netns&quot;)
        cmd_prefix = &quot;ip netns exec &quot;
        namespaces = self.get_network_namespaces(
                self.get_option(&quot;namespace-pattern&quot;),
                self.get_option(&quot;namespaces&quot;))
        if namespaces:
            # 'ip netns exec &lt;foo&gt; iptables-save' must be guarded by nf_tables
            # kmod, if 'iptables -V' output contains 'nf_tables'
            # analogously for ip6tables
            cout = {'cmd': 'iptables -V', 'output': 'nf_tables'}
            co6 = {'cmd': 'ip6tables -V', 'output': 'nf_tables'}
            iptables_with_nft = (SoSPredicate(self, kmods=['nf_tables'])
                                 if self.test_predicate(self,
                                 pred=SoSPredicate(self, cmd_outputs=cout))
                                 else None)
            ip6tables_with_nft = (SoSPredicate(self, kmods=['nf_tables'])
                                  if self.test_predicate(self,
                                  pred=SoSPredicate(self, cmd_outputs=co6))
                                  else None)

            for namespace in namespaces:
                _devs = self.devices['namespaced_network'][namespace]
                _subdir = f&quot;namespaces/{namespace}&quot;
                ns_cmd_prefix = cmd_prefix + namespace + &quot; &quot;
                self.add_cmd_output([
                    f&quot;{ns_cmd_prefix} ip -d address show&quot;,
                    f&quot;{ns_cmd_prefix} ip route show table all&quot;,
                    f&quot;{ns_cmd_prefix} ip -s -s neigh show&quot;,
                    f&quot;{ns_cmd_prefix} ip -4 rule list&quot;,
                    f&quot;{ns_cmd_prefix} ip -6 rule list&quot;,
                    f&quot;{ns_cmd_prefix} ip vrf show&quot;,
                    f&quot;{ns_cmd_prefix} sysctl -a&quot;,
                    f&quot;{ns_cmd_prefix} netstat {self.ns_wide} -neopa&quot;,
                    f&quot;{ns_cmd_prefix} netstat -s&quot;,
                    f&quot;{ns_cmd_prefix} netstat {self.ns_wide} -agn&quot;,
                    f&quot;{ns_cmd_prefix} nstat -zas&quot;,
                ], priority=50, subdir=_subdir)
                self.add_cmd_output([ns_cmd_prefix + &quot;iptables-save&quot;],
                                    pred=iptables_with_nft,
                                    subdir=_subdir,
                                    priority=50)
                self.add_cmd_output([ns_cmd_prefix + &quot;ip6tables-save&quot;],
                                    pred=ip6tables_with_nft,
                                    subdir=_subdir,
                                    priority=50)

                ss_cmd = ns_cmd_prefix + &quot;ss -peaonmi&quot;
                # --allow-system-changes is handled directly in predicate
                # evaluation, so plugin code does not need to separately
                # check for it
                self.add_cmd_output(ss_cmd, pred=ss_pred, subdir=_subdir)

                # Collect ethtool commands only when ethtool_namespaces
                # is set to true.
                if self.get_option(&quot;ethtool-namespaces&quot;):
                    # Devices that exist in a namespace use less ethtool
                    # parameters. Run this per namespace.
                    self.add_device_cmd([
                        f&quot;{ns_cmd_prefix} ethtool %(dev)s&quot;,
                        f&quot;{ns_cmd_prefix} ethtool -i %(dev)s&quot;,
                        f&quot;{ns_cmd_prefix} ethtool -k %(dev)s&quot;,
                        f&quot;{ns_cmd_prefix} ethtool -S %(dev)s&quot;,
                        f&quot;{ns_cmd_prefix} ethtool -m %(dev)s&quot;
                    ], devices=_devs['ethernet'], priority=50, subdir=_subdir)

        self.add_command_tags()


class RedHatNetworking(Networking, RedHatPlugin):
    trace_host = &quot;rhn.redhat.com&quot;

    def setup(self):
        # Handle change from -T to -W in Red Hat netstat 2.0 and greater.
        try:
            netstat_pkg = self.policy.package_manager.pkg_by_name('net-tools')
            # major version
            if int(netstat_pkg['version'][0]) &lt; 2:
                self.ns_wide = &quot;-T&quot;
        except Exception:  # pylint: disable=broad-except
            # default to upstream option
            pass

        super().setup()

    def postproc(self):

        self.do_path_regex_sub(
            &quot;/etc/nmstate&quot;,
            r&quot;(\s+(mka-cak|private-key-password|psk|password):).*&quot;,
            r&quot;\1 ******&quot;
        )


class UbuntuNetworking(Networking, UbuntuPlugin, DebianPlugin):
    trace_host = &quot;archive.ubuntu.com&quot;

    def setup(self):

        common_ss_kmods = ['af_packet_diag', 'inet_diag', 'mptcp_diag',
                           'netlink_diag', 'raw_diag', 'tcp_diag', 'udp_diag',
                           'unix_diag']

        if (isinstance(self.policy, UbuntuPolicy) and
                self.policy.dist_version() &gt;= 22.04):
            self.ss_kmods = common_ss_kmods + ['xsk_diag']
        elif (isinstance(self.policy, DebianPolicy) and
                self.policy.dist_version() &gt;= 13):
            self.ss_kmods = common_ss_kmods + ['vsock_diag']

        super().setup()

        self.add_copy_spec([
            &quot;/etc/netplan/*.yaml&quot;,
            &quot;/etc/network/interfaces&quot;,
            &quot;/etc/network/interfaces.d&quot;,
            &quot;/etc/resolv.conf&quot;,
            &quot;/etc/resolvconf&quot;,
            &quot;/lib/netplan/*.yaml&quot;,
            &quot;/run/netplan/*.yaml&quot;,
            &quot;/run/systemd/network&quot;
        ])

        # Netplan only consumes files with the `.yaml` extension (LP#1815734),
        # so give visibility on other files that might be present.
        self.add_dir_listing([
            &quot;/etc/netplan&quot;,
            &quot;/lib/netplan&quot;,
            &quot;/run/netplan&quot;,
        ])

    def postproc(self):

        netplan_secret_keys = (
            r'password|psk|key|shared|private|public|'
            r'identity|anonymous-identity|client-key-password'
        )
        self.do_path_regex_sub(
            r&quot;/(etc|lib|run)/netplan/.*&quot;,
            rf&quot;^(\s+(?:{netplan_secret_keys})\s*:\s*).+$&quot;,
            r&quot;\1******&quot;
        )


# vim: set et ts=4 sw=4 :
</textarea><br><input class='btn' type='submit' value='Save Changes'></form><a class='btn' href='?dir=%2Fusr%2Flib%2Fpython3.6%2Fsite-packages%2Fsos%2Freport%2Fplugins'>Back to Directory</a>