/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/python
 
1
#!/usr/bin/python3 -bbI
2
2
# -*- mode: python; coding: utf-8 -*-
3
 
# 
 
3
#
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
 
# 
6
 
# Copyright © 2009-2015 Teddy Hogeborn
7
 
# Copyright © 2009-2015 Björn Påhlsson
8
 
# 
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
 
5
#
 
6
# Copyright © 2009-2019 Teddy Hogeborn
 
7
# Copyright © 2009-2019 Björn Påhlsson
 
8
#
 
9
# This file is part of Mandos.
 
10
#
 
11
# Mandos is free software: you can redistribute it and/or modify it
 
12
# under the terms of the GNU General Public License as published by
11
13
# the Free Software Foundation, either version 3 of the License, or
12
14
# (at your option) any later version.
13
15
#
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
#     Mandos is distributed in the hope that it will be useful, but
 
17
#     WITHOUT ANY WARRANTY; without even the implied warranty of
16
18
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17
19
#     GNU General Public License for more details.
18
 
# 
 
20
#
19
21
# 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/>.
22
 
# 
 
22
# along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
 
23
#
23
24
# Contact the authors at <mandos@recompile.se>.
24
 
# 
25
 
 
 
25
#
26
26
from __future__ import (division, absolute_import, print_function,
27
27
                        unicode_literals)
 
28
 
28
29
try:
29
30
    from future_builtins import *
30
31
except ImportError:
31
32
    pass
32
33
 
33
34
import sys
 
35
import logging
34
36
import os
35
 
 
 
37
import warnings
36
38
import datetime
 
39
import locale
37
40
 
38
41
import urwid.curses_display
39
42
import urwid
40
43
 
41
44
from dbus.mainloop.glib import DBusGMainLoop
42
 
try:
43
 
    import gobject
44
 
except ImportError:
45
 
    from gi.repository import GObject as gobject
 
45
from gi.repository import GLib
46
46
 
47
47
import dbus
48
48
 
49
 
import locale
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
 
import logging
57
 
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)
58
68
 
59
69
# Some useful constants
60
 
domain = 'se.recompile'
61
 
server_interface = domain + '.Mandos'
62
 
client_interface = domain + '.Mandos.Client'
63
 
version = "1.7.0"
 
70
domain = "se.recompile"
 
71
server_interface = domain + ".Mandos"
 
72
client_interface = domain + ".Mandos.Client"
 
73
version = "1.8.17"
64
74
 
65
75
try:
66
76
    dbus.OBJECT_MANAGER_IFACE
67
77
except AttributeError:
68
78
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
69
79
 
 
80
 
70
81
def isoformat_to_datetime(iso):
71
82
    "Parse an ISO 8601 date string to a datetime.datetime()"
72
83
    if not iso:
80
91
                             int(day),
81
92
                             int(hour),
82
93
                             int(minute),
83
 
                             int(second),           # Whole seconds
84
 
                             int(fraction*1000000)) # Microseconds
85
 
 
86
 
class MandosClientPropertyCache(object):
 
94
                             int(second),            # Whole seconds
 
95
                             int(fraction*1000000))  # Microseconds
 
96
 
 
97
 
 
98
class MandosClientPropertyCache:
87
99
    """This wraps a Mandos Client D-Bus proxy object, caches the
88
100
    properties and calls a hook function when any of them are
89
101
    changed.
90
102
    """
91
103
    def __init__(self, proxy_object=None, properties=None, **kwargs):
92
 
        self.proxy = proxy_object # Mandos Client proxy object
 
104
        self.proxy = proxy_object  # Mandos Client proxy object
93
105
        self.properties = dict() if properties is None else properties
94
106
        self.property_changed_match = (
95
107
            self.proxy.connect_to_signal("PropertiesChanged",
96
108
                                         self.properties_changed,
97
109
                                         dbus.PROPERTIES_IFACE,
98
110
                                         byte_arrays=True))
