2
# -*- mode: python; coding: utf-8 -*-
 
 
4
# Mandos Monitor - Control and monitor the Mandos server
 
 
6
# Copyright © 2009-2011 Teddy Hogeborn
 
 
7
# Copyright © 2009-2011 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 <http://www.gnu.org/licenses/>.
 
 
22
# Contact the authors at <mandos@fukt.bsnet.se>.
 
 
25
from __future__ import division, absolute_import, print_function, unicode_literals
 
 
33
import urwid.curses_display
 
 
36
from dbus.mainloop.glib import DBusGMainLoop
 
 
45
locale.setlocale(locale.LC_ALL, '')
 
 
48
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
 
 
50
# Some useful constants
 
 
51
domain = 'se.bsnet.fukt'
 
 
52
server_interface = domain + '.Mandos'
 
 
53
client_interface = domain + '.Mandos.Client'
 
 
56
# Always run in monochrome mode
 
 
57
urwid.curses_display.curses.has_colors = lambda : False
 
 
59
# Urwid doesn't support blinking, but we want it.  Since we have no
 
 
60
# use for underline on its own, we make underline also always blink.
 
 
61
urwid.curses_display.curses.A_UNDERLINE |= (
 
 
62
    urwid.curses_display.curses.A_BLINK)
 
 
64
def isoformat_to_datetime(iso):
 
 
65
    "Parse an ISO 8601 date string to a datetime.datetime()"
 
 
68
    d, t = iso.split("T", 1)
 
 
69
    year, month, day = d.split("-", 2)
 
 
70
    hour, minute, second = t.split(":", 2)
 
 
71
    second, fraction = divmod(float(second), 1)
 
 
72
    return datetime.datetime(int(year),
 
 
77
                             int(second),           # Whole seconds
 
 
78
                             int(fraction*1000000)) # Microseconds
 
 
80
class MandosClientPropertyCache(object):
 
 
81
    """This wraps a Mandos Client D-Bus proxy object, caches the
 
 
82
    properties and calls a hook function when any of them are
 
 
85
    def __init__(self, proxy_object=None, *args, **kwargs):
 
 
86
        self.proxy = proxy_object # Mandos Client proxy object
 
 
88
        self.properties = dict()
 
 
89
        self.proxy.connect_to_signal("PropertyChanged",
 
 
90
                                     self.property_changed,
 
 
94
        self.properties.update(
 
 
95
            self.proxy.GetAll(client_interface,
 
 
96
                              dbus_interface = dbus.PROPERTIES_IFACE))
 
 
98
        #XXX This break good super behaviour!
 
 
99
#        super(MandosClientPropertyCache, self).__init__(
 
 
102
    def property_changed(self, property=None, value=None):
 
 
103
        """This is called whenever we get a PropertyChanged signal
 
 
104
        It updates the changed property in the "properties" dict.
 
 
106
        # Update properties dict with new value
 
 
107
        self.properties[property] = value
 
 
110
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
 
 
111
    """A Mandos Client which is visible on the screen.
 
 
114
    def __init__(self, server_proxy_object=None, update_hook=None,
 
 
115
                 delete_hook=None, logger=None, *args, **kwargs):
 
 
117
        self.update_hook = update_hook
 
 
119
        self.delete_hook = delete_hook
 
 
120
        # Mandos Server proxy object
 
 
121
        self.server_proxy_object = server_proxy_object
 
 
125
        self._update_timer_callback_tag = None
 
 
126
        self._update_timer_callback_lock = 0
 
 
127
        self.last_checker_failed = False
 
 
129
        # The widget shown normally
 
 
130
        self._text_widget = urwid.Text("")
 
 
131
        # The widget shown when we have focus
 
 
132
        self._focus_text_widget = urwid.Text("")
 
 
133
        super(MandosClientWidget, self).__init__(
 
 
134
            update_hook=update_hook, delete_hook=delete_hook,
 
 
139
        last_checked_ok = isoformat_to_datetime(self.properties
 
 
141
        if last_checked_ok is None:
 
 
142
            self.last_checker_failed = True
 
 
144
            self.last_checker_failed = ((datetime.datetime.utcnow()
 
 
151
        if self.last_checker_failed:
 
 
152
            self.using_timer(True)
 
 
154
        if self.need_approval:
 
 
155
            self.using_timer(True)
 
 
157
        self.proxy.connect_to_signal("CheckerCompleted",
 
 
158
                                     self.checker_completed,
 
 
161
        self.proxy.connect_to_signal("CheckerStarted",
 
 
162
                                     self.checker_started,
 
 
165
        self.proxy.connect_to_signal("GotSecret",
 
 
169
        self.proxy.connect_to_signal("NeedApproval",
 
 
173
        self.proxy.connect_to_signal("Rejected",
 
 
178
    def property_changed(self, property=None, value=None):
 
 
179
        super(self, MandosClientWidget).property_changed(property,
 
 
181
        if property == "ApprovalPending":
 
 
182
            using_timer(bool(value))
 
 
184
    def using_timer(self, flag):
 
 
185
        """Call this method with True or False when timer should be
 
 
