/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

* plugins.d/mandos-client.c: Merge unified printing system.

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