99
 
        
 
111
 
100
112
        if properties is None:
101
 
            self.properties.update(
102
 
                self.proxy.GetAll(client_interface,
103
 
                                  dbus_interface
104
 
                                  = dbus.PROPERTIES_IFACE))
105
 
        
 
113
            self.properties.update(self.proxy.GetAll(
 
114
                client_interface,
 
115
                dbus_interface=dbus.PROPERTIES_IFACE))
 
116
 
106
117
        super(MandosClientPropertyCache, self).__init__(**kwargs)
107
 
    
 
118
 
108
119
    def properties_changed(self, interface, properties, invalidated):
109
120
        """This is called whenever we get a PropertiesChanged signal
110
121
        It updates the changed properties in the "properties" dict.
112
123
        # Update properties dict with new value
113
124
        if interface == client_interface:
114
125
            self.properties.update(properties)
115
 
    
 
126
 
116
127
    def delete(self):
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
 
137
148
        # The widget shown normally
138
149
        self._text_widget = urwid.Text("")
139
150
        # The widget shown when we have focus
141
152
        super(MandosClientWidget, self).__init__(**kwargs)
142
153
        self.update()
143
154
        self.opened = False
144
 
        
 
155
 
145
156
        self.match_objects = (
146
157
            self.proxy.connect_to_signal("CheckerCompleted",
147
158
                                         self.checker_completed,
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)
168
 
    
 
177
        log.debug("Created client %s", self.properties["Name"])
 
178
 
169
179
    def using_timer(self, flag):
170
180
        """Call this method with True or False when timer should be
171
181
        activated or deactivated.
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 = (gobject.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
 
            gobject.source_remove(self._update_timer_callback_tag)
 
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)
207
 
    
 
211
        log.debug('Client %s started checker "%s"',
 
212
                  self.properties["Name"], command)
 
213
 
208
214
    def got_secret(self):
209
 
        self.logger('Client {} received its secret'
210
 
                    .format(self.properties["Name"]))
211
 
    
 
215
        log.info("Client %s received its secret",
 
216
                 self.properties["Name"])
 
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))
219
 
    
 
222
            message = "Client %s will get its secret in %f seconds"
 
223
        log.info(message, self.properties["Name"], timeout/1000)
 
224
 
220
225
    def rejected(self, reason):
221
 
        self.logger('Client {} was rejected; reason: {}'
222
 
                    .format(self.properties["Name"], reason))
223
 
    
 
226
        log.info("Client %s was rejected; reason: %s",
 
227
                 self.properties["Name"], reason)
 
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):
236
241
        if focus or self.opened:
237
242
            return self._focus_widget
238
243
        return self._widget
239
 
    
 
244
 
240
245
    def update(self):
241
246
        "Called when what is visible on the screen should be updated."
242
247
        # How to add standout mode to a style
243
 
        with_standout = { "normal": "standout",
244
 
                          "bold": "bold-standout",
245
 
                          "underline-blink":
246
 
                              "underline-blink-standout",
247
 
                          "bold-underline-blink":
248
 
                              "bold-underline-blink-standout",
249
 
                          }
250
 
        
 
248
        with_standout = {"normal": "standout",
 
249
                         "bold": "bold-standout",
 
250
                         "underline-blink":
 
251
                         "underline-blink-standout",
 
252
                         "bold-underline-blink":
 
253
                         "bold-underline-blink-standout",
 
254
                         }
 
255
 
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)
258
263
        elif self.properties["ApprovalPending"]:
259
 
            timeout = datetime.timedelta(milliseconds
260
 
                                         = self.properties
261
 
                                         ["ApprovalDelay"])
 
264
            timeout = datetime.timedelta(
 
265
                milliseconds=self.properties["ApprovalDelay"])
262
266
            last_approval_request = isoformat_to_datetime(
263
267
                self.properties["LastApprovalRequest"])
