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
21
# <http://www.gnu.org/licenses/>.
23
# Contact the authors at <mandos@recompile.se>.
26
from __future__ import (division, absolute_import, print_function,
29
from future_builtins import *
37
import urwid.curses_display
40
from dbus.mainloop.glib import DBusGMainLoop
49
locale.setlocale(locale.LC_ALL, '')
52
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
54
# Some useful constants
55
domain = 'se.recompile'
56
server_interface = domain + '.Mandos'
57
client_interface = domain + '.Mandos.Client'
60
# Always run in monochrome mode
61
urwid.curses_display.curses.has_colors = lambda : False
63
# Urwid doesn't support blinking, but we want it. Since we have no
64
# use for underline on its own, we make underline also always blink.
65
urwid.curses_display.curses.A_UNDERLINE |= (
66
urwid.curses_display.curses.A_BLINK)
68
def isoformat_to_datetime(iso):
69
"Parse an ISO 8601 date string to a datetime.datetime()"
72
d, t = iso.split("T", 1)
73
year, month, day = d.split("-", 2)
74
hour, minute, second = t.split(":", 2)
75
second, fraction = divmod(float(second), 1)
76
return datetime.datetime(int(year),
81
int(second), # Whole seconds
82
int(fraction*1000000)) # Microseconds
84
class MandosClientPropertyCache(object):
85
"""This wraps a Mandos Client D-Bus proxy object, caches the
86
properties and calls a hook function when any of them are
89
def __init__(self, proxy_object=None, *args, **kwargs):
90
self.proxy = proxy_object # Mandos Client proxy object
92
self.properties = dict()
93
self.property_changed_match = (
94
self.proxy.connect_to_signal("PropertyChanged",
95
self.property_changed,
99
self.properties.update(
100
self.proxy.GetAll(client_interface,
101
dbus_interface = dbus.PROPERTIES_IFACE))
103
#XXX This breaks good super behaviour
104
# super(MandosClientPropertyCache, self).__init__(
107
def property_changed(self, property=None, value=None):
108
"""This is called whenever we get a PropertyChanged signal
109
It updates the changed property in the "properties" dict.
111
# Update properties dict with new value
112
self.properties[property] = value
114
def delete(self, *args, **kwargs):
115
self.property_changed_match.remove()
116
super(MandosClientPropertyCache, self).__init__(
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, *args, **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
136
self._update_timer_callback_lock = 0
138
# The widget shown normally
139
self._text_widget = urwid.Text("")
140
# The widget shown when we have focus
141
self._focus_text_widget = urwid.Text("")
142
super(MandosClientWidget, self).__init__(
143
update_hook=update_hook, delete_hook=delete_hook,
148
last_checked_ok = isoformat_to_datetime(self.properties
151
if self.properties ["LastCheckerStatus"] != 0:
152
self.using_timer(True)
154
if self.need_approval:
155
self.using_timer(True)
157
self.match_objects = (
158
self.proxy.connect_to_signal("CheckerCompleted",
159
self.checker_completed,
162
self.proxy.connect_to_signal("CheckerStarted",
163
self.checker_started,
166
self.proxy.connect_to_signal("GotSecret",
170
self.proxy.connect_to_signal("NeedApproval",
174
self.proxy.connect_to_signal("Rejected",
178
#self.logger('Created client {0}'
179
# .format(self.properties["Name"]))
181
def property_changed(self, property=None, value=None):
182
super(self, MandosClientWidget).property_changed(property,
184
if property == "ApprovalPending":
185
using_timer(bool(value))
186
if property == "LastCheckerStatus":
187
using_timer(value != 0)
188
#self.logger('Checker for client {0} (command "{1}") was '
189
# ' successful'.format(self.properties["Name"],
192
def using_timer(self, flag):
193
"""Call this method with True or False when timer should be
194
activated or deactivated.
196
old = self._update_timer_callback_lock
198
self._update_timer_callback_lock += 1
200
self._update_timer_callback_lock -= 1
201
if old == 0 and self._update_timer_callback_lock:
202
# Will update the shown timer value every second
203
self._update_timer_callback_tag = (gobject.timeout_add
206
elif old and self._update_timer_callback_lock == 0:
207
gobject.source_remove(self._update_timer_callback_tag)
208
self._update_timer_callback_tag = None
210
def checker_completed(self, exitstatus, condition, command):
215
if os.WIFEXITED(condition):
216
self.logger('Checker for client {0} (command "{1}")'
217
' failed with exit code {2}'
218
.format(self.properties["Name"], command,
219
os.WEXITSTATUS(condition)))
220
elif os.WIFSIGNALED(condition):
221
self.logger('Checker for client {0} (command "{1}") was'
222
' killed by signal {2}'
223
.format(self.properties["Name"], command,
224
os.WTERMSIG(condition)))
225
elif os.WCOREDUMP(condition):
226
self.logger('Checker for client {0} (command "{1}")'
228
.format(self.properties["Name"], command))
230
self.logger('Checker for client {0} completed'
232
.format(self.properties["Name"]))
235
def checker_started(self, command):
236
"""Server signals that a checker started. This could be useful
237
to log in the future. """
238
#self.logger('Client {0} started checker "{1}"'
239
# .format(self.properties["Name"],
243
def got_secret(self):
244
self.logger('Client {0} received its secret'
245
.format(self.properties["Name"]))
247
def need_approval(self, timeout, default):
249
message = 'Client {0} needs approval within {1} seconds'
251
message = 'Client {0} will get its secret in {1} seconds'
252
self.logger(message.format(self.properties["Name"],
254
self.using_timer(True)
256
def rejected(self, reason):
257
self.logger('Client {0} was rejected; reason: {1}'
258
.format(self.properties["Name"], reason))
260
def selectable(self):
261
"""Make this a "selectable" widget.
262
This overrides the method from urwid.FlowWidget."""
265
def rows(self, maxcolrow, focus=False):
266
"""How many rows this widget will occupy might depend on
267
whether we have focus or not.
268
This overrides the method from urwid.FlowWidget"""
269
return self.current_widget(focus).rows(maxcolrow, focus=focus)
271
def current_widget(self, focus=False):
272
if focus or self.opened:
273
return self._focus_widget
277
"Called when what is visible on the screen should be updated."
278
# How to add standout mode to a style
279
with_standout = { "normal": "standout",
280
"bold": "bold-standout",
282
"underline-blink-standout",
283
"bold-underline-blink":
284
"bold-underline-blink-standout",
287
# Rebuild focus and non-focus widgets using current properties
289
# Base part of a client. Name!
290
base = '{name}: '.format(name=self.properties["Name"])
291
if not self.properties["Enabled"]:
293
elif self.properties["ApprovalPending"]:
294
timeout = datetime.timedelta(milliseconds
297
last_approval_request = isoformat_to_datetime(
298
self.properties["LastApprovalRequest"])
299
if last_approval_request is not None:
300
timer = timeout - (datetime.datetime.utcnow()
301
- last_approval_request)
303
timer = datetime.timedelta()
304
if self.properties["ApprovedByDefault"]:
305
message = "Approval in {0}. (d)eny?"
307
message = "Denial in {0}. (a)pprove?"
308
message = message.format(unicode(timer).rsplit(".", 1)[0])
309
elif self.properties["LastCheckerStatus"] != 0:
310
# When checker has failed, show timer until client expires
311
expires = self.properties["Expires"]
313
timer = datetime.timedelta(0)
315
expires = (datetime.datetime.strptime
316
(expires, '%Y-%m-%dT%H:%M:%S.%f'))
317
timer = expires - datetime.datetime.utcnow()
318
message = ('A checker has failed! Time until client'
319
' gets disabled: {0}'
320
.format(unicode(timer).rsplit(".", 1)[0]))
323
self._text = "{0}{1}".format(base, message)
325
if not urwid.supports_unicode():
326
self._text = self._text.encode("ascii", "replace")
327
textlist = [("normal", self._text)]
328
self._text_widget.set_text(textlist)
329
self._focus_text_widget.set_text([(with_standout[text[0]],
331
if isinstance(text, tuple)
333
for text in textlist])
334
self._widget = self._text_widget
335
self._focus_widget = urwid.AttrWrap(self._focus_text_widget,
337
# Run update hook, if any
338
if self.update_hook is not None:
341
def update_timer(self):
342
"""called by gobject. Will indefinitely loop until
343
gobject.source_remove() on tag is called"""
345
return True # Keep calling this
347
def delete(self, *args, **kwargs):
348
if self._update_timer_callback_tag is not None:
349
gobject.source_remove(self._update_timer_callback_tag)
350
self._update_timer_callback_tag = None
351
for match in self.match_objects:
353
self.match_objects = ()
354
if self.delete_hook is not None:
355
self.delete_hook(self)
356
return super(MandosClientWidget, self).delete(*args, **kwargs)
358
def render(self, maxcolrow, focus=False):
359
"""Render differently if we have focus.
360
This overrides the method from urwid.FlowWidget"""
361
return self.current_widget(focus).render(maxcolrow,
364
def keypress(self, maxcolrow, key):
366
This overrides the method from urwid.FlowWidget"""
368
self.proxy.Enable(dbus_interface = client_interface,
371
self.proxy.Disable(dbus_interface = client_interface,
374
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
375
dbus_interface = client_interface,
378
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
379
dbus_interface = client_interface,
381
elif key == "R" or key == "_" or key == "ctrl k":
382
self.server_proxy_object.RemoveClient(self.proxy
386
self.proxy.StartChecker(dbus_interface = client_interface,
389
self.proxy.StopChecker(dbus_interface = client_interface,
392
self.proxy.CheckedOK(dbus_interface = client_interface,
395
# elif key == "p" or key == "=":
397
# elif key == "u" or key == ":":
398
# self.proxy.unpause()
404
def property_changed(self, property=None, value=None,
406
"""Call self.update() if old value is not new value.
407
This overrides the method from MandosClientPropertyCache"""
408
property_name = unicode(property)
409
old_value = self.properties.get(property_name)
410
super(MandosClientWidget, self).property_changed(
411
property=property, value=value, *args, **kwargs)
412
if self.properties.get(property_name) != old_value:
416
class ConstrainedListBox(urwid.ListBox):
417
"""Like a normal urwid.ListBox, but will consume all "up" or
418
"down" key presses, thus not allowing any containing widgets to
419
use them as an excuse to shift focus away from this widget.
421
def keypress(self, maxcolrow, key):
422
ret = super(ConstrainedListBox, self).keypress(maxcolrow, key)
423
if ret in ("up", "down"):
428
class UserInterface(object):
429
"""This is the entire user interface - the whole screen
430
with boxes, lists of client widgets, etc.
432
def __init__(self, max_log_length=1000):
433
DBusGMainLoop(set_as_default=True)
435
self.screen = urwid.curses_display.Screen()
437
self.screen.register_palette((
439
"default", "default", None),
441
"default", "default", "bold"),
443
"default", "default", "underline"),
445
"default", "default", "standout"),
446
("bold-underline-blink",
447
"default", "default", ("bold", "underline")),
449
"default", "default", ("bold", "standout")),
450
("underline-blink-standout",
451
"default", "default", ("underline", "standout")),
452
("bold-underline-blink-standout",
453
"default", "default", ("bold", "underline",
457
if urwid.supports_unicode():
458
self.divider = "─" # \u2500
459
#self.divider = "━" # \u2501
461
#self.divider = "-" # \u002d
462
self.divider = "_" # \u005f
466
self.size = self.screen.get_cols_rows()
468
self.clients = urwid.SimpleListWalker([])
469
self.clients_dict = {}
471
# We will add Text widgets to this list
473
self.max_log_length = max_log_length
475
# We keep a reference to the log widget so we can remove it
476
# from the ListWalker without it getting destroyed
477
self.logbox = ConstrainedListBox(self.log)
479
# This keeps track of whether self.uilist currently has
480
# self.logbox in it or not
481
self.log_visible = True
482
self.log_wrap = "any"
485
self.log_message_raw(("bold",
486
"Mandos Monitor version " + version))
487
self.log_message_raw(("bold",
490
self.busname = domain + '.Mandos'
491
self.main_loop = gobject.MainLoop()
493
def client_not_found(self, fingerprint, address):
494
self.log_message("Client with address {0} and fingerprint"
495
" {1} could not be found"
496
.format(address, fingerprint))
499
"""This rebuilds the User Interface.
500
Call this when the widget layout needs to change"""
502
#self.uilist.append(urwid.ListBox(self.clients))
503
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
505
#header=urwid.Divider(),
508
urwid.Divider(div_char=
511
self.uilist.append(self.logbox)
512
self.topwidget = urwid.Pile(self.uilist)
514
def log_message(self, message):
515
timestamp = datetime.datetime.now().isoformat()
516
self.log_message_raw(timestamp + ": " + message)
518
def log_message_raw(self, markup):
519
"""Add a log message to the log buffer."""
520
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
521
if (self.max_log_length
522
and len(self.log) > self.max_log_length):
523
del self.log[0:len(self.log)-self.max_log_length-1]
524
self.logbox.set_focus(len(self.logbox.body.contents),
528
def toggle_log_display(self):
529
"""Toggle visibility of the log buffer."""
530
self.log_visible = not self.log_visible
532
#self.log_message("Log visibility changed to: "
533
# + unicode(self.log_visible))
535
def change_log_display(self):
536
"""Change type of log display.
537
Currently, this toggles wrapping of text lines."""
538
if self.log_wrap == "clip":
539
self.log_wrap = "any"
541
self.log_wrap = "clip"
542
for textwidget in self.log:
543
textwidget.set_wrap_mode(self.log_wrap)
544
#self.log_message("Wrap mode: " + self.log_wrap)
546
def find_and_remove_client(self, path, name):
547
"""Find a client by its object path and remove it.
549
This is connected to the ClientRemoved signal from the
550
Mandos server object."""
552
client = self.clients_dict[path]
555
self.log_message("Unknown client {0!r} ({1!r}) removed"
560
def add_new_client(self, path):
561
client_proxy_object = self.bus.get_object(self.busname, path)
562
self.add_client(MandosClientWidget(server_proxy_object
565
=client_proxy_object,
574
def add_client(self, client, path=None):
575
self.clients.append(client)
577
path = client.proxy.object_path
578
self.clients_dict[path] = client
579
self.clients.sort(None, lambda c: c.properties["Name"])
582
def remove_client(self, client, path=None):
583
self.clients.remove(client)
585
path = client.proxy.object_path
586
del self.clients_dict[path]
587
if not self.clients_dict:
588
# Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker
589
# is completely emptied, we need to recreate it.
590
self.clients = urwid.SimpleListWalker([])
595
"""Redraw the screen"""
596
canvas = self.topwidget.render(self.size, focus=True)
597
self.screen.draw_screen(self.size, canvas)
600
"""Start the main loop and exit when it's done."""
601
self.bus = dbus.SystemBus()
602
mandos_dbus_objc = self.bus.get_object(
603
self.busname, "/", follow_name_owner_changes=True)
604
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
608
mandos_clients = (self.mandos_serv
609
.GetAllClientsWithProperties())
610
except dbus.exceptions.DBusException:
611
mandos_clients = dbus.Dictionary()
614
.connect_to_signal("ClientRemoved",
615
self.find_and_remove_client,
616
dbus_interface=server_interface,
619
.connect_to_signal("ClientAdded",
621
dbus_interface=server_interface,
624
.connect_to_signal("ClientNotFound",
625
self.client_not_found,
626
dbus_interface=server_interface,
628
for path, client in mandos_clients.iteritems():
629
client_proxy_object = self.bus.get_object(self.busname,
631
self.add_client(MandosClientWidget(server_proxy_object
634
=client_proxy_object,
645
self._input_callback_tag = (gobject.io_add_watch
650
# Main loop has finished, we should close everything now
651
gobject.source_remove(self._input_callback_tag)
655
self.main_loop.quit()
657
def process_input(self, source, condition):
658
keys = self.screen.get_input()
659
translations = { "ctrl n": "down", # Emacs
660
"ctrl p": "up", # Emacs
661
"ctrl v": "page down", # Emacs
662
"meta v": "page up", # Emacs
663
" ": "page down", # less
664
"f": "page down", # less
665
"b": "page up", # less
671
key = translations[key]
672
except KeyError: # :-)
675
if key == "q" or key == "Q":
678
elif key == "window resize":
679
self.size = self.screen.get_cols_rows()
681
elif key == "\f": # Ctrl-L
683
elif key == "l" or key == "D":
684
self.toggle_log_display()
686
elif key == "w" or key == "i":
687
self.change_log_display()
689
elif key == "?" or key == "f1" or key == "esc":
690
if not self.log_visible:
691
self.log_visible = True
693
self.log_message_raw(("bold",
697
"l: Log window toggle",
698
"TAB: Switch window",
700
self.log_message_raw(("bold",
706
"s: Start new checker",
713
if self.topwidget.get_focus() is self.logbox:
714
self.topwidget.set_focus(0)
716
self.topwidget.set_focus(self.logbox)
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)
744
except KeyboardInterrupt:
747
ui.log_message(unicode(e))