/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-22 23:33:56 UTC
  • Revision ID: teddy@recompile.se-20120622233356-odoqqt2ki2gssn37
* Makefile (check): Also check mandos-ctl.
* mandos-ctl: All options taking a time interval argument can now take
              an RFC 3339 duration.
  (rfc3339_duration_to_delta): New function.
  (string_to_delta): Try rfc3339_duration_to_delta first.
  (main): New "--check" option.
* mandos-ctl.xml (SYNOPSIS, OPTIONS): Document new "--check" option.

Show diffs side-by-side

added added

removed removed

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