/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-01-01 04:02:00 UTC
  • Revision ID: teddy@recompile.se-20120101040200-8wgma707v4gi7hxn
* debian/rules (binary-common): Exclude network-hooks.d from
                                dh_fixperms.
* mandos (DBusObjectWithProperties.Set): Bug fix: handle byte arrays.
* mandos-clients.conf.xml (DESCRIPTION): Add reference to persistent
                                         state.
* mandos-options.xml (restore): Adjust wording slightly.
* mandos.xml (OPTIONS/--no-restore): Refer to "PERSISTENT STATE"
                                     section.
  (PERSISTENT STATE): New section.

Show diffs side-by-side

added added

removed removed

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