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.major == 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("PropertiesChanged",
 
 
91
                                         self.properties_changed,
 
 
92
                                         dbus.PROPERTIES_IFACE,
 
 
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 properties_changed(self, interface, properties, invalidated):
 
 
104
        """This is called whenever we get a PropertiesChanged signal
 
 
105
        It updates the changed properties in the "properties" dict.
 
 
107
        # Update properties dict with new value
 
 
108
        self.properties.update(properties)
 
 
111
        self.property_changed_match.remove()
 
 
114
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
 
 
115
    """A Mandos Client which is visible on the screen.
 
 
118
    def __init__(self, server_proxy_object=None, update_hook=None,
 
 
119
                 delete_hook=None, logger=None, **kwargs):
 
 
121
        self.update_hook = update_hook
 
 
123
        self.delete_hook = delete_hook
 
 
124
        # Mandos Server proxy object
 
 
125
        self.server_proxy_object = server_proxy_object
 
 
129
        self._update_timer_callback_tag = None
 
 
131
        # The widget shown normally
 
 
132
        self._text_widget = urwid.Text("")
 
 
133
        # The widget shown when we have focus
 
 
134
        self._focus_text_widget = urwid.Text("")
 
 
135
        super(MandosClientWidget, self).__init__(**kwargs)
 
 
139
        self.match_objects = (
 
 
140
            self.proxy.connect_to_signal("CheckerCompleted",
 
 
141
                                         self.checker_completed,
 
 
144
            self.proxy.connect_to_signal("CheckerStarted",
 
 
145
                                         self.checker_started,
 
 
148
            self.proxy.connect_to_signal("GotSecret",
 
 
152
            self.proxy.connect_to_signal("NeedApproval",
 
 
156
            self.proxy.connect_to_signal("Rejected",
 
 
160
        self.logger('Created client {}'
 
 
161
                    .format(self.properties["Name"]), level=0)
 
 
163
    def using_timer(self, flag):
 
 
164
        """Call this method with True or False when timer should be
 
 
165
        activated or deactivated.
 
 
167
        if flag and self._update_timer_callback_tag is None:
 
 
168
            # Will update the shown timer value every second
 
 
169
            self._update_timer_callback_tag = (gobject.timeout_add
 
 
172
        elif not (flag or self._update_timer_callback_tag is None):
 
 
173
            gobject.source_remove(self._update_timer_callback_tag)
 
 
174
            self._update_timer_callback_tag = None
 
 
176
    def checker_completed(self, exitstatus, condition, command):
 
 
178
            self.logger('Checker for client {} (command "{}")'
 
 
179
                        ' succeeded'.format(self.properties["Name"],
 
 
184
        if os.WIFEXITED(condition):
 
 
185
            self.logger('Checker for client {} (command "{}") failed'
 
 
187
                        .format(self.properties["Name"], command,
 
 
188
                                os.WEXITSTATUS(condition)))
 
 
189
        elif os.WIFSIGNALED(condition):
 
 
190
            self.logger('Checker for client {} (command "{}") was'
 
 
191
                        ' killed by signal {}'
 
 
192
                        .format(self.properties["Name"], command,
 
 
193
                                os.WTERMSIG(condition)))
 
 
194
        elif os.WCOREDUMP(condition):
 
 
195
            self.logger('Checker for client {} (command "{}") dumped'
 
 
196
                        ' core'.format(self.properties["Name"],
 
 
199
            self.logger('Checker for client {} completed'
 
 
201
                        .format(self.properties["Name"]))
 
 
204
    def checker_started(self, command):
 
 
205
        """Server signals that a checker started."""
 
 
206
        self.logger('Client {} started checker "{}"'
 
 
207
                    .format(self.properties["Name"],
 
 
210
    def got_secret(self):
 
 
211
        self.logger('Client {} received its secret'
 
 
212
                    .format(self.properties["Name"]))
 
 
214
    def need_approval(self, timeout, default):
 
 
216
            message = 'Client {} needs approval within {} seconds'
 
 
218
            message = 'Client {} will get its secret in {} seconds'
 
 
219
        self.logger(message.format(self.properties["Name"],
 
 
222
    def rejected(self, reason):
 
 
223
        self.logger('Client {} was rejected; reason: {}'
 
 
224
                    .format(self.properties["Name"], reason))
 
 
226
    def selectable(self):
 
 
227
        """Make this a "selectable" widget.
 
 
228
        This overrides the method from urwid.FlowWidget."""
 
 
231
    def rows(self, maxcolrow, focus=False):
 
 
232
        """How many rows this widget will occupy might depend on
 
 
233
        whether we have focus or not.
 
 
234
        This overrides the method from urwid.FlowWidget"""
 
 
235
        return self.current_widget(focus).rows(maxcolrow, focus=focus)
 
 
237
    def current_widget(self, focus=False):
 
 
238
        if focus or self.opened:
 
 
239
            return self._focus_widget
 
 
243
        "Called when what is visible on the screen should be updated."
 
 
244
        # How to add standout mode to a style
 
 
245
        with_standout = { "normal": "standout",
 
 
246
                          "bold": "bold-standout",
 
 
248
                              "underline-blink-standout",
 
 
249
                          "bold-underline-blink":
 
 
250
                              "bold-underline-blink-standout",
 
 
253
        # Rebuild focus and non-focus widgets using current properties
 
 
255
        # Base part of a client. Name!
 
 
256
        base = '{name}: '.format(name=self.properties["Name"])
 
 
257
        if not self.properties["Enabled"]:
 
 
259
            self.using_timer(False)
 
 
260
        elif self.properties["ApprovalPending"]:
 
 
261
            timeout = datetime.timedelta(milliseconds
 
 
264
            last_approval_request = isoformat_to_datetime(
 
 
265
                self.properties["LastApprovalRequest"])
 
 
266
            if last_approval_request is not None:
 
 
267
                timer = max(timeout - (datetime.datetime.utcnow()
 
 
268
                                       - last_approval_request),
 
 
269
                            datetime.timedelta())
 
 
271
                timer = datetime.timedelta()
 
 
272
            if self.properties["ApprovedByDefault"]:
 
 
273
                message = "Approval in {}. (d)eny?"
 
 
275
                message = "Denial in {}. (a)pprove?"
 
 
276
            message = message.format(str(timer).rsplit(".", 1)[0])
 
 
277
            self.using_timer(True)
 
 
278
        elif self.properties["LastCheckerStatus"] != 0:
 
 
279
            # When checker has failed, show timer until client expires
 
 
280
            expires = self.properties["Expires"]
 
 
282
                timer = datetime.timedelta(0)
 
 
284
                expires = (datetime.datetime.strptime
 
 
285
                           (expires, '%Y-%m-%dT%H:%M:%S.%f'))
 
 
286
                timer = max(expires - datetime.datetime.utcnow(),
 
 
287
                            datetime.timedelta())
 
 
288
            message = ('A checker has failed! Time until client'
 
 
290
                       .format(str(timer).rsplit(".", 1)[0]))
 
 
291
            self.using_timer(True)
 
 
294
            self.using_timer(False)
 
 
295
        self._text = "{}{}".format(base, message)
 
 
297
        if not urwid.supports_unicode():
 
 
298
            self._text = self._text.encode("ascii", "replace")
 
 
299
        textlist = [("normal", self._text)]
 
 
300
        self._text_widget.set_text(textlist)
 
 
301
        self._focus_text_widget.set_text([(with_standout[text[0]],
 
 
303
                                          if isinstance(text, tuple)
 
 
305
                                          for text in textlist])
 
 
306
        self._widget = self._text_widget
 
 
307
        self._focus_widget = urwid.AttrWrap(self._focus_text_widget,
 
 
309
        # Run update hook, if any
 
 
310
        if self.update_hook is not None:
 
 
313
    def update_timer(self):
 
 
314
        """called by gobject. Will indefinitely loop until
 
 
315
        gobject.source_remove() on tag is called"""
 
 
317
        return True             # Keep calling this
 
 
319
    def delete(self, **kwargs):
 
 
320
        if self._update_timer_callback_tag is not None:
 
 
321
            gobject.source_remove(self._update_timer_callback_tag)
 
 
322
            self._update_timer_callback_tag = None
 
 
323
        for match in self.match_objects:
 
 
325
        self.match_objects = ()
 
 
326
        if self.delete_hook is not None:
 
 
327
            self.delete_hook(self)
 
 
328
        return super(MandosClientWidget, self).delete(**kwargs)
 
 
330
    def render(self, maxcolrow, focus=False):
 
 
331
        """Render differently if we have focus.
 
 
332
        This overrides the method from urwid.FlowWidget"""
 
 
333
        return self.current_widget(focus).render(maxcolrow,
 
 
336
    def keypress(self, maxcolrow, key):
 
 
338
        This overrides the method from urwid.FlowWidget"""
 
 
340
            self.proxy.Enable(dbus_interface = client_interface,
 
 
343
            self.proxy.Disable(dbus_interface = client_interface,
 
 
346
            self.proxy.Approve(dbus.Boolean(True, variant_level=1),
 
 
347
                               dbus_interface = client_interface,
 
 
350
            self.proxy.Approve(dbus.Boolean(False, variant_level=1),
 
 
351
                                  dbus_interface = client_interface,
 
 
353
        elif key == "R" or key == "_" or key == "ctrl k":
 
 
354
            self.server_proxy_object.RemoveClient(self.proxy
 
 
358
            self.proxy.StartChecker(dbus_interface = client_interface,
 
 
361
            self.proxy.StopChecker(dbus_interface = client_interface,
 
 
364
            self.proxy.CheckedOK(dbus_interface = client_interface,
 
 
367
#         elif key == "p" or key == "=":
 
 
369
#         elif key == "u" or key == ":":
 
 
370
#             self.proxy.unpause()
 
 
376
    def properties_changed(self, interface, properties, invalidated):
 
 
377
        """Call self.update() if any properties changed.
 
 
378
        This overrides the method from MandosClientPropertyCache"""
 
 
379
        old_values = { key: self.properties.get(key)
 
 
380
                       for key in properties.keys() }
 
 
381
        super(MandosClientWidget, self).properties_changed(
 
 
382
            interface, properties, invalidated)
 
 
383
        if any(old_values[key] != self.properties.get(key)
 
 
384
               for key in old_values):
 
 
388
class ConstrainedListBox(urwid.ListBox):
 
 
389
    """Like a normal urwid.ListBox, but will consume all "up" or
 
 
390
    "down" key presses, thus not allowing any containing widgets to
 
 
391
    use them as an excuse to shift focus away from this widget.
 
 
393
    def keypress(self, *args, **kwargs):
 
 
394
        ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
 
 
395
        if ret in ("up", "down"):
 
 
400
class UserInterface(object):
 
 
401
    """This is the entire user interface - the whole screen
 
 
402
    with boxes, lists of client widgets, etc.
 
 
404
    def __init__(self, max_log_length=1000, log_level=1):
 
 
405
        DBusGMainLoop(set_as_default=True)
 
 
407
        self.screen = urwid.curses_display.Screen()
 
 
409
        self.screen.register_palette((
 
 
411
                 "default", "default", None),
 
 
413
                 "bold", "default", "bold"),
 
 
415
                 "underline,blink", "default", "underline,blink"),
 
 
417
                 "standout", "default", "standout"),
 
 
418
                ("bold-underline-blink",
 
 
419
                 "bold,underline,blink", "default", "bold,underline,blink"),
 
 
421
                 "bold,standout", "default", "bold,standout"),
 
 
422
                ("underline-blink-standout",
 
 
423
                 "underline,blink,standout", "default",
 
 
424
                 "underline,blink,standout"),
 
 
425
                ("bold-underline-blink-standout",
 
 
426
                 "bold,underline,blink,standout", "default",
 
 
427
                 "bold,underline,blink,standout"),
 
 
430
        if urwid.supports_unicode():
 
 
431
            self.divider = "─" # \u2500
 
 
432
            #self.divider = "━" # \u2501
 
 
434
            #self.divider = "-" # \u002d
 
 
435
            self.divider = "_" # \u005f
 
 
439
        self.size = self.screen.get_cols_rows()
 
 
441
        self.clients = urwid.SimpleListWalker([])
 
 
442
        self.clients_dict = {}
 
 
444
        # We will add Text widgets to this list
 
 
446
        self.max_log_length = max_log_length
 
 
448
        self.log_level = log_level
 
 
450
        # We keep a reference to the log widget so we can remove it
 
 
451
        # from the ListWalker without it getting destroyed
 
 
452
        self.logbox = ConstrainedListBox(self.log)
 
 
454
        # This keeps track of whether self.uilist currently has
 
 
455
        # self.logbox in it or not
 
 
456
        self.log_visible = True
 
 
457
        self.log_wrap = "any"
 
 
460
        self.log_message_raw(("bold",
 
 
461
                              "Mandos Monitor version " + version))
 
 
462
        self.log_message_raw(("bold",
 
 
465
        self.busname = domain + '.Mandos'
 
 
466
        self.main_loop = gobject.MainLoop()
 
 
468
    def client_not_found(self, fingerprint, address):
 
 
469
        self.log_message("Client with address {} and fingerprint {}"
 
 
470
                         " could not be found"
 
 
471
                         .format(address, fingerprint))
 
 
474
        """This rebuilds the User Interface.
 
 
475
        Call this when the widget layout needs to change"""
 
 
477
        #self.uilist.append(urwid.ListBox(self.clients))
 
 
478
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.
 
 
480
                                       #header=urwid.Divider(),
 
 
483
                                       urwid.Divider(div_char=
 
 
486
            self.uilist.append(self.logbox)
 
 
487
        self.topwidget = urwid.Pile(self.uilist)
 
 
489
    def log_message(self, message, level=1):
 
 
490
        """Log message formatted with timestamp"""
 
 
491
        if level < self.log_level:
 
 
493
        timestamp = datetime.datetime.now().isoformat()
 
 
494
        self.log_message_raw("{}: {}".format(timestamp, message),
 
 
497
    def log_message_raw(self, markup, level=1):
 
 
498
        """Add a log message to the log buffer."""
 
 
499
        if level < self.log_level:
 
 
501
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
 
 
502
        if (self.max_log_length
 
 
503
            and len(self.log) > self.max_log_length):
 
 
504
            del self.log[0:len(self.log)-self.max_log_length-1]
 
 
505
        self.logbox.set_focus(len(self.logbox.body.contents),
 
 
509
    def toggle_log_display(self):
 
 
510
        """Toggle visibility of the log buffer."""
 
 
511
        self.log_visible = not self.log_visible
 
 
513
        self.log_message("Log visibility changed to: {}"
 
 
514
                         .format(self.log_visible), level=0)
 
 
516
    def change_log_display(self):
 
 
517
        """Change type of log display.
 
 
518
        Currently, this toggles wrapping of text lines."""
 
 
519
        if self.log_wrap == "clip":
 
 
520
            self.log_wrap = "any"
 
 
522
            self.log_wrap = "clip"
 
 
523
        for textwidget in self.log:
 
 
524
            textwidget.set_wrap_mode(self.log_wrap)
 
 
525
        self.log_message("Wrap mode: {}".format(self.log_wrap),
 
 
528
    def find_and_remove_client(self, path, name):
 
 
529
        """Find a client by its object path and remove it.
 
 
531
        This is connected to the ClientRemoved signal from the
 
 
532
        Mandos server object."""
 
 
534
            client = self.clients_dict[path]
 
 
537
            self.log_message("Unknown client {!r} ({!r}) removed"
 
 
542
    def add_new_client(self, path):
 
 
543
        client_proxy_object = self.bus.get_object(self.busname, path)
 
 
544
        self.add_client(MandosClientWidget(server_proxy_object
 
 
547
                                           =client_proxy_object,
 
 
556
    def add_client(self, client, path=None):
 
 
557
        self.clients.append(client)
 
 
559
            path = client.proxy.object_path
 
 
560
        self.clients_dict[path] = client
 
 
561
        self.clients.sort(key=lambda c: c.properties["Name"])
 
 
564
    def remove_client(self, client, path=None):
 
 
565
        self.clients.remove(client)
 
 
567
            path = client.proxy.object_path
 
 
568
        del self.clients_dict[path]
 
 
572
        """Redraw the screen"""
 
 
573
        canvas = self.topwidget.render(self.size, focus=True)
 
 
574
        self.screen.draw_screen(self.size, canvas)
 
 
577
        """Start the main loop and exit when it's done."""
 
 
578
        self.bus = dbus.SystemBus()
 
 
579
        mandos_dbus_objc = self.bus.get_object(
 
 
580
            self.busname, "/", follow_name_owner_changes=True)
 
 
581
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
 
 
585
            mandos_clients = (self.mandos_serv
 
 
586
                              .GetAllClientsWithProperties())
 
 
587
            if not mandos_clients:
 
 
588
                self.log_message_raw(("bold", "Note: Server has no clients."))
 
 
589
        except dbus.exceptions.DBusException:
 
 
590
            self.log_message_raw(("bold", "Note: No Mandos server running."))
 
 
591
            mandos_clients = dbus.Dictionary()
 
 
594
         .connect_to_signal("ClientRemoved",
 
 
595
                            self.find_and_remove_client,
 
 
596
                            dbus_interface=server_interface,
 
 
599
         .connect_to_signal("ClientAdded",
 
 
601
                            dbus_interface=server_interface,
 
 
604
         .connect_to_signal("ClientNotFound",
 
 
605
                            self.client_not_found,
 
 
606
                            dbus_interface=server_interface,
 
 
608
        for path, client in mandos_clients.items():
 
 
609
            client_proxy_object = self.bus.get_object(self.busname,
 
 
611
            self.add_client(MandosClientWidget(server_proxy_object
 
 
614
                                               =client_proxy_object,
 
 
625
        self._input_callback_tag = (gobject.io_add_watch
 
 
630
        # Main loop has finished, we should close everything now
 
 
631
        gobject.source_remove(self._input_callback_tag)
 
 
635
        self.main_loop.quit()
 
 
637
    def process_input(self, source, condition):
 
 
638
        keys = self.screen.get_input()
 
 
639
        translations = { "ctrl n": "down",      # Emacs
 
 
640
                         "ctrl p": "up",        # Emacs
 
 
641
                         "ctrl v": "page down", # Emacs
 
 
642
                         "meta v": "page up",   # Emacs
 
 
643
                         " ": "page down",      # less
 
 
644
                         "f": "page down",      # less
 
 
645
                         "b": "page up",        # less
 
 
651
                key = translations[key]
 
 
652
            except KeyError:    # :-)
 
 
655
            if key == "q" or key == "Q":
 
 
658
            elif key == "window resize":
 
 
659
                self.size = self.screen.get_cols_rows()
 
 
661
            elif key == "ctrl l":
 
 
664
            elif key == "l" or key == "D":
 
 
665
                self.toggle_log_display()
 
 
667
            elif key == "w" or key == "i":
 
 
668
                self.change_log_display()
 
 
670
            elif key == "?" or key == "f1" or key == "esc":
 
 
671
                if not self.log_visible:
 
 
672
                    self.log_visible = True
 
 
674
                self.log_message_raw(("bold",
 
 
678
                                            "l: Log window toggle",
 
 
679
                                            "TAB: Switch window",
 
 
680
                                            "w: Wrap (log lines)",
 
 
681
                                            "v: Toggle verbose log",
 
 
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)
 
 
702
                if self.log_level == 0:
 
 
704
                    self.log_message("Verbose mode: Off")
 
 
707
                    self.log_message("Verbose mode: On")
 
 
708
            #elif (key == "end" or key == "meta >" or key == "G"
 
 
710
            #    pass            # xxx end-of-buffer
 
 
711
            #elif (key == "home" or key == "meta <" or key == "g"
 
 
713
            #    pass            # xxx beginning-of-buffer
 
 
714
            #elif key == "ctrl e" or key == "$":
 
 
715
            #    pass            # xxx move-end-of-line
 
 
716
            #elif key == "ctrl a" or key == "^":
 
 
717
            #    pass            # xxx move-beginning-of-line
 
 
718
            #elif key == "ctrl b" or key == "meta (" or key == "h":
 
 
720
            #elif key == "ctrl f" or key == "meta )" or key == "l":
 
 
723
            #    pass            # scroll up log
 
 
725
            #    pass            # scroll down log
 
 
726
            elif self.topwidget.selectable():
 
 
727
                self.topwidget.keypress(self.size, key)
 
 
734
except KeyboardInterrupt:
 
 
736
except Exception as e:
 
 
737
    ui.log_message(str(e))