/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2016-02-28 14:10:37 UTC
  • Revision ID: teddy@recompile.se-20160228141037-fyrxjr3l439zx2jl
Fix Debian dependency bugs and lintian checks.

* debian/control (Source: mandos/Build-Depends-Indep): Change "python
                         (= 2.7)" to "python (>= 2.7), python (<< 3)".
  (Package: mandos/Depends): - '' -
* mandos: Change "#!/usr/bin/python2.7" to "/usr/bin/python", since
          lintian otherwise complains about missing dependency on
          "python2.7".

Show diffs side-by-side

added added

removed removed

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