186
        activated or deactivated.
 
 
188
        old = self._update_timer_callback_lock
 
 
190
            self._update_timer_callback_lock += 1
 
 
192
            self._update_timer_callback_lock -= 1
 
 
193
        if old == 0 and self._update_timer_callback_lock:
 
 
194
            self._update_timer_callback_tag = (gobject.timeout_add
 
 
197
        elif old and self._update_timer_callback_lock == 0:
 
 
198
            gobject.source_remove(self._update_timer_callback_tag)
 
 
199
            self._update_timer_callback_tag = None
 
 
201
    def checker_completed(self, exitstatus, condition, command):
 
 
203
            if self.last_checker_failed:
 
 
204
                self.last_checker_failed = False
 
 
205
                self.using_timer(False)
 
 
206
            #self.logger('Checker for client %s (command "%s")'
 
 
208
            #            % (self.properties["Name"], command))
 
 
212
        if not self.last_checker_failed:
 
 
213
            self.last_checker_failed = True
 
 
214
            self.using_timer(True)
 
 
215
        if os.WIFEXITED(condition):
 
 
216
            self.logger('Checker for client %s (command "%s")'
 
 
217
                        ' failed with exit code %s'
 
 
218
                        % (self.properties["Name"], command,
 
 
219
                           os.WEXITSTATUS(condition)))
 
 
220
        elif os.WIFSIGNALED(condition):
 
 
221
            self.logger('Checker for client %s (command "%s")'
 
 
222
                        ' was killed by signal %s'
 
 
223
                        % (self.properties["Name"], command,
 
 
224
                           os.WTERMSIG(condition)))
 
 
225
        elif os.WCOREDUMP(condition):
 
 
226
            self.logger('Checker for client %s (command "%s")'
 
 
228
                        % (self.properties["Name"], command))
 
 
230
            self.logger('Checker for client %s completed'
 
 
234
    def checker_started(self, command):
 
 
235
        #self.logger('Client %s started checker "%s"'
 
 
236
        #            % (self.properties["Name"], unicode(command)))
 
 
239
    def got_secret(self):
 
 
240
        self.last_checker_failed = False
 
 
241
        self.logger('Client %s received its secret'
 
 
242
                    % self.properties["Name"])
 
 
244
    def need_approval(self, timeout, default):
 
 
246
            message = 'Client %s needs approval within %s seconds'
 
 
248
            message = 'Client %s will get its secret in %s seconds'
 
 
250
                    % (self.properties["Name"], timeout/1000))
 
 
251
        self.using_timer(True)
 
 
253
    def rejected(self, reason):
 
 
254
        self.logger('Client %s was rejected; reason: %s'
 
 
255
                    % (self.properties["Name"], reason))
 
 
257
    def selectable(self):
 
 
258
        """Make this a "selectable" widget.
 
 
259
        This overrides the method from urwid.FlowWidget."""
 
 
262
    def rows(self, maxcolrow, focus=False):
 
 
263
        """How many rows this widget will occupy might depend on
 
 
264
        whether we have focus or not.
 
 
265
        This overrides the method from urwid.FlowWidget"""
 
 
266
        return self.current_widget(focus).rows(maxcolrow, focus=focus)
 
 
268
    def current_widget(self, focus=False):
 
 
269
        if focus or self.opened:
 
 
270
            return self._focus_widget
 
 
274
        "Called when what is visible on the screen should be updated."
 
 
275
        # How to add standout mode to a style
 
 
276
        with_standout = { "normal": "standout",
 
 
277
                          "bold": "bold-standout",
 
 
279
                              "underline-blink-standout",
 
 
280
                          "bold-underline-blink":
 
 
281
                              "bold-underline-blink-standout",
 
 
284
        # Rebuild focus and non-focus widgets using current properties
 
 
286
        # Base part of a client. Name!
 
 
288
                      % {"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 %s. (d)eny?"
 
 
305
                message = "Denial in %s. (a)pprove?"
 
 
306
            message = message % unicode(timer).rsplit(".", 1)[0]
 
 
307
        elif self.last_checker_failed:
 
 
308
            timeout = datetime.timedelta(milliseconds
 
 
311
            last_ok = isoformat_to_datetime(
 
 
312
                max((self.properties["LastCheckedOK"]
 
 
313
                     or self.properties["Created"]),
 
 
314
                    self.properties["LastEnabled"]))
 
 
315
            timer = timeout - (datetime.datetime.utcnow() - last_ok)
 
 
316
            message = ('A checker has failed! Time until client'
 
 
318
                           % unicode(timer).rsplit(".", 1)[0])
 
 
321
        self._text = "%s%s" % (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):
 
 
342
        return True             # Keep calling this
 
 
345
        if self._update_timer_callback_tag is not None:
 
 
346
            gobject.source_remove(self._update_timer_callback_tag)
 
 
347
            self._update_timer_callback_tag = None
 
 
348
        if self.delete_hook is not None:
 
 
349
            self.delete_hook(self)
 
 
351
    def render(self, maxcolrow, focus=False):
 
 
352
        """Render differently if we have focus.
 
 
353
        This overrides the method from urwid.FlowWidget"""
 
 
354
        return self.current_widget(focus).render(maxcolrow,
 
 
357
    def keypress(self, maxcolrow, key):
 
 
359
        This overrides the method from urwid.FlowWidget"""
 
 
361
            self.proxy.Enable(dbus_interface = client_interface,
 
 
364
            self.proxy.Disable(dbus_interface = client_interface,
 
 
367
            self.proxy.Approve(dbus.Boolean(True, variant_level=1),
 
 
368
                               dbus_interface = client_interface,
 
 
371
            self.proxy.Approve(dbus.Boolean(False, variant_level=1),
 
 
372
                                  dbus_interface = client_interface,
 
 
374
        elif key == "R" or key == "_" or key == "ctrl k":
 
 
375
            self.server_proxy_object.RemoveClient(self.proxy
 
 
379
            self.proxy.StartChecker(dbus_interface = client_interface,
 
 
382
            self.proxy.StopChecker(dbus_interface = client_interface,
 
 
385
            self.proxy.CheckedOK(dbus_interface = client_interface,
 
 
388
#         elif key == "p" or key == "=":
 
 
390
#         elif key == "u" or key == ":":
 
 
391
#             self.proxy.unpause()
 
 
397
    def property_changed(self, property=None, value=None,
 
 
399
        """Call self.update() if old value is not new value.
 
 
400
        This overrides the method from MandosClientPropertyCache"""
 
 
401
        property_name = unicode(property)
 
 
402
        old_value = self.properties.get(property_name)
 
 
403
        super(MandosClientWidget, self).property_changed(
 
 
404
            property=property, value=value, *args, **kwargs)
 
 
405
        if self.properties.get(property_name) != old_value:
 
 
409
class ConstrainedListBox(urwid.ListBox):
 
 
410
    """Like a normal urwid.ListBox, but will consume all "up" or
 
 
411
    "down" key presses, thus not allowing any containing widgets to
 
 
412
    use them as an excuse to shift focus away from this widget.
 
 
414
    def keypress(self, maxcolrow, key):
 
 
415
        ret = super(ConstrainedListBox, self).keypress(maxcolrow, key)
 
 
416
        if ret in ("up", "down"):
 
 
421
class UserInterface(object):
 
 
422
    """This is the entire user interface - the whole screen
 
 
423
    with boxes, lists of client widgets, etc.
 
 
425
    def __init__(self, max_log_length=1000):
 
 
426
        DBusGMainLoop(set_as_default=True)
 
 
428
        self.screen = urwid.curses_display.Screen()
 
 
430
        self.screen.register_palette((
 
 
432
                 "default", "default", None),
 
 
434
                 "default", "default", "bold"),
 
 
436
                 "default", "default", "underline"),
 
 
438
                 "default", "default", "standout"),
 
 
439
                ("bold-underline-blink",
 
 
440
                 "default", "default", ("bold", "underline")),
 
 
442
                 "default", "default", ("bold", "standout")),
 
 
443
                ("underline-blink-standout",
 
 
444
                 "default", "default", ("underline", "standout")),
 
 
445
                ("bold-underline-blink-standout",
 
 
446
                 "default", "default", ("bold", "underline",
 
 
450
        if urwid.supports_unicode():
 
 
451
            self.divider = "─" # \u2500
 
 
452
            #self.divider = "━" # \u2501
 
 
454
            #self.divider = "-" # \u002d
 
 
455
            self.divider = "_" # \u005f
 
 
459
        self.size = self.screen.get_cols_rows()
 
 
461
        self.clients = urwid.SimpleListWalker([])
 
 
462
        self.clients_dict = {}
 
 
464
        # We will add Text widgets to this list
 
 
466
        self.max_log_length = max_log_length
 
 
468
        # We keep a reference to the log widget so we can remove it
 
 
469
        # from the ListWalker without it getting destroyed
 
 
470
        self.logbox = ConstrainedListBox(self.log)
 
 
472
        # This keeps track of whether self.uilist currently has
 
 
473
        # self.logbox in it or not
 
 
474
        self.log_visible = True
 
 
475
        self.log_wrap = "any"
 
 
478
        self.log_message_raw(("bold",
 
 
479
                              "Mandos Monitor version " + version))
 
 
480
        self.log_message_raw(("bold",
 
 
483
        self.busname = domain + '.Mandos'
 
 
484
        self.main_loop = gobject.MainLoop()
 
 
485
        self.bus = dbus.SystemBus()
 
 
486
        mandos_dbus_objc = self.bus.get_object(
 
 
487
            self.busname, "/", follow_name_owner_changes=True)
 
 
488
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
 
 
492
            mandos_clients = (self.mandos_serv
 
 
493
                              .GetAllClientsWithProperties())
 
 
494
        except dbus.exceptions.DBusException:
 
 
495
            mandos_clients = dbus.Dictionary()
 
 
498
         .connect_to_signal("ClientRemoved",
 
 
499
                            self.find_and_remove_client,
 
 
500
                            dbus_interface=server_interface,
 
 
503
         .connect_to_signal("ClientAdded",
 
 
505
                            dbus_interface=server_interface,
 
 
508
         .connect_to_signal("ClientNotFound",
 
 
509
                            self.client_not_found,
 
 
510
                            dbus_interface=server_interface,
 
 
512
        for path, client in mandos_clients.iteritems():
 
 
513
            client_proxy_object = self.bus.get_object(self.busname,
 
 
515
            self.add_client(MandosClientWidget(server_proxy_object
 
 
518
                                               =client_proxy_object,
 
 
528
    def client_not_found(self, fingerprint, address):
 
 
529
        self.log_message(("Client with address %s and fingerprint %s"
 
 
530
                          " could not be found" % (address,
 
 
534
        """This rebuilds the User Interface.
 
 
535
        Call this when the widget layout needs to change"""
 
 
537
        #self.uilist.append(urwid.ListBox(self.clients))
 
 
538
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.
 
 
540
                                       #header=urwid.Divider(),
 
 
543
                                       urwid.Divider(div_char=
 
 
546
            self.uilist.append(self.logbox)
 
 
548
        self.topwidget = urwid.Pile(self.uilist)
 
 
550
    def log_message(self, message):
 
 
551
        timestamp = datetime.datetime.now().isoformat()
 
 
552
        self.log_message_raw(timestamp + ": " + message)
 
 
554
    def log_message_raw(self, markup):
 
 
555
        """Add a log message to the log buffer."""
 
 
556
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
 
 
557
        if (self.max_log_length
 
 
558
            and len(self.log) > self.max_log_length):
 
 
559
            del self.log[0:len(self.log)-self.max_log_length-1]
 
 
560
        self.logbox.set_focus(len(self.logbox.body.contents),
 
 
564
    def toggle_log_display(self):
 
 
565
        """Toggle visibility of the log buffer."""
 
 
566
        self.log_visible = not self.log_visible
 
 
568
        #self.log_message("Log visibility changed to: "
 
 
569
        #                 + unicode(self.log_visible))
 
 
571
    def change_log_display(self):
 
 
572
        """Change type of log display.
 
 
573
        Currently, this toggles wrapping of text lines."""
 
 
574
        if self.log_wrap == "clip":
 
 
575
            self.log_wrap = "any"
 
 
577
            self.log_wrap = "clip"
 
 
578
        for textwidget in self.log:
 
 
579
            textwidget.set_wrap_mode(self.log_wrap)
 
 
580
        #self.log_message("Wrap mode: " + self.log_wrap)
 
 
582
    def find_and_remove_client(self, path, name):
 
 
583
        """Find an client from its object path and remove it.
 
 
585
        This is connected to the ClientRemoved signal from the
 
 
586
        Mandos server object."""
 
 
588
            client = self.clients_dict[path]
 
 
592
        self.remove_client(client, path)
 
 
594
    def add_new_client(self, path):
 
 
595
        client_proxy_object = self.bus.get_object(self.busname, path)
 
 
596
        self.add_client(MandosClientWidget(server_proxy_object
 
 
599
                                           =client_proxy_object,
 
 
608
    def add_client(self, client, path=None):
 
 
609
        self.clients.append(client)
 
 
611
            path = client.proxy.object_path
 
 
612
        self.clients_dict[path] = client
 
 
613
        self.clients.sort(None, lambda c: c.properties["Name"])
 
 
616
    def remove_client(self, client, path=None):
 
 
617
        self.clients.remove(client)
 
 
619
            path = client.proxy.object_path
 
 
620
        del self.clients_dict[path]
 
 
621
        if not self.clients_dict:
 
 
622
            # Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker
 
 
623
            # is completely emptied, we need to recreate it.
 
 
624
            self.clients = urwid.SimpleListWalker([])
 
 
629
        """Redraw the screen"""
 
 
630
        canvas = self.topwidget.render(self.size, focus=True)
 
 
631
        self.screen.draw_screen(self.size, canvas)
 
 
634
        """Start the main loop and exit when it's done."""
 
 
636
        self._input_callback_tag = (gobject.io_add_watch
 
 
641
        # Main loop has finished, we should close everything now
 
 
642
        gobject.source_remove(self._input_callback_tag)
 
 
646
        self.main_loop.quit()
 
 
648
    def process_input(self, source, condition):
 
 
649
        keys = self.screen.get_input()
 
 
650
        translations = { "ctrl n": "down",      # Emacs
 
 
651
                         "ctrl p": "up",        # Emacs
 
 
652
                         "ctrl v": "page down", # Emacs
 
 
653
                         "meta v": "page up",   # Emacs
 
 
654
                         " ": "page down",      # less
 
 
655
                         "f": "page down",      # less
 
 
656
                         "b": "page up",        # less
 
 
662
                key = translations[key]
 
 
663
            except KeyError:    # :-)
 
 
666
            if key == "q" or key == "Q":
 
 
669
            elif key == "window resize":
 
 
670
                self.size = self.screen.get_cols_rows()
 
 
672
            elif key == "\f":  # Ctrl-L
 
 
674
            elif key == "l" or key == "D":
 
 
675
                self.toggle_log_display()
 
 
677
            elif key == "w" or key == "i":
 
 
678
                self.change_log_display()
 
 
680
            elif key == "?" or key == "f1" or key == "esc":
 
 
681
                if not self.log_visible:
 
 
682
                    self.log_visible = True
 
 
684
                self.log_message_raw(("bold",
 
 
688
                                            "l: Log window toggle",
 
 
689
                                            "TAB: Switch window",
 
 
691
                self.log_message_raw(("bold",
 
 
697
                                             "s: Start new checker",
 
 
704
                if self.topwidget.get_focus() is self.logbox:
 
 
705
                    self.topwidget.set_focus(0)
 
 
707
                    self.topwidget.set_focus(self.logbox)
 
 
709
            #elif (key == "end" or key == "meta >" or key == "G"
 
 
711
            #    pass            # xxx end-of-buffer
 
 
712
            #elif (key == "home" or key == "meta <" or key == "g"
 
 
714
            #    pass            # xxx beginning-of-buffer
 
 
715
            #elif key == "ctrl e" or key == "$":
 
 
716
            #    pass            # xxx move-end-of-line
 
 
717
            #elif key == "ctrl a" or key == "^":
 
 
718
            #    pass            # xxx move-beginning-of-line
 
 
719
            #elif key == "ctrl b" or key == "meta (" or key == "h":
 
 
721
            #elif key == "ctrl f" or key == "meta )" or key == "l":
 
 
724
            #    pass            # scroll up log
 
 
726
            #    pass            # scroll down log
 
 
727
            elif self.topwidget.selectable():
 
 
728
                self.topwidget.keypress(self.size, key)
 
 
735
except KeyboardInterrupt:
 
 
738
    ui.log_message(unicode(e))