/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-06-01 21:48:12 UTC
  • Revision ID: teddy@recompile.se-20120601214812-g7685v5oeiuhi2qw
* debian/copyright (Copyright): Join the two lines to one line.
* debian/mandos-client.README.Debian: Refer to new location of example
  network hooks.
* debian/mandos-client.docs (network-hooks.d): Removed.
* debian/mandos-client.examples: New; contains "network-hooks.d".
* debian/rules (binary-common): Added "dh_installexamples".
  (binary-common/dh_fixperms): Changed to exclude new location of
  "network-hooks.d".
* init.d-mandos (status): Support new "status" action.

Show diffs side-by-side

added added

removed removed

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