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:
52
log = logging.getLogger(os.path.basename(sys.argv[0]))
53
logging.basicConfig(level="NOTSET", # Show all messages
54
format="%(message)s") # Show basic log messages
56
logging.captureWarnings(True) # Show warnings via the logging system
58
locale.setlocale(locale.LC_ALL, "")
60
logging.getLogger("dbus.proxies").setLevel(logging.CRITICAL)
62
# Some useful constants
63
domain = "se.recompile"
64
server_interface = domain + ".Mandos"
65
client_interface = domain + ".Mandos.Client"
69
dbus.OBJECT_MANAGER_IFACE
70
except AttributeError:
71
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
74
def isoformat_to_datetime(iso):
75
"Parse an ISO 8601 date string to a datetime.datetime()"
78
d, t = iso.split("T", 1)
79
year, month, day = d.split("-", 2)
80
hour, minute, second = t.split(":", 2)
81
second, fraction = divmod(float(second), 1)
82
return datetime.datetime(int(year),
87
int(second), # Whole seconds
88
int(fraction*1000000)) # Microseconds
91
class MandosClientPropertyCache(object):
92
"""This wraps a Mandos Client D-Bus proxy object, caches the
93
properties and calls a hook function when any of them are
96
def __init__(self, proxy_object=None, properties=None, **kwargs):
97
self.proxy = proxy_object # Mandos Client proxy object
98
self.properties = dict() if properties is None else properties
99
self.property_changed_match = (
100
self.proxy.connect_to_signal("PropertiesChanged",
101
self.properties_changed,
102
dbus.PROPERTIES_IFACE,
105
if properties is None:
106
self.properties.update(self.proxy.GetAll(
108
dbus_interface=dbus.PROPERTIES_IFACE))
110
super(MandosClientPropertyCache, self).__init__(**kwargs)
112
def properties_changed(self, interface, properties, invalidated):
113
"""This is called whenever we get a PropertiesChanged signal
114
It updates the changed properties in the "properties" dict.
116
# Update properties dict with new value
117
if interface == client_interface:
118
self.properties.update(properties)
121
self.property_changed_match.remove()
124
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
125
"""A Mandos Client which is visible on the screen.
128
def __init__(self, server_proxy_object=None, update_hook=None,
129
delete_hook=None, **kwargs):
131
self.update_hook = update_hook
133
self.delete_hook = delete_hook
134
# Mandos Server proxy object
135
self.server_proxy_object = server_proxy_object
137
self._update_timer_callback_tag = None
139
# The widget shown normally
140
self._text_widget = urwid.Text("")
141
# The widget shown when we have focus
142
self._focus_text_widget = urwid.Text("")
143
super(MandosClientWidget, self).__init__(**kwargs)
147
self.match_objects = (
148
self.proxy.connect_to_signal("CheckerCompleted",
149
self.checker_completed,
152
self.proxy.connect_to_signal("CheckerStarted",
153
self.checker_started,
156
self.proxy.connect_to_signal("GotSecret",
160
self.proxy.connect_to_signal("NeedApproval",
164
self.proxy.connect_to_signal("Rejected",
168
log.debug("Created client %s", self.properties["Name"])
170
def using_timer(self, flag):
171
"""Call this method with True or False when timer should be
172
activated or deactivated.
174
if flag and self._update_timer_callback_tag is None:
175
# Will update the shown timer value every second
176
self._update_timer_callback_tag = (
177
GLib.timeout_add(1000,
178
glib_safely(self.update_timer)))
179
elif not (flag or self._update_timer_callback_tag is None):
180
GLib.source_remove(self._update_timer_callback_tag)
181
self._update_timer_callback_tag = None
183
def checker_completed(self, exitstatus, condition, command):
185
log.debug('Checker for client %s (command "%s")'
186
" succeeded", self.properties["Name"], command)
190
if os.WIFEXITED(condition):
191
log.info('Checker for client %s (command "%s") failed'
192
" with exit code %d", self.properties["Name"],
193
command, os.WEXITSTATUS(condition))
194
elif os.WIFSIGNALED(condition):
195
log.info('Checker for client %s (command "%s") was'
196
" killed by signal %d", self.properties["Name"],
197
command, os.WTERMSIG(condition))
200
def checker_started(self, command):
201
"""Server signals that a checker started."""
202
log.debug('Client %s started checker "%s"',
203
self.properties["Name"], command)
205
def got_secret(self):
206
log.info("Client %s received its secret",
207
self.properties["Name"])
209
def need_approval(self, timeout, default):
211
message = "Client %s needs approval within %f seconds"
213
message = "Client %s will get its secret in %f seconds"
214
log.info(message, self.properties["Name"], timeout/1000)
216
def rejected(self, reason):
217
log.info("Client %s was rejected; reason: %s",
218
self.properties["Name"], reason)
220
def selectable(self):
221
"""Make this a "selectable" widget.
222
This overrides the method from urwid.FlowWidget."""
225
def rows(self, maxcolrow, focus=False):
226
"""How many rows this widget will occupy might depend on
227
whether we have focus or not.
228
This overrides the method from urwid.FlowWidget"""
229
return self.current_widget(focus).rows(maxcolrow, focus=focus)
231
def current_widget(self, focus=False):
232
if focus or self.opened:
233
return self._focus_widget
237
"Called when what is visible on the screen should be updated."
238
# How to add standout mode to a style
239
with_standout = {"normal": "standout",
240
"bold": "bold-standout",
242
"underline-blink-standout",
243
"bold-underline-blink":
244
"bold-underline-blink-standout",
247
# Rebuild focus and non-focus widgets using current properties
249
# Base part of a client. Name!
250
base = "{name}: ".format(name=self.properties["Name"])
251
if not self.properties["Enabled"]:
253
self.using_timer(False)
254
elif self.properties["ApprovalPending"]:
255
timeout = datetime.timedelta(
256
milliseconds=self.properties["ApprovalDelay"])
257
last_approval_request = isoformat_to_datetime(
258
self.properties["LastApprovalRequest"])
259
if last_approval_request is not None:
260
timer = max(timeout - (datetime.datetime.utcnow()
261
- last_approval_request),
262
datetime.timedelta())
264
timer = datetime.timedelta()
265
if self.properties["ApprovedByDefault"]:
266
message = "Approval in {}. (d)eny?"
268
message = "Denial in {}. (a)pprove?"
269
message = message.format(str(timer).rsplit(".", 1)[0])
270
self.using_timer(True)
271
elif self.properties["LastCheckerStatus"] != 0:
272
# When checker has failed, show timer until client expires
273
expires = self.properties["Expires"]
275
timer = datetime.timedelta(0)
277
expires = (datetime.datetime.strptime
278
(expires, "%Y-%m-%dT%H:%M:%S.%f"))
279
timer = max(expires - datetime.datetime.utcnow(),
280
datetime.timedelta())
281
message = ("A checker has failed! Time until client"
283
.format(str(timer).rsplit(".", 1)[0]))
284
self.using_timer(True)
287
self.using_timer(False)
288
self._text = "{}{}".format(base, message)
290
if not urwid.supports_unicode():
291
self._text = self._text.encode("ascii", "replace")
292
textlist = [("normal", self._text)]
293
self._text_widget.set_text(textlist)
294
self._focus_text_widget.set_text([(with_standout[text[0]],
296
if isinstance(text, tuple)
298
for text in textlist])
299
self._widget = self._text_widget
300
self._focus_widget = urwid.AttrWrap(self._focus_text_widget,
302
# Run update hook, if any
303
if self.update_hook is not None:
306
def update_timer(self):
307
"""called by GLib. Will indefinitely loop until
308
GLib.source_remove() on tag is called
311
return True # Keep calling this
313
def delete(self, **kwargs):
314
if self._update_timer_callback_tag is not None:
315
GLib.source_remove(self._update_timer_callback_tag)
316
self._update_timer_callback_tag = None
317
for match in self.match_objects:
319
self.match_objects = ()
320
if self.delete_hook is not None:
321
self.delete_hook(self)
322
return super(MandosClientWidget, self).delete(**kwargs)
324
def render(self, maxcolrow, focus=False):
325
"""Render differently if we have focus.
326
This overrides the method from urwid.FlowWidget"""
327
return self.current_widget(focus).render(maxcolrow,
330
def keypress(self, maxcolrow, key):
332
This overrides the method from urwid.FlowWidget"""
334
self.proxy.Set(client_interface, "Enabled",
335
dbus.Boolean(True), ignore_reply=True,
336
dbus_interface=dbus.PROPERTIES_IFACE)
338
self.proxy.Set(client_interface, "Enabled", False,
340
dbus_interface=dbus.PROPERTIES_IFACE)
342
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
343
dbus_interface=client_interface,
346
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
347
dbus_interface=client_interface,
349
elif key == "R" or key == "_" or key == "ctrl k":
350
self.server_proxy_object.RemoveClient(self.proxy
354
self.proxy.Set(client_interface, "CheckerRunning",
355
dbus.Boolean(True), ignore_reply=True,
356
dbus_interface=dbus.PROPERTIES_IFACE)
358
self.proxy.Set(client_interface, "CheckerRunning",
359
dbus.Boolean(False), ignore_reply=True,
360
dbus_interface=dbus.PROPERTIES_IFACE)
362
self.proxy.CheckedOK(dbus_interface=client_interface,
365
# elif key == "p" or key == "=":
367
# elif key == "u" or key == ":":
368
# self.proxy.unpause()
374
def properties_changed(self, interface, properties, invalidated):
375
"""Call self.update() if any properties changed.
376
This overrides the method from MandosClientPropertyCache"""
377
old_values = {key: self.properties.get(key)
378
for key in properties.keys()}
379
super(MandosClientWidget, self).properties_changed(
380
interface, properties, invalidated)
381
if any(old_values[key] != self.properties.get(key)
382
for key in old_values):
386
def glib_safely(func, retval=True):
387
def safe_func(*args, **kwargs):
389
return func(*args, **kwargs)
396
class ConstrainedListBox(urwid.ListBox):
397
"""Like a normal urwid.ListBox, but will consume all "up" or
398
"down" key presses, thus not allowing any containing widgets to
399
use them as an excuse to shift focus away from this widget.
401
def keypress(self, *args, **kwargs):
402
ret = (super(ConstrainedListBox, self)
403
.keypress(*args, **kwargs))
404
if ret in ("up", "down"):
409
class UserInterface(object):
410
"""This is the entire user interface - the whole screen
411
with boxes, lists of client widgets, etc.
413
def __init__(self, max_log_length=1000):
414
DBusGMainLoop(set_as_default=True)
416
self.screen = urwid.curses_display.Screen()
418
self.screen.register_palette((
420
"default", "default", None),
422
"bold", "default", "bold"),
424
"underline,blink", "default", "underline,blink"),
426
"standout", "default", "standout"),
427
("bold-underline-blink",
428
"bold,underline,blink", "default",
429
"bold,underline,blink"),
431
"bold,standout", "default", "bold,standout"),
432
("underline-blink-standout",
433
"underline,blink,standout", "default",
434
"underline,blink,standout"),
435
("bold-underline-blink-standout",
436
"bold,underline,blink,standout", "default",
437
"bold,underline,blink,standout"),
440
if urwid.supports_unicode():
441
self.divider = "─" # \u2500
443
self.divider = "_" # \u005f
447
self.size = self.screen.get_cols_rows()
449
self.clients = urwid.SimpleListWalker([])
450
self.clients_dict = {}
452
# We will add Text widgets to this list
453
self.log = urwid.SimpleListWalker([])
454
self.max_log_length = max_log_length
456
# We keep a reference to the log widget so we can remove it
457
# from the ListWalker without it getting destroyed
458
self.logbox = ConstrainedListBox(self.log)
460
# This keeps track of whether self.uilist currently has
461
# self.logbox in it or not
462
self.log_visible = True
463
self.log_wrap = "any"
465
self.loghandler = UILogHandler(self)
468
self.add_log_line(("bold",
469
"Mandos Monitor version " + version))
470
self.add_log_line(("bold", "q: Quit ?: Help"))
472
self.busname = domain + ".Mandos"
473
self.main_loop = GLib.MainLoop()
475
def client_not_found(self, key_id, address):
476
log.info("Client with address %s and key ID %s could"
477
" not be found", address, key_id)
480
"""This rebuilds the User Interface.
481
Call this when the widget layout needs to change"""
483
# self.uilist.append(urwid.ListBox(self.clients))
484
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
486
# header=urwid.Divider(),
488
footer=urwid.Divider(
489
div_char=self.divider)))
491
self.uilist.append(self.logbox)
492
self.topwidget = urwid.Pile(self.uilist)
494
def add_log_line(self, markup):
495
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
496
if self.max_log_length:
497
if len(self.log) > self.max_log_length:
498
del self.log[0:(len(self.log) - self.max_log_length)]
499
self.logbox.set_focus(len(self.logbox.body.contents)-1,
503
def toggle_log_display(self):
504
"""Toggle visibility of the log buffer."""
505
self.log_visible = not self.log_visible
507
log.debug("Log visibility changed to: %s", self.log_visible)
509
def change_log_display(self):
510
"""Change type of log display.
511
Currently, this toggles wrapping of text lines."""
512
if self.log_wrap == "clip":
513
self.log_wrap = "any"
515
self.log_wrap = "clip"
516
for textwidget in self.log:
517
textwidget.set_wrap_mode(self.log_wrap)
518
log.debug("Wrap mode: %s", self.log_wrap)
520
def find_and_remove_client(self, path, interfaces):
521
"""Find a client by its object path and remove it.
523
This is connected to the InterfacesRemoved signal from the
524
Mandos server object."""
525
if client_interface not in interfaces:
526
# Not a Mandos client object; ignore
529
client = self.clients_dict[path]
532
log.warning("Unknown client %s removed", path)
536
def add_new_client(self, path, ifs_and_props):
537
"""Find a client by its object path and remove it.
539
This is connected to the InterfacesAdded signal from the
540
Mandos server object.
542
if client_interface not in ifs_and_props:
543
# Not a Mandos client object; ignore
545
client_proxy_object = self.bus.get_object(self.busname, path)
546
self.add_client(MandosClientWidget(
547
server_proxy_object=self.mandos_serv,
548
proxy_object=client_proxy_object,
549
update_hook=self.refresh,
550
delete_hook=self.remove_client,
551
properties=dict(ifs_and_props[client_interface])),
554
def add_client(self, client, path=None):
555
self.clients.append(client)
557
path = client.proxy.object_path
558
self.clients_dict[path] = client
559
self.clients.sort(key=lambda c: c.properties["Name"])
562
def remove_client(self, client, path=None):
563
self.clients.remove(client)
565
path = client.proxy.object_path
566
del self.clients_dict[path]
570
"""Redraw the screen"""
571
canvas = self.topwidget.render(self.size, focus=True)
572
self.screen.draw_screen(self.size, canvas)
575
"""Start the main loop and exit when it's done."""
576
log.addHandler(self.loghandler)
577
self.orig_log_propagate = log.propagate
578
log.propagate = False
579
self.orig_log_level = log.level
581
self.bus = dbus.SystemBus()
582
mandos_dbus_objc = self.bus.get_object(
583
self.busname, "/", follow_name_owner_changes=True)
584
self.mandos_serv = dbus.Interface(
585
mandos_dbus_objc, dbus_interface=server_interface)
587
mandos_clients = (self.mandos_serv
588
.GetAllClientsWithProperties())
589
if not mandos_clients:
590
log.warning("Note: Server has no clients.")
591
except dbus.exceptions.DBusException:
592
log.warning("Note: No Mandos server running.")
593
mandos_clients = dbus.Dictionary()
596
.connect_to_signal("InterfacesRemoved",
597
self.find_and_remove_client,
598
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
601
.connect_to_signal("InterfacesAdded",
603
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
606
.connect_to_signal("ClientNotFound",
607
self.client_not_found,
608
dbus_interface=server_interface,
610
for path, client in mandos_clients.items():
611
client_proxy_object = self.bus.get_object(self.busname,
613
self.add_client(MandosClientWidget(
614
server_proxy_object=self.mandos_serv,
615
proxy_object=client_proxy_object,
617
update_hook=self.refresh,
618
delete_hook=self.remove_client),
622
self._input_callback_tag = (
624
GLib.IOChannel.unix_new(sys.stdin.fileno()),
625
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
626
glib_safely(self.process_input)))
628
# Main loop has finished, we should close everything now
629
GLib.source_remove(self._input_callback_tag)
630
with warnings.catch_warnings():
631
warnings.simplefilter("ignore", BytesWarning)
635
self.main_loop.quit()
636
log.removeHandler(self.loghandler)
637
log.propagate = self.orig_log_propagate
639
def process_input(self, source, condition):
640
keys = self.screen.get_input()
641
translations = {"ctrl n": "down", # Emacs
642
"ctrl p": "up", # Emacs
643
"ctrl v": "page down", # Emacs
644
"meta v": "page up", # Emacs
645
" ": "page down", # less
646
"f": "page down", # less
647
"b": "page up", # less
653
key = translations[key]
654
except KeyError: # :-)
657
if key == "q" or key == "Q":
660
elif key == "window resize":
661
self.size = self.screen.get_cols_rows()
663
elif key == "ctrl l":
666
elif key == "l" or key == "D":
667
self.toggle_log_display()
669
elif key == "w" or key == "i":
670
self.change_log_display()
672
elif key == "?" or key == "f1" or key == "esc":
673
if not self.log_visible:
674
self.log_visible = True
676
self.add_log_line(("bold",
679
"l: Log window toggle",
680
"TAB: Switch window",
681
"w: Wrap (log lines)",
682
"v: Toggle verbose log",
684
self.add_log_line(("bold",
685
" ".join(("Clients:",
689
"s: Start new checker",
697
if self.topwidget.get_focus() is self.logbox:
698
self.topwidget.set_focus(0)
700
self.topwidget.set_focus(self.logbox)
703
if log.level < logging.INFO:
704
log.setLevel(logging.INFO)
705
log.info("Verbose mode: Off")
707
log.setLevel(logging.NOTSET)
708
log.info("Verbose mode: On")
709
# elif (key == "end" or key == "meta >" or key == "G"
711
# pass # xxx end-of-buffer
712
# elif (key == "home" or key == "meta <" or key == "g"
714
# pass # xxx beginning-of-buffer
715
# elif key == "ctrl e" or key == "$":
716
# pass # xxx move-end-of-line
717
# elif key == "ctrl a" or key == "^":
718
# pass # xxx move-beginning-of-line
719
# elif key == "ctrl b" or key == "meta (" or key == "h":
721
# elif key == "ctrl f" or key == "meta )" or key == "l":
724
# pass # scroll up log
726
# pass # scroll down log
727
elif self.topwidget.selectable():
728
self.topwidget.keypress(self.size, key)
733
class UILogHandler(logging.Handler):
734
def __init__(self, ui, *args, **kwargs):
736
super(UILogHandler, self).__init__(*args, **kwargs)
738
logging.Formatter("%(asctime)s: %(message)s"))
739
def emit(self, record):
740
msg = self.format(record)
741
if record.levelno > logging.INFO:
743
self.ui.add_log_line(msg)
749
except KeyboardInterrupt:
750
with warnings.catch_warnings():
751
warnings.filterwarnings("ignore", "", BytesWarning)
754
with warnings.catch_warnings():
755
warnings.filterwarnings("ignore", "", BytesWarning)