/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-07-29 16:35:53 UTC
  • Revision ID: teddy@recompile.se-20190729163553-1i442i2cbx64c537
Make tests and man page examples match

Make the tests test_manual_page_example[1-5] match exactly what is
written in the manual page, and add comments to manual page as
reminders to keep tests and manual page examples in sync.

* mandos-ctl (Test_commands_from_options.test_manual_page_example_1):
  Remove "--verbose" option, since the manual does not have it as the
  first example, and change assertion to match.
* mandos-ctl.xml (EXAMPLE): Add comments to all examples documenting
  which test function they correspond to.  Also remove unnecessary
  quotes from option arguments in fourth example, and clarify language
  slightly in fifth example.

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