/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-07-27 17:58:27 UTC
  • mto: (237.4.29 release)
  • mto: This revision was merged to the branch mainline in revision 490.
  • Revision ID: teddy@fukt.bsnet.se-20110727175827-nrd1ysjl4jrh6qw1
Tags: version-1.3.1-1
* Makefile (version): Changed to "1.3.1".
* NEWS (Version 1.3.1): New entry.
* debian/changelog (1.3.1-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
 
#
24
 
# Contact the authors at <mandos@recompile.se>.
25
 
#
 
20
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
21
 
22
# Contact the authors at <mandos@fukt.bsnet.se>.
 
23
 
24
 
26
25
from __future__ import (division, absolute_import, print_function,
27
26
                        unicode_literals)
28
27
 
29
 
try:
30
 
    from future_builtins import *
31
 
except ImportError:
32
 
    pass
33
 
 
34
28
import sys
35
 
import logging
36
29
import os
37
 
import warnings
 
30
import signal
 
31
 
38
32
import datetime
39
 
import locale
40
33
 
41
34
import urwid.curses_display
42
35
import urwid
43
36
 
44
37
from dbus.mainloop.glib import DBusGMainLoop
45
 
from gi.repository import GLib
 
38
import gobject
46
39
 
47
40
import dbus
48
41
 
49
 
if sys.version_info.major == 2:
50
 
    __metaclass__ = type
51
 
    str = unicode
52
 
    input = raw_input
53
 
 
54
 
# Show warnings by default
55
 
if not sys.warnoptions:
56
 
    warnings.simplefilter("default")
57
 
 
58
 
log = logging.getLogger(os.path.basename(sys.argv[0]))
59
 
logging.basicConfig(level="NOTSET", # Show all messages
60
 
                    format="%(message)s") # Show basic log messages
61
 
 
62
 
logging.captureWarnings(True)   # Show warnings via the logging system
63
 
 
64
 
locale.setlocale(locale.LC_ALL, "")
65
 
 
66
 
logging.getLogger("dbus.proxies").setLevel(logging.CRITICAL)
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.bsnet.fukt'
 
53
server_interface = domain + '.Mandos'
 
54
client_interface = domain + '.Mandos.Client'
 
55
version = "1.3.1"
 
56
 
 
57
# Always run in monochrome mode
 
58
urwid.curses_display.curses.has_colors = lambda : False
 
59
 
 
60
# Urwid doesn't support blinking, but we want it.  Since we have no
 
61
# use for underline on its own, we make underline also always blink.
 
62
urwid.curses_display.curses.A_UNDERLINE |= (
 
63
    urwid.curses_display.curses.A_BLINK)
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:
184
 
            # 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)
 
197
        old = self._update_timer_callback_lock
 
198
        if flag:
 
199
            self._update_timer_callback_lock += 1
 
200
        else:
 
201
            self._update_timer_callback_lock -= 1
 
202
        if old == 0 and self._update_timer_callback_lock:
 
203
            self._update_timer_callback_tag = (gobject.timeout_add
 
204
                                               (1000,
 
205
                                                self.update_timer))
 
206
        elif old and self._update_timer_callback_lock == 0:
 
207
            gobject.source_remove(self._update_timer_callback_tag)
190
208
            self._update_timer_callback_tag = None
191
 
 
 
209
    
192
210
    def checker_completed(self, exitstatus, condition, command):
193
211
        if exitstatus == 0:
194
 
            log.debug('Checker for client %s (command "%s")'
195
 
                      " succeeded", self.properties["Name"], command)
 
212
            if self.last_checker_failed:
 
213
                self.last_checker_failed = False
 
214
                self.using_timer(False)
 
215
            #self.logger('Checker for client %s (command "%s")'
 
216
            #            ' was successful'
 
217
            #            % (self.properties["Name"], command))
196
218
            self.update()
197
219
            return
198
220
        # Checker failed
 
221
        if not self.last_checker_failed:
 
222
            self.last_checker_failed = True
 
223
            self.using_timer(True)
199
224
        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))
 
