2
# -*- mode: python; coding: utf-8 -*-
 
 
4
from __future__ import division, absolute_import, with_statement
 
 
12
import urwid.curses_display
 
 
15
from dbus.mainloop.glib import DBusGMainLoop
 
 
24
locale.setlocale(locale.LC_ALL, u'')
 
 
27
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
 
 
29
# Some useful constants
 
 
30
domain = 'se.bsnet.fukt'
 
 
31
server_interface = domain + '.Mandos'
 
 
32
client_interface = domain + '.Mandos.Client'
 
 
35
# Always run in monochrome mode
 
 
36
urwid.curses_display.curses.has_colors = lambda : False
 
 
38
# Urwid doesn't support blinking, but we want it.  Since we have no
 
 
39
# use for underline on its own, we make underline also always blink.
 
 
40
urwid.curses_display.curses.A_UNDERLINE |= (
 
 
41
    urwid.curses_display.curses.A_BLINK)
 
 
43
def isoformat_to_datetime(iso):
 
 
44
    "Parse an ISO 8601 date string to a datetime.datetime()"
 
 
47
    d, t = iso.split(u"T", 1)
 
 
48
    year, month, day = d.split(u"-", 2)
 
 
49
    hour, minute, second = t.split(u":", 2)
 
 
50
    second, fraction = divmod(float(second), 1)
 
 
51
    return datetime.datetime(int(year),
 
 
56
                             int(second),           # Whole seconds
 
 
57
                             int(fraction*1000000)) # Microseconds
 
 
59
class MandosClientPropertyCache(object):
 
 
60
    """This wraps a Mandos Client D-Bus proxy object, caches the
 
 
61
    properties and calls a hook function when any of them are
 
 
64
    def __init__(self, proxy_object=None, *args, **kwargs):
 
 
65
        self.proxy = proxy_object # Mandos Client proxy object
 
 
67
        self.properties = dict()
 
 
68
        self.proxy.connect_to_signal(u"PropertyChanged",
 
 
69
                                     self.property_changed,
 
 
73
        self.properties.update(
 
 
74
            self.proxy.GetAll(client_interface,
 
 
75
                              dbus_interface = dbus.PROPERTIES_IFACE))
 
 
77
        #XXX This break good super behaviour!
 
 
78
#        super(MandosClientPropertyCache, self).__init__(
 
 
81
    def property_changed(self, property=None, value=None):
 
 
82
        """This is called whenever we get a PropertyChanged signal
 
 
83
        It updates the changed property in the "properties" dict.
 
 
85
        # Update properties dict with new value
 
 
86
        self.properties[property] = value
 
 
