/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-01-15 21:01:13 UTC
  • Revision ID: teddy@recompile.se-20120115210113-mzpkowq0opshtu30
* mandos.xml (CHECKING): Don't claim that a successful secret request
                         is equivalent to a successful checker.

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