nojhan/tunnelmon
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Compare commits

base: nojhan:master
Branches Tags
nojhan:master
nojhan:v1.1
nojhan:v1.1-beta
nojhan:v1.0
..
compare: nojhan:v1.1
Branches Tags
nojhan:master
nojhan:v1.1
nojhan:v1.1-beta
nojhan:v1.0

No commits in common. "master" and "v1.1" have entirely different histories.
master ... v1.1

2 changed files with 39 additions and 72 deletions
Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -5,12 +5,12 @@ tunnelmon -- Monitor and manage autoSSH tunnels
`tunnelmon` [-h] `tunnelmon` [-h]
`tunnelmon` [-c] [-n] [-u] [-l LEVEL] [-g FILE] [-s] `tunnelmon` [-c] [-n] [-u] [-l LEVEL] [-g FILE]
## DESCRIPTION ## DESCRIPTION
`tunnelmon` is an autossh tunnel monitor. It gives a user interface to monitor existing SSH tunnel, and tunnels managed with autossh. `tunnelmon` is an autossh tunnel monitor. It gives a user interface to monitor existing SSH tunnel, and tunnels managed with autossh.
It can print the current state of your tunnels or display them in an interactive text-based interface. It can print the current state of your tunnels or display them in an interactive text-based interface.
@ -22,10 +22,8 @@ It can print the current state of your tunnels or display them in an interactive
## INSTALLATION ## INSTALLATION
`tunnelmon` targets Linux operating systems, and depends on: `tunnelmon` targets Linux operating systems, and depends on:
* `openssh-client`, * `openssh-client`
* `python` version 3.8 at least, you may also need to install the following python modules (for example via `pip`, but you may use any other package management system going along with your installation): * `python` version 3.8 at least.
* `psutils`
* `curses`
You may also want to install the recommend packages: You may also want to install the recommend packages:
* `autossh` * `autossh`
@ -55,9 +53,6 @@ Called without option,`tunnelmon` will print the current state of the autossh tu
Log messages are written to the given FILE. Useful to debug the interactive interface. Log messages are written to the given FILE. Useful to debug the interactive interface.
If not set, asking for the curses interface automatically set logging to the "tunnelmon.log" file. If not set, asking for the curses interface automatically set logging to the "tunnelmon.log" file.
* `-s`, `--log-sensitive`:
Allow sensitive information (hostnames, IPs, PIDs, etc.) into the logs.
## INTERACTIVE INTERFACE ## INTERACTIVE INTERFACE
@ -67,7 +62,7 @@ Keyboard commands:
* `R`: Reload the selected autossh instance (i.e. send a `SIGUSR1`, which is interpreted as a reload command by autossh). * `R`: Reload the selected autossh instance (i.e. send a `SIGUSR1`, which is interpreted as a reload command by autossh).
* `C`: Close the selected tunnel (i.e. send a `SIGTERM`). * `C`: Close the selected tunnel (i.e. send a `SIGTERM`).
* `N`: Show the network connections related to each tunnel instances. * `N`: Show the network connections related to each tunnel instances.
* `Q`: Quit Tunnelmon. * `Q`: Quit tunnelmon.
## DISPLAY ## DISPLAY

96
tunnelmon.py
View file

