/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2019-09-04 21:17:42 UTC
  • mto: This revision was merged to the branch mainline in revision 1179.
  • Revision ID: teddy@recompile.se-20190904211742-9luzszv5yt5h91pw
Tags: version-1.8.9-2
* debian/changelog (1.8.9-2): Add new entry.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-monitor
1
 
#!/usr/bin/python3 -bbI
 
1
#!/usr/bin/python3 -bb
2
2
# -*- mode: python; coding: utf-8 -*-
3
3
#
4
4
# Mandos Monitor - Control and monitor the Mandos server
23
23
#
24
24
# Contact the authors at <mandos@recompile.se>.
25
25
#
 
26
 
26
27
from __future__ import (division, absolute_import, print_function,
27
28
                        unicode_literals)
28
 
 
29
29
try:
30
30
    from future_builtins import *
31
31
except ImportError:
32
32
    pass
33
33
 
34
34
import sys
35
 
import logging
36
35
import os
37
36
import warnings
38
37
import datetime
39
 
import locale
40
38
 
41
39
import urwid.curses_display
42
40
import urwid
46
44
 
47
45
import dbus
48
46
 
 
47
import locale
 
48
 
 
49
import logging
 
50
 
49
51
if sys.version_info.major == 2:
50
 
    __metaclass__ = type
51
52
    str = unicode
52
 
    input = raw_input
53
 
 
54
 
# Show warnings by default
55
 
if not sys.warnoptions:
56
 
    warnings.simplefilter("default")
57
 
 
58
 
log = logging.getLogger(os.path.basename(sys.argv[0]))
59
 
logging.basicConfig(level="NOTSET", # Show all messages
60
 
                    format="%(message)s") # Show basic log messages
61
 
 
62
 
logging.captureWarnings(True)   # Show warnings via the logging system
63
 
 
64
 
locale.setlocale(locale.LC_ALL, "")
65
 
 
66
 
logging.getLogger("dbus.proxies").setLevel(logging.CRITICAL)
67
 
logging.getLogger("urwid").setLevel(logging.INFO)
 
53
 
 
54
locale.setlocale(locale.LC_ALL, '')
 
55
 
 
56
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
68
57
 
69
58
# Some useful constants
70
 
domain = "se.recompile"
71
 
server_interface = domain + ".Mandos"
72
 
client_interface = domain + ".Mandos.Client"
73
 
version = "1.8.18"
 
59
domain = 'se.recompile'
 
60
server_interface = domain + '.Mandos'
 
61
client_interface = domain + '.Mandos.Client'
 
62
version = "1.8.9"
74
63
 
75
64
try:
76
65
    dbus.OBJECT_MANAGER_IFACE
95
84
                             int(fraction*1000000))  # Microseconds
96
85
 
97
86
 
98
 
class MandosClientPropertyCache:
 
87
class MandosClientPropertyCache(object):
99
88
    """This wraps a Mandos Client D-Bus proxy object, caches the
100
89
    properties and calls a hook function when any of them are
101
90
    changed.
128
117
        self.property_changed_match.remove()
129
118
 
130
119
 
131
 
class MandosClientWidget(MandosClientPropertyCache, urwid.Widget):
 
120
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
132
121
    """A Mandos Client which is visible on the screen.
133
122
    """
134
123
 
135
 
    _sizing = frozenset(["flow"])
136
 
 
137
124
    def __init__(self, server_proxy_object=None, update_hook=None,
138
 
                 delete_hook=None, **kwargs):
 
125
                 delete_hook=None, logger=None, **kwargs):
139
126
        # Called on update
140
127
        self.update_hook = update_hook
141
128
        # Called on delete
142
129
        self.delete_hook = delete_hook
143
130
        # Mandos Server proxy object
144
131
        self.server_proxy_object = server_proxy_object
 
132
        # Logger
 
133
        self.logger = logger
145
134
 
146
135
        self._update_timer_callback_tag = None
147
136
 
174
163
                                         self.rejected,
175
164
                                         client_interface,
176
165
                                         byte_arrays=True))
177
 
        log.debug("Created client %s", self.properties["Name"])
 
166
        self.logger('Created client {}'
 
167
                    .format(self.properties["Name"]), level=0)
178
168
 
179
169
    def using_timer(self, flag):
180
170
        """Call this method with True or False when timer should be
