/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

* Makefile: Merge branch adding warning messages to "run-*" targets.

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