225
            self.logger('Checker for client %s (command "%s")'
 
226
                        ' failed with exit code %s'
 
227
                        % (self.properties["Name"], command,
 
228
                           os.WEXITSTATUS(condition)))
203
229
        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))
 
230
            self.logger('Checker for client %s (command "%s")'
 
231
                        ' was killed by signal %s'
 
232
                        % (self.properties["Name"], command,
 
233
                           os.WTERMSIG(condition)))
 
234
        elif os.WCOREDUMP(condition):
 
235
            self.logger('Checker for client %s (command "%s")'
 
236
                        ' dumped core'
 
237
                        % (self.properties["Name"], command))
 
238
        else:
 
239
            self.logger('Checker for client %s completed'
 
240
                        ' mysteriously')
207
241
        self.update()
208
 
 
 
242
    
209
243
    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
 
 
 
244
        #self.logger('Client %s started checker "%s"'
 
245
        #            % (self.properties["Name"], unicode(command)))
 
246
        pass
 
247
    
214
248
    def got_secret(self):
215
 
        log.info("Client %s received its secret",
216
 
                 self.properties["Name"])
217
 
 
 
249
        self.last_checker_failed = False
 
250
        self.logger('Client %s received its secret'
 
251
                    % self.properties["Name"])
 
252
    
218
253
    def need_approval(self, timeout, default):
219
254
        if not default:
220
 
            message = "Client %s needs approval within %f seconds"
 
255
            message = 'Client %s needs approval within %s seconds'
221
256
        else:
222
 
            message = "Client %s will get its secret in %f seconds"
223
 
        log.info(message, self.properties["Name"], timeout/1000)
224
 
 
 
257
            message = 'Client %s will get its secret in %s seconds'
 
258
        self.logger(message
 
259
                    % (self.properties["Name"], timeout/1000))
 
260
        self.using_timer(True)
 
261
    
225
262
    def rejected(self, reason):
226
 
        log.info("Client %s was rejected; reason: %s",
227
 
                 self.properties["Name"], reason)
228
 
 
 
263
        self.logger('Client %s was rejected; reason: %s'
 
264
                    % (self.properties["Name"], reason))
 
265
    
229
266
    def selectable(self):
230
267
        """Make this a "selectable" widget.
231
 
        This overrides the method from urwid.Widget."""
 
268
        This overrides the method from urwid.FlowWidget."""
232
269
        return True
233
 
 
 
270
    
234
271
    def rows(self, maxcolrow, focus=False):
235
272
        """How many rows this widget will occupy might depend on
236
273
        whether we have focus or not.
237
 
        This overrides the method from urwid.Widget"""
 
274
        This overrides the method from urwid.FlowWidget"""
238
275
        return self.current_widget(focus).rows(maxcolrow, focus=focus)
239
 
 
 
276
    
240
277
    def current_widget(self, focus=False):
241
278
        if focus or self.opened:
242
279
            return self._focus_widget
243
280
        return self._widget
244
 
 
 
281
    
245
282
    def update(self):
246
283
        "Called when what is visible on the screen should be updated."
247
284
        # 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
 
                         }
 
285
        with_standout = { "normal": "standout",
 
286
                          "bold": "bold-standout",
 
287
                          "underline-blink":
 
288
                              "underline-blink-standout",
 
289
                          "bold-underline-blink":
 
290
                              "bold-underline-blink-standout",
 
291
                          }
255
292
 
256
293
        # Rebuild focus and non-focus widgets using current properties
257
294
 
258
295
        # Base part of a client. Name!
259
 
        base = "{name}: ".format(name=self.properties["Name"])
 
296
        base = ('%(name)s: '
 
297
                      % {"name": self.properties["Name"]})
260
298
        if not self.properties["Enabled"]:
261
299
            message = "DISABLED"
262
 
            self.using_timer(False)
263
300
        elif self.properties["ApprovalPending"]:
