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