/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: 2024-11-22 20:30:34 UTC
  • Revision ID: teddy@recompile.se-20241122203034-92q7483wxv29tqev
mandos-monitor: avoid deprecation warnings from urwid

The urwid.FlowWidget class is deprecated.  Replace it with inheriting
from urwid.Widget, and setting the appropriate class attribute.

* mandos-monitor: Replace any mentions of urwid.FlowWidget with
  urwid.Widget.
  (MandosClientWidget): Inherit from "urwid.Widget" instead of
  "urwid.FlowWidget".  Also, move MandosClientPropertyCache to first
  in inheritance list so that its __init__ method can absorb the
  "proxy_object" and "properties" keyword arguments.
  (MandosClientWidget._sizing): New class attribute; set to
  "frozenset(["flow"])".

(Thanks to an anonymous contributor for reporting this.)

Show diffs side-by-side

added added

removed removed

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