/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2012-05-03 20:16:22 UTC
  • Revision ID: teddy@recompile.se-20120503201622-d9yezi9t17i00lio
* mandos-ctl: Use new string format method.  Bug fix: --version now
              shows the program name.

Show diffs side-by-side

added added

removed removed

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