/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: 2014-07-14 21:41:08 UTC
  • Revision ID: teddy@recompile.se-20140714214108-awg7u6gaiy7d40dz
mandos-monitor: New "verbose" mode to see less important log messages.

* mandos-monitor (MandosClientWidget.__init__): Log client creation.
  (MandosClientWidget.checker_completed): Log a successful checker.
  (MandosClientWidget.checker_started): Log starting of a checker.
  (UserInterface.__init__): New optional "log_level" argument.
  (UserInterface.log_message, UserInterface.log_message_raw): Take
                                                              optional
                                                              "level"
                                                              arg.
  (UserInterface.toggle_log_display): Log visibility change.
  (UserInterface.change_log_display): Log wrap mode change.
  (UserInterface.process_input): Show new "v" key in help message and
                                 process "v" key if pressed.
* mandos-monitor.xml (KEYS): Document new "v" key.

Show diffs side-by-side

added added

removed removed

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