@ -36,7 +36,6 @@ import re
import collections import collections
import itertools import itertools
log_sensitive = False
class Tunnel: class Tunnel:
def __init__(self, ssh_pid=None, in_port=None, via_host=None, target_host=None, out_port=None, forward=None): def __init__(self, ssh_pid=None, in_port=None, via_host=None, target_host=None, out_port=None, forward=None):
@ -163,22 +162,16 @@ class TunnelsParser:
return self.tunnels[pid] return self.tunnels[pid]
def parse(self, cmd): def parse(self, cmd):
try: cmdline = " ".join(cmd)
cmdline = " ".join(cmd)
except TypeError:
cmdline = cmd
if log_sensitive: logging.debug('autossh cmd line: %s', cmdline)
logging.debug("[SENSITIVE] autossh cmd line: %s", cmdline) logging.debug('forwarding regexp: %s', self.re_forwarding)
logging.debug("forwarding regexp: %s" % self.re_forwarding)
match = self.re_forwarding.findall(cmdline) match = self.re_forwarding.findall(cmdline)
if log_sensitive: logging.debug(match)
logging.debug("[SENSITIVE] match: %s", match)
if match: if match:
assert len(match) == 1 assert len(match) == 1
forward, in_port, target_host, out_port = match[0] forward, in_port, target_host, out_port = match[0]
if log_sensitive: logging.debug("matches: %s", match)
logging.debug("[SENSITIVE] matches: %s", match)
else: else:
raise ValueError("is not a ssh tunnel") raise ValueError("is not a ssh tunnel")
@ -188,8 +181,7 @@ class TunnelsParser:
# FIXME this is an ugly hack # FIXME this is an ugly hack
i = 1 i = 1
while i < len(cmd): while i < len(cmd):
if log_sensitive: logging.debug("ici: %i %s", i, cmd[i])
logging.debug("[SENSITIVE] here: %i %s", i, cmd[i])
if cmd[i][0] == '-': if cmd[i][0] == '-':
if cmd[i][1] in '46AaCfGgKkMNnqsTtVvXxYy': if cmd[i][1] in '46AaCfGgKkMNnqsTtVvXxYy':
# flag without argument # flag without argument
@ -219,14 +211,12 @@ class TunnelsParser:
pass pass
else: else:
if process['name'] == 'ssh': if process['name'] == 'ssh':
if log_sensitive: logging.debug(process)
logging.debug("[SENSITIVE] process: %s ", process)
try: try:
in_port, via_host, target_host, out_port, forward = self.parse(cmd) in_port, via_host, target_host, out_port, forward = self.parse(cmd)
except ValueError: except ValueError:
continue continue
if log_sensitive: logging.debug("%s %s %s %s %s", in_port, via_host, target_host, out_port, forward)
logging.debug("[SENSITIVE] parsed: %s %s %s %s %s", in_port, via_host, target_host, out_port, forward)
# Check if this ssh tunnel is managed by autossh. # Check if this ssh tunnel is managed by autossh.
parent = psutil.Process(process['ppid']) parent = psutil.Process(process['ppid'])
@ -240,20 +230,17 @@ class TunnelsParser:
self.tunnels[pid] = RawTunnel(pid, in_port, via_host, target_host, out_port, forward) self.tunnels[pid] = RawTunnel(pid, in_port, via_host, target_host, out_port, forward)
for c in process['connections']: for c in process['connections']:
if log_sensitive: logging.debug(c)
logging.debug("[SENSITIVE] connection: %s", c)
laddr, lport = c.laddr laddr, lport = c.laddr
if c.raddr: if c.raddr:
raddr, rport = c.raddr raddr, rport = c.raddr
else: else:
raddr, rport = (None, None) raddr, rport = (None, None)
connection = Connection(laddr, lport, raddr, rport, c.status, c.family) connection = Connection(laddr, lport, raddr, rport, c.status, c.family)
if log_sensitive: logging.debug(connection)
logging.debug("[SENSITIVE] connection: %s", connection)
self.tunnels[pid].connections.append(connection) self.tunnels[pid].connections.append(connection)
if log_sensitive: logging.debug(self.tunnels)
logging.debug("[SENSITIVE] %s", self.tunnels)
def __repr__(self): def __repr__(self):
reps = [self.header] reps = [self.header]
@ -273,7 +260,7 @@ class CursesMonitor:
def __init__(self, scr): def __init__(self, scr):
# hide cursor # hide cursor
curses.curs_set(0) curses.curs_set(0)
# curses screen # curses screen
self.scr = scr self.scr = scr
@ -354,14 +341,14 @@ class CursesMonitor:
def do_Q(self): def do_Q(self):
"""Quit""" """Quit"""
logging.debug("Waited: %s", self.log_ticks) logging.debug("Waited: %s" % self.log_ticks)
self.log_ticks = "" self.log_ticks = ""
logging.debug("Key pushed: Q") logging.debug("Key pushed: Q")
return False return False
def do_R(self): def do_R(self):
"""Reload autossh tunnel""" """Reload autossh tunnel"""
logging.debug("Waited: %s", self.log_ticks) logging.debug("Waited: %s" % self.log_ticks)
self.log_ticks = "" self.log_ticks = ""
logging.debug("Key pushed: R") logging.debug("Key pushed: R")
# if a pid is selected # if a pid is selected
@ -369,8 +356,7 @@ class CursesMonitor:
# send the SIGUSR1 signal # send the SIGUSR1 signal
if type(self.tp.get_tunnel(self.cur_line)) == AutoTunnel: if type(self.tp.get_tunnel(self.cur_line)) == AutoTunnel:
# autossh performs a reload of existing tunnels that it manages # autossh performs a reload of existing tunnels that it manages
if log_sensitive: logging.debug("SIGUSR1 on PID: %i" % self.cur_pid)
logging.debug("[SENSITIVE] SIGUSR1 on PID: %i", self.cur_pid)
os.kill(self.cur_pid, signal.SIGUSR1) os.kill(self.cur_pid, signal.SIGUSR1)
else: else:
logging.debug("Cannot reload a RAW tunnel") logging.debug("Cannot reload a RAW tunnel")
@ -378,7 +364,7 @@ class CursesMonitor:
def do_C(self): def do_C(self):
"""Close tunnel""" """Close tunnel"""
logging.debug("Waited: %s", self.log_ticks) logging.debug("Waited: %s" % self.log_ticks)
self.log_ticks = "" self.log_ticks = ""
logging.debug("Key pushed: C") logging.debug("Key pushed: C")
if self.cur_pid != -1: if self.cur_pid != -1:
@ -388,21 +374,17 @@ class CursesMonitor:
tunnel = self.tp.get_tunnel(self.cur_line) tunnel = self.tp.get_tunnel(self.cur_line)
if type(tunnel) == AutoTunnel: if type(tunnel) == AutoTunnel:
if log_sensitive: logging.debug("SIGKILL on autossh PID: %i" % self.cur_pid)
logging.debug("[SENSITIVE] SIGKILL on autossh PID: %i", self.cur_pid)
try: try:
os.kill(self.cur_pid, signal.SIGKILL) os.kill(self.cur_pid, signal.SIGKILL)
except OSError: except OSError:
if log_sensitive: logging.error("No such process: %i" % self.cur_pid)
logging.error("[SENSITIVE] No such process: %i", self.cur_pid)
if log_sensitive: logging.debug("SIGKILL on ssh PID: %i" % tunnel.ssh_pid)
logging.debug("[SENSITIVE] SIGKILL on ssh PID: %i", tunnel.ssh_pid)
try: try:
os.kill(tunnel.ssh_pid, signal.SIGKILL) os.kill(tunnel.ssh_pid, signal.SIGKILL)
except OSError: except OSError:
if log_sensitive: logging.error("No such process: %i" % tunnel.ssh_pid)
logging.error("[SENSITIVE] No such process: %i", tunnel.ssh_pid)
self.cur_line -= 1 self.cur_line -= 1
self.cur_pid = -1 self.cur_pid = -1
# FIXME update cur_pid or get rid of it everywhere # FIXME update cur_pid or get rid of it everywhere
@ -410,7 +392,7 @@ class CursesMonitor:
def do_N(self): def do_N(self):
"""Show connections""" """Show connections"""
logging.debug("Waited: %s", self.log_ticks) logging.debug("Waited: %s" % self.log_ticks)
self.log_ticks = "" self.log_ticks = ""
logging.debug("Key pushed: N") logging.debug("Key pushed: N")
self.show_connections = not self.show_connections self.show_connections = not self.show_connections
@ -418,7 +400,7 @@ class CursesMonitor:
def do_258(self): def do_258(self):
"""Move down""" """Move down"""
logging.debug("Waited: %s", self.log_ticks) logging.debug("Waited: %s" % self.log_ticks)
self.log_ticks = "" self.log_ticks = ""
logging.debug("Key pushed: down") logging.debug("Key pushed: down")
# if not the end of the list # if not the end of the list
@ -433,7 +415,7 @@ class CursesMonitor:
def do_259(self): def do_259(self):
"""Move up""" """Move up"""
logging.debug("Waited: %s", self.log_ticks) logging.debug("Waited: %s" % self.log_ticks)
self.log_ticks = "" self.log_ticks = ""
logging.debug("Key pushed: up") logging.debug("Key pushed: up")
if self.cur_line > -1: if self.cur_line > -1:
@ -472,11 +454,10 @@ class CursesMonitor:
state = "%s" % self.tp state = "%s" % self.tp
if state != self.last_state: if state != self.last_state:
logging.debug("Waited: %s", self.log_ticks) logging.debug("Waited: %s" % self.log_ticks)
self.log_ticks = "" self.log_ticks = ""
logging.debug("----- Time of screen update: %s -----", time.time()) logging.debug("----- Time of screen update: %s -----" % time.time())
if log_sensitive: logging.debug("State of tunnels:\n%s" % self.tp)
logging.debug("[SENSITIVE] State of tunnels:\n%s", self.tp)
self.last_state = state self.last_state = state
else: else:
self.log_ticks += "." self.log_ticks += "."
@ -495,12 +476,12 @@ class CursesMonitor:
# Call the do_* handler. # Call the do_* handler.
fch = "do_%s" % ch.capitalize() fch = "do_%s" % ch.capitalize()
fkc = "do_%i" % kc fkc = "do_%i" % kc
logging.debug("key func: %s / %s", fch, fkc) logging.debug("key func: %s / %s" % (fch, fkc))
if fch in dir(self): if fch in dir(self):
notquit = eval("self."+fch+"()") notquit = eval("self."+fch+"()")
elif fkc in dir(self): elif fkc in dir(self):
notquit = eval("self."+fkc+"()") notquit = eval("self."+fkc+"()")
logging.debug("notquit = %s", notquit) logging.debug("notquit = %s" % notquit)
# update the display # update the display
self.display() self.display()
@ -511,15 +492,15 @@ class CursesMonitor:
# end of the loop # end of the loop
def format(self): def format(self):
"""Prepare formating strings to pad with spaces up to the column header width.""" """Prepare formating strings to pad with spaces up to the tolumn header width."""
reps = [self.tp.tunnels[t].repr_tunnel() for t in self.tp.tunnels] reps = [self.tp.tunnels[t].repr_tunnel() for t in self.tp.tunnels]
tuns = [t.split() for t in reps] tuns = [t.split() for t in reps]
tuns.append(self.header) tuns.append(self.header)
cols = itertools.zip_longest(*tuns, fillvalue='') cols = itertools.zip_longest(*tuns, fillvalue='')
widths = [max(len(s) for s in col) for col in cols] widths = [max(len(s) for s in col) for col in cols]
logging.debug("Columns widths: %s", widths) logging.debug(widths)
fmt = ['{{: <{}}}'.format(w) for w in widths] fmt = ['{{: <{}}}'.format(w) for w in widths]
logging.debug("Columns formats: %s", fmt) logging.debug(fmt)
return fmt return fmt
def display(self): def display(self):
@ -740,10 +721,6 @@ if __name__ == "__main__":
help="Log to this file, default to standard output. \ help="Log to this file, default to standard output. \
If you use the curses interface, you may want to set this to actually see logs.") If you use the curses interface, you may want to set this to actually see logs.")
parser.add_option("-s", "--log-sensitive",
action="store_true", default=False,
help="Do log sensitive informations (like hostnames, IPs and PIDs).")
parser.add_option('-f', '--config-file', default=None, metavar='FILE', parser.add_option('-f', '--config-file', default=None, metavar='FILE',
help="Use this configuration file (default: '~/.tunnelmon.conf')") help="Use this configuration file (default: '~/.tunnelmon.conf')")
@ -755,7 +732,7 @@ if __name__ == "__main__":
logfile = asked_for.log_file logfile = asked_for.log_file
logging.basicConfig(filename=logfile, level=LOG_LEVELS[asked_for.log_level]) logging.basicConfig(filename=logfile, level=LOG_LEVELS[asked_for.log_level])
logging.debug(logmsg) logging.debug(logmsg)
logging.debug("Log in %s", logfile) logging.debug("Log in %s" % logfile)
else: else:
if asked_for.curses: if asked_for.curses:
logging.warning("It's a bad idea to log to stdout while in the curses interface.") logging.warning("It's a bad idea to log to stdout while in the curses interface.")
@ -763,11 +740,7 @@ if __name__ == "__main__":
logging.debug(logmsg) logging.debug(logmsg)
logging.debug("Log to stdout") logging.debug("Log to stdout")
logging.debug("Asked for: %s" % asked_for) logging.debug("Asked for: %s", asked_for)
if asked_for.log_sensitive:
logging.debug("Asked for logging sensitive information.")
log_sensitive = True
# unfortunately, asked_for class has no __len__ method in python 2.4.3 (bug?) # unfortunately, asked_for class has no __len__ method in python 2.4.3 (bug?)
# if len(asked_for) > 1: # if len(asked_for) > 1:
@ -837,8 +810,7 @@ if __name__ == "__main__":
tp = TunnelsParser() tp = TunnelsParser()
tp.update() tp.update()
# do not call update() but only get connections # do not call update() but only get connections
if log_sensitive: logging.debug("UID: %i.", os.geteuid())
logging.debug("[SENSITIVE] UID: %i", os.geteuid())
# if os.geteuid() == 0: # if os.geteuid() == 0:
for t in tp.tunnels: for t in tp.tunnels:
for c in tp.tunnels[t].connections: for c in tp.tunnels[t].connections: