/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: 2019-11-03 18:58:44 UTC
  • mto: This revision was merged to the branch mainline in revision 396.
  • Revision ID: teddy@recompile.se-20191103185844-r5ghn595fdzefg4w
mandos-monitor: Formatting changes only

* mandos-monitor: Re-order imports and normally use double quotes
                  instead of single quotes for strings.

Show diffs side-by-side

added added

removed removed

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