182
172
        """
183
173
        if flag and self._update_timer_callback_tag is None:
184
174
            # Will update the shown timer value every second
185
 
            self._update_timer_callback_tag = (
186
 
                GLib.timeout_add(1000,
187
 
                                 glib_safely(self.update_timer)))
 
175
            self._update_timer_callback_tag = (GLib.timeout_add
 
176
                                               (1000,
 
177
                                                self.update_timer))
188
178
        elif not (flag or self._update_timer_callback_tag is None):
189
179
            GLib.source_remove(self._update_timer_callback_tag)
190
180
            self._update_timer_callback_tag = None
191
181
 
192
182
    def checker_completed(self, exitstatus, condition, command):
193
183
        if exitstatus == 0:
194
 
            log.debug('Checker for client %s (command "%s")'
195
 
                      " succeeded", self.properties["Name"], command)
 
184
            self.logger('Checker for client {} (command "{}")'
 
185
                        ' succeeded'.format(self.properties["Name"],
 
186
                                            command), level=0)
196
187
            self.update()
197
188
            return
198
189
        # Checker failed
199
190
        if os.WIFEXITED(condition):
200
 
            log.info('Checker for client %s (command "%s") failed'
201
 
                     " with exit code %d", self.properties["Name"],
202
 
                     command, os.WEXITSTATUS(condition))
 
191
            self.logger('Checker for client {} (command "{}") failed'
 
192
                        ' with exit code {}'
 
193
                        .format(self.properties["Name"], command,
 
194
                                os.WEXITSTATUS(condition)))
203
195
        elif os.WIFSIGNALED(condition):
204
 
            log.info('Checker for client %s (command "%s") was'
205
 
                     " killed by signal %d", self.properties["Name"],
206
 
                     command, os.WTERMSIG(condition))
 
196
            self.logger('Checker for client {} (command "{}") was'
 
197
                        ' killed by signal {}'
 
198
                        .format(self.properties["Name"], command,
 
199
                                os.WTERMSIG(condition)))
207
200
        self.update()
208
201
 
209
202
    def checker_started(self, command):
210
203
        """Server signals that a checker started."""
211
 
        log.debug('Client %s started checker "%s"',
212
 
                  self.properties["Name"], command)
 
204
        self.logger('Client {} started checker "{}"'
 
205
                    .format(self.properties["Name"],
 
206
                            command), level=0)
213
207
 
214
208
    def got_secret(self):
215
 
        log.info("Client %s received its secret",
216
 
                 self.properties["Name"])
 
209
        self.logger('Client {} received its secret'
 
210
                    .format(self.properties["Name"]))
217
211
 
218
212
    def need_approval(self, timeout, default):
219
213
        if not default:
220
 
            message = "Client %s needs approval within %f seconds"
 
214
            message = 'Client {} needs approval within {} seconds'
221
215
        else:
222
 
            message = "Client %s will get its secret in %f seconds"
223
 
        log.info(message, self.properties["Name"], timeout/1000)
 
216
            message = 'Client {} will get its secret in {} seconds'
 
217
        self.logger(message.format(self.properties["Name"],
 
218
                                   timeout/1000))
224
219
 
225
220
    def rejected(self, reason):
226
 
        log.info("Client %s was rejected; reason: %s",
227
 
                 self.properties["Name"], reason)
 
221
        self.logger('Client {} was rejected; reason: {}'
 
222
                    .format(self.properties["Name"], reason))
228
223
 
229
224
    def selectable(self):
230
225
        """Make this a "selectable" widget.
231
 
        This overrides the method from urwid.Widget."""
 
226
        This overrides the method from urwid.FlowWidget."""
232
227
        return True
233
228
 
234
229
    def rows(self, maxcolrow, focus=False):
235
230
        """How many rows this widget will occupy might depend on
236
231
        whether we have focus or not.
237
 
        This overrides the method from urwid.Widget"""
 
