zsh: add netsniff-ng zsh auto completion support

Hideo Hattori wrote a set of auto completion scripts for zsh that
support netsniff-ng tools. Big thanks for that! Follow-up commits
still need to address updated command-line options.

Signed-off-by: Hideo Hattori <hhatto.jp@gmail.com>
Signed-off-by: Daniel Borkmann <dborkman@redhat.com>

8 files changed, 279 insertions, 0 deletions

diff --git a/AUTHORS b/AUTHORS
index 2dd2697..acd765d 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -14,6 +14,7 @@ Major contributors (> 30 commits):
 
 Minor contributors (<= 30 commits):
 
+ * Hideo Hattori <hhatto.jp@gmail.com>
  * Peter Stuge <peter@stuge.se>
  * Scott Moeller <electronjoe@gmail.com>
  * Jesper Dangaard Brouer <brouer@redhat.com>
diff --git a/astraceroute.zsh b/astraceroute.zsh
new file mode 100644
index 0000000..28fa24a
--- /dev/null
+++ b/astraceroute.zsh
@@ -0,0 +1,50 @@
+#compdef astraceroute
+#
+# astraceroute.zsh -- zsh completion function for astraceroute
+#
+# Copyright (C) 2013 Hideo Hattori <hhatto.jp@gmail.com>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 as
+# published by the Free Software Foundation.
+
+typeset -A opt_args
+
+_interfaces () {
+    _wanted interfaces expl 'network interface' \
+    _net_interfaces
+    _values "Pseudo-device that captures on all interfaces" "any"
+}
+
+_arguments -s -S \
+    "(-H --host)"{-H,--host}"[Host/IPv4/IPv6 to lookup AS route to]:host:_hosts" \
+    "(-p --port)"{-p,--port}"[Hosts port to lookup AS route to]:port:_gnu_generic" \
+    "(-i -d --dev)"{-i,-d,--dev}"[Networking device i.e., eth0]:device:_interfaces" \
+    "(-4 --ipv4)"{-4,--ipv4}"[Use IPv4 requests (default)]" \
+    "(-6 --ipv6)"{-6,--ipv6}"[Use IPv6 requests]" \
+    "(-n --numeric)"{-n,--nemeric}"[Do not do reverse DNS lookup for hops]" \
+    "(-N --dns)"{-N,--dns}"[Do a reverse DNS lookup for hops]" \
+    "(-f --init-ttl)"{-f,--init-ttl}"[Set initial TTL]:ttl:_gnu_generic" \
+    "(-m --max-ttl)"{-m,--max--ttl}"[Set maximum TTL]:ttl:_gnu_generic" \
+    "(-q --num-probes)"{-q,--num-probes}"[Set maximum TTL (default: 30)]:ttl:_gnu_generic" \
+    "(-q --num-probes)"{-q,--num-probes}"[Number of max probes for each hop (default: 3)]:num:_gnu_generic" \
+    "(-x --timeout)"{-x,--timeout}"[Probe response timeout in sec (default: 3)]:timeout:_gnu_generic" \
+    "(-S --syn)"{-S,--syn}"[Set TCP SYN flag in packets]" \
+    "(-A --ack)"{-A,--ack}"[Set TCP ACK flag in packets]" \
+    "(-F --fin)"{-F,--fin}"[Set TCP FIN flag in packets]" \
+    "(-P --psh)"{-P,--psh}"[Set TCP PSH flag in packets]" \
+    "(-U --urg)"{-U,--urg}"[Set TCP URG flag in packets]" \
+    "(-R --rst)"{-R,--rst}"[Set TCP RST flag in packets]" \
+    "(-E --ecn-syn)"{-E,--ecn-syn}"[Send ECN SYN packets (RFC3168)]" \
+    "(-t --tos)"{-t,--tos}"[Set the IP TOS field]:tos:_gnu_generic" \
+    "(-G --nofrag)"{-G,--nofrag}"[Set do not fragment bit]" \
+    "(-X --payload)"{-X,--payload}"[Specify a payload string to test DPIs]:string:_gnu_generic" \
+    "(-Z --show-packet)"{-Z,--show-packet}"[Show returned packet on each hop]" \
+    "(-l --totlen)"{-l,--totlen}"[Specify total packet len]:lengths:_gnu_generic" \
+    "(-w --whois)"{-w,--whois}"[Use a different AS whois DB server (default: /etc/netsniff-ng/whois.conf)]:file:_files" \
+    "(-W --wport)"{-W,--wport}"[Use a different port to AS whois server (default: /etc/netsniff-ng/whois.conf)]:file:_files" \
+    "--city-db[Specifiy path for geoip city database]:path:_files" \
+    "--country-db[Specifiy path for geoip country database]:path:_files" \
+    {-v,--version}"[Print version]:" \
+    {-h,--help}"[Print this help]:" \
+    "*::args:_gnu_generic"
diff --git a/bpfc.zsh b/bpfc.zsh
new file mode 100644
index 0000000..ae6eb39
--- /dev/null
+++ b/bpfc.zsh
@@ -0,0 +1,18 @@
+#compdef bpfc
+#
+# bpfc.zsh --  zsh completion function for bpfc
+#
+# Copyright (C) 2013 Hideo Hattori <hhatto.jp@gmail.com>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 as
+# published by the Free Software Foundation.
+
+typeset -A opt_args
+
+_arguments -s -S \
+    "(-i --input)"{-i,--input}"[Berkeley Packet Filter file]:input:_files" \
+    "(-V --verbose)"{-V,--verbose}"[Be more verbose]" \
+    {-v,--version}"[Print version]:" \
+    {-h,--help}"[Print this help]:" \
+    "*::args:_gnu_generic"
diff --git a/curvetun.zsh b/curvetun.zsh
new file mode 100644
index 0000000..16a1fd3
--- /dev/null
+++ b/curvetun.zsh
@@ -0,0 +1,36 @@
+#compdef curvetun
+#
+# curvetun.zsh -- zsh completion function for curvetun
+#
+# Copyright (C) 2013 Hideo Hattori <hhatto.jp@gmail.com>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 as
+# published by the Free Software Foundation.
+
+typeset -A opt_args
+
+_interfaces () {
+    _wanted interfaces expl 'network interface' \
+    _net_interfaces
+    _values "Pseudo-device that captures on all interfaces" "any"
+}
+
+_arguments -s -S \
+    "(-k --keygen)"{-k,--keygen}"[Generate public/private keypair]" \
+    "(-x --export)"{-x,--export}"[Export your public data for remote servers]" \
+    "(-C --dumpc)"{-C,--dumpc}"[Dump parsed clients]" \
+    "(-S --dumps)"{-S,--dumps}"[Dump parsed servers]" \
+    "(-D --nofork)"{-D,--nofork}"[Do not daemonize]" \
+    "(-d --dev)"{-d,--dev}"[Networking tunnel device, e.g. tun0]:device:_interfaces" \
+    {-v,--version}"[Print version]:" \
+    {-h,--help}"[Print this help]:" \
+    "(-s --server -N --no-logging -p --port -t --stun -u --udp -4 --ipv4 -6 --ipv6 -c --client)"{-c,--client}"[Client mode, server alias optional]:client:_gnu_generic" \
+    "(-c --client -s --server)"{-s,--server}"[Server mode]" \
+    "(-c --client -N --no-logging)"{-N,--no-logging}"[Disable server logging (for better anonymity)]" \
+    "(-c --client -p --port)"{-p,--port}"[Port number (mandatory)]:port:_gnu_generic" \
+    "(-c --client -t --stun)"{-t,--stun}"[Show public IP/Port mapping via STUN]:stun:_gnu_generic" \
+    "(-c --client -u --udp)"{-u,--udp}"[Use UDP as carrier instead of TCP]" \
+    "(-c --client -4 --ipv4)"{-4,--ipv4}"[Tunnel devices are IPv4]" \
+    "(-c --client -6 --ipv6)"{-6,--ipv6}"[Tunnel devices are IPv6 (default: same as carrier protocol)]" \
+    "*::args:_gnu_generic"
diff --git a/flowtop.zsh b/flowtop.zsh
new file mode 100644
index 0000000..1d1b2e7
--- /dev/null
+++ b/flowtop.zsh
@@ -0,0 +1,21 @@
+#compdef flowtop
+#
+# flowtop.zsh -- zsh completion function for flowtop
+#
+# Copyright (C) 2013 Hideo Hattori <hhatto.jp@gmail.com>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 as
+# published by the Free Software Foundation.
+
+typeset -A opt_args
+
+_arguments -s -S \
+    "(-T --tcp)"{-T,--tcp}"[Show only TCP flows (default)]" \
+    "(-U --udp)"{-U,--udp}"[Show only UDP flows]" \
+    "(-s --show-src)"{-s,--show-src}"[Also show source, not only dest]" \
+    "--city-db[Specifiy path for geoip city database]:path:_files" \
+    "--country-db[Specifiy path for geoip country database]:path:_files" \
+    {-v,--version}"[Print version]:" \
+    {-h,--help}"[Print this help]:" \
+    "*::args:_gnu_generic"
diff --git a/ifpps.zsh b/ifpps.zsh
new file mode 100644
index 0000000..a4a4a5d
--- /dev/null
+++ b/ifpps.zsh
@@ -0,0 +1,29 @@
+#compdef ifpps
+#
+# ifpps.zsh -- zsh completion function for ifpps
+#
+# Copyright (C) 2013 Hideo Hattori <hhatto.jp@gmail.com>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 as
+# published by the Free Software Foundation.
+
+typeset -A opt_args
+
+_interfaces () {
+    _wanted interfaces expl 'network interface' \
+    _net_interfaces
+    _values "Pseudo-device that captures on all interfaces" "any"
+}
+
+_arguments -s -S \
+    "(-d --dev)"{-d,--dev}"[Device to fetch statistics for i.e., eth0]:device:_interfaces" \
+    "(-p --promisc)"{-p,--promisc}"[Promiscuous mode]" \
+    "(-t --interval)"{-t,--interval}"[Refresh time in sec (default 1 s)]:interval:_gnu_generic" \
+    "(-c --term)"{-c,--term}"[Output to terminal]" \
+    "(-C --csv)"{-C,--csv}"[Output to terminal as CSV  E.g. post-processing with Gnuplot et al.]" \
+    "(-H --csv-tablehead)"{-H,--csv-tablehead}"[Print CSV table head]" \
+    "(-l --loop)"{-l,--loop}"[Loop terminal output]" \
+    {-v,--version}"[Print version]:" \
+    {-h,--help}"[Print this help]:" \
+    "*::args:_gnu_generic"
diff --git a/netsniff-ng.zsh b/netsniff-ng.zsh
new file mode 100644
index 0000000..122d661
--- /dev/null
+++ b/netsniff-ng.zsh
@@ -0,0 +1,69 @@
+#compdef netsniff-ng
+#
+# netsniff-ng.zsh -- zsh completion function for netsniff-ng
+#
+# Copyright (C) 2013 Hideo Hattori <hhatto.jp@gmail.com>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 as
+# published by the Free Software Foundation.
+
+typeset -A opt_args
+local context state line
+
+_cpu () {
+    _cpus=(${${(f)"$(grep processor /proc/cpuinfo | awk '{print $3}')"}})
+    compadd -a _cpus
+}
+
+_user_info () {
+    user_info=(${${(f)"$(awk -F':' '{print $3":"$1}' /etc/passwd)"}})
+    _describe -t usr "user info" user_info && ret=0
+}
+
+_group_info () {
+    group_info=(${${(f)"$(awk -F':' '{print $4":"$1}' /etc/passwd)"}})
+    _describe -t usr "group info" group_info && ret=0
+}
+
+_interfaces () {
+    _wanted interfaces expl 'network interface' \
+    _net_interfaces
+    _values "Pseudo-device that captures on all interfaces" "any"
+}
+
+_arguments -s -S \
+    "(-i -d --dev --in)"{-i,-d,--dev,--in}"[Input source as netdev, pcap or pcap stdin]:input:_interfaces" \
+    "(-o --out)"{-o,--out}"[Output sink as netdev, pcap, directory, trafgen, or stdout]::_gnu_generic" \
+    "(-f --filter)"{-f,--filter}"[Use BPF filter file from bpfc or tcpdump-like expression]" \
+    "(-t --type)"{-t,--type}"[Filter type]:filter:(host broadcast multicast others outgoing)" \
+    "(-F --interval)"{-F,--interval}"[Dump interval if -o is a dir: <num>KiB/MiB/GiB/s/sec/min/hrs]:interval:_gnu_generic" \
+    "(-J --jumbo-support)"{-J,--jumbo-support}"[Support for 64KB Super Jumbo Frames (def: 2048B)]" \
+    "(-R --rfraw)"{-R,--rfraw}"[Capture or inject raw 802.11 frames]" \
+    "(-n --num)"{-n,--num}"[Number of packets until exit (def: 0)]" \
+    "(-P --prefix)"{-P,--prefix}"[Prefix for pcaps stored in directory]" \
+    "(-T --magic)"{-T,--magic}"[Pcap magic number/pcap format to store, see -D]" \
+    "(-D --dump-pcap-types)"{-D,--dump-pcap-types}"[Dump pcap types and magic numbers and quit]" \
+    "(-B --dump-bpf)"{-B,--dump-bpf}"[Dump generated BPF assembly]" \
+    "(-r --rand)"{-r,--rand}"[Randomize packet forwarding order (dev->dev)]" \
+    "(-M --no-promisc)"{-M,--no-promisc}"[No promiscuous mode for netdev]" \
+    "(-A --no-sock-mem)"{-A,--no-sock-mem}"[Don\'t tune core socket memory]" \
+    "(-m --mmap)"{-m,--mmap}"[Mmap(2) pcap file i.e., for replaying pcaps]" \
+    "(-G --sg)"{-G,--sg}"[Scatter/gather pcap file I/O]" \
+    "(-c --clrw)"{-c,--clrw}"[Use slower read(2)/write(2) I/O]" \
+    "(-S --ring-size)"{-S,--ring-size}"[Specify ring size to: <num>KiB/MiB/GiB]:ringsize:" \
+    "(-k --kernel-pull)"{-k,--kernel-pull}"[Kernel pull from user interval in us (def: 10us)]:kernelpull:_gnu_generic" \
+    "(-b --bind-cpu)"{-b,--bind-cpu}"[Bind to specific CPU]:cpunum:_cpu" \
+    "(-u --user)"{-u,--user}"[Drop privileges and change to userid]:user:_user_info" \
+    "(-g --group)"{-g,--group}"[Drop privileges and change to groupid]:group:_group_info" \
+    "(-H --prio-high)"{-H,--prio-high}"[Make this high priority process]" \
+    "(-Q --notouch-irq)"{-Q,--notouch-irq}"[Do not touch IRQ CPU affinity of NIC]" \
+    "(-s --silent)"{-s,--silent}"[Do not print captured packets]" \
+    "(-q --less)"{-q,--less}"[Print less-verbose packet information]" \
+    "(-X --hex)"{-X,--hex}"[Print packet data in hex format]" \
+    "(-l --ascii)"{-l,--ascii}"[Print human-readable packet data]" \
+    "(-U --update)"{-U,--update}"[Update GeoIP databases]" \
+    "(-V --verbose)"{-V,--verbose}"[Be more verbose]" \
+    {-v,--version}"[Show version]:" \
+    {-h,--help}"[Guess what?!]:" \
+    "*::args:_gnu_generic"
diff --git a/trafgen.zsh b/trafgen.zsh
new file mode 100644
index 0000000..4a4fdde
--- /dev/null
+++ b/trafgen.zsh
@@ -0,0 +1,55 @@
+#compdef trafgen
+#
+# trafgen.zsh -- zsh completion function for trafgen
+#
+# Copyright (C) 2013 Hideo Hattori <hhatto.jp@gmail.com>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 as
+# published by the Free Software Foundation.
+
+typeset -A opt_args
+local context state line
+
+_cpu () {
+    _cpus=(${${(f)"$(grep processor /proc/cpuinfo | awk '{print $3}')"}})
+    compadd -a _cpus
+}
+
+_user_info () {
+    user_info=(${${(f)"$(awk -F':' '{print $3":"$1}' /etc/passwd)"}})
+    _describe -t usr "user info" user_info && ret=0
+}
+
+_group_info () {
+    group_info=(${${(f)"$(awk -F':' '{print $4":"$1}' /etc/passwd)"}})
+    _describe -t usr "group info" group_info && ret=0
+}
+
+_interfaces () {
+    _wanted interfaces expl 'network interface' \
+    _net_interfaces
+    _values "Pseudo-device that captures on all interfaces" "any"
+}
+
+_arguments -s -S \
+    "(-i -c --in --conf)"{-i,-c,--in,--conf}"[Packet configuration file/stdin]:input:_files" \
+    "(-o -d --out --dev)"{-o,-d,--out,--dev}"[Networking device i.e., eth0]:device:_interfaces" \
+    "(-p --cpp)"{-p,--cpp}"[Run packet config through C preprocessor]" \
+    "(-J --jumbo-support)"{-J,--jumbo-support}"[Support 64KB super jumbo frames (def: 2048B)]" \
+    "(-R --rfraw)"{-R,--rfraw}"[Inject raw 802.11 frames]" \
+    "(-s --smoke-test)"{-s,--smoke-test}"[Probe if machine survived fuzz-tested packet]" \
+    "(-n --num)"{-n,--num}"[Number of packets until exit (def: 0)]" \
+    "(-r --rand)"{-r,--rand}"[Randomize packet selection (def: round robin)]" \
+    "(-P --cpus)"{-P,--cpus}"[Specify number of forks(<= CPUs) (def: #CPUs)]:cpunum:_cpu" \
+    "(-t --gap)"{-t,--gap}"[Interpacket gap in us (approx)]" \
+    "(-S --ring-size)"{-S,--ring-size}"[Manually set mmap size (KiB/MiB/GiB)]:ringsize:" \
+    "(-k --kernel-pull)"{-k,--kernel-pull}"[Kernel pull from user interval in us (def: 10us)]:kernelpull:_gnu_generic" \
+    "(-E --seed)"{-E,--seed}"[Manually set srand(3) seed]" \
+    "(-u --user)"{-u,--user}"[Drop privileges and change to userid]:user:_user_info" \
+    "(-g --group)"{-g,--group}"[Drop privileges and change to groupid]:group:_group_info" \
+    "(-e --example)"{-e,--example}"[Show built-in packet config example]:" \
+    "(-V --verbose)"{-V,--verbose}"[Be more verbose]" \
+    {-v,--version}"[Show version]:" \
+    {-h,--help}"[Guess what?!]:" \
+    "*::args:_gnu_generic"