/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:28:54 UTC
  • Revision ID: teddy@recompile.se-20241122202854-dycuf117byxhxl32
mandos-monitor: Avoid debug messages from urwid

Avoid debug messages from urwid.  Any logging output before the screen
has been set up will mangle the screen.

* mandos-monitor: When setting up logging, set urwid to only show log
  messages of level INFO or above.

(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-2014 Teddy Hogeborn
7
 
# Copyright © 2009-2014 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
 
if sys.version_info[0] == 2:
 
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.6.4"
 
70
domain = "se.recompile"
 
71
server_interface = domain + ".Mandos"
 
72
client_interface = domain + ".Mandos.Client"
 
73
version = "1.8.17"
 
74
 
 
75
try:
 
76
    dbus.OBJECT_MANAGER_IFACE
 
77
except AttributeError:
 
78
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
79
 
64
80
 
65
81
def isoformat_to_datetime(iso):
66
82
    "Parse an ISO 8601 date string to a datetime.datetime()"
75
91
                             int(day),
76
92
                             int(hour),
77
93
                             int(minute),
78
 
                             int(second),           # Whole seconds
79
 
                             int(fraction*1000000)) # Microseconds
80
 
 
81
 
class MandosClientPropertyCache(object):
 
94
                             int(second),            # Whole seconds
 
95
                             int(fraction*1000000))  # Microseconds
 
96
 
 
97
 
 
98
class MandosClientPropertyCache:
82
99
    """This wraps a Mandos Client D-Bus proxy object, caches the
83
100
    properties and calls a hook function when any of them are
84
101
    changed.
85
102
    """
86
103
    def __init__(self, proxy_object=None, properties=None, **kwargs):
87
 
        self.proxy = proxy_object # Mandos Client proxy object
 
104
        self.proxy = proxy_object  # Mandos Client proxy object
88
105
        self.properties = dict() if properties is None else properties
