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