/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: 2015-08-10 07:34:37 UTC
  • Revision ID: teddy@recompile.se-20150810073437-3m8jgt13nqric6vf
Revert change to D-Bus API.

The D-Bus API signal CheckerCompleted is documented to provide a
wait(2) status value.  Since the server switched to using subprocess
to run checkers, it no longer has access to a wait(2) status value.  A
previous change to work around this made the D-Bus API incompatible.
Revert this change by constructing a fake wait(2) status value; this
keeps the D-Bus API stable.

* DBUS-API (CheckerCompleted): Revert incompatible change.
* mandos (ClientDBus.checker_callback): Construct fake wait(2) status.
* mandos-monitor (MandosClientWidget.checker_completed): Revert to
                                                         using
                                                         original API
                                                         with wait(2)
                                                         condition
                                                         value.

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