/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

* mandos: Use all new builtins.
* mandos-ctl: - '' -
* mandos-monitor: - '' -

Show diffs side-by-side

added added

removed removed

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