/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

merge

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