/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos-monitor

* Makefile (run-server): Remove warning about now-eliminated error.

Show diffs side-by-side

added added

removed removed

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