/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2012-05-07 19:13:15 UTC
  • Revision ID: teddy@recompile.se-20120507191315-tbe55n4u1uq3l7ft
* mandos: Use all new builtins.
* mandos-ctl: - '' -
* mandos-monitor: - '' -

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