232
        This overrides the method from urwid.FlowWidget"""
238
233
        return self.current_widget(focus).rows(maxcolrow, focus=focus)
239
234
 
240
235
    def current_widget(self, focus=False):
256
251
        # Rebuild focus and non-focus widgets using current properties
257
252
 
258
253
        # Base part of a client. Name!
259
 
        base = "{name}: ".format(name=self.properties["Name"])
 
254
        base = '{name}: '.format(name=self.properties["Name"])
260
255
        if not self.properties["Enabled"]:
261
256
            message = "DISABLED"
262
257
            self.using_timer(False)
284
279
                timer = datetime.timedelta(0)
285
280
            else:
286
281
                expires = (datetime.datetime.strptime
287
 
                           (expires, "%Y-%m-%dT%H:%M:%S.%f"))
 
282
                           (expires, '%Y-%m-%dT%H:%M:%S.%f'))
288
283
                timer = max(expires - datetime.datetime.utcnow(),
289
284
                            datetime.timedelta())
290
 
            message = ("A checker has failed! Time until client"
291
 
                       " gets disabled: {}"
 
285
            message = ('A checker has failed! Time until client'
 
286
                       ' gets disabled: {}'
292
287
                       .format(str(timer).rsplit(".", 1)[0]))
293
288
            self.using_timer(True)
294
289
        else:
332
327
 
333
328
    def render(self, maxcolrow, focus=False):
334
329
        """Render differently if we have focus.
335
 
        This overrides the method from urwid.Widget"""
 
330
        This overrides the method from urwid.FlowWidget"""
336
331
        return self.current_widget(focus).render(maxcolrow,
337
332
                                                 focus=focus)
338
333
 
339
334
    def keypress(self, maxcolrow, key):
340
335
        """Handle keys.
341
 
        This overrides the method from urwid.Widget"""
 
336
        This overrides the method from urwid.FlowWidget"""
342
337
        if key == "+":
343
338
            self.proxy.Set(client_interface, "Enabled",
344
339
                           dbus.Boolean(True), ignore_reply=True,
392
387
            self.update()
393
388
 
394
389
 
395
 
def glib_safely(func, retval=True):
396
 
    def safe_func(*args, **kwargs):
397
 
        try:
398
 
            return func(*args, **kwargs)
399
 
        except Exception:
400
 
            log.exception("")
401
 
            return retval
402
 
    return safe_func
403
 
 
404
 
 
405
390
class ConstrainedListBox(urwid.ListBox):
406
391
    """Like a normal urwid.ListBox, but will consume all "up" or
407
392
    "down" key presses, thus not allowing any containing widgets to
415
400
        return ret
416
401
 
417
402
 
418
 
class UserInterface:
 
403
class UserInterface(object):
419
404
    """This is the entire user interface - the whole screen
420
405
    with boxes, lists of client widgets, etc.
421
406
    """
422
 
    def __init__(self, max_log_length=1000):
 
407
    def __init__(self, max_log_length=1000, log_level=1):
423
408
        DBusGMainLoop(set_as_default=True)
424
409
 
425
410
        self.screen = urwid.curses_display.Screen()
462
447
        self.log = urwid.SimpleListWalker([])
463
448
        self.max_log_length = max_log_length
464
449
 
 
450
        self.log_level = log_level
 
451
 
465
452
        # We keep a reference to the log widget so we can remove it
466
453
        # from the ListWalker without it getting destroyed
467
454
        self.logbox = ConstrainedListBox(self.log)
471
458
        self.log_visible = True
472
459
        self.log_wrap = "any"
473
460
 
474
 
        self.loghandler = UILogHandler(self)
475
 
 
476
461
        self.rebuild()
477
 
        self.add_log_line(("bold",
478
 
                           "Mandos Monitor version " + version))
479
 
        self.add_log_line(("bold", "q: Quit  ?: Help"))
 
462
        self.log_message_raw(("bold",
 
463
                              "Mandos Monitor version " + version))
 
464
        self.log_message_raw(("bold",
 
465
                              "q: Quit  ?: Help"))
480
466
 
481
 
        self.busname = domain + ".Mandos"
 
467
        self.busname = domain + '.Mandos'
482
468
        self.main_loop = GLib.MainLoop()
483
469
 
484
470
    def client_not_found(self, key_id, address):
485
 
        log.info("Client with address %s and key ID %s could"
486
 
                 " not be found", address, key_id)
 
471
        self.log_message("Client with address {} and key ID {} could"
 
472
                         " not be found".format(address, key_id))
487
473
 
488
474
    def rebuild(self):
