/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Björn Påhlsson
  • Date: 2011-10-02 19:18:24 UTC
  • mto: (237.7.53 trunk)
  • mto: This revision was merged to the branch mainline in revision 286.
  • Revision ID: belorn@fukt.bsnet.se-20111002191824-eweh4pvneeg3qzia
transitional stuff actually working
documented change to D-Bus API

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