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)
 
363
 
            self.proxy.Disable(dbus_interface = client_interface)
 
365
 
            self.proxy.Approve(dbus.Boolean(True, variant_level=1),
 
366
 
                               dbus_interface = client_interface)
 
368
 
            self.proxy.Approve(dbus.Boolean(False, variant_level=1),
 
369
 
                                  dbus_interface = client_interface)
 
370
 
        elif key == "R" or key == "_" or key == "ctrl k":
 
371
 
            self.server_proxy_object.RemoveClient(self.proxy
 
374
 
            self.proxy.StartChecker(dbus_interface = client_interface)
 
376
 
            self.proxy.StopChecker(dbus_interface = client_interface)
 
378
 
            self.proxy.CheckedOK(dbus_interface = client_interface)
 
380
 
#         elif key == "p" or key == "=":
 
382
 
#         elif key == "u" or key == ":":
 
383
 
#             self.proxy.unpause()
 
389
 
    def property_changed(self, property=None, value=None,
 
391
 
        """Call self.update() if old value is not new value.
 
392
 
        This overrides the method from MandosClientPropertyCache"""
 
393
 
        property_name = unicode(property)
 
394
 
        old_value = self.properties.get(property_name)
 
395
 
        super(MandosClientWidget, self).property_changed(
 
396
 
            property=property, value=value, *args, **kwargs)
 
397
 
        if self.properties.get(property_name) != old_value:
 
401
 
class ConstrainedListBox(urwid.ListBox):
 
402
 
    """Like a normal urwid.ListBox, but will consume all "up" or
 
403
 
    "down" key presses, thus not allowing any containing widgets to
 
404
 
    use them as an excuse to shift focus away from this widget.
 
406
 
    def keypress(self, maxcolrow, key):
 
407
 
        ret = super(ConstrainedListBox, self).keypress(maxcolrow, key)
 
408
 
        if ret in ("up", "down"):
 
413
 
class UserInterface(object):
 
414
 
    """This is the entire user interface - the whole screen
 
415
 
    with boxes, lists of client widgets, etc.
 
417
 
    def __init__(self, max_log_length=1000):
 
418
 
        DBusGMainLoop(set_as_default=True)
 
420
 
        self.screen = urwid.curses_display.Screen()
 
422
 
        self.screen.register_palette((
 
424
 
                 "default", "default", None),
 
426
 
                 "default", "default", "bold"),
 
428
 
                 "default", "default", "underline"),
 
430
 
                 "default", "default", "standout"),
 
431
 
                ("bold-underline-blink",
 
432
 
                 "default", "default", ("bold", "underline")),
 
434
 
                 "default", "default", ("bold", "standout")),
 
435
 
                ("underline-blink-standout",
 
436
 
                 "default", "default", ("underline", "standout")),
 