264
 
            timeout = datetime.timedelta(
265
 
                milliseconds=self.properties["ApprovalDelay"])
 
301
            timeout = datetime.timedelta(milliseconds
 
302
                                         = self.properties
 
303
                                         ["ApprovalDelay"])
266
304
            last_approval_request = isoformat_to_datetime(
267
305
                self.properties["LastApprovalRequest"])
268
306
            if last_approval_request is not None:
269
 
                timer = max(timeout - (datetime.datetime.utcnow()
270
 
                                       - last_approval_request),
271
 
                            datetime.timedelta())
 
307
                timer = timeout - (datetime.datetime.utcnow()
 
308
                                   - last_approval_request)
272
309
            else:
273
310
                timer = datetime.timedelta()
274
311
            if self.properties["ApprovedByDefault"]:
275
 
                message = "Approval in {}. (d)eny?"
276
 
            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
282
 
            expires = self.properties["Expires"]
283
 
            if expires == "":
284
 
                timer = datetime.timedelta(0)
285
 
            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)
 
312
                message = "Approval in %s. (d)eny?"
 
313
            else:
 
314
                message = "Denial in %s. (a)pprove?"
 
315
            message = message % unicode(timer).rsplit(".", 1)[0]
 
316
        elif self.last_checker_failed:
 
317
            timeout = datetime.timedelta(milliseconds
 
318
                                         = self.properties
 
319
                                         ["Timeout"])
 
320
            last_ok = isoformat_to_datetime(
 
321
                max((self.properties["LastCheckedOK"]
 
322
                     or self.properties["Created"]),
 
323
                    self.properties["LastEnabled"]))
 
324
            timer = timeout - (datetime.datetime.utcnow() - last_ok)
 
325
            message = ('A checker has failed! Time until client'
 
326
                       ' gets disabled: %s'
 
327
                           % unicode(timer).rsplit(".", 1)[0])
294
328
        else:
295
329
            message = "enabled"
296
 
            self.using_timer(False)
297
 
        self._text = "{}{}".format(base, message)
298
 
 
 
330
        self._text = "%s%s" % (base, message)
 
331
            
299
332
        if not urwid.supports_unicode():
300
333
            self._text = self._text.encode("ascii", "replace")
301
334
        textlist = [("normal", self._text)]
311
344
        # Run update hook, if any
312
345
        if self.update_hook is not None:
313
346
            self.update_hook()
314
 
 
 
347
    
315
348
    def update_timer(self):
316
 
        """called by GLib. Will indefinitely loop until
317
 
        GLib.source_remove() on tag is called
318
 
        """
 
349
        "called by gobject"
319
350
        self.update()
320
351
        return True             # Keep calling this
321
 
 
322
 
    def delete(self, **kwargs):
 
352
    
 
353
    def delete(self, *args, **kwargs):
323
354
        if self._update_timer_callback_tag is not None:
324
 
            GLib.source_remove(self._update_timer_callback_tag)
 
355
            gobject.source_remove(self._update_timer_callback_tag)
325
356
            self._update_timer_callback_tag = None
326
357
        for match in self.match_objects:
327
358
            match.remove()
328
359
        self.match_objects = ()
329
360
        if self.delete_hook is not None:
330
361
            self.delete_hook(self)
331
 
        return super(MandosClientWidget, self).delete(**kwargs)
332
 
 
 
362
        return super(MandosClientWidget, self).delete(*args, **kwargs)
 
363
    
333
364
    def render(self, maxcolrow, focus=False):
334
365
        """Render differently if we have focus.
335
 
        This overrides the method from urwid.Widget"""
 
366
        This overrides the method from urwid.FlowWidget"""
336
367
        return self.current_widget(focus).render(maxcolrow,
337
368
                                                 focus=focus)
338
 
 
 
369
    
339
370
    def keypress(self, maxcolrow, key):
340
371
        """Handle keys.
341
 
        This overrides the method from urwid.Widget"""
 
372
        This overrides the method from urwid.FlowWidget"""
