/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: 2015-08-02 16:45:29 UTC
  • Revision ID: teddy@recompile.se-20150802164529-pemtk1agiqluoiua
Deprecate some D-Bus methods in favor of D-Bus properties.

The following D-Bus methods on the interface
"se.recompile.Mandos.Client" are redundant, and are therefore
deprecated:  "Disable", "Enable", "StartChecker", and "StopChecker".
Instead, the D-Bus properties "Enabled" and "CheckerRunning" should be
set, as was always also possible.

* DBUS-API (se.recompile.Mandos.Client.Disable): Remove; deprecated.
  (se.recompile.Mandos.Client.Enable): - '' -
  (se.recompile.Mandos.Client.StartChecker): - '' -
  (se.recompile.Mandos.Client.StopChecker): - '' -
* mandos (ClientDBus.Enable): Annotate as deprecated.
  (ClientDBus.StartChecker): - '' -
  (ClientDBus.Disable): - '' -
  (ClientDBus.StopChecker): - '' -
* mandos-monitor (MandosClientWidget.keypress): Set properties instead
                                                of calling deprecated
                                                methods.

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