/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: 2022-04-24 11:45:13 UTC
  • Revision ID: teddy@recompile.se-20220424114513-0rvlunnjhgs3deus
mandos-monitor: Update boilerplate code

* mandos-monitor: Show warnings by default.

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