2
 
# -*- mode: python; coding: utf-8 -*-
 
4
 
# Mandos Monitor - Control and monitor the Mandos server
 
6
 
# Copyright © 2009,2010 Teddy Hogeborn
 
7
 
# Copyright © 2009,2010 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, with_statement
 
33
 
import urwid.curses_display
 
36
 
from dbus.mainloop.glib import DBusGMainLoop
 
45
 
locale.setlocale(locale.LC_ALL, u'')
 
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(u"T", 1)
 
69
 
    year, month, day = d.split(u"-", 2)
 
70
 
    hour, minute, second = t.split(u":", 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(u"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(u"")
 
131
 
        # The widget shown when we have focus
 
132
 
        self._focus_text_widget = urwid.Text(u"")
 
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(u"CheckerCompleted",
 
158
 
                                     self.checker_completed,
 
161
 
        self.proxy.connect_to_signal(u"CheckerStarted",
 
162
 
                                     self.checker_started,
 
165
 
        self.proxy.connect_to_signal(u"GotSecret",
 
169
 
        self.proxy.connect_to_signal(u"NeedApproval",
 
173
 
        self.proxy.connect_to_signal(u"Rejected",
 
178
 
    def property_changed(self, property=None, value=None):
 
179
 
        super(self, MandosClientWidget).property_changed(property,
 
181
 
        if property == u"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(u'Checker for client %s (command "%s")'
 
208
 
            #            % (self.properties[u"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(u'Checker for client %s (command "%s")'
 
217
 
                        u' failed with exit code %s'
 
218
 
                        % (self.properties[u"Name"], command,
 
219
 
                           os.WEXITSTATUS(condition)))
 
220
 
        elif os.WIFSIGNALED(condition):
 
221
 
            self.logger(u'Checker for client %s (command "%s")'
 
222
 
                        u' was killed by signal %s'
 
223
 
                        % (self.properties[u"Name"], command,
 
224
 
                           os.WTERMSIG(condition)))
 
225
 
        elif os.WCOREDUMP(condition):
 
226
 
            self.logger(u'Checker for client %s (command "%s")'
 
228
 
                        % (self.properties[u"Name"], command))
 
230
 
            self.logger(u'Checker for client %s completed'
 
234
 
    def checker_started(self, command):
 
235
 
        #self.logger(u'Client %s started checker "%s"'
 
236
 
        #            % (self.properties[u"Name"], unicode(command)))
 
239
 
    def got_secret(self):
 
240
 
        self.last_checker_failed = False
 
241
 
        self.logger(u'Client %s received its secret'
 
242
 
                    % self.properties[u"Name"])
 
244
 
    def need_approval(self, timeout, default):
 
246
 
            message = u'Client %s needs approval within %s seconds'
 
248
 
            message = u'Client %s will get its secret in %s seconds'
 
250
 
                    % (self.properties[u"Name"], timeout/1000))
 
251
 
        self.using_timer(True)
 
253
 
    def rejected(self, reason):
 
254
 
        self.logger(u'Client %s was rejected; reason: %s'
 
255
 
                    % (self.properties[u"Name"], reason))
 
257
 
    def selectable(self):
 
258
 
        """Make this a "selectable" widget.
 
259
 
        This overrides the method from urwid.FlowWidget."""
 
262
 
    def rows(self, (maxcol,), 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((maxcol,), 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 = { u"normal": u"standout",
 
277
 
                          u"bold": u"bold-standout",
 
279
 
                              u"underline-blink-standout",
 
280
 
                          u"bold-underline-blink":
 
281
 
                              u"bold-underline-blink-standout",
 
284
 
        # Rebuild focus and non-focus widgets using current properties
 
286
 
        # Base part of a client. Name!
 
287
 
        base = (u'%(name)s: '
 
288
 
                      % {u"name": self.properties[u"Name"]})
 
289
 
        if not self.properties[u"Enabled"]:
 
290
 
            message = u"DISABLED"
 
291
 
        elif self.properties[u"ApprovalPending"]:
 
292
 
            timeout = datetime.timedelta(milliseconds
 
295
 
            last_approval_request = isoformat_to_datetime(
 
296
 
                self.properties[u"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[u"ApprovedByDefault"]:
 
303
 
                message = u"Approval in %s. (d)eny?"
 
305
 
                message = u"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[u"LastCheckedOK"]
 
313
 
                     or self.properties[u"Created"]),
 
314
 
                    self.properties[u"LastEnabled"]))
 
315
 
            timer = timeout - (datetime.datetime.utcnow() - last_ok)
 
316
 
            message = (u'A checker has failed! Time until client'
 
317
 
                       u' gets disabled: %s'
 
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 = [(u"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, (maxcol,), focus=False):
 
352
 
        """Render differently if we have focus.
 
353
 
        This overrides the method from urwid.FlowWidget"""
 
354
 
        return self.current_widget(focus).render((maxcol,),
 
357
 
    def keypress(self, (maxcol,), 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 == u"R" or key == u"_" or key == u"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 == u"p" or key == "=":
 
382
 
#         elif key == u"u" or key == ":":
 
383
 
#             self.proxy.unpause()
 
384
 
#         elif key == u"RET":
 
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, (maxcol, maxrow), key):
 
407
 
        ret = super(ConstrainedListBox, self).keypress((maxcol,
 
409
 
        if ret in (u"up", u"down"):
 
414
 
class UserInterface(object):
 
415
 
    """This is the entire user interface - the whole screen
 
416
 
    with boxes, lists of client widgets, etc.
 
418
 
    def __init__(self, max_log_length=1000):
 
419
 
        DBusGMainLoop(set_as_default=True)
 
421
 
        self.screen = urwid.curses_display.Screen()
 
423
 
        self.screen.register_palette((
 
425
 
                 u"default", u"default", None),
 
427
 
                 u"default", u"default", u"bold"),
 
429
 
                 u"default", u"default", u"underline"),
 
431
 
                 u"default", u"default", u"standout"),
 
432
 
                (u"bold-underline-blink",
 
433
 
                 u"default", u"default", (u"bold", u"underline")),
 
435
 
                 u"default", u"default", (u"bold", u"standout")),
 
436
 
                (u"underline-blink-standout",
 
437
 
                 u"default", u"default", (u"underline", u"standout")),
 
438
 
                (u"bold-underline-blink-standout",
 
439
 
                 u"default", u"default", (u"bold", u"underline",
 
443
 
        if urwid.supports_unicode():
 
444
 
            self.divider = u"─" # \u2500
 
445
 
            #self.divider = u"━" # \u2501
 
447
 
            #self.divider = u"-" # \u002d
 
448
 
            self.divider = u"_" # \u005f
 
452
 
        self.size = self.screen.get_cols_rows()
 
454
 
        self.clients = urwid.SimpleListWalker([])
 
455
 
        self.clients_dict = {}
 
457
 
        # We will add Text widgets to this list
 
459
 
        self.max_log_length = max_log_length
 
461
 
        # We keep a reference to the log widget so we can remove it
 
462
 
        # from the ListWalker without it getting destroyed
 
463
 
        self.logbox = ConstrainedListBox(self.log)
 
465
 
        # This keeps track of whether self.uilist currently has
 
466
 
        # self.logbox in it or not
 
467
 
        self.log_visible = True
 
468
 
        self.log_wrap = u"any"
 
471
 
        self.log_message_raw((u"bold",
 
472
 
                              u"Mandos Monitor version " + version))
 
473
 
        self.log_message_raw((u"bold",
 
476
 
        self.busname = domain + '.Mandos'
 
477
 
        self.main_loop = gobject.MainLoop()
 
478
 
        self.bus = dbus.SystemBus()
 
479
 
        mandos_dbus_objc = self.bus.get_object(
 
480
 
            self.busname, u"/", follow_name_owner_changes=True)
 
481
 
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
 
485
 
            mandos_clients = (self.mandos_serv
 
486
 
                              .GetAllClientsWithProperties())
 
487
 
        except dbus.exceptions.DBusException:
 
488
 
            mandos_clients = dbus.Dictionary()
 
491
 
         .connect_to_signal(u"ClientRemoved",
 
492
 
                            self.find_and_remove_client,
 
493
 
                            dbus_interface=server_interface,
 
496
 
         .connect_to_signal(u"ClientAdded",
 
498
 
                            dbus_interface=server_interface,
 
501
 
         .connect_to_signal(u"ClientNotFound",
 
502
 
                            self.client_not_found,
 
503
 
                            dbus_interface=server_interface,
 
505
 
        for path, client in mandos_clients.iteritems():
 
506
 
            client_proxy_object = self.bus.get_object(self.busname,
 
508
 
            self.add_client(MandosClientWidget(server_proxy_object
 
511
 
                                               =client_proxy_object,
 
521
 
    def client_not_found(self, fingerprint, address):
 
522
 
        self.log_message((u"Client with address %s and fingerprint %s"
 
523
 
                          u" could not be found" % (address,
 
527
 
        """This rebuilds the User Interface.
 
528
 
        Call this when the widget layout needs to change"""
 
530
 
        #self.uilist.append(urwid.ListBox(self.clients))
 
531
 
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.
 
533
 
                                       #header=urwid.Divider(),
 
536
 
                                       urwid.Divider(div_char=
 
539
 
            self.uilist.append(self.logbox)
 
541
 
        self.topwidget = urwid.Pile(self.uilist)
 
543
 
    def log_message(self, message):
 
544
 
        timestamp = datetime.datetime.now().isoformat()
 
545
 
        self.log_message_raw(timestamp + u": " + message)
 
547
 
    def log_message_raw(self, markup):
 
548
 
        """Add a log message to the log buffer."""
 
549
 
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
 
550
 
        if (self.max_log_length
 
551
 
            and len(self.log) > self.max_log_length):
 
552
 
            del self.log[0:len(self.log)-self.max_log_length-1]
 
553
 
        self.logbox.set_focus(len(self.logbox.body.contents),
 
554
 
                              coming_from=u"above")
 
557
 
    def toggle_log_display(self):
 
558
 
        """Toggle visibility of the log buffer."""
 
559
 
        self.log_visible = not self.log_visible
 
561
 
        #self.log_message(u"Log visibility changed to: "
 
562
 
        #                 + unicode(self.log_visible))
 
564
 
    def change_log_display(self):
 
565
 
        """Change type of log display.
 
566
 
        Currently, this toggles wrapping of text lines."""
 
567
 
        if self.log_wrap == u"clip":
 
568
 
            self.log_wrap = u"any"
 
570
 
            self.log_wrap = u"clip"
 
571
 
        for textwidget in self.log:
 
572
 
            textwidget.set_wrap_mode(self.log_wrap)
 
573
 
        #self.log_message(u"Wrap mode: " + self.log_wrap)
 
575
 
    def find_and_remove_client(self, path, name):
 
576
 
        """Find an client from its object path and remove it.
 
578
 
        This is connected to the ClientRemoved signal from the
 
579
 
        Mandos server object."""
 
581
 
            client = self.clients_dict[path]
 
585
 
        self.remove_client(client, path)
 
587
 
    def add_new_client(self, path):
 
588
 
        client_proxy_object = self.bus.get_object(self.busname, path)
 
589
 
        self.add_client(MandosClientWidget(server_proxy_object
 
592
 
                                           =client_proxy_object,
 
601
 
    def add_client(self, client, path=None):
 
602
 
        self.clients.append(client)
 
604
 
            path = client.proxy.object_path
 
605
 
        self.clients_dict[path] = client
 
606
 
        self.clients.sort(None, lambda c: c.properties[u"Name"])
 
609
 
    def remove_client(self, client, path=None):
 
610
 
        self.clients.remove(client)
 
612
 
            path = client.proxy.object_path
 
613
 
        del self.clients_dict[path]
 
614
 
        if not self.clients_dict:
 
615
 
            # Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker
 
616
 
            # is completely emptied, we need to recreate it.
 
617
 
            self.clients = urwid.SimpleListWalker([])
 
622
 
        """Redraw the screen"""
 
623
 
        canvas = self.topwidget.render(self.size, focus=True)
 
624
 
        self.screen.draw_screen(self.size, canvas)
 
627
 
        """Start the main loop and exit when it's done."""
 
629
 
        self._input_callback_tag = (gobject.io_add_watch
 
634
 
        # Main loop has finished, we should close everything now
 
635
 
        gobject.source_remove(self._input_callback_tag)
 
639
 
        self.main_loop.quit()
 
641
 
    def process_input(self, source, condition):
 
642
 
        keys = self.screen.get_input()
 
643
 
        translations = { u"ctrl n": u"down",      # Emacs
 
644
 
                         u"ctrl p": u"up",        # Emacs
 
645
 
                         u"ctrl v": u"page down", # Emacs
 
646
 
                         u"meta v": u"page up",   # Emacs
 
647
 
                         u" ": u"page down",      # less
 
648
 
                         u"f": u"page down",      # less
 
649
 
                         u"b": u"page up",        # less
 
655
 
                key = translations[key]
 
656
 
            except KeyError:    # :-)
 
659
 
            if key == u"q" or key == u"Q":
 
662
 
            elif key == u"window resize":
 
663
 
                self.size = self.screen.get_cols_rows()
 
665
 
            elif key == u"\f":  # Ctrl-L
 
667
 
            elif key == u"l" or key == u"D":
 
668
 
                self.toggle_log_display()
 
670
 
            elif key == u"w" or key == u"i":
 
671
 
                self.change_log_display()
 
673
 
            elif key == u"?" or key == u"f1" or key == u"esc":
 
674
 
                if not self.log_visible:
 
675
 
                    self.log_visible = True
 
677
 
                self.log_message_raw((u"bold",
 
681
 
                                            u"l: Log window toggle",
 
682
 
                                            u"TAB: Switch window",
 
684
 
                self.log_message_raw((u"bold",
 
690
 
                                             u"s: Start new checker",
 
697
 
                if self.topwidget.get_focus() is self.logbox:
 
698
 
                    self.topwidget.set_focus(0)
 
700
 
                    self.topwidget.set_focus(self.logbox)
 
702
 
            #elif (key == u"end" or key == u"meta >" or key == u"G"
 
704
 
            #    pass            # xxx end-of-buffer
 
705
 
            #elif (key == u"home" or key == u"meta <" or key == u"g"
 
707
 
            #    pass            # xxx beginning-of-buffer
 
708
 
            #elif key == u"ctrl e" or key == u"$":
 
709
 
            #    pass            # xxx move-end-of-line
 
710
 
            #elif key == u"ctrl a" or key == u"^":
 
711
 
            #    pass            # xxx move-beginning-of-line
 
712
 
            #elif key == u"ctrl b" or key == u"meta (" or key == u"h":
 
714
 
            #elif key == u"ctrl f" or key == u"meta )" or key == u"l":
 
717
 
            #    pass            # scroll up log
 
719
 
            #    pass            # scroll down log
 
720
 
            elif self.topwidget.selectable():
 
721
 
                self.topwidget.keypress(self.size, key)
 
728
 
except KeyboardInterrupt:
 
731
 
    ui.log_message(unicode(e))