2
# -*- mode: python; coding: utf-8 -*-
4
# Mandos Monitor - Control and monitor the Mandos server
6
# Copyright © 2009-2012 Teddy Hogeborn
7
# Copyright © 2009-2012 Björn Påhlsson
9
# This program is free software: you can redistribute it and/or modify
10
# it under the terms of the GNU General Public License as published by
11
# the Free Software Foundation, either version 3 of the License, or
12
# (at your option) any later version.
14
# This program is distributed in the hope that it will be useful,
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17
# GNU General Public License for more details.
19
# You should have received a copy of the GNU General Public License
20
# along with this program. If not, see <http://www.gnu.org/licenses/>.
22
# Contact the authors at <mandos@recompile.se>.
25
from __future__ import (division, absolute_import, print_function,
34
import urwid.curses_display
37
from dbus.mainloop.glib import DBusGMainLoop
46
locale.setlocale(locale.LC_ALL, '')
49
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
51
# Some useful constants
52
domain = 'se.recompile'
53
server_interface = domain + '.Mandos'
54
client_interface = domain + '.Mandos.Client'
57
# Always run in monochrome mode
58
urwid.curses_display.curses.has_colors = lambda : False
60
# Urwid doesn't support blinking, but we want it. Since we have no
61
# use for underline on its own, we make underline also always blink.
62
urwid.curses_display.curses.A_UNDERLINE |= (
63
urwid.curses_display.curses.A_BLINK)
65
def isoformat_to_datetime(iso):
66
"Parse an ISO 8601 date string to a datetime.datetime()"
69
d, t = iso.split("T", 1)
70
year, month, day = d.split("-", 2)
71
hour, minute, second = t.split(":", 2)
72
second, fraction = divmod(float(second), 1)
73
return datetime.datetime(int(year),
78
int(second), # Whole seconds
79
int(fraction*1000000)) # Microseconds
81
class MandosClientPropertyCache(object):
82
"""This wraps a Mandos Client D-Bus proxy object, caches the
83
properties and calls a hook function when any of them are
86
def __init__(self, proxy_object=None, *args, **kwargs):
87
self.proxy = proxy_object # Mandos Client proxy object
89
self.properties = dict()
90
self.property_changed_match = (
91
self.proxy.connect_to_signal("PropertyChanged",
92
self.property_changed,
96
self.properties.update(
97
self.proxy.GetAll(client_interface,
98
dbus_interface = dbus.PROPERTIES_IFACE))
100
#XXX This breaks good super behaviour
101
# super(MandosClientPropertyCache, self).__init__(
104
def property_changed(self, property=None, value=None):
105
"""This is called whenever we get a PropertyChanged signal
106
It updates the changed property in the "properties" dict.
108
# Update properties dict with new value
109
self.properties[property] = value
111
def delete(self, *args, **kwargs):
112
self.property_changed_match.remove()
113
super(MandosClientPropertyCache, self).__init__(
117
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
118
"""A Mandos Client which is visible on the screen.
121
def __init__(self, server_proxy_object=None, update_hook=None,
122
delete_hook=None, logger=None, *args, **kwargs):
124
self.update_hook = update_hook
126
self.delete_hook = delete_hook
127
# Mandos Server proxy object
128
self.server_proxy_object = server_proxy_object
132
self._update_timer_callback_tag = None
133
self._update_timer_callback_lock = 0
135
# The widget shown normally
136
self._text_widget = urwid.Text("")
137
# The widget shown when we have focus
138
self._focus_text_widget = urwid.Text("")
139
super(MandosClientWidget, self).__init__(
140
update_hook=update_hook, delete_hook=delete_hook,
145
last_checked_ok = isoformat_to_datetime(self.properties
148
if self.properties ["LastCheckerStatus"] != 0:
149
self.using_timer(True)
151
if self.need_approval:
152
self.using_timer(True)
154
self.match_objects = (
155
self.proxy.connect_to_signal("CheckerCompleted",
156
self.checker_completed,
159
self.proxy.connect_to_signal("CheckerStarted",
160
self.checker_started,
163
self.proxy.connect_to_signal("GotSecret",
167
self.proxy.connect_to_signal("NeedApproval",
171
self.proxy.connect_to_signal("Rejected",
175
#self.logger('Created client {0}'
176
# .format(self.properties["Name"]))
178
def property_changed(self, property=None, value=None):
179
super(self, MandosClientWidget).property_changed(property,
181
if property == "ApprovalPending":
182
using_timer(bool(value))
183
if property == "LastCheckerStatus":
184
using_timer(value != 0)
185
#self.logger('Checker for client {0} (command "{1}") was '
186
# ' successful'.format(self.properties["Name"],
189
def using_timer(self, flag):
190
"""Call this method with True or False when timer should be
191
activated or deactivated.
193
old = self._update_timer_callback_lock
195
self._update_timer_callback_lock += 1
197
self._update_timer_callback_lock -= 1
198
if old == 0 and self._update_timer_callback_lock:
199
# Will update the shown timer value every second
200
self._update_timer_callback_tag = (gobject.timeout_add
203
elif old and self._update_timer_callback_lock == 0:
204
gobject.source_remove(self._update_timer_callback_tag)
205
self._update_timer_callback_tag = None
207
def checker_completed(self, exitstatus, condition, command):
212
if os.WIFEXITED(condition):
213
self.logger('Checker for client {0} (command "{1}")'
214
' failed with exit code {2}'
215
.format(self.properties["Name"], command,
216
os.WEXITSTATUS(condition)))
217
elif os.WIFSIGNALED(condition):
218
self.logger('Checker for client {0} (command "{1}") was'
219
' killed by signal {2}'
220
.format(self.properties["Name"], command,
221
os.WTERMSIG(condition)))
222
elif os.WCOREDUMP(condition):
223
self.logger('Checker for client {0} (command "{1}")'
225
.format(self.properties["Name"], command))
227
self.logger('Checker for client {0} completed'
229
.format(self.properties["Name"]))
232
def checker_started(self, command):
233
"""Server signals that a checker started. This could be useful
234
to log in the future. """
235
#self.logger('Client {0} started checker "{1}"'
236
# .format(self.properties["Name"],
240
def got_secret(self):
241
self.logger('Client {0} received its secret'
242
.format(self.properties["Name"]))
244
def need_approval(self, timeout, default):
246
message = 'Client {0} needs approval within {1} seconds'
248
message = 'Client {0} will get its secret in {1} seconds'
249
self.logger(message.format(self.properties["Name"],
251
self.using_timer(True)
253
def rejected(self, reason):
254
self.logger('Client {0} was rejected; reason: {1}'
255
.format(self.properties["Name"], reason))
257
def selectable(self):
258
"""Make this a "selectable" widget.
259
This overrides the method from urwid.FlowWidget."""
262
def rows(self, maxcolrow, focus=False):
263
"""How many rows this widget will occupy might depend on
264
whether we have focus or not.
265
This overrides the method from urwid.FlowWidget"""
266
return self.current_widget(focus).rows(maxcolrow, focus=focus)
268
def current_widget(self, focus=False):
269
if focus or self.opened:
270
return self._focus_widget
274
"Called when what is visible on the screen should be updated."
275
# How to add standout mode to a style
276
with_standout = { "normal": "standout",
277
"bold": "bold-standout",
279
"underline-blink-standout",
280
"bold-underline-blink":
281
"bold-underline-blink-standout",
284
# Rebuild focus and non-focus widgets using current properties
286
# Base part of a client. Name!
287
base = '{name}: '.format(name=self.properties["Name"])
288
if not self.properties["Enabled"]:
290
elif self.properties["ApprovalPending"]:
291
timeout = datetime.timedelta(milliseconds
294
last_approval_request = isoformat_to_datetime(
295
self.properties["LastApprovalRequest"])
296
if last_approval_request is not None:
297
timer = timeout - (datetime.datetime.utcnow()
298
- last_approval_request)
300
timer = datetime.timedelta()
301
if self.properties["ApprovedByDefault"]:
302
message = "Approval in {0}. (d)eny?"
304
message = "Denial in {0}. (a)pprove?"
305
message = message.format(unicode(timer).rsplit(".", 1)[0])
306
elif self.properties["LastCheckerStatus"] != 0:
307
# When checker has failed, print a timer until client expires
308
expires = self.properties["Expires"]
310
timer = datetime.timedelta(0)
312
expires = datetime.datetime.strptime(expires,
313
'%Y-%m-%dT%H:%M:%S.%f')
314
timer = expires - datetime.datetime.utcnow()
315
message = ('A checker has failed! Time until client'
316
' gets disabled: {0}'
317
.format(unicode(timer).rsplit(".", 1)[0]))
320
self._text = "{0}{1}".format(base, message)
322
if not urwid.supports_unicode():
323
self._text = self._text.encode("ascii", "replace")
324
textlist = [("normal", self._text)]
325
self._text_widget.set_text(textlist)
326
self._focus_text_widget.set_text([(with_standout[text[0]],
328
if isinstance(text, tuple)
330
for text in textlist])
331
self._widget = self._text_widget
332
self._focus_widget = urwid.AttrWrap(self._focus_text_widget,
334
# Run update hook, if any
335
if self.update_hook is not None:
338
def update_timer(self):
339
"""called by gobject. Will indefinitely loop until
340
gobject.source_remove() on tag is called"""
342
return True # Keep calling this
344
def delete(self, *args, **kwargs):
345
if self._update_timer_callback_tag is not None:
346
gobject.source_remove(self._update_timer_callback_tag)
347
self._update_timer_callback_tag = None
348
for match in self.match_objects:
350
self.match_objects = ()
351
if self.delete_hook is not None:
352
self.delete_hook(self)
353
return super(MandosClientWidget, self).delete(*args, **kwargs)
355
def render(self, maxcolrow, focus=False):
356
"""Render differently if we have focus.
357
This overrides the method from urwid.FlowWidget"""
358
return self.current_widget(focus).render(maxcolrow,
361
def keypress(self, maxcolrow, key):
363
This overrides the method from urwid.FlowWidget"""
365
self.proxy.Enable(dbus_interface = client_interface,
368
self.proxy.Disable(dbus_interface = client_interface,
371
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
372
dbus_interface = client_interface,
375
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
376
dbus_interface = client_interface,
378
elif key == "R" or key == "_" or key == "ctrl k":
379
self.server_proxy_object.RemoveClient(self.proxy
383
self.proxy.StartChecker(dbus_interface = client_interface,
386
self.proxy.StopChecker(dbus_interface = client_interface,
389
self.proxy.CheckedOK(dbus_interface = client_interface,
392
# elif key == "p" or key == "=":
394
# elif key == "u" or key == ":":
395
# self.proxy.unpause()
401
def property_changed(self, property=None, value=None,
403
"""Call self.update() if old value is not new value.
404
This overrides the method from MandosClientPropertyCache"""
405
property_name = unicode(property)
406
old_value = self.properties.get(property_name)
407
super(MandosClientWidget, self).property_changed(
408
property=property, value=value, *args, **kwargs)
409
if self.properties.get(property_name) != old_value:
413
class ConstrainedListBox(urwid.ListBox):
414
"""Like a normal urwid.ListBox, but will consume all "up" or
415
"down" key presses, thus not allowing any containing widgets to
416
use them as an excuse to shift focus away from this widget.
418
def keypress(self, maxcolrow, key):
419
ret = super(ConstrainedListBox, self).keypress(maxcolrow, key)
420
if ret in ("up", "down"):
425
class UserInterface(object):
426
"""This is the entire user interface - the whole screen
427
with boxes, lists of client widgets, etc.
429
def __init__(self, max_log_length=1000):
430
DBusGMainLoop(set_as_default=True)
432
self.screen = urwid.curses_display.Screen()
434
self.screen.register_palette((
436
"default", "default", None),
438
"default", "default", "bold"),
440
"default", "default", "underline"),
442
"default", "default", "standout"),
443
("bold-underline-blink",
444
"default", "default", ("bold", "underline")),
446
"default", "default", ("bold", "standout")),
447
("underline-blink-standout",
448
"default", "default", ("underline", "standout")),
449
("bold-underline-blink-standout",
450
"default", "default", ("bold", "underline",
454
if urwid.supports_unicode():
455
self.divider = "─" # \u2500
456
#self.divider = "━" # \u2501
458
#self.divider = "-" # \u002d
459
self.divider = "_" # \u005f
463
self.size = self.screen.get_cols_rows()
465
self.clients = urwid.SimpleListWalker([])
466
self.clients_dict = {}
468
# We will add Text widgets to this list
470
self.max_log_length = max_log_length
472
# We keep a reference to the log widget so we can remove it
473
# from the ListWalker without it getting destroyed
474
self.logbox = ConstrainedListBox(self.log)
476
# This keeps track of whether self.uilist currently has
477
# self.logbox in it or not
478
self.log_visible = True
479
self.log_wrap = "any"
482
self.log_message_raw(("bold",
483
"Mandos Monitor version " + version))
484
self.log_message_raw(("bold",
487
self.busname = domain + '.Mandos'
488
self.main_loop = gobject.MainLoop()
490
def client_not_found(self, fingerprint, address):
491
self.log_message("Client with address {0} and fingerprint"
492
" {1} could not be found"
493
.format(address, fingerprint))
496
"""This rebuilds the User Interface.
497
Call this when the widget layout needs to change"""
499
#self.uilist.append(urwid.ListBox(self.clients))
500
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
502
#header=urwid.Divider(),
505
urwid.Divider(div_char=
508
self.uilist.append(self.logbox)
509
self.topwidget = urwid.Pile(self.uilist)
511
def log_message(self, message):
512
timestamp = datetime.datetime.now().isoformat()
513
self.log_message_raw(timestamp + ": " + message)
515
def log_message_raw(self, markup):
516
"""Add a log message to the log buffer."""
517
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
518
if (self.max_log_length
519
and len(self.log) > self.max_log_length):
520
del self.log[0:len(self.log)-self.max_log_length-1]
521
self.logbox.set_focus(len(self.logbox.body.contents),
525
def toggle_log_display(self):
526
"""Toggle visibility of the log buffer."""
527
self.log_visible = not self.log_visible
529
#self.log_message("Log visibility changed to: "
530
# + unicode(self.log_visible))
532
def change_log_display(self):
533
"""Change type of log display.
534
Currently, this toggles wrapping of text lines."""
535
if self.log_wrap == "clip":
536
self.log_wrap = "any"
538
self.log_wrap = "clip"
539
for textwidget in self.log:
540
textwidget.set_wrap_mode(self.log_wrap)
541
#self.log_message("Wrap mode: " + self.log_wrap)
543
def find_and_remove_client(self, path, name):
544
"""Find a client by its object path and remove it.
546
This is connected to the ClientRemoved signal from the
547
Mandos server object."""
549
client = self.clients_dict[path]
552
self.log_message("Unknown client {0!r} ({1!r}) removed"
557
def add_new_client(self, path):
558
client_proxy_object = self.bus.get_object(self.busname, path)
559
self.add_client(MandosClientWidget(server_proxy_object
562
=client_proxy_object,
571
def add_client(self, client, path=None):
572
self.clients.append(client)
574
path = client.proxy.object_path
575
self.clients_dict[path] = client
576
self.clients.sort(None, lambda c: c.properties["Name"])
579
def remove_client(self, client, path=None):
580
self.clients.remove(client)
582
path = client.proxy.object_path
583
del self.clients_dict[path]
584
if not self.clients_dict:
585
# Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker
586
# is completely emptied, we need to recreate it.
587
self.clients = urwid.SimpleListWalker([])
592
"""Redraw the screen"""
593
canvas = self.topwidget.render(self.size, focus=True)
594
self.screen.draw_screen(self.size, canvas)
597
"""Start the main loop and exit when it's done."""
598
self.bus = dbus.SystemBus()
599
mandos_dbus_objc = self.bus.get_object(
600
self.busname, "/", follow_name_owner_changes=True)
601
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
605
mandos_clients = (self.mandos_serv
606
.GetAllClientsWithProperties())
607
except dbus.exceptions.DBusException:
608
mandos_clients = dbus.Dictionary()
611
.connect_to_signal("ClientRemoved",
612
self.find_and_remove_client,
613
dbus_interface=server_interface,
616
.connect_to_signal("ClientAdded",
618
dbus_interface=server_interface,
621
.connect_to_signal("ClientNotFound",
622
self.client_not_found,
623
dbus_interface=server_interface,
625
for path, client in mandos_clients.iteritems():
626
client_proxy_object = self.bus.get_object(self.busname,
628
self.add_client(MandosClientWidget(server_proxy_object
631
=client_proxy_object,
642
self._input_callback_tag = (gobject.io_add_watch
647
# Main loop has finished, we should close everything now
648
gobject.source_remove(self._input_callback_tag)
652
self.main_loop.quit()
654
def process_input(self, source, condition):
655
keys = self.screen.get_input()
656
translations = { "ctrl n": "down", # Emacs
657
"ctrl p": "up", # Emacs
658
"ctrl v": "page down", # Emacs
659
"meta v": "page up", # Emacs
660
" ": "page down", # less
661
"f": "page down", # less
662
"b": "page up", # less
668
key = translations[key]
669
except KeyError: # :-)
672
if key == "q" or key == "Q":
675
elif key == "window resize":
676
self.size = self.screen.get_cols_rows()
678
elif key == "\f": # Ctrl-L
680
elif key == "l" or key == "D":
681
self.toggle_log_display()
683
elif key == "w" or key == "i":
684
self.change_log_display()
686
elif key == "?" or key == "f1" or key == "esc":
687
if not self.log_visible:
688
self.log_visible = True
690
self.log_message_raw(("bold",
694
"l: Log window toggle",
695
"TAB: Switch window",
697
self.log_message_raw(("bold",
703
"s: Start new checker",
710
if self.topwidget.get_focus() is self.logbox:
711
self.topwidget.set_focus(0)
713
self.topwidget.set_focus(self.logbox)
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)
741
except KeyboardInterrupt:
744
ui.log_message(unicode(e))