2
2
# -*- mode: python; coding: utf-8 -*-
 
4
4
# Mandos Monitor - Control and monitor the Mandos server
 
6
6
# Copyright © 2009-2016 Teddy Hogeborn
 
7
7
# Copyright © 2009-2016 Björn Påhlsson
 
9
9
# This program is free software: you can redistribute it and/or modify
 
10
10
# it under the terms of the GNU General Public License as published by
 
11
11
# the Free Software Foundation, either version 3 of the License, or
 
 
15
15
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
 
16
16
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
17
17
#     GNU General Public License for more details.
 
19
19
# You should have received a copy of the GNU General Public License
 
20
20
# along with this program.  If not, see
 
21
21
# <http://www.gnu.org/licenses/>.
 
23
23
# Contact the authors at <mandos@recompile.se>.
 
26
26
from __future__ import (division, absolute_import, print_function,
 
 
50
48
if sys.version_info.major == 2:
 
53
51
locale.setlocale(locale.LC_ALL, '')
 
55
54
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
 
57
56
# Some useful constants
 
58
57
domain = 'se.recompile'
 
59
58
server_interface = domain + '.Mandos'
 
60
59
client_interface = domain + '.Mandos.Client'
 
64
63
    dbus.OBJECT_MANAGER_IFACE
 
65
64
except AttributeError:
 
66
65
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
69
67
def isoformat_to_datetime(iso):
 
70
68
    "Parse an ISO 8601 date string to a datetime.datetime()"
 
 
82
 
                             int(second),            # Whole seconds
 
83
 
                             int(fraction*1000000))  # Microseconds
 
 
80
                             int(second),           # Whole seconds
 
 
81
                             int(fraction*1000000)) # Microseconds
 
86
83
class MandosClientPropertyCache(object):
 
87
84
    """This wraps a Mandos Client D-Bus proxy object, caches the
 
 
91
88
    def __init__(self, proxy_object=None, properties=None, **kwargs):
 
92
 
        self.proxy = proxy_object  # Mandos Client proxy object
 
 
89
        self.proxy = proxy_object # Mandos Client proxy object
 
93
90
        self.properties = dict() if properties is None else properties
 
94
91
        self.property_changed_match = (
 
95
92
            self.proxy.connect_to_signal("PropertiesChanged",
 
96
93
                                         self.properties_changed,
 
97
94
                                         dbus.PROPERTIES_IFACE,
 
100
97
        if properties is None:
 
101
 
            self.properties.update(self.proxy.GetAll(
 
103
 
                dbus_interface=dbus.PROPERTIES_IFACE))
 
 
98
            self.properties.update(
 
 
99
                self.proxy.GetAll(client_interface,
 
 
101
                                  = dbus.PROPERTIES_IFACE))
 
105
103
        super(MandosClientPropertyCache, self).__init__(**kwargs)
 
107
105
    def properties_changed(self, interface, properties, invalidated):
 
108
106
        """This is called whenever we get a PropertiesChanged signal
 
109
107
        It updates the changed properties in the "properties" dict.
 
 
119
117
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
 
120
118
    """A Mandos Client which is visible on the screen.
 
123
121
    def __init__(self, server_proxy_object=None, update_hook=None,
 
124
122
                 delete_hook=None, logger=None, **kwargs):
 
125
123
        # Called on update
 
 
164
162
                                         byte_arrays=True))
 
165
163
        self.logger('Created client {}'
 
166
164
                    .format(self.properties["Name"]), level=0)
 
168
166
    def using_timer(self, flag):
 
169
167
        """Call this method with True or False when timer should be
 
170
168
        activated or deactivated.
 
 
177
175
        elif not (flag or self._update_timer_callback_tag is None):
 
178
176
            GLib.source_remove(self._update_timer_callback_tag)
 
179
177
            self._update_timer_callback_tag = None
 
181
179
    def checker_completed(self, exitstatus, condition, command):
 