342
373
        if key == "+":
343
 
            self.proxy.Set(client_interface, "Enabled",
344
 
                           dbus.Boolean(True), ignore_reply=True,
345
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
374
            self.proxy.Enable(dbus_interface = client_interface,
 
375
                              ignore_reply=True)
346
376
        elif key == "-":
347
 
            self.proxy.Set(client_interface, "Enabled", False,
348
 
                           ignore_reply=True,
349
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
377
            self.proxy.Disable(dbus_interface = client_interface,
 
378
                               ignore_reply=True)
350
379
        elif key == "a":
351
380
            self.proxy.Approve(dbus.Boolean(True, variant_level=1),
352
 
                               dbus_interface=client_interface,
 
381
                               dbus_interface = client_interface,
353
382
                               ignore_reply=True)
354
383
        elif key == "d":
355
384
            self.proxy.Approve(dbus.Boolean(False, variant_level=1),
356
 
                               dbus_interface=client_interface,
 
385
                                  dbus_interface = client_interface,
357
386
                               ignore_reply=True)
358
387
        elif key == "R" or key == "_" or key == "ctrl k":
359
388
            self.server_proxy_object.RemoveClient(self.proxy
360
389
                                                  .object_path,
361
390
                                                  ignore_reply=True)
362
391
        elif key == "s":
363
 
            self.proxy.Set(client_interface, "CheckerRunning",
364
 
                           dbus.Boolean(True), ignore_reply=True,
365
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
392
            self.proxy.StartChecker(dbus_interface = client_interface,
 
393
                                    ignore_reply=True)
366
394
        elif key == "S":
367
 
            self.proxy.Set(client_interface, "CheckerRunning",
368
 
                           dbus.Boolean(False), ignore_reply=True,
369
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
395
            self.proxy.StopChecker(dbus_interface = client_interface,
 
396
                                   ignore_reply=True)
370
397
        elif key == "C":
371
 
            self.proxy.CheckedOK(dbus_interface=client_interface,
 
398
            self.proxy.CheckedOK(dbus_interface = client_interface,
372
399
                                 ignore_reply=True)
373
400
        # xxx
374
401
#         elif key == "p" or key == "=":
379
406
#             self.open()
380
407
        else:
381
408
            return key
382
 
 
383
 
    def properties_changed(self, interface, properties, invalidated):
384
 
        """Call self.update() if any properties changed.
 
409
    
 
410
    def property_changed(self, property=None, value=None,
 
411
                         *args, **kwargs):
 
412
        """Call self.update() if old value is not new value.
385
413
        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):
 
414
        property_name = unicode(property)
 
415
        old_value = self.properties.get(property_name)
 
416
        super(MandosClientWidget, self).property_changed(
 
417
            property=property, value=value, *args, **kwargs)
 
418
        if self.properties.get(property_name) != old_value:
392
419
            self.update()
393
420
 
394
421
 
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
422
class ConstrainedListBox(urwid.ListBox):
406
423
    """Like a normal urwid.ListBox, but will consume all "up" or
407
424
    "down" key presses, thus not allowing any containing widgets to
408
425
    use them as an excuse to shift focus away from this widget.
409
426
    """
410
 
    def keypress(self, *args, **kwargs):
411
 
        ret = (super(ConstrainedListBox, self)
412
 
               .keypress(*args, **kwargs))
 
427
    def keypress(self, maxcolrow, key):
 
428
        ret = super(ConstrainedListBox, self).keypress(maxcolrow, key)
413
429
        if ret in ("up", "down"):
414
430
            return
415
431
        return ret
416
432
 
417
433
 
418
 
class UserInterface:
 
434
class UserInterface(object):
419
435
    """This is the entire user interface - the whole screen
420
436
    with boxes, lists of client widgets, etc.
421
437
    """
422
438
    def __init__(self, max_log_length=1000):
423
439
        DBusGMainLoop(set_as_default=True)
424
 
 
 
440
        
425
441
        self.screen = urwid.curses_display.Screen()
426
 
 
 
442
        
427
443
        self.screen.register_palette((
428
444
                ("normal",
429
445
                 "default", "default", None),
430
446
                ("bold",
431
 
                 "bold", "default", "bold"),
 
447
                 "default", "default", "bold"),
432
448
                ("underline-blink",
433
 
                 "underline,blink", "default", "underline,blink"),
 
449
                 "default", "default", "underline"),
434
450
                ("standout",
435
 
                 "standout", "default", "standout"),
 
451
                 "default", "default", "standout"),
436
452
                ("bold-underline-blink",
437
 
                 "bold,underline,blink", "default",
438
 
                 "bold,underline,blink"),
 
453
                 "default", "default", ("bold", "underline")),
439
454
                ("bold-standout",
440
 
                 "bold,standout", "default", "bold,standout"),
 
455
                 "default", "default", ("bold", "standout")),
441
456
                ("underline-blink-standout",
442
 
                 "underline,blink,standout", "default",
443
 
                 "underline,blink,standout"),
 
457
                 "default", "default", ("underline", "standout")),
444
458
                ("bold-underline-blink-standout",
445
 
                 "bold,underline,blink,standout", "default",
446
 
                 "bold,underline,blink,standout"),
 
459
                 "default", "default", ("bold", "underline",
 
460
                                          "standout")),
447
461
                ))
448
 
 
 
462
        
449
463
        if urwid.supports_unicode():
450
 
            self.divider = "─"  # \u2500
 
464
            self.divider = "─" # \u2500
 
465
            #self.divider = "━" # \u2501
451
466
        else:
452
 
            self.divider = "_"  # \u005f
453
 
 
 
467
            #self.divider = "-" # \u002d
 
468
            self.divider = "_" # \u005f
 
469
        
454
470
        self.screen.start()
455
 
 
 
471
        
456
472
        self.size = self.screen.get_cols_rows()
457
 
 
 
473
        
458
474
        self.clients = urwid.SimpleListWalker([])
459
475
        self.clients_dict = {}
460
 
 
 
476
        
461
477
        # We will add Text widgets to this list
462
 
        self.log = urwid.SimpleListWalker([])
 
478
        self.log = []
463
479
        self.max_log_length = max_log_length
464
 
 
 
480
        
465
481
        # We keep a reference to the log widget so we can remove it
466
482
        # from the ListWalker without it getting destroyed
467
483
        self.logbox = ConstrainedListBox(self.log)
468
 
 
 
484
        
469
485
        # This keeps track of whether self.uilist currently has
470
486
        # self.logbox in it or not
471
487
        self.log_visible = True
472
488
        self.log_wrap = "any"
473
 
 
474
 
        self.loghandler = UILogHandler(self)
475
 
 
 
489
        
476
490
        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
 
 
 
491
        self.log_message_raw(("bold",
 
492
                              "Mandos Monitor version " + version))
 
493
        self.log_message_raw(("bold",
 
494
                              "q: Quit  ?: Help"))
 
495
        
 
496
        self.busname = domain + '.Mandos'
 
497
        self.main_loop = gobject.MainLoop()
 
498
        self.bus = dbus.SystemBus()
 
499
        mandos_dbus_objc = self.bus.get_object(
 
500
            self.busname, "/", follow_name_owner_changes=True)
 
501
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
 
502
                                          dbus_interface
 
503
                                          = server_interface)
 
504
        try:
 
505
            mandos_clients = (self.mandos_serv
 
506
                              .GetAllClientsWithProperties())
 
507
        except dbus.exceptions.DBusException:
 
508
            mandos_clients = dbus.Dictionary()
 
509
        
 
510
        (self.mandos_serv
 
511
         .connect_to_signal("ClientRemoved",
 
512
                            self.find_and_remove_client,
 
513
                            dbus_interface=server_interface,
 
514
                            byte_arrays=True))
 
