/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

Removed implemented TODO entry

Show diffs side-by-side

added added

removed removed

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