437
 
                ("bold-underline-blink-standout",
 
438
 
                 "default", "default", ("bold", "underline",
 
442
 
        if urwid.supports_unicode():
 
443
 
            self.divider = "─" # \u2500
 
444
 
            #self.divider = "━" # \u2501
 
446
 
            #self.divider = "-" # \u002d
 
447
 
            self.divider = "_" # \u005f
 
451
 
        self.size = self.screen.get_cols_rows()
 
453
 
        self.clients = urwid.SimpleListWalker([])
 
454
 
        self.clients_dict = {}
 
456
 
        # We will add Text widgets to this list
 
458
 
        self.max_log_length = max_log_length
 
460
 
        # We keep a reference to the log widget so we can remove it
 
461
 
        # from the ListWalker without it getting destroyed
 
462
 
        self.logbox = ConstrainedListBox(self.log)
 
464
 
        # This keeps track of whether self.uilist currently has
 
465
 
        # self.logbox in it or not
 
466
 
        self.log_visible = True
 
467
 
        self.log_wrap = "any"
 
470
 
        self.log_message_raw(("bold",
 
471
 
                              "Mandos Monitor version " + version))
 
472
 
        self.log_message_raw(("bold",
 
475
 
        self.busname = domain + '.Mandos'
 
476
 
        self.main_loop = gobject.MainLoop()
 
477
 
        self.bus = dbus.SystemBus()
 
478
 
        mandos_dbus_objc = self.bus.get_object(
 
479
 
            self.busname, "/", follow_name_owner_changes=True)
 
480
 
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
 
484
 
            mandos_clients = (self.mandos_serv
 
485
 
                              .GetAllClientsWithProperties())
 
486
 
        except dbus.exceptions.DBusException:
 
487
 
            mandos_clients = dbus.Dictionary()
 
490
 
         .connect_to_signal("ClientRemoved",
 
491
 
                            self.find_and_remove_client,
 
492
 
                            dbus_interface=server_interface,
 
495
 
         .connect_to_signal("ClientAdded",
 
497
 
                            dbus_interface=server_interface,
 
500
 
         .connect_to_signal("ClientNotFound",
 
501
 
                            self.client_not_found,
 
502
 
                            dbus_interface=server_interface,
 
504
 
        for path, client in mandos_clients.iteritems():
 
505
 
            client_proxy_object = self.bus.get_object(self.busname,
 
507
 
            self.add_client(MandosClientWidget(server_proxy_object
 
510
 
                                               =client_proxy_object,
 
520
 
    def client_not_found(self, fingerprint, address):
 
521
 
        self.log_message(("Client with address %s and fingerprint %s"
 
522
 
                          " could not be found" % (address,
 
526
 
        """This rebuilds the User Interface.
 
527
 
        Call this when the widget layout needs to change"""
 
529
 
        #self.uilist.append(urwid.ListBox(self.clients))
 
530
 
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.
 
532
 
                                       #header=urwid.Divider(),
 
535
 
                                       urwid.Divider(div_char=
 
538
 
            self.uilist.append(self.logbox)
 
540
 
        self.topwidget = urwid.Pile(self.uilist)
 
542
 
    def log_message(self, message):
 
543
 
        timestamp = datetime.datetime.now().isoformat()
 
544
 
        self.log_message_raw(timestamp + ": " + message)
 
546
 
    def log_message_raw(self, markup):
 
547
 
        """Add a log message to the log buffer."""
 
548
 
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
 
549
 
        if (self.max_log_length
 
550
 
            and len(self.log) > self.max_log_length):
 
551
 
            del self.log[0:len(self.log)-self.max_log_length-1]
 
552
 
        self.logbox.set_focus(len(self.logbox.body.contents),
 
556
 
    def toggle_log_display(self):
 
557
 
        """Toggle visibility of the log buffer."""
 
558
 
        self.log_visible = not self.log_visible
 
560
 
        #self.log_message("Log visibility changed to: "
 
561
 
        #                 + unicode(self.log_visible))
 
563
 
    def change_log_display(self):
 
564
 
        """Change type of log display.
 
565
 
        Currently, this toggles wrapping of text lines."""
 
566
 
        if self.log_wrap == "clip":
 
567
 
            self.log_wrap = "any"
 
569
 
            self.log_wrap = "clip"
 
570
 
        for textwidget in self.log:
 
571
 
            textwidget.set_wrap_mode(self.log_wrap)
 
572
 
        #self.log_message("Wrap mode: " + self.log_wrap)
 
574
 
    def find_and_remove_client(self, path, name):
 
575
 
        """Find an client from its object path and remove it.
 
577
 
        This is connected to the ClientRemoved signal from the
 
578
 
        Mandos server object."""
 
580
 
            client = self.clients_dict[path]
 
584
 
        self.remove_client(client, path)
 
586
 
    def add_new_client(self, path):
 
587
 
        client_proxy_object = self.bus.get_object(self.busname, path)
 
588
 
        self.add_client(MandosClientWidget(server_proxy_object
 
591
 
                                           =client_proxy_object,
 
600
 
    def add_client(self, client, path=None):
 
601
 
        self.clients.append(client)
 
603
 
            path = client.proxy.object_path
 
604
 
        self.clients_dict[path] = client
 
605
 
        self.clients.sort(None, lambda c: c.properties["Name"])
 
608
 
    def remove_client(self, client, path=None):
 
609
 
        self.clients.remove(client)
 
611
 
            path = client.proxy.object_path
 
612
 
        del self.clients_dict[path]
 
613
 
        if not self.clients_dict:
 
614
 
            # Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker
 
615
 
            # is completely emptied, we need to recreate it.
 
616
 
            self.clients = urwid.SimpleListWalker([])
 
621
 
        """Redraw the screen"""
 
622
 
        canvas = self.topwidget.render(self.size, focus=True)
 
623
 
        self.screen.draw_screen(self.size, canvas)
 
626
 
        """Start the main loop and exit when it's done."""
 
628
 
        self._input_callback_tag = (gobject.io_add_watch
 
633
 
        # Main loop has finished, we should close everything now
 
634
 
        gobject.source_remove(self._input_callback_tag)
 
638
 
        self.main_loop.quit()
 
640
 
    def process_input(self, source, condition):
 
641
 
        keys = self.screen.get_input()
 
642
 
        translations = { "ctrl n": "down",      # Emacs
 
643
 
                         "ctrl p": "up",        # Emacs
 
644
 
                         "ctrl v": "page down", # Emacs
 
645
 
                         "meta v": "page up",   # Emacs
 
646
 
                         " ": "page down",      # less
 
647
 
                         "f": "page down",      # less
 
648
 
                         "b": "page up",        # less
 
654
 
                key = translations[key]
 
655
 
            except KeyError:    # :-)
 
658
 
            if key == "q" or key == "Q":
 
661
 
            elif key == "window resize":
 
662
 
                self.size = self.screen.get_cols_rows()
 
664
 
            elif key == "\f":  # Ctrl-L
 
666
 
            elif key == "l" or key == "D":
 
667
 
                self.toggle_log_display()
 
669
 
            elif key == "w" or key == "i":
 
670
 
                self.change_log_display()
 
672
 
            elif key == "?" or key == "f1" or key == "esc":
 
673
 
                if not self.log_visible:
 
674
 
                    self.log_visible = True
 
676
 
                self.log_message_raw(("bold",
 
680
 
                                            "l: Log window toggle",
 
681
 
                                            "TAB: Switch window",
 
683
 
                self.log_message_raw(("bold",
 
689
 
                                             "s: Start new checker",
 
696
 
                if self.topwidget.get_focus() is self.logbox:
 
697
 
                    self.topwidget.set_focus(0)
 
699
 
                    self.topwidget.set_focus(self.logbox)
 
701
 
            #elif (key == "end" or key == "meta >" or key == "G"
 
703
 
            #    pass            # xxx end-of-buffer
 
704
 
            #elif (key == "home" or key == "meta <" or key == "g"
 
706
 
            #    pass            # xxx beginning-of-buffer
 
707
 
            #elif key == "ctrl e" or key == "$":
 
708
 
            #    pass            # xxx move-end-of-line
 
709
 
            #elif key == "ctrl a" or key == "^":
 
710
 
            #    pass            # xxx move-beginning-of-line
 
711
 
            #elif key == "ctrl b" or key == "meta (" or key == "h":
 
713
 
            #elif key == "ctrl f" or key == "meta )" or key == "l":
 
716
 
            #    pass            # scroll up log
 
718
 
            #    pass            # scroll down log
 
719
 
            elif self.topwidget.selectable():
 
720
 
                self.topwidget.keypress(self.size, key)
 
727
 
except KeyboardInterrupt:
 
730
 
    ui.log_message(unicode(e))