/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-monitor

* debian/rules: Only set BROKEN_PIE if binutils is a specific range of
                versions.
* mandos-monitor (MandosClientWidget.keypress): Also accept "Ctrl-K"
                                                for removing client.
  (UserInterface.__init__): Use non-bold line drawing charater.
  (UserInterface.log_message): Scroll to bottom.
  (UserInterface.process_input): Also show help on "ESC" key.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!/usr/bin/python3 -bbI
 
1
#!/usr/bin/python
2
2
# -*- mode: python; coding: utf-8 -*-
3
 
#
4
 
# Mandos Monitor - Control and monitor the Mandos server
5
 
#
6
 
# Copyright © 2009-2019 Teddy Hogeborn
7
 
# Copyright © 2009-2019 Björn Påhlsson
8
 
#
9
 
# This file is part of Mandos.
10
 
#
11
 
# Mandos is free software: you can redistribute it and/or modify it
12
 
# under the terms of the GNU General Public License as published by
13
 
# the Free Software Foundation, either version 3 of the License, or
14
 
# (at your option) any later version.
15
 
#
16
 
#     Mandos is distributed in the hope that it will be useful, but
17
 
#     WITHOUT ANY WARRANTY; without even the implied warranty of
18
 
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19
 
#     GNU General Public License for more details.
20
 
#
21
 
# You should have received a copy of the GNU General Public License
22
 
# along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
23
 
#
24
 
# Contact the authors at <mandos@recompile.se>.
25
 
#
26
 
from __future__ import (division, absolute_import, print_function,
27
 
                        unicode_literals)
28
3
 
29
 
try:
30
 
    from future_builtins import *
31
 
except ImportError:
32
 
    pass
 
4
from __future__ import division, absolute_import, with_statement
33
5
 
34
6
import sys
35
 
import logging
36
 
import os
37
 
import warnings
38
 
import datetime
39
 
import locale
 
7
import signal
40
8
 
41
9
import urwid.curses_display
42
10
import urwid
43
11
 
44
12
from dbus.mainloop.glib import DBusGMainLoop
45
 
from gi.repository import GLib
 
13
import gobject
46
14
 
47
15
import dbus
48
16
 
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)
 
17
import UserList
67
18
 
68
19
# Some useful constants
69
 
domain = "se.recompile"
70
 
server_interface = domain + ".Mandos"
71
 
client_interface = domain + ".Mandos.Client"
72
 
version = "1.8.16"
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:
 
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):
98
34
    """This wraps a Mandos Client D-Bus proxy object, caches the
99
35
    properties and calls a hook function when any of them are
100
36
    changed.
101
37
    """
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.
 
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.
121
62
        """
122
63
        # Update properties dict with new value
123
 
        if interface == client_interface:
124
 
            self.properties.update(properties)
125
 
 
126
 
    def delete(self):
127
 
        self.property_changed_match.remove()
 
64
        self.properties[property] = value
128
65
 
129
66
 
130
67
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
131
68
    """A Mandos Client which is visible on the screen.
132
69
    """
133
 
 
 
70
    
134
71
    def __init__(self, server_proxy_object=None, update_hook=None,
135
 
                 delete_hook=None, **kwargs):
 
72
                 delete_hook=None, *args, **kwargs):
136
73
        # Called on update
137
74
        self.update_hook = update_hook
138
75
        # Called on delete
139
76
        self.delete_hook = delete_hook
140
77
        # Mandos Server proxy object
141
78
        self.server_proxy_object = server_proxy_object
142
 
 
143
 
        self._update_timer_callback_tag = None
144
 
 
 
79
        
145
80
        # The widget shown normally
146
81
        self._text_widget = urwid.Text("")
147
82
        # The widget shown when we have focus
148
83
        self._focus_text_widget = urwid.Text("")
149
 
        super(MandosClientWidget, self).__init__(**kwargs)
 
84
        super(MandosClientWidget, self).__init__(
 
85
            update_hook=update_hook, delete_hook=delete_hook,
 
86
            *args, **kwargs)
150
87
        self.update()
151
88
        self.opened = False
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
 
 
 
89
    
226
90
    def selectable(self):
227
91
        """Make this a "selectable" widget.
228
92
        This overrides the method from urwid.FlowWidget."""
229
93
        return True
230
 
 
231
 
    def rows(self, maxcolrow, focus=False):
 
94
    
 
95
    def rows(self, (maxcol,), focus=False):
232
96
        """How many rows this widget will occupy might depend on
