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 *
39
import urwid.curses_display
42
from dbus.mainloop.glib import DBusGMainLoop
43
from gi.repository import GLib
51
if sys.version_info.major == 2:
54
locale.setlocale(locale.LC_ALL, '')
56
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
58
# Some useful constants
59
domain = 'se.recompile'
60
server_interface = domain + '.Mandos'
61
client_interface = domain + '.Mandos.Client'
65
dbus.OBJECT_MANAGER_IFACE
66
except AttributeError:
67
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
70
def isoformat_to_datetime(iso):
71
"Parse an ISO 8601 date string to a datetime.datetime()"
74
d, t = iso.split("T", 1)
75
year, month, day = d.split("-", 2)
76
hour, minute, second = t.split(":", 2)
77
second, fraction = divmod(float(second), 1)
78
return datetime.datetime(int(year),
83
int(second), # Whole seconds
84
int(fraction*1000000)) # Microseconds
87
class MandosClientPropertyCache(object):
88
"""This wraps a Mandos Client D-Bus proxy object, caches the
89
properties and calls a hook function when any of them are
92
def __init__(self, proxy_object=None, properties=None, **kwargs):
93
self.proxy = proxy_object # Mandos Client proxy object
94
self.properties = dict() if properties is None else properties
95
self.property_changed_match = (
96
self.proxy.connect_to_signal("PropertiesChanged",
97
self.properties_changed,
98
dbus.PROPERTIES_IFACE,
101
if properties is None:
102
self.properties.update(self.proxy.GetAll(
104
dbus_interface=dbus.PROPERTIES_IFACE))
106
super(MandosClientPropertyCache, self).__init__(**kwargs)
108
def properties_changed(self, interface, properties, invalidated):
109
"""This is called whenever we get a PropertiesChanged signal
110
It updates the changed properties in the "properties" dict.
112
# Update properties dict with new value
113
if interface == client_interface:
114
self.properties.update(properties)
117
self.property_changed_match.remove()
120
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
121
"""A Mandos Client which is visible on the screen.
124
def __init__(self, server_proxy_object=None, update_hook=None,
125
delete_hook=None, logger=None, **kwargs):
127
self.update_hook = update_hook
129
self.delete_hook = delete_hook
130
# Mandos Server proxy object
131
self.server_proxy_object = server_proxy_object
135
self._update_timer_callback_tag = None
137
# The widget shown normally
138
self._text_widget = urwid.Text("")
139
# The widget shown when we have focus
140
self._focus_text_widget = urwid.Text("")
141
super(MandosClientWidget, self).__init__(**kwargs)
145
self.match_objects = (
146
self.proxy.connect_to_signal("CheckerCompleted",
147
self.checker_completed,
150
self.proxy.connect_to_signal("CheckerStarted",
151
self.checker_started,
154
self.proxy.connect_to_signal("GotSecret",
158
self.proxy.connect_to_signal("NeedApproval",
162
self.proxy.connect_to_signal("Rejected",
166
self.logger('Created client {}'
167
.format(self.properties["Name"]), level=0)
169
def using_timer(self, flag):
170
"""Call this method with True or False when timer should be
171
activated or deactivated.
173
if flag and self._update_timer_callback_tag is None:
174
# Will update the shown timer value every second
175
self._update_timer_callback_tag = (GLib.timeout_add
178
elif not (flag or self._update_timer_callback_tag is None):
179
GLib.source_remove(self._update_timer_callback_tag)
180
self._update_timer_callback_tag = None
182
def checker_completed(self, exitstatus, condition, command):
184
self.logger('Checker for client {} (command "{}")'
185
' succeeded'.format(self.properties["Name"],
190
if os.WIFEXITED(condition):
191
self.logger('Checker for client {} (command "{}") failed'
193
.format(self.properties["Name"], command,
194
os.WEXITSTATUS(condition)))
195
elif os.WIFSIGNALED(condition):
196
self.logger('Checker for client {} (command "{}") was'
197
' killed by signal {}'
198
.format(self.properties["Name"], command,
199
os.WTERMSIG(condition)))
202
def checker_started(self, command):
203
"""Server signals that a checker started."""
204
self.logger('Client {} started checker "{}"'
205
.format(self.properties["Name"],
208
def got_secret(self):
209
self.logger('Client {} received its secret'
210
.format(self.properties["Name"]))
212
def need_approval(self, timeout, default):
214
message = 'Client {} needs approval within {} seconds'
216
message = 'Client {} will get its secret in {} seconds'
217
self.logger(message.format(self.properties["Name"],
220
def rejected(self, reason):
221
self.logger('Client {} was rejected; reason: {}'
222
.format(self.properties["Name"], reason))
224
def selectable(self):
225
"""Make this a "selectable" widget.
226
This overrides the method from urwid.FlowWidget."""
229
def rows(self, maxcolrow, focus=False):
230
"""How many rows this widget will occupy might depend on
231
whether we have focus or not.
232
This overrides the method from urwid.FlowWidget"""
233
return self.current_widget(focus).rows(maxcolrow, focus=focus)
235
def current_widget(self, focus=False):
236
if focus or self.opened:
237
return self._focus_widget
241
"Called when what is visible on the screen should be updated."
242
# How to add standout mode to a style
243
with_standout = {"normal": "standout",
244
"bold": "bold-standout",
246
"underline-blink-standout",
247
"bold-underline-blink":
248
"bold-underline-blink-standout",
251
# Rebuild focus and non-focus widgets using current properties
253
# Base part of a client. Name!
254
base = '{name}: '.format(name=self.properties["Name"])
255
if not self.properties["Enabled"]:
257
self.using_timer(False)
258
elif self.properties["ApprovalPending"]:
259
timeout = datetime.timedelta(
260
milliseconds=self.properties["ApprovalDelay"])
261
last_approval_request = isoformat_to_datetime(
262
self.properties["LastApprovalRequest"])
263
if last_approval_request is not None:
264
timer = max(timeout - (datetime.datetime.utcnow()
265
- last_approval_request),
266
datetime.timedelta())
268
timer = datetime.timedelta()
269
if self.properties["ApprovedByDefault"]:
270
message = "Approval in {}. (d)eny?"
272
message = "Denial in {}. (a)pprove?"
273
message = message.format(str(timer).rsplit(".", 1)[0])
274
self.using_timer(True)
275
elif self.properties["LastCheckerStatus"] != 0:
276
# When checker has failed, show timer until client expires
277
expires = self.properties["Expires"]
279
timer = datetime.timedelta(0)
281
expires = (datetime.datetime.strptime
282
(expires, '%Y-%m-%dT%H:%M:%S.%f'))
283
timer = max(expires - datetime.datetime.utcnow(),
284
datetime.timedelta())
285
message = ('A checker has failed! Time until client'
287
.format(str(timer).rsplit(".", 1)[0]))
288
self.using_timer(True)
291
self.using_timer(False)
292
self._text = "{}{}".format(base, message)
294
if not urwid.supports_unicode():
295
self._text = self._text.encode("ascii", "replace")
296
textlist = [("normal", self._text)]
297
self._text_widget.set_text(textlist)
298
self._focus_text_widget.set_text([(with_standout[text[0]],
300
if isinstance(text, tuple)
302
for text in textlist])
303
self._widget = self._text_widget
304
self._focus_widget = urwid.AttrWrap(self._focus_text_widget,
306
# Run update hook, if any
307
if self.update_hook is not None:
310
def update_timer(self):
311
"""called by GLib. Will indefinitely loop until
312
GLib.source_remove() on tag is called
315
return True # Keep calling this
317
def delete(self, **kwargs):
318
if self._update_timer_callback_tag is not None:
319
GLib.source_remove(self._update_timer_callback_tag)
320
self._update_timer_callback_tag = None
321
for match in self.match_objects:
323
self.match_objects = ()
324
if self.delete_hook is not None:
325
self.delete_hook(self)
326
return super(MandosClientWidget, self).delete(**kwargs)
328
def render(self, maxcolrow, focus=False):
329
"""Render differently if we have focus.
330
This overrides the method from urwid.FlowWidget"""
331
return self.current_widget(focus).render(maxcolrow,
334
def keypress(self, maxcolrow, key):
336
This overrides the method from urwid.FlowWidget"""
338
self.proxy.Set(client_interface, "Enabled",
339
dbus.Boolean(True), ignore_reply=True,
340
dbus_interface=dbus.PROPERTIES_IFACE)
342
self.proxy.Set(client_interface, "Enabled", False,
344
dbus_interface=dbus.PROPERTIES_IFACE)
346
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
347
dbus_interface=client_interface,
350
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
351
dbus_interface=client_interface,
353
elif key == "R" or key == "_" or key == "ctrl k":
354
self.server_proxy_object.RemoveClient(self.proxy
358
self.proxy.Set(client_interface, "CheckerRunning",
359
dbus.Boolean(True), ignore_reply=True,
360
dbus_interface=dbus.PROPERTIES_IFACE)
362
self.proxy.Set(client_interface, "CheckerRunning",
363
dbus.Boolean(False), ignore_reply=True,
364
dbus_interface=dbus.PROPERTIES_IFACE)
366
self.proxy.CheckedOK(dbus_interface=client_interface,
369
# elif key == "p" or key == "=":
371
# elif key == "u" or key == ":":
372
# self.proxy.unpause()
378
def properties_changed(self, interface, properties, invalidated):
379
"""Call self.update() if any properties changed.
380
This overrides the method from MandosClientPropertyCache"""
381
old_values = {key: self.properties.get(key)
382
for key in properties.keys()}
383
super(MandosClientWidget, self).properties_changed(
384
interface, properties, invalidated)
385
if any(old_values[key] != self.properties.get(key)
386
for key in old_values):
390
class ConstrainedListBox(urwid.ListBox):
391
"""Like a normal urwid.ListBox, but will consume all "up" or
392
"down" key presses, thus not allowing any containing widgets to
393
use them as an excuse to shift focus away from this widget.
395
def keypress(self, *args, **kwargs):
396
ret = (super(ConstrainedListBox, self)
397
.keypress(*args, **kwargs))
398
if ret in ("up", "down"):
403
class UserInterface(object):
404
"""This is the entire user interface - the whole screen
405
with boxes, lists of client widgets, etc.
407
def __init__(self, max_log_length=1000, log_level=1):
408
DBusGMainLoop(set_as_default=True)
410
self.screen = urwid.curses_display.Screen()
412
self.screen.register_palette((
414
"default", "default", None),
416
"bold", "default", "bold"),
418
"underline,blink", "default", "underline,blink"),
420
"standout", "default", "standout"),
421
("bold-underline-blink",
422
"bold,underline,blink", "default",
423
"bold,underline,blink"),
425
"bold,standout", "default", "bold,standout"),
426
("underline-blink-standout",
427
"underline,blink,standout", "default",
428
"underline,blink,standout"),
429
("bold-underline-blink-standout",
430
"bold,underline,blink,standout", "default",
431
"bold,underline,blink,standout"),
434
if urwid.supports_unicode():
435
self.divider = "─" # \u2500
437
self.divider = "_" # \u005f
441
self.size = self.screen.get_cols_rows()
443
self.clients = urwid.SimpleListWalker([])
444
self.clients_dict = {}
446
# We will add Text widgets to this list
447
self.log = urwid.SimpleListWalker([])
448
self.max_log_length = max_log_length
450
self.log_level = log_level
452
# We keep a reference to the log widget so we can remove it
453
# from the ListWalker without it getting destroyed
454
self.logbox = ConstrainedListBox(self.log)
456
# This keeps track of whether self.uilist currently has
457
# self.logbox in it or not
458
self.log_visible = True
459
self.log_wrap = "any"
462
self.log_message_raw(("bold",
463
"Mandos Monitor version " + version))
464
self.log_message_raw(("bold",
467
self.busname = domain + '.Mandos'
468
self.main_loop = GLib.MainLoop()
470
def client_not_found(self, key_id, address):
471
self.log_message("Client with address {} and key ID {} could"
472
" not be found".format(address, key_id))
475
"""This rebuilds the User Interface.
476
Call this when the widget layout needs to change"""
478
# self.uilist.append(urwid.ListBox(self.clients))
479
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
481
# header=urwid.Divider(),
483
footer=urwid.Divider(
484
div_char=self.divider)))
486
self.uilist.append(self.logbox)
487
self.topwidget = urwid.Pile(self.uilist)
489
def log_message(self, message, level=1):
490
"""Log message formatted with timestamp"""
491
if level < self.log_level:
493
timestamp = datetime.datetime.now().isoformat()
494
self.log_message_raw("{}: {}".format(timestamp, message),
497
def log_message_raw(self, markup, level=1):
498
"""Add a log message to the log buffer."""
499
if level < self.log_level:
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-1]
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
self.log_message("Log visibility changed to: {}"
514
.format(self.log_visible), level=0)
516
def change_log_display(self):
517
"""Change type of log display.
518
Currently, this toggles wrapping of text lines."""
519
if self.log_wrap == "clip":
520
self.log_wrap = "any"
522
self.log_wrap = "clip"
523
for textwidget in self.log:
524
textwidget.set_wrap_mode(self.log_wrap)
525
self.log_message("Wrap mode: {}".format(self.log_wrap),
528
def find_and_remove_client(self, path, interfaces):
529
"""Find a client by its object path and remove it.
531
This is connected to the InterfacesRemoved signal from the
532
Mandos server object."""
533
if client_interface not in interfaces:
534
# Not a Mandos client object; ignore
537
client = self.clients_dict[path]
540
self.log_message("Unknown client {!r} removed"
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
logger=self.log_message,
561
properties=dict(ifs_and_props[client_interface])),
564
def add_client(self, client, path=None):
565
self.clients.append(client)
567
path = client.proxy.object_path
568
self.clients_dict[path] = client
569
self.clients.sort(key=lambda c: c.properties["Name"])
572
def remove_client(self, client, path=None):
573
self.clients.remove(client)
575
path = client.proxy.object_path
576
del self.clients_dict[path]
580
"""Redraw the screen"""
581
canvas = self.topwidget.render(self.size, focus=True)
582
self.screen.draw_screen(self.size, canvas)
585
"""Start the main loop and exit when it's done."""
586
self.bus = dbus.SystemBus()
587
mandos_dbus_objc = self.bus.get_object(
588
self.busname, "/", follow_name_owner_changes=True)
589
self.mandos_serv = dbus.Interface(
590
mandos_dbus_objc, dbus_interface=server_interface)
592
mandos_clients = (self.mandos_serv
593
.GetAllClientsWithProperties())
594
if not mandos_clients:
595
self.log_message_raw(("bold",
596
"Note: Server has no clients."))
597
except dbus.exceptions.DBusException:
598
self.log_message_raw(("bold",
599
"Note: No Mandos server running."))
600
mandos_clients = dbus.Dictionary()
603
.connect_to_signal("InterfacesRemoved",
604
self.find_and_remove_client,
605
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
608
.connect_to_signal("InterfacesAdded",
610
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
613
.connect_to_signal("ClientNotFound",
614
self.client_not_found,
615
dbus_interface=server_interface,
617
for path, client in mandos_clients.items():
618
client_proxy_object = self.bus.get_object(self.busname,
620
self.add_client(MandosClientWidget(
621
server_proxy_object=self.mandos_serv,
622
proxy_object=client_proxy_object,
624
update_hook=self.refresh,
625
delete_hook=self.remove_client,
626
logger=self.log_message),
630
self._input_callback_tag = (
632
GLib.IOChannel.unix_new(sys.stdin.fileno()),
633
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
636
# Main loop has finished, we should close everything now
637
GLib.source_remove(self._input_callback_tag)
638
with warnings.catch_warnings():
639
warnings.simplefilter("ignore", BytesWarning)
643
self.main_loop.quit()
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.log_message_raw(("bold",
686
"l: Log window toggle",
687
"TAB: Switch window",
688
"w: Wrap (log lines)",
689
"v: Toggle verbose log",
691
self.log_message_raw(("bold",
697
"s: Start new checker",
704
if self.topwidget.get_focus() is self.logbox:
705
self.topwidget.set_focus(0)
707
self.topwidget.set_focus(self.logbox)
710
if self.log_level == 0:
712
self.log_message("Verbose mode: Off")
715
self.log_message("Verbose mode: On")
716
# elif (key == "end" or key == "meta >" or key == "G"
718
# pass # xxx end-of-buffer
719
# elif (key == "home" or key == "meta <" or key == "g"
721
# pass # xxx beginning-of-buffer
722
# elif key == "ctrl e" or key == "$":
723
# pass # xxx move-end-of-line
724
# elif key == "ctrl a" or key == "^":
725
# pass # xxx move-beginning-of-line
726
# elif key == "ctrl b" or key == "meta (" or key == "h":
728
# elif key == "ctrl f" or key == "meta )" or key == "l":
731
# pass # scroll up log
733
# pass # scroll down log
734
elif self.topwidget.selectable():
735
self.topwidget.keypress(self.size, key)
743
except KeyboardInterrupt:
745
except Exception as e:
746
ui.log_message(str(e))