/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: 2021-02-03 23:10:42 UTC
  • Revision ID: teddy@recompile.se-20210203231042-2z3egrvpo1zt7nej
mandos-ctl: Fix bad test for command.Remove and related minor issues

The test for command.Remove removes all clients from the spy server,
and then loops over all clients, looking for the corresponding Remove
command as recorded by the spy server.  But since since there aren't
any clients left after they were removed, no assertions are made, and
the test therefore does nothing.  Fix this.

In tests for command.Approve and command.Deny, add checks that clients
were not somehow removed by the command (in which case, likewise, no
assertions are made).

Add related checks to TestPropertySetterCmd.runTest; i.e. test that a
sequence is not empty before looping over it and making assertions.

* mandos-ctl (TestBaseCommands.test_Remove): Save a copy of the
  original "clients" dict, and loop over those instead.  Add assertion
  that all clients were indeed removed.  Also fix the code which looks
  for the Remove command, which now needs to actually work.
  (TestBaseCommands.test_Approve, TestBaseCommands.test_Deny): Add
  assertion that there are still clients before looping over them.
  (TestPropertySetterCmd.runTest): Add assertion that the list of
  values to get is not empty before looping over them.  Also add check
  that there are still clients before looping over clients.

Show diffs side-by-side

added added

removed removed

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