/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-monitor

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