515
        (self.mandos_serv
 
516
         .connect_to_signal("ClientAdded",
 
517
                            self.add_new_client,
 
518
                            dbus_interface=server_interface,
 
519
                            byte_arrays=True))
 
520
        (self.mandos_serv
 
521
         .connect_to_signal("ClientNotFound",
 
522
                            self.client_not_found,
 
523
                            dbus_interface=server_interface,
 
524
                            byte_arrays=True))
 
525
        for path, client in mandos_clients.iteritems():
 
526
            client_proxy_object = self.bus.get_object(self.busname,
 
527
                                                      path)
 
528
            self.add_client(MandosClientWidget(server_proxy_object
 
529
                                               =self.mandos_serv,
 
530
                                               proxy_object
 
531
                                               =client_proxy_object,
 
532
                                               properties=client,
 
533
                                               update_hook
 
534
                                               =self.refresh,
 
535
                                               delete_hook
 
536
                                               =self.remove_client,
 
537
                                               logger
 
538
                                               =self.log_message),
 
539
                            path=path)
 
540
    
 
541
    def client_not_found(self, fingerprint, address):
 
542
        self.log_message(("Client with address %s and fingerprint %s"
 
543
                          " could not be found" % (address,
 
544
                                                    fingerprint)))
 
545
    
488
546
    def rebuild(self):
489
547
        """This rebuilds the User Interface.
490
548
        Call this when the widget layout needs to change"""
491
549
        self.uilist = []
492
 
        # self.uilist.append(urwid.ListBox(self.clients))
 
550
        #self.uilist.append(urwid.ListBox(self.clients))
493
551
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.
494
552
                                                          clients),
495
 
                                       # header=urwid.Divider(),
 
553
                                       #header=urwid.Divider(),
496
554
                                       header=None,
497
 
                                       footer=urwid.Divider(
498
 
                                           div_char=self.divider)))
 
555
                                       footer=
 
556
                                       urwid.Divider(div_char=
 
557
                                                     self.divider)))
499
558
        if self.log_visible:
500
559
            self.uilist.append(self.logbox)
 
560
            pass
501
561
        self.topwidget = urwid.Pile(self.uilist)
502
 
 
503
 
    def add_log_line(self, markup):
 
562
    
 
563
    def log_message(self, message):
 
564
        timestamp = datetime.datetime.now().isoformat()
 
565
        self.log_message_raw(timestamp + ": " + message)
 
566
    
 
567
    def log_message_raw(self, markup):
 
568
        """Add a log message to the log buffer."""
504
569
        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,
 
570
        if (self.max_log_length
 
571
            and len(self.log) > self.max_log_length):
 
572
            del self.log[0:len(self.log)-self.max_log_length-1]
 
573
        self.logbox.set_focus(len(self.logbox.body.contents),
509
574
                              coming_from="above")
510
575
        self.refresh()
511
 
 
 
576
    
512
577
    def toggle_log_display(self):
513
578
        """Toggle visibility of the log buffer."""
514
579
        self.log_visible = not self.log_visible
515
580
        self.rebuild()
516
 
        log.debug("Log visibility changed to: %s", self.log_visible)
517
 
 
 
581
        #self.log_message("Log visibility changed to: "
 
582
        #                 + unicode(self.log_visible))
 
583
    
518
584
    def change_log_display(self):
519
585
        """Change type of log display.
520
586
        Currently, this toggles wrapping of text lines."""
524
590
            self.log_wrap = "clip"
525
591
        for textwidget in self.log:
526
592
            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):
 
593
        #self.log_message("Wrap mode: " + self.log_wrap)
 
594
    
 
595
    def find_and_remove_client(self, path, name):
530
596
        """Find a client by its object path and remove it.
531
 
 
532
 
        This is connected to the InterfacesRemoved signal from the
 
597
        
 
598
        This is connected to the ClientRemoved signal from the
533
599
        Mandos server object."""
534
 
        if client_interface not in interfaces:
535
 
            # Not a Mandos client object; ignore
536
 
            return
537
600
        try:
538
601
            client = self.clients_dict[path]
