[ { "path": ".gitignore", "content": "*.db\n*.htm\n*.log\n*.old\n*~\n.RData\n\\#*\nold\nTAGS\n*.tgz\n*.ipk\n.gawk*\n" }, { "path": "README.md", "content": "# wrtbwmon\nModified from https://code.google.com/p/wrtbwmon/.\n\n## Testers needed for IPv6 support\nExperimental release: https://github.com/pyrovski/wrtbwmon/releases/tag/0.37_ipv6\n\n## Features\n - \"User\" column has mouseover text containing MAC and IP addresses\n - \"First seen\" and \"Total\" columns in usage table\n - Monitoring of locally generated traffic on a per-interface basis\n - `remove` function to delete `iptables` rules\n\n### What does it do?\n`wrtbwmon` was designed to track bandwidth consumption on home routers. \nIt accomplishes this with `iptables` rules, which means you don't need to run an extra process just to track bandwidth. \n`wrtbwmon` conveniently tracks bandwidth consumption on a per-IP address basis, \nso you can easily determine which user/device is the culprit.\n\nHere is an example usage table:\n![image](example.png)\n\n### How do I use it?\n- Install: Download and install ipk from the [releases page](https://github.com/pyrovski/wrtbwmon/releases/)\n- Setup: `wrtbwmon setup`\n- Update table: `wrtbwmon update /tmp/usage.db` (you can place the data table anywhere)\n- Create html page: `wrtbwmon publish /tmp/usage.db /tmp/usage.htm`\n- Dump table to terminal: `wrtbwmon dump /tmp/usage.db`\n- Remove: `wrtbwmon remove`\n\n### Installation options\n- Install ipk\n - e.g.,: \n - `cd /tmp`\n - HTTPS: `curl -LO https://github.com/pyrovski/wrtbwmon/releases/download/0.36/wrtbwmon_0.36_all.ipk`\n - HTTP: you're on your own :( Busybox wget usually doesn't have SSL support.\n - OpenWrt: `opkg install /tmp/wrtbwmon_0.36_all.ipk`\n- Install deb from [the releases page](https://github.com/pyrovski/wrtbwmon/releases)\n- Or, if you don't want to use an ipk or a deb:\n - `cd /tmp`\n - HTTPS: `curl -L https://github.com/pyrovski/wrtbwmon/archive/0.36.tar.gz | tar xvz`\n - `cd wrtbwmon-0.36`\n - `./install.sh wrtbwmon readDB.awk usage.htm1 usage.htm2 wrtbwmon`\n - Currently, this depends on the `install` program. OpenWrt chose to provide this as the \"coreutils-install\" package.\n- Or, if you have `make`, just `make install` as root after cloning/unpacking.\n\n### Configuring the published table\n- `wrtbwmon` checks a few files for MAC -> name maps:\n - 4th argument to `wrtbwmon publish `\n - `/tmp/dhcp.leases`\n - `/tmp/dnsmasq.conf`\n - `/etc/dnsmasq.conf`\n - `/etc/hosts`\n- If all of the above do not yield a match, the script will optionally perform a reverse DNS lookup directed at the DNS server specified in the `DNS` variable. If `DNS` is blank or unset, the script will not perform such lookups.\n\n### Regular updates\n- Add the following to root's crontab:\n\n # adapt PATH to your needs\n PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin\n\t\n * * * * * \n

Total Usage:

\n\n\n\n\n\n\n\n\n\n
UserDownloadUploadTotalFirst seenLast seen
\n
This page was generated on (date)\n\n" }, { "path": "wrtbwmon", "content": "#!/bin/sh\n#\n# wrtbwmon: traffic logging tool for routers\n#\n# Peter Bailey (peter.eldridge.bailey+wrtbwmon AT gmail.com)\n#\n# Based on work by:\n# Emmanuel Brucy (e.brucy AT qut.edu.au)\n# Fredrik Erlandsson (erlis AT linux.nu)\n# twist - http://wiki.openwrt.org/RrdTrafficWatch\n\ntrap \"rm -f /tmp/*_$$.tmp; kill $$\" INT\nbinDir=/usr/sbin\ndataDir=/usr/share/wrtbwmon\nlockDir=/tmp/wrtbwmon.lock\npidFile=$lockDir/pid\nnetworkFuncs=/lib/functions/network.sh\nuci=`which uci 2>/dev/null`\nnslookup=`which nslookup 2>/dev/null`\nnvram=`which nvram 2>/dev/null`\n\nchains='INPUT OUTPUT FORWARD'\nDEBUG=\ninterfaces='eth0 tun0' # in addition to detected WAN\nDB=$2\nmode=\n\n# DNS server for reverse lookups provided in \"DNS\".\n# don't perform reverse DNS lookups by default\nDO_RDNS=${DNS-}\n\nheader=\"#mac,ip,iface,in,out,total,first_date,last_date\"\n\ncreateDbIfMissing()\n{\n [ ! -f \"$DB\" ] && echo $header > \"$DB\"\n}\n\ncheckDbArg()\n{\n [ -z \"$DB\" ] && echo \"ERROR: Missing argument 2 (database file)\" && exit 1\n}\n\ncheckDB()\n{\n [ ! -f \"$DB\" ] && echo \"ERROR: $DB does not exist\" && exit 1\n [ ! -w \"$DB\" ] && echo \"ERROR: $DB is not writable\" && exit 1 \n}\n\ncheckWAN()\n{\n [ -z \"$wan\" ] && echo \"Warning: failed to detect WAN interface.\"\n}\n\nlookup()\n{\n MAC=$1\n IP=$2\n userDB=$3\n for USERSFILE in $userDB /tmp/dhcp.leases /tmp/dnsmasq.conf /etc/dnsmasq.conf /etc/hosts; do\n\t[ -e \"$USERSFILE\" ] || continue\n\tcase $USERSFILE in\n\t /tmp/dhcp.leases )\n\t\tUSER=$(grep -i \"$MAC\" $USERSFILE | cut -f4 -s -d' ')\n\t\t;;\n\t /etc/hosts )\n\t\tUSER=$(grep \"^$IP \" $USERSFILE | cut -f2 -s -d' ')\n\t\t;;\n\t * )\n\t\tUSER=$(grep -i \"$MAC\" \"$USERSFILE\" | cut -f2 -s -d,)\n\t\t;;\n\tesac\n\t[ \"$USER\" = \"*\" ] && USER=\n\t[ -n \"$USER\" ] && break\n done\n if [ -n \"$DO_RDNS\" -a -z \"$USER\" -a \"$IP\" != \"NA\" -a -n \"$nslookup\" ]; then\n\tUSER=`$nslookup $IP $DNS | awk '!/server can/{if($4){print $4; exit}}' | sed -re 's/[.]$//'`\n fi\n [ -z \"$USER\" ] && USER=${MAC}\n echo $USER\n}\n\ndetectIF()\n{\n if [ -f \"$networkFuncs\" ]; then\n\tIF=`. $networkFuncs; network_get_device netdev $1; echo $netdev`\n\t[ -n \"$IF\" ] && echo $IF && return\n fi\n\n if [ -n \"$uci\" -a -x \"$uci\" ]; then\n\tIF=`$uci get network.${1}.ifname 2>/dev/null`\n\t[ $? -eq 0 -a -n \"$IF\" ] && echo $IF && return\n fi\n\n if [ -n \"$nvram\" -a -x \"$nvram\" ]; then\n\tIF=`$nvram get ${1}_ifname 2>/dev/null`\n\t[ $? -eq 0 -a -n \"$IF\" ] && echo $IF && return\n fi\n}\n\ndetectLAN()\n{\n [ -e /sys/class/net/br-lan ] && echo br-lan && return\n lan=$(detectIF lan)\n [ -n \"$lan\" ] && echo $lan && return\n}\n\ndetectWAN()\n{\n [ -n \"$WAN_IF\" ] && echo $WAN_IF && return\n wan=$(detectIF wan)\n [ -n \"$wan\" ] && echo $wan && return\n wan=$(ip route show 2>/dev/null | grep default | sed -re '/^default/ s/default.*dev +([^ ]+).*/\\1/')\n [ -n \"$wan\" ] && echo $wan && return\n [ -f \"$networkFuncs\" ] && wan=$(. $networkFuncs; network_find_wan wan; echo $wan)\n [ -n \"$wan\" ] && echo $wan && return\n}\n\nlock()\n{\n attempts=0\n while [ $attempts -lt 10 ]; do\n\tmkdir $lockDir 2>/dev/null && break\n\tattempts=$((attempts+1))\n\tpid=`cat $pidFile 2>/dev/null`\n\tif [ -n \"$pid\" ]; then\n\t if [ -d \"/proc/$pid\" ]; then\n\t\t[ -n \"$DEBUG\" ] && echo \"WARNING: Lockfile detected but process $(cat $pidFile) does not exist !\"\n\t\trm -rf $lockDir\n\t else\n\t\tsleep 1\n\t fi\n\tfi\n done\n mkdir $lockDir 2>/dev/null\n echo $$ > $pidFile\n [ -n \"$DEBUG\" ] && echo $$ \"got lock after $attempts attempts\"\n trap '' INT\n}\n\nunlock()\n{\n rm -rf $lockDir\n [ -n \"$DEBUG\" ] && echo $$ \"released lock\"\n trap \"rm -f /tmp/*_$$.tmp; kill $$\" INT\n}\n\n# chain\nnewChain()\n{\n chain=$1\n # Create the RRDIPT_$chain chain (it doesn't matter if it already exists).\n iptables -t mangle -N RRDIPT_$chain 2> /dev/null\n \n # Add the RRDIPT_$chain CHAIN to the $chain chain if not present\n iptables -t mangle -C $chain -j RRDIPT_$chain 2>/dev/null\n if [ $? -ne 0 ]; then\n\t[ -n \"$DEBUG\" ] && echo \"DEBUG: iptables chain misplaced, recreating it...\"\n\tiptables -t mangle -I $chain -j RRDIPT_$chain\n fi\n}\n\n# chain tun\nnewRuleIF()\n{\n chain=$1\n IF=$2\n \n #!@todo test\n if [ \"$chain\" = \"OUTPUT\" ]; then\n\tcmd=\"iptables -t mangle -o $IF -j RETURN\"\n\teval $cmd \" -C RRDIPT_$chain 2>/dev/null\" || eval $cmd \" -A RRDIPT_$chain\"\n elif [ \"$chain\" = \"INPUT\" ]; then\n\tcmd=\"iptables -t mangle -i $IF -j RETURN\"\n\teval $cmd \" -C RRDIPT_$chain 2>/dev/null\" || eval $cmd \" -A RRDIPT_$chain\"\n fi\n}\n\nupdate()\n{\n #!@todo could let readDB.awk handle this; that would place header\n #!info in fewer places\n createDbIfMissing\n \n checkDB\n checkWAN\n\n > /tmp/iptables_$$.tmp\n lock\n # only zero our own chains\n for chain in $chains; do\n\tiptables -nvxL RRDIPT_$chain -t mangle -Z >> /tmp/iptables_$$.tmp\n done\n # the iptables and readDB commands have to be separate. Otherwise,\n # they will fight over iptables locks\n awk -v mode=\"$mode\" -v interfaces=\\\"\"$interfaces\"\\\" -f $binDir/readDB.awk \\\n\t$DB \\\n\t/proc/net/arp \\\n\t/tmp/iptables_$$.tmp\n unlock\n}\n\n############################################################\n\ncase $1 in\n \"dump\" )\n\tcheckDbArg\n\tlock\n\ttr ',' '\\t' < \"$DB\"\n\tunlock\n ;;\n\n \"update\" )\n\tcheckDbArg\n\twan=$(detectWAN)\n\tinterfaces=\"$interfaces $wan\"\n\tupdate\n\trm -f /tmp/*_$$.tmp\n\texit\n\t;;\n\n \"publish\" )\n\tcheckDbArg\n\t[ -z \"$3\" ] && echo \"ERROR: Missing argument 3 (output html file)\" && exit 1\n\t\n\t# sort DB\n\tlock\n\n\t# busybox sort truncates numbers to 32 bits\n\tgrep -v '^#' $DB | awk -F, '{OFS=\",\"; a=sprintf(\"%f\",$4/1e6); $4=\"\"; print a,$0}' | tr -s ',' | sort -rn | awk -F, '{OFS=\",\";$1=sprintf(\"%f\",$1*1e6);print}' > /tmp/sorted_$$.tmp\n\n # create HTML page\n\trm -f $3.tmp\n\tcp $dataDir/usage.htm1 $3.tmp\n\n\t#!@todo fix publishing\n\twhile IFS=, read PEAKUSAGE_IN MAC IP IFACE PEAKUSAGE_OUT TOTAL FIRSTSEEN LASTSEEN\n\tdo\n\t echo \"\nnew Array(\\\"$(lookup $MAC $IP $4)\\\",\\\"$MAC\\\",\\\"$IP\\\",\n$PEAKUSAGE_IN,$PEAKUSAGE_OUT,$TOTAL,\\\"$FIRSTSEEN\\\",\\\"$LASTSEEN\\\"),\" >> $3.tmp\n\tdone < /tmp/sorted_$$.tmp\n\techo \"0);\" >> $3.tmp\n\t\n\tsed \"s/(date)/`date`/\" < $dataDir/usage.htm2 >> $3.tmp\n\tmv $3.tmp $3\n\n\tunlock\n\t\n\t#Free some memory\n\trm -f /tmp/*_$$.tmp\n\t;;\n \n \"setup\" )\n\tcheckDbArg\n\t[ -w \"$DB\" ] && echo \"Warning: using existing $DB\"\n\tcreateDbIfMissing\n\t\n\tfor chain in $chains; do\n\t newChain $chain\n\tdone\n\n\t#lan=$(detectLAN)\n\twan=$(detectWAN)\n\tcheckWAN\n\tinterfaces=\"$interfaces $wan\"\n\n\t# track local data\n\tfor chain in INPUT OUTPUT; do\n\t for interface in $interfaces; do\n\t\t[ -n \"$interface\" ] && [ -e \"/sys/class/net/$interface\" ] && newRuleIF $chain $interface\n\t done\n\tdone\n\n\t# this will add rules for hosts in arp table\n\tupdate\n\n\trm -f /tmp/*_$$.tmp\n\t;;\n\n \"remove\" )\n\tiptables-save | grep -v RRDIPT | iptables-restore\n\trm -rf \"$lockDir\"\n\t;;\n\n *)\n\techo \\\n\"Usage: $0 {setup|update|publish|remove} [options...]\nOptions:\n $0 setup database_file\n $0 update database_file\n $0 publish database_file path_of_html_report [user_file]\nExamples:\n $0 setup /tmp/usage.db\n $0 update /tmp/usage.db\n $0 publish /tmp/usage.db /www/user/usage.htm /jffs/users.txt\n $0 remove\nNote: [user_file] is an optional file to match users with MAC addresses.\n Its format is \\\"00:MA:CA:DD:RE:SS,username\\\", with one entry per line.\"\n\t;;\nesac\n" } ]