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