89
106
        self.property_changed_match = (
90
 
            self.proxy.connect_to_signal("PropertyChanged",
91
 
                                         self._property_changed,
92
 
                                         client_interface,
 
107
            self.proxy.connect_to_signal("PropertiesChanged",
 
108
                                         self.properties_changed,
 
109
                                         dbus.PROPERTIES_IFACE,
93
110
                                         byte_arrays=True))
94
 
        
 
111
 
95
112
        if properties is None:
96
 
            self.properties.update(
97
 
                self.proxy.GetAll(client_interface,
98
 
                                  dbus_interface
99
 
                                  = dbus.PROPERTIES_IFACE))
100
 
        
 
113
            self.properties.update(self.proxy.GetAll(
 
114
                client_interface,
 
115
                dbus_interface=dbus.PROPERTIES_IFACE))
 
116
 
101
117
        super(MandosClientPropertyCache, self).__init__(**kwargs)
102
 
    
103
 
    def _property_changed(self, property, value):
104
 
        """Helper which takes positional arguments"""
105
 
        return self.property_changed(property=property, value=value)
106
 
    
107
 
    def property_changed(self, property=None, value=None):
108
 
        """This is called whenever we get a PropertyChanged signal
109
 
        It updates the changed property in the "properties" dict.
 
118
 
 
119
    def properties_changed(self, interface, properties, invalidated):
 
120
        """This is called whenever we get a PropertiesChanged signal
 
121
        It updates the changed properties in the "properties" dict.
110
122
        """
111
123
        # Update properties dict with new value
112
 
        self.properties[property] = value
113
 
    
 
124
        if interface == client_interface:
 
125
            self.properties.update(properties)
 
126
 
114
127
    def delete(self):
115
128
        self.property_changed_match.remove()
116
129
 
118
131
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
119
132
    """A Mandos Client which is visible on the screen.
120
133
    """
121
 
    
 
134
 
122
135
    def __init__(self, server_proxy_object=None, update_hook=None,
123
 
                 delete_hook=None, logger=None, **kwargs):
 
136
                 delete_hook=None, **kwargs):
124
137
        # Called on update
125
138
        self.update_hook = update_hook
126
139
        # Called on delete
127
140
        self.delete_hook = delete_hook
128
141
        # Mandos Server proxy object
129
142
        self.server_proxy_object = server_proxy_object
130
 
        # Logger
131
 
        self.logger = logger
132
 
        
 
143
 
133
144
        self._update_timer_callback_tag = None
134
 
        
 
145
 
135
146
        # The widget shown normally
136
147
        self._text_widget = urwid.Text("")
137
148
        # The widget shown when we have focus
139
150
        super(MandosClientWidget, self).__init__(**kwargs)
140
151
        self.update()
141
152
        self.opened = False
142
 
        
 
153
 
143
154
        self.match_objects = (
144
155
            self.proxy.connect_to_signal("CheckerCompleted",
145
156
                                         self.checker_completed,
161
172
                                         self.rejected,
162
173
                                         client_interface,
163
174
                                         byte_arrays=True))
164
 
        #self.logger('Created client {0}'
165
 
        #            .format(self.properties["Name"]))
166
 
    
 
175
        log.debug("Created client %s", self.properties["Name"])
 
176
 
167
177
    def using_timer(self, flag):
168
178
        """Call this method with True or False when timer should be
169
179
        activated or deactivated.
170
180
        """
171
181
        if flag and self._update_timer_callback_tag is None:
172
182
            # Will update the shown timer value every second
173
 
            self._update_timer_callback_tag = (gobject.timeout_add
174
 
                                               (1000,
175
 
                                                self.update_timer))
 
183
            self._update_timer_callback_tag = (
 
184
                GLib.timeout_add(1000,
 
185
                                 glib_safely(self.update_timer)))
176
186
        elif not (flag or self._update_timer_callback_tag is None):
177
 
            gobject.source_remove(self._update_timer_callback_tag)
 
187
            GLib.source_remove(self._update_timer_callback_tag)
178
188
            self._update_timer_callback_tag = None
179
 
    
 
189
 
180
190
    def checker_completed(self, exitstatus, condition, command):
181
191
        if exitstatus == 0:
 
192
            log.debug('Checker for client %s (command "%s")'
 
193
                      " succeeded", self.properties["Name"], command)
182
194
            self.update()
183
195
            return
184
196
        # Checker failed
185
197
        if os.WIFEXITED(condition):
186
 
            self.logger('Checker for client {0} (command "{1}")'
187
 
                        ' failed with exit code {2}'
188
 
                        .format(self.properties["Name"], command,
189
 
                                os.WEXITSTATUS(condition)))
 
198
            log.info('Checker for client %s (command "%s") failed'
 
199
                     " with exit code %d", self.properties["Name"],
 
200
                     command, os.WEXITSTATUS(condition))
190
201
        elif os.WIFSIGNALED(condition):
191
 
            self.logger('Checker for client {0} (command "{1}") was'
192
 
                        ' killed by signal {2}'
193
 
                        .format(self.properties["Name"], command,
194
 
                                os.WTERMSIG(condition)))
195
 
        elif os.WCOREDUMP(condition):
196
 
            self.logger('Checker for client {0} (command "{1}")'
197
 
                        ' dumped core'
198
 
                        .format(self.properties["Name"], command))
199
 
        else:
200
 
            self.logger('Checker for client {0} completed'
201
 
                        ' mysteriously'
202
 
                        .format(self.properties["Name"]))
 
202
            log.info('Checker for client %s (command "%s") was'
 
203
                     " killed by signal %d", self.properties["Name"],
 
204
                     command, os.WTERMSIG(condition))
203
205
        self.update()
204
 
    
 
206
 
205
207
    def checker_started(self, command):
206
 
        """Server signals that a checker started. This could be useful
207
 
           to log in the future. """
208
 
        #self.logger('Client {0} started checker "{1}"'
209
 
        #            .format(self.properties["Name"],
210
 
        #                    str(command)))
211
 
        pass
212
 
    
 
208
        """Server signals that a checker started."""
 
209
        log.debug('Client %s started checker "%s"',
 
210
                  self.properties["Name"], command)
 
211
 
213
212
    def got_secret(self):
214
 
        self.logger('Client {0} received its secret'
215
 
                    .format(self.properties["Name"]))
216
 
    
 
213
        log.info("Client %s received its secret",
 
214
                 self.properties["Name"])
 
215
 
217
216
    def need_approval(self, timeout, default):
218
217
        if not default:
219
 
            message = 'Client {0} needs approval within {1} seconds'
 
218
            message = "Client %s needs approval within %f seconds"
220
219
        else:
221
 
            message = 'Client {0} will get its secret in {1} seconds'
222
 
        self.logger(message.format(self.properties["Name"],
223
 
                                   timeout/1000))
224
 
    
 
220
            message = "Client %s will get its secret in %f seconds"
 
221
        log.info(message, self.properties["Name"], timeout/1000)
 
222
 
225
223
    def rejected(self, reason):
226
 
        self.logger('Client {0} was rejected; reason: {1}'
227
 
                    .format(self.properties["Name"], reason))
228
 
    
 
224
        log.info("Client %s was rejected; reason: %s",
 
225
                 self.properties["Name"], reason)
 
226
 
229
227
    def selectable(self):
230
228
        """Make this a "selectable" widget.
231
229
        This overrides the method from urwid.FlowWidget."""
232
230
        return True
233
 
    
 
231
 
234
232
    def rows(self, maxcolrow, focus=False):
235
233
        """How many rows this widget will occupy might depend on
236
234
        whether we have focus or not.
237
235
        This overrides the method from urwid.FlowWidget"""
238
236
        return self.current_widget(focus).rows(maxcolrow, focus=focus)
239
 
    
 
237
 
240
238
    def current_widget(self, focus=False):
241
239
        if focus or self.opened:
242
240
            return self._focus_widget
243
241
        return self._widget
244
 
    
 
242
 
245
243
    def update(self):
246
244
        "Called when what is visible on the screen should be updated."
247
245
        # How to add standout mode to a style
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
 
        
 
246
        with_standout = {"normal": "standout",
 
247
                         "bold": "bold-standout",
 
248
                         "underline-blink":
 
249
                         "underline-blink-standout",
 
250
                         "bold-underline-blink":
 
251
                         "bold-underline-blink-standout",
 
252
                         }
 
253
 
256
254
        # Rebuild focus and non-focus widgets using current properties
257
 
        
 
255
 
258
256
        # Base part of a client. Name!
259
 
        base = '{name}: '.format(name=self.properties["Name"])
 
257
        base = "{name}: ".format(name=self.properties["Name"])
260
258
        if not self.properties["Enabled"]:
261
259
            message = "DISABLED"
262
260
            self.using_timer(False)
263
261
        elif self.properties["ApprovalPending"]:
264
 
            timeout = datetime.timedelta(milliseconds
265
 
                                         = self.properties
266
 
                                         ["ApprovalDelay"])
 
262
            timeout = datetime.timedelta(
 
263
                milliseconds=self.properties["ApprovalDelay"])
267
264
            last_approval_request = isoformat_to_datetime(
268
265
                self.properties["LastApprovalRequest"])
269
266
            if last_approval_request is not None:
273
270
            else:
274
271
                timer = datetime.timedelta()
275
272
            if self.properties["ApprovedByDefault"]:
276
 
                message = "Approval in {0}. (d)eny?"
 
273
                message = "Approval in {}. (d)eny?"
277
274
            else:
278
 
                message = "Denial in {0}. (a)pprove?"
 
275
                message = "Denial in {}. (a)pprove?"
279
276
            message = message.format(str(timer).rsplit(".", 1)[0])
280
277
            self.using_timer(True)
281
278
        elif self.properties["LastCheckerStatus"] != 0:
285
282
                timer = datetime.timedelta(0)
286
283
            else:
287
284
                expires = (datetime.datetime.strptime
288
 
                           (expires, '%Y-%m-%dT%H:%M:%S.%f'))
 
285
                           (expires, "%Y-%m-%dT%H:%M:%S.%f"))
289
286
                timer = max(expires - datetime.datetime.utcnow(),
290
287
                            datetime.timedelta())
291
 
            message = ('A checker has failed! Time until client'
292
 
                       ' gets disabled: {0}'
 
288
            message = ("A checker has failed! Time until client"
 
289
                       " gets disabled: {}"
293
290
                       .format(str(timer).rsplit(".", 1)[0]))
294
291
            self.using_timer(True)
295
292
        else:
296
293
            message = "enabled"
297
294
            self.using_timer(False)
298
 
        self._text = "{0}{1}".format(base, message)
299
 
        
 
295
        self._text = "{}{}".format(base, message)
 
296
 
300
297
        if not urwid.supports_unicode():
301
298
            self._text = self._text.encode("ascii", "replace")
302
299
        textlist = [("normal", self._text)]
312
309
        # Run update hook, if any
313
310
        if self.update_hook is not None:
314
311
            self.update_hook()
315
 
    
 
312
 
316
313
    def update_timer(self):
317
 
        """called by gobject. Will indefinitely loop until
318
 
        gobject.source_remove() on tag is called"""
 
314
        """called by GLib. Will indefinitely loop until
 
315
        GLib.source_remove() on tag is called
 
316
        """
319
317
        self.update()
320
318
        return True             # Keep calling this
321
 
    
 
319
 
322
320
    def delete(self, **kwargs):
323
321
        if self._update_timer_callback_tag is not None:
324
 
            gobject.source_remove(self._update_timer_callback_tag)
 
322
            GLib.source_remove(self._update_timer_callback_tag)
325
323
            self._update_timer_callback_tag = None
326
324
        for match in self.match_objects:
327
325
            match.remove()
329
327
        if self.delete_hook is not None:
330
328
            self.delete_hook(self)
331
329
        return super(MandosClientWidget, self).delete(**kwargs)
332
 
    
 
330
 
333
331
    def render(self, maxcolrow, focus=False):
334
332
        """Render differently if we have focus.
335
333
        This overrides the method from urwid.FlowWidget"""
336
334
        return self.current_widget(focus).render(maxcolrow,
337
335
                                                 focus=focus)
338
 
    
 
336
 
339
337
    def keypress(self, maxcolrow, key):
340
338
        """Handle keys.
341
339
        This overrides the method from urwid.FlowWidget"""
342
340
        if key == "+":
343
 
            self.proxy.Enable(dbus_interface = client_interface,
344
 
                              ignore_reply=True)
 
341
            self.proxy.Set(client_interface, "Enabled",
 
342
                           dbus.Boolean(True), ignore_reply=True,
 
343
                           dbus_interface=dbus.PROPERTIES_IFACE)
345
344
        elif key == "-":
346
 
            self.proxy.Disable(dbus_interface = client_interface,
347
 
                               ignore_reply=True)
 
345
            self.proxy.Set(client_interface, "Enabled", False,
 
346
                           ignore_reply=True,
 
347
                           dbus_interface=dbus.PROPERTIES_IFACE)
348
348
        elif key == "a":
349
349
            self.proxy.Approve(dbus.Boolean(True, variant_level=1),
350
 
                               dbus_interface = client_interface,
 
350
                               dbus_interface=client_interface,
351
351
                               ignore_reply=True)
352
352
        elif key == "d":
353
353
            self.proxy.Approve(dbus.Boolean(False, variant_level=1),
354
 
                                  dbus_interface = client_interface,
 
354
                               dbus_interface=client_interface,
355
355
                               ignore_reply=True)
356
356
        elif key == "R" or key == "_" or key == "ctrl k":
357
357
            self.server_proxy_object.RemoveClient(self.proxy
358
358
                                                  .object_path,
359
359
                                                  ignore_reply=True)
360
360
        elif key == "s":
361
 
            self.proxy.StartChecker(dbus_interface = client_interface,
362
 
                                    ignore_reply=True)
 
361
            self.proxy.Set(client_interface, "CheckerRunning",
 
362
                           dbus.Boolean(True), ignore_reply=True,
 
363
                           dbus_interface=dbus.PROPERTIES_IFACE)
363
364
        elif key == "S":
364
 
            self.proxy.StopChecker(dbus_interface = client_interface,
365
 
                                   ignore_reply=True)
 
365
            self.proxy.Set(client_interface, "CheckerRunning",
 
366
                           dbus.Boolean(False), ignore_reply=True,
 
367
                           dbus_interface=dbus.PROPERTIES_IFACE)
366
368
        elif key == "C":
367
 
            self.proxy.CheckedOK(dbus_interface = client_interface,
 
369
            self.proxy.CheckedOK(dbus_interface=client_interface,
368
370
                                 ignore_reply=True)
369
371
        # xxx
370
372
#         elif key == "p" or key == "=":
375
377
#             self.open()
376
378
        else:
377
379
            return key
378
 
    
379
 
    def property_changed(self, property=None, **kwargs):
380
 
        """Call self.update() if old value is not new value.
 
380
 
 
381
    def properties_changed(self, interface, properties, invalidated):
 
382
        """Call self.update() if any properties changed.
381
383
        This overrides the method from MandosClientPropertyCache"""
382
 
        property_name = str(property)
383
 
        old_value = self.properties.get(property_name)
384
 
        super(MandosClientWidget, self).property_changed(
385
 
            property=property, **kwargs)
386
 
        if self.properties.get(property_name) != old_value:
 
384
        old_values = {key: self.properties.get(key)
 
385
                      for key in properties.keys()}
 
386
        super(MandosClientWidget, self).properties_changed(
 
387
            interface, properties, invalidated)
 
388
        if any(old_values[key] != self.properties.get(key)
 
389
               for key in old_values):
387
390
            self.update()
388
391
 
389
392
 
 
393
def glib_safely(func, retval=True):
 
394
    def safe_func(*args, **kwargs):
 
395
        try:
 
396
            return func(*args, **kwargs)
 
397
        except Exception:
 
398
            log.exception("")
 
399
            return retval
 
400
    return safe_func
 
401
 
 
402
 
390
403
class ConstrainedListBox(urwid.ListBox):
391
404
    """Like a normal urwid.ListBox, but will consume all "up" or
392
405
    "down" key presses, thus not allowing any containing widgets to
393
406
    use them as an excuse to shift focus away from this widget.
394
407
    """
395
408
    def keypress(self, *args, **kwargs):
396
 
        ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
 
409
        ret = (super(ConstrainedListBox, self)
 
410
               .keypress(*args, **kwargs))
397
411
        if ret in ("up", "down"):
398
412
            return
399
413
        return ret
400
414
 
401
415
 
402
 
class UserInterface(object):
 
416
class UserInterface:
403
417
    """This is the entire user interface - the whole screen
404
418
    with boxes, lists of client widgets, etc.
405
419
    """
406
420
    def __init__(self, max_log_length=1000):
407
421
        DBusGMainLoop(set_as_default=True)
408
 
        
 
422
 
409
423
        self.screen = urwid.curses_display.Screen()
410
 
        
 
424
 
411
425
        self.screen.register_palette((
412
426
                ("normal",
413
427
                 "default", "default", None),
418
432
                ("standout",
419
433
                 "standout", "default", "standout"),
420
434
                ("bold-underline-blink",
421
 
                 "bold,underline,blink", "default", "bold,underline,blink"),
 
435
                 "bold,underline,blink", "default",
 
436
                 "bold,underline,blink"),
422
437
                ("bold-standout",
423
438
                 "bold,standout", "default", "bold,standout"),
424
439
                ("underline-blink-standout",
428
443
                 "bold,underline,blink,standout", "default",
429
444
                 "bold,underline,blink,standout"),
430
445
                ))
