/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

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