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
class MandosClientPropertyCache(object):
 
 
44
    """This wraps a Mandos Client D-Bus proxy object, caches the
 
 
45
    properties and calls a hook function when any of them are
 
 
48
    def __init__(self, proxy_object=None, *args, **kwargs):
 
 
49
        self.proxy = proxy_object # Mandos Client proxy object
 
 
51
        self.properties = dict()
 
 
52
        self.proxy.connect_to_signal(u"PropertyChanged",
 
 
53
                                     self.property_changed,
 
 
57
        self.properties.update(
 
 
58
            self.proxy.GetAll(client_interface,
 
 
59
                              dbus_interface = dbus.PROPERTIES_IFACE))
 
 
61
        #XXX This break good super behaviour!
 
 
62
#        super(MandosClientPropertyCache, self).__init__(
 
 
65
    def property_changed(self, property=None, value=None):
 
 
66
        """This is called whenever we get a PropertyChanged signal
 
 
67
        It updates the changed property in the "properties" dict.
 
 
69
        # Update properties dict with new value
 
 
70
        self.properties[property] = value
 
 
73
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
 
 
74
    """A Mandos Client which is visible on the screen.
 
 
77
    def __init__(self, server_proxy_object=None, update_hook=None,
 
 
78
                 delete_hook=None, logger=None, *args, **kwargs):
 
 
80
        self.update_hook = update_hook
 
 
82
        self.delete_hook = delete_hook
 
 
83
        # Mandos Server proxy object
 
 
84
        self.server_proxy_object = server_proxy_object
 
 
88
        # The widget shown normally
 
 
89
        self._text_widget = urwid.Text(u"")
 
 
90
        # The widget shown when we have focus
 
 
91
        self._focus_text_widget = urwid.Text(u"")
 
 
92
        super(MandosClientWidget, self).__init__(
 
 
93
            update_hook=update_hook, delete_hook=delete_hook,
 
 
97
        self.proxy.connect_to_signal(u"CheckerCompleted",
 
 
98
                                     self.checker_completed,
 
 
101
        self.proxy.connect_to_signal(u"CheckerStarted",
 
 
102
                                     self.checker_started,
 
 
105
        self.proxy.connect_to_signal(u"GotSecret",
 
 
109
        self.proxy.connect_to_signal(u"NeedApproval",
 
 
113
        self.proxy.connect_to_signal(u"Rejected",
 
 
118
    def checker_completed(self, exitstatus, condition, command):
 
 
120
            #self.logger(u'Checker for client %s (command "%s")'
 
 
122
            #            % (self.properties[u"name"], command))
 
 
124
        if os.WIFEXITED(condition):
 
 
125
            self.logger(u'Checker for client %s (command "%s")'
 
 
126
                        u' failed with exit code %s'
 
 
127
                        % (self.properties[u"name"], command,
 
 
128
                           os.WEXITSTATUS(condition)))
 
 
130
        if os.WIFSIGNALED(condition):
 
 
131
            self.logger(u'Checker for client %s (command "%s")'
 
 
132
                        u' was killed by signal %s'
 
 
133
                        % (self.properties[u"name"], command,
 
 
134
                           os.WTERMSIG(condition)))
 
 
136
        if os.WCOREDUMP(condition):
 
 
137
            self.logger(u'Checker for client %s (command "%s")'
 
 
139
                        % (self.properties[u"name"], command))
 
 
140
        self.logger(u'Checker for client %s completed mysteriously')
 
 
142
    def checker_started(self, command):
 
 
143
        #self.logger(u'Client %s started checker "%s"'
 
 
144
        #            % (self.properties[u"name"], unicode(command)))
 
 
147
    def got_secret(self):
 
 
148
        self.logger(u'Client %s received its secret'
 
 
149
                    % self.properties[u"name"])
 
 
151
    def need_approval(self, timeout, default):
 
 
153
            message = u'Client %s needs approval within %s seconds'
 
 
155
            message = u'Client %s will get its secret in %s seconds'
 
 
157
                    % (self.properties[u"name"], timeout/1000))
 
 
159
    def rejected(self, reason):
 
 
160
        self.logger(u'Client %s was rejected; reason: %s'
 
 
161
                    % (self.properties[u"name"], reason))
 
 
163
    def selectable(self):
 
 
164
        """Make this a "selectable" widget.
 
 
165
        This overrides the method from urwid.FlowWidget."""
 
 
168
    def rows(self, (maxcol,), focus=False):
 
 
169
        """How many rows this widget will occupy might depend on
 
 
170
        whether we have focus or not.
 
 
