/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2011-10-09 17:36:01 UTC
  • Revision ID: teddy@recompile.se-20111009173601-ctzsqstad3q2bs4c
Tags: version-1.4.0-1
* Makefile (version): Changed to "1.4.0".
* NEWS (Version 1.4.0): New entry.
* debian/changelog (1.4.0-1): - '' -

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