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>.
27
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:
53
log = logging.getLogger(os.path.basename(sys.argv[0]))
54
logging.basicConfig(level="NOTSET", # Show all messages
55
format="%(message)s") # Show basic log messages
57
logging.captureWarnings(True) # Show warnings via the logging system
59
locale.setlocale(locale.LC_ALL, "")
61
logging.getLogger("dbus.proxies").setLevel(logging.CRITICAL)
63
# Some useful constants
64
domain = "se.recompile"
65
server_interface = domain + ".Mandos"
66
client_interface = domain + ".Mandos.Client"
70
dbus.OBJECT_MANAGER_IFACE
71
except AttributeError:
72
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
75
def isoformat_to_datetime(iso):
76
"Parse an ISO 8601 date string to a datetime.datetime()"
79
d, t = iso.split("T", 1)
80
year, month, day = d.split("-", 2)
81
hour, minute, second = t.split(":", 2)
82
second, fraction = divmod(float(second), 1)
83
return datetime.datetime(int(year),
88
int(second), # Whole seconds
89
int(fraction*1000000)) # Microseconds
92
class MandosClientPropertyCache:
93
"""This wraps a Mandos Client D-Bus proxy object, caches the
94
properties and calls a hook function when any of them are
97
def __init__(self, proxy_object=None, properties=None, **kwargs):
98
self.proxy = proxy_object # Mandos Client proxy object
99
self.properties = dict() if properties is None else properties
100
self.property_changed_match = (
101
self.proxy.connect_to_signal("PropertiesChanged",
102
self.properties_changed,
103
dbus.PROPERTIES_IFACE,
106
if properties is None:
107
self.properties.update(self.proxy.GetAll(
109
dbus_interface=dbus.PROPERTIES_IFACE))
111
super(MandosClientPropertyCache, self).__init__(**kwargs)
113
def properties_changed(self, interface, properties, invalidated):
114
"""This is called whenever we get a PropertiesChanged signal
115
It updates the changed properties in the "properties" dict.
117
# Update properties dict with new value
118
if interface == client_interface:
119
self.properties.update(properties)
122
self.property_changed_match.remove()
125
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
126
"""A Mandos Client which is visible on the screen.
129
def __init__(self, server_proxy_object=None, update_hook=None,
130
delete_hook=None, **kwargs):
132
self.update_hook = update_hook
134
self.delete_hook = delete_hook
135
# Mandos Server proxy object
136
self.server_proxy_object = server_proxy_object
138
self._update_timer_callback_tag = None
140
# The widget shown normally
141
self._text_widget = urwid.Text("")
142
# The widget shown when we have focus
143
self._focus_text_widget = urwid.Text("")
144
super(MandosClientWidget, self).__init__(**kwargs)
148
self.match_objects = (
149
self.proxy.connect_to_signal("CheckerCompleted",
150
self.checker_completed,
153
self.proxy.connect_to_signal("CheckerStarted",
154
self.checker_started,
157
self.proxy.connect_to_signal("GotSecret",
161
self.proxy.connect_to_signal("NeedApproval",
165
self.proxy.connect_to_signal("Rejected",
169
log.debug("Created client %s", self.properties["Name"])
171
def using_timer(self, flag):
172
"""Call this method with True or False when timer should be
173
activated or deactivated.
175
if flag and self._update_timer_callback_tag is None:
176
# Will update the shown timer value every second
177
self._update_timer_callback_tag = (
178
GLib.timeout_add(1000,
179
glib_safely(self.update_timer)))
180
elif not (flag or self._update_timer_callback_tag is None):
181
GLib.source_remove(self._update_timer_callback_tag)
182
self._update_timer_callback_tag = None
184
def checker_completed(self, exitstatus, condition, command):
186
log.debug('Checker for client %s (command "%s")'
187
" succeeded", self.properties["Name"], command)
191
if os.WIFEXITED(condition):
192
log.info('Checker for client %s (command "%s") failed'
193
" with exit code %d", self.properties["Name"],
194
command, os.WEXITSTATUS(condition))
195
elif os.WIFSIGNALED(condition):
196
log.info('Checker for client %s (command "%s") was'
197
" killed by signal %d", self.properties["Name"],
198
command, os.WTERMSIG(condition))
201
def checker_started(self, command):
202
"""Server signals that a checker started."""
203
log.debug('Client %s started checker "%s"',
204
self.properties["Name"], command)
206
def got_secret(self):
207
log.info("Client %s received its secret",
208
self.properties["Name"])
210
def need_approval(self, timeout, default):
212
message = "Client %s needs approval within %f seconds"
214
message = "Client %s will get its secret in %f seconds"
215
log.info(message, self.properties["Name"], timeout/1000)
217
def rejected(self, reason):
218
log.info("Client %s was rejected; reason: %s",
219
self.properties["Name"], reason)
221
def selectable(self):
222
"""Make this a "selectable" widget.
223
This overrides the method from urwid.FlowWidget."""
226
def rows(self, maxcolrow, focus=False):
227
"""How many rows this widget will occupy might depend on
228
whether we have focus or not.
229
This overrides the method from urwid.FlowWidget"""
230
return self.current_widget(focus).rows(maxcolrow, focus=focus)
232
def current_widget(self, focus=False):
233
if focus or self.opened:
234
return self._focus_widget
238
"Called when what is visible on the screen should be updated."
239
# How to add standout mode to a style
240
with_standout = {"normal": "standout",
241
"bold": "bold-standout",
243
"underline-blink-standout",
244
"bold-underline-blink":
245
"bold-underline-blink-standout",
248
# Rebuild focus and non-focus widgets using current properties
250
# Base part of a client. Name!
251
base = "{name}: ".format(name=self.properties["Name"])
252
if not self.properties["Enabled"]:
254
self.using_timer(False)
255
elif self.properties["ApprovalPending"]:
256
timeout = datetime.timedelta(
257
milliseconds=self.properties["ApprovalDelay"])
258
last_approval_request = isoformat_to_datetime(
259
self.properties["LastApprovalRequest"])
260
if last_approval_request is not None:
261
timer = max(timeout - (datetime.datetime.utcnow()
262
- last_approval_request),
263
datetime.timedelta())
265
timer = datetime.timedelta()
266
if self.properties["ApprovedByDefault"]:
267
message = "Approval in {}. (d)eny?"
269
message = "Denial in {}. (a)pprove?"
270
message = message.format(str(timer).rsplit(".", 1)[0])
271
self.using_timer(True)
272
elif self.properties["LastCheckerStatus"] != 0:
273
# When checker has failed, show timer until client expires
274
expires = self.properties["Expires"]
276
timer = datetime.timedelta(0)
278
expires = (datetime.datetime.strptime
279
(expires, "%Y-%m-%dT%H:%M:%S.%f"))
280
timer = max(expires - datetime.datetime.utcnow(),
281
datetime.timedelta())
282
message = ("A checker has failed! Time until client"
284
.format(str(timer).rsplit(".", 1)[0]))
285
self.using_timer(True)
288
self.using_timer(False)
289
self._text = "{}{}".format(base, message)
291
if not urwid.supports_unicode():
292
self._text = self._text.encode("ascii", "replace")
293
textlist = [("normal", self._text)]
294
self._text_widget.set_text(textlist)
295
self._focus_text_widget.set_text([(with_standout[text[0]],
297
if isinstance(text, tuple)
299
for text in textlist])
300
self._widget = self._text_widget
301
self._focus_widget = urwid.AttrWrap(self._focus_text_widget,
303
# Run update hook, if any
304
if self.update_hook is not None:
307
def update_timer(self):
308
"""called by GLib. Will indefinitely loop until
309
GLib.source_remove() on tag is called
312
return True # Keep calling this
314
def delete(self, **kwargs):
315
if self._update_timer_callback_tag is not None:
316
GLib.source_remove(self._update_timer_callback_tag)
317
self._update_timer_callback_tag = None
318
for match in self.match_objects:
320
self.match_objects = ()
321
if self.delete_hook is not None:
322
self.delete_hook(self)
323
return super(MandosClientWidget, self).delete(**kwargs)
325
def render(self, maxcolrow, focus=False):
326
"""Render differently if we have focus.
327
This overrides the method from urwid.FlowWidget"""
328
return self.current_widget(focus).render(maxcolrow,
331
def keypress(self, maxcolrow, key):
333
This overrides the method from urwid.FlowWidget"""
335
self.proxy.Set(client_interface, "Enabled",
336
dbus.Boolean(True), ignore_reply=True,
337
dbus_interface=dbus.PROPERTIES_IFACE)
339
self.proxy.Set(client_interface, "Enabled", False,
341
dbus_interface=dbus.PROPERTIES_IFACE)
343
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
344
dbus_interface=client_interface,
347
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
348
dbus_interface=client_interface,
350
elif key == "R" or key == "_" or key == "ctrl k":
351
self.server_proxy_object.RemoveClient(self.proxy
355
self.proxy.Set(client_interface, "CheckerRunning",
356
dbus.Boolean(True), ignore_reply=True,
357
dbus_interface=dbus.PROPERTIES_IFACE)
359
self.proxy.Set(client_interface, "CheckerRunning",
360
dbus.Boolean(False), ignore_reply=True,
361
dbus_interface=dbus.PROPERTIES_IFACE)
363
self.proxy.CheckedOK(dbus_interface=client_interface,
366
# elif key == "p" or key == "=":
368
# elif key == "u" or key == ":":
369
# self.proxy.unpause()
375
def properties_changed(self, interface, properties, invalidated):
376
"""Call self.update() if any properties changed.
377
This overrides the method from MandosClientPropertyCache"""
378
old_values = {key: self.properties.get(key)
379
for key in properties.keys()}
380
super(MandosClientWidget, self).properties_changed(
381
interface, properties, invalidated)
382
if any(old_values[key] != self.properties.get(key)
383
for key in old_values):
387
def glib_safely(func, retval=True):
388
def safe_func(*args, **kwargs):
390
return func(*args, **kwargs)
397
class ConstrainedListBox(urwid.ListBox):
398
"""Like a normal urwid.ListBox, but will consume all "up" or
399
"down" key presses, thus not allowing any containing widgets to
400
use them as an excuse to shift focus away from this widget.
402
def keypress(self, *args, **kwargs):
403
ret = (super(ConstrainedListBox, self)
404
.keypress(*args, **kwargs))
405
if ret in ("up", "down"):
411
"""This is the entire user interface - the whole screen
412
with boxes, lists of client widgets, etc.
414
def __init__(self, max_log_length=1000):
415
DBusGMainLoop(set_as_default=True)
417
self.screen = urwid.curses_display.Screen()
419
self.screen.register_palette((
421
"default", "default", None),
423
"bold", "default", "bold"),
425
"underline,blink", "default", "underline,blink"),
427
"standout", "default", "standout"),
428
("bold-underline-blink",
429
"bold,underline,blink", "default",
430
"bold,underline,blink"),
432
"bold,standout", "default", "bold,standout"),
433
("underline-blink-standout",
434
"underline,blink,standout", "default",
435
"underline,blink,standout"),
436
("bold-underline-blink-standout",
437
"bold,underline,blink,standout", "default",
438
"bold,underline,blink,standout"),
441
if urwid.supports_unicode():
442
self.divider = "─" # \u2500
444
self.divider = "_" # \u005f
448
self.size = self.screen.get_cols_rows()
450
self.clients = urwid.SimpleListWalker([])
451
self.clients_dict = {}
453
# We will add Text widgets to this list
454
self.log = urwid.SimpleListWalker([])
455
self.max_log_length = max_log_length
457
# We keep a reference to the log widget so we can remove it
458
# from the ListWalker without it getting destroyed
459
self.logbox = ConstrainedListBox(self.log)
461
# This keeps track of whether self.uilist currently has
462
# self.logbox in it or not
463
self.log_visible = True
464
self.log_wrap = "any"
466
self.loghandler = UILogHandler(self)
469
self.add_log_line(("bold",
470
"Mandos Monitor version " + version))
471
self.add_log_line(("bold", "q: Quit ?: Help"))
473
self.busname = domain + ".Mandos"
474
self.main_loop = GLib.MainLoop()
476
def client_not_found(self, key_id, address):
477
log.info("Client with address %s and key ID %s could"
478
" not be found", address, key_id)
481
"""This rebuilds the User Interface.
482
Call this when the widget layout needs to change"""
484
# self.uilist.append(urwid.ListBox(self.clients))
485
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
487
# header=urwid.Divider(),
489
footer=urwid.Divider(
490
div_char=self.divider)))
492
self.uilist.append(self.logbox)
493
self.topwidget = urwid.Pile(self.uilist)
495
def add_log_line(self, markup):
496
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
497
if self.max_log_length:
498
if len(self.log) > self.max_log_length:
499
del self.log[0:(len(self.log) - self.max_log_length)]
500
self.logbox.set_focus(len(self.logbox.body.contents)-1,
504
def toggle_log_display(self):
505
"""Toggle visibility of the log buffer."""
506
self.log_visible = not self.log_visible
508
log.debug("Log visibility changed to: %s", self.log_visible)
510
def change_log_display(self):
511
"""Change type of log display.
512
Currently, this toggles wrapping of text lines."""
513
if self.log_wrap == "clip":
514
self.log_wrap = "any"
516
self.log_wrap = "clip"
517
for textwidget in self.log:
518
textwidget.set_wrap_mode(self.log_wrap)
519
log.debug("Wrap mode: %s", self.log_wrap)
521
def find_and_remove_client(self, path, interfaces):
522
"""Find a client by its object path and remove it.
524
This is connected to the InterfacesRemoved signal from the
525
Mandos server object."""
526
if client_interface not in interfaces:
527
# Not a Mandos client object; ignore
530
client = self.clients_dict[path]
533
log.warning("Unknown client %s removed", path)
537
def add_new_client(self, path, ifs_and_props):
538
"""Find a client by its object path and remove it.
540
This is connected to the InterfacesAdded signal from the
541
Mandos server object.
543
if client_interface not in ifs_and_props:
544
# Not a Mandos client object; ignore
546
client_proxy_object = self.bus.get_object(self.busname, path)
547
self.add_client(MandosClientWidget(
548
server_proxy_object=self.mandos_serv,
549
proxy_object=client_proxy_object,
550
update_hook=self.refresh,
551
delete_hook=self.remove_client,
552
properties=dict(ifs_and_props[client_interface])),
555
def add_client(self, client, path=None):
556
self.clients.append(client)
558
path = client.proxy.object_path
559
self.clients_dict[path] = client
560
self.clients.sort(key=lambda c: c.properties["Name"])
563
def remove_client(self, client, path=None):
564
self.clients.remove(client)
566
path = client.proxy.object_path
567
del self.clients_dict[path]
571
"""Redraw the screen"""
572
canvas = self.topwidget.render(self.size, focus=True)
573
self.screen.draw_screen(self.size, canvas)
576
"""Start the main loop and exit when it's done."""
577
log.addHandler(self.loghandler)
578
self.orig_log_propagate = log.propagate
579
log.propagate = False
580
self.orig_log_level = log.level
582
self.bus = dbus.SystemBus()
583
mandos_dbus_objc = self.bus.get_object(
584
self.busname, "/", follow_name_owner_changes=True)
585
self.mandos_serv = dbus.Interface(
586
mandos_dbus_objc, dbus_interface=server_interface)
588
mandos_clients = (self.mandos_serv
589
.GetAllClientsWithProperties())
590
if not mandos_clients:
591
log.warning("Note: Server has no clients.")
592
except dbus.exceptions.DBusException:
593
log.warning("Note: No Mandos server running.")
594
mandos_clients = dbus.Dictionary()
597
.connect_to_signal("InterfacesRemoved",
598
self.find_and_remove_client,
599
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
602
.connect_to_signal("InterfacesAdded",
604
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
607
.connect_to_signal("ClientNotFound",
608
self.client_not_found,
609
dbus_interface=server_interface,
611
for path, client in mandos_clients.items():
612
client_proxy_object = self.bus.get_object(self.busname,
614
self.add_client(MandosClientWidget(
615
server_proxy_object=self.mandos_serv,
616
proxy_object=client_proxy_object,
618
update_hook=self.refresh,
619
delete_hook=self.remove_client),
623
self._input_callback_tag = (
625
GLib.IOChannel.unix_new(sys.stdin.fileno()),
626
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
627
glib_safely(self.process_input)))
629
# Main loop has finished, we should close everything now
630
GLib.source_remove(self._input_callback_tag)
631
with warnings.catch_warnings():
632
warnings.simplefilter("ignore", BytesWarning)
636
self.main_loop.quit()
637
log.removeHandler(self.loghandler)
638
log.propagate = self.orig_log_propagate
640
def process_input(self, source, condition):
641
keys = self.screen.get_input()
642
translations = {"ctrl n": "down", # Emacs
643
"ctrl p": "up", # Emacs
644
"ctrl v": "page down", # Emacs
645
"meta v": "page up", # Emacs
646
" ": "page down", # less
647
"f": "page down", # less
648
"b": "page up", # less
654
key = translations[key]
655
except KeyError: # :-)
658
if key == "q" or key == "Q":
661
elif key == "window resize":
662
self.size = self.screen.get_cols_rows()
664
elif key == "ctrl l":
667
elif key == "l" or key == "D":
668
self.toggle_log_display()
670
elif key == "w" or key == "i":
671
self.change_log_display()
673
elif key == "?" or key == "f1" or key == "esc":
674
if not self.log_visible:
675
self.log_visible = True
677
self.add_log_line(("bold",
680
"l: Log window toggle",
681
"TAB: Switch window",
682
"w: Wrap (log lines)",
683
"v: Toggle verbose log",
685
self.add_log_line(("bold",
686
" ".join(("Clients:",
690
"s: Start new checker",
698
if self.topwidget.get_focus() is self.logbox:
699
self.topwidget.set_focus(0)
701
self.topwidget.set_focus(self.logbox)
704
if log.level < logging.INFO:
705
log.setLevel(logging.INFO)
706
log.info("Verbose mode: Off")
708
log.setLevel(logging.NOTSET)
709
log.info("Verbose mode: On")
710
# elif (key == "end" or key == "meta >" or key == "G"
712
# pass # xxx end-of-buffer
713
# elif (key == "home" or key == "meta <" or key == "g"
715
# pass # xxx beginning-of-buffer
716
# elif key == "ctrl e" or key == "$":
717
# pass # xxx move-end-of-line
718
# elif key == "ctrl a" or key == "^":
719
# pass # xxx move-beginning-of-line
720
# elif key == "ctrl b" or key == "meta (" or key == "h":
722
# elif key == "ctrl f" or key == "meta )" or key == "l":
725
# pass # scroll up log
727
# pass # scroll down log
728
elif self.topwidget.selectable():
729
self.topwidget.keypress(self.size, key)
734
class UILogHandler(logging.Handler):
735
def __init__(self, ui, *args, **kwargs):
737
super(UILogHandler, self).__init__(*args, **kwargs)
739
logging.Formatter("%(asctime)s: %(message)s"))
740
def emit(self, record):
741
msg = self.format(record)
742
if record.levelno > logging.INFO:
744
self.ui.add_log_line(msg)
750
except KeyboardInterrupt:
751
with warnings.catch_warnings():
752
warnings.filterwarnings("ignore", "", BytesWarning)
755
with warnings.catch_warnings():
756
warnings.filterwarnings("ignore", "", BytesWarning)