2
# -*- mode: python; coding: utf-8 -*-
 
 
4
# Mandos Monitor - Control and monitor the Mandos server
 
 
6
# Copyright © 2009-2014 Teddy Hogeborn
 
 
7
# Copyright © 2009-2014 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
 
 
21
# <http://www.gnu.org/licenses/>.
 
 
23
# Contact the authors at <mandos@recompile.se>.
 
 
26
from __future__ import (division, absolute_import, print_function,
 
 
29
    from future_builtins import *
 
 
38
import urwid.curses_display
 
 
41
from dbus.mainloop.glib import DBusGMainLoop
 
 
45
    from gi.repository import GObject as gobject
 
 
51
if sys.version_info[0] == 2:
 
 
54
locale.setlocale(locale.LC_ALL, '')
 
 
57
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
 
 
59
# Some useful constants
 
 
60
domain = 'se.recompile'
 
 
61
server_interface = domain + '.Mandos'
 
 
62
client_interface = domain + '.Mandos.Client'
 
 
65
def isoformat_to_datetime(iso):
 
 
66
    "Parse an ISO 8601 date string to a datetime.datetime()"
 
 
69
    d, t = iso.split("T", 1)
 
 
70
    year, month, day = d.split("-", 2)
 
 
71
    hour, minute, second = t.split(":", 2)
 
 
72
    second, fraction = divmod(float(second), 1)
 
 
73
    return datetime.datetime(int(year),
 
 
78
                             int(second),           # Whole seconds
 
 
79
                             int(fraction*1000000)) # Microseconds
 
 
81
class MandosClientPropertyCache(object):
 
 
82
    """This wraps a Mandos Client D-Bus proxy object, caches the
 
 
83
    properties and calls a hook function when any of them are
 
 
86
    def __init__(self, proxy_object=None, properties=None, **kwargs):
 
 
87
        self.proxy = proxy_object # Mandos Client proxy object
 
 
88
        self.properties = dict() if properties is None else properties
 
 
89
        self.property_changed_match = (
 
 
90
            self.proxy.connect_to_signal("PropertyChanged",
 
 
91
                                         self._property_changed,
 
 
95
        if properties is None:
 
 
96
            self.properties.update(
 
 
97
                self.proxy.GetAll(client_interface,
 
 
99
                                  = dbus.PROPERTIES_IFACE))
 
 
101
        super(MandosClientPropertyCache, self).__init__(**kwargs)
 
 
103
    def _property_changed(self, property, value):
 
 
104
        """Helper which takes positional arguments"""
 
 
105
        return self.property_changed(property=property, value=value)
 
 
107
    def property_changed(self, property=None, value=None):
 
 
108
        """This is called whenever we get a PropertyChanged signal
 
 
109
        It updates the changed property in the "properties" dict.
 
 
111
        # Update properties dict with new value
 
 
112
        self.properties[property] = value
 
 
115
        self.property_changed_match.remove()
 
 
118
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
 
 
119
    """A Mandos Client which is visible on the screen.
 
 
122
    def __init__(self, server_proxy_object=None, update_hook=None,
 
 
123
                 delete_hook=None, logger=None, **kwargs):
 
 
125
        self.update_hook = update_hook
 
 
127
        self.delete_hook = delete_hook
 
 
128
        # Mandos Server proxy object
 
 
129
        self.server_proxy_object = server_proxy_object
 
 
133
        self._update_timer_callback_tag = None
 
 
135
        # The widget shown normally
 
 
136
        self._text_widget = urwid.Text("")
 
 
137
        # The widget shown when we have focus
 
 
138
        self._focus_text_widget = urwid.Text("")
 
 
139
        super(MandosClientWidget, self).__init__(**kwargs)
 
 
143
        self.match_objects = (
 
 
144
            self.proxy.connect_to_signal("CheckerCompleted",
 
 
145
                                         self.checker_completed,
 
 
148
            self.proxy.connect_to_signal("CheckerStarted",
 
 
149
                                         self.checker_started,
 
 
152
            self.proxy.connect_to_signal("GotSecret",
 
 
156
            self.proxy.connect_to_signal("NeedApproval",
 
 
160
            self.proxy.connect_to_signal("Rejected",
 
 
164
        self.logger('Created client {}'
 
 
165
                    .format(self.properties["Name"]), level=0)
 
 
167
    def using_timer(self, flag):
 
 
168
        """Call this method with True or False when timer should be
 
 
169
        activated or deactivated.
 
 
171
        if flag and self._update_timer_callback_tag is None:
 
 
172
            # Will update the shown timer value every second
 
 
173
            self._update_timer_callback_tag = (gobject.timeout_add
 
 
176
        elif not (flag or self._update_timer_callback_tag is None):
 
 
177
            gobject.source_remove(self._update_timer_callback_tag)
 
 
178
            self._update_timer_callback_tag = None
 
 
180
    def checker_completed(self, exitstatus, condition, command):
 
 
182
            self.logger('Checker for client {} (command "{}")'
 
 
183
                        ' succeeded'.format(self.properties["Name"],
 
 
188
        if os.WIFEXITED(condition):
 
 
189
            self.logger('Checker for client {} (command "{}") failed'
 
 
191
                        .format(self.properties["Name"], command,
 
 
192
                                os.WEXITSTATUS(condition)))
 
 
193
        elif os.WIFSIGNALED(condition):
 
 
194
            self.logger('Checker for client {} (command "{}") was'
 
 
195
                        ' killed by signal {}'
 
 
196
                        .format(self.properties["Name"], command,
 
 
197
                                os.WTERMSIG(condition)))
 
 
198
        elif os.WCOREDUMP(condition):
 
 
199
            self.logger('Checker for client {} (command "{}") dumped'
 
 
200
                        ' core'.format(self.properties["Name"],
 
 
203
            self.logger('Checker for client {} completed'
 
 
205
                        .format(self.properties["Name"]))
 
 
208
    def checker_started(self, command):
 
 
209
        """Server signals that a checker started."""
 
 
210
        self.logger('Client {} started checker "{}"'
 
 
211
                    .format(self.properties["Name"],
 
 
214
    def got_secret(self):
 
 
215
        self.logger('Client {} received its secret'
 
 
216
                    .format(self.properties["Name"]))
 
 
218
    def need_approval(self, timeout, default):
 
 
220
            message = 'Client {} needs approval within {} seconds'
 
 
222
            message = 'Client {} will get its secret in {} seconds'
 
 
223
        self.logger(message.format(self.properties["Name"],
 
 
226
    def rejected(self, reason):
 
 
227
        self.logger('Client {} was rejected; reason: {}'
 
 
228
                    .format(self.properties["Name"], reason))
 
 
230
    def selectable(self):
 
 
231
        """Make this a "selectable" widget.
 
 
232
        This overrides the method from urwid.FlowWidget."""
 
 
235
    def rows(self, maxcolrow, focus=False):
 
 
236
        """How many rows this widget will occupy might depend on
 
 
237
        whether we have focus or not.
 
 
238
        This overrides the method from urwid.FlowWidget"""
 
 
239
        return self.current_widget(focus).rows(maxcolrow, focus=focus)
 
 
241
    def current_widget(self, focus=False):
 
 
242
        if focus or self.opened:
 
 
243
            return self._focus_widget
 
 
247
        "Called when what is visible on the screen should be updated."
 
 
248
        # How to add standout mode to a style
 
 
249
        with_standout = { "normal": "standout",
 
 
250
                          "bold": "bold-standout",
 
 
252
                              "underline-blink-standout",
 
 
253
                          "bold-underline-blink":
 
 
254
                              "bold-underline-blink-standout",
 
 
257
        # Rebuild focus and non-focus widgets using current properties
 
 
259
        # Base part of a client. Name!
 
 
260
        base = '{name}: '.format(name=self.properties["Name"])
 
 
261
        if not self.properties["Enabled"]:
 
 
263
            self.using_timer(False)
 
 
264
        elif self.properties["ApprovalPending"]:
 
 
265
            timeout = datetime.timedelta(milliseconds
 
 
268
            last_approval_request = isoformat_to_datetime(
 
 
269
                self.properties["LastApprovalRequest"])
 
 
270
            if last_approval_request is not None:
 
 
271
                timer = max(timeout - (datetime.datetime.utcnow()
 
 
272
                                       - last_approval_request),
 
 
273
                            datetime.timedelta())
 
 
275
                timer = datetime.timedelta()
 
 
276
            if self.properties["ApprovedByDefault"]:
 
 
277
                message = "Approval in {}. (d)eny?"
 
 
279
                message = "Denial in {}. (a)pprove?"
 
 
280
            message = message.format(str(timer).rsplit(".", 1)[0])
 
 
281
            self.using_timer(True)
 
 
282
        elif self.properties["LastCheckerStatus"] != 0:
 
 
283
            # When checker has failed, show timer until client expires
 
 
284
            expires = self.properties["Expires"]
 
 
286
                timer = datetime.timedelta(0)
 
 
288
                expires = (datetime.datetime.strptime
 
 
289
                           (expires, '%Y-%m-%dT%H:%M:%S.%f'))
 
 
290
                timer = max(expires - datetime.datetime.utcnow(),
 
 
291
                            datetime.timedelta())
 
 
292
            message = ('A checker has failed! Time until client'
 
 
294
                       .format(str(timer).rsplit(".", 1)[0]))
 
 
295
            self.using_timer(True)
 
 
298
            self.using_timer(False)
 
 
299
        self._text = "{}{}".format(base, message)
 
 
301
        if not urwid.supports_unicode():
 
 
302
            self._text = self._text.encode("ascii", "replace")
 
 
303
        textlist = [("normal", self._text)]
 
 
304
        self._text_widget.set_text(textlist)
 
 
305
        self._focus_text_widget.set_text([(with_standout[text[0]],
 
 
307
                                          if isinstance(text, tuple)
 
 
309
                                          for text in textlist])
 
 
310
        self._widget = self._text_widget
 
 
311
        self._focus_widget = urwid.AttrWrap(self._focus_text_widget,
 
 
313
        # Run update hook, if any
 
 
314
        if self.update_hook is not None:
 
 
317
    def update_timer(self):
 
 
318
        """called by gobject. Will indefinitely loop until
 
 
319
        gobject.source_remove() on tag is called"""
 
 
321
        return True             # Keep calling this
 
 
323
    def delete(self, **kwargs):
 
 
324
        if self._update_timer_callback_tag is not None:
 
 
325
            gobject.source_remove(self._update_timer_callback_tag)
 
 
326
            self._update_timer_callback_tag = None
 
 
327
        for match in self.match_objects:
 
 
329
        self.match_objects = ()
 
 
330
        if self.delete_hook is not None:
 
 
331
            self.delete_hook(self)
 
 
332
        return super(MandosClientWidget, self).delete(**kwargs)
 
 
334
    def render(self, maxcolrow, focus=False):
 
 
335
        """Render differently if we have focus.
 
 
336
        This overrides the method from urwid.FlowWidget"""
 
 
337
        return self.current_widget(focus).render(maxcolrow,
 
 
340
    def keypress(self, maxcolrow, key):
 
 
342
        This overrides the method from urwid.FlowWidget"""
 
 
344
            self.proxy.Enable(dbus_interface = client_interface,
 
 
347
            self.proxy.Disable(dbus_interface = client_interface,
 
 
350
            self.proxy.Approve(dbus.Boolean(True, variant_level=1),
 
 
351
                               dbus_interface = client_interface,
 
 
354
            self.proxy.Approve(dbus.Boolean(False, variant_level=1),
 
 
355
                                  dbus_interface = client_interface,
 
 
357
        elif key == "R" or key == "_" or key == "ctrl k":
 
 
358
            self.server_proxy_object.RemoveClient(self.proxy
 
 
362
            self.proxy.StartChecker(dbus_interface = client_interface,
 
 
365
            self.proxy.StopChecker(dbus_interface = client_interface,
 
 
368
            self.proxy.CheckedOK(dbus_interface = client_interface,
 
 
371
#         elif key == "p" or key == "=":
 
 
373
#         elif key == "u" or key == ":":
 
 
374
#             self.proxy.unpause()
 
 
380
    def property_changed(self, property=None, **kwargs):
 
 
381
        """Call self.update() if old value is not new value.
 
 
382
        This overrides the method from MandosClientPropertyCache"""
 
 
383
        property_name = str(property)
 
 
384
        old_value = self.properties.get(property_name)
 
 
385
        super(MandosClientWidget, self).property_changed(
 
 
386
            property=property, **kwargs)
 
 
387
        if self.properties.get(property_name) != old_value:
 
 
391
class ConstrainedListBox(urwid.ListBox):
 
 
392
    """Like a normal urwid.ListBox, but will consume all "up" or
 
 
393
    "down" key presses, thus not allowing any containing widgets to
 
 
394
    use them as an excuse to shift focus away from this widget.
 
 
396
    def keypress(self, *args, **kwargs):
 
 
397
        ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
 
 
398
        if ret in ("up", "down"):
 
 
403
class UserInterface(object):
 
 
404
    """This is the entire user interface - the whole screen
 
 
405
    with boxes, lists of client widgets, etc.
 
 
407
    def __init__(self, max_log_length=1000, log_level=1):
 
 
408
        DBusGMainLoop(set_as_default=True)
 
 
410
        self.screen = urwid.curses_display.Screen()
 
 
412
        self.screen.register_palette((
 
 
414
                 "default", "default", None),
 
 
416
                 "bold", "default", "bold"),
 
 
418
                 "underline,blink", "default", "underline,blink"),
 
 
420
                 "standout", "default", "standout"),
 
 
421
                ("bold-underline-blink",
 
 
422
                 "bold,underline,blink", "default", "bold,underline,blink"),
 
 
424
                 "bold,standout", "default", "bold,standout"),
 
 
425
                ("underline-blink-standout",
 
 
426
                 "underline,blink,standout", "default",
 
 
427
                 "underline,blink,standout"),
 
 
428
                ("bold-underline-blink-standout",
 
 
429
                 "bold,underline,blink,standout", "default",
 
 
430
                 "bold,underline,blink,standout"),
 
 
433
        if urwid.supports_unicode():
 
 
434
            self.divider = "─" # \u2500
 
 
435
            #self.divider = "━" # \u2501
 
 
437
            #self.divider = "-" # \u002d
 
 
438
            self.divider = "_" # \u005f
 
 
442
        self.size = self.screen.get_cols_rows()
 
 
444
        self.clients = urwid.SimpleListWalker([])
 
 
445
        self.clients_dict = {}
 
 
447
        # We will add Text widgets to this list
 
 
449
        self.max_log_length = max_log_length
 
 
451
        self.log_level = log_level
 
 
453
        # We keep a reference to the log widget so we can remove it
 
 
454
        # from the ListWalker without it getting destroyed
 
 
455
        self.logbox = ConstrainedListBox(self.log)
 
 
457
        # This keeps track of whether self.uilist currently has
 
 
458
        # self.logbox in it or not
 
 
459
        self.log_visible = True
 
 
460
        self.log_wrap = "any"
 
 
463
        self.log_message_raw(("bold",
 
 
464
                              "Mandos Monitor version " + version))
 
 
465
        self.log_message_raw(("bold",
 
 
468
        self.busname = domain + '.Mandos'
 
 
469
        self.main_loop = gobject.MainLoop()
 
 
471
    def client_not_found(self, fingerprint, address):
 
 
472
        self.log_message("Client with address {} and fingerprint {}"
 
 
473
                         " could not be found"
 
 
474
                         .format(address, fingerprint))
 
 
477
        """This rebuilds the User Interface.
 
 
478
        Call this when the widget layout needs to change"""
 
 
480
        #self.uilist.append(urwid.ListBox(self.clients))
 
 
481
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.
 
 
483
                                       #header=urwid.Divider(),
 
 
486
                                       urwid.Divider(div_char=
 
 
489
            self.uilist.append(self.logbox)
 
 
490
        self.topwidget = urwid.Pile(self.uilist)
 
 
492
    def log_message(self, message, level=1):
 
 
493
        """Log message formatted with timestamp"""
 
 
494
        if level < self.log_level:
 
 
496
        timestamp = datetime.datetime.now().isoformat()
 
 
497
        self.log_message_raw("{}: {}".format(timestamp, message),
 
 
500
    def log_message_raw(self, markup, level=1):
 
 
501
        """Add a log message to the log buffer."""
 
 
502
        if level < self.log_level:
 
 
504
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
 
 
505
        if (self.max_log_length
 
 
506
            and len(self.log) > self.max_log_length):
 
 
507
            del self.log[0:len(self.log)-self.max_log_length-1]
 
 
508
        self.logbox.set_focus(len(self.logbox.body.contents),
 
 
512
    def toggle_log_display(self):
 
 
513
        """Toggle visibility of the log buffer."""
 
 
514
        self.log_visible = not self.log_visible
 
 
516
        self.log_message("Log visibility changed to: {}"
 
 
517
                         .format(self.log_visible), level=0)
 
 
519
    def change_log_display(self):
 
 
520
        """Change type of log display.
 
 
521
        Currently, this toggles wrapping of text lines."""
 
 
522
        if self.log_wrap == "clip":
 
 
523
            self.log_wrap = "any"
 
 
525
            self.log_wrap = "clip"
 
 
526
        for textwidget in self.log:
 
 
527
            textwidget.set_wrap_mode(self.log_wrap)
 
 
528
        self.log_message("Wrap mode: {}".format(self.log_wrap),
 
 
531
    def find_and_remove_client(self, path, name):
 
 
532
        """Find a client by its object path and remove it.
 
 
534
        This is connected to the ClientRemoved signal from the
 
 
535
        Mandos server object."""
 
 
537
            client = self.clients_dict[path]
 
 
540
            self.log_message("Unknown client {!r} ({!r}) removed"
 
 
545
    def add_new_client(self, path):
 
 
546
        client_proxy_object = self.bus.get_object(self.busname, path)
 
 
547
        self.add_client(MandosClientWidget(server_proxy_object
 
 
550
                                           =client_proxy_object,
 
 
559
    def add_client(self, client, path=None):
 
 
560
        self.clients.append(client)
 
 
562
            path = client.proxy.object_path
 
 
563
        self.clients_dict[path] = client
 
 
564
        self.clients.sort(key=lambda c: c.properties["Name"])
 
 
567
    def remove_client(self, client, path=None):
 
 
568
        self.clients.remove(client)
 
 
570
            path = client.proxy.object_path
 
 
571
        del self.clients_dict[path]
 
 
575
        """Redraw the screen"""
 
 
576
        canvas = self.topwidget.render(self.size, focus=True)
 
 
577
        self.screen.draw_screen(self.size, canvas)
 
 
580
        """Start the main loop and exit when it's done."""
 
 
581
        self.bus = dbus.SystemBus()
 
 
582
        mandos_dbus_objc = self.bus.get_object(
 
 
583
            self.busname, "/", follow_name_owner_changes=True)
 
 
584
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
 
 
588
            mandos_clients = (self.mandos_serv
 
 
589
                              .GetAllClientsWithProperties())
 
 
590
            if not mandos_clients:
 
 
591
                self.log_message_raw(("bold", "Note: Server has no clients."))
 
 
592
        except dbus.exceptions.DBusException:
 
 
593
            self.log_message_raw(("bold", "Note: No Mandos server running."))
 
 
594
            mandos_clients = dbus.Dictionary()
 
 
597
         .connect_to_signal("ClientRemoved",
 
 
598
                            self.find_and_remove_client,
 
 
599
                            dbus_interface=server_interface,
 
 
602
         .connect_to_signal("ClientAdded",
 
 
604
                            dbus_interface=server_interface,
 
 
607
         .connect_to_signal("ClientNotFound",
 
 
608
                            self.client_not_found,
 
 
609
                            dbus_interface=server_interface,
 
 
611
        for path, client in mandos_clients.items():
 
 
612
            client_proxy_object = self.bus.get_object(self.busname,
 
 
614
            self.add_client(MandosClientWidget(server_proxy_object
 
 
617
                                               =client_proxy_object,
 
 
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 == "ctrl l":
 
 
667
            elif key == "l" or key == "D":
 
 
668
                self.toggle_log_display()
 
 
670
            elif key == "w" or key == "i":
 
 
671
                self.change_log_display()
 
 
673
            elif key == "?" or key == "f1" or key == "esc":
 
 
674
                if not self.log_visible:
 
 
675
                    self.log_visible = True
 
 
677
                self.log_message_raw(("bold",
 
 
681
                                            "l: Log window toggle",
 
 
682
                                            "TAB: Switch window",
 
 
683
                                            "w: Wrap (log lines)",
 
 
684
                                            "v: Toggle verbose log",
 
 
686
                self.log_message_raw(("bold",
 
 
692
                                             "s: Start new checker",
 
 
699
                if self.topwidget.get_focus() is self.logbox:
 
 
700
                    self.topwidget.set_focus(0)
 
 
702
                    self.topwidget.set_focus(self.logbox)
 
 
705
                if self.log_level == 0:
 
 
707
                    self.log_message("Verbose mode: Off")
 
 
710
                    self.log_message("Verbose mode: On")
 
 
711
            #elif (key == "end" or key == "meta >" or key == "G"
 
 
713
            #    pass            # xxx end-of-buffer
 
 
714
            #elif (key == "home" or key == "meta <" or key == "g"
 
 
716
            #    pass            # xxx beginning-of-buffer
 
 
717
            #elif key == "ctrl e" or key == "$":
 
 
718
            #    pass            # xxx move-end-of-line
 
 
719
            #elif key == "ctrl a" or key == "^":
 
 
720
            #    pass            # xxx move-beginning-of-line
 
 
721
            #elif key == "ctrl b" or key == "meta (" or key == "h":
 
 
723
            #elif key == "ctrl f" or key == "meta )" or key == "l":
 
 
726
            #    pass            # scroll up log
 
 
728
            #    pass            # scroll down log
 
 
729
            elif self.topwidget.selectable():
 
 
730
                self.topwidget.keypress(self.size, key)
 
 
737
except KeyboardInterrupt:
 
 
739
except Exception as e:
 
 
740
    ui.log_message(str(e))