171
        This overrides the method from urwid.FlowWidget"""
 
 
172
        return self.current_widget(focus).rows((maxcol,), focus=focus)
 
 
174
    def current_widget(self, focus=False):
 
 
175
        if focus or self.opened:
 
 
176
            return self._focus_widget
 
 
180
        "Called when what is visible on the screen should be updated."
 
 
181
        # How to add standout mode to a style
 
 
182
        with_standout = { u"normal": u"standout",
 
 
183
                          u"bold": u"bold-standout",
 
 
185
                              u"underline-blink-standout",
 
 
186
                          u"bold-underline-blink":
 
 
187
                              u"bold-underline-blink-standout",
 
 
190
        # Rebuild focus and non-focus widgets using current properties
 
 
192
        # Base part of a client. Name!
 
 
193
        self._text = (u'%(name)s: '
 
 
194
                      % {u"name": self.properties[u"name"]})
 
 
196
        if self.properties[u"approved_pending"]:
 
 
197
            if self.properties[u"approved_by_default"]:
 
 
198
                self._text += u"Connection established to client. (d)eny?"
 
 
200
                self._text += u"Seeks approval to send secret. (a)pprove?"
 
 
202
            self._text += (u'%(enabled)s'
 
 
205
                                if self.properties[u"enabled"]
 
 
207
        if not urwid.supports_unicode():
 
 
208
            self._text = self._text.encode("ascii", "replace")
 
 
209
        textlist = [(u"normal", self._text)]
 
 
210
        self._text_widget.set_text(textlist)
 
 
211
        self._focus_text_widget.set_text([(with_standout[text[0]],
 
 
213
                                          if isinstance(text, tuple)
 
 
215
                                          for text in textlist])
 
 
216
        self._widget = self._text_widget
 
 
217
        self._focus_widget = urwid.AttrWrap(self._focus_text_widget,
 
 
219
        # Run update hook, if any
 
 
220
        if self.update_hook is not None:
 
 
224
        if self.delete_hook is not None:
 
 
225
            self.delete_hook(self)
 
 
227
    def render(self, (maxcol,), focus=False):
 
 
228
        """Render differently if we have focus.
 
 
229
        This overrides the method from urwid.FlowWidget"""
 
 
230
        return self.current_widget(focus).render((maxcol,),
 
 
233
    def keypress(self, (maxcol,), key):
 
 
235
        This overrides the method from urwid.FlowWidget"""
 
 
237
            self.proxy.Enable(dbus_interface = client_interface)
 
 
239
            self.proxy.Disable(dbus_interface = client_interface)
 
 
241
            self.proxy.Approve(dbus.Boolean(True, variant_level=1),
 
 
242
                               dbus_interface = client_interface)
 
 
244
            self.proxy.Approve(dbus.Boolean(False, variant_level=1),
 
 
245
                                  dbus_interface = client_interface)
 
 
246
        elif key == u"r" or key == u"_" or key == u"ctrl k":
 
 
247
            self.server_proxy_object.RemoveClient(self.proxy
 
 
250
            self.proxy.StartChecker(dbus_interface = client_interface)
 
 
252
            self.proxy.StopChecker(dbus_interface = client_interface)
 
 
254
            self.proxy.CheckedOK(dbus_interface = client_interface)
 
 
256
#         elif key == u"p" or key == "=":
 
 
258
#         elif key == u"u" or key == ":":
 
 
259
#             self.proxy.unpause()
 
 
260
#         elif key == u"RET":
 
 
263
#            self.proxy.Approve(True)
 
 
265
#            self.proxy.Approve(False)
 
 
269
    def property_changed(self, property=None, value=None,
 
 
271
        """Call self.update() if old value is not new value.
 
 
272
        This overrides the method from MandosClientPropertyCache"""
 
 
273
        property_name = unicode(property)
 
 
274
        old_value = self.properties.get(property_name)
 
 
275
        super(MandosClientWidget, self).property_changed(
 
 
276
            property=property, value=value, *args, **kwargs)
 
 
277
        if self.properties.get(property_name) != old_value:
 
 
281
class ConstrainedListBox(urwid.ListBox):
 
 
282
    """Like a normal urwid.ListBox, but will consume all "up" or
 
 
283
    "down" key presses, thus not allowing any containing widgets to
 
 
284
    use them as an excuse to shift focus away from this widget.
 
 
286
    def keypress(self, (maxcol, maxrow), key):
 
 
287
        ret = super(ConstrainedListBox, self).keypress((maxcol, maxrow), key)
 
 
288
        if ret in (u"up", u"down"):
 
 
293
class UserInterface(object):
 
 
294
    """This is the entire user interface - the whole screen
 
 
295
    with boxes, lists of client widgets, etc.
 
 
297
    def __init__(self, max_log_length=1000):
 
 
298
        DBusGMainLoop(set_as_default=True)
 
 
300
        self.screen = urwid.curses_display.Screen()
 
 
302
        self.screen.register_palette((
 
 
304
                 u"default", u"default", None),
 
 
306
                 u"default", u"default", u"bold"),
 
 
308
                 u"default", u"default", u"underline"),
 
 
310
                 u"default", u"default", u"standout"),
 
 