539
602
        except KeyError:
540
603
            # not found?
541
 
            log.warning("Unknown client %s removed", path)
 
604
            self.log_message("Unknown client %r (%r) removed", name,
 
605
                             path)
542
606
            return
543
607
        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
 
608
    
 
609
    def add_new_client(self, path):
554
610
        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])),
 
611
        self.add_client(MandosClientWidget(server_proxy_object
 
612
                                           =self.mandos_serv,
 
613
                                           proxy_object
 
614
                                           =client_proxy_object,
 
615
                                           update_hook
 
616
                                           =self.refresh,
 
617
                                           delete_hook
 
618
                                           =self.remove_client,
 
619
                                           logger
 
620
                                           =self.log_message),
561
621
                        path=path)
562
 
 
 
622
    
563
623
    def add_client(self, client, path=None):
564
624
        self.clients.append(client)
565
625
        if path is None:
566
626
            path = client.proxy.object_path
567
627
        self.clients_dict[path] = client
568
 
        self.clients.sort(key=lambda c: c.properties["Name"])
 
628
        self.clients.sort(None, lambda c: c.properties["Name"])
569
629
        self.refresh()
570
 
 
 
630
    
571
631
    def remove_client(self, client, path=None):
572
632
        self.clients.remove(client)
573
633
        if path is None:
574
634
            path = client.proxy.object_path
575
635
        del self.clients_dict[path]
 
636
        if not self.clients_dict:
 
637
            # Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker
 
638
            # is completely emptied, we need to recreate it.
 
639
            self.clients = urwid.SimpleListWalker([])
 
640
            self.rebuild()
576
641
        self.refresh()
577
 
 
 
642
    
578
643
    def refresh(self):
579
644
        """Redraw the screen"""
580
645
        canvas = self.topwidget.render(self.size, focus=True)
581
646
        self.screen.draw_screen(self.size, canvas)
582
 
 
 
647
    
583
648
    def run(self):
