/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-12-31 23:05:34 UTC
  • Revision ID: teddy@recompile.se-20111231230534-o5w0uhwx30gwhmk7
Updated year in copyright notices.

Show diffs side-by-side

added added

removed removed

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