489
475
        """This rebuilds the User Interface.
500
486
            self.uilist.append(self.logbox)
501
487
        self.topwidget = urwid.Pile(self.uilist)
502
488
 
503
 
    def add_log_line(self, markup):
 
489
    def log_message(self, message, level=1):
 
490
        """Log message formatted with timestamp"""
 
491
        if level < self.log_level:
 
492
            return
 
493
        timestamp = datetime.datetime.now().isoformat()
 
494
        self.log_message_raw("{}: {}".format(timestamp, message),
 
495
                             level=level)
 
496
 
 
497
    def log_message_raw(self, markup, level=1):
 
498
        """Add a log message to the log buffer."""
 
499
        if level < self.log_level:
 
500
            return
504
501
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
505
502
        if self.max_log_length:
506
503
            if len(self.log) > self.max_log_length:
507
 
                del self.log[0:(len(self.log) - self.max_log_length)]
 
504
                del self.log[0:len(self.log)-self.max_log_length-1]
508
505
        self.logbox.set_focus(len(self.logbox.body.contents)-1,
509
506
                              coming_from="above")
510
507
        self.refresh()
513
510
        """Toggle visibility of the log buffer."""
514
511
        self.log_visible = not self.log_visible
515
512
        self.rebuild()
516
 
        log.debug("Log visibility changed to: %s", self.log_visible)
 
513
        self.log_message("Log visibility changed to: {}"
 
514
                         .format(self.log_visible), level=0)
517
515
 
518
516
    def change_log_display(self):
519
517
        """Change type of log display.
524
522
            self.log_wrap = "clip"
525
523
        for textwidget in self.log:
526
524
            textwidget.set_wrap_mode(self.log_wrap)
527
 
        log.debug("Wrap mode: %s", self.log_wrap)
 
525
        self.log_message("Wrap mode: {}".format(self.log_wrap),
 
526
                         level=0)
528
527
 
529
528
    def find_and_remove_client(self, path, interfaces):
530
529
        """Find a client by its object path and remove it.
538
537
            client = self.clients_dict[path]
539
538
        except KeyError:
540
539
            # not found?
541
 
            log.warning("Unknown client %s removed", path)
 
540
            self.log_message("Unknown client {!r} removed"
 
541
                             .format(path))
542
542
            return
543
543
        client.delete()
544
544
 
557
557
            proxy_object=client_proxy_object,
558
558
            update_hook=self.refresh,
559
559
            delete_hook=self.remove_client,
 
560
            logger=self.log_message,
560
561
            properties=dict(ifs_and_props[client_interface])),
561
562
                        path=path)
562
563
 
582
583
 
583
584
    def run(self):
584
585
        """Start the main loop and exit when it's done."""
585
 
        log.addHandler(self.loghandler)
586
 
        self.orig_log_propagate = log.propagate
587
 
        log.propagate = False
588
 
        self.orig_log_level = log.level
589
 
        log.setLevel("INFO")
590
586
        self.bus = dbus.SystemBus()
591
587
        mandos_dbus_objc = self.bus.get_object(
592
588
            self.busname, "/", follow_name_owner_changes=True)
596
592
            mandos_clients = (self.mandos_serv
597
593
                              .GetAllClientsWithProperties())
598
594
            if not mandos_clients:
599
 
                log.warning("Note: Server has no clients.")
 
595
                self.log_message_raw(("bold",
 
596
                                      "Note: Server has no clients."))
600
597
        except dbus.exceptions.DBusException:
601
 
            log.warning("Note: No Mandos server running.")
 
598
            self.log_message_raw(("bold",
 
599
                                  "Note: No Mandos server running."))
602
600
            mandos_clients = dbus.Dictionary()
603
601
 
604
602
        (self.mandos_serv
624
622
                proxy_object=client_proxy_object,
625
623
                properties=client,
626
624
                update_hook=self.refresh,
627
 
                delete_hook=self.remove_client),
 
625
                delete_hook=self.remove_client,
 
626
                logger=self.log_message),
628
627
                            path=path)
629
628
 
630
629
        self.refresh()
632
631
            GLib.io_add_watch(
633
632
                GLib.IOChannel.unix_new(sys.stdin.fileno()),
634
633
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
635
 
                glib_safely(self.process_input)))
 
634
                self.process_input))
636
635
        self.main_loop.run()
637
636
        # Main loop has finished, we should close everything now
