/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-ctl (main): Use D-Bus properties instead of methods.

Show diffs side-by-side

added added

removed removed

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