431
 
        
 
446
 
432
447
        if urwid.supports_unicode():
433
 
            self.divider = "─" # \u2500
434
 
            #self.divider = "━" # \u2501
 
448
            self.divider = "─"  # \u2500
435
449
        else:
436
 
            #self.divider = "-" # \u002d
437
 
            self.divider = "_" # \u005f
438
 
        
 
450
            self.divider = "_"  # \u005f
 
451
 
439
452
        self.screen.start()
440
 
        
 
453
 
441
454
        self.size = self.screen.get_cols_rows()
442
 
        
 
455
 
443
456
        self.clients = urwid.SimpleListWalker([])
444
457
        self.clients_dict = {}
445
 
        
 
458
 
446
459
        # We will add Text widgets to this list
447
 
        self.log = []
 
460
        self.log = urwid.SimpleListWalker([])
448
461
        self.max_log_length = max_log_length
449
 
        
 
462
 
450
463
        # We keep a reference to the log widget so we can remove it
451
464
        # from the ListWalker without it getting destroyed
452
465
        self.logbox = ConstrainedListBox(self.log)
453
 
        
 
466
 
454
467
        # This keeps track of whether self.uilist currently has
455
468
        # self.logbox in it or not
456
469
        self.log_visible = True
457
470
        self.log_wrap = "any"
