/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-monitor

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