/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-05 09:17:34 UTC
  • mto: This revision was merged to the branch mainline in revision 570.
  • Revision ID: teddy@recompile.se-20120505091734-6ax38hc7091lotfm
* mandos-ctl (main): Use helper functions to shorten code.

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