458
 
        
 
471
 
 
472
        self.loghandler = UILogHandler(self)
 
473
 
459
474
        self.rebuild()
460
 
        self.log_message_raw(("bold",
461
 
                              "Mandos Monitor version " + version))
462
 
        self.log_message_raw(("bold",
463
 
                              "q: Quit  ?: Help"))
464
 
        
465
 
        self.busname = domain + '.Mandos'
466
 
        self.main_loop = gobject.MainLoop()
467
 
    
468
 
    def client_not_found(self, fingerprint, address):
469
 
        self.log_message("Client with address {0} and fingerprint"
470
 
                         " {1} could not be found"
471
 
                         .format(address, fingerprint))
472
 
    
 
475
        self.add_log_line(("bold",
 
476
                           "Mandos Monitor version " + version))
 
477
        self.add_log_line(("bold", "q: Quit  ?: Help"))
 
478
 
 
479
        self.busname = domain + ".Mandos"
 
480
        self.main_loop = GLib.MainLoop()
 
481
 
 
482
    def client_not_found(self, key_id, address):
 
483
        log.info("Client with address %s and key ID %s could"
 
484
                 " not be found", address, key_id)
 
485
 
473
486
    def rebuild(self):
474
487
        """This rebuilds the User Interface.
475
488
        Call this when the widget layout needs to change"""