311
                (u"bold-underline-blink",
 
 
312
                 u"default", u"default", (u"bold", u"underline")),
 
 
314
                 u"default", u"default", (u"bold", u"standout")),
 
 
315
                (u"underline-blink-standout",
 
 
316
                 u"default", u"default", (u"underline", u"standout")),
 
 
317
                (u"bold-underline-blink-standout",
 
 
318
                 u"default", u"default", (u"bold", u"underline",
 
 
322
        if urwid.supports_unicode():
 
 
323
            self.divider = u"─" # \u2500
 
 
324
            #self.divider = u"━" # \u2501
 
 
326
            #self.divider = u"-" # \u002d
 
 
327
            self.divider = u"_" # \u005f
 
 
331
        self.size = self.screen.get_cols_rows()
 
 
333
        self.clients = urwid.SimpleListWalker([])
 
 
334
        self.clients_dict = {}
 
 
336
        # We will add Text widgets to this list
 
 
338
        self.max_log_length = max_log_length
 
 
340
        # We keep a reference to the log widget so we can remove it
 
 
341
        # from the ListWalker without it getting destroyed
 
 
342
        self.logbox = ConstrainedListBox(self.log)
 
 
344
        # This keeps track of whether self.uilist currently has
 
 
345
        # self.logbox in it or not
 
 
346
        self.log_visible = True
 
 
347
        self.log_wrap = u"any"
 
 
350
        self.log_message_raw((u"bold",
 
 
351
                              u"Mandos Monitor version " + version))
 
 
352
        self.log_message_raw((u"bold",
 
 
355
        self.busname = domain + '.Mandos'
 
 
356
        self.main_loop = gobject.MainLoop()
 
 
357
        self.bus = dbus.SystemBus()
 
 
358
        mandos_dbus_objc = self.bus.get_object(
 
 
359
            self.busname, u"/", follow_name_owner_changes=True)
 
 
360
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
 
 
364
            mandos_clients = (self.mandos_serv
 
 
365
                              .GetAllClientsWithProperties())
 
 
366
        except dbus.exceptions.DBusException:
 
 
367
            mandos_clients = dbus.Dictionary()
 
 
370
         .connect_to_signal(u"ClientRemoved",
 
 
371
                            self.find_and_remove_client,
 
 
372
                            dbus_interface=server_interface,
 
 
375
         .connect_to_signal(u"ClientAdded",
 
 
377
                            dbus_interface=server_interface,
 
 
380
         .connect_to_signal(u"ClientNotFound",
 
 
381
                            self.client_not_found,
 
 
382
                            dbus_interface=server_interface,
 
 
384
        for path, client in mandos_clients.iteritems():
 
 
385
            client_proxy_object = self.bus.get_object(self.busname,
 
 
387
            self.add_client(MandosClientWidget(server_proxy_object
 
 
390
                                               =client_proxy_object,
 
 
400
    def client_not_found(self, fingerprint, address):
 
 
401
        self.log_message((u"Client with address %s and fingerprint %s"
 
 
402
                          u" could not be found" % (address,
 
 
406
        """This rebuilds the User Interface.
 
 
407
        Call this when the widget layout needs to change"""
 
 
409
        #self.uilist.append(urwid.ListBox(self.clients))
 
 
410
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
 
 
411
                                       #header=urwid.Divider(),
 
 
413
                                       footer=urwid.Divider(div_char=self.divider)))
 
 
415
            self.uilist.append(self.logbox)
 
 
417
        self.topwidget = urwid.Pile(self.uilist)
 
 
419
    def log_message(self, message):
 
 
420
        timestamp = datetime.datetime.now().isoformat()
 
 
421
        self.log_message_raw(timestamp + u": " + message)
 
 
423
    def log_message_raw(self, markup):
 
 
424
        """Add a log message to the log buffer."""
 
 
425
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
 
 
426
        if (self.max_log_length
 
 
427
            and len(self.log) > self.max_log_length):
 
 
428
            del self.log[0:len(self.log)-self.max_log_length-1]
 
 
429
        self.logbox.set_focus(len(self.logbox.body.contents),
 
 
430
                              coming_from=u"above")
 
 
433
    def toggle_log_display(self):
 
 
434
        """Toggle visibility of the log buffer."""
 
 
435
        self.log_visible = not self.log_visible
 
 
437
        self.log_message(u"Log visibility changed to: "
 
 
438
                         + unicode(self.log_visible))
 
 
440
    def change_log_display(self):
 
 
441
        """Change type of log display.
 
 
442
        Currently, this toggles wrapping of text lines."""
 
 
443
        if self.log_wrap == u"clip":
 
 
444
            self.log_wrap = u"any"
 
 
446
            self.log_wrap = u"clip"
 
 
447
        for textwidget in self.log:
 
 
448
            textwidget.set_wrap_mode(self.log_wrap)
 
 
449
        self.log_message(u"Wrap mode: " + self.log_wrap)
 
 
451
    def find_and_remove_client(self, path, name):
 
 
452
        """Find an client from its object path and remove it.
 
 
454
        This is connected to the ClientRemoved signal from the
 
 
455
        Mandos server object."""
 
 
457
            client = self.clients_dict[path]
 
 
461
        self.remove_client(client, path)
 
 
463
    def add_new_client(self, path):
 
 
464
        client_proxy_object = self.bus.get_object(self.busname, path)
 
 
465
        self.add_client(MandosClientWidget(server_proxy_object
 
 
468
                                           =client_proxy_object,
 
 
477
    def add_client(self, client, path=None):
 
 
478
        self.clients.append(client)
 
 
480
            path = client.proxy.object_path
 
 
481
        self.clients_dict[path] = client
 
 
482
        self.clients.sort(None, lambda c: c.properties[u"name"])
 
 
485
    def remove_client(self, client, path=None):
 
 
486
        self.clients.remove(client)
 
 
488
            path = client.proxy.object_path
 
 
489
        del self.clients_dict[path]
 
 
490
        if not self.clients_dict:
 
 
491
            # Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker
 
 
492
            # is completely emptied, we need to recreate it.
 
 
493
            self.clients = urwid.SimpleListWalker([])
 
 
498
        """Redraw the screen"""
 
 
499
        canvas = self.topwidget.render(self.size, focus=True)
 
 
500
        self.screen.draw_screen(self.size, canvas)
 
 
503
        """Start the main loop and exit when it's done."""
 
 
505
        self._input_callback_tag = (gobject.io_add_watch
 
 
510
        # Main loop has finished, we should close everything now
 
 
511
        gobject.source_remove(self._input_callback_tag)
 
 
515
        self.main_loop.quit()
 
 
517
    def process_input(self, source, condition):
 
 
518
        keys = self.screen.get_input()
 
 
519
        translations = { u"ctrl n": u"down",      # Emacs
 
 
520
                         u"ctrl p": u"up",        # Emacs
 
 
521
                         u"ctrl v": u"page down", # Emacs
 
 
522
                         u"meta v": u"page up",   # Emacs
 
 
523
                         u" ": u"page down",      # less
 
 
524
                         u"f": u"page down",      # less
 
 
525
                         u"b": u"page up",        # less
 
 
531
                key = translations[key]
 
 
532
            except KeyError:    # :-)
 
 
535
            if key == u"q" or key == u"Q":
 
 
538
            elif key == u"window resize":
 
 
539
                self.size = self.screen.get_cols_rows()
 
 
541
            elif key == u"\f":  # Ctrl-L
 
 
543
            elif key == u"l" or key == u"D":
 
 
544
                self.toggle_log_display()
 
 
546
            elif key == u"w" or key == u"i":
 
 
547
                self.change_log_display()
 
 
549
            elif key == u"?" or key == u"f1" or key == u"esc":
 
 
550
                if not self.log_visible:
 
 
551
                    self.log_visible = True
 
 
553
                self.log_message_raw((u"bold",
 
 
557
                                            u"l: Log window toggle",
 
 
558
                                            u"TAB: Switch window",
 
 
560
                self.log_message_raw((u"bold",
 
 
566
                                             u"s: Start new checker",
 
 
573
                if self.topwidget.get_focus() is self.logbox:
 
 
574
                    self.topwidget.set_focus(0)
 
 
576
                    self.topwidget.set_focus(self.logbox)
 
 
578
            #elif (key == u"end" or key == u"meta >" or key == u"G"
 
 
580
            #    pass            # xxx end-of-buffer
 
 
581
            #elif (key == u"home" or key == u"meta <" or key == u"g"
 
 
583
            #    pass            # xxx beginning-of-buffer
 
 
584
            #elif key == u"ctrl e" or key == u"$":
 
 
585
            #    pass            # xxx move-end-of-line
 
 
586
            #elif key == u"ctrl a" or key == u"^":
 
 
587
            #    pass            # xxx move-beginning-of-line
 
 
588
            #elif key == u"ctrl b" or key == u"meta (" or key == u"h":
 
 
590
            #elif key == u"ctrl f" or key == u"meta )" or key == u"l":
 
 
593
            #    pass            # scroll up log
 
 
595
            #    pass            # scroll down log
 
 
596
            elif self.topwidget.selectable():
 
 
597
                self.topwidget.keypress(self.size, key)
 
 
605
    ui.log_message(unicode(e))