core/src/opnsense/scripts/interfaces/traffic_top.py

#!/usr/local/bin/python3

"""
    Copyright (c) 2020 Ad Schellevis <ad@opnsense.org>
    All rights reserved.

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions are met:

    1. Redistributions of source code must retain the above copyright notice,
     this list of conditions and the following disclaimer.

    2. Redistributions in binary form must reproduce the above copyright
     notice, this list of conditions and the following disclaimer in the
     documentation and/or other materials provided with the distribution.

    THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
    INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
    AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
    AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
    OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    POSSIBILITY OF SUCH DAMAGE.

"""
import argparse
import decimal
import subprocess
import os
import sys
import math
import ujson
import netaddr
from concurrent.futures import ThreadPoolExecutor
from netaddr import IPNetwork, IPAddress, AddrFormatError


def iftop(interface, target):
    try:
        sp = subprocess.run(
            ['/usr/local/sbin/iftop', '-nNb', '-i', interface, '-s', '2', '-t'],
            capture_output=True, text=True, timeout=10
        )
        target[interface] = sp.stdout
    except subprocess.TimeoutExpired:
        target[interface] = None

def local_addresses():
    result = []
    sp = subprocess.run(['/sbin/ifconfig'], capture_output=True, text=True)
    for line in sp.stdout.split('\n'):
        if line.find('\tinet') > -1:
            try:
                ip = IPAddress(line.split()[1].split('%')[0])
            except AddrFormatError:
                ip = None

            if ip and not ip.is_loopback() and not ip.is_link_local():
                result.append(ip)
    return result

def from_bformat(value):
    value = value.lower()
    if value.endswith('kb'):
        return decimal.Decimal(value[:-2]) * 1000
    elif value.endswith('mb'):
        return decimal.Decimal(value[:-2]) * 1000000
    elif value.endswith('gb'):
        return decimal.Decimal(value[:-2]) * 1000000000
    elif value.endswith('b') and value[:-1].isdigit():
        return decimal.Decimal(value[:-1])
    return 0

def to_bformat(value):
    fileSizeTypes = ["b", "kb", "mb", "gb", "tb", "pb", "eb", "zb", "yb"]
    ndx = math.floor(math.log(value) / math.log(1000)) if value > 0 else 0
    return  "%s %s" % (round(value / math.pow(1000, ndx), 2), fileSizeTypes[ndx])


if __name__ == '__main__':
    result = dict()
    parser = argparse.ArgumentParser()
    parser.add_argument('--interfaces', help='interface(s) to sample')
    cmd_args = parser.parse_args()
    all_local_addresses = local_addresses()
    interfaces = cmd_args.interfaces.split(',')
    iftop_data = dict()
    with ThreadPoolExecutor(max_workers=len(interfaces)) as executor:
        for intf in interfaces:
            executor.submit(iftop, intf.strip(), iftop_data)

    for intf in iftop_data:
        agg_results = dict()
        result[intf] = {'records' : []}
        if iftop_data[intf] is None:
            result[intf]['status'] = 'timeout'
            continue
        else:
            result[intf]['status'] = 'ok'

        other_end = None
        for line in iftop_data[intf].split('\n'):
            if line.find('=>') > -1 or line.find('<=') > -1:
                parts = line.split()
                if parts[0].find('.') == -1 and parts[0].find(':') == -1:
                    parts.pop(0)
                item = {
                    'address': parts[0],
                    'rate': parts[2],
                    'rate_bits': int(from_bformat(parts[2])),
                    'cumulative': parts[5],
                    'cumulative_bytes': int(from_bformat(parts[5])),
                    'tags': []
                }
                # attach tags (type of address)
                try:
                    ip = IPAddress(parts[0])
                    if ip in all_local_addresses:
                        item['tags'].append('local')
                    if ip.is_private():
                        item['tags'].append('private')
                except subprocess.TimeoutExpired:
                    pass

                if line.find('=>') > -1:
                    other_end = item
                elif other_end is not None:
                    if item['address'] not in agg_results:
                        agg_results[item['address']] = {
                            'address': item['address'],
                            'rate_bits_in': 0,
                            'rate_bits_out': 0,
                            'rate_bits': 0,
                            'cumulative_bytes_in': 0,
                            'cumulative_bytes_out': 0,
                            'cumulative_bytes': 0,
                            'tags': item['tags'],
                            'details': []
                        }
                    agg_results[item['address']]['rate_bits_out'] += item['rate_bits']
                    agg_results[item['address']]['rate_bits_in'] += other_end['rate_bits']
                    agg_results[item['address']]['rate_bits'] += (item['rate_bits'] + other_end['rate_bits'])
                    agg_results[item['address']]['cumulative_bytes_out'] += item['cumulative_bytes']
                    agg_results[item['address']]['cumulative_bytes_in'] += other_end['cumulative_bytes']
                    agg_results[item['address']]['cumulative_bytes'] += (
                        item['cumulative_bytes'] + other_end['cumulative_bytes']
                    )
                    agg_results[item['address']]['details'].append(other_end)

        # XXX: sort output, limit output results to max 200 (safety precaution)
        top_hosts = sorted(agg_results.values(), key=lambda x: x['rate_bits'], reverse=True)[:200]
        for host in top_hosts:
            host['rate_in'] = to_bformat(host['rate_bits_in'])
            host['rate_out'] = to_bformat(host['rate_bits_out'])
            host['rate'] = to_bformat(host['rate_bits'])
            host['cumulative_in'] = to_bformat(host['cumulative_bytes_in'])
            host['cumulative_out'] = to_bformat(host['cumulative_bytes_out'])
            host['cumulative'] = to_bformat(host['cumulative_bytes'])
            result[intf]['records'].append(host)

    print(ujson.dumps(result))