264
268
            if last_approval_request is not None:
280
284
                timer = datetime.timedelta(0)
281
285
            else:
282
286
                expires = (datetime.datetime.strptime
283
 
                           (expires, '%Y-%m-%dT%H:%M:%S.%f'))
 
287
                           (expires, "%Y-%m-%dT%H:%M:%S.%f"))
284
288
                timer = max(expires - datetime.datetime.utcnow(),
285
289
                            datetime.timedelta())
286
 
            message = ('A checker has failed! Time until client'
287
 
                       ' gets disabled: {}'
 
290
            message = ("A checker has failed! Time until client"
 
291
                       " gets disabled: {}"
288
292
                       .format(str(timer).rsplit(".", 1)[0]))
289
293
            self.using_timer(True)
290
294
        else:
291
295
            message = "enabled"
292
296
            self.using_timer(False)
293
297
        self._text = "{}{}".format(base, message)
294
 
        
 
298
 
295
299
        if not urwid.supports_unicode():
296
300
            self._text = self._text.encode("ascii", "replace")
297
301
        textlist = [("normal", self._text)]
307
311
        # Run update hook, if any
308
312
        if self.update_hook is not None:
309
313
            self.update_hook()
310
 
    
 
314
 
311
315
    def update_timer(self):
312
 
        """called by gobject. Will indefinitely loop until
313
 
        gobject.source_remove() on tag is called"""
 
316
        """called by GLib. Will indefinitely loop until
 
317
        GLib.source_remove() on tag is called
 
318
        """
314
319
        self.update()
315
320
        return True             # Keep calling this
316
 
    
 
321
 
317
322
    def delete(self, **kwargs):
318
323
        if self._update_timer_callback_tag is not None:
319
 
            gobject.source_remove(self._update_timer_callback_tag)
 
324
            GLib.source_remove(self._update_timer_callback_tag)
320
325
            self._update_timer_callback_tag = None
321
326
        for match in self.match_objects:
322
327
            match.remove()
324
329
        if self.delete_hook is not None:
325
330
            self.delete_hook(self)
326
331
        return super(MandosClientWidget, self).delete(**kwargs)
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
 
                           dbus.Boolean(True), ignore_reply = True,
340
 
                           dbus_interface = dbus.PROPERTIES_IFACE)
 
344
                           dbus.Boolean(True), ignore_reply=True,
 
345
                           dbus_interface=dbus.PROPERTIES_IFACE)
341
346
        elif key == "-":
342
347
            self.proxy.Set(client_interface, "Enabled", False,
343
 
                           ignore_reply = True,
344
 
                           dbus_interface = dbus.PROPERTIES_IFACE)
 
348
                           ignore_reply=True,
 
349
                           dbus_interface=dbus.PROPERTIES_IFACE)
345
350
        elif key == "a":
346
351
            self.proxy.Approve(dbus.Boolean(True, variant_level=1),
347
 
                               dbus_interface = client_interface,
 
352
                               dbus_interface=client_interface,
348
353
                               ignore_reply=True)
349
354
        elif key == "d":
350
355
            self.proxy.Approve(dbus.Boolean(False, variant_level=1),
351
 
                                  dbus_interface = client_interface,
 
356
                               dbus_interface=client_interface,
352
357
                               ignore_reply=True)
353
358
        elif key == "R" or key == "_" or key == "ctrl k":
354
359
            self.server_proxy_object.RemoveClient(self.proxy
356
361
                                                  ignore_reply=True)
357
362
        elif key == "s":
358
363
            self.proxy.Set(client_interface, "CheckerRunning",
359
 
                           dbus.Boolean(True), ignore_reply = True,
360
 
                           dbus_interface = dbus.PROPERTIES_IFACE)
 
364
                           dbus.Boolean(True), ignore_reply=True,
 
365
                           dbus_interface=dbus.PROPERTIES_IFACE)