233
97
        whether we have focus or not.
234
98
        This overrides the method from urwid.FlowWidget"""
235
 
        return self.current_widget(focus).rows(maxcolrow, focus=focus)
236
 
 
 
99
        return self.current_widget(focus).rows((maxcol,), focus=focus)
 
100
    
237
101
    def current_widget(self, focus=False):
238
102
        if focus or self.opened:
239
103
            return self._focus_widget
240
104
        return self._widget
241
 
 
 
105
    
242
106
    def update(self):
243
107
        "Called when what is visible on the screen should be updated."
244
108
        # How to add standout mode to a style
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
 
 
 
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
        
253
117
        # Rebuild focus and non-focus widgets using current 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
 
 
 
118
        self._text = (u'name="%(name)s", enabled=%(enabled)s'
 
119
                      % self.properties)
296
120
        if not urwid.supports_unicode():
297
121
            self._text = self._text.encode("ascii", "replace")
298
 
        textlist = [("normal", self._text)]
 
122
        textlist = [(u"normal", u"BLARGH: "), (u"bold", self._text)]
299
123
        self._text_widget.set_text(textlist)
300
124
        self._focus_text_widget.set_text([(with_standout[text[0]],
301
125
                                           text[1])
308
132
        # Run update hook, if any
309
133
        if self.update_hook is not None:
310
134
            self.update_hook()
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 = ()
 
135
    
 
136
    def delete(self):
326
137
        if self.delete_hook is not None:
327
138
            self.delete_hook(self)
328
 
        return super(MandosClientWidget, self).delete(**kwargs)
329
 
 
330
 
    def render(self, maxcolrow, focus=False):
 
139
    
 
140
    def render(self, (maxcol,), focus=False):
331
141
        """Render differently if we have focus.
332
142
        This overrides the method from urwid.FlowWidget"""
333
 
        return self.current_widget(focus).render(maxcolrow,
 
143
        return self.current_widget(focus).render((maxcol,),
334
144
                                                 focus=focus)
335
 
 
336
 
    def keypress(self, maxcolrow, key):
 
145
    
 
146
    def keypress(self, (maxcol,), key):
337
147
        """Handle keys.
338
148
        This overrides the method from urwid.FlowWidget"""
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":
 
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":
356
154
            self.server_proxy_object.RemoveClient(self.proxy
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)
 
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()
370
162
        # xxx
371
 
#         elif key == "p" or key == "=":
 
163
#         elif key == u"p" or key == "=":
372
164
#             self.proxy.pause()
373
 
#         elif key == "u" or key == ":":
 
165
#         elif key == u"u" or key == ":":
374
166
#             self.proxy.unpause()
375
 
#         elif key == "RET":
 
167
#         elif key == u"RET":
376
168
#             self.open()
377
169
        else:
378
170
            return key
379
 
 
380
 
    def properties_changed(self, interface, properties, invalidated):
381
 
        """Call self.update() if any properties changed.
 
171
    
 
172
    def property_changed(self, property=None, value=None,
 
173
                         *args, **kwargs):
 
174
        """Call self.update() if old value is not new value.
382
175
        This overrides the method from MandosClientPropertyCache"""
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):
 
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:
389
181
            self.update()
390
182
 
391
183
 
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
 
 
402
184
class ConstrainedListBox(urwid.ListBox):
403
185
    """Like a normal urwid.ListBox, but will consume all "up" or
404
186
    "down" key presses, thus not allowing any containing widgets to
405
187
    use them as an excuse to shift focus away from this widget.
406
188
    """
407
 
    def keypress(self, *args, **kwargs):
408
 
        ret = (super(ConstrainedListBox, self)
409
 
               .keypress(*args, **kwargs))
410
 
        if ret in ("up", "down"):
 
189
    def keypress(self, (maxcol, maxrow), key):
 
190
        ret = super(ConstrainedListBox, self).keypress((maxcol, maxrow), key)
 
191
        if ret in (u"up", u"down"):
411
192
            return
412
193
        return ret
413
194
 
414
195
 
415
 
class UserInterface:
 
196
class UserInterface(object):
416
197
    """This is the entire user interface - the whole screen
417
198
    with boxes, lists of client widgets, etc.
418
199
    """