89
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
 
 
90
    """A Mandos Client which is visible on the screen.
 
 
93
    def __init__(self, server_proxy_object=None, update_hook=None,
 
 
94
                 delete_hook=None, logger=None, *args, **kwargs):
 
 
96
        self.update_hook = update_hook
 
 
98
        self.delete_hook = delete_hook
 
 
99
        # Mandos Server proxy object
 
 
100
        self.server_proxy_object = server_proxy_object
 
 
104
        self._update_timer_callback_tag = None
 
 
105
        self.last_checker_failed = False
 
 
107
        # The widget shown normally
 
 
108
        self._text_widget = urwid.Text(u"")
 
 
109
        # The widget shown when we have focus
 
 
110
        self._focus_text_widget = urwid.Text(u"")
 
 
111
        super(MandosClientWidget, self).__init__(
 
 
112
            update_hook=update_hook, delete_hook=delete_hook,
 
 
116
        self.proxy.connect_to_signal(u"CheckerCompleted",
 
 
117
                                     self.checker_completed,
 
 
120
        self.proxy.connect_to_signal(u"CheckerStarted",
 
 
121
                                     self.checker_started,
 
 
124
        self.proxy.connect_to_signal(u"GotSecret",
 
 
128
        self.proxy.connect_to_signal(u"NeedApproval",
 
 
132
        self.proxy.connect_to_signal(u"Rejected",
 
 
136
        last_checked_ok = isoformat_to_datetime(self.properties
 
 
138
        if last_checked_ok is None:
 
 
139
            self.last_checker_failed = True
 
 
141
            self.last_checker_failed = ((datetime.datetime.utcnow()
 
 
147
        if self.last_checker_failed:
 
 
148
            self._update_timer_callback_tag = (gobject.timeout_add
 
 
152
    def checker_completed(self, exitstatus, condition, command):
 
 
154
            if self.last_checker_failed:
 
 
155
                self.last_checker_failed = False
 
 
156
                gobject.source_remove(self._update_timer_callback_tag)
 
 
157
                self._update_timer_callback_tag = None
 
 
158
            #self.logger(u'Checker for client %s (command "%s")'
 
 
160
            #            % (self.properties[u"Name"], command))
 
 
164
        if not self.last_checker_failed:
 
 
165
            self.last_checker_failed = True
 
 
166
            self._update_timer_callback_tag = (gobject.timeout_add
 
 
169
        if os.WIFEXITED(condition):
 
 
170
            self.logger(u'Checker for client %s (command "%s")'
 
 
171
                        u' failed with exit code %s'
 
 
172
                        % (self.properties[u"Name"], command,
 
 
173
                           os.WEXITSTATUS(condition)))
 
 
174
        elif os.WIFSIGNALED(condition):
 
 
175
            self.logger(u'Checker for client %s (command "%s")'
 
 
176
                        u' was killed by signal %s'
 
 
177
                        % (self.properties[u"Name"], command,
 
 
178
                           os.WTERMSIG(condition)))
 
 
179
        elif os.WCOREDUMP(condition):
 
 
180
            self.logger(u'Checker for client %s (command "%s")'
 
 
182
                        % (self.properties[u"Name"], command))
 
 
184
            self.logger(u'Checker for client %s completed'
 
 
188
    def checker_started(self, command):
 
 
189
        #self.logger(u'Client %s started checker "%s"'
 
 
190
        #            % (self.properties[u"Name"], unicode(command)))
 
 
193
    def got_secret(self):
 
 
194
        self.last_checker_failed = False
 
 
195
        self.logger(u'Client %s received its secret'
 
 
196
                    % self.properties[u"Name"])
 
 
198
    def need_approval(self, timeout, default):
 
 
200
            message = u'Client %s needs approval within %s seconds'
 
 
202
            message = u'Client %s will get its secret in %s seconds'
 
 
204
                    % (self.properties[u"Name"], timeout/1000))
 
 
206
    def rejected(self, reason):
 
 
207
        self.logger(u'Client %s was rejected; reason: %s'
 
 
208
                    % (self.properties[u"Name"], reason))
 
 
210
    def selectable(self):
 
 
211
        """Make this a "selectable" widget.
 
 
212
        This overrides the method from urwid.FlowWidget."""
 
 
215
    def rows(self, (maxcol,), focus=False):
 
 
216
        """How many rows this widget will occupy might depend on
 
 
217
        whether we have focus or not.
 
 
218
        This overrides the method from urwid.FlowWidget"""
 
 
219
        return self.current_widget(focus).rows((maxcol,), focus=focus)
 
 
221
    def current_widget(self, focus=False):
 
 
222
        if focus or self.opened:
 
 
223
            return self._focus_widget
 
 
227
        "Called when what is visible on the screen should be updated."
 
 
228
        # How to add standout mode to a style
 
 
229
        with_standout = { u"normal": u"standout",
 
 
230
                          u"bold": u"bold-standout",
 
 
232
                              u"underline-blink-standout",
 
 
233
                          u"bold-underline-blink":
 
 
234
                              u"bold-underline-blink-standout",
 
 
237
        # Rebuild focus and non-focus widgets using current properties
 
 
239
        # Base part of a client. Name!
 
 
240
        base = (u'%(name)s: '
 
 
241
                      % {u"name": self.properties[u"Name"]})
 
 
242
        if not self.properties[u"Enabled"]:
 
 
243
            message = u"DISABLED"
 
 
244
        elif self.properties[u"ApprovalPending"]:
 
 
245
            if self.properties[u"ApprovedByDefault"]:
 
 
246
                message = u"Connection established to client. (d)eny?"
 
 
248
                message = u"Seeks approval to send secret. (a)pprove?"
 
 
249
        elif self.last_checker_failed:
 
 
250
            timeout = datetime.timedelta(milliseconds
 
 
253
            last_ok = isoformat_to_datetime(
 
 
254
                max((self.properties[u"LastCheckedOK"]
 
 
255
                     or self.properties[u"Created"]),
 
 
256
                    self.properties[u"LastEnabled"]))
 
 
257
            timer = timeout - (datetime.datetime.utcnow() - last_ok)
 
 
258
            message = (u'A checker has failed! Time until client'
 
 
260
                           % unicode(timer).rsplit(".", 1)[0])
 
 
263
        self._text = "%s%s" % (base, message)
 
 
265
        if not urwid.supports_unicode():
 
 
266
            self._text = self._text.encode("ascii", "replace")
 
 
267
        textlist = [(u"normal", self._text)]
 
 
268
        self._text_widget.set_text(textlist)
 
 
269
        self._focus_text_widget.set_text([(with_standout[text[0]],
 
 
271
                                          if isinstance(text, tuple)
 
 
273
                                          for text in textlist])
 
 
274
        self._widget = self._text_widget
 
 
275
        self._focus_widget = urwid.AttrWrap(self._focus_text_widget,
 
 
277
        # Run update hook, if any
 
 
278
        if self.update_hook is not None:
 
 
281
    def update_timer(self):
 
 
284
        return True             # Keep calling this
 
 
287
        if self._update_timer_callback_tag is not None:
 
 
288
            gobject.source_remove(self._update_timer_callback_tag)
 
 
289
            self._update_timer_callback_tag = None
 
 
290
        if self.delete_hook is not None:
 
 
291
            self.delete_hook(self)
 
 
293
    def render(self, (maxcol,), focus=False):
 
 
294
        """Render differently if we have focus.
 
 
