/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-03-08 21:57:33 UTC
  • mto: This revision was merged to the branch mainline in revision 562.
  • Revision ID: teddy@recompile.se-20120308215733-8pz2o2lbuc19e9uc
Add D-Bus annotations support to methods, signals and properties.

* mandos (dbus_annotations): New; decorator to add annotations.
  (DBusObjectWithProperties._get_all_dbus_things): Bug fix: return
                                                   normal name if no
                                                   "_dbus_name"
                                                   attribute.
  (DBusObjectWithProperties.Introspect): Add annotation tags.
  (AlternateDBusNamesMetaclass.__new__): Copy annotations.
  

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