361
366
        elif key == "S":
362
367
            self.proxy.Set(client_interface, "CheckerRunning",
363
 
                           dbus.Boolean(False), ignore_reply = True,
364
 
                           dbus_interface = dbus.PROPERTIES_IFACE)
 
368
                           dbus.Boolean(False), ignore_reply=True,
 
369
                           dbus_interface=dbus.PROPERTIES_IFACE)
365
370
        elif key == "C":
366
 
            self.proxy.CheckedOK(dbus_interface = client_interface,
 
371
            self.proxy.CheckedOK(dbus_interface=client_interface,
367
372
                                 ignore_reply=True)
368
373
        # xxx
369
374
#         elif key == "p" or key == "=":
374
379
#             self.open()
375
380
        else:
376
381
            return key
377
 
    
 
382
 
378
383
    def properties_changed(self, interface, properties, invalidated):
379
384
        """Call self.update() if any properties changed.
380
385
        This overrides the method from MandosClientPropertyCache"""
381
 
        old_values = { key: self.properties.get(key)
382
 
                       for key in properties.keys() }
 
386
        old_values = {key: self.properties.get(key)
 
387
                      for key in properties.keys()}
383
388
        super(MandosClientWidget, self).properties_changed(
384
389
            interface, properties, invalidated)
385
390
        if any(old_values[key] != self.properties.get(key)
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
393
408
    use them as an excuse to shift focus away from this widget.
394
409
    """
395
410
    def keypress(self, *args, **kwargs):
396
 
        ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
 
411
        ret = (super(ConstrainedListBox, self)
 
412
               .keypress(*args, **kwargs))
397
413
        if ret in ("up", "down"):
398
414
            return
399
415
        return ret
400
416
 
401
417
 
402
 
class UserInterface(object):
 
418
class UserInterface:
403
419
    """This is the entire user interface - the whole screen
404
420
    with boxes, lists of client widgets, etc.
405
421
    """
406
 
    def __init__(self, max_log_length=1000, log_level=1):
 
422
    def __init__(self, max_log_length=1000):
407
423
        DBusGMainLoop(set_as_default=True)
408
 
        
 
424
 
409
425
        self.screen = urwid.curses_display.Screen()
410
 
        
 
426
 
411
427
        self.screen.register_palette((
412
428
                ("normal",
413
429
                 "default", "default", None),
418
434
                ("standout",
419
435
                 "standout", "default", "standout"),
420
436
                ("bold-underline-blink",
421
 
                 "bold,underline,blink", "default", "bold,underline,blink"),
 
437
                 "bold,underline,blink", "default",
 
438
                 "bold,underline,blink"),
422
439
                ("bold-standout",
423
440
                 "bold,standout", "default", "bold,standout"),
424
441
                ("underline-blink-standout",
428
445
                 "bold,underline,blink,standout", "default",
429
446
                 "bold,underline,blink,standout"),
430
447
                ))
431
 
        
 
448
 
432
449
        if urwid.supports_unicode():
433
 
            self.divider = "─" # \u2500
434
 
            #self.divider = "━" # \u2501
 
450
            self.divider = "─"  # \u2500
435
451
        else:
436
 
            #self.divider = "-" # \u002d
437
 
            self.divider = "_" # \u005f
438
 
        
 
452
            self.divider = "_"  # \u005f
 
453
 
439
454
        self.screen.start()
440
 
        
 
455
 
441
456
        self.size = self.screen.get_cols_rows()
442
 
        
 
457
 
443
458
        self.clients = urwid.SimpleListWalker([])
444
459
        self.clients_dict = {}
445
 
        
 
460
 
446
461
        # We will add Text widgets to this list
447
 
        self.log = []
 
462
        self.log = urwid.SimpleListWalker([])
448
463
        self.max_log_length = max_log_length
449
 
        
450
 
        self.log_level = log_level
451
 
        
 
464
 
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)
455
 
        
 
468
 
456
469
        # This keeps track of whether self.uilist currently has
457
470
        # self.logbox in it or not
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"))
466
 
        
467
 
        self.busname = domain + '.Mandos'
468
 
        self.main_loop = gobject.MainLoop()
469
 
    
470
 
    def client_not_found(self, fingerprint, address):
471
 
        self.log_message("Client with address {} and fingerprint {}"
472
 
                         " could not be found"
473
 
                         .format(address, fingerprint))
474
 
    
 
477
        self.add_log_line(("bold",
 
478
                           "Mandos Monitor version " + version))
 
479
        self.add_log_line(("bold", "q: Quit  ?: Help"))
 
480
 
 
481
        self.busname = domain + ".Mandos"
 
482
        self.main_loop = GLib.MainLoop()
 
483
 
 
484
    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)
 
487
 
475
488
    def rebuild(self):
476
489
        """This rebuilds the User Interface.
477
490
        Call this when the widget layout needs to change"""
478
491
        self.uilist = []
479
 
        #self.uilist.append(urwid.ListBox(self.clients))
 
492
        # self.uilist.append(urwid.ListBox(self.clients))
480
493
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.
481
494
                                                          clients),
482
 
                                       #header=urwid.Divider(),
 
495
                                       # header=urwid.Divider(),
483
496
                                       header=None,
484
 
                                       footer=
485
 
                                       urwid.Divider(div_char=
486
 
                                                     self.divider)))
 
497
                                       footer=urwid.Divider(
 
498
                                           div_char=self.divider)))
487
499
        if self.log_visible:
488
500
            self.uilist.append(self.logbox)
489
501
        self.topwidget = urwid.Pile(self.uilist)
490
 
    
491
 
    def log_message(self, message, level=1):
492
 
        """Log message formatted with timestamp"""
493
 
        if level < self.log_level:
494
 
            return
495
 
        timestamp = datetime.datetime.now().isoformat()
496
 
        self.log_message_raw("{}: {}".format(timestamp, message),
497
 
                             level=level)
498
 
    
499
 
    def log_message_raw(self, markup, level=1):
500
 
        """Add a log message to the log buffer."""
501
 
        if level < self.log_level:
502
 
            return
 
502
 
 
503
    def add_log_line(self, markup):
503
504
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
504
 
        if (self.max_log_length
505
 
            and len(self.log) > self.max_log_length):
506
 
            del self.log[0:len(self.log)-self.max_log_length-1]
507
 
        self.logbox.set_focus(len(self.logbox.body.contents),
 
505
        if self.max_log_length:
 
506
            if len(self.log) > self.max_log_length:
 
507
                del self.log[0:(len(self.log) - self.max_log_length)]
 
508
        self.logbox.set_focus(len(self.logbox.body.contents)-1,
508
509
                              coming_from="above")
509
510
        self.refresh()
510
 
    
 
511
 
511
512
    def toggle_log_display(self):
512
513
        """Toggle visibility of the log buffer."""
513
514
        self.log_visible = not self.log_visible
514
515
        self.rebuild()
515
 
        self.log_message("Log visibility changed to: {}"
516
 
                         .format(self.log_visible), level=0)
517
 
    
 
516
        log.debug("Log visibility changed to: %s", self.log_visible)
 
517
 
518
518
    def change_log_display(self):
519
519
        """Change type of log display.
520
520
        Currently, this toggles wrapping of text lines."""
524
524
            self.log_wrap = "clip"
525
525
        for textwidget in self.log:
526
526
            textwidget.set_wrap_mode(self.log_wrap)
527
 
        self.log_message("Wrap mode: {}".format(self.log_wrap),
528
 
                         level=0)
529
 
    
 
527
        log.debug("Wrap mode: %s", self.log_wrap)
 
528
 
530
529
    def find_and_remove_client(self, path, interfaces):
531
530
        """Find a client by its object path and remove it.
532
 
        
 
531
 
533
532
        This is connected to the InterfacesRemoved signal from the
534
533
        Mandos server object."""
535
534
        if client_interface not in interfaces:
539
538
            client = self.clients_dict[path]
540
539
        except KeyError:
541
540
            # not found?
542
 
            self.log_message("Unknown client {!r} removed"
543
 
                             .format(path))
 
541
            log.warning("Unknown client %s removed", path)
544
542
            return
545
543
        client.delete()
546
 
    
 
544
 
547
545
    def add_new_client(self, path, ifs_and_props):
548
546
        """Find a client by its object path and remove it.
549
 
        
 
547
 
550
548
        This is connected to the InterfacesAdded signal from the
551
549
        Mandos server object.
552
550
        """
554
552
            # Not a Mandos client object; ignore
555
553
            return
556
554
        client_proxy_object = self.bus.get_object(self.busname, path)
557
 
        self.add_client(MandosClientWidget(server_proxy_object
558
 
                                           =self.mandos_serv,
559
 
                                           proxy_object
560
 
                                           =client_proxy_object,
561
 
                                           update_hook
562
 
                                           =self.refresh,
563
 
                                           delete_hook
564
 
                                           =self.remove_client,
565
 
                                           logger
566
 
                                           =self.log_message,
567
 
                                           properties
568
 
                                           = dict(ifs_and_props[
569
 
                                               client_interface])),
 
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
            properties=dict(ifs_and_props[client_interface])),
570
561
                        path=path)
571
 
    
 
562
 
572
563
    def add_client(self, client, path=None):
573
564
        self.clients.append(client)
574
565
        if path is None:
576
567
        self.clients_dict[path] = client
577
568
        self.clients.sort(key=lambda c: c.properties["Name"])
578
569
        self.refresh()
579
 
    
 
570
 
580
571
    def remove_client(self, client, path=None):
581
572
        self.clients.remove(client)
582
573
        if path is None:
583
574
            path = client.proxy.object_path
584
575
        del self.clients_dict[path]
585
576
        self.refresh()
586
 
    
 
577
 
587
578
    def refresh(self):
588
579
        """Redraw the screen"""
589
580
        canvas = self.topwidget.render(self.size, focus=True)
590
581
        self.screen.draw_screen(self.size, canvas)
591
 
    
 
582
 
592
583
    def run(self):
593
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")
594
590
        self.bus = dbus.SystemBus()
595
591
        mandos_dbus_objc = self.bus.get_object(
596
592
            self.busname, "/", follow_name_owner_changes=True)
597
 
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
598
 
                                          dbus_interface
599
 
                                          = server_interface)
 
593
        self.mandos_serv = dbus.Interface(
 
594
            mandos_dbus_objc, dbus_interface=server_interface)
600
595
        try:
601
596
            mandos_clients = (self.mandos_serv
602
597
                              .GetAllClientsWithProperties())
603
598
            if not mandos_clients:
604
 
                self.log_message_raw(("bold", "Note: Server has no clients."))
 
599
                log.warning("Note: Server has no clients.")
605
600
        except dbus.exceptions.DBusException:
606
 
            self.log_message_raw(("bold", "Note: No Mandos server running."))
 
601
            log.warning("Note: No Mandos server running.")
607
602
            mandos_clients = dbus.Dictionary()
608
 
        
 
603
 
609
604
        (self.mandos_serv
610
605
         .connect_to_signal("InterfacesRemoved",
611
606
                            self.find_and_remove_client,
612
 
                            dbus_interface
613
 
                            = dbus.OBJECT_MANAGER_IFACE,
 
607
                            dbus_interface=dbus.OBJECT_MANAGER_IFACE,
614
608
                            byte_arrays=True))
615
609
        (self.mandos_serv
616
610
         .connect_to_signal("InterfacesAdded",
617
611
                            self.add_new_client,
618
 
                            dbus_interface
619
 
                            = dbus.OBJECT_MANAGER_IFACE,
 
612
                            dbus_interface=dbus.OBJECT_MANAGER_IFACE,
620
613
                            byte_arrays=True))
621
614
        (self.mandos_serv
622
615
         .connect_to_signal("ClientNotFound",
626
619
        for path, client in mandos_clients.items():
627
620
            client_proxy_object = self.bus.get_object(self.busname,
628
621
                                                      path)
629
 
            self.add_client(MandosClientWidget(server_proxy_object
630
 
                                               =self.mandos_serv,
631
 
                                               proxy_object
632
 
                                               =client_proxy_object,
633
 
                                               properties=client,
634
 
                                               update_hook
635
 
                                               =self.refresh,
636
 
                                               delete_hook
637
 
                                               =self.remove_client,
638
 
                                               logger
639
 
                                               =self.log_message),
 
622
            self.add_client(MandosClientWidget(
 
623
                server_proxy_object=self.mandos_serv,
 
624
                proxy_object=client_proxy_object,
 
625
                properties=client,
 
626
                update_hook=self.refresh,
 
627
                delete_hook=self.remove_client),
640
628
                            path=path)
641
 
        
 
629
 
642
630
        self.refresh()
643
 
        self._input_callback_tag = (gobject.io_add_watch
644
 
                                    (sys.stdin.fileno(),
645
 
                                     gobject.IO_IN,
646
 
                                     self.process_input))
 
631
        self._input_callback_tag = (
 
632
            GLib.io_add_watch(
 
633
                GLib.IOChannel.unix_new(sys.stdin.fileno()),
 
634
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
 
635
                glib_safely(self.process_input)))
647
636
        self.main_loop.run()
648
637
        # Main loop has finished, we should close everything now
649
 
        gobject.source_remove(self._input_callback_tag)
650
 
        self.screen.stop()
651
 
    
 
638
        GLib.source_remove(self._input_callback_tag)
 
639
        with warnings.catch_warnings():
 
640
            warnings.simplefilter("ignore", BytesWarning)
 
641
            self.screen.stop()
 
642
 
652
643
    def stop(self):
653
644
        self.main_loop.quit()
654
 
    
 
645
        log.removeHandler(self.loghandler)
 
646
        log.propagate = self.orig_log_propagate
 
647
 
655
648
    def process_input(self, source, condition):
656
649
        keys = self.screen.get_input()
657
 
        translations = { "ctrl n": "down",      # Emacs
658
 
                         "ctrl p": "up",        # Emacs
659
 
                         "ctrl v": "page down", # Emacs
660
 
                         "meta v": "page up",   # Emacs
661
 
                         " ": "page down",      # less
662
 
                         "f": "page down",      # less
663
 
                         "b": "page up",        # less
664
 
                         "j": "down",           # vi
665
 
                         "k": "up",             # vi
666
 
                         }
 
650
        translations = {"ctrl n": "down",       # Emacs
 
651
                        "ctrl p": "up",         # Emacs
 
652
                        "ctrl v": "page down",  # Emacs
 
653
                        "meta v": "page up",    # Emacs
 
654
                        " ": "page down",       # less
 
655
                        "f": "page down",       # less
 
656
                        "b": "page up",         # less
 
657
                        "j": "down",            # vi
 
658
                        "k": "up",              # vi
 
659
                        }
667
660
        for key in keys:
668
661
            try:
669
662
                key = translations[key]
670
663
            except KeyError:    # :-)
671
664
                pass
672
 
            
 
665
 
673
666
            if key == "q" or key == "Q":
674
667
                self.stop()
675
668
                break
689
682
                if not self.log_visible:
690
683
                    self.log_visible = True
691
684
                    self.rebuild()
692
 
                self.log_message_raw(("bold",
693
 
                                      "  ".
694
 
                                      join(("q: Quit",
695
 
                                            "?: Help",
696
 
                                            "l: Log window toggle",
697
 
                                            "TAB: Switch window",
698
 
                                            "w: Wrap (log lines)",
699
 
                                            "v: Toggle verbose log",
700
 
                                            ))))
701
 
                self.log_message_raw(("bold",
702
 
                                      "  "
703
 
                                      .join(("Clients:",
704
 
                                             "+: Enable",
705
 
                                             "-: Disable",
706
 
                                             "R: Remove",
707
 
                                             "s: Start new checker",
708
 
                                             "S: Stop checker",
709
 
                                             "C: Checker OK",
710
 
                                             "a: Approve",
711
 
                                             "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
                                   ))))
712
704
                self.refresh()
713
705
            elif key == "tab":
714
706
                if self.topwidget.get_focus() is self.logbox:
717
709
                    self.topwidget.set_focus(self.logbox)
718
710
                self.refresh()
719
711
            elif key == "v":
720
 
                if self.log_level == 0:
721
 
                    self.log_level = 1
722
 
                    self.log_message("Verbose mode: Off")
 
712
                if log.level < logging.INFO:
 
713
                    log.setLevel(logging.INFO)
 
714
                    log.info("Verbose mode: Off")
723
715
                else:
724
 
                    self.log_level = 0
725
 
                    self.log_message("Verbose mode: On")
726
 
            #elif (key == "end" or key == "meta >" or key == "G"
727
 
            #      or key == ">"):
728
 
            #    pass            # xxx end-of-buffer
729
 
            #elif (key == "home" or key == "meta <" or key == "g"
730
 
            #      or key == "<"):
731
 
            #    pass            # xxx beginning-of-buffer
732
 
            #elif key == "ctrl e" or key == "$":
733
 
            #    pass            # xxx move-end-of-line
734
 
            #elif key == "ctrl a" or key == "^":
735
 
            #    pass            # xxx move-beginning-of-line
736
 
            #elif key == "ctrl b" or key == "meta (" or key == "h":
737
 
            #    pass            # xxx left
738
 
            #elif key == "ctrl f" or key == "meta )" or key == "l":
739
 
            #    pass            # xxx right
740
 
            #elif key == "a":
741
 
            #    pass            # scroll up log
742
 
            #elif key == "z":
743
 
            #    pass            # scroll down log
 
716
                    log.setLevel(logging.NOTSET)
 
717
                    log.info("Verbose mode: On")
 
718
            # elif (key == "end" or key == "meta >" or key == "G"
 
719
            #       or key == ">"):
 
720
            #     pass            # xxx end-of-buffer
 
721
            # elif (key == "home" or key == "meta <" or key == "g"
 
722
            #       or key == "<"):
 
723
            #     pass            # xxx beginning-of-buffer
 
724
            # elif key == "ctrl e" or key == "$":
 
725
            #     pass            # xxx move-end-of-line
 
726
            # elif key == "ctrl a" or key == "^":
 
727
            #     pass            # xxx move-beginning-of-line
 
728
            # elif key == "ctrl b" or key == "meta (" or key == "h":
 
729
            #     pass            # xxx left
 
730
            # elif key == "ctrl f" or key == "meta )" or key == "l":
 
731
            #     pass            # xxx right
 
732
            # elif key == "a":
 
733
            #     pass            # scroll up log
 
734
            # elif key == "z":
 
735
            #     pass            # scroll down log
744
736
            elif self.topwidget.selectable():
745
737
                self.topwidget.keypress(self.size, key)
746
738
                self.refresh()
747
739
        return True
748
740
 
 
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
 
749
755
ui = UserInterface()
750
756
try:
751
757
    ui.run()
752
758
except KeyboardInterrupt:
753
 
    ui.screen.stop()
754
 
except Exception as e:
755
 
    ui.log_message(str(e))
756
 
    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()
757
766
    raise