295
        This overrides the method from urwid.FlowWidget"""
 
 
296
        return self.current_widget(focus).render((maxcol,),
 
 
299
    def keypress(self, (maxcol,), key):
 
 
301
        This overrides the method from urwid.FlowWidget"""
 
 
303
            self.proxy.Enable(dbus_interface = client_interface)
 
 
305
            self.proxy.Disable(dbus_interface = client_interface)
 
 
307
            self.proxy.Approve(dbus.Boolean(True, variant_level=1),
 
 
308
                               dbus_interface = client_interface)
 
 
310
            self.proxy.Approve(dbus.Boolean(False, variant_level=1),
 
 
311
                                  dbus_interface = client_interface)
 
 
312
        elif key == u"r" or key == u"_" or key == u"ctrl k":
 
 
313
            self.server_proxy_object.RemoveClient(self.proxy
 
 
316
            self.proxy.StartChecker(dbus_interface = client_interface)
 
 
318
            self.proxy.StopChecker(dbus_interface = client_interface)
 
 
320
            self.proxy.CheckedOK(dbus_interface = client_interface)
 
 
322
#         elif key == u"p" or key == "=":
 
 
324
#         elif key == u"u" or key == ":":
 
 
325
#             self.proxy.unpause()
 
 
326
#         elif key == u"RET":
 
 
331
    def property_changed(self, property=None, value=None,
 
 
333
        """Call self.update() if old value is not new value.
 
 
334
        This overrides the method from MandosClientPropertyCache"""
 
 
335
        property_name = unicode(property)
 
 
336
        old_value = self.properties.get(property_name)
 
 
337
        super(MandosClientWidget, self).property_changed(
 
 
338
            property=property, value=value, *args, **kwargs)
 
 
339
        if self.properties.get(property_name) != old_value:
 
 
343
class ConstrainedListBox(urwid.ListBox):
 
 
344
    """Like a normal urwid.ListBox, but will consume all "up" or
 
 
345
    "down" key presses, thus not allowing any containing widgets to
 
 
346
    use them as an excuse to shift focus away from this widget.
 
 
348
    def keypress(self, (maxcol, maxrow), key):
 
 
349
        ret = super(ConstrainedListBox, self).keypress((maxcol,
 
 
351
        if ret in (u"up", u"down"):
 
 
356
class UserInterface(object):
 
 
357
    """This is the entire user interface - the whole screen
 
 
358
    with boxes, lists of client widgets, etc.
 
 
360
    def __init__(self, max_log_length=1000):
 
 
361
        DBusGMainLoop(set_as_default=True)
 
 
363
        self.screen = urwid.curses_display.Screen()
 
 
365
        self.screen.register_palette((
 
 
367
                 u"default", u"default", None),
 
 
369
                 u"default", u"default", u"bold"),
 
 
371
                 u"default", u"default", u"underline"),
 
 
373
                 u"default", u"default", u"standout"),
 
 
374
                (u"bold-underline-blink",
 
 
375
                 u"default", u"default", (u"bold", u"underline")),
 
 
377
                 u"default", u"default", (u"bold", u"standout")),
 
 
378
                (u"underline-blink-standout",
 
 
379
                 u"default", u"default", (u"underline", u"standout")),
 
 
