/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: 2012-05-07 20:46:51 UTC
  • Revision ID: teddy@recompile.se-20120507204651-qx5o5ztwmau54mh4
* mandos-monitor: Speedup: Use properties from D-Bus
                  GetAllClientsWithProperties() call.  Also use
                  super() properly - only use keyword arguments and
                  strip them off as "kwargs" is passed on.
  (MandosClientPropertyCache.__init__): Take new "properties"
                                        argument; use it to skip
                                        calling D-Bus GetAll() method.
                                        Call super().  Bind self._
  (MandosClientPropertyCache._property_changed): New helper function.
  (MandosClientPropertyCache.property_changed): Changed to take
                                                keyword arguments.
  (MandosClientPropertyCache.delete): Bug fix: Don't call
                                      super().__init__().
  (MandosClientWidget.__init__): Don't take *args.  Strip used keyword
                                 arguments before calling super().
  (MandosClientWidget.property_changed): Removed dead code.
  (MandosClientWidget.delete): Don't take *args.
  (MandosClientWidget.property_changed): Don't take "value" argument,
                                         since it is not used.
  (ConstrainedListBox.keypress): Take *args, **kwargs and pass them on
                                 to super().

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