/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2024-09-08 02:18:57 UTC
  • mto: This revision was merged to the branch mainline in revision 410.
  • Revision ID: teddy@recompile.se-20240908021857-821e09dd4mp37h9k
Be more tolerant when a client is misconfigured in clients.conf

* mandos (Client/config_parser): If a client config section in
  clients.conf lacks both a fingerprint= and a key_id= setting, show
  an error and skip that client instead of crashing.

Show diffs side-by-side

added added

removed removed

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