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)
67
logging.getLogger("urwid").setLevel(logging.INFO)
69
# Some useful constants
70
domain = "se.recompile"
71
server_interface = domain + ".Mandos"
72
client_interface = domain + ".Mandos.Client"
76
dbus.OBJECT_MANAGER_IFACE
77
except AttributeError:
78
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
81
def isoformat_to_datetime(iso):
82
"Parse an ISO 8601 date string to a datetime.datetime()"
85
d, t = iso.split("T", 1)
86
year, month, day = d.split("-", 2)
87
hour, minute, second = t.split(":", 2)
88
second, fraction = divmod(float(second), 1)
89
return datetime.datetime(int(year),
94
int(second), # Whole seconds
95
int(fraction*1000000)) # Microseconds
98
class MandosClientPropertyCache:
99
"""This wraps a Mandos Client D-Bus proxy object, caches the
100
properties and calls a hook function when any of them are
103
def __init__(self, proxy_object=None, properties=None, **kwargs):
104
self.proxy = proxy_object # Mandos Client proxy object
105
self.properties = dict() if properties is None else properties
106
self.property_changed_match = (
107
self.proxy.connect_to_signal("PropertiesChanged",
108
self.properties_changed,
109
dbus.PROPERTIES_IFACE,
112
if properties is None:
113
self.properties.update(self.proxy.GetAll(
115
dbus_interface=dbus.PROPERTIES_IFACE))
117
super(MandosClientPropertyCache, self).__init__(**kwargs)
119
def properties_changed(self, interface, properties, invalidated):
120
"""This is called whenever we get a PropertiesChanged signal
121
It updates the changed properties in the "properties" dict.
123
# Update properties dict with new value
124
if interface == client_interface:
125
self.properties.update(properties)
128
self.property_changed_match.remove()
131
class MandosClientWidget(MandosClientPropertyCache, urwid.Widget):
132
"""A Mandos Client which is visible on the screen.
135
_sizing = frozenset(["flow"])
137
def __init__(self, server_proxy_object=None, update_hook=None,
138
delete_hook=None, **kwargs):
140
self.update_hook = update_hook
142
self.delete_hook = delete_hook
143
# Mandos Server proxy object
144
self.server_proxy_object = server_proxy_object
146
self._update_timer_callback_tag = None
148
# The widget shown normally
149
self._text_widget = urwid.Text("")
150
# The widget shown when we have focus
151
self._focus_text_widget = urwid.Text("")
152
super(MandosClientWidget, self).__init__(**kwargs)
156
self.match_objects = (
157
self.proxy.connect_to_signal("CheckerCompleted",
158
self.checker_completed,
161
self.proxy.connect_to_signal("CheckerStarted",
162
self.checker_started,
165
self.proxy.connect_to_signal("GotSecret",
169
self.proxy.connect_to_signal("NeedApproval",
173
self.proxy.connect_to_signal("Rejected",
177
log.debug("Created client %s", self.properties["Name"])
179
def using_timer(self, flag):
180
"""Call this method with True or False when timer should be
181
activated or deactivated.
183
if flag and self._update_timer_callback_tag is None:
184
# Will update the shown timer value every second
185
self._update_timer_callback_tag = (
186
GLib.timeout_add(1000,
187
glib_safely(self.update_timer)))
188
elif not (flag or self._update_timer_callback_tag is None):
189
GLib.source_remove(self._update_timer_callback_tag)
190
self._update_timer_callback_tag = None
192
def checker_completed(self, exitstatus, condition, command):
194
log.debug('Checker for client %s (command "%s")'
195
" succeeded", self.properties["Name"], command)
199
if os.WIFEXITED(condition):
200
log.info('Checker for client %s (command "%s") failed'
201
" with exit code %d", self.properties["Name"],
202
command, os.WEXITSTATUS(condition))
203
elif os.WIFSIGNALED(condition):
204
log.info('Checker for client %s (command "%s") was'
205
" killed by signal %d", self.properties["Name"],
206
command, os.WTERMSIG(condition))
209
def checker_started(self, command):
210
"""Server signals that a checker started."""
211
log.debug('Client %s started checker "%s"',
212
self.properties["Name"], command)
214
def got_secret(self):
215
log.info("Client %s received its secret",
216
self.properties["Name"])
218
def need_approval(self, timeout, default):
220
message = "Client %s needs approval within %f seconds"
222
message = "Client %s will get its secret in %f seconds"
223
log.info(message, self.properties["Name"], timeout/1000)
225
def rejected(self, reason):
226
log.info("Client %s was rejected; reason: %s",
227
self.properties["Name"], reason)
229
def selectable(self):
230
"""Make this a "selectable" widget.
231
This overrides the method from urwid.Widget."""
234
def rows(self, maxcolrow, focus=False):
235
"""How many rows this widget will occupy might depend on
236
whether we have focus or not.
237
This overrides the method from urwid.Widget"""
238
return self.current_widget(focus).rows(maxcolrow, focus=focus)
240
def current_widget(self, focus=False):
241
if focus or self.opened:
242
return self._focus_widget
246
"Called when what is visible on the screen should be updated."
247
# How to add standout mode to a style
248
with_standout = {"normal": "standout",
249
"bold": "bold-standout",
251
"underline-blink-standout",
252
"bold-underline-blink":
253
"bold-underline-blink-standout",
256
# Rebuild focus and non-focus widgets using current properties
258
# Base part of a client. Name!
259
base = "{name}: ".format(name=self.properties["Name"])
260
if not self.properties["Enabled"]:
262
self.using_timer(False)
263
elif self.properties["ApprovalPending"]:
264
timeout = datetime.timedelta(
265
milliseconds=self.properties["ApprovalDelay"])
266
last_approval_request = isoformat_to_datetime(
267
self.properties["LastApprovalRequest"])
268
if last_approval_request is not None:
269
timer = max(timeout - (datetime.datetime.utcnow()
270
- last_approval_request),
271
datetime.timedelta())
273
timer = datetime.timedelta()
274
if self.properties["ApprovedByDefault"]:
275
message = "Approval in {}. (d)eny?"
277
message = "Denial in {}. (a)pprove?"
278
message = message.format(str(timer).rsplit(".", 1)[0])
279
self.using_timer(True)
280
elif self.properties["LastCheckerStatus"] != 0:
281
# When checker has failed, show timer until client expires
282
expires = self.properties["Expires"]
284
timer = datetime.timedelta(0)
286
expires = (datetime.datetime.strptime
287
(expires, "%Y-%m-%dT%H:%M:%S.%f"))
288
timer = max(expires - datetime.datetime.utcnow(),
289
datetime.timedelta())
290
message = ("A checker has failed! Time until client"
292
.format(str(timer).rsplit(".", 1)[0]))
293
self.using_timer(True)
296
self.using_timer(False)
297
self._text = "{}{}".format(base, message)
299
if not urwid.supports_unicode():
300
self._text = self._text.encode("ascii", "replace")
301
textlist = [("normal", self._text)]
302
self._text_widget.set_text(textlist)
303
self._focus_text_widget.set_text([(with_standout[text[0]],
305
if isinstance(text, tuple)
307
for text in textlist])
308
self._widget = self._text_widget
309
self._focus_widget = urwid.AttrWrap(self._focus_text_widget,
311
# Run update hook, if any
312
if self.update_hook is not None:
315
def update_timer(self):
316
"""called by GLib. Will indefinitely loop until
317
GLib.source_remove() on tag is called
320
return True # Keep calling this
322
def delete(self, **kwargs):
323
if self._update_timer_callback_tag is not None:
324
GLib.source_remove(self._update_timer_callback_tag)
325
self._update_timer_callback_tag = None
326
for match in self.match_objects:
328
self.match_objects = ()
329
if self.delete_hook is not None:
330
self.delete_hook(self)
331
return super(MandosClientWidget, self).delete(**kwargs)
333
def render(self, maxcolrow, focus=False):
334
"""Render differently if we have focus.
335
This overrides the method from urwid.Widget"""
336
return self.current_widget(focus).render(maxcolrow,
339
def keypress(self, maxcolrow, key):
341
This overrides the method from urwid.Widget"""
343
self.proxy.Set(client_interface, "Enabled",
344
dbus.Boolean(True), ignore_reply=True,
345
dbus_interface=dbus.PROPERTIES_IFACE)
347
self.proxy.Set(client_interface, "Enabled", False,
349
dbus_interface=dbus.PROPERTIES_IFACE)
351
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
352
dbus_interface=client_interface,
355
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
356
dbus_interface=client_interface,
358
elif key == "R" or key == "_" or key == "ctrl k":
359
self.server_proxy_object.RemoveClient(self.proxy
363
self.proxy.Set(client_interface, "CheckerRunning",
364
dbus.Boolean(True), ignore_reply=True,
365
dbus_interface=dbus.PROPERTIES_IFACE)
367
self.proxy.Set(client_interface, "CheckerRunning",
368
dbus.Boolean(False), ignore_reply=True,
369
dbus_interface=dbus.PROPERTIES_IFACE)
371
self.proxy.CheckedOK(dbus_interface=client_interface,
374
# elif key == "p" or key == "=":
376
# elif key == "u" or key == ":":
377
# self.proxy.unpause()
383
def properties_changed(self, interface, properties, invalidated):
384
"""Call self.update() if any properties changed.
385
This overrides the method from MandosClientPropertyCache"""
386
old_values = {key: self.properties.get(key)
387
for key in properties.keys()}
388
super(MandosClientWidget, self).properties_changed(
389
interface, properties, invalidated)
390
if any(old_values[key] != self.properties.get(key)
391
for key in old_values):
395
def glib_safely(func, retval=True):
396
def safe_func(*args, **kwargs):
398
return func(*args, **kwargs)
405
class ConstrainedListBox(urwid.ListBox):
406
"""Like a normal urwid.ListBox, but will consume all "up" or
407
"down" key presses, thus not allowing any containing widgets to
408
use them as an excuse to shift focus away from this widget.
410
def keypress(self, *args, **kwargs):
411
ret = (super(ConstrainedListBox, self)
412
.keypress(*args, **kwargs))
413
if ret in ("up", "down"):
419
"""This is the entire user interface - the whole screen
420
with boxes, lists of client widgets, etc.
422
def __init__(self, max_log_length=1000):
423
DBusGMainLoop(set_as_default=True)
425
self.screen = urwid.curses_display.Screen()
427
self.screen.register_palette((
429
"default", "default", None),
431
"bold", "default", "bold"),
433
"underline,blink", "default", "underline,blink"),
435
"standout", "default", "standout"),
436
("bold-underline-blink",
437
"bold,underline,blink", "default",
438
"bold,underline,blink"),
440
"bold,standout", "default", "bold,standout"),
441
("underline-blink-standout",
442
"underline,blink,standout", "default",
443
"underline,blink,standout"),
444
("bold-underline-blink-standout",
445
"bold,underline,blink,standout", "default",
446
"bold,underline,blink,standout"),
449
if urwid.supports_unicode():
450
self.divider = "─" # \u2500
452
self.divider = "_" # \u005f
456
self.size = self.screen.get_cols_rows()
458
self.clients = urwid.SimpleListWalker([])
459
self.clients_dict = {}
461
# We will add Text widgets to this list
462
self.log = urwid.SimpleListWalker([])
463
self.max_log_length = max_log_length
465
# We keep a reference to the log widget so we can remove it
466
# from the ListWalker without it getting destroyed
467
self.logbox = ConstrainedListBox(self.log)
469
# This keeps track of whether self.uilist currently has
470
# self.logbox in it or not
471
self.log_visible = True
472
self.log_wrap = "any"
474
self.loghandler = UILogHandler(self)
477
self.add_log_line(("bold",
478
"Mandos Monitor version " + version))
479
self.add_log_line(("bold", "q: Quit ?: Help"))
481
self.busname = domain + ".Mandos"
482
self.main_loop = GLib.MainLoop()
484
def client_not_found(self, key_id, address):
485
log.info("Client with address %s and key ID %s could"
486
" not be found", address, key_id)
489
"""This rebuilds the User Interface.
490
Call this when the widget layout needs to change"""
492
# self.uilist.append(urwid.ListBox(self.clients))
493
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
495
# header=urwid.Divider(),
497
footer=urwid.Divider(
498
div_char=self.divider)))
500
self.uilist.append(self.logbox)
501
self.topwidget = urwid.Pile(self.uilist)
503
def add_log_line(self, markup):
504
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
505
if self.max_log_length:
506
if len(self.log) > self.max_log_length:
507
del self.log[0:(len(self.log) - self.max_log_length)]
508
self.logbox.set_focus(len(self.logbox.body.contents)-1,
512
def toggle_log_display(self):
513
"""Toggle visibility of the log buffer."""
514
self.log_visible = not self.log_visible
516
log.debug("Log visibility changed to: %s", self.log_visible)
518
def change_log_display(self):
519
"""Change type of log display.
520
Currently, this toggles wrapping of text lines."""
521
if self.log_wrap == "clip":
522
self.log_wrap = "any"
524
self.log_wrap = "clip"
525
for textwidget in self.log:
526
textwidget.set_wrap_mode(self.log_wrap)
527
log.debug("Wrap mode: %s", self.log_wrap)
529
def find_and_remove_client(self, path, interfaces):
530
"""Find a client by its object path and remove it.
532
This is connected to the InterfacesRemoved signal from the
533
Mandos server object."""
534
if client_interface not in interfaces:
535
# Not a Mandos client object; ignore
538
client = self.clients_dict[path]
541
log.warning("Unknown client %s removed", path)
545
def add_new_client(self, path, ifs_and_props):
546
"""Find a client by its object path and remove it.
548
This is connected to the InterfacesAdded signal from the
549
Mandos server object.
551
if client_interface not in ifs_and_props:
552
# Not a Mandos client object; ignore
554
client_proxy_object = self.bus.get_object(self.busname, path)
555
self.add_client(MandosClientWidget(
556
server_proxy_object=self.mandos_serv,
557
proxy_object=client_proxy_object,
558
update_hook=self.refresh,
559
delete_hook=self.remove_client,
560
properties=dict(ifs_and_props[client_interface])),
563
def add_client(self, client, path=None):
564
self.clients.append(client)
566
path = client.proxy.object_path
567
self.clients_dict[path] = client
568
self.clients.sort(key=lambda c: c.properties["Name"])
571
def remove_client(self, client, path=None):
572
self.clients.remove(client)
574
path = client.proxy.object_path
575
del self.clients_dict[path]
579
"""Redraw the screen"""
580
canvas = self.topwidget.render(self.size, focus=True)
581
self.screen.draw_screen(self.size, canvas)
584
"""Start the main loop and exit when it's done."""
585
log.addHandler(self.loghandler)
586
self.orig_log_propagate = log.propagate
587
log.propagate = False
588
self.orig_log_level = log.level
590
self.bus = dbus.SystemBus()
591
mandos_dbus_objc = self.bus.get_object(
592
self.busname, "/", follow_name_owner_changes=True)
593
self.mandos_serv = dbus.Interface(
594
mandos_dbus_objc, dbus_interface=server_interface)
596
mandos_clients = (self.mandos_serv
597
.GetAllClientsWithProperties())
598
if not mandos_clients:
599
log.warning("Note: Server has no clients.")
600
except dbus.exceptions.DBusException:
601
log.warning("Note: No Mandos server running.")
602
mandos_clients = dbus.Dictionary()
605
.connect_to_signal("InterfacesRemoved",
606
self.find_and_remove_client,
607
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
610
.connect_to_signal("InterfacesAdded",
612
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
615
.connect_to_signal("ClientNotFound",
616
self.client_not_found,
617
dbus_interface=server_interface,
619
for path, client in mandos_clients.items():
620
client_proxy_object = self.bus.get_object(self.busname,
622
self.add_client(MandosClientWidget(
623
server_proxy_object=self.mandos_serv,
624
proxy_object=client_proxy_object,
626
update_hook=self.refresh,
627
delete_hook=self.remove_client),
631
self._input_callback_tag = (
633
GLib.IOChannel.unix_new(sys.stdin.fileno()),
634
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
635
glib_safely(self.process_input)))
637
# Main loop has finished, we should close everything now
638
GLib.source_remove(self._input_callback_tag)
639
with warnings.catch_warnings():
640
warnings.simplefilter("ignore", BytesWarning)
644
self.main_loop.quit()
645
log.removeHandler(self.loghandler)
646
log.propagate = self.orig_log_propagate
648
def process_input(self, source, condition):
649
keys = self.screen.get_input()
650
translations = {"ctrl n": "down", # Emacs
651
"ctrl p": "up", # Emacs
652
"ctrl v": "page down", # Emacs
653
"meta v": "page up", # Emacs
654
" ": "page down", # less
655
"f": "page down", # less
656
"b": "page up", # less
662
key = translations[key]
663
except KeyError: # :-)
666
if key == "q" or key == "Q":
669
elif key == "window resize":
670
self.size = self.screen.get_cols_rows()
672
elif key == "ctrl l":
675
elif key == "l" or key == "D":
676
self.toggle_log_display()
678
elif key == "w" or key == "i":
679
self.change_log_display()
681
elif key == "?" or key == "f1" or key == "esc":
682
if not self.log_visible:
683
self.log_visible = True
685
self.add_log_line(("bold",
688
"l: Log window toggle",
689
"TAB: Switch window",
690
"w: Wrap (log lines)",
691
"v: Toggle verbose log",
693
self.add_log_line(("bold",
694
" ".join(("Clients:",
698
"s: Start new checker",
706
if self.topwidget.get_focus() is self.logbox:
707
self.topwidget.set_focus(0)
709
self.topwidget.set_focus(self.logbox)
712
if log.level < logging.INFO:
713
log.setLevel(logging.INFO)
714
log.info("Verbose mode: Off")
716
log.setLevel(logging.NOTSET)
717
log.info("Verbose mode: On")
718
# elif (key == "end" or key == "meta >" or key == "G"
720
# pass # xxx end-of-buffer
721
# elif (key == "home" or key == "meta <" or key == "g"
723
# pass # xxx beginning-of-buffer
724
# elif key == "ctrl e" or key == "$":
725
# pass # xxx move-end-of-line
726
# elif key == "ctrl a" or key == "^":
727
# pass # xxx move-beginning-of-line
728
# elif key == "ctrl b" or key == "meta (" or key == "h":
730
# elif key == "ctrl f" or key == "meta )" or key == "l":
733
# pass # scroll up log
735
# pass # scroll down log
736
elif self.topwidget.selectable():
737
self.topwidget.keypress(self.size, key)
742
class UILogHandler(logging.Handler):
743
def __init__(self, ui, *args, **kwargs):
745
super(UILogHandler, self).__init__(*args, **kwargs)
747
logging.Formatter("%(asctime)s: %(message)s"))
748
def emit(self, record):
749
msg = self.format(record)
750
if record.levelno > logging.INFO:
752
self.ui.add_log_line(msg)
758
except KeyboardInterrupt:
759
with warnings.catch_warnings():
760
warnings.filterwarnings("ignore", "", BytesWarning)
763
with warnings.catch_warnings():
764
warnings.filterwarnings("ignore", "", BytesWarning)