638
637
        GLib.source_remove(self._input_callback_tag)
642
641
 
643
642
    def stop(self):
644
643
        self.main_loop.quit()
645
 
        log.removeHandler(self.loghandler)
646
 
        log.propagate = self.orig_log_propagate
647
644
 
648
645
    def process_input(self, source, condition):
649
646
        keys = self.screen.get_input()
682
679
                if not self.log_visible:
683
680
                    self.log_visible = True
684
681
                    self.rebuild()
685
 
                self.add_log_line(("bold",
686
 
                                   "  ".join(("q: Quit",
687
 
                                              "?: Help",
688
 
                                              "l: Log window toggle",
689
 
                                              "TAB: Switch window",
690
 
                                              "w: Wrap (log lines)",
691
 
                                              "v: Toggle verbose log",
692
 
                                   ))))
693
 
                self.add_log_line(("bold",
694
 
                                   "  ".join(("Clients:",
695
 
                                              "+: Enable",
696
 
                                              "-: Disable",
697
 
                                              "R: Remove",
698
 
                                              "s: Start new checker",
699
 
                                              "S: Stop checker",
700
 
                                              "C: Checker OK",
701
 
                                              "a: Approve",
702
 
                                              "d: Deny",
703
 
                                   ))))
 
682
                self.log_message_raw(("bold",
 
683
                                      "  ".
 
684
                                      join(("q: Quit",
 
685
                                            "?: Help",
 
686
                                            "l: Log window toggle",
 
687
                                            "TAB: Switch window",
 
688
                                            "w: Wrap (log lines)",
 
689
                                            "v: Toggle verbose log",
 
690
                                            ))))
 
691
                self.log_message_raw(("bold",
 
692
                                      "  "
 
693
                                      .join(("Clients:",
 
694
                                             "+: Enable",
 
695
                                             "-: Disable",
 
696
                                             "R: Remove",
 
697
                                             "s: Start new checker",
 
698
                                             "S: Stop checker",
 
699
                                             "C: Checker OK",
 
700
                                             "a: Approve",
 
701
                                             "d: Deny"))))
704
702
                self.refresh()
705
703
            elif key == "tab":
706
704
                if self.topwidget.get_focus() is self.logbox:
709
707
                    self.topwidget.set_focus(self.logbox)
710
708
                self.refresh()
711
709
            elif key == "v":
712
 
                if log.level < logging.INFO:
713
 
                    log.setLevel(logging.INFO)
714
 
                    log.info("Verbose mode: Off")
 
710
                if self.log_level == 0:
 
711
                    self.log_level = 1
 
712
                    self.log_message("Verbose mode: Off")
715
713
                else:
716
 
                    log.setLevel(logging.NOTSET)
717
 
                    log.info("Verbose mode: On")
 
714
                    self.log_level = 0
 
715
                    self.log_message("Verbose mode: On")
718
716
            # elif (key == "end" or key == "meta >" or key == "G"
719
717
            #       or key == ">"):
720
718
            #     pass            # xxx end-of-buffer
739
737
        return True
740
738
 
741
739
 
742
 
class UILogHandler(logging.Handler):
743
 
    def __init__(self, ui, *args, **kwargs):
744
 
        self.ui = ui
745
 
        super(UILogHandler, self).__init__(*args, **kwargs)
746
 
        self.setFormatter(
747
 
            logging.Formatter("%(asctime)s: %(message)s"))
748
 
    def emit(self, record):
749
 
        msg = self.format(record)
750
 
        if record.levelno > logging.INFO:
751
 
            msg = ("bold", msg)
752
 
        self.ui.add_log_line(msg)
753
 
 
754
 
 
755
740
ui = UserInterface()
756
741
try:
757
742
    ui.run()
758
743
except KeyboardInterrupt:
759
 
    with warnings.catch_warnings():
760
 
        warnings.filterwarnings("ignore", "", BytesWarning)
761
 
        ui.screen.stop()
762
 
except Exception:
763
 
    with warnings.catch_warnings():
764
 
        warnings.filterwarnings("ignore", "", BytesWarning)
765
 
        ui.screen.stop()
 
744
    ui.screen.stop()
 
745
except Exception as e:
 
746
    ui.log_message(str(e))
 
747
    ui.screen.stop()
766
748
    raise