/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: 2011-04-02 06:37:18 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110402063718-13ldrcuu0t33sdc4
* mandos: Tolerate restarting Avahi servers.  Also Changed to new
          "except x as y" exception syntax.
  (AvahiService.entry_group_state_changed_match): New; contains the
                                                  SignalMatch object.
  (AvahiService.remove): Really remove the group and the signal
                         connection, if any.
  (AvahiService.add): Always create a new group and signal connection.
  (AvahiService.cleanup): Changed to simply call remove().
  (AvahiService.server_state_changed): Handle and log more bad states.
  (AvahiService.activate): Set "follow_name_owner_changes=True" on the
                           Avahi Server proxy object.
  (ClientDBus.checked_ok): Do not return anything.
  (ClientDBus.CheckedOK): Do not return anything, as documented.
* mandos-monitor: Call D-Bus methods asynchronously.

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