/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-15 20:55:50 UTC
  • Revision ID: teddy@recompile.se-20120115205550-i9dfhet4qjcroxru
Use the new Client.LastCheckerStatus property.
* mandos-monitor (MandosClientWidget.last_checker_failed): Removed.
  (MandosClientWidget.property_changed): Check for LastCheckerStatus
                                         and enable timer if failure
                                         is indicated.
  (MandosClientWidget.update): Use LastCheckerStatus property instead
                               of last_checker_failed.

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