/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: 2021-02-03 23:10:42 UTC
  • Revision ID: teddy@recompile.se-20210203231042-2z3egrvpo1zt7nej
mandos-ctl: Fix bad test for command.Remove and related minor issues

The test for command.Remove removes all clients from the spy server,
and then loops over all clients, looking for the corresponding Remove
command as recorded by the spy server.  But since since there aren't
any clients left after they were removed, no assertions are made, and
the test therefore does nothing.  Fix this.

In tests for command.Approve and command.Deny, add checks that clients
were not somehow removed by the command (in which case, likewise, no
assertions are made).

Add related checks to TestPropertySetterCmd.runTest; i.e. test that a
sequence is not empty before looping over it and making assertions.

* mandos-ctl (TestBaseCommands.test_Remove): Save a copy of the
  original "clients" dict, and loop over those instead.  Add assertion
  that all clients were indeed removed.  Also fix the code which looks
  for the Remove command, which now needs to actually work.
  (TestBaseCommands.test_Approve, TestBaseCommands.test_Deny): Add
  assertion that there are still clients before looping over them.
  (TestPropertySetterCmd.runTest): Add assertion that the list of
  values to get is not empty before looping over them.  Also add check
  that there are still clients before looping over clients.

Show diffs side-by-side

added added

removed removed

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