/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: 2019-03-30 07:03:04 UTC
  • Revision ID: teddy@recompile.se-20190330070304-dqgch62lsaaygg46
mandos-ctl: Refactor D-Bus operations

* mandos-ctl (dbus): Rename imported module to "dbus_python".
  (main): Only create a bus object and do everything via that object.
  (get_mandos_dbus_object): Remove and move code into dbus or
                            dbus_python_adapter namespaces.
  (if_dbus_exception_log_with_exception_and_exit): - '' -
  (SilenceLogger): - '' -
  (dbus): New; move everything dbus-specific into this module-like
          namespace.
  (dbus_python_adapter): New; move everything specific to the
                         dbus-python D-Bus module into this
                         module-like namespace.
  (command.Base.run): Take only a bus argument; use only that.  Pass
                      "client" argument as a D-Bus object path string,
                      not a dbus-python proxy object.  All derivatives
                      adjusted.
  (command.IsEnabled.is_enabled): Remove.
  (command.Approve, command.Deny, command.Remove,
  command.PropertySetter): Do no logging of D-Bus commands, and use
  only bus, not client, to do D-Bus calls.
  (command.DumpJSON.dbus_boolean_to_bool): Remove; move filtering to
                                           dbus_python_adapter.
  (command.Enable, command.Disable, command.StopChecker,
  command.ApproveByDefault): Use normal Python booleans instead of
  dbus-python's special Boolean types.
  (Unique): New; move here out from inside TestPropertySetterCmd.
  (Test_get_mandos_dbus_object): Remove.
  (Test_get_managed_objects): - '' -
  (Test_dbus_exceptions): New.
  (Test_dbus_MandosBus): - '' -
  (Test_dbus_python_adapter_SystemBus): - '' -
  (Test_dbus_python_adapter_CachingBus): - '' -
  (Test_commands_from_options): Don't create mock client proxy
  objects, define dict of client properties and use a mock dbus to
  verify that the correct D-Bus calls are made.  Also remove any types
  specific to dbus-python.
  (TestEnableCmd, TestDisableCmd, TestStartCheckerCmd,
  TestStopCheckerCmd, TestApproveByDefaultCmd, TestDenyByDefaultCmd):
  Use normal Python booleans instead of dbus-python's special Boolean
  types.
  (TestPropertySetterValueCmd.runTest): Remove; unnecessary.

Show diffs side-by-side

added added

removed removed

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