380
                (u"bold-underline-blink-standout",
 
 
381
                 u"default", u"default", (u"bold", u"underline",
 
 
385
        if urwid.supports_unicode():
 
 
386
            self.divider = u"─" # \u2500
 
 
387
            #self.divider = u"━" # \u2501
 
 
389
            #self.divider = u"-" # \u002d
 
 
390
            self.divider = u"_" # \u005f
 
 
394
        self.size = self.screen.get_cols_rows()
 
 
396
        self.clients = urwid.SimpleListWalker([])
 
 
397
        self.clients_dict = {}
 
 
399
        # We will add Text widgets to this list
 
 
401
        self.max_log_length = max_log_length
 
 
403
        # We keep a reference to the log widget so we can remove it
 
 
404
        # from the ListWalker without it getting destroyed
 
 
405
        self.logbox = ConstrainedListBox(self.log)
 
 
407
        # This keeps track of whether self.uilist currently has
 
 
408
        # self.logbox in it or not
 
 
409
        self.log_visible = True
 
 
410
        self.log_wrap = u"any"
 
 
413
        self.log_message_raw((u"bold",
 
 
414
                              u"Mandos Monitor version " + version))
 
 
415
        self.log_message_raw((u"bold",
 
 
418
        self.busname = domain + '.Mandos'
 
 
419
        self.main_loop = gobject.MainLoop()
 
 
420
        self.bus = dbus.SystemBus()
 
 
421
        mandos_dbus_objc = self.bus.get_object(
 
 
422
            self.busname, u"/", follow_name_owner_changes=True)
 
 
423
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
 
 
427
            mandos_clients = (self.mandos_serv
 
 
428
                              .GetAllClientsWithProperties())
 
 
429
        except dbus.exceptions.DBusException:
 
 
430
            mandos_clients = dbus.Dictionary()
 
 
433
         .connect_to_signal(u"ClientRemoved",
 
 
434
                            self.find_and_remove_client,
 
 
435
                            dbus_interface=server_interface,
 
 
438
         .connect_to_signal(u"ClientAdded",
 
 
440
                            dbus_interface=server_interface,
 
 
443
         .connect_to_signal(u"ClientNotFound",
 
 
444
                            self.client_not_found,
 
 
445
                            dbus_interface=server_interface,
 
 
447
        for path, client in mandos_clients.iteritems():
 
 
448
            client_proxy_object = self.bus.get_object(self.busname,
 
 
450
            self.add_client(MandosClientWidget(server_proxy_object
 
 
453
                                               =client_proxy_object,
 
 
463
    def client_not_found(self, fingerprint, address):
 
 
464
        self.log_message((u"Client with address %s and fingerprint %s"
 
 
465
                          u" could not be found" % (address,
 
 
469
        """This rebuilds the User Interface.
 
 
470
        Call this when the widget layout needs to change"""
 
 
472
        #self.uilist.append(urwid.ListBox(self.clients))
 
 
473
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.
 
 
475
                                       #header=urwid.Divider(),
 
 
478
                                       urwid.Divider(div_char=
 
 
481
            self.uilist.append(self.logbox)
 
 
483
        self.topwidget = urwid.Pile(self.uilist)
 
 
485
    def log_message(self, message):
 
 
486
        timestamp = datetime.datetime.now().isoformat()
 
 
487
        self.log_message_raw(timestamp + u": " + message)
 
 
489
    def log_message_raw(self, markup):
 
 
490
        """Add a log message to the log buffer."""
 
 
491
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
 
 
492
        if (self.max_log_length
 
 
493
            and len(self.log) > self.max_log_length):
 
 
494
            del self.log[0:len(self.log)-self.max_log_length-1]
 
 
495
        self.logbox.set_focus(len(self.logbox.body.contents),
 
 
496
                              coming_from=u"above")
 
 
499
    def toggle_log_display(self):
 
 
500
        """Toggle visibility of the log buffer."""
 
 
501
        self.log_visible = not self.log_visible
 
 
503
        #self.log_message(u"Log visibility changed to: "
 
 
504
        #                 + unicode(self.log_visible))
 
 
506
    def change_log_display(self):
 
 
507
        """Change type of log display.
 
 
508
        Currently, this toggles wrapping of text lines."""
 
 
509
        if self.log_wrap == u"clip":
 
 
510
            self.log_wrap = u"any"
 
 
512
            self.log_wrap = u"clip"
 
 
513
        for textwidget in self.log:
 
 
514
            textwidget.set_wrap_mode(self.log_wrap)
 
 
515
        #self.log_message(u"Wrap mode: " + self.log_wrap)
 
 
517
    def find_and_remove_client(self, path, name):
 
 
518
        """Find an client from its object path and remove it.
 
 
520
        This is connected to the ClientRemoved signal from the
 
 
521
        Mandos server object."""
 
 
523
            client = self.clients_dict[path]
 
 
527
        self.remove_client(client, path)
 
 
529
    def add_new_client(self, path):
 
 
530
        client_proxy_object = self.bus.get_object(self.busname, path)
 
 
531
        self.add_client(MandosClientWidget(server_proxy_object
 
 
534
                                           =client_proxy_object,
 
 
543
    def add_client(self, client, path=None):
 
 
544
        self.clients.append(client)
 
 
546
            path = client.proxy.object_path
 
 
547
        self.clients_dict[path] = client
 
 
548
        self.clients.sort(None, lambda c: c.properties[u"Name"])
 
 
551
    def remove_client(self, client, path=None):
 
 
552
        self.clients.remove(client)
 
 
554
            path = client.proxy.object_path
 
 
555
        del self.clients_dict[path]
 
 
556
        if not self.clients_dict:
 
 
557
            # Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker
 
 
558
            # is completely emptied, we need to recreate it.
 
 
559
            self.clients = urwid.SimpleListWalker([])
 
 
564
        """Redraw the screen"""
 
 
565
        canvas = self.topwidget.render(self.size, focus=True)
 
 
566
        self.screen.draw_screen(self.size, canvas)
 
 
569
        """Start the main loop and exit when it's done."""
 
 
571
        self._input_callback_tag = (gobject.io_add_watch
 
 
576
        # Main loop has finished, we should close everything now
 
 
577
        gobject.source_remove(self._input_callback_tag)
 
 
581
        self.main_loop.quit()
 
 
583
    def process_input(self, source, condition):
 
 
584
        keys = self.screen.get_input()
 
 
585
        translations = { u"ctrl n": u"down",      # Emacs
 
 
586
                         u"ctrl p": u"up",        # Emacs
 
 
587
                         u"ctrl v": u"page down", # Emacs
 
 
588
                         u"meta v": u"page up",   # Emacs
 
 
589
                         u" ": u"page down",      # less
 
 
590
                         u"f": u"page down",      # less
 
 
591
                         u"b": u"page up",        # less
 
 
597
                key = translations[key]
 
 
598
            except KeyError:    # :-)
 
 
601
            if key == u"q" or key == u"Q":
 
 
604
            elif key == u"window resize":
 
 
605
                self.size = self.screen.get_cols_rows()
 
 
607
            elif key == u"\f":  # Ctrl-L
 
 
609
            elif key == u"l" or key == u"D":
 
 
610
                self.toggle_log_display()
 
 
612
            elif key == u"w" or key == u"i":
 
 
613
                self.change_log_display()
 
 
615
            elif key == u"?" or key == u"f1" or key == u"esc":
 
 
616
                if not self.log_visible:
 
 
617
                    self.log_visible = True
 
 
619
                self.log_message_raw((u"bold",
 
 
623
                                            u"l: Log window toggle",
 
 
624
                                            u"TAB: Switch window",
 
 
626
                self.log_message_raw((u"bold",
 
 
632
                                             u"s: Start new checker",
 
 
639
                if self.topwidget.get_focus() is self.logbox:
 
 
640
                    self.topwidget.set_focus(0)
 
 
642
                    self.topwidget.set_focus(self.logbox)
 
 
644
            #elif (key == u"end" or key == u"meta >" or key == u"G"
 
 
646
            #    pass            # xxx end-of-buffer
 
 
647
            #elif (key == u"home" or key == u"meta <" or key == u"g"
 
 
649
            #    pass            # xxx beginning-of-buffer
 
 
650
            #elif key == u"ctrl e" or key == u"$":
 
 
651
            #    pass            # xxx move-end-of-line
 
 
652
            #elif key == u"ctrl a" or key == u"^":
 
 
653
            #    pass            # xxx move-beginning-of-line
 
 
654
            #elif key == u"ctrl b" or key == u"meta (" or key == u"h":
 
 
656
            #elif key == u"ctrl f" or key == u"meta )" or key == u"l":
 
 
659
            #    pass            # scroll up log
 
 
661
            #    pass            # scroll down log
 
 
662
            elif self.topwidget.selectable():
 
 
663
                self.topwidget.keypress(self.size, key)
 
 
670
except KeyboardInterrupt:
 
 
673
    ui.log_message(unicode(e))