419
200
    def __init__(self, max_log_length=1000):
420
201
        DBusGMainLoop(set_as_default=True)
421
 
 
 
202
        
422
203
        self.screen = urwid.curses_display.Screen()
423
 
 
 
204
        
424
205
        self.screen.register_palette((
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"),
 
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")),
444
223
                ))
445
 
 
 
224
        
446
225
        if urwid.supports_unicode():
447
 
            self.divider = "─"  # \u2500
 
226
            self.divider = u"─" # \u2500
 
227
            #self.divider = u"━" # \u2501
448
228
        else:
449
 
            self.divider = "_"  # \u005f
450
 
 
 
229
            #self.divider = u"-" # \u002d
 
230
            self.divider = u"_" # \u005f
 
231
        
451
232
        self.screen.start()
452
 
 
 
233
        
453
234
        self.size = self.screen.get_cols_rows()
454
 
 
 
235
        
455
236
        self.clients = urwid.SimpleListWalker([])
456
237
        self.clients_dict = {}
457
 
 
 
238
        
458
239
        # We will add Text widgets to this list
459
 
        self.log = urwid.SimpleListWalker([])
 
240
        self.log = []
460
241
        self.max_log_length = max_log_length
461
 
 
 
242
        
462
243
        # We keep a reference to the log widget so we can remove it
463
244
        # from the ListWalker without it getting destroyed
464
245
        self.logbox = ConstrainedListBox(self.log)
465
 
 
 
246
        
466
247
        # This keeps track of whether self.uilist currently has
467
248
        # self.logbox in it or not
468
249
        self.log_visible = True
469
 
        self.log_wrap = "any"
470
 
 
471
 
        self.loghandler = UILogHandler(self)
472
 
 
 
250
        self.log_wrap = u"any"
 
251
        
473
252
        self.rebuild()
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
 
 
 
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
    
485
296
    def rebuild(self):
486
297
        """This rebuilds the User Interface.
487
298
        Call this when the widget layout needs to change"""
488
299
        self.uilist = []
489
 
        # self.uilist.append(urwid.ListBox(self.clients))
490
 
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.
491
 
                                                          clients),
492
 
                                       # header=urwid.Divider(),
 
300
        #self.uilist.append(urwid.ListBox(self.clients))
 
301
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
 
302
                                       #header=urwid.Divider(),
493
303
                                       header=None,
494
 
                                       footer=urwid.Divider(
495
 
                                           div_char=self.divider)))
 
304
                                       footer=urwid.Divider(div_char=self.divider)))
496
305
        if self.log_visible:
497
306
            self.uilist.append(self.logbox)
 
307
            pass
498
308
        self.topwidget = urwid.Pile(self.uilist)
499
 
 
500
 
    def add_log_line(self, markup):
 
309
    
 
310
    def log_message(self, markup):
 
311
        """Add a log message to the log buffer."""
501
312
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
502
 
        if self.max_log_length:
503
 
            if len(self.log) > self.max_log_length:
504
 
                del self.log[0:(len(self.log) - self.max_log_length)]
505
 
        self.logbox.set_focus(len(self.logbox.body.contents)-1,
506
 
                              coming_from="above")
507
 
        self.refresh()
508
 
 
 
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
    
509
319
    def toggle_log_display(self):
510
320
        """Toggle visibility of the log buffer."""
511
321
        self.log_visible = not self.log_visible
512
322
        self.rebuild()
513
 
        log.debug("Log visibility changed to: %s", self.log_visible)
514
 
 
 
323
        self.log_message(u"Log visibility changed to: "
 
324
                         + unicode(self.log_visible))
 
325
    
515
326
    def change_log_display(self):
516
327
        """Change type of log display.
517
328
        Currently, this toggles wrapping of text lines."""
518
 
        if self.log_wrap == "clip":
519
 
            self.log_wrap = "any"
 
329
        if self.log_wrap == u"clip":
 
330
            self.log_wrap = u"any"
520
331
        else:
521
 
            self.log_wrap = "clip"
 
332
            self.log_wrap = u"clip"
522
333
        for textwidget in self.log:
