/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2017-02-23 21:14:58 UTC
  • mfrom: (237.4.90 release)
  • Revision ID: teddy@recompile.se-20170223211458-2rv7ec5bxmk4ts81
Merge from release branch

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