182
180
        if exitstatus == 0:
 
183
181
            self.logger('Checker for client {} (command "{}")'
 
 
197
195
                        .format(self.properties["Name"], command,
 
198
196
                                os.WTERMSIG(condition)))
 
201
199
    def checker_started(self, command):
 
202
200
        """Server signals that a checker started."""
 
203
201
        self.logger('Client {} started checker "{}"'
 
204
202
                    .format(self.properties["Name"],
 
205
203
                            command), level=0)
 
207
205
    def got_secret(self):
 
208
206
        self.logger('Client {} received its secret'
 
209
207
                    .format(self.properties["Name"]))
 
211
209
    def need_approval(self, timeout, default):
 
213
211
            message = 'Client {} needs approval within {} seconds'
 
 
215
213
            message = 'Client {} will get its secret in {} seconds'
 
216
214
        self.logger(message.format(self.properties["Name"],
 
219
217
    def rejected(self, reason):
 
220
218
        self.logger('Client {} was rejected; reason: {}'
 
221
219
                    .format(self.properties["Name"], reason))
 
223
221
    def selectable(self):
 
224
222
        """Make this a "selectable" widget.
 
225
223
        This overrides the method from urwid.FlowWidget."""
 
228
226
    def rows(self, maxcolrow, focus=False):
 
229
227
        """How many rows this widget will occupy might depend on
 
230
228
        whether we have focus or not.
 
231
229
        This overrides the method from urwid.FlowWidget"""
 
232
230
        return self.current_widget(focus).rows(maxcolrow, focus=focus)
 
234
232
    def current_widget(self, focus=False):
 
235
233
        if focus or self.opened:
 
236
234
            return self._focus_widget
 
237
235
        return self._widget
 
239
237
    def update(self):
 
240
238
        "Called when what is visible on the screen should be updated."
 
241
239
        # How to add standout mode to a style
 
242
 
        with_standout = {"normal": "standout",
 
243
 
                         "bold": "bold-standout",
 
245
 
                         "underline-blink-standout",
 
246
 
                         "bold-underline-blink":
 
247
 
                         "bold-underline-blink-standout",
 
 
240
        with_standout = { "normal": "standout",
 
 
241
                          "bold": "bold-standout",
 
 
243
                              "underline-blink-standout",
 
 
244
                          "bold-underline-blink":
 
 
245
                              "bold-underline-blink-standout",
 
250
248
        # Rebuild focus and non-focus widgets using current properties
 
252
250
        # Base part of a client. Name!
 
253
251
        base = '{name}: '.format(name=self.properties["Name"])
 
254
252
        if not self.properties["Enabled"]:
 
255
253
            message = "DISABLED"
 
256
254
            self.using_timer(False)
 
257
255
        elif self.properties["ApprovalPending"]:
 
258
 
            timeout = datetime.timedelta(
 
259
 
                milliseconds=self.properties["ApprovalDelay"])
 
 
256
            timeout = datetime.timedelta(milliseconds
 
260
259
            last_approval_request = isoformat_to_datetime(
 
261
260
                self.properties["LastApprovalRequest"])
 
262
261
            if last_approval_request is not None:
 
 
305
304
        # Run update hook, if any
 
306
305
        if self.update_hook is not None:
 
307
306
            self.update_hook()
 
309
308
    def update_timer(self):
 
310
309
        """called by GLib. Will indefinitely loop until
 
311
310
        GLib.source_remove() on tag is called
 
314
313
        return True             # Keep calling this
 
316
315
    def delete(self, **kwargs):
 
317
316
        if self._update_timer_callback_tag is not None:
 
318
317
            GLib.source_remove(self._update_timer_callback_tag)
 
 
323
322
        if self.delete_hook is not None:
 
324
323
            self.delete_hook(self)
 
325
324
        return super(MandosClientWidget, self).delete(**kwargs)
 
327
326
    def render(self, maxcolrow, focus=False):
 
328
327
        """Render differently if we have focus.
 
329
328
        This overrides the method from urwid.FlowWidget"""
 
330
329
        return self.current_widget(focus).render(maxcolrow,
 
333
332
    def keypress(self, maxcolrow, key):
 
335
334
        This overrides the method from urwid.FlowWidget"""
 
337
336
            self.proxy.Set(client_interface, "Enabled",
 
338
 
                           dbus.Boolean(True), ignore_reply=True,
 
339
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
 
337
                           dbus.Boolean(True), ignore_reply = True,
 
 
338
                           dbus_interface = dbus.PROPERTIES_IFACE)
 
341
340
            self.proxy.Set(client_interface, "Enabled", False,
 
343
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
 
342
                           dbus_interface = dbus.PROPERTIES_IFACE)
 
345
344
            self.proxy.Approve(dbus.Boolean(True, variant_level=1),
 
346
 
                               dbus_interface=client_interface,
 
 
345
                               dbus_interface = client_interface,
 
347
346
                               ignore_reply=True)
 
349
348
            self.proxy.Approve(dbus.Boolean(False, variant_level=1),
 
350
 
                               dbus_interface=client_interface,
 
 
349
                                  dbus_interface = client_interface,
 
351
350
                               ignore_reply=True)
 
352
351
        elif key == "R" or key == "_" or key == "ctrl k":
 
353
352
            self.server_proxy_object.RemoveClient(self.proxy
 
 
355
354
                                                  ignore_reply=True)
 
357
356
            self.proxy.Set(client_interface, "CheckerRunning",
 
358
 
                           dbus.Boolean(True), ignore_reply=True,
 
359
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
 
357
                           dbus.Boolean(True), ignore_reply = True,
 
 
358
                           dbus_interface = dbus.PROPERTIES_IFACE)
 
361
360
            self.proxy.Set(client_interface, "CheckerRunning",
 
362
 
                           dbus.Boolean(False), ignore_reply=True,
 
363
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
 
361
                           dbus.Boolean(False), ignore_reply = True,
 
 
362
                           dbus_interface = dbus.PROPERTIES_IFACE)
 
365
 
            self.proxy.CheckedOK(dbus_interface=client_interface,
 
 
364
            self.proxy.CheckedOK(dbus_interface = client_interface,
 
366
365
                                 ignore_reply=True)
 
368
367
#         elif key == "p" or key == "=":
 
 
377
376
    def properties_changed(self, interface, properties, invalidated):
 
378
377
        """Call self.update() if any properties changed.
 
379
378
        This overrides the method from MandosClientPropertyCache"""
 
380
 
        old_values = {key: self.properties.get(key)
 
381
 
                      for key in properties.keys()}
 
 
379
        old_values = { key: self.properties.get(key)
 
 
380
                       for key in properties.keys() }
 
382
381
        super(MandosClientWidget, self).properties_changed(
 
383
382
            interface, properties, invalidated)
 
384
383
        if any(old_values[key] != self.properties.get(key)
 
 
392
391
    use them as an excuse to shift focus away from this widget.
 
394
393
    def keypress(self, *args, **kwargs):
 
395
 
        ret = (super(ConstrainedListBox, self)
 
396
 
               .keypress(*args, **kwargs))
 
 
394
        ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
 
397
395
        if ret in ("up", "down"):
 
 
406
404
    def __init__(self, max_log_length=1000, log_level=1):
 
407
405
        DBusGMainLoop(set_as_default=True)
 
409
407
        self.screen = urwid.curses_display.Screen()
 
411
409
        self.screen.register_palette((
 
413
411
                 "default", "default", None),
 
 
419
417
                 "standout", "default", "standout"),
 
420
418
                ("bold-underline-blink",
 
421
 
                 "bold,underline,blink", "default",
 
422
 
                 "bold,underline,blink"),
 
 
419
                 "bold,underline,blink", "default", "bold,underline,blink"),
 
423
420
                ("bold-standout",
 
424
421
                 "bold,standout", "default", "bold,standout"),
 
425
422
                ("underline-blink-standout",
 
 
429
426
                 "bold,underline,blink,standout", "default",
 
430
427
                 "bold,underline,blink,standout"),
 
433
430
        if urwid.supports_unicode():
 
434
 
            self.divider = "─"  # \u2500
 
 
431
            self.divider = "─" # \u2500
 
 
432
            #self.divider = "━" # \u2501
 
436
 
            self.divider = "_"  # \u005f
 
 
434
            #self.divider = "-" # \u002d
 
 
435
            self.divider = "_" # \u005f
 
438
437
        self.screen.start()
 
440
439
        self.size = self.screen.get_cols_rows()
 
442
441
        self.clients = urwid.SimpleListWalker([])
 
443
442
        self.clients_dict = {}
 
445
444
        # We will add Text widgets to this list
 
447
446
        self.max_log_length = max_log_length
 
449
448
        self.log_level = log_level
 
451
450
        # We keep a reference to the log widget so we can remove it
 
452
451
        # from the ListWalker without it getting destroyed
 
453
452
        self.logbox = ConstrainedListBox(self.log)
 
455
454
        # This keeps track of whether self.uilist currently has
 
456
455
        # self.logbox in it or not
 
457
456
        self.log_visible = True
 
458
457
        self.log_wrap = "any"
 
461
460
        self.log_message_raw(("bold",
 
462
461
                              "Mandos Monitor version " + version))
 
463
462
        self.log_message_raw(("bold",
 
464
463
                              "q: Quit  ?: Help"))
 
466
465
        self.busname = domain + '.Mandos'
 
467
466
        self.main_loop = GLib.MainLoop()
 
469
468
    def client_not_found(self, fingerprint, address):
 
470
469
        self.log_message("Client with address {} and fingerprint {}"
 
471
470
                         " could not be found"
 
472
471
                         .format(address, fingerprint))
 
474
473
    def rebuild(self):
 
475
474
        """This rebuilds the User Interface.
 
476
475
        Call this when the widget layout needs to change"""
 
478
 
        # self.uilist.append(urwid.ListBox(self.clients))
 
 
477
        #self.uilist.append(urwid.ListBox(self.clients))
 
479
478
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.
 
481
 
                                       # header=urwid.Divider(),
 
 
480
                                       #header=urwid.Divider(),
 
483
 
                                       footer=urwid.Divider(
 
484
 
                                           div_char=self.divider)))
 
 
483
                                       urwid.Divider(div_char=
 
485
485
        if self.log_visible:
 
486
486
            self.uilist.append(self.logbox)
 
487
487
        self.topwidget = urwid.Pile(self.uilist)
 
489
489
    def log_message(self, message, level=1):
 
490
490
        """Log message formatted with timestamp"""
 
491
491
        if level < self.log_level:
 
 
493
493
        timestamp = datetime.datetime.now().isoformat()
 
494
494
        self.log_message_raw("{}: {}".format(timestamp, message),
 
497
497
    def log_message_raw(self, markup, level=1):
 
498
498
        """Add a log message to the log buffer."""
 
499
499
        if level < self.log_level:
 
501
501
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
 
502
 
        if self.max_log_length:
 
503
 
            if len(self.log) > self.max_log_length:
 
504
 
                del self.log[0:len(self.log)-self.max_log_length-1]
 
 
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
505
        self.logbox.set_focus(len(self.logbox.body.contents),
 
506
506
                              coming_from="above")
 
509
509
    def toggle_log_display(self):
 
510
510
        """Toggle visibility of the log buffer."""
 
511
511
        self.log_visible = not self.log_visible
 
513
513
        self.log_message("Log visibility changed to: {}"
 
514
514
                         .format(self.log_visible), level=0)
 
516
516
    def change_log_display(self):
 
517
517
        """Change type of log display.
 
518
518
        Currently, this toggles wrapping of text lines."""
 
 
524
524
            textwidget.set_wrap_mode(self.log_wrap)
 
525
525
        self.log_message("Wrap mode: {}".format(self.log_wrap),
 
528
528
    def find_and_remove_client(self, path, interfaces):
 
529
529
        """Find a client by its object path and remove it.
 
531
531
        This is connected to the InterfacesRemoved signal from the
 
532
532
        Mandos server object."""
 
533
533
        if client_interface not in interfaces:
 
 
552
552
            # Not a Mandos client object; ignore
 
554
554
        client_proxy_object = self.bus.get_object(self.busname, path)
 
555
 
        self.add_client(MandosClientWidget(
 
556
 
            server_proxy_object=self.mandos_serv,
 
557
 
            proxy_object=client_proxy_object,
 
558
 
            update_hook=self.refresh,
 
559
 
            delete_hook=self.remove_client,
 
560
 
            logger=self.log_message,
 
561
 
            properties=dict(ifs_and_props[client_interface])),
 
 
555
        self.add_client(MandosClientWidget(server_proxy_object
 
 
558
                                           =client_proxy_object,
 
 
566
                                           = dict(ifs_and_props[
 
564
570
    def add_client(self, client, path=None):
 
565
571
        self.clients.append(client)
 
 
568
574
        self.clients_dict[path] = client
 
569
575
        self.clients.sort(key=lambda c: c.properties["Name"])
 
572
578
    def remove_client(self, client, path=None):
 
573
579
        self.clients.remove(client)
 
575
581
            path = client.proxy.object_path
 
576
582
        del self.clients_dict[path]
 
579
585
    def refresh(self):
 
580
586
        """Redraw the screen"""
 
581
587
        canvas = self.topwidget.render(self.size, focus=True)
 
582
588
        self.screen.draw_screen(self.size, canvas)
 
585
591
        """Start the main loop and exit when it's done."""
 
586
592
        self.bus = dbus.SystemBus()
 
587
593
        mandos_dbus_objc = self.bus.get_object(
 
588
594
            self.busname, "/", follow_name_owner_changes=True)
 
589
 
        self.mandos_serv = dbus.Interface(
 
590
 
            mandos_dbus_objc, dbus_interface=server_interface)
 
 
595
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
 
592
599
            mandos_clients = (self.mandos_serv
 
593
600
                              .GetAllClientsWithProperties())
 
594
601
            if not mandos_clients:
 
595
 
                self.log_message_raw(("bold",
 
596
 
                                      "Note: Server has no clients."))
 
 
602
                self.log_message_raw(("bold", "Note: Server has no clients."))
 
597
603
        except dbus.exceptions.DBusException:
 
598
 
            self.log_message_raw(("bold",
 
599
 
                                  "Note: No Mandos server running."))
 
 
604
            self.log_message_raw(("bold", "Note: No Mandos server running."))
 
600
605
            mandos_clients = dbus.Dictionary()
 
602
607
        (self.mandos_serv
 
603
608
         .connect_to_signal("InterfacesRemoved",
 
604
609
                            self.find_and_remove_client,
 
605
 
                            dbus_interface=dbus.OBJECT_MANAGER_IFACE,
 
 
611
                            = dbus.OBJECT_MANAGER_IFACE,
 
606
612
                            byte_arrays=True))
 
607
613
        (self.mandos_serv
 
608
614
         .connect_to_signal("InterfacesAdded",
 
609
615
                            self.add_new_client,
 
610
 
                            dbus_interface=dbus.OBJECT_MANAGER_IFACE,
 
 
617
                            = dbus.OBJECT_MANAGER_IFACE,
 
611
618
                            byte_arrays=True))
 
612
619
        (self.mandos_serv
 
613
620
         .connect_to_signal("ClientNotFound",
 
 
617
624
        for path, client in mandos_clients.items():
 
618
625
            client_proxy_object = self.bus.get_object(self.busname,
 
620
 
            self.add_client(MandosClientWidget(
 
621
 
                server_proxy_object=self.mandos_serv,
 
622
 
                proxy_object=client_proxy_object,
 
624
 
                update_hook=self.refresh,
 
625
 
                delete_hook=self.remove_client,
 
626
 
                logger=self.log_message),
 
 
627
            self.add_client(MandosClientWidget(server_proxy_object
 
 
630
                                               =client_proxy_object,
 
630
641
        self._input_callback_tag = (GLib.io_add_watch
 
631
642
                                    (sys.stdin.fileno(),
 
 
635
646
        # Main loop has finished, we should close everything now
 
636
647
        GLib.source_remove(self._input_callback_tag)
 
637
648
        self.screen.stop()
 
640
651
        self.main_loop.quit()
 
642
653
    def process_input(self, source, condition):
 
643
654
        keys = self.screen.get_input()
 
644
 
        translations = {"ctrl n": "down",       # Emacs
 
645
 
                        "ctrl p": "up",         # Emacs
 
646
 
                        "ctrl v": "page down",  # Emacs
 
647
 
                        "meta v": "page up",    # Emacs
 
648
 
                        " ": "page down",       # less
 
649
 
                        "f": "page down",       # less
 
650
 
                        "b": "page up",         # less
 
 
655
        translations = { "ctrl n": "down",      # Emacs
 
 
656
                         "ctrl p": "up",        # Emacs
 
 
657
                         "ctrl v": "page down", # Emacs
 
 
658
                         "meta v": "page up",   # Emacs
 
 
659
                         " ": "page down",      # less
 
 
660
                         "f": "page down",      # less
 
 
661
                         "b": "page up",        # less
 
656
667
                key = translations[key]
 
657
668
            except KeyError:    # :-)
 
660
671
            if key == "q" or key == "Q":
 
 
711
722
                    self.log_level = 0
 
712
723
                    self.log_message("Verbose mode: On")
 
713
 
            # elif (key == "end" or key == "meta >" or key == "G"
 
715
 
            #     pass            # xxx end-of-buffer
 
716
 
            # elif (key == "home" or key == "meta <" or key == "g"
 
718
 
            #     pass            # xxx beginning-of-buffer
 
719
 
            # elif key == "ctrl e" or key == "$":
 
720
 
            #     pass            # xxx move-end-of-line
 
721
 
            # elif key == "ctrl a" or key == "^":
 
722
 
            #     pass            # xxx move-beginning-of-line
 
723
 
            # elif key == "ctrl b" or key == "meta (" or key == "h":
 
725
 
            # elif key == "ctrl f" or key == "meta )" or key == "l":
 
728
 
            #     pass            # scroll up log
 
730
 
            #     pass            # scroll down log
 
 
724
            #elif (key == "end" or key == "meta >" or key == "G"
 
 
726
            #    pass            # xxx end-of-buffer
 
 
727
            #elif (key == "home" or key == "meta <" or key == "g"
 
 
729
            #    pass            # xxx beginning-of-buffer
 
 
730
            #elif key == "ctrl e" or key == "$":
 
 
731
            #    pass            # xxx move-end-of-line
 
 
732
            #elif key == "ctrl a" or key == "^":
 
 
733
            #    pass            # xxx move-beginning-of-line
 
 
734
            #elif key == "ctrl b" or key == "meta (" or key == "h":
 
 
736
            #elif key == "ctrl f" or key == "meta )" or key == "l":
 
 
739
            #    pass            # scroll up log
 
 
741
            #    pass            # scroll down log
 
731
742
            elif self.topwidget.selectable():
 
732
743
                self.topwidget.keypress(self.size, key)
 
737
747
ui = UserInterface()