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,
35
import urwid.curses_display
38
from dbus.mainloop.glib import DBusGMainLoop
47
locale.setlocale(locale.LC_ALL, '')
50
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
52
# Some useful constants
53
domain = 'se.recompile'
54
server_interface = domain + '.Mandos'
55
client_interface = domain + '.Mandos.Client'
58
# Always run in monochrome mode
59
urwid.curses_display.curses.has_colors = lambda : False
61
# Urwid doesn't support blinking, but we want it. Since we have no
62
# use for underline on its own, we make underline also always blink.
63
urwid.curses_display.curses.A_UNDERLINE |= (
64
urwid.curses_display.curses.A_BLINK)
66
def isoformat_to_datetime(iso):
67
"Parse an ISO 8601 date string to a datetime.datetime()"
70
d, t = iso.split("T", 1)
71
year, month, day = d.split("-", 2)
72
hour, minute, second = t.split(":", 2)
73
second, fraction = divmod(float(second), 1)
74
return datetime.datetime(int(year),
79
int(second), # Whole seconds
80
int(fraction*1000000)) # Microseconds
82
class MandosClientPropertyCache(object):
83
"""This wraps a Mandos Client D-Bus proxy object, caches the
84
properties and calls a hook function when any of them are
87
def __init__(self, proxy_object=None, *args, **kwargs):
88
self.proxy = proxy_object # Mandos Client proxy object
90
self.properties = dict()
91
self.property_changed_match = (
92
self.proxy.connect_to_signal("PropertyChanged",
93
self.property_changed,
97
self.properties.update(
98
self.proxy.GetAll(client_interface,
99
dbus_interface = dbus.PROPERTIES_IFACE))
101
#XXX This breaks good super behaviour
102
# super(MandosClientPropertyCache, self).__init__(
105
def property_changed(self, property=None, value=None):
106
"""This is called whenever we get a PropertyChanged signal
107
It updates the changed property in the "properties" dict.
109
# Update properties dict with new value
110
self.properties[property] = value
112
def delete(self, *args, **kwargs):
113
self.property_changed_match.remove()
114
super(MandosClientPropertyCache, self).__init__(
118
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
119
"""A Mandos Client which is visible on the screen.
122
def __init__(self, server_proxy_object=None, update_hook=None,
123
delete_hook=None, logger=None, *args, **kwargs):
125
self.update_hook = update_hook
127
self.delete_hook = delete_hook
128
# Mandos Server proxy object
129
self.server_proxy_object = server_proxy_object
133
self._update_timer_callback_tag = None
134
self._update_timer_callback_lock = 0
136
# The widget shown normally
137
self._text_widget = urwid.Text("")
138
# The widget shown when we have focus
139
self._focus_text_widget = urwid.Text("")
140
super(MandosClientWidget, self).__init__(
141
update_hook=update_hook, delete_hook=delete_hook,
146
last_checked_ok = isoformat_to_datetime(self.properties
149
if self.properties ["LastCheckerStatus"] != 0:
150
self.using_timer(True)
152
if self.need_approval:
153
self.using_timer(True)
155
self.match_objects = (
156
self.proxy.connect_to_signal("CheckerCompleted",
157
self.checker_completed,
160
self.proxy.connect_to_signal("CheckerStarted",
161
self.checker_started,
164
self.proxy.connect_to_signal("GotSecret",
168
self.proxy.connect_to_signal("NeedApproval",
172
self.proxy.connect_to_signal("Rejected",
176
#self.logger('Created client {0}'
177
# .format(self.properties["Name"]))
179
def property_changed(self, property=None, value=None):
180
super(self, MandosClientWidget).property_changed(property,
182
if property == "ApprovalPending":
183
using_timer(bool(value))
184
if property == "LastCheckerStatus":
185
using_timer(value != 0)
186
#self.logger('Checker for client {0} (command "{1}") was '
187
# ' successful'.format(self.properties["Name"],
190
def using_timer(self, flag):
191
"""Call this method with True or False when timer should be
192
activated or deactivated.
194
old = self._update_timer_callback_lock
196
self._update_timer_callback_lock += 1
198
self._update_timer_callback_lock -= 1
199
if old == 0 and self._update_timer_callback_lock:
200
# Will update the shown timer value every second
201
self._update_timer_callback_tag = (gobject.timeout_add
204
elif old and self._update_timer_callback_lock == 0:
205
gobject.source_remove(self._update_timer_callback_tag)
206
self._update_timer_callback_tag = None
208
def checker_completed(self, exitstatus, condition, command):
213
if os.WIFEXITED(condition):
214
self.logger('Checker for client {0} (command "{1}")'
215
' failed with exit code {2}'
216
.format(self.properties["Name"], command,
217
os.WEXITSTATUS(condition)))
218
elif os.WIFSIGNALED(condition):
219
self.logger('Checker for client {0} (command "{1}") was'
220
' killed by signal {2}'
221
.format(self.properties["Name"], command,
222
os.WTERMSIG(condition)))
223
elif os.WCOREDUMP(condition):
224
self.logger('Checker for client {0} (command "{1}")'
226
.format(self.properties["Name"], command))
228
self.logger('Checker for client {0} completed'
230
.format(self.properties["Name"]))
233
def checker_started(self, command):
234
"""Server signals that a checker started. This could be useful
235
to log in the future. """
236
#self.logger('Client {0} started checker "{1}"'
237
# .format(self.properties["Name"],
241
def got_secret(self):
242
self.logger('Client {0} received its secret'
243
.format(self.properties["Name"]))
245
def need_approval(self, timeout, default):
247
message = 'Client {0} needs approval within {1} seconds'
249
message = 'Client {0} will get its secret in {1} seconds'
250
self.logger(message.format(self.properties["Name"],
252
self.using_timer(True)
254
def rejected(self, reason):
255
self.logger('Client {0} was rejected; reason: {1}'
256
.format(self.properties["Name"], reason))
258
def selectable(self):
259
"""Make this a "selectable" widget.
260
This overrides the method from urwid.FlowWidget."""
263
def rows(self, maxcolrow, focus=False):
264
"""How many rows this widget will occupy might depend on
265
whether we have focus or not.
266
This overrides the method from urwid.FlowWidget"""
267
return self.current_widget(focus).rows(maxcolrow, focus=focus)
269
def current_widget(self, focus=False):
270
if focus or self.opened:
271
return self._focus_widget
275
"Called when what is visible on the screen should be updated."
276
# How to add standout mode to a style
277
with_standout = { "normal": "standout",
278
"bold": "bold-standout",
280
"underline-blink-standout",
281
"bold-underline-blink":
282
"bold-underline-blink-standout",
285
# Rebuild focus and non-focus widgets using current properties
287
# Base part of a client. Name!
288
base = '{name}: '.format(name=self.properties["Name"])
289
if not self.properties["Enabled"]:
291
elif self.properties["ApprovalPending"]:
292
timeout = datetime.timedelta(milliseconds
295
last_approval_request = isoformat_to_datetime(
296
self.properties["LastApprovalRequest"])
297
if last_approval_request is not None:
298
timer = timeout - (datetime.datetime.utcnow()
299
- last_approval_request)
301
timer = datetime.timedelta()
302
if self.properties["ApprovedByDefault"]:
303
message = "Approval in {0}. (d)eny?"
305
message = "Denial in {0}. (a)pprove?"
306
message = message.format(unicode(timer).rsplit(".", 1)[0])
307
elif self.properties["LastCheckerStatus"] != 0:
308
# When checker has failed, show timer until client expires
309
expires = self.properties["Expires"]
311
timer = datetime.timedelta(0)
313
expires = (datetime.datetime.strptime
314
(expires, '%Y-%m-%dT%H:%M:%S.%f'))
315
timer = expires - datetime.datetime.utcnow()
316
message = ('A checker has failed! Time until client'
317
' gets disabled: {0}'
318
.format(unicode(timer).rsplit(".", 1)[0]))
321
self._text = "{0}{1}".format(base, message)
323
if not urwid.supports_unicode():
324
self._text = self._text.encode("ascii", "replace")
325
textlist = [("normal", self._text)]
326
self._text_widget.set_text(textlist)
327
self._focus_text_widget.set_text([(with_standout[text[0]],
329
if isinstance(text, tuple)
331
for text in textlist])
332
self._widget = self._text_widget
333
self._focus_widget = urwid.AttrWrap(self._focus_text_widget,
335
# Run update hook, if any
336
if self.update_hook is not None:
339
def update_timer(self):
340
"""called by gobject. Will indefinitely loop until
341
gobject.source_remove() on tag is called"""
343
return True # Keep calling this
345
def delete(self, *args, **kwargs):
346
if self._update_timer_callback_tag is not None:
347
gobject.source_remove(self._update_timer_callback_tag)
348
self._update_timer_callback_tag = None
349
for match in self.match_objects:
351
self.match_objects = ()
352
if self.delete_hook is not None:
353
self.delete_hook(self)
354
return super(MandosClientWidget, self).delete(*args, **kwargs)
356
def render(self, maxcolrow, focus=False):
357
"""Render differently if we have focus.
358
This overrides the method from urwid.FlowWidget"""
359
return self.current_widget(focus).render(maxcolrow,
362
def keypress(self, maxcolrow, key):
364
This overrides the method from urwid.FlowWidget"""
366
self.proxy.Enable(dbus_interface = client_interface,
369
self.proxy.Disable(dbus_interface = client_interface,
372
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
373
dbus_interface = client_interface,
376
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
377
dbus_interface = client_interface,
379
elif key == "R" or key == "_" or key == "ctrl k":
380
self.server_proxy_object.RemoveClient(self.proxy
384
self.proxy.StartChecker(dbus_interface = client_interface,
387
self.proxy.StopChecker(dbus_interface = client_interface,
390
self.proxy.CheckedOK(dbus_interface = client_interface,
393
# elif key == "p" or key == "=":
395
# elif key == "u" or key == ":":
396
# self.proxy.unpause()
402
def property_changed(self, property=None, value=None,
404
"""Call self.update() if old value is not new value.
405
This overrides the method from MandosClientPropertyCache"""
406
property_name = unicode(property)
407
old_value = self.properties.get(property_name)
408
super(MandosClientWidget, self).property_changed(
409
property=property, value=value, *args, **kwargs)
410
if self.properties.get(property_name) != old_value:
414
class ConstrainedListBox(urwid.ListBox):
415
"""Like a normal urwid.ListBox, but will consume all "up" or
416
"down" key presses, thus not allowing any containing widgets to
417
use them as an excuse to shift focus away from this widget.
419
def keypress(self, maxcolrow, key):
420
ret = super(ConstrainedListBox, self).keypress(maxcolrow, key)
421
if ret in ("up", "down"):
426
class UserInterface(object):
427
"""This is the entire user interface - the whole screen
428
with boxes, lists of client widgets, etc.
430
def __init__(self, max_log_length=1000):
431
DBusGMainLoop(set_as_default=True)
433
self.screen = urwid.curses_display.Screen()
435
self.screen.register_palette((
437
"default", "default", None),
439
"default", "default", "bold"),
441
"default", "default", "underline"),
443
"default", "default", "standout"),
444
("bold-underline-blink",
445
"default", "default", ("bold", "underline")),
447
"default", "default", ("bold", "standout")),
448
("underline-blink-standout",
449
"default", "default", ("underline", "standout")),
450
("bold-underline-blink-standout",
451
"default", "default", ("bold", "underline",
455
if urwid.supports_unicode():
456
self.divider = "─" # \u2500
457
#self.divider = "━" # \u2501
459
#self.divider = "-" # \u002d
460
self.divider = "_" # \u005f
464
self.size = self.screen.get_cols_rows()
466
self.clients = urwid.SimpleListWalker([])
467
self.clients_dict = {}
469
# We will add Text widgets to this list
471
self.max_log_length = max_log_length
473
# We keep a reference to the log widget so we can remove it
474
# from the ListWalker without it getting destroyed
475
self.logbox = ConstrainedListBox(self.log)
477
# This keeps track of whether self.uilist currently has
478
# self.logbox in it or not
479
self.log_visible = True
480
self.log_wrap = "any"
483
self.log_message_raw(("bold",
484
"Mandos Monitor version " + version))
485
self.log_message_raw(("bold",
488
self.busname = domain + '.Mandos'
489
self.main_loop = gobject.MainLoop()
491
def client_not_found(self, fingerprint, address):
492
self.log_message("Client with address {0} and fingerprint"
493
" {1} could not be found"
494
.format(address, fingerprint))
497
"""This rebuilds the User Interface.
498
Call this when the widget layout needs to change"""
500
#self.uilist.append(urwid.ListBox(self.clients))
501
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
503
#header=urwid.Divider(),
506
urwid.Divider(div_char=
509
self.uilist.append(self.logbox)
510
self.topwidget = urwid.Pile(self.uilist)
512
def log_message(self, message):
513
timestamp = datetime.datetime.now().isoformat()
514
self.log_message_raw(timestamp + ": " + message)
516
def log_message_raw(self, markup):
517
"""Add a log message to the log buffer."""
518
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
519
if (self.max_log_length
520
and len(self.log) > self.max_log_length):
521
del self.log[0:len(self.log)-self.max_log_length-1]
522
self.logbox.set_focus(len(self.logbox.body.contents),
526
def toggle_log_display(self):
527
"""Toggle visibility of the log buffer."""
528
self.log_visible = not self.log_visible
530
#self.log_message("Log visibility changed to: "
531
# + unicode(self.log_visible))
533
def change_log_display(self):
534
"""Change type of log display.
535
Currently, this toggles wrapping of text lines."""
536
if self.log_wrap == "clip":
537
self.log_wrap = "any"
539
self.log_wrap = "clip"
540
for textwidget in self.log:
541
textwidget.set_wrap_mode(self.log_wrap)
542
#self.log_message("Wrap mode: " + self.log_wrap)
544
def find_and_remove_client(self, path, name):
545
"""Find a client by its object path and remove it.
547
This is connected to the ClientRemoved signal from the
548
Mandos server object."""
550
client = self.clients_dict[path]
553
self.log_message("Unknown client {0!r} ({1!r}) removed"
558
def add_new_client(self, path):
559
client_proxy_object = self.bus.get_object(self.busname, path)
560
self.add_client(MandosClientWidget(server_proxy_object
563
=client_proxy_object,
572
def add_client(self, client, path=None):
573
self.clients.append(client)
575
path = client.proxy.object_path
576
self.clients_dict[path] = client
577
self.clients.sort(None, lambda c: c.properties["Name"])
580
def remove_client(self, client, path=None):
581
self.clients.remove(client)
583
path = client.proxy.object_path
584
del self.clients_dict[path]
585
if not self.clients_dict:
586
# Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker
587
# is completely emptied, we need to recreate it.
588
self.clients = urwid.SimpleListWalker([])
593
"""Redraw the screen"""
594
canvas = self.topwidget.render(self.size, focus=True)
595
self.screen.draw_screen(self.size, canvas)
598
"""Start the main loop and exit when it's done."""
599
self.bus = dbus.SystemBus()
600
mandos_dbus_objc = self.bus.get_object(
601
self.busname, "/", follow_name_owner_changes=True)
602
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
606
mandos_clients = (self.mandos_serv
607
.GetAllClientsWithProperties())
608
except dbus.exceptions.DBusException:
609
mandos_clients = dbus.Dictionary()
612
.connect_to_signal("ClientRemoved",
613
self.find_and_remove_client,
614
dbus_interface=server_interface,
617
.connect_to_signal("ClientAdded",
619
dbus_interface=server_interface,
622
.connect_to_signal("ClientNotFound",
623
self.client_not_found,
624
dbus_interface=server_interface,
626
for path, client in mandos_clients.iteritems():
627
client_proxy_object = self.bus.get_object(self.busname,
629
self.add_client(MandosClientWidget(server_proxy_object
632
=client_proxy_object,
643
self._input_callback_tag = (gobject.io_add_watch
648
# Main loop has finished, we should close everything now
649
gobject.source_remove(self._input_callback_tag)
653
self.main_loop.quit()
655
def process_input(self, source, condition):
656
keys = self.screen.get_input()
657
translations = { "ctrl n": "down", # Emacs
658
"ctrl p": "up", # Emacs
659
"ctrl v": "page down", # Emacs
660
"meta v": "page up", # Emacs
661
" ": "page down", # less
662
"f": "page down", # less
663
"b": "page up", # less
669
key = translations[key]
670
except KeyError: # :-)
673
if key == "q" or key == "Q":
676
elif key == "window resize":
677
self.size = self.screen.get_cols_rows()
679
elif key == "\f": # Ctrl-L
681
elif key == "l" or key == "D":
682
self.toggle_log_display()
684
elif key == "w" or key == "i":
685
self.change_log_display()
687
elif key == "?" or key == "f1" or key == "esc":
688
if not self.log_visible:
689
self.log_visible = True
691
self.log_message_raw(("bold",
695
"l: Log window toggle",
696
"TAB: Switch window",
698
self.log_message_raw(("bold",
704
"s: Start new checker",
711
if self.topwidget.get_focus() is self.logbox:
712
self.topwidget.set_focus(0)
714
self.topwidget.set_focus(self.logbox)
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)
742
except KeyboardInterrupt:
745
ui.log_message(unicode(e))