523
334
            textwidget.set_wrap_mode(self.log_wrap)
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
 
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
530
341
        Mandos server object."""
531
 
        if client_interface not in interfaces:
532
 
            # Not a Mandos client object; ignore
533
 
            return
534
342
        try:
535
343
            client = self.clients_dict[path]
536
344
        except KeyError:
537
345
            # not found?
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
 
346
            return
 
347
        self.remove_client(client, path)
 
348
    
 
349
    def add_new_client(self, path, properties):
551
350
        client_proxy_object = self.bus.get_object(self.busname, path)
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])),
 
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),
558
360
                        path=path)
559
 
 
 
361
    
560
362
    def add_client(self, client, path=None):
561
363
        self.clients.append(client)
562
364
        if path is None:
563
365
            path = client.proxy.object_path
564
366
        self.clients_dict[path] = client
565
 
        self.clients.sort(key=lambda c: c.properties["Name"])
 
367
        self.clients.sort(None, lambda c: c.properties[u"name"])
566
368
        self.refresh()
567
 
 
 
369
    
568
370
    def remove_client(self, client, path=None):
569
371
        self.clients.remove(client)
570
372
        if path is None:
571
373
            path = client.proxy.object_path
572
374
        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()
573
380
        self.refresh()
574
 
 
 
381
    
575
382
    def refresh(self):
576
383
        """Redraw the screen"""
577
384
        canvas = self.topwidget.render(self.size, focus=True)
578
385
        self.screen.draw_screen(self.size, canvas)
579
 
 
 
386
    
580
387
    def run(self):
581
388
        """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
 
 
627
389
        self.refresh()
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)))
 
390
        self._input_callback_tag = (gobject.io_add_watch
 
391
                                    (sys.stdin.fileno(),
 
392
                                     gobject.IO_IN,
 
393
                                     self.process_input))
633
394
        self.main_loop.run()
634
395
        # Main loop has finished, we should close everything now
635
 
        GLib.source_remove(self._input_callback_tag)
636
 
        with warnings.catch_warnings():
637
 
            warnings.simplefilter("ignore", BytesWarning)
638
 
            self.screen.stop()
639
 
 
 
396
        gobject.source_remove(self._input_callback_tag)
 
397
        self.screen.stop()
 
398
    
640
399
    def stop(self):
641
400
        self.main_loop.quit()
642
 
        log.removeHandler(self.loghandler)
643
 
        log.propagate = self.orig_log_propagate
644
 
 
 
401
    
645
402
    def process_input(self, source, condition):
646
403
        keys = self.screen.get_input()
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
 
                        }
 
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
                         }
657
414
        for key in keys:
658
415
            try:
659
416
                key = translations[key]
660
417
            except KeyError:    # :-)
661
418
                pass
662
 
 
663
 
            if key == "q" or key == "Q":
 
419
            
 
420
            if key == u"q" or key == u"Q":
664
421
                self.stop()
665
422
                break
666
 
            elif key == "window resize":
 
423
            elif key == u"window resize":
667
424
                self.size = self.screen.get_cols_rows()
668
425
                self.refresh()
669
 
            elif key == "ctrl l":
670
 
                self.screen.clear()
 
426
            elif key == u"\f":  # Ctrl-L
671
427
                self.refresh()
672
 
            elif key == "l" or key == "D":
 
428
            elif key == u"l" or key == u"D":
673
429
                self.toggle_log_display()
674
430
                self.refresh()
675
 
            elif key == "w" or key == "i":
 
431
            elif key == u"w" or key == u"i":
676
432
                self.change_log_display()
677
433
                self.refresh()
678
 
            elif key == "?" or key == "f1" or key == "esc":
 
434
            elif key == u"?" or key == u"f1" or key == u"esc":
679
435
                if not self.log_visible:
680
436
                    self.log_visible = True
681
437
                    self.rebuild()
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
 
                                   ))))
 
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"))))
701
452
                self.refresh()
702
 
            elif key == "tab":
 
453
            elif key == u"tab":
703
454
                if self.topwidget.get_focus() is self.logbox:
704
455
                    self.topwidget.set_focus(0)
705
456
                else:
706
457
                    self.topwidget.set_focus(self.logbox)
707
458
                self.refresh()
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
 
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
733
477
            elif self.topwidget.selectable():
734
478
                self.topwidget.keypress(self.size, key)
735
479
                self.refresh()
736
480
        return True
737
481
 
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
 
 
752
482
ui = UserInterface()
753
483
try:
754
484
    ui.run()
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()
 
485
except:
 
486
    ui.screen.stop()
763
487
    raise