1
#!/usr/bin/python3 -bbI
2
# -*- mode: python; coding: utf-8 -*-
4
# Mandos Monitor - Control and monitor the Mandos server
6
# Copyright © 2009-2019 Teddy Hogeborn
7
# Copyright © 2009-2019 Björn Påhlsson
9
# This file is part of Mandos.
11
# Mandos is free software: you can redistribute it and/or modify it
12
# under the terms of the GNU General Public License as published by
13
# the Free Software Foundation, either version 3 of the License, or
14
# (at your option) any later version.
16
# Mandos is distributed in the hope that it will be useful, but
17
# WITHOUT ANY WARRANTY; without even the implied warranty of
18
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19
# GNU General Public License for more details.
21
# You should have received a copy of the GNU General Public License
22
# along with Mandos. If not, see <http://www.gnu.org/licenses/>.
24
# Contact the authors at <mandos@recompile.se>.
26
from __future__ import (division, absolute_import, print_function,
30
from future_builtins import *
41
import urwid.curses_display
44
from dbus.mainloop.glib import DBusGMainLoop
45
from gi.repository import GLib
49
if sys.version_info.major == 2:
54
# Show warnings by default
55
if not sys.warnoptions:
56
warnings.simplefilter("default")
58
log = logging.getLogger(os.path.basename(sys.argv[0]))
59
logging.basicConfig(level="NOTSET", # Show all messages
60
format="%(message)s") # Show basic log messages
62
logging.captureWarnings(True) # Show warnings via the logging system
64
locale.setlocale(locale.LC_ALL, "")
66
logging.getLogger("dbus.proxies").setLevel(logging.CRITICAL)
68
# Some useful constants
69
domain = "se.recompile"
70
server_interface = domain + ".Mandos"
71
client_interface = domain + ".Mandos.Client"
75
dbus.OBJECT_MANAGER_IFACE
76
except AttributeError:
77
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
80
def isoformat_to_datetime(iso):
81
"Parse an ISO 8601 date string to a datetime.datetime()"
84
d, t = iso.split("T", 1)
85
year, month, day = d.split("-", 2)
86
hour, minute, second = t.split(":", 2)
87
second, fraction = divmod(float(second), 1)
88
return datetime.datetime(int(year),
93
int(second), # Whole seconds
94
int(fraction*1000000)) # Microseconds
97
class MandosClientPropertyCache:
98
"""This wraps a Mandos Client D-Bus proxy object, caches the
99
properties and calls a hook function when any of them are
102
def __init__(self, proxy_object=None, properties=None, **kwargs):
103
self.proxy = proxy_object # Mandos Client proxy object
104
self.properties = dict() if properties is None else properties
105
self.property_changed_match = (
106
self.proxy.connect_to_signal("PropertiesChanged",
107
self.properties_changed,
108
dbus.PROPERTIES_IFACE,
111
if properties is None:
112
self.properties.update(self.proxy.GetAll(
114
dbus_interface=dbus.PROPERTIES_IFACE))
116
super(MandosClientPropertyCache, self).__init__(**kwargs)
118
def properties_changed(self, interface, properties, invalidated):
119
"""This is called whenever we get a PropertiesChanged signal
120
It updates the changed properties in the "properties" dict.
122
# Update properties dict with new value
123
if interface == client_interface:
124
self.properties.update(properties)
127
self.property_changed_match.remove()
130
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
131
"""A Mandos Client which is visible on the screen.
134
def __init__(self, server_proxy_object=None, update_hook=None,
135
delete_hook=None, **kwargs):
137
self.update_hook = update_hook
139
self.delete_hook = delete_hook
140
# Mandos Server proxy object
141
self.server_proxy_object = server_proxy_object
143
self._update_timer_callback_tag = None
145
# The widget shown normally
146
self._text_widget = urwid.Text("")
147
# The widget shown when we have focus
148
self._focus_text_widget = urwid.Text("")
149
super(MandosClientWidget, self).__init__(**kwargs)
153
self.match_objects = (
154
self.proxy.connect_to_signal("CheckerCompleted",
155
self.checker_completed,
158
self.proxy.connect_to_signal("CheckerStarted",
159
self.checker_started,
162
self.proxy.connect_to_signal("GotSecret",
166
self.proxy.connect_to_signal("NeedApproval",
170
self.proxy.connect_to_signal("Rejected",
174
log.debug("Created client %s", self.properties["Name"])
176
def using_timer(self, flag):
177
"""Call this method with True or False when timer should be
178
activated or deactivated.
180
if flag and self._update_timer_callback_tag is None:
181
# Will update the shown timer value every second
182
self._update_timer_callback_tag = (
183
GLib.timeout_add(1000,
184
glib_safely(self.update_timer)))
185
elif not (flag or self._update_timer_callback_tag is None):
186
GLib.source_remove(self._update_timer_callback_tag)
187
self._update_timer_callback_tag = None
189
def checker_completed(self, exitstatus, condition, command):
191
log.debug('Checker for client %s (command "%s")'
192
" succeeded", self.properties["Name"], command)
196
if os.WIFEXITED(condition):
197
log.info('Checker for client %s (command "%s") failed'
198
" with exit code %d", self.properties["Name"],
199
command, os.WEXITSTATUS(condition))
200
elif os.WIFSIGNALED(condition):
201
log.info('Checker for client %s (command "%s") was'
202
" killed by signal %d", self.properties["Name"],
203
command, os.WTERMSIG(condition))
206
def checker_started(self, command):
207
"""Server signals that a checker started."""
208
log.debug('Client %s started checker "%s"',
209
self.properties["Name"], command)
211
def got_secret(self):
212
log.info("Client %s received its secret",
213
self.properties["Name"])
215
def need_approval(self, timeout, default):
217
message = "Client %s needs approval within %f seconds"
219
message = "Client %s will get its secret in %f seconds"
220
log.info(message, self.properties["Name"], timeout/1000)
222
def rejected(self, reason):
223
log.info("Client %s was rejected; reason: %s",
224
self.properties["Name"], reason)
226
def selectable(self):
227
"""Make this a "selectable" widget.
228
This overrides the method from urwid.FlowWidget."""
231
def rows(self, maxcolrow, focus=False):
232
"""How many rows this widget will occupy might depend on
233
whether we have focus or not.
234
This overrides the method from urwid.FlowWidget"""
235
return self.current_widget(focus).rows(maxcolrow, focus=focus)
237
def current_widget(self, focus=False):
238
if focus or self.opened:
239
return self._focus_widget
243
"Called when what is visible on the screen should be updated."
244
# How to add standout mode to a style
245
with_standout = {"normal": "standout",
246
"bold": "bold-standout",
248
"underline-blink-standout",
249
"bold-underline-blink":
250
"bold-underline-blink-standout",
253
# Rebuild focus and non-focus widgets using current properties
255
# Base part of a client. Name!
256
base = "{name}: ".format(name=self.properties["Name"])
257
if not self.properties["Enabled"]:
259
self.using_timer(False)
260
elif self.properties["ApprovalPending"]:
261
timeout = datetime.timedelta(
262
milliseconds=self.properties["ApprovalDelay"])
263
last_approval_request = isoformat_to_datetime(
264
self.properties["LastApprovalRequest"])
265
if last_approval_request is not None:
266
timer = max(timeout - (datetime.datetime.utcnow()
267
- last_approval_request),
268
datetime.timedelta())
270
timer = datetime.timedelta()
271
if self.properties["ApprovedByDefault"]:
272
message = "Approval in {}. (d)eny?"
274
message = "Denial in {}. (a)pprove?"
275
message = message.format(str(timer).rsplit(".", 1)[0])
276
self.using_timer(True)
277
elif self.properties["LastCheckerStatus"] != 0:
278
# When checker has failed, show timer until client expires
279
expires = self.properties["Expires"]
281
timer = datetime.timedelta(0)
283
expires = (datetime.datetime.strptime
284
(expires, "%Y-%m-%dT%H:%M:%S.%f"))
285
timer = max(expires - datetime.datetime.utcnow(),
286
datetime.timedelta())
287
message = ("A checker has failed! Time until client"
289
.format(str(timer).rsplit(".", 1)[0]))
290
self.using_timer(True)
293
self.using_timer(False)
294
self._text = "{}{}".format(base, message)
296
if not urwid.supports_unicode():
297
self._text = self._text.encode("ascii", "replace")
298
textlist = [("normal", self._text)]
299
self._text_widget.set_text(textlist)
300
self._focus_text_widget.set_text([(with_standout[text[0]],
302
if isinstance(text, tuple)
304
for text in textlist])
305
self._widget = self._text_widget
306
self._focus_widget = urwid.AttrWrap(self._focus_text_widget,
308
# Run update hook, if any
309
if self.update_hook is not None:
312
def update_timer(self):
313
"""called by GLib. Will indefinitely loop until
314
GLib.source_remove() on tag is called
317
return True # Keep calling this
319
def delete(self, **kwargs):
320
if self._update_timer_callback_tag is not None:
321
GLib.source_remove(self._update_timer_callback_tag)
322
self._update_timer_callback_tag = None
323
for match in self.match_objects:
325
self.match_objects = ()
326
if self.delete_hook is not None:
327
self.delete_hook(self)
328
return super(MandosClientWidget, self).delete(**kwargs)
330
def render(self, maxcolrow, focus=False):
331
"""Render differently if we have focus.
332
This overrides the method from urwid.FlowWidget"""
333
return self.current_widget(focus).render(maxcolrow,
336
def keypress(self, maxcolrow, key):
338
This overrides the method from urwid.FlowWidget"""
340
self.proxy.Set(client_interface, "Enabled",
341
dbus.Boolean(True), ignore_reply=True,
342
dbus_interface=dbus.PROPERTIES_IFACE)
344
self.proxy.Set(client_interface, "Enabled", False,
346
dbus_interface=dbus.PROPERTIES_IFACE)
348
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
349
dbus_interface=client_interface,
352
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
353
dbus_interface=client_interface,
355
elif key == "R" or key == "_" or key == "ctrl k":
356
self.server_proxy_object.RemoveClient(self.proxy
360
self.proxy.Set(client_interface, "CheckerRunning",
361
dbus.Boolean(True), ignore_reply=True,
362
dbus_interface=dbus.PROPERTIES_IFACE)
364
self.proxy.Set(client_interface, "CheckerRunning",
365
dbus.Boolean(False), ignore_reply=True,
366
dbus_interface=dbus.PROPERTIES_IFACE)
368
self.proxy.CheckedOK(dbus_interface=client_interface,
371
# elif key == "p" or key == "=":
373
# elif key == "u" or key == ":":
374
# self.proxy.unpause()
380
def properties_changed(self, interface, properties, invalidated):
381
"""Call self.update() if any properties changed.
382
This overrides the method from MandosClientPropertyCache"""
383
old_values = {key: self.properties.get(key)
384
for key in properties.keys()}
385
super(MandosClientWidget, self).properties_changed(
386
interface, properties, invalidated)
387
if any(old_values[key] != self.properties.get(key)
388
for key in old_values):
392
def glib_safely(func, retval=True):
393
def safe_func(*args, **kwargs):
395
return func(*args, **kwargs)
402
class ConstrainedListBox(urwid.ListBox):
403
"""Like a normal urwid.ListBox, but will consume all "up" or
404
"down" key presses, thus not allowing any containing widgets to
405
use them as an excuse to shift focus away from this widget.
407
def keypress(self, *args, **kwargs):
408
ret = (super(ConstrainedListBox, self)
409
.keypress(*args, **kwargs))
410
if ret in ("up", "down"):
416
"""This is the entire user interface - the whole screen
417
with boxes, lists of client widgets, etc.
419
def __init__(self, max_log_length=1000):
420
DBusGMainLoop(set_as_default=True)
422
self.screen = urwid.curses_display.Screen()
424
self.screen.register_palette((
426
"default", "default", None),
428
"bold", "default", "bold"),
430
"underline,blink", "default", "underline,blink"),
432
"standout", "default", "standout"),
433
("bold-underline-blink",
434
"bold,underline,blink", "default",
435
"bold,underline,blink"),
437
"bold,standout", "default", "bold,standout"),
438
("underline-blink-standout",
439
"underline,blink,standout", "default",
440
"underline,blink,standout"),
441
("bold-underline-blink-standout",
442
"bold,underline,blink,standout", "default",
443
"bold,underline,blink,standout"),
446
if urwid.supports_unicode():
447
self.divider = "─" # \u2500
449
self.divider = "_" # \u005f
453
self.size = self.screen.get_cols_rows()
455
self.clients = urwid.SimpleListWalker([])
456
self.clients_dict = {}
458
# We will add Text widgets to this list
459
self.log = urwid.SimpleListWalker([])
460
self.max_log_length = max_log_length
462
# We keep a reference to the log widget so we can remove it
463
# from the ListWalker without it getting destroyed
464
self.logbox = ConstrainedListBox(self.log)
466
# This keeps track of whether self.uilist currently has
467
# self.logbox in it or not
468
self.log_visible = True
469
self.log_wrap = "any"
471
self.loghandler = UILogHandler(self)
474
self.add_log_line(("bold",
475
"Mandos Monitor version " + version))
476
self.add_log_line(("bold", "q: Quit ?: Help"))
478
self.busname = domain + ".Mandos"
479
self.main_loop = GLib.MainLoop()
481
def client_not_found(self, key_id, address):
482
log.info("Client with address %s and key ID %s could"
483
" not be found", address, key_id)
486
"""This rebuilds the User Interface.
487
Call this when the widget layout needs to change"""
489
# self.uilist.append(urwid.ListBox(self.clients))
490
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
492
# header=urwid.Divider(),
494
footer=urwid.Divider(
495
div_char=self.divider)))
497
self.uilist.append(self.logbox)
498
self.topwidget = urwid.Pile(self.uilist)
500
def add_log_line(self, markup):
501
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
502
if self.max_log_length:
503
if len(self.log) > self.max_log_length:
504
del self.log[0:(len(self.log) - self.max_log_length)]
505
self.logbox.set_focus(len(self.logbox.body.contents)-1,
509
def toggle_log_display(self):
510
"""Toggle visibility of the log buffer."""
511
self.log_visible = not self.log_visible
513
log.debug("Log visibility changed to: %s", self.log_visible)
515
def change_log_display(self):
516
"""Change type of log display.
517
Currently, this toggles wrapping of text lines."""
518
if self.log_wrap == "clip":
519
self.log_wrap = "any"
521
self.log_wrap = "clip"
522
for textwidget in self.log:
523
textwidget.set_wrap_mode(self.log_wrap)
524
log.debug("Wrap mode: %s", self.log_wrap)
526
def find_and_remove_client(self, path, interfaces):
527
"""Find a client by its object path and remove it.
529
This is connected to the InterfacesRemoved signal from the
530
Mandos server object."""
531
if client_interface not in interfaces:
532
# Not a Mandos client object; ignore
535
client = self.clients_dict[path]
538
log.warning("Unknown client %s removed", path)
542
def add_new_client(self, path, ifs_and_props):
543
"""Find a client by its object path and remove it.
545
This is connected to the InterfacesAdded signal from the
546
Mandos server object.
548
if client_interface not in ifs_and_props:
549
# Not a Mandos client object; ignore
551
client_proxy_object = self.bus.get_object(self.busname, path)
552
self.add_client(MandosClientWidget(
553
server_proxy_object=self.mandos_serv,
554
proxy_object=client_proxy_object,
555
update_hook=self.refresh,
556
delete_hook=self.remove_client,
557
properties=dict(ifs_and_props[client_interface])),
560
def add_client(self, client, path=None):
561
self.clients.append(client)
563
path = client.proxy.object_path
564
self.clients_dict[path] = client
565
self.clients.sort(key=lambda c: c.properties["Name"])
568
def remove_client(self, client, path=None):
569
self.clients.remove(client)
571
path = client.proxy.object_path
572
del self.clients_dict[path]
576
"""Redraw the screen"""
577
canvas = self.topwidget.render(self.size, focus=True)
578
self.screen.draw_screen(self.size, canvas)
581
"""Start the main loop and exit when it's done."""
582
log.addHandler(self.loghandler)
583
self.orig_log_propagate = log.propagate
584
log.propagate = False
585
self.orig_log_level = log.level
587
self.bus = dbus.SystemBus()
588
mandos_dbus_objc = self.bus.get_object(
589
self.busname, "/", follow_name_owner_changes=True)
590
self.mandos_serv = dbus.Interface(
591
mandos_dbus_objc, dbus_interface=server_interface)
593
mandos_clients = (self.mandos_serv
594
.GetAllClientsWithProperties())
595
if not mandos_clients:
596
log.warning("Note: Server has no clients.")
597
except dbus.exceptions.DBusException:
598
log.warning("Note: No Mandos server running.")
599
mandos_clients = dbus.Dictionary()
602
.connect_to_signal("InterfacesRemoved",
603
self.find_and_remove_client,
604
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
607
.connect_to_signal("InterfacesAdded",
609
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
612
.connect_to_signal("ClientNotFound",
613
self.client_not_found,
614
dbus_interface=server_interface,
616
for path, client in mandos_clients.items():
617
client_proxy_object = self.bus.get_object(self.busname,
619
self.add_client(MandosClientWidget(
620
server_proxy_object=self.mandos_serv,
621
proxy_object=client_proxy_object,
623
update_hook=self.refresh,
624
delete_hook=self.remove_client),
628
self._input_callback_tag = (
630
GLib.IOChannel.unix_new(sys.stdin.fileno()),
631
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
632
glib_safely(self.process_input)))
634
# Main loop has finished, we should close everything now
635
GLib.source_remove(self._input_callback_tag)
636
with warnings.catch_warnings():
637
warnings.simplefilter("ignore", BytesWarning)
641
self.main_loop.quit()
642
log.removeHandler(self.loghandler)
643
log.propagate = self.orig_log_propagate
645
def process_input(self, source, condition):
646
keys = self.screen.get_input()
647
translations = {"ctrl n": "down", # Emacs
648
"ctrl p": "up", # Emacs
649
"ctrl v": "page down", # Emacs
650
"meta v": "page up", # Emacs
651
" ": "page down", # less
652
"f": "page down", # less
653
"b": "page up", # less
659
key = translations[key]
660
except KeyError: # :-)
663
if key == "q" or key == "Q":
666
elif key == "window resize":
667
self.size = self.screen.get_cols_rows()
669
elif key == "ctrl l":
672
elif key == "l" or key == "D":
673
self.toggle_log_display()
675
elif key == "w" or key == "i":
676
self.change_log_display()
678
elif key == "?" or key == "f1" or key == "esc":
679
if not self.log_visible:
680
self.log_visible = True
682
self.add_log_line(("bold",
685
"l: Log window toggle",
686
"TAB: Switch window",
687
"w: Wrap (log lines)",
688
"v: Toggle verbose log",
690
self.add_log_line(("bold",
691
" ".join(("Clients:",
695
"s: Start new checker",
703
if self.topwidget.get_focus() is self.logbox:
704
self.topwidget.set_focus(0)
706
self.topwidget.set_focus(self.logbox)
709
if log.level < logging.INFO:
710
log.setLevel(logging.INFO)
711
log.info("Verbose mode: Off")
713
log.setLevel(logging.NOTSET)
714
log.info("Verbose mode: On")
715
# elif (key == "end" or key == "meta >" or key == "G"
717
# pass # xxx end-of-buffer
718
# elif (key == "home" or key == "meta <" or key == "g"
720
# pass # xxx beginning-of-buffer
721
# elif key == "ctrl e" or key == "$":
722
# pass # xxx move-end-of-line
723
# elif key == "ctrl a" or key == "^":
724
# pass # xxx move-beginning-of-line
725
# elif key == "ctrl b" or key == "meta (" or key == "h":
727
# elif key == "ctrl f" or key == "meta )" or key == "l":
730
# pass # scroll up log
732
# pass # scroll down log
733
elif self.topwidget.selectable():
734
self.topwidget.keypress(self.size, key)
739
class UILogHandler(logging.Handler):
740
def __init__(self, ui, *args, **kwargs):
742
super(UILogHandler, self).__init__(*args, **kwargs)
744
logging.Formatter("%(asctime)s: %(message)s"))
745
def emit(self, record):
746
msg = self.format(record)
747
if record.levelno > logging.INFO:
749
self.ui.add_log_line(msg)
755
except KeyboardInterrupt:
756
with warnings.catch_warnings():
757
warnings.filterwarnings("ignore", "", BytesWarning)
760
with warnings.catch_warnings():
761
warnings.filterwarnings("ignore", "", BytesWarning)