476
489
        self.uilist = []
477
 
        #self.uilist.append(urwid.ListBox(self.clients))
 
490
        # self.uilist.append(urwid.ListBox(self.clients))
478
491
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.
479
492
                                                          clients),
480
 
                                       #header=urwid.Divider(),
 
493
                                       # header=urwid.Divider(),
481
494
                                       header=None,
482
 
                                       footer=
483
 
                                       urwid.Divider(div_char=
484
 
                                                     self.divider)))
 
495
                                       footer=urwid.Divider(
 
496
                                           div_char=self.divider)))
485
497
        if self.log_visible:
486
498
            self.uilist.append(self.logbox)
487
499
        self.topwidget = urwid.Pile(self.uilist)
488
 
    
489
 
    def log_message(self, message):
490
 
        """Log message formatted with timestamp"""
491
 
        timestamp = datetime.datetime.now().isoformat()
492
 
        self.log_message_raw(timestamp + ": " + message)
493
 
    
494
 
    def log_message_raw(self, markup):
495
 
        """Add a log message to the log buffer."""
 
500
 
 
501
    def add_log_line(self, markup):
496
502
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
497
 
        if (self.max_log_length
498
 
            and len(self.log) > self.max_log_length):
499
 
            del self.log[0:len(self.log)-self.max_log_length-1]