584
649
        """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
 
        self.bus = dbus.SystemBus()
591
 
        mandos_dbus_objc = self.bus.get_object(
592
 
            self.busname, "/", follow_name_owner_changes=True)
593
 
        self.mandos_serv = dbus.Interface(
594
 
            mandos_dbus_objc, dbus_interface=server_interface)
595
 
        try:
596
 
            mandos_clients = (self.mandos_serv
597
 
                              .GetAllClientsWithProperties())
598
 
            if not mandos_clients:
599
 
                log.warning("Note: Server has no clients.")
600
 
        except dbus.exceptions.DBusException:
601
 
            log.warning("Note: No Mandos server running.")
602
 
            mandos_clients = dbus.Dictionary()
603
 
 
604
 
        (self.mandos_serv
605
 
         .connect_to_signal("InterfacesRemoved",
606
 
                            self.find_and_remove_client,
607
 
                            dbus_interface=dbus.OBJECT_MANAGER_IFACE,
608
 
                            byte_arrays=True))
609
 
        (self.mandos_serv
610
 
         .connect_to_signal("InterfacesAdded",
611
 
                            self.add_new_client,
612
 
                            dbus_interface=dbus.OBJECT_MANAGER_IFACE,
613
 
                            byte_arrays=True))
614
 
        (self.mandos_serv
615
 
         .connect_to_signal("ClientNotFound",
616
 
                            self.client_not_found,
617
 
                            dbus_interface=server_interface,
618
 
                            byte_arrays=True))
619
 
        for path, client in mandos_clients.items():
620
 
            client_proxy_object = self.bus.get_object(self.busname,
621
 
                                                      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),
628
 
                            path=path)
629
 
 
630
650
        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)))
 
651
        self._input_callback_tag = (gobject.io_add_watch
 
652
                                    (sys.stdin.fileno(),
 
653
                                     gobject.IO_IN,
 
654
                                     self.process_input))
636
655
        self.main_loop.run()
637
656
        # 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
 
 
 
657
        gobject.source_remove(self._input_callback_tag)
 
658
        self.screen.stop()
 
659
    
643
660
    def stop(self):
644
661
        self.main_loop.quit()
645
 
        log.removeHandler(self.loghandler)
646
 
        log.propagate = self.orig_log_propagate
647
 
 
 
662
    
648
663
    def process_input(self, source, condition):
649
664
        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
 
                        }
 
665
        translations = { "ctrl n": "down",      # Emacs
 
666
                         "ctrl p": "up",        # Emacs
 
667
                         "ctrl v": "page down", # Emacs
 
668
                         "meta v": "page up",   # Emacs
 
669
                         " ": "page down",      # less
 
670
                         "f": "page down",      # less
 
671
                         "b": "page up",        # less
 
672
                         "j": "down",           # vi
 
673
                         "k": "up",             # vi
 
674
                         }
660
675
        for key in keys:
661
676
            try:
662
677
                key = translations[key]
663
678
            except KeyError:    # :-)
664
679
                pass
665
 
 
 
680
            
666
681
            if key == "q" or key == "Q":
667
682
                self.stop()
668
683
                break
669
684
            elif key == "window resize":
670
685
                self.size = self.screen.get_cols_rows()
671
686
                self.refresh()
672
 
            elif key == "ctrl l":
673
 
                self.screen.clear()
 
687
            elif key == "\f":  # Ctrl-L
674
688
                self.refresh()
675
689
            elif key == "l" or key == "D":
676
690
                self.toggle_log_display()
682
696
                if not self.log_visible:
683
697
                    self.log_visible = True
684
698
                    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
 
                                   ))))
 
699
                self.log_message_raw(("bold",
 
700
                                      "  ".
 
701
                                      join(("q: Quit",
 
702
                                            "?: Help",
 
703
                                            "l: Log window toggle",
 
704
                                            "TAB: Switch window",
 
705
                                            "w: Wrap (log)"))))
 
706
                self.log_message_raw(("bold",
 
707
                                      "  "
 
708
                                      .join(("Clients:",
 
709
                                             "+: Enable",
 
710
                                             "-: Disable",
 
711
                                             "R: Remove",
 
712
                                             "s: Start new checker",
 
713
                                             "S: Stop checker",
 
714
                                             "C: Checker OK",
 
715
                                             "a: Approve",
 
716
                                             "d: Deny"))))
704
717
                self.refresh()
705
718
            elif key == "tab":
706
719
                if self.topwidget.get_focus() is self.logbox:
708
721
                else:
709
722
                    self.topwidget.set_focus(self.logbox)
710
723
                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
 
724
            #elif (key == "end" or key == "meta >" or key == "G"
 
725
            #      or key == ">"):
 
726
            #    pass            # xxx end-of-buffer
 
727
            #elif (key == "home" or key == "meta <" or key == "g"
 
728
            #      or key == "<"):
 
729
            #    pass            # xxx beginning-of-buffer
 
730
            #elif key == "ctrl e" or key == "$":
 
731
            #    pass            # xxx move-end-of-line
 
732
            #elif key == "ctrl a" or key == "^":
 
733
            #    pass            # xxx move-beginning-of-line
 
734
            #elif key == "ctrl b" or key == "meta (" or key == "h":
 
735
            #    pass            # xxx left
 
736
            #elif key == "ctrl f" or key == "meta )" or key == "l":
 
737
            #    pass            # xxx right
 
738
            #elif key == "a":
 
739
            #    pass            # scroll up log
 
740
            #elif key == "z":
 
741
            #    pass            # scroll down log
736
742
            elif self.topwidget.selectable():
737
743
                self.topwidget.keypress(self.size, key)
738
744
                self.refresh()
739
745
        return True
740
746
 
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
747
ui = UserInterface()
756
748
try:
757
749
    ui.run()
758
750
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()
 
751
    ui.screen.stop()
 
752
except Exception, e:
 
753
    ui.log_message(unicode(e))
 
754
    ui.screen.stop()
766
755
    raise