/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: 2011-09-18 15:03:26 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110918150326-tj4zz5qv0cv54we3
* debian/control: Fix language for lintian.

Show diffs side-by-side

added added

removed removed

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