500
 
        self.logbox.set_focus(len(self.logbox.body.contents),
 
503
        if self.max_log_length:
 
504
            if len(self.log) > self.max_log_length:
 
505
                del self.log[0:(len(self.log) - self.max_log_length)]
 
506
        self.logbox.set_focus(len(self.logbox.body.contents)-1,
501
507
                              coming_from="above")
502
508
        self.refresh()
503
 
    
 
509
 
504
510
    def toggle_log_display(self):
505
511
        """Toggle visibility of the log buffer."""
506
512
        self.log_visible = not self.log_visible
507
513
        self.rebuild()
508
 
        #self.log_message("Log visibility changed to: "
509
 
        #                 + str(self.log_visible))
510
 
    
 
514
        log.debug("Log visibility changed to: %s", self.log_visible)
 
515
 
511
516
    def change_log_display(self):
512
517
        """Change type of log display.
513
518
        Currently, this toggles wrapping of text lines."""
517
522
            self.log_wrap = "clip"
518
523
        for textwidget in self.log:
519
524
            textwidget.set_wrap_mode(self.log_wrap)
520
 
        #self.log_message("Wrap mode: " + self.log_wrap)
521
 
    
522
 
    def find_and_remove_client(self, path, name):
 
525
        log.debug("Wrap mode: %s", self.log_wrap)
 
526
 
 
527
    def find_and_remove_client(self, path, interfaces):
523
528
        """Find a client by its object path and remove it.
524
 
        
525
 
        This is connected to the ClientRemoved signal from the
 
529
 
 
530
        This is connected to the InterfacesRemoved signal from the
526
531
        Mandos server object."""
 
532
        if client_interface not in interfaces:
 
533
            # Not a Mandos client object; ignore
 
534
            return
527
535
        try:
528
536
            client = self.clients_dict[path]
529
537
        except KeyError:
530
538
            # not found?
531
 
            self.log_message("Unknown client {0!r} ({1!r}) removed"
532
 
                             .format(name, path))
 
539
            log.warning("Unknown client %s removed", path)
533
540
            return
534
541
        client.delete()
535
 
    
536
 
    def add_new_client(self, path):
 
542
 
 
543
    def add_new_client(self, path, ifs_and_props):
 
544
        """Find a client by its object path and remove it.
 
545
 
 
546
        This is connected to the InterfacesAdded signal from the
 
547
        Mandos server object.
 
548
        """
 
549
        if client_interface not in ifs_and_props:
 
550
            # Not a Mandos client object; ignore
 
551
            return
537
552
        client_proxy_object = self.bus.get_object(self.busname, path)
538
 
        self.add_client(MandosClientWidget(server_proxy_object
539
 
                                           =self.mandos_serv,
540
 
                                           proxy_object
541
 
                                           =client_proxy_object,
542
 
                                           update_hook
543
 
                                           =self.refresh,
544
 
                                           delete_hook
545
 
                                           =self.remove_client,
546
 
                                           logger
547
 
                                           =self.log_message),
 
553
        self.add_client(MandosClientWidget(
 
554
            server_proxy_object=self.mandos_serv,
 
555
            proxy_object=client_proxy_object,
 
556
            update_hook=self.refresh,
 
557
            delete_hook=self.remove_client,
 
558
            properties=dict(ifs_and_props[client_interface])),
548
559
                        path=path)
549
 
    
 
560
 
550
561
    def add_client(self, client, path=None):
551
562
        self.clients.append(client)
552
563
        if path is None:
554
565
        self.clients_dict[path] = client
555
566
        self.clients.sort(key=lambda c: c.properties["Name"])
556
567
        self.refresh()
557
 
    
 
568
 
558
569
    def remove_client(self, client, path=None):
559
570
        self.clients.remove(client)
560
571
        if path is None:
561
572
            path = client.proxy.object_path
562
573
        del self.clients_dict[path]
563
574
        self.refresh()
564
 
    
 
575
 
565
576
    def refresh(self):
566
577
        """Redraw the screen"""
567
578
        canvas = self.topwidget.render(self.size, focus=True)
568
579
        self.screen.draw_screen(self.size, canvas)
569
 
    
 
580
 
570
581
    def run(self):
571
582
        """Start the main loop and exit when it's done."""
 
583
        log.addHandler(self.loghandler)
 
584
        self.orig_log_propagate = log.propagate
 
585
        log.propagate = False
 
586
        self.orig_log_level = log.level
 
587
        log.setLevel("INFO")
572
588
        self.bus = dbus.SystemBus()
573
589
        mandos_dbus_objc = self.bus.get_object(
574
590
            self.busname, "/", follow_name_owner_changes=True)
575
 
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
576
 
                                          dbus_interface
577
 
                                          = server_interface)
 
591
        self.mandos_serv = dbus.Interface(
 
592
            mandos_dbus_objc, dbus_interface=server_interface)
578
593
        try:
579
594
            mandos_clients = (self.mandos_serv
580
595
                              .GetAllClientsWithProperties())
581
596
            if not mandos_clients:
582
 
                self.log_message_raw(("bold", "Note: Server has no clients."))
 
597
                log.warning("Note: Server has no clients.")
583
598
        except dbus.exceptions.DBusException:
584
 
            self.log_message_raw(("bold", "Note: No Mandos server running."))
 
599
            log.warning("Note: No Mandos server running.")
585
600
            mandos_clients = dbus.Dictionary()
586
 
        
 
601
 
587
602
        (self.mandos_serv
588
 
         .connect_to_signal("ClientRemoved",
 
603
         .connect_to_signal("InterfacesRemoved",
589
604
                            self.find_and_remove_client,
590
 
                            dbus_interface=server_interface,
 
605
                            dbus_interface=dbus.OBJECT_MANAGER_IFACE,
591
606
                            byte_arrays=True))
592
607
        (self.mandos_serv
593
 
         .connect_to_signal("ClientAdded",
 
608
         .connect_to_signal("InterfacesAdded",
594
609
                            self.add_new_client,
595
 
                            dbus_interface=server_interface,
 
610
                            dbus_interface=dbus.OBJECT_MANAGER_IFACE,
596
611
                            byte_arrays=True))
597
612
        (self.mandos_serv
598
613
         .connect_to_signal("ClientNotFound",
602
617
        for path, client in mandos_clients.items():
603
618
            client_proxy_object = self.bus.get_object(self.busname,
604
619
                                                      path)
605
 
            self.add_client(MandosClientWidget(server_proxy_object
606
 
                                               =self.mandos_serv,
607
 
                                               proxy_object
608
 
                                               =client_proxy_object,
609
 
                                               properties=client,
610
 
                                               update_hook
611
 
                                               =self.refresh,
612
 
                                               delete_hook
613
 
                                               =self.remove_client,
614
 
                                               logger
615
 
                                               =self.log_message),
 
620
            self.add_client(MandosClientWidget(
 
621
                server_proxy_object=self.mandos_serv,
 
622
                proxy_object=client_proxy_object,
 
623
                properties=client,
 
624
                update_hook=self.refresh,
 
625
                delete_hook=self.remove_client),
616
626
                            path=path)
617
 
        
 
627
 
618
628
        self.refresh()
619
 
        self._input_callback_tag = (gobject.io_add_watch
620
 
                                    (sys.stdin.fileno(),
621
 
                                     gobject.IO_IN,
622
 
                                     self.process_input))
 
629
        self._input_callback_tag = (
 
630
            GLib.io_add_watch(
 
631
                GLib.IOChannel.unix_new(sys.stdin.fileno()),
 
632
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
 
633
                glib_safely(self.process_input)))
623
634
        self.main_loop.run()
624
635
        # Main loop has finished, we should close everything now
625
 
        gobject.source_remove(self._input_callback_tag)
626
 
        self.screen.stop()
627
 
    
 
636
        GLib.source_remove(self._input_callback_tag)
 
637
        with warnings.catch_warnings():
 
638
            warnings.simplefilter("ignore", BytesWarning)
 
639
            self.screen.stop()
 
640
 
628
641
    def stop(self):
629
642
        self.main_loop.quit()
630
 
    
 
643
        log.removeHandler(self.loghandler)
 
644
        log.propagate = self.orig_log_propagate
 
645
 
631
646
    def process_input(self, source, condition):
632
647
        keys = self.screen.get_input()
633
 
        translations = { "ctrl n": "down",      # Emacs
634
 
                         "ctrl p": "up",        # Emacs
635
 
                         "ctrl v": "page down", # Emacs
636
 
                         "meta v": "page up",   # Emacs
637
 
                         " ": "page down",      # less
638
 
                         "f": "page down",      # less
639
 
                         "b": "page up",        # less
640
 
                         "j": "down",           # vi
641
 
                         "k": "up",             # vi
642
 
                         }
 
648
        translations = {"ctrl n": "down",       # Emacs
 
649
                        "ctrl p": "up",         # Emacs
 
650
                        "ctrl v": "page down",  # Emacs
 
651
                        "meta v": "page up",    # Emacs
 
652
                        " ": "page down",       # less
 
653
                        "f": "page down",       # less
 
654
                        "b": "page up",         # less
 
655
                        "j": "down",            # vi
 
656
                        "k": "up",              # vi
 
657
                        }
643
658
        for key in keys:
644
659
            try:
645
660
                key = translations[key]
646
661
            except KeyError:    # :-)
647
662
                pass
648
 
            
 
663
 
649
664
            if key == "q" or key == "Q":
650
665
                self.stop()
651
666
                break
652
667
            elif key == "window resize":
653
668
                self.size = self.screen.get_cols_rows()
654
669
                self.refresh()
655
 
            elif key == "\f":  # Ctrl-L
 
670
            elif key == "ctrl l":
 
671
                self.screen.clear()
656
672
                self.refresh()
657
673
            elif key == "l" or key == "D":
658
674
                self.toggle_log_display()
664
680
                if not self.log_visible:
665
681
                    self.log_visible = True
666
682
                    self.rebuild()
667
 
                self.log_message_raw(("bold",
668
 
                                      "  ".
669
 
                                      join(("q: Quit",
670
 
                                            "?: Help",
671
 
                                            "l: Log window toggle",
672
 
                                            "TAB: Switch window",
673
 
                                            "w: Wrap (log)"))))
674
 
                self.log_message_raw(("bold",
675
 
                                      "  "
676
 
                                      .join(("Clients:",
677
 
                                             "+: Enable",
678
 
                                             "-: Disable",
679
 
                                             "R: Remove",
680
 
                                             "s: Start new checker",
681
 
                                             "S: Stop checker",
682
 
                                             "C: Checker OK",
683
 
                                             "a: Approve",
684
 
                                             "d: Deny"))))
 
683
                self.add_log_line(("bold",
 
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.add_log_line(("bold",
 
692
                                   "  ".join(("Clients:",
 
693
                                              "+: Enable",
 
694
                                              "-: Disable",
 
695
                                              "R: Remove",
 
696
                                              "s: Start new checker",
 
697
                                              "S: Stop checker",
 
698
                                              "C: Checker OK",
 
699
                                              "a: Approve",
 
700
                                              "d: Deny",
 
701
                                   ))))
685
702
                self.refresh()
686
703
            elif key == "tab":
687
704
                if self.topwidget.get_focus() is self.logbox:
689
706
                else:
690
707
                    self.topwidget.set_focus(self.logbox)
691
708
                self.refresh()
692
 
            #elif (key == "end" or key == "meta >" or key == "G"
693
 
            #      or key == ">"):
694
 
            #    pass            # xxx end-of-buffer
695
 
            #elif (key == "home" or key == "meta <" or key == "g"
696
 
            #      or key == "<"):
697
 
            #    pass            # xxx beginning-of-buffer
698
 
            #elif key == "ctrl e" or key == "$":
699
 
            #    pass            # xxx move-end-of-line
700
 
            #elif key == "ctrl a" or key == "^":
701
 
            #    pass            # xxx move-beginning-of-line
702
 
            #elif key == "ctrl b" or key == "meta (" or key == "h":
703
 
            #    pass            # xxx left
704
 
            #elif key == "ctrl f" or key == "meta )" or key == "l":
705
 
            #    pass            # xxx right
706
 
            #elif key == "a":
707
 
            #    pass            # scroll up log
708
 
            #elif key == "z":
709
 
            #    pass            # scroll down log
 
709
            elif key == "v":
 
710
                if log.level < logging.INFO:
 
711
                    log.setLevel(logging.INFO)
 
712
                    log.info("Verbose mode: Off")
 
713
                else:
 
714
                    log.setLevel(logging.NOTSET)
 
715
                    log.info("Verbose mode: On")
 
716
            # elif (key == "end" or key == "meta >" or key == "G"
 
717
            #       or key == ">"):
 
718
            #     pass            # xxx end-of-buffer
 
719
            # elif (key == "home" or key == "meta <" or key == "g"
 
720
            #       or key == "<"):
 
721
            #     pass            # xxx beginning-of-buffer
 
722
            # elif key == "ctrl e" or key == "$":
 
723
            #     pass            # xxx move-end-of-line
 
724
            # elif key == "ctrl a" or key == "^":
 
725
            #     pass            # xxx move-beginning-of-line
 
726
            # elif key == "ctrl b" or key == "meta (" or key == "h":
 
727
            #     pass            # xxx left
 
728
            # elif key == "ctrl f" or key == "meta )" or key == "l":
 
729
            #     pass            # xxx right
 
730
            # elif key == "a":
 
731
            #     pass            # scroll up log
 
732
            # elif key == "z":
 
733
            #     pass            # scroll down log
710
734
            elif self.topwidget.selectable():
711
735
                self.topwidget.keypress(self.size, key)
712
736
                self.refresh()
713
737
        return True
714
738
 
 
739
 
 
740
class UILogHandler(logging.Handler):
 
741
    def __init__(self, ui, *args, **kwargs):
 
742
        self.ui = ui
 
743
        super(UILogHandler, self).__init__(*args, **kwargs)
 
744
        self.setFormatter(
 
745
            logging.Formatter("%(asctime)s: %(message)s"))
 
746
    def emit(self, record):
 
747
        msg = self.format(record)
 
748
        if record.levelno > logging.INFO:
 
749
            msg = ("bold", msg)
 
750
        self.ui.add_log_line(msg)
 
751
 
 
752
 
715
753
ui = UserInterface()
716
754
try:
717
755
    ui.run()
718
756
except KeyboardInterrupt:
719
 
    ui.screen.stop()
720
 
except Exception as e:
721
 
    ui.log_message(str(e))
722
 
    ui.screen.stop()
 
757
    with warnings.catch_warnings():
 
758
        warnings.filterwarnings("ignore", "", BytesWarning)
 
759
        ui.screen.stop()
 
760
except Exception:
 
761
    with warnings.catch_warnings():
 
762
        warnings.filterwarnings("ignore", "", BytesWarning)
 
763
        ui.screen.stop()
723
764
    raise