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()
 
 
145
                                         self.properties["interval"]))
 
 
146
        if self.last_checker_failed:
 
 
147
            self._update_timer_callback_tag = (gobject.timeout_add
 
 
151
    def checker_completed(self, exitstatus, condition, command):
 
 
153
            if self.last_checker_failed:
 
 
154
                self.last_checker_failed = False
 
 
155
                gobject.source_remove(self._update_timer_callback_tag)
 
 
156
                self._update_timer_callback_tag = None
 
 
157
            self.logger(u'Checker for client %s (command "%s")'
 
 
159
                        % (self.properties[u"name"], command))
 
 
163
        if not self.last_checker_failed:
 
 
164
            self.last_checker_failed = True
 
 
165
            self._update_timer_callback_tag = (gobject.timeout_add
 
 
168
        if os.WIFEXITED(condition):
 
 
169
            self.logger(u'Checker for client %s (command "%s")'
 
 
170
                        u' failed with exit code %s'
 
 
171
                        % (self.properties[u"name"], command,
 
 
172
                           os.WEXITSTATUS(condition)))
 
 
173
        elif os.WIFSIGNALED(condition):
 
 
174
            self.logger(u'Checker for client %s (command "%s")'
 
 
175
                        u' was killed by signal %s'
 
 
176
                        % (self.properties[u"name"], command,
 
 
177
                           os.WTERMSIG(condition)))
 
 
178
        elif os.WCOREDUMP(condition):
 
 
179
            self.logger(u'Checker for client %s (command "%s")'
 
 
181
                        % (self.properties[u"name"], command))
 
 
183
            self.logger(u'Checker for client %s completed mysteriously')
 
 
186
    def checker_started(self, command):
 
 
187
        #self.logger(u'Client %s started checker "%s"'
 
 
188
        #            % (self.properties[u"name"], unicode(command)))
 
 
191
    def got_secret(self):
 
 
192
        self.logger(u'Client %s received its secret'
 
 
193
                    % self.properties[u"name"])
 
 
195
    def need_approval(self, timeout, default):
 
 
197
            message = u'Client %s needs approval within %s seconds'
 
 
199
            message = u'Client %s will get its secret in %s seconds'
 
 
201
                    % (self.properties[u"name"], timeout/1000))
 
 
203
    def rejected(self, reason):
 
 
204
        self.logger(u'Client %s was rejected; reason: %s'
 
 
205
                    % (self.properties[u"name"], reason))
 
 
207
    def selectable(self):
 
 
208
        """Make this a "selectable" widget.
 
 
209
        This overrides the method from urwid.FlowWidget."""
 
 
212
    def rows(self, (maxcol,), focus=False):
 
 
213
        """How many rows this widget will occupy might depend on
 
 
214
        whether we have focus or not.
 
 
215
        This overrides the method from urwid.FlowWidget"""
 
 
216
        return self.current_widget(focus).rows((maxcol,), focus=focus)
 
 
218
    def current_widget(self, focus=False):
 
 
219
        if focus or self.opened:
 
 
220
            return self._focus_widget
 
 
224
        "Called when what is visible on the screen should be updated."
 
 
225
        # How to add standout mode to a style
 
 
226
        with_standout = { u"normal": u"standout",
 
 
227
                          u"bold": u"bold-standout",
 
 
229
                              u"underline-blink-standout",
 
 
230
                          u"bold-underline-blink":
 
 
231
                              u"bold-underline-blink-standout",
 
 
234
        # Rebuild focus and non-focus widgets using current properties
 
 
236
        # Base part of a client. Name!
 
 
237
        base = (u'%(name)s: '
 
 
238
                      % {u"name": self.properties[u"name"]})
 
 
239
        if not self.properties[u"enabled"]:
 
 
240
            message = u"DISABLED"
 
 
241
        elif self.last_checker_failed:
 
 
242
            timeout = datetime.timedelta(milliseconds
 
 
243
                                         = self.properties[u"timeout"])
 
 
244
            last_ok = isoformat_to_datetime(
 
 
245
                max((self.properties["last_checked_ok"]
 
 
246
                     or self.properties["created"]),
 
 
247
                    self.properties[u"last_enabled"]))
 
 
248
            timer = timeout - (datetime.datetime.utcnow() - last_ok)
 
 
250
            message = (u'A checker has failed! Time until client gets diabled: %s'
 
 
252
        elif self.properties[u"approved_pending"]:
 
 
253
            if self.properties[u"approved_by_default"]:
 
 
254
                message = u"Connection established to client. (d)eny?"
 
 
256
                message = u"Seeks approval to send secret. (a)pprove?"
 
 
259
        self._text = "%s%s" % (base, message)
 
 
261
        if not urwid.supports_unicode():
 
 
262
            self._text = self._text.encode("ascii", "replace")
 
 
263
        textlist = [(u"normal", self._text)]
 
 
264
        self._text_widget.set_text(textlist)
 
 
265
        self._focus_text_widget.set_text([(with_standout[text[0]],
 
 
267
                                          if isinstance(text, tuple)
 
 
269
                                          for text in textlist])
 
 
270
        self._widget = self._text_widget
 
 
271
        self._focus_widget = urwid.AttrWrap(self._focus_text_widget,
 
 
273
        # Run update hook, if any
 
 
274
        if self.update_hook is not None:
 
 
277
    def update_timer(self):
 
 
280
        return True             # Keep calling this
 
 
283
        if self._update_timer_callback_tag is not None:
 
 
284
            gobject.source_remove(self._update_timer_callback_tag)
 
 
285
            self._update_timer_callback_tag = None
 
 
286
        if self.delete_hook is not None:
 
 
287
            self.delete_hook(self)
 
 
289
    def render(self, (maxcol,), focus=False):
 
 
290
        """Render differently if we have focus.
 
 
291
        This overrides the method from urwid.FlowWidget"""
 
 
292
        return self.current_widget(focus).render((maxcol,),
 
 
295
    def keypress(self, (maxcol,), key):
 
 
297
        This overrides the method from urwid.FlowWidget"""
 
 
299
            self.proxy.Enable(dbus_interface = client_interface)
 
 
301
            self.proxy.Disable(dbus_interface = client_interface)
 
 
303
            self.proxy.Approve(dbus.Boolean(True, variant_level=1),
 
 
304
                               dbus_interface = client_interface)
 
 
306
            self.proxy.Approve(dbus.Boolean(False, variant_level=1),
 
 
307
                                  dbus_interface = client_interface)
 
 
308
        elif key == u"r" or key == u"_" or key == u"ctrl k":
 
 
309
            self.server_proxy_object.RemoveClient(self.proxy
 
 
312
            self.proxy.StartChecker(dbus_interface = client_interface)
 
 
314
            self.proxy.StopChecker(dbus_interface = client_interface)
 
 
316
            self.proxy.CheckedOK(dbus_interface = client_interface)
 
 
318
#         elif key == u"p" or key == "=":
 
 
320
#         elif key == u"u" or key == ":":
 
 
321
#             self.proxy.unpause()
 
 
322
#         elif key == u"RET":
 
 
325
#            self.proxy.Approve(True)
 
 
327
#            self.proxy.Approve(False)
 
 
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, maxrow), key)
 
 
350
        if ret in (u"up", u"down"):
 
 
355
class UserInterface(object):
 
 
356
    """This is the entire user interface - the whole screen
 
 
357
    with boxes, lists of client widgets, etc.
 
 
359
    def __init__(self, max_log_length=1000):
 
 
360
        DBusGMainLoop(set_as_default=True)
 
 
362
        self.screen = urwid.curses_display.Screen()
 
 
364
        self.screen.register_palette((
 
 
366
                 u"default", u"default", None),
 
 
368
                 u"default", u"default", u"bold"),
 
 
370
                 u"default", u"default", u"underline"),
 
 
372
                 u"default", u"default", u"standout"),
 
 
373
                (u"bold-underline-blink",
 
 
374
                 u"default", u"default", (u"bold", u"underline")),
 
 
376
                 u"default", u"default", (u"bold", u"standout")),
 
 
377
                (u"underline-blink-standout",
 
 
378
                 u"default", u"default", (u"underline", u"standout")),
 
 
379
                (u"bold-underline-blink-standout",
 
 
380
                 u"default", u"default", (u"bold", u"underline",
 
 
384
        if urwid.supports_unicode():
 
 
385
            self.divider = u"─" # \u2500
 
 
386
            #self.divider = u"━" # \u2501
 
 
388
            #self.divider = u"-" # \u002d
 
 
389
            self.divider = u"_" # \u005f
 
 
393
        self.size = self.screen.get_cols_rows()
 
 
395
        self.clients = urwid.SimpleListWalker([])
 
 
396
        self.clients_dict = {}
 
 
398
        # We will add Text widgets to this list
 
 
400
        self.max_log_length = max_log_length
 
 
402
        # We keep a reference to the log widget so we can remove it
 
 
403
        # from the ListWalker without it getting destroyed
 
 
404
        self.logbox = ConstrainedListBox(self.log)
 
 
406
        # This keeps track of whether self.uilist currently has
 
 
407
        # self.logbox in it or not
 
 
408
        self.log_visible = True
 
 
409
        self.log_wrap = u"any"
 
 
412
        self.log_message_raw((u"bold",
 
 
413
                              u"Mandos Monitor version " + version))
 
 
414
        self.log_message_raw((u"bold",
 
 
417
        self.busname = domain + '.Mandos'
 
 
418
        self.main_loop = gobject.MainLoop()
 
 
419
        self.bus = dbus.SystemBus()
 
 
420
        mandos_dbus_objc = self.bus.get_object(
 
 
421
            self.busname, u"/", follow_name_owner_changes=True)
 
 
422
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
 
 
426
            mandos_clients = (self.mandos_serv
 
 
427
                              .GetAllClientsWithProperties())
 
 
428
        except dbus.exceptions.DBusException:
 
 
429
            mandos_clients = dbus.Dictionary()
 
 
432
         .connect_to_signal(u"ClientRemoved",
 
 
433
                            self.find_and_remove_client,
 
 
434
                            dbus_interface=server_interface,
 
 
437
         .connect_to_signal(u"ClientAdded",
 
 
439
                            dbus_interface=server_interface,
 
 
442
         .connect_to_signal(u"ClientNotFound",
 
 
443
                            self.client_not_found,
 
 
444
                            dbus_interface=server_interface,
 
 
446
        for path, client in mandos_clients.iteritems():
 
 
447
            client_proxy_object = self.bus.get_object(self.busname,
 
 
449
            self.add_client(MandosClientWidget(server_proxy_object
 
 
452
                                               =client_proxy_object,
 
 
462
    def client_not_found(self, fingerprint, address):
 
 
463
        self.log_message((u"Client with address %s and fingerprint %s"
 
 
464
                          u" could not be found" % (address,
 
 
468
        """This rebuilds the User Interface.
 
 
469
        Call this when the widget layout needs to change"""
 
 
471
        #self.uilist.append(urwid.ListBox(self.clients))
 
 
472
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
 
 
473
                                       #header=urwid.Divider(),
 
 
475
                                       footer=urwid.Divider(div_char=self.divider)))
 
 
477
            self.uilist.append(self.logbox)
 
 
479
        self.topwidget = urwid.Pile(self.uilist)
 
 
481
    def log_message(self, message):
 
 
482
        timestamp = datetime.datetime.now().isoformat()
 
 
483
        self.log_message_raw(timestamp + u": " + message)
 
 
485
    def log_message_raw(self, markup):
 
 
486
        """Add a log message to the log buffer."""
 
 
487
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
 
 
488
        if (self.max_log_length
 
 
489
            and len(self.log) > self.max_log_length):
 
 
490
            del self.log[0:len(self.log)-self.max_log_length-1]
 
 
491
        self.logbox.set_focus(len(self.logbox.body.contents),
 
 
492
                              coming_from=u"above")
 
 
495
    def toggle_log_display(self):
 
 
496
        """Toggle visibility of the log buffer."""
 
 
497
        self.log_visible = not self.log_visible
 
 
499
        self.log_message(u"Log visibility changed to: "
 
 
500
                         + unicode(self.log_visible))
 
 
502
    def change_log_display(self):
 
 
503
        """Change type of log display.
 
 
504
        Currently, this toggles wrapping of text lines."""
 
 
505
        if self.log_wrap == u"clip":
 
 
506
            self.log_wrap = u"any"
 
 
508
            self.log_wrap = u"clip"
 
 
509
        for textwidget in self.log:
 
 
510
            textwidget.set_wrap_mode(self.log_wrap)
 
 
511
        self.log_message(u"Wrap mode: " + self.log_wrap)
 
 
513
    def find_and_remove_client(self, path, name):
 
 
514
        """Find an client from its object path and remove it.
 
 
516
        This is connected to the ClientRemoved signal from the
 
 
517
        Mandos server object."""
 
 
519
            client = self.clients_dict[path]
 
 
523
        self.remove_client(client, path)
 
 
525
    def add_new_client(self, path):
 
 
526
        client_proxy_object = self.bus.get_object(self.busname, path)
 
 
527
        self.add_client(MandosClientWidget(server_proxy_object
 
 
530
                                           =client_proxy_object,
 
 
539
    def add_client(self, client, path=None):
 
 
540
        self.clients.append(client)
 
 
542
            path = client.proxy.object_path
 
 
543
        self.clients_dict[path] = client
 
 
544
        self.clients.sort(None, lambda c: c.properties[u"name"])
 
 
547
    def remove_client(self, client, path=None):
 
 
548
        self.clients.remove(client)
 
 
550
            path = client.proxy.object_path
 
 
551
        del self.clients_dict[path]
 
 
552
        if not self.clients_dict:
 
 
553
            # Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker
 
 
554
            # is completely emptied, we need to recreate it.
 
 
555
            self.clients = urwid.SimpleListWalker([])
 
 
560
        """Redraw the screen"""
 
 
561
        canvas = self.topwidget.render(self.size, focus=True)
 
 
562
        self.screen.draw_screen(self.size, canvas)
 
 
565
        """Start the main loop and exit when it's done."""
 
 
567
        self._input_callback_tag = (gobject.io_add_watch
 
 
572
        # Main loop has finished, we should close everything now
 
 
573
        gobject.source_remove(self._input_callback_tag)
 
 
577
        self.main_loop.quit()
 
 
579
    def process_input(self, source, condition):
 
 
580
        keys = self.screen.get_input()
 
 
581
        translations = { u"ctrl n": u"down",      # Emacs
 
 
582
                         u"ctrl p": u"up",        # Emacs
 
 
583
                         u"ctrl v": u"page down", # Emacs
 
 
584
                         u"meta v": u"page up",   # Emacs
 
 
585
                         u" ": u"page down",      # less
 
 
586
                         u"f": u"page down",      # less
 
 
587
                         u"b": u"page up",        # less
 
 
593
                key = translations[key]
 
 
594
            except KeyError:    # :-)
 
 
597
            if key == u"q" or key == u"Q":
 
 
600
            elif key == u"window resize":
 
 
601
                self.size = self.screen.get_cols_rows()
 
 
603
            elif key == u"\f":  # Ctrl-L
 
 
605
            elif key == u"l" or key == u"D":
 
 
606
                self.toggle_log_display()
 
 
608
            elif key == u"w" or key == u"i":
 
 
609
                self.change_log_display()
 
 
611
            elif key == u"?" or key == u"f1" or key == u"esc":
 
 
612
                if not self.log_visible:
 
 
613
                    self.log_visible = True
 
 
615
                self.log_message_raw((u"bold",
 
 
619
                                            u"l: Log window toggle",
 
 
620
                                            u"TAB: Switch window",
 
 
622
                self.log_message_raw((u"bold",
 
 
628
                                             u"s: Start new checker",
 
 
635
                if self.topwidget.get_focus() is self.logbox:
 
 
636
                    self.topwidget.set_focus(0)
 
 
638
                    self.topwidget.set_focus(self.logbox)
 
 
640
            #elif (key == u"end" or key == u"meta >" or key == u"G"
 
 
642
            #    pass            # xxx end-of-buffer
 
 
643
            #elif (key == u"home" or key == u"meta <" or key == u"g"
 
 
645
            #    pass            # xxx beginning-of-buffer
 
 
646
            #elif key == u"ctrl e" or key == u"$":
 
 
647
            #    pass            # xxx move-end-of-line
 
 
648
            #elif key == u"ctrl a" or key == u"^":
 
 
649
            #    pass            # xxx move-beginning-of-line
 
 
650
            #elif key == u"ctrl b" or key == u"meta (" or key == u"h":
 
 
652
            #elif key == u"ctrl f" or key == u"meta )" or key == u"l":
 
 
655
            #    pass            # scroll up log
 
 
657
            #    pass            # scroll down log
 
 
658
            elif self.topwidget.selectable():
 
 
659
                self.topwidget.keypress(self.size, key)
 
 
667
    ui.log_message(unicode(e))