/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-01 20:45:53 UTC
  • Revision ID: teddy@recompile.se-20120101204553-f1zlty873gswtf5n
* README: Hint